Update FSF's address.
[bpt/emacs.git] / lisp / telnet.el
1 ;;; telnet.el --- run a telnet session from within an Emacs buffer
2
3 ;; Copyright (C) 1985, 1988, 1992, 1994 Free Software Foundation, Inc.
4
5 ;; Author: William F. Schelter
6 ;; Maintainer: FSF
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; This mode is intended to be used for telnet or rsh to a remode host;
28 ;; `telnet' and `rsh' are the two entry points. Multiple telnet or rsh
29 ;; sessions are supported.
30 ;;
31 ;; Normally, input is sent to the remote telnet/rsh line-by-line, as you
32 ;; type RET or LFD. C-c C-c sends a C-c to the remote immediately;
33 ;; C-c C-z sends C-z immediately. C-c C-q followed by any character
34 ;; sends that character immediately.
35 ;;
36 ;; All RET characters are filtered out of the output coming back from the
37 ;; remote system. The mode tries to do other useful translations based
38 ;; on what it sees coming back from the other system before the password
39 ;; query. It knows about UNIX, ITS, TOPS-20 and Explorer systems.
40
41 ;;; Code:
42
43 ;; to do fix software types for lispm:
44 ;; to eval current expression. Also to try to send escape keys correctly.
45 ;; essentially we'll want the rubout-handler off.
46
47 ;; filter is simplistic but should be okay for typical shell usage.
48 ;; needs hacking if it is going to deal with asynchronous output in a sane
49 ;; manner
50
51 (require 'comint)
52
53 (defvar telnet-new-line "\r")
54 (defvar telnet-mode-map nil)
55 (defvar telnet-prompt-pattern "^[^#$%>\n]*[#$%>] *")
56 (defvar telnet-replace-c-g nil)
57 (make-variable-buffer-local
58 (defvar telnet-remote-echoes t
59 "True if the telnet process will echo input."))
60 (make-variable-buffer-local
61 (defvar telnet-interrupt-string "\C-c" "String sent by C-c."))
62
63 (defvar telnet-count 0
64 "Number of output strings from telnet process while looking for password.")
65 (make-variable-buffer-local 'telnet-count)
66
67 (defvar telnet-program "telnet"
68 "Program to run to open a telnet connection.")
69
70 (defvar telnet-initial-count -50
71 "Initial value of `telnet-count'. Should be set to the negative of the
72 number of terminal writes telnet will make setting up the host connection.")
73
74 (defvar telnet-maximum-count 4
75 "Maximum value `telnet-count' can have.
76 After this many passes, we stop looking for initial setup data.
77 Should be set to the number of terminal writes telnet will make
78 rejecting one login and prompting again for a username and password.")
79
80 (defun telnet-interrupt-subjob ()
81 (interactive)
82 "Interrupt the program running through telnet on the remote host."
83 (send-string nil telnet-interrupt-string))
84
85 (defun telnet-c-z ()
86 (interactive)
87 (send-string nil "\C-z"))
88
89 (defun send-process-next-char ()
90 (interactive)
91 (send-string nil
92 (char-to-string
93 (let ((inhibit-quit t))
94 (prog1 (read-char)
95 (setq quit-flag nil))))))
96
97 ; initialization on first load.
98 (if telnet-mode-map
99 nil
100 (setq telnet-mode-map (nconc (make-sparse-keymap) comint-mode-map))
101 (define-key telnet-mode-map "\C-m" 'telnet-send-input)
102 ; (define-key telnet-mode-map "\C-j" 'telnet-send-input)
103 (define-key telnet-mode-map "\C-c\C-q" 'send-process-next-char)
104 (define-key telnet-mode-map "\C-c\C-c" 'telnet-interrupt-subjob)
105 (define-key telnet-mode-map "\C-c\C-z" 'telnet-c-z))
106
107 ;;maybe should have a flag for when have found type
108 (defun telnet-check-software-type-initialize (string)
109 "Tries to put correct initializations in. Needs work."
110 (let ((case-fold-search t))
111 (cond ((string-match "unix" string)
112 (setq telnet-prompt-pattern comint-prompt-regexp)
113 (setq telnet-new-line "\n"))
114 ((string-match "tops-20" string) ;;maybe add telnet-replace-c-g
115 (setq telnet-prompt-pattern "[@>]*"))
116 ((string-match "its" string)
117 (setq telnet-prompt-pattern "^[^*>\n]*[*>] *"))
118 ((string-match "explorer" string) ;;explorer telnet needs work
119 (setq telnet-replace-c-g ?\n))))
120 (setq comint-prompt-regexp telnet-prompt-pattern))
121
122 (defun telnet-initial-filter (proc string)
123 ;For reading up to and including password; also will get machine type.
124 (cond ((string-match "No such host" string)
125 (kill-buffer (process-buffer proc))
126 (error "No such host."))
127 ((string-match "passw" string)
128 (telnet-filter proc string)
129 (setq telnet-count 0)
130 (send-string proc (concat (comint-read-noecho "Password: " t)
131 telnet-new-line)))
132 (t (telnet-check-software-type-initialize string)
133 (telnet-filter proc string)
134 (cond ((> telnet-count telnet-maximum-count)
135 (set-process-filter proc 'telnet-filter))
136 (t (setq telnet-count (1+ telnet-count)))))))
137
138 ;; Identical to comint-simple-send, except that it sends telnet-new-line
139 ;; instead of "\n".
140 (defun telnet-simple-send (proc string)
141 (comint-send-string proc string)
142 (comint-send-string proc telnet-new-line))
143
144 (defun telnet-filter (proc string)
145 (save-excursion
146 (set-buffer (process-buffer proc))
147 (let* ((last-insertion (marker-position (process-mark proc)))
148 (delta (- (point) last-insertion))
149 (ie (and comint-last-input-end
150 (marker-position comint-last-input-end)))
151 (w (get-buffer-window (current-buffer)))
152 (ws (and w (window-start w))))
153 (goto-char last-insertion)
154 (insert-before-markers string)
155 (set-marker (process-mark proc) (point))
156 (if ws (set-window-start w ws t))
157 (if ie (set-marker comint-last-input-end ie))
158 (while (progn (skip-chars-backward "^\C-m" last-insertion)
159 (> (point) last-insertion))
160 (delete-region (1- (point)) (point)))
161 (goto-char (process-mark proc))
162 (and telnet-replace-c-g
163 (subst-char-in-region last-insertion (point) ?\C-g
164 telnet-replace-c-g t))
165 ;; If point is after the insertion place, move it
166 ;; along with the text.
167 (if (> delta 0)
168 (goto-char (+ (process-mark proc) delta))))))
169
170 (defun telnet-send-input ()
171 (interactive)
172 ; (comint-send-input telnet-new-line telnet-remote-echoes)
173 (comint-send-input)
174 (if telnet-remote-echoes
175 (delete-region comint-last-input-start
176 comint-last-input-end)))
177
178 ;;;###autoload (add-hook 'same-window-regexps "\\*telnet-.*\\*\\(\\|<[0-9]+>\\)")
179
180 ;;;###autoload
181 (defun telnet (host)
182 "Open a network login connection to host named HOST (a string).
183 Communication with HOST is recorded in a buffer `*telnet-HOST*'.
184 Normally input is edited in Emacs and sent a line at a time."
185 (interactive "sOpen telnet connection to host: ")
186 (let* ((comint-delimiter-argument-list '(?\ ?\t))
187 (name (concat "telnet-" (comint-arguments host 0 nil) ))
188 (buffer (get-buffer (concat "*" name "*")))
189 process)
190 (if (and buffer (get-buffer-process buffer))
191 (pop-to-buffer (concat "*" name "*"))
192 (pop-to-buffer (make-comint name telnet-program))
193 (setq process (get-buffer-process (current-buffer)))
194 (set-process-filter process 'telnet-initial-filter)
195 ;; Don't send the `open' cmd till telnet is ready for it.
196 (accept-process-output process)
197 (erase-buffer)
198 (send-string process (concat "open " host "\n"))
199 (telnet-mode)
200 (setq comint-input-sender 'telnet-simple-send)
201 (setq telnet-count telnet-initial-count))))
202
203 (defun telnet-mode ()
204 "This mode is for using telnet (or rsh) from a buffer to another host.
205 It has most of the same commands as comint-mode.
206 There is a variable ``telnet-interrupt-string'' which is the character
207 sent to try to stop execution of a job on the remote host.
208 Data is sent to the remote host when RET is typed.
209
210 \\{telnet-mode-map}
211 "
212 (interactive)
213 (comint-mode)
214 (setq major-mode 'telnet-mode
215 mode-name "Telnet"
216 comint-prompt-regexp telnet-prompt-pattern)
217 (use-local-map telnet-mode-map)
218 (run-hooks 'telnet-mode-hook))
219
220 ;;;###autoload (add-hook 'same-window-regexps "\\*rsh-[^-]*\\*\\(\\|<[0-9]*>\\)")
221
222 ;;;###autoload
223 (defun rsh (host)
224 "Open a network login connection to host named HOST (a string).
225 Communication with HOST is recorded in a buffer `*rsh-HOST*'.
226 Normally input is edited in Emacs and sent a line at a time."
227 (interactive "sOpen rsh connection to host: ")
228 (require 'shell)
229 (let ((name (concat "rsh-" host )))
230 (pop-to-buffer (make-comint name remote-shell-program nil host))
231 (set-process-filter (get-process name) 'telnet-initial-filter)
232 (telnet-mode)
233 (setq telnet-count -16)))
234
235 (provide 'telnet)
236
237 ;;; telnet.el ends here