* src/xsettings.c: Comment fix.
[bpt/emacs.git] / lisp / net / rlogin.el
CommitLineData
8749abea
GM
1;;; rlogin.el --- remote login interface
2
f2e3589a 3;; Copyright (C) 1992, 1993, 1994, 1995, 1997, 1998, 2001, 2002, 2003,
5df4f04c 4;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
8749abea
GM
5
6;; Author: Noah Friedman
7;; Maintainer: Noah Friedman <friedman@splode.com>
8;; Keywords: unix, comm
9
8749abea
GM
10;; This file is part of GNU Emacs.
11
874a927a 12;; GNU Emacs is free software: you can redistribute it and/or modify
8749abea 13;; it under the terms of the GNU General Public License as published by
874a927a
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
8749abea
GM
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
874a927a 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
8749abea
GM
24
25;;; Commentary:
26
27;; Support for remote logins using `rlogin'.
28;; This program is layered on top of shell.el; the code here only accounts
29;; for the variations needed to handle a remote process, e.g. directory
30;; tracking and the sending of some special characters.
31
32;; If you wish for rlogin mode to prompt you in the minibuffer for
33;; passwords when a password prompt appears, just enter m-x send-invisible
34;; and type in your line, or add `comint-watch-for-password-prompt' to
35;; `comint-output-filter-functions'.
36
37;;; Code:
38
39(require 'comint)
40(require 'shell)
41
42(defgroup rlogin nil
508334bc 43 "Remote login interface."
8749abea
GM
44 :group 'processes
45 :group 'unix)
46
47(defcustom rlogin-program "rlogin"
1fc7dabf 48 "Name of program to invoke rlogin"
8749abea
GM
49 :type 'string
50 :group 'rlogin)
51
52(defcustom rlogin-explicit-args nil
1fc7dabf 53 "List of arguments to pass to rlogin on the command line."
8749abea
GM
54 :type '(repeat (string :tag "Argument"))
55 :group 'rlogin)
56
57(defcustom rlogin-mode-hook nil
1fc7dabf 58 "Hooks to run after setting current buffer to rlogin-mode."
8749abea
GM
59 :type 'hook
60 :group 'rlogin)
61
62(defcustom rlogin-process-connection-type
63 (save-match-data
64 ;; Solaris 2.x `rlogin' will spew a bunch of ioctl error messages if
65 ;; stdin isn't a tty.
66 (cond ((and (boundp 'system-configuration)
67 (stringp system-configuration)
68 (string-match "-solaris2" system-configuration))
69 t)
70 (t nil)))
1fc7dabf 71 "If non-nil, use a pty for the local rlogin process.
5199cf98 72If nil, use a pipe (if pipes are supported on the local system).
8749abea
GM
73
74Generally it is better not to waste ptys on systems which have a static
75number of them. On the other hand, some implementations of `rlogin' assume
76a pty is being used, and errors will result from using a pipe instead."
77 :type '(choice (const :tag "pipes" nil)
78 (other :tag "ptys" t))
79 :group 'rlogin)
80
81(defcustom rlogin-directory-tracking-mode 'local
1fc7dabf 82 "Control whether and how to do directory tracking in an rlogin buffer.
8749abea
GM
83
84nil means don't do directory tracking.
85
86t means do so using an ftp remote file name.
87
88Any other value means do directory tracking using local file names.
89This works only if the remote machine and the local one
90share the same directories (through NFS). This is the default.
91
92This variable becomes local to a buffer when set in any fashion for it.
93
94It is better to use the function of the same name to change the behavior of
95directory tracking in an rlogin session once it has begun, rather than
96simply setting this variable, since the function does the necessary
97re-synching of directories."
98 :type '(choice (const :tag "off" nil)
99 (const :tag "ftp" t)
100 (other :tag "local" local))
101 :group 'rlogin)
102
103(make-variable-buffer-local 'rlogin-directory-tracking-mode)
104
105(defcustom rlogin-host nil
1fc7dabf 106 "The name of the remote host. This variable is buffer-local."
8749abea
GM
107 :type '(choice (const nil) string)
108 :group 'rlogin)
109
110(defcustom rlogin-remote-user nil
1fc7dabf 111 "The username used on the remote host.
8749abea
GM
112This variable is buffer-local and defaults to your local user name.
113If rlogin is invoked with the `-l' option to specify the remote username,
114this variable is set from that."
115 :type '(choice (const nil) string)
116 :group 'rlogin)
117
118;; Initialize rlogin mode map.
119(defvar rlogin-mode-map '())
120(cond
121 ((null rlogin-mode-map)
122 (setq rlogin-mode-map (if (consp shell-mode-map)
123 (cons 'keymap shell-mode-map)
124 (copy-keymap shell-mode-map)))
125 (define-key rlogin-mode-map "\C-c\C-c" 'rlogin-send-Ctrl-C)
126 (define-key rlogin-mode-map "\C-c\C-d" 'rlogin-send-Ctrl-D)
127 (define-key rlogin-mode-map "\C-c\C-z" 'rlogin-send-Ctrl-Z)
128 (define-key rlogin-mode-map "\C-c\C-\\" 'rlogin-send-Ctrl-backslash)
129 (define-key rlogin-mode-map "\C-d" 'rlogin-delchar-or-send-Ctrl-D)
130 (define-key rlogin-mode-map "\C-i" 'rlogin-tab-or-complete)))
131
132\f
6bdad9ae 133;;;###autoload (add-hook 'same-window-regexps (purecopy "^\\*rlogin-.*\\*\\(\\|<[0-9]+>\\)"))
8749abea
GM
134
135(defvar rlogin-history nil)
136
137;;;###autoload
138(defun rlogin (input-args &optional buffer)
139 "Open a network login connection via `rlogin' with args INPUT-ARGS.
140INPUT-ARGS should start with a host name; it may also contain
141other arguments for `rlogin'.
142
143Input is sent line-at-a-time to the remote connection.
144
145Communication with the remote host is recorded in a buffer `*rlogin-HOST*'
146\(or `*rlogin-USER@HOST*' if the remote username differs\).
147If a prefix argument is given and the buffer `*rlogin-HOST*' already exists,
148a new buffer with a different connection will be made.
149
150When called from a program, if the optional second argument BUFFER is
151a string or buffer, it specifies the buffer to use.
152
153The variable `rlogin-program' contains the name of the actual program to
154run. It can be a relative or absolute path.
155
156The variable `rlogin-explicit-args' is a list of arguments to give to
157the rlogin when starting. They are added after any arguments given in
158INPUT-ARGS.
159
160If the default value of `rlogin-directory-tracking-mode' is t, then the
161default directory in that buffer is set to a remote (FTP) file name to
162access your home directory on the remote machine. Occasionally this causes
163an error, if you cannot access the home directory on that machine. This
164error is harmless as long as you don't try to use that default directory.
165
166If `rlogin-directory-tracking-mode' is neither t nor nil, then the default
167directory is initially set up to your (local) home directory.
168This is useful if the remote machine and your local machine
169share the same files via NFS. This is the default.
170
171If you wish to change directory tracking styles during a session, use the
172function `rlogin-directory-tracking-mode' rather than simply setting the
173variable."
174 (interactive (list
175 (read-from-minibuffer "rlogin arguments (hostname first): "
176 nil nil nil 'rlogin-history)
177 current-prefix-arg))
178
179 (let* ((process-connection-type rlogin-process-connection-type)
180 (args (if rlogin-explicit-args
19a31306 181 (append (split-string input-args)
8749abea 182 rlogin-explicit-args)
19a31306 183 (split-string input-args)))
9a479835
TTN
184 (host (let ((tail args))
185 ;; Find first arg that doesn't look like an option.
186 ;; This still loses for args that take values, feh.
187 (while (and tail (= ?- (aref (car tail) 0)))
188 (setq tail (cdr tail)))
189 (car tail)))
8749abea
GM
190 (user (or (car (cdr (member "-l" args)))
191 (user-login-name)))
192 (buffer-name (if (string= user (user-login-name))
193 (format "*rlogin-%s*" host)
0fd2d581 194 (format "*rlogin-%s@%s*" user host))))
8749abea
GM
195
196 (cond ((null buffer))
197 ((stringp buffer)
198 (setq buffer-name buffer))
199 ((bufferp buffer)
200 (setq buffer-name (buffer-name buffer)))
201 ((numberp buffer)
202 (setq buffer-name (format "%s<%d>" buffer-name buffer)))
203 (t
204 (setq buffer-name (generate-new-buffer-name buffer-name))))
205
206 (setq buffer (get-buffer-create buffer-name))
207 (pop-to-buffer buffer-name)
208
0fd2d581 209 (unless (comint-check-proc buffer-name)
8749abea 210 (comint-exec buffer buffer-name rlogin-program nil args)
8749abea
GM
211
212 (rlogin-mode)
213
214 (make-local-variable 'rlogin-host)
215 (setq rlogin-host host)
216 (make-local-variable 'rlogin-remote-user)
217 (setq rlogin-remote-user user)
218
219 (condition-case ()
220 (cond ((eq rlogin-directory-tracking-mode t)
221 ;; Do this here, rather than calling the tracking mode
222 ;; function, to avoid a gratuitous resync check; the default
223 ;; should be the user's home directory, be it local or remote.
224 (setq comint-file-name-prefix
225 (concat "/" rlogin-remote-user "@" rlogin-host ":"))
226 (cd-absolute comint-file-name-prefix))
227 ((null rlogin-directory-tracking-mode))
228 (t
229 (cd-absolute (concat comint-file-name-prefix "~/"))))
0fd2d581 230 (error nil)))))
8749abea
GM
231
232(put 'rlogin-mode 'mode-class 'special)
233
cf232e4d 234(define-derived-mode rlogin-mode shell-mode "Rlogin"
8749abea 235 (setq shell-dirtrackp rlogin-directory-tracking-mode)
cf232e4d 236 (make-local-variable 'comint-file-name-prefix))
8749abea
GM
237
238(defun rlogin-directory-tracking-mode (&optional prefix)
239 "Do remote or local directory tracking, or disable entirely.
240
241If called with no prefix argument or a unspecified prefix argument (just
242``\\[universal-argument]'' with no number) do remote directory tracking via
243ange-ftp. If called as a function, give it no argument.
244
245If called with a negative prefix argument, disable directory tracking
246entirely.
247
248If called with a positive, numeric prefix argument, e.g.
249``\\[universal-argument] 1 M-x rlogin-directory-tracking-mode\'',
250then do directory tracking but assume the remote filesystem is the same as
251the local system. This only works in general if the remote machine and the
365f8d85 252local one share the same directories (e.g. through NFS)."
8749abea
GM
253 (interactive "P")
254 (cond
255 ((or (null prefix)
256 (consp prefix))
257 (setq rlogin-directory-tracking-mode t)
258 (setq shell-dirtrackp t)
259 (setq comint-file-name-prefix
260 (concat "/" rlogin-remote-user "@" rlogin-host ":")))
261 ((< prefix 0)
262 (setq rlogin-directory-tracking-mode nil)
263 (setq shell-dirtrackp nil))
264 (t
265 (setq rlogin-directory-tracking-mode 'local)
266 (setq comint-file-name-prefix "")
267 (setq shell-dirtrackp t)))
268 (cond
269 (shell-dirtrackp
270 (let* ((proc (get-buffer-process (current-buffer)))
271 (proc-mark (process-mark proc))
272 (current-input (buffer-substring proc-mark (point-max)))
273 (orig-point (point))
274 (offset (and (>= orig-point proc-mark)
275 (- (point-max) orig-point))))
276 (unwind-protect
277 (progn
278 (delete-region proc-mark (point-max))
279 (goto-char (point-max))
280 (shell-resync-dirs))
281 (goto-char proc-mark)
282 (insert current-input)
283 (if offset
284 (goto-char (- (point-max) offset))
285 (goto-char orig-point)))))))
286
287\f
8749abea
GM
288(defun rlogin-send-Ctrl-C ()
289 (interactive)
290 (process-send-string nil "\C-c"))
291
292(defun rlogin-send-Ctrl-D ()
293 (interactive)
294 (process-send-string nil "\C-d"))
295
296(defun rlogin-send-Ctrl-Z ()
297 (interactive)
298 (process-send-string nil "\C-z"))
299
300(defun rlogin-send-Ctrl-backslash ()
301 (interactive)
302 (process-send-string nil "\C-\\"))
303
304(defun rlogin-delchar-or-send-Ctrl-D (arg)
305 "\
306Delete ARG characters forward, or send a C-d to process if at end of buffer."
307 (interactive "p")
308 (if (eobp)
309 (rlogin-send-Ctrl-D)
310 (delete-char arg)))
311
312(defun rlogin-tab-or-complete ()
313 "Complete file name if doing directory tracking, or just insert TAB."
314 (interactive)
315 (if rlogin-directory-tracking-mode
316 (comint-dynamic-complete)
317 (insert "\C-i")))
318
319(provide 'rlogin)
320
321;;; rlogin.el ends here