1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2011 Free Software Foundation, Inc.
5 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
6 ;; Michael Albinus <michael.albinus@gmx.de>
7 ;; Keywords: comm, processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This package provides remote file editing, similar to ange-ftp.
28 ;; The difference is that ange-ftp uses FTP to transfer files between
29 ;; the local and the remote host, whereas tramp.el uses a combination
30 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
32 ;; For more detailed instructions, please see the info file.
37 ;; This package only works for Emacs 22.1 and higher, and for XEmacs 21.4
38 ;; and higher. For XEmacs 21, you need the package `fsf-compat' for
39 ;; the `with-timeout' macro.
41 ;; Also see the todo list at the bottom of this file.
43 ;; The current version of Tramp can be retrieved from the following URL:
44 ;; http://ftp.gnu.org/gnu/tramp/
46 ;; There's a mailing list for this, as well. Its name is:
47 ;; tramp-devel@gnu.org
48 ;; You can use the Web to subscribe, under the following URL:
49 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
51 ;; For the adventurous, the current development sources are available
52 ;; via CVS. You can find instructions about this at the following URL:
53 ;; http://savannah.gnu.org/projects/tramp/
54 ;; Click on "CVS" in the navigation bar near the top.
56 ;; Don't forget to put on your asbestos longjohns, first!
60 (require 'tramp-compat
)
62 ;;; User Customizable Internal Variables:
65 "Edit remote files with a combination of rsh and rcp or similar programs."
70 ;; Maybe we need once a real Tramp mode, with key bindings etc.
72 (defcustom tramp-mode t
73 "*Whether Tramp is enabled.
74 If it is set to nil, all remote file names are used literally."
78 (defcustom tramp-verbose
3
79 "*Verbosity level for Tramp messages.
80 Any level x includes messages for all levels 1 .. x-1. The levels are
82 0 silent (no tramp messages at all)
85 3 connection to remote hosts (default level)
88 6 sent and received strings
90 8 connection properties
98 (when (boundp 'backup-directory-alist
)
99 (defcustom tramp-backup-directory-alist nil
100 "Alist of filename patterns and backup directory names.
101 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
102 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
103 is a local file name, the backup directory is prepended with Tramp file
104 name prefix \(method, user, host\) of file.
106 \(setq tramp-backup-directory-alist backup-directory-alist\)
108 gives the same backup policy for Tramp files on their hosts like the
109 policy for local files."
111 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
112 (directory :tag
"Backup directory name"))))))
114 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
115 ;; the package "backup-dir" might not be loaded yet.
117 (when (featurep 'xemacs
)
118 (defcustom tramp-bkup-backup-directory-info nil
119 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
120 It has the same meaning like `bkup-backup-directory-info' from package
121 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
122 file name, the backup directory is prepended with Tramp file name prefix
123 \(method, user, host\) of file.
125 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
127 gives the same backup policy for Tramp files on their hosts like the
128 policy for local files."
130 (list (regexp :tag
"File regexp")
131 (string :tag
"Backup Dir")
136 (const search-upward
))))
139 (defcustom tramp-auto-save-directory nil
140 "*Put auto-save files in this directory, if set.
141 The idea is to use a local directory so that auto-saving is faster."
143 :type
'(choice (const nil
) string
))
145 (defcustom tramp-encoding-shell
146 (if (memq system-type
'(windows-nt))
149 "*Use this program for encoding and decoding commands on the local host.
150 This shell is used to execute the encoding and decoding command on the
151 local host, so if you want to use `~' in those commands, you should
152 choose a shell here which groks tilde expansion. `/bin/sh' normally
153 does not understand tilde expansion.
155 For encoding and deocding, commands like the following are executed:
157 /bin/sh -c COMMAND < INPUT > OUTPUT
159 This variable can be used to change the \"/bin/sh\" part. See the
160 variable `tramp-encoding-command-switch' for the \"-c\" part.
162 If the shell must be forced to be interactive, see
163 `tramp-encoding-command-interactive'.
165 Note that this variable is not used for remote commands. There are
166 mechanisms in tramp.el which automatically determine the right shell to
167 use for the remote host."
169 :type
'(file :must-match t
))
171 (defcustom tramp-encoding-command-switch
172 (if (string-match "cmd\\.exe" tramp-encoding-shell
)
175 "*Use this switch together with `tramp-encoding-shell' for local commands.
176 See the variable `tramp-encoding-shell' for more information."
180 (defcustom tramp-encoding-command-interactive
181 (unless (string-match "cmd\\.exe" tramp-encoding-shell
) "-i")
182 "*Use this switch together with `tramp-encoding-shell' for interactive shells.
183 See the variable `tramp-encoding-shell' for more information."
185 :type
'(choice (const nil
) string
))
188 (defvar tramp-methods nil
189 "*Alist of methods for remote files.
190 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
191 Each NAME stands for a remote access method. Each PARAM is a
192 pair of the form (KEY VALUE). The following KEYs are defined:
194 This specifies the Bourne shell to use on the remote host. This
195 MUST be a Bourne-like shell. It is normally not necessary to set
196 this to any value other than \"/bin/sh\": Tramp wants to use a shell
197 which groks tilde expansion, but it can search for it. Also note
198 that \"/bin/sh\" exists on all Unixen, this might not be true for
199 the value that you decide to use. You Have Been Warned.
200 * `tramp-login-program'
201 This specifies the name of the program to use for logging in to the
202 remote host. This may be the name of rsh or a workalike program,
203 or the name of telnet or a workalike, or the name of su or a workalike.
205 This specifies the list of arguments to pass to the above
206 mentioned program. Please note that this is a list of list of arguments,
207 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
208 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
209 There are some patterns: \"%h\" in this list is replaced by the host
210 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
211 port number, and \"%%\" can be used to obtain a literal percent character.
212 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
213 expansion (i.e. no host or no user specified), this list is not used as
214 argument. By this, arguments like (\"-l\" \"%u\") are optional.
215 \"%t\" is replaced by the temporary file name produced with
216 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
217 parameter of a program, if exists.
219 When an asynchronous process is started, we know already that
220 the connection works. Therefore, we can pass additional
221 parameters to suppress diagnostic messages, in order not to
222 tamper the process output.
223 * `tramp-copy-program'
224 This specifies the name of the program to use for remotely copying
225 the file; this might be the absolute filename of rcp or the name of
228 This specifies the list of parameters to pass to the above mentioned
229 program, the hints for `tramp-login-args' also apply here.
230 * `tramp-copy-keep-date'
231 This specifies whether the copying program when the preserves the
232 timestamp of the original file.
233 * `tramp-copy-keep-tmpfile'
234 This specifies whether a temporary local file shall be kept
235 for optimization reasons (useful for \"rsync\" methods).
236 * `tramp-copy-recursive'
237 Whether the operation copies directories recursively.
238 * `tramp-default-port'
239 The default port of a method is needed in case of gateway connections.
240 Additionally, it is used as indication which method is prepared for
243 As the attribute name says, additional arguments are specified here
244 when a method is applied via a gateway.
245 * `tramp-password-end-of-line'
246 This specifies the string to use for terminating the line after
247 submitting the password. If this method parameter is nil, then the
248 value of the normal variable `tramp-default-password-end-of-line'
249 is used. This parameter is necessary because the \"plink\" program
250 requires any two characters after sending the password. These do
251 not have to be newline or carriage return characters. Other login
252 programs are happy with just one character, the newline character.
253 We use \"xy\" as the value for methods using \"plink\".
255 What does all this mean? Well, you should specify `tramp-login-program'
256 for all methods; this program is used to log in to the remote site. Then,
257 there are two ways to actually transfer the files between the local and the
258 remote side. One way is using an additional rcp-like program. If you want
259 to do this, set `tramp-copy-program' in the method.
261 Another possibility for file transfer is inline transfer, i.e. the
262 file is passed through the same buffer used by `tramp-login-program'. In
263 this case, the file contents need to be protected since the
264 `tramp-login-program' might use escape codes or the connection might not
265 be eight-bit clean. Therefore, file contents are encoded for transit.
266 See the variables `tramp-local-coding-commands' and
267 `tramp-remote-coding-commands' for details.
269 So, to summarize: if the method is an out-of-band method, then you
270 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
271 inline method, then these two parameters should be nil. Methods which
272 are fit for gateways must have `tramp-default-port' at least.
276 When using `su' or `sudo' the phrase `open connection to a remote
277 host' sounds strange, but it is used nevertheless, for consistency.
278 No connection is opened to a remote host, but `su' or `sudo' is
279 started on the local host. You should specify a remote host
280 `localhost' or the name of the local host. Another host name is
281 useful only in combination with `tramp-default-proxies-alist'.")
283 (defun tramp-detect-ssh-controlmaster ()
284 "Call ssh to detect whether it supports the ControlMaster argument.
285 This function may return nil when the argument is supported, but
286 shouldn't return t when it isn't."
289 (call-process "ssh" nil t nil
"-o" "ControlMaster")
290 (goto-char (point-min))
291 (search-forward-regexp "Missing ControlMaster argument" nil t
))))
293 (defcustom tramp-default-method
294 ;; An external copy method seems to be preferred, because it is much
295 ;; more performant for large files, and it hasn't too serious delays
296 ;; for small files. But it must be ensured that there aren't
297 ;; permanent password queries. Either a password agent like
298 ;; "ssh-agent" or "Pageant" shall run, or the optional
299 ;; password-cache.el or auth-sources.el packages shall be active for
300 ;; password caching. "scpc" is chosen if we detect that the user is
301 ;; running OpenSSH 4.0 or newer.
303 ;; PuTTY is installed. We don't take it, if it is installed on a
304 ;; non-windows system, or pscp from the pssh (parallel ssh) package
306 ((and (eq system-type
'windows-nt
)
307 (executable-find "pscp"))
308 (if (or (fboundp 'password-read
)
309 (fboundp 'auth-source-user-or-password
)
310 (fboundp 'auth-source-search
)
311 ;; Pageant is running.
312 (tramp-compat-process-running-p "Pageant"))
315 ;; There is an ssh installation.
316 ((executable-find "scp")
318 ((tramp-detect-ssh-controlmaster) "scpc")
319 ((or (fboundp 'password-read
)
320 (fboundp 'auth-source-user-or-password
)
321 (fboundp 'auth-source-search
)
322 ;; ssh-agent is running.
323 (getenv "SSH_AUTH_SOCK")
324 (getenv "SSH_AGENT_PID"))
329 "*Default method to use for transferring files.
330 See `tramp-methods' for possibilities.
331 Also see `tramp-default-method-alist'."
336 (defcustom tramp-default-method-alist nil
337 "*Default method to use for specific host/user pairs.
338 This is an alist of items (HOST USER METHOD). The first matching item
339 specifies the method to use for a file name which does not specify a
340 method. HOST and USER are regular expressions or nil, which is
341 interpreted as a regular expression which always matches. If no entry
342 matches, the variable `tramp-default-method' takes effect.
344 If the file name does not specify the user, lookup is done using the
345 empty string for the user name.
347 See `tramp-methods' for a list of possibilities for METHOD."
349 :type
'(repeat (list (choice :tag
"Host regexp" regexp sexp
)
350 (choice :tag
"User regexp" regexp sexp
)
351 (choice :tag
"Method name" string
(const nil
)))))
353 (defcustom tramp-default-user nil
354 "*Default user to use for transferring files.
355 It is nil by default; otherwise settings in configuration files like
356 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
358 This variable is regarded as obsolete, and will be removed soon."
360 :type
'(choice (const nil
) string
))
363 (defcustom tramp-default-user-alist nil
364 "*Default user to use for specific method/host pairs.
365 This is an alist of items (METHOD HOST USER). The first matching item
366 specifies the user to use for a file name which does not specify a
367 user. METHOD and USER are regular expressions or nil, which is
368 interpreted as a regular expression which always matches. If no entry
369 matches, the variable `tramp-default-user' takes effect.
371 If the file name does not specify the method, lookup is done using the
372 empty string for the method name."
374 :type
'(repeat (list (choice :tag
"Method regexp" regexp sexp
)
375 (choice :tag
" Host regexp" regexp sexp
)
376 (choice :tag
" User name" string
(const nil
)))))
378 (defcustom tramp-default-host
(system-name)
379 "*Default host to use for transferring files.
380 Useful for su and sudo methods mostly."
384 (defcustom tramp-default-proxies-alist nil
385 "*Route to be followed for specific host/user pairs.
386 This is an alist of items (HOST USER PROXY). The first matching
387 item specifies the proxy to be passed for a file name located on
388 a remote target matching USER@HOST. HOST and USER are regular
389 expressions. PROXY must be a Tramp filename without a localname
390 part. Method and user name on PROXY are optional, which is
391 interpreted with the default values. PROXY can contain the
392 patterns %h and %u, which are replaced by the strings matching
393 HOST or USER, respectively.
395 HOST, USER or PROXY could also be Lisp forms, which will be
396 evaluated. The result must be a string or nil, which is
397 interpreted as a regular expression which always matches."
399 :type
'(repeat (list (choice :tag
"Host regexp" regexp sexp
)
400 (choice :tag
"User regexp" regexp sexp
)
401 (choice :tag
" Proxy name" string
(const nil
)))))
404 (defconst tramp-local-host-regexp
408 (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t
)
410 "*Host names which are regarded as local host.")
412 (defvar tramp-completion-function-alist nil
413 "*Alist of methods for remote files.
414 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\).
415 Each NAME stands for a remote access method. Each PAIR is of the form
416 \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host
417 names from FILE for completion. The following predefined FUNCTIONs exists:
419 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
420 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
421 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
422 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
423 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
424 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
425 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
426 * `tramp-parse-netrc' for \"~/.netrc\" like files.
427 * `tramp-parse-putty' for PuTTY registry keys.
429 FUNCTION can also be a customer defined function. For more details see
432 (defconst tramp-echo-mark-marker
"_echo"
433 "String marker to surround echoed commands.")
435 (defconst tramp-echo-mark-marker-length
(length tramp-echo-mark-marker
)
436 "String length of `tramp-echo-mark-marker'.")
438 (defconst tramp-echo-mark
439 (concat tramp-echo-mark-marker
440 (make-string tramp-echo-mark-marker-length ?
\b))
441 "String mark to be transmitted around shell commands.
442 Used to separate their echo from the output they produce. This
443 will only be used if we cannot disable remote echo via stty.
444 This string must have no effect on the remote shell except for
445 producing some echo which can later be detected by
446 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
447 followed by an equal number of backspaces to erase them will
450 (defconst tramp-echoed-echo-mark-regexp
451 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
452 tramp-echo-mark-marker tramp-echo-mark-marker-length
)
453 "Regexp which matches `tramp-echo-mark' as it gets echoed by
456 (defcustom tramp-rsh-end-of-line
"\n"
457 "*String used for end of line in rsh connections.
458 I don't think this ever needs to be changed, so please tell me about it
459 if you need to change this.
460 Also see the method parameter `tramp-password-end-of-line' and the normal
461 variable `tramp-default-password-end-of-line'."
465 (defcustom tramp-default-password-end-of-line
466 tramp-rsh-end-of-line
467 "*String used for end of line after sending a password.
468 This variable provides the default value for the method parameter
469 `tramp-password-end-of-line', see `tramp-methods' for more details.
471 It seems that people using plink under Windows need to send
472 \"\\r\\n\" (carriage-return, then newline) after a password, but just
473 \"\\n\" after all other lines. This variable can be used for the
474 password, see `tramp-rsh-end-of-line' for the other cases.
476 The default value is to use the same value as `tramp-rsh-end-of-line'."
480 (defcustom tramp-login-prompt-regexp
481 ".*ogin\\( .*\\)?: *"
482 "*Regexp matching login-like prompts.
483 The regexp should match at end of buffer.
485 Sometimes the prompt is reported to look like \"login as:\"."
489 (defcustom tramp-shell-prompt-pattern
490 ;; Allow a prompt to start right after a ^M since it indeed would be
491 ;; displayed at the beginning of the line (and Zsh uses it). This
492 ;; regexp works only for GNU Emacs.
493 (concat (if (featurep 'xemacs
) "" "\\(?:^\\|\r\\)")
494 "[^#$%>\n]*#?[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
495 "Regexp to match prompts from remote shell.
496 Normally, Tramp expects you to configure `shell-prompt-pattern'
497 correctly, but sometimes it happens that you are connecting to a
498 remote host which sends a different kind of shell prompt. Therefore,
499 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
500 and also things matched by this variable. The default value of this
501 variable is similar to the default value of `shell-prompt-pattern',
502 which should work well in many cases.
504 This regexp must match both `tramp-initial-end-of-output' and
505 `tramp-end-of-output'."
509 (defcustom tramp-password-prompt-regexp
510 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
511 "*Regexp matching password-like prompts.
512 The regexp should match at end of buffer.
514 The `sudo' program appears to insert a `^@' character into the prompt."
518 (defcustom tramp-wrong-passwd-regexp
520 ;; These strings should be on the last line
521 (regexp-opt '("Permission denied"
526 "Timeout, server not responding."
528 "Name or service not known"
529 "Host key verification failed."
530 "No supported authentication methods left to try!") t
)
534 ;; Here comes a list of regexes, separated by \\|
535 "Received signal [0-9]+"
537 "*Regexp matching a `login failed' message.
538 The regexp should match at end of buffer."
542 (defcustom tramp-yesno-prompt-regexp
544 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t
)
546 "Regular expression matching all yes/no queries which need to be confirmed.
547 The confirmation should be done with yes or no.
548 The regexp should match at end of buffer.
549 See also `tramp-yn-prompt-regexp'."
553 (defcustom tramp-yn-prompt-regexp
555 (regexp-opt '("Store key in cache? (y/n)"
556 "Update cached key? (y/n, Return cancels connection)") t
)
558 "Regular expression matching all y/n queries which need to be confirmed.
559 The confirmation should be done with y or n.
560 The regexp should match at end of buffer.
561 See also `tramp-yesno-prompt-regexp'."
565 (defcustom tramp-terminal-prompt-regexp
569 "Terminal type\\? \\[.*\\]"
571 "Regular expression matching all terminal setting prompts.
572 The regexp should match at end of buffer.
573 The answer will be provided by `tramp-action-terminal', which see."
577 (defcustom tramp-operation-not-permitted-regexp
578 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
579 (regexp-opt '("Operation not permitted") t
))
580 "Regular expression matching keep-date problems in (s)cp operations.
581 Copying has been performed successfully already, so this message can
586 (defcustom tramp-copy-failed-regexp
588 (regexp-opt '("Permission denied"
591 "No such file or directory") t
)
593 "Regular expression matching copy problems in (s)cp operations."
597 (defcustom tramp-process-alive-regexp
599 "Regular expression indicating a process has finished.
600 In fact this expression is empty by intention, it will be used only to
601 check regularly the status of the associated process.
602 The answer will be provided by `tramp-action-process-alive',
603 `tramp-action-out-of-band', which see."
607 (defconst tramp-temp-name-prefix
"tramp."
608 "*Prefix to use for temporary files.
609 If this is a relative file name (such as \"tramp.\"), it is considered
610 relative to the directory name returned by the function
611 `tramp-compat-temporary-file-directory' (which see). It may also be an
612 absolute file name; don't forget to include a prefix for the filename
615 (defconst tramp-temp-buffer-name
" *tramp temp*"
616 "Buffer name for a temporary buffer.
617 It shall be used in combination with `generate-new-buffer-name'.")
619 (defvar tramp-temp-buffer-file-name nil
620 "File name of a persistent local temporary file.
621 Useful for \"rsync\" like methods.")
622 (make-variable-buffer-local 'tramp-temp-buffer-file-name
)
623 (put 'tramp-temp-buffer-file-name
'permanent-local t
)
625 ;; XEmacs is distributed with few Lisp packages. Further packages are
626 ;; installed using EFS. If we use a unified filename format, then
627 ;; Tramp is required in addition to EFS. (But why can't Tramp just
628 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
629 ;; just like before.) Another reason for using a separate filename
630 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
631 ;; Tramp only knows how to deal with `file-name-handler-alist', not
634 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
636 (defcustom tramp-syntax
637 (if (featurep 'xemacs
) 'sep
'ftp
)
638 "Tramp filename syntax to be used.
640 It can have the following values:
642 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
643 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
644 'url -- URL-like syntax."
646 :type
(if (featurep 'xemacs
)
647 '(choice (const :tag
"EFS" ftp
)
648 (const :tag
"XEmacs" sep
)
649 (const :tag
"URL" url
))
650 '(choice (const :tag
"Ange-FTP" ftp
)
651 (const :tag
"URL" url
))))
653 (defconst tramp-prefix-format
654 (cond ((equal tramp-syntax
'ftp
) "/")
655 ((equal tramp-syntax
'sep
) "/[")
656 ((equal tramp-syntax
'url
) "/")
657 (t (error "Wrong `tramp-syntax' defined")))
658 "*String matching the very beginning of Tramp file names.
659 Used in `tramp-make-tramp-file-name'.")
661 (defconst tramp-prefix-regexp
662 (concat "^" (regexp-quote tramp-prefix-format
))
663 "*Regexp matching the very beginning of Tramp file names.
664 Should always start with \"^\". Derived from `tramp-prefix-format'.")
666 (defconst tramp-method-regexp
668 "*Regexp matching methods identifiers.")
670 (defconst tramp-postfix-method-format
671 (cond ((equal tramp-syntax
'ftp
) ":")
672 ((equal tramp-syntax
'sep
) "/")
673 ((equal tramp-syntax
'url
) "://")
674 (t (error "Wrong `tramp-syntax' defined")))
675 "*String matching delimiter between method and user or host names.
676 Used in `tramp-make-tramp-file-name'.")
678 (defconst tramp-postfix-method-regexp
679 (regexp-quote tramp-postfix-method-format
)
680 "*Regexp matching delimiter between method and user or host names.
681 Derived from `tramp-postfix-method-format'.")
683 (defconst tramp-user-regexp
"[^:/ \t]+"
684 "*Regexp matching user names.")
687 (defconst tramp-prefix-domain-format
"%"
688 "*String matching delimiter between user and domain names.")
691 (defconst tramp-prefix-domain-regexp
692 (regexp-quote tramp-prefix-domain-format
)
693 "*Regexp matching delimiter between user and domain names.
694 Derived from `tramp-prefix-domain-format'.")
696 (defconst tramp-domain-regexp
"[-a-zA-Z0-9_.]+"
697 "*Regexp matching domain names.")
699 (defconst tramp-user-with-domain-regexp
700 (concat "\\(" tramp-user-regexp
"\\)"
701 tramp-prefix-domain-regexp
702 "\\(" tramp-domain-regexp
"\\)")
703 "*Regexp matching user names with domain names.")
705 (defconst tramp-postfix-user-format
"@"
706 "*String matching delimiter between user and host names.
707 Used in `tramp-make-tramp-file-name'.")
709 (defconst tramp-postfix-user-regexp
710 (regexp-quote tramp-postfix-user-format
)
711 "*Regexp matching delimiter between user and host names.
712 Derived from `tramp-postfix-user-format'.")
714 (defconst tramp-host-regexp
"[a-zA-Z0-9_.-]+"
715 "*Regexp matching host names.")
717 (defconst tramp-prefix-ipv6-format
718 (cond ((equal tramp-syntax
'ftp
) "[")
719 ((equal tramp-syntax
'sep
) "")
720 ((equal tramp-syntax
'url
) "[")
721 (t (error "Wrong `tramp-syntax' defined")))
722 "*String matching left hand side of IPv6 addresses.
723 Used in `tramp-make-tramp-file-name'.")
725 (defconst tramp-prefix-ipv6-regexp
726 (regexp-quote tramp-prefix-ipv6-format
)
727 "*Regexp matching left hand side of IPv6 addresses.
728 Derived from `tramp-prefix-ipv6-format'.")
730 ;; The following regexp is a bit sloppy. But it shall serve our
731 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
732 ;; "::ffff:192.168.0.1".
733 (defconst tramp-ipv6-regexp
734 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
735 "*Regexp matching IPv6 addresses.")
737 (defconst tramp-postfix-ipv6-format
738 (cond ((equal tramp-syntax
'ftp
) "]")
739 ((equal tramp-syntax
'sep
) "")
740 ((equal tramp-syntax
'url
) "]")
741 (t (error "Wrong `tramp-syntax' defined")))
742 "*String matching right hand side of IPv6 addresses.
743 Used in `tramp-make-tramp-file-name'.")
745 (defconst tramp-postfix-ipv6-regexp
746 (regexp-quote tramp-postfix-ipv6-format
)
747 "*Regexp matching right hand side of IPv6 addresses.
748 Derived from `tramp-postfix-ipv6-format'.")
750 (defconst tramp-prefix-port-format
751 (cond ((equal tramp-syntax
'ftp
) "#")
752 ((equal tramp-syntax
'sep
) "#")
753 ((equal tramp-syntax
'url
) ":")
754 (t (error "Wrong `tramp-syntax' defined")))
755 "*String matching delimiter between host names and port numbers.")
757 (defconst tramp-prefix-port-regexp
758 (regexp-quote tramp-prefix-port-format
)
759 "*Regexp matching delimiter between host names and port numbers.
760 Derived from `tramp-prefix-port-format'.")
762 (defconst tramp-port-regexp
"[0-9]+"
763 "*Regexp matching port numbers.")
765 (defconst tramp-host-with-port-regexp
766 (concat "\\(" tramp-host-regexp
"\\)"
767 tramp-prefix-port-regexp
768 "\\(" tramp-port-regexp
"\\)")
769 "*Regexp matching host names with port numbers.")
771 (defconst tramp-postfix-host-format
772 (cond ((equal tramp-syntax
'ftp
) ":")
773 ((equal tramp-syntax
'sep
) "]")
774 ((equal tramp-syntax
'url
) "")
775 (t (error "Wrong `tramp-syntax' defined")))
776 "*String matching delimiter between host names and localnames.
777 Used in `tramp-make-tramp-file-name'.")
779 (defconst tramp-postfix-host-regexp
780 (regexp-quote tramp-postfix-host-format
)
781 "*Regexp matching delimiter between host names and localnames.
782 Derived from `tramp-postfix-host-format'.")
784 (defconst tramp-localname-regexp
".*$"
785 "*Regexp matching localnames.")
787 ;;; File name format:
789 (defconst tramp-file-name-structure
793 "\\(" "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
"\\)?"
794 "\\(" "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
"\\)?"
795 "\\(" "\\(" tramp-host-regexp
797 tramp-prefix-ipv6-regexp tramp-ipv6-regexp
798 tramp-postfix-ipv6-regexp
"\\)"
799 "\\(" tramp-prefix-port-regexp tramp-port-regexp
"\\)?" "\\)?"
800 tramp-postfix-host-regexp
801 "\\(" tramp-localname-regexp
"\\)")
804 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
805 the Tramp file name structure.
807 The first element REGEXP is a regular expression matching a Tramp file
808 name. The regex should contain parentheses around the method name,
809 the user name, the host name, and the file name parts.
811 The second element METHOD is a number, saying which pair of
812 parentheses matches the method name. The third element USER is
813 similar, but for the user name. The fourth element HOST is similar,
814 but for the host name. The fifth element FILE is for the file name.
815 These numbers are passed directly to `match-string', which see. That
816 means the opening parentheses are counted to identify the pair.
818 See also `tramp-file-name-regexp'.")
821 (defconst tramp-file-name-regexp-unified
822 (if (memq system-type
'(cygwin windows-nt
))
823 "\\`/\\([^[/:]\\{2,\\}\\|[^/]\\{2,\\}]\\):"
824 "\\`/\\([^[/:]+\\|[^/]+]\\):")
825 "Value for `tramp-file-name-regexp' for unified remoting.
826 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
827 Tramp. See `tramp-file-name-structure' for more explanations.
829 On W32 systems, the volume letter must be ignored.")
832 (defconst tramp-file-name-regexp-separate
"\\`/\\[.*\\]"
833 "Value for `tramp-file-name-regexp' for separate remoting.
834 XEmacs uses a separate filename syntax for Tramp and EFS.
835 See `tramp-file-name-structure' for more explanations.")
838 (defconst tramp-file-name-regexp-url
"\\`/[^/:]+://"
839 "Value for `tramp-file-name-regexp' for URL-like remoting.
840 See `tramp-file-name-structure' for more explanations.")
843 (defconst tramp-file-name-regexp
844 (cond ((equal tramp-syntax
'ftp
) tramp-file-name-regexp-unified
)
845 ((equal tramp-syntax
'sep
) tramp-file-name-regexp-separate
)
846 ((equal tramp-syntax
'url
) tramp-file-name-regexp-url
)
847 (t (error "Wrong `tramp-syntax' defined")))
848 "*Regular expression matching file names handled by Tramp.
849 This regexp should match Tramp file names but no other file names.
850 When tramp.el is loaded, this regular expression is prepended to
851 `file-name-handler-alist', and that is searched sequentially. Thus,
852 if the Tramp entry appears rather early in the `file-name-handler-alist'
853 and is a bit too general, then some files might be considered Tramp
854 files which are not really Tramp files.
856 Please note that the entry in `file-name-handler-alist' is made when
857 this file \(tramp.el\) is loaded. This means that this variable must be set
858 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
859 updated after changing this variable.
861 Also see `tramp-file-name-structure'.")
864 (defconst tramp-root-regexp
865 (if (memq system-type
'(cygwin windows-nt
))
866 "\\`\\([a-zA-Z]:\\)?/"
868 "Beginning of an incomplete Tramp file name.
869 Usually, it is just \"\\\\`/\". On W32 systems, there might be a
870 volume letter, which will be removed by `tramp-drop-volume-letter'.")
873 (defconst tramp-completion-file-name-regexp-unified
874 (if (memq system-type
'(cygwin windows-nt
))
875 (concat tramp-root-regexp
"[^/]\\{2,\\}\\'")
876 (concat tramp-root-regexp
"[^/]*\\'"))
877 "Value for `tramp-completion-file-name-regexp' for unified remoting.
878 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
879 See `tramp-file-name-structure' for more explanations.
881 On W32 systems, the volume letter must be ignored.")
884 (defconst tramp-completion-file-name-regexp-separate
885 (concat tramp-root-regexp
"\\([[][^]]*\\)?\\'")
886 "Value for `tramp-completion-file-name-regexp' for separate remoting.
887 XEmacs uses a separate filename syntax for Tramp and EFS.
888 See `tramp-file-name-structure' for more explanations.")
891 (defconst tramp-completion-file-name-regexp-url
892 (concat tramp-root-regexp
"[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?\\'")
893 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
894 See `tramp-file-name-structure' for more explanations.")
897 (defconst tramp-completion-file-name-regexp
898 (cond ((equal tramp-syntax
'ftp
) tramp-completion-file-name-regexp-unified
)
899 ((equal tramp-syntax
'sep
) tramp-completion-file-name-regexp-separate
)
900 ((equal tramp-syntax
'url
) tramp-completion-file-name-regexp-url
)
901 (t (error "Wrong `tramp-syntax' defined")))
902 "*Regular expression matching file names handled by Tramp completion.
903 This regexp should match partial Tramp file names only.
905 Please note that the entry in `file-name-handler-alist' is made when
906 this file (tramp.el) is loaded. This means that this variable must be set
907 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
908 updated after changing this variable.
910 Also see `tramp-file-name-structure'.")
912 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
913 ;; known to have a bug in `process-send-string'; some ssh connections appear
914 ;; to drop bytes when data is sent too quickly. There is also a connection
915 ;; buffer local variable, which is computed depending on remote host properties
916 ;; when `tramp-chunksize' is zero or nil.
917 (defcustom tramp-chunksize
918 (when (and (not (featurep 'xemacs
))
919 (memq system-type
'(hpux)))
921 ;; Parentheses in docstring starting at beginning of line are escaped.
922 ;; Fontification is messed up when
923 ;; `open-paren-in-column-0-is-defun-start' set to t.
924 "*If non-nil, chunksize for sending input to local process.
925 It is necessary only on systems which have a buggy `process-send-string'
926 implementation. The necessity, whether this variable must be set, can be
927 checked via the following code:
930 (let* ((user \"xxx\") (host \"yyy\")
932 (sent init) (received init))
933 (while (= sent received)
934 (setq sent (+ sent step))
936 (let ((proc (start-process (buffer-name) (current-buffer)
937 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
938 (when (memq (process-status proc) '(run open))
939 (process-send-string proc (make-string sent ?\\ ))
940 (process-send-eof proc)
941 (process-send-eof proc))
942 (while (not (progn (goto-char (point-min))
943 (re-search-forward \"\\\\w+\" (point-max) t)))
944 (accept-process-output proc 1))
945 (when (memq (process-status proc) '(run open))
946 (setq received (string-to-number (match-string 0)))
947 (delete-process proc)
948 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
950 (if (> sent (+ init step))
951 (message \"You should set `tramp-chunksize' to a maximum of %s\"
953 (message \"Test does not work\")
954 (display-buffer (current-buffer))
957 In the Emacs normally running Tramp, evaluate the above code
958 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
959 respectively\). You can do this, for example, by pasting it into
960 the `*scratch*' buffer and then hitting C-j with the cursor after the
961 last closing parenthesis. Note that it works only if you have configured
962 \"ssh\" to run without password query, see ssh-agent\(1\).
964 You will see the number of bytes sent successfully to the remote host.
965 If that number exceeds 1000, you can stop the execution by hitting
966 C-g, because your Emacs is likely clean.
968 When it is necessary to set `tramp-chunksize', you might consider to
969 use an out-of-the-band method \(like \"scp\"\) instead of an internal one
970 \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases
973 If your Emacs is buggy, the code stops and gives you an indication
974 about the value `tramp-chunksize' should be set. Maybe you could just
975 experiment a bit, e.g. changing the values of `init' and `step'
976 in the third line of the code.
978 Please raise a bug report via \"M-x tramp-bug\" if your system needs
979 this variable to be set as well."
981 :type
'(choice (const nil
) integer
))
983 ;; Logging in to a remote host normally requires obtaining a pty. But
984 ;; Emacs on MacOS X has process-connection-type set to nil by default,
985 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
986 ;; for an override of the system default.
987 (defcustom tramp-process-connection-type t
988 "Overrides `process-connection-type' for connections from Tramp.
989 Tramp binds process-connection-type to the value given here before
990 opening a connection to a remote host."
992 :type
'(choice (const nil
) (const t
) (const pty
)))
994 (defcustom tramp-completion-reread-directory-timeout
10
995 "Defines seconds since last remote command before rereading a directory.
996 A remote directory might have changed its contents. In order to
997 make it visible during file name completion in the minibuffer,
998 Tramp flushes its cache and rereads the directory contents when
999 more than `tramp-completion-reread-directory-timeout' seconds
1000 have been gone since last remote command execution. A value of `t'
1001 would require an immediate reread during filename completion, `nil'
1002 means to use always cached values for the directory contents."
1004 :type
'(choice (const nil
) integer
))
1006 ;;; Internal Variables:
1008 (defvar tramp-current-method nil
1009 "Connection method for this *tramp* buffer.")
1011 (defvar tramp-current-user nil
1012 "Remote login name for this *tramp* buffer.")
1014 (defvar tramp-current-host nil
1015 "Remote host for this *tramp* buffer.")
1018 (defconst tramp-completion-file-name-handler-alist
1019 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions
)
1020 (file-name-completion . tramp-completion-handle-file-name-completion
))
1021 "Alist of completion handler functions.
1022 Used for file names matching `tramp-file-name-regexp'. Operations
1023 not mentioned here will be handled by Tramp's file name handler
1024 functions, or the normal Emacs functions.")
1026 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1027 ;;;###tramp-autoload
1028 (defvar tramp-foreign-file-name-handler-alist nil
1029 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1030 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1033 ;;; Internal functions which must come first:
1035 ;; Conversion functions between external representation and
1036 ;; internal data structure. Convenience functions for internal
1039 (defun tramp-file-name-p (vec)
1040 "Check, whether VEC is a Tramp object."
1041 (and (vectorp vec
) (= 4 (length vec
))))
1043 (defun tramp-file-name-method (vec)
1044 "Return method component of VEC."
1045 (and (tramp-file-name-p vec
) (aref vec
0)))
1047 (defun tramp-file-name-user (vec)
1048 "Return user component of VEC."
1049 (and (tramp-file-name-p vec
) (aref vec
1)))
1051 (defun tramp-file-name-host (vec)
1052 "Return host component of VEC."
1053 (and (tramp-file-name-p vec
) (aref vec
2)))
1055 (defun tramp-file-name-localname (vec)
1056 "Return localname component of VEC."
1057 (and (tramp-file-name-p vec
) (aref vec
3)))
1059 ;; The user part of a Tramp file name vector can be of kind
1060 ;; "user%domain". Sometimes, we must extract these parts.
1061 (defun tramp-file-name-real-user (vec)
1062 "Return the user name of VEC without domain."
1064 (let ((user (tramp-file-name-user vec
)))
1065 (if (and (stringp user
)
1066 (string-match tramp-user-with-domain-regexp user
))
1067 (match-string 1 user
)
1070 (defun tramp-file-name-domain (vec)
1071 "Return the domain name of VEC."
1073 (let ((user (tramp-file-name-user vec
)))
1075 (string-match tramp-user-with-domain-regexp user
)
1076 (match-string 2 user
)))))
1078 ;; The host part of a Tramp file name vector can be of kind
1079 ;; "host#port". Sometimes, we must extract these parts.
1080 (defun tramp-file-name-real-host (vec)
1081 "Return the host name of VEC without port."
1083 (let ((host (tramp-file-name-host vec
)))
1084 (if (and (stringp host
)
1085 (string-match tramp-host-with-port-regexp host
))
1086 (match-string 1 host
)
1089 (defun tramp-file-name-port (vec)
1090 "Return the port number of VEC."
1092 (let ((method (tramp-file-name-method vec
))
1093 (host (tramp-file-name-host vec
)))
1094 (or (and (stringp host
)
1095 (string-match tramp-host-with-port-regexp host
)
1096 (string-to-number (match-string 2 host
)))
1097 (tramp-get-method-parameter method
'tramp-default-port
)))))
1099 ;;;###tramp-autoload
1100 (defun tramp-tramp-file-p (name)
1101 "Return t if NAME is a string with Tramp file name syntax."
1103 (and (stringp name
) (string-match tramp-file-name-regexp name
))))
1105 (defun tramp-find-method (method user host
)
1106 "Return the right method string to use.
1107 This is METHOD, if non-nil. Otherwise, do a lookup in
1108 `tramp-default-method-alist'."
1110 (let ((choices tramp-default-method-alist
)
1113 (setq item
(pop choices
))
1114 (when (and (string-match (or (nth 0 item
) "") (or host
""))
1115 (string-match (or (nth 1 item
) "") (or user
"")))
1116 (setq lmethod
(nth 2 item
))
1117 (setq choices nil
)))
1119 tramp-default-method
))
1121 (defun tramp-find-user (method user host
)
1122 "Return the right user string to use.
1123 This is USER, if non-nil. Otherwise, do a lookup in
1124 `tramp-default-user-alist'."
1126 (let ((choices tramp-default-user-alist
)
1129 (setq item
(pop choices
))
1130 (when (and (string-match (or (nth 0 item
) "") (or method
""))
1131 (string-match (or (nth 1 item
) "") (or host
"")))
1132 (setq luser
(nth 2 item
))
1133 (setq choices nil
)))
1135 tramp-default-user
))
1137 (defun tramp-find-host (method user host
)
1138 "Return the right host string to use.
1139 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1140 (or (and (> (length host
) 0) host
)
1141 tramp-default-host
))
1143 (defun tramp-dissect-file-name (name &optional nodefault
)
1144 "Return a `tramp-file-name' structure.
1145 The structure consists of remote method, remote user, remote host
1146 and localname (file name on remote host). If NODEFAULT is
1147 non-nil, the file name parts are not expanded to their default
1150 (let ((match (string-match (nth 0 tramp-file-name-structure
) name
)))
1151 (unless match
(error "Not a Tramp file name: %s" name
))
1152 (let ((method (match-string (nth 1 tramp-file-name-structure
) name
))
1153 (user (match-string (nth 2 tramp-file-name-structure
) name
))
1154 (host (match-string (nth 3 tramp-file-name-structure
) name
))
1155 (localname (match-string (nth 4 tramp-file-name-structure
) name
)))
1157 (when (string-match tramp-prefix-ipv6-regexp host
)
1158 (setq host
(replace-match "" nil t host
)))
1159 (when (string-match tramp-postfix-ipv6-regexp host
)
1160 (setq host
(replace-match "" nil t host
))))
1162 (vector method user host localname
)
1164 (tramp-find-method method user host
)
1165 (tramp-find-user method user host
)
1166 (tramp-find-host method user host
)
1169 (defun tramp-buffer-name (vec)
1170 "A name for the connection buffer VEC."
1171 ;; We must use `tramp-file-name-real-host', because for gateway
1172 ;; methods the default port will be expanded later on, which would
1174 (let ((method (tramp-file-name-method vec
))
1175 (user (tramp-file-name-user vec
))
1176 (host (tramp-file-name-real-host vec
)))
1177 (if (not (zerop (length user
)))
1178 (format "*tramp/%s %s@%s*" method user host
)
1179 (format "*tramp/%s %s*" method host
))))
1181 (defun tramp-make-tramp-file-name (method user host localname
)
1182 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME."
1183 (concat tramp-prefix-format
1184 (when (not (zerop (length method
)))
1185 (concat method tramp-postfix-method-format
))
1186 (when (not (zerop (length user
)))
1187 (concat user tramp-postfix-user-format
))
1189 (if (string-match tramp-ipv6-regexp host
)
1190 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format
)
1192 tramp-postfix-host-format
1193 (when localname localname
)))
1195 (defun tramp-completion-make-tramp-file-name (method user host localname
)
1196 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1197 It must not be a complete Tramp file name, but as long as there are
1198 necessary only. This function will be used in file name completion."
1199 (concat tramp-prefix-format
1200 (when (not (zerop (length method
)))
1201 (concat method tramp-postfix-method-format
))
1202 (when (not (zerop (length user
)))
1203 (concat user tramp-postfix-user-format
))
1204 (when (not (zerop (length host
)))
1206 (if (string-match tramp-ipv6-regexp host
)
1208 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format
)
1210 tramp-postfix-host-format
))
1211 (when localname localname
)))
1213 (defun tramp-get-buffer (vec)
1214 "Get the connection buffer to be used for VEC."
1215 (or (get-buffer (tramp-buffer-name vec
))
1216 (with-current-buffer (get-buffer-create (tramp-buffer-name vec
))
1217 (setq buffer-undo-list t
)
1218 (setq default-directory
1219 (tramp-make-tramp-file-name
1220 (tramp-file-name-method vec
)
1221 (tramp-file-name-user vec
)
1222 (tramp-file-name-host vec
)
1226 (defun tramp-get-connection-buffer (vec)
1227 "Get the connection buffer to be used for VEC.
1228 In case a second asynchronous communication has been started, it is different
1229 from `tramp-get-buffer'."
1230 (or (tramp-get-connection-property vec
"process-buffer" nil
)
1231 (tramp-get-buffer vec
)))
1233 (defun tramp-get-connection-name (vec)
1234 "Get the connection name to be used for VEC.
1235 In case a second asynchronous communication has been started, it is different
1236 from the default one."
1237 (or (tramp-get-connection-property vec
"process-name" nil
)
1238 (tramp-buffer-name vec
)))
1240 (defun tramp-get-connection-process (vec)
1241 "Get the connection process to be used for VEC.
1242 In case a second asynchronous communication has been started, it is different
1243 from the default one."
1244 (get-process (tramp-get-connection-name vec
)))
1246 (defun tramp-debug-buffer-name (vec)
1247 "A name for the debug buffer for VEC."
1248 ;; We must use `tramp-file-name-real-host', because for gateway
1249 ;; methods the default port will be expanded later on, which would
1251 (let ((method (tramp-file-name-method vec
))
1252 (user (tramp-file-name-user vec
))
1253 (host (tramp-file-name-real-host vec
)))
1254 (if (not (zerop (length user
)))
1255 (format "*debug tramp/%s %s@%s*" method user host
)
1256 (format "*debug tramp/%s %s*" method host
))))
1258 (defconst tramp-debug-outline-regexp
1259 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1260 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1262 (defun tramp-debug-outline-level ()
1263 "Return the depth to which a statement is nested in the outline.
1264 Point must be at the beginning of a header line.
1266 The outline level is equal to the verbosity of the Tramp message."
1267 (1+ (string-to-number (match-string 1))))
1269 (defun tramp-get-debug-buffer (vec)
1270 "Get the debug buffer for VEC."
1271 (with-current-buffer
1272 (get-buffer-create (tramp-debug-buffer-name vec
))
1274 (setq buffer-undo-list t
)
1275 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1276 ;; `outline-mode-hook'. We must prevent that local processes
1277 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1278 ;; Furthermore, `outline-regexp' must have the correct value
1279 ;; already, because it is used by `font-lock-compile-keywords'.
1280 (let ((default-directory (tramp-compat-temporary-file-directory))
1281 (outline-regexp tramp-debug-outline-regexp
))
1283 (set (make-local-variable 'outline-regexp
) tramp-debug-outline-regexp
)
1284 (set (make-local-variable 'outline-level
) 'tramp-debug-outline-level
))
1287 (defsubst tramp-debug-message
(vec fmt-string
&rest args
)
1288 "Append message to debug buffer.
1289 Message is formatted with FMT-STRING as control string and the remaining
1290 ARGS to actually emit the message (if applicable)."
1291 (when (get-buffer (tramp-buffer-name vec
))
1292 (with-current-buffer (tramp-get-debug-buffer vec
)
1293 (goto-char (point-max))
1298 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1299 (if (featurep 'sxemacs
) "SX" (if (featurep 'xemacs
) "X" "GNU "))
1300 emacs-version tramp-version
)))
1304 (let ((now (current-time)))
1305 (insert (format-time-string "%T." now
))
1306 (insert (format "%06d " (nth 2 now
))))
1307 ;; Calling Tramp function. We suppress compat and trace
1308 ;; functions from being displayed.
1309 (let ((btn 1) btf fn
)
1311 (setq btf
(nth 1 (backtrace-frame btn
)))
1315 (setq fn
(symbol-name btf
))
1318 (string-match "^tramp" fn
)
1324 '("tramp-compat-funcall"
1325 "tramp-compat-with-temp-message"
1326 "tramp-debug-message"
1328 "tramp-error-with-buffer"
1330 "tramp-with-progress-reporter")
1335 (setq btn
(1+ btn
))))
1336 ;; The following code inserts filename and line number.
1337 ;; Should be deactivated by default, because it is time
1339 ; (let ((ffn (find-function-noselect (intern fn))))
1343 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1344 ; (with-current-buffer (car ffn)
1345 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1346 (insert (format "%s " fn
)))
1348 (insert (apply 'format fmt-string args
)))))
1350 (defvar tramp-message-show-message t
1351 "Show Tramp message in the minibuffer.
1352 This variable is used to disable messages from `tramp-error'.
1353 The messages are visible anyway, because an error is raised.")
1355 (defsubst tramp-message
(vec-or-proc level fmt-string
&rest args
)
1356 "Emit a message depending on verbosity level.
1357 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1358 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1359 less than LEVEL. The message is emitted only if `tramp-verbose' is
1360 greater than or equal to LEVEL.
1362 The message is also logged into the debug buffer when `tramp-verbose'
1363 is greater than or equal 4.
1365 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1366 control string and the remaining ARGS to actually emit the message (if
1369 (when (<= level tramp-verbose
)
1370 ;; Match data must be preserved!
1372 ;; Display only when there is a minimum level.
1373 (when (and tramp-message-show-message
(<= level
3))
1379 ((= level
2) "Warning: ")
1383 ;; Log only when there is a minimum level.
1384 (when (>= tramp-verbose
4)
1385 (when (and vec-or-proc
1386 (processp vec-or-proc
)
1387 (buffer-name (process-buffer vec-or-proc
)))
1388 (with-current-buffer (process-buffer vec-or-proc
)
1389 ;; Translate proc to vec.
1390 (setq vec-or-proc
(tramp-dissect-file-name default-directory
))))
1391 (when (and vec-or-proc
(vectorp vec-or-proc
))
1392 (apply 'tramp-debug-message
1394 (concat (format "(%d) # " level
) fmt-string
)
1397 (defsubst tramp-error
(vec-or-proc signal fmt-string
&rest args
)
1399 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1400 signal identifier to be raised, remaining args passed to
1401 `tramp-message'. Finally, signal SIGNAL is raised."
1402 (let (tramp-message-show-message)
1405 (error-message-string
1407 (get signal
'error-message
)
1408 (apply 'format fmt-string args
))))
1409 (signal signal
(list (apply 'format fmt-string args
)))))
1411 (defsubst tramp-error-with-buffer
1412 (buffer vec-or-proc signal fmt-string
&rest args
)
1413 "Emit an error, and show BUFFER.
1414 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
1415 an input event arrives. The other arguments are passed to `tramp-error'."
1416 (save-window-excursion
1418 (apply 'tramp-error vec-or-proc signal fmt-string args
)
1419 (when (and vec-or-proc
1420 (not (zerop tramp-verbose
))
1421 (not (tramp-completion-mode-p)))
1422 (let ((enable-recursive-minibuffers t
))
1424 (or (and (bufferp buffer
) buffer
)
1425 (and (processp vec-or-proc
) (process-buffer vec-or-proc
))
1426 (tramp-get-buffer vec-or-proc
)))
1429 (defmacro with-parsed-tramp-file-name
(filename var
&rest body
)
1430 "Parse a Tramp filename and make components available in the body.
1432 First arg FILENAME is evaluated and dissected into its components.
1433 Second arg VAR is a symbol. It is used as a variable name to hold
1434 the filename structure. It is also used as a prefix for the variables
1435 holding the components. For example, if VAR is the symbol `foo', then
1436 `foo' will be bound to the whole structure, `foo-method' will be bound to
1437 the method component, and so on for `foo-user', `foo-host', `foo-localname'.
1439 Remaining args are Lisp expressions to be evaluated (inside an implicit
1442 If VAR is nil, then we bind `v' to the structure and `method', `user',
1443 `host', `localname' to the components."
1444 `(let* ((,(or var
'v
) (tramp-dissect-file-name ,filename
))
1445 (,(if var
(intern (concat (symbol-name var
) "-method")) 'method
)
1446 (tramp-file-name-method ,(or var
'v
)))
1447 (,(if var
(intern (concat (symbol-name var
) "-user")) 'user
)
1448 (tramp-file-name-user ,(or var
'v
)))
1449 (,(if var
(intern (concat (symbol-name var
) "-host")) 'host
)
1450 (tramp-file-name-host ,(or var
'v
)))
1451 (,(if var
(intern (concat (symbol-name var
) "-localname")) 'localname
)
1452 (tramp-file-name-localname ,(or var
'v
))))
1455 (put 'with-parsed-tramp-file-name
'lisp-indent-function
2)
1456 (put 'with-parsed-tramp-file-name
'edebug-form-spec
'(form symbolp body
))
1457 (tramp-compat-font-lock-add-keywords
1458 'emacs-lisp-mode
'("\\<with-parsed-tramp-file-name\\>"))
1460 (defun tramp-progress-reporter-update (reporter &optional value
)
1461 (let* ((parameters (cdr reporter
))
1462 (message (aref parameters
3)))
1463 (when (string-match message
(or (current-message) ""))
1464 (tramp-compat-funcall 'progress-reporter-update reporter value
))))
1466 (defmacro tramp-with-progress-reporter
(vec level message
&rest body
)
1467 "Executes BODY, spinning a progress reporter with MESSAGE.
1468 If LEVEL does not fit for visible messages, or if this is a
1469 nested call of the macro, there are only traces without a visible
1471 (declare (indent 3) (debug t
))
1473 (tramp-message ,vec
,level
"%s..." ,message
)
1474 ;; We start a pulsing progress reporter after 3 seconds. Feature
1475 ;; introduced in Emacs 24.1.
1476 (when (and tramp-message-show-message
1477 ;; Display only when there is a minimum level.
1478 (<= ,level
(min tramp-verbose
3)))
1480 (setq pr
(tramp-compat-funcall 'make-progress-reporter
,message
)
1482 (run-at-time 3 0.1 'tramp-progress-reporter-update pr
)))))
1484 ;; Execute the body. Unset `tramp-message-show-message' when
1485 ;; the timer object is created, in order to suppress
1486 ;; concurrent timers.
1487 (let ((tramp-message-show-message
1488 (and tramp-message-show-message
(not tm
))))
1490 ;; Stop progress reporter.
1491 (if tm
(tramp-compat-funcall 'cancel-timer tm
))
1492 (tramp-message ,vec
,level
"%s...done" ,message
))))
1494 (tramp-compat-font-lock-add-keywords
1495 'emacs-lisp-mode
'("\\<tramp-with-progress-reporter\\>"))
1497 (eval-and-compile ;; Silence compiler.
1498 (if (memq system-type
'(cygwin windows-nt
))
1499 (defun tramp-drop-volume-letter (name)
1500 "Cut off unnecessary drive letter from file NAME.
1501 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1502 locally on a remote file name. When the local system is a W32 system
1503 but the remote system is Unix, this introduces a superfluous drive
1504 letter into the file name. This function removes it."
1506 (if (string-match tramp-root-regexp name
)
1507 (replace-match "/" nil t name
)
1510 (defalias 'tramp-drop-volume-letter
'identity
)))
1512 ;;; Config Manipulation Functions:
1514 ;;;###tramp-autoload
1515 (defun tramp-set-completion-function (method function-list
)
1516 "Sets the list of completion functions for METHOD.
1517 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1518 The FUNCTION is intended to parse FILE according its syntax.
1519 It might be a predefined FUNCTION, or a user defined FUNCTION.
1520 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
1521 `tramp-parse-sconfig', `tramp-parse-hosts', `tramp-parse-passwd',
1522 and `tramp-parse-netrc'.
1526 (tramp-set-completion-function
1528 '((tramp-parse-sconfig \"/etc/ssh_config\")
1529 (tramp-parse-sconfig \"~/.ssh/config\")))"
1531 (let ((r function-list
)
1533 (setq tramp-completion-function-alist
1534 (delete (assoc method tramp-completion-function-alist
)
1535 tramp-completion-function-alist
))
1538 ;; Remove double entries.
1539 (when (member (car v
) (cdr v
))
1540 (setcdr v
(delete (car v
) (cdr v
))))
1541 ;; Check for function and file or registry key.
1542 (unless (and (functionp (nth 0 (car v
)))
1543 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v
)))
1544 ;; Windows registry.
1545 (and (memq system-type
'(cygwin windows-nt
))
1547 (tramp-compat-call-process
1548 "reg" nil nil nil
"query" (nth 1 (car v
)))))
1549 ;; Configuration file.
1550 (file-exists-p (nth 1 (car v
)))))
1551 (setq r
(delete (car v
) r
)))
1555 (add-to-list 'tramp-completion-function-alist
1558 (defun tramp-get-completion-function (method)
1559 "Returns a list of completion functions for METHOD.
1560 For definition of that list see `tramp-set-completion-function'."
1562 ;; Hosts visited once shall be remembered.
1563 `(tramp-parse-connection-properties ,method
)
1564 ;; The method related defaults.
1565 (cdr (assoc method tramp-completion-function-alist
))))
1568 ;;; Fontification of `read-file-name':
1570 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1571 (defvar tramp-rfn-eshadow-overlay
)
1572 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay
)
1574 (defun tramp-rfn-eshadow-setup-minibuffer ()
1575 "Set up a minibuffer for `file-name-shadow-mode'.
1576 Adds another overlay hiding filename parts according to Tramp's
1577 special handling of `substitute-in-file-name'."
1578 (when (symbol-value 'minibuffer-completing-file-name
)
1579 (setq tramp-rfn-eshadow-overlay
1580 (tramp-compat-funcall
1582 (tramp-compat-funcall 'minibuffer-prompt-end
)
1583 (tramp-compat-funcall 'minibuffer-prompt-end
)))
1584 ;; Copy rfn-eshadow-overlay properties.
1585 (let ((props (tramp-compat-funcall
1586 'overlay-properties
(symbol-value 'rfn-eshadow-overlay
))))
1588 ;; The `field' property prevents correct minibuffer
1589 ;; completion; we exclude it.
1590 (if (not (eq (car props
) 'field
))
1591 (tramp-compat-funcall
1592 'overlay-put tramp-rfn-eshadow-overlay
(pop props
) (pop props
))
1593 (pop props
) (pop props
))))))
1595 (when (boundp 'rfn-eshadow-setup-minibuffer-hook
)
1596 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1597 'tramp-rfn-eshadow-setup-minibuffer
)
1598 (add-hook 'tramp-unload-hook
1600 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1601 'tramp-rfn-eshadow-setup-minibuffer
))))
1603 (defconst tramp-rfn-eshadow-update-overlay-regexp
1604 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format
))
1606 (defun tramp-rfn-eshadow-update-overlay ()
1607 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1608 This is intended to be used as a minibuffer `post-command-hook' for
1609 `file-name-shadow-mode'; the minibuffer should have already
1610 been set up by `rfn-eshadow-setup-minibuffer'."
1611 ;; In remote files name, there is a shadowing just for the local part.
1612 (let ((end (or (tramp-compat-funcall
1613 'overlay-end
(symbol-value 'rfn-eshadow-overlay
))
1614 (tramp-compat-funcall 'minibuffer-prompt-end
))))
1617 (tramp-compat-funcall 'buffer-substring-no-properties end
(point-max)))
1621 (1+ (or (string-match
1622 tramp-rfn-eshadow-update-overlay-regexp
(buffer-string) end
)
1625 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay
)
1626 (rfn-eshadow-update-overlay-hook nil
))
1627 (tramp-compat-funcall
1628 'move-overlay rfn-eshadow-overlay
(point-max) (point-max))
1629 (tramp-compat-funcall 'rfn-eshadow-update-overlay
)))))))
1631 (when (boundp 'rfn-eshadow-update-overlay-hook
)
1632 (add-hook 'rfn-eshadow-update-overlay-hook
1633 'tramp-rfn-eshadow-update-overlay
)
1634 (add-hook 'tramp-unload-hook
1636 (remove-hook 'rfn-eshadow-update-overlay-hook
1637 'tramp-rfn-eshadow-update-overlay
))))
1639 ;; Inodes don't exist for some file systems. Therefore we must
1640 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1641 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1642 ;; performance isn't the major issue given that file transfer will
1644 (defvar tramp-inodes nil
1645 "Keeps virtual inodes numbers.")
1647 ;; Devices must distinguish physical file systems. The device numbers
1648 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1649 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1650 ;; EFS use device number "-1". In order to be different, we use device number
1651 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1652 (defvar tramp-devices nil
1653 "Keeps virtual device numbers.")
1655 (defun tramp-default-file-modes (filename)
1656 "Return file modes of FILENAME as integer.
1657 If the file modes of FILENAME cannot be determined, return the
1658 value of `default-file-modes', without execute permissions."
1659 (or (file-modes filename
)
1660 (logand (default-file-modes) (tramp-compat-octal-to-decimal "0666"))))
1662 (defun tramp-replace-environment-variables (filename)
1663 "Replace environment variables in FILENAME.
1664 Return the string with the replaced variables."
1666 (let ((idx (string-match "$\\(\\w+\\)" filename
)))
1667 ;; `$' is coded as `$$'.
1669 (or (zerop idx
) (not (eq ?$
(aref filename
(1- idx
)))))
1670 (getenv (match-string 1 filename
)))
1673 (substitute-in-file-name (match-string 0 filename
))
1677 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
1678 ;; which calls corresponding functions (see minibuf.el).
1679 (when (fboundp 'minibuffer-electric-separator
)
1684 (around ,(intern (format "tramp-advice-%s" x
)) activate
)
1685 "Invoke `substitute-in-file-name' for Tramp files."
1686 (if (and (symbol-value 'minibuffer-electric-file-name-behavior
)
1687 (tramp-tramp-file-p (buffer-substring)))
1688 ;; We don't need to handle `last-input-event', because
1689 ;; due to the key map we know it must be ?/ or ?~.
1690 (let ((s (concat (buffer-substring (point-min) (point))
1691 (string last-command-char
))))
1692 (delete-region (point-min) (point))
1693 (insert (substitute-in-file-name s
))
1694 (setq ad-return-value last-command-char
))
1700 (ad-remove-advice ',x
'around
',(intern (format "tramp-advice-%s" x
)))
1701 (ad-activate ',x
)))))
1703 '(minibuffer-electric-separator
1704 minibuffer-electric-tilde
)))
1706 (defun tramp-find-file-name-coding-system-alist (filename tmpname
)
1707 "Like `find-operation-coding-system' for Tramp filenames.
1708 Tramp's `insert-file-contents' and `write-region' work over
1709 temporary file names. If `file-coding-system-alist' contains an
1710 expression, which matches more than the file name suffix, the
1711 coding system might not be determined. This function repairs it."
1713 (dolist (elt file-coding-system-alist result
)
1714 (when (and (consp elt
) (string-match (car elt
) filename
))
1715 ;; We found a matching entry in `file-coding-system-alist'.
1716 ;; So we add a similar entry, but with the temporary file name
1719 'result
(cons (regexp-quote tmpname
) (cdr elt
)) 'append
)))))
1722 (progn (defun tramp-run-real-handler (operation args
)
1723 "Invoke normal file name handler for OPERATION.
1724 First arg specifies the OPERATION, second arg is a list of arguments to
1725 pass to the OPERATION."
1726 (let* ((inhibit-file-name-handlers
1727 `(tramp-file-name-handler
1728 tramp-vc-file-name-handler
1729 tramp-completion-file-name-handler
1730 cygwin-mount-name-hook-function
1731 cygwin-mount-map-drive-hook-function
1733 ,(and (eq inhibit-file-name-operation operation
)
1734 inhibit-file-name-handlers
)))
1735 (inhibit-file-name-operation operation
))
1736 (apply operation args
))))
1739 (progn (defun tramp-completion-run-real-handler (operation args
)
1740 "Invoke `tramp-file-name-handler' for OPERATION.
1741 First arg specifies the OPERATION, second arg is a list of arguments to
1742 pass to the OPERATION."
1743 (let* ((inhibit-file-name-handlers
1744 `(tramp-completion-file-name-handler
1745 cygwin-mount-name-hook-function
1746 cygwin-mount-map-drive-hook-function
1748 ,(and (eq inhibit-file-name-operation operation
)
1749 inhibit-file-name-handlers
)))
1750 (inhibit-file-name-operation operation
))
1751 (apply operation args
))))
1753 ;; We handle here all file primitives. Most of them have the file
1754 ;; name as first parameter; nevertheless we check for them explicitly
1755 ;; in order to be signaled if a new primitive appears. This
1756 ;; scenario is needed because there isn't a way to decide by
1757 ;; syntactical means whether a foreign method must be called. It would
1758 ;; ease the life if `file-name-handler-alist' would support a decision
1759 ;; function as well but regexp only.
1760 (defun tramp-file-name-for-operation (operation &rest args
)
1761 "Return file name related to OPERATION file primitive.
1762 ARGS are the arguments OPERATION has been called with."
1764 ;; FILE resp DIRECTORY.
1766 (list 'access-file
'byte-compiler-base-file-name
'delete-directory
1767 'delete-file
'diff-latest-backup-file
'directory-file-name
1768 'directory-files
'directory-files-and-attributes
1769 'dired-compress-file
'dired-uncache
1770 'file-accessible-directory-p
'file-attributes
1771 'file-directory-p
'file-executable-p
'file-exists-p
1772 'file-local-copy
'file-remote-p
'file-modes
1773 'file-name-as-directory
'file-name-directory
1774 'file-name-nondirectory
'file-name-sans-versions
1775 'file-ownership-preserved-p
'file-readable-p
1776 'file-regular-p
'file-symlink-p
'file-truename
1777 'file-writable-p
'find-backup-file-name
'find-file-noselect
1778 'get-file-buffer
'insert-directory
'insert-file-contents
1779 'load
'make-directory
'make-directory-internal
1780 'set-file-modes
'substitute-in-file-name
1781 'unhandled-file-name-directory
'vc-registered
1785 'file-selinux-context
'set-file-selinux-context
1787 'abbreviate-file-name
'create-file-buffer
1788 'dired-file-modtime
'dired-make-compressed-filename
1789 'dired-recursive-delete-directory
'dired-set-file-modtime
1790 'dired-shell-unhandle-file-name
'dired-uucode-file
1791 'insert-file-contents-literally
'make-temp-name
'recover-file
1792 'vm-imap-check-mail
'vm-pop-check-mail
'vm-spool-check-mail
))
1793 (if (file-name-absolute-p (nth 0 args
))
1795 (expand-file-name (nth 0 args
))))
1796 ;; FILE DIRECTORY resp FILE1 FILE2.
1798 (list 'add-name-to-file
'copy-file
'expand-file-name
1799 'file-name-all-completions
'file-name-completion
1800 'file-newer-than-file-p
'make-symbolic-link
'rename-file
1804 'dired-make-relative-symlink
1805 'vm-imap-move-mail
'vm-pop-move-mail
'vm-spool-move-mail
))
1808 ((string-match tramp-file-name-regexp
(nth 0 args
)) (nth 0 args
))
1809 ((string-match tramp-file-name-regexp
(nth 1 args
)) (nth 1 args
))
1810 (t (buffer-file-name (current-buffer))))))
1812 ((eq operation
'write-region
)
1816 (list 'set-visited-file-modtime
'verify-visited-file-modtime
1818 'make-auto-save-file-name
1822 (if (bufferp (nth 0 args
)) (nth 0 args
) (current-buffer))))
1825 (list ;; not in Emacs 23+.
1834 'dired-print-file
'dired-shell-call-process
1836 'executable-find
'start-process
1837 'call-process
'call-process-region
))
1839 ;; Unknown file primitive.
1840 (t (error "unknown file I/O primitive: %s" operation
))))
1842 (defun tramp-find-foreign-file-name-handler (filename)
1843 "Return foreign file name handler if exists."
1844 (when (tramp-tramp-file-p filename
)
1845 (let ((v (tramp-dissect-file-name filename t
))
1846 (handler tramp-foreign-file-name-handler-alist
)
1848 ;; When we are not fully sure that filename completion is safe,
1849 ;; we should not return a handler.
1850 (when (or (tramp-file-name-method v
) (tramp-file-name-user v
)
1851 (and (tramp-file-name-host v
)
1852 (not (member (tramp-file-name-host v
)
1853 (mapcar 'car tramp-methods
))))
1854 (not (tramp-completion-mode-p)))
1856 (setq elt
(car handler
)
1857 handler
(cdr handler
))
1858 (when (funcall (car elt
) filename
)
1865 (defun tramp-file-name-handler (operation &rest args
)
1866 "Invoke Tramp file name handler.
1867 Falls back to normal file name handler if no Tramp file name handler exists."
1871 (tramp-replace-environment-variables
1872 (apply 'tramp-file-name-for-operation operation args
)))
1873 (completion (tramp-completion-mode-p))
1874 (foreign (tramp-find-foreign-file-name-handler filename
)))
1875 (with-parsed-tramp-file-name filename nil
1876 ;; Call the backend function.
1879 (let ((sf (symbol-function foreign
)))
1880 ;; Some packages set the default directory to a
1881 ;; remote path, before respective Tramp packages
1882 ;; are already loaded. This results in
1883 ;; recursive loading. Therefore, we load the
1884 ;; Tramp packages locally.
1885 (when (and (listp sf
) (eq (car sf
) 'autoload
))
1886 (let ((default-directory
1887 (tramp-compat-temporary-file-directory)))
1888 (load (cadr sf
) 'noerror
)))
1889 (apply foreign operation args
))
1891 ;; Trace that somebody has interrupted the operation.
1893 (let (tramp-message-show-message)
1895 v
1 "Interrupt received in operation %s"
1896 (append (list operation
) args
)))
1897 ;; Propagate the quit signal.
1898 (signal (car err
) (cdr err
)))
1900 ;; When we are in completion mode, some failed
1901 ;; operations shall return at least a default value
1902 ;; in order to give the user a chance to correct the
1903 ;; file name in the minibuffer.
1906 ((and completion
(zerop (length localname
))
1907 (memq operation
'(file-exists-p file-directory-p
)))
1909 ((and completion
(zerop (length localname
))
1911 '(expand-file-name file-name-as-directory
)))
1913 ;; Propagate the error.
1914 (t (signal (car err
) (cdr err
))))))
1916 ;; Nothing to do for us.
1917 (tramp-run-real-handler operation args
)))))
1919 ;; When `tramp-mode' is not enabled, we don't do anything.
1920 (tramp-run-real-handler operation args
)))
1922 ;; In Emacs, there is some concurrency due to timers. If a timer
1923 ;; interrupts Tramp and wishes to use the same connection buffer as
1924 ;; the "main" Emacs, then garbage might occur in the connection
1925 ;; buffer. Therefore, we need to make sure that a timer does not use
1926 ;; the same connection buffer as the "main" Emacs. We implement a
1927 ;; cheap global lock, instead of locking each connection buffer
1928 ;; separately. The global lock is based on two variables,
1929 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
1930 ;; (with setq) to indicate a lock. But Tramp also calls itself during
1931 ;; processing of a single file operation, so we need to allow
1932 ;; recursive calls. That's where the `tramp-locker' variable comes in
1933 ;; -- it is let-bound to t during the execution of the current
1934 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
1935 ;; then we should just proceed because we have been called
1936 ;; recursively. But if `tramp-locker' is nil, then we are a timer
1937 ;; interrupting the "main" Emacs, and then we signal an error.
1939 (defvar tramp-locked nil
1940 "If non-nil, then Tramp is currently busy.
1941 Together with `tramp-locker', this implements a locking mechanism
1942 preventing reentrant calls of Tramp.")
1944 (defvar tramp-locker nil
1945 "If non-nil, then a caller has locked Tramp.
1946 Together with `tramp-locked', this implements a locking mechanism
1947 preventing reentrant calls of Tramp.")
1950 (progn (defun tramp-completion-file-name-handler (operation &rest args
)
1951 "Invoke Tramp file name completion handler.
1952 Falls back to normal file name handler if no Tramp file name handler exists."
1953 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
1954 ;; would otherwise use backslash.
1955 (let ((directory-sep-char ?
/)
1956 (fn (assoc operation tramp-completion-file-name-handler-alist
)))
1958 ;; When `tramp-mode' is not enabled, we don't do anything.
1960 ;; For other syntaxes than `sep', the regexp matches many common
1961 ;; situations where the user doesn't actually want to use Tramp.
1962 ;; So to avoid autoloading Tramp after typing just "/s", we
1963 ;; disable this part of the completion, unless the user implicitly
1964 ;; indicated his interest in using a fancier completion system.
1965 (or (eq tramp-syntax
'sep
)
1966 (featurep 'tramp
) ;; If it's loaded, we may as well use it.
1967 ;; `partial-completion-mode' does not exist in XEmacs.
1968 ;; It is obsoleted with Emacs 24.1.
1969 (and (boundp 'partial-completion-mode
)
1970 (symbol-value 'partial-completion-mode
))
1971 ;; FIXME: These may have been loaded even if the user never
1972 ;; intended to use them.
1974 (featurep 'icicles
)))
1975 (save-match-data (apply (cdr fn
) args
))
1976 (tramp-completion-run-real-handler operation args
)))))
1979 (progn (defun tramp-register-file-name-handlers ()
1980 "Add Tramp file name handlers to `file-name-handler-alist'."
1981 ;; Remove autoloaded handlers from file name handler alist. Useful,
1982 ;; if `tramp-syntax' has been changed.
1983 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist
)))
1984 (setq file-name-handler-alist
(delq a1 file-name-handler-alist
)))
1986 'tramp-completion-file-name-handler file-name-handler-alist
)))
1987 (setq file-name-handler-alist
(delq a1 file-name-handler-alist
)))
1988 ;; Add the handlers.
1989 (add-to-list 'file-name-handler-alist
1990 (cons tramp-file-name-regexp
'tramp-file-name-handler
))
1991 (put 'tramp-file-name-handler
'safe-magic t
)
1992 (add-to-list 'file-name-handler-alist
1993 (cons tramp-completion-file-name-regexp
1994 'tramp-completion-file-name-handler
))
1995 (put 'tramp-completion-file-name-handler
'safe-magic t
)
1996 ;; If jka-compr or epa-file are already loaded, move them to the
1997 ;; front of `file-name-handler-alist'.
1998 (dolist (fnh '(epa-file-handler jka-compr-handler
))
1999 (let ((entry (rassoc fnh file-name-handler-alist
)))
2001 (setq file-name-handler-alist
2002 (cons entry
(delete entry file-name-handler-alist
))))))))
2004 ;; `tramp-file-name-handler' must be registered before evaluation of
2005 ;; site-start and init files, because there might exist remote files
2006 ;; already, f.e. files kept via recentf-mode.
2008 (tramp-register-file-name-handlers)
2010 (defun tramp-exists-file-name-handler (operation &rest args
)
2011 "Check, whether OPERATION runs a file name handler."
2012 ;; The file name handler is determined on base of either an
2013 ;; argument, `buffer-file-name', or `default-directory'.
2015 (let* ((buffer-file-name "/")
2016 (default-directory "/")
2017 (fnha file-name-handler-alist
)
2018 (check-file-name-operation operation
)
2019 (file-name-handler-alist
2022 (lambda (operation &rest args
)
2023 "Returns OPERATION if it is the one to be checked."
2024 (if (equal check-file-name-operation operation
)
2026 (let ((file-name-handler-alist fnha
))
2027 (apply operation args
))))))))
2028 (equal (apply operation args
) operation
))))
2031 (defun tramp-unload-file-name-handlers ()
2032 (setq file-name-handler-alist
2033 (delete (rassoc 'tramp-file-name-handler
2034 file-name-handler-alist
)
2035 (delete (rassoc 'tramp-completion-file-name-handler
2036 file-name-handler-alist
)
2037 file-name-handler-alist
))))
2039 (add-hook 'tramp-unload-hook
'tramp-unload-file-name-handlers
)
2041 ;;; File name handler functions for completion mode:
2043 (defvar tramp-completion-mode nil
2044 "If non-nil, external packages signal that they are in file name completion.
2046 This is necessary, because Tramp uses a heuristic depending on last
2047 input event. This fails when external packages use other characters
2048 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2049 should never be set globally, the intention is to let-bind it.")
2051 ;; Necessary because `tramp-file-name-regexp-unified' and
2052 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2053 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2054 ;; to `tramp-file-name-handler'). Otherwise, it takes
2055 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2056 ;; risky, because completing a file might require loading other files,
2057 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2058 ;; variable. On the other hand, those files shouldn't have partial
2059 ;; Tramp file name syntax. Maybe another variable should be introduced
2060 ;; overwriting this check in such cases. Or we change Tramp file name
2061 ;; syntax in order to avoid ambiguities, like in XEmacs ...
2062 ;;;###tramp-autoload
2063 (defun tramp-completion-mode-p ()
2064 "Check, whether method / user name / host name completion is active."
2066 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2067 (and (boundp 'non-essential
) (symbol-value 'non-essential
))
2068 tramp-completion-mode
2070 (equal last-input-event
'tab
)
2071 (and (natnump last-input-event
)
2073 ;; ?\t has event-modifier 'control.
2074 (equal last-input-event ?
\t)
2075 (and (not (event-modifiers last-input-event
))
2076 (or (equal last-input-event ?
\?)
2077 (equal last-input-event ?\
)))))
2079 (and (featurep 'xemacs
)
2080 ;; `last-input-event' might be nil.
2081 (not (null last-input-event
))
2082 ;; `last-input-event' may have no character approximation.
2083 (tramp-compat-funcall 'event-to-character last-input-event
)
2085 ;; ?\t has event-modifier 'control.
2087 (tramp-compat-funcall 'event-to-character last-input-event
) ?
\t)
2088 (and (not (event-modifiers last-input-event
))
2090 (tramp-compat-funcall 'event-to-character last-input-event
)
2093 (tramp-compat-funcall 'event-to-character last-input-event
)
2096 (defun tramp-connectable-p (filename)
2097 "Check, whether it is possible to connect the remote host w/o side-effects.
2098 This is true, if either the remote host is already connected, or if we are
2099 not in completion mode."
2100 (and (tramp-tramp-file-p filename
)
2101 (with-parsed-tramp-file-name filename nil
2102 (or (get-buffer (tramp-buffer-name v
))
2103 (not (tramp-completion-mode-p))))))
2105 ;; Method, host name and user name completion.
2106 ;; `tramp-completion-dissect-file-name' returns a list of
2107 ;; tramp-file-name structures. For all of them we return possible completions.
2109 (defun tramp-completion-handle-file-name-all-completions (filename directory
)
2110 "Like `file-name-all-completions' for partial Tramp files."
2112 (let* ((fullname (tramp-drop-volume-letter
2113 (expand-file-name filename directory
)))
2114 ;; Possible completion structures.
2115 (v (tramp-completion-dissect-file-name fullname
))
2119 (let* ((car (car v
))
2120 (method (tramp-file-name-method car
))
2121 (user (tramp-file-name-user car
))
2122 (host (tramp-file-name-host car
))
2123 (localname (tramp-file-name-localname car
))
2124 (m (tramp-find-method method user host
))
2125 (tramp-current-user user
) ; see `tramp-parse-passwd'
2128 (unless localname
;; Nothing to complete.
2132 ;; Method dependent user / host combinations.
2136 (setq all-user-hosts
2137 (append all-user-hosts
2138 (funcall (nth 0 x
) (nth 1 x
)))))
2139 (tramp-get-completion-function m
))
2145 (tramp-get-completion-user-host
2146 method user host
(nth 0 x
) (nth 1 x
)))
2147 (delq nil all-user-hosts
)))))
2149 ;; Possible methods.
2151 (append result
(tramp-get-completion-methods m
)))))
2155 ;; Unify list, remove nil elements.
2157 (let ((car (car result
)))
2161 (substring car
(length (tramp-drop-volume-letter directory
)))))
2162 (setq result
(cdr result
))))
2164 ;; Complete local parts.
2168 (apply (if (tramp-connectable-p fullname
)
2169 'tramp-completion-run-real-handler
2170 'tramp-run-real-handler
)
2171 'file-name-all-completions
(list (list filename directory
)))))))
2173 ;; Method, host name and user name completion for a file.
2175 (defun tramp-completion-handle-file-name-completion
2176 (filename directory
&optional predicate
)
2177 "Like `file-name-completion' for Tramp files."
2180 (mapcar 'list
(file-name-all-completions filename directory
))
2181 (when (and predicate
2182 (tramp-connectable-p (expand-file-name filename directory
)))
2183 (lambda (x) (funcall predicate
(expand-file-name (car x
) directory
))))))
2185 ;; I misuse a little bit the tramp-file-name structure in order to handle
2186 ;; completion possibilities for partial methods / user names / host names.
2187 ;; Return value is a list of tramp-file-name structures according to possible
2188 ;; completions. If "localname" is non-nil it means there
2189 ;; shouldn't be a completion anymore.
2191 ;; Expected results:
2193 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2194 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2195 ;; [nil "x" nil nil]
2196 ;; ["x" nil nil nil]
2198 ;; "/x:" "/x:y" "/x:y:"
2199 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2201 ;; ["x" nil "" nil] ["x" nil "y" nil]
2202 ;; ["x" "" nil nil] ["x" "y" nil nil]
2204 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2205 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2206 ;; "/[x/y@" "/[x/y@z"
2207 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2208 (defun tramp-completion-dissect-file-name (name)
2209 "Returns a list of `tramp-file-name' structures.
2210 They are collected by `tramp-completion-dissect-file-name1'."
2214 (tramp-completion-ipv6-regexp
2217 (if (zerop (length tramp-postfix-ipv6-format
))
2218 tramp-postfix-host-format
2219 tramp-postfix-ipv6-format
)))
2220 ;; "/method" "/[method"
2221 (tramp-completion-file-name-structure1
2222 (list (concat tramp-prefix-regexp
"\\(" tramp-method-regexp x-nil
"\\)$")
2225 (tramp-completion-file-name-structure2
2226 (list (concat tramp-prefix-regexp
"\\(" tramp-user-regexp x-nil
"\\)$")
2229 (tramp-completion-file-name-structure3
2230 (list (concat tramp-prefix-regexp
"\\(" tramp-host-regexp x-nil
"\\)$")
2232 ;; "/[ipv6" "/[ipv6"
2233 (tramp-completion-file-name-structure4
2234 (list (concat tramp-prefix-regexp
2235 tramp-prefix-ipv6-regexp
2236 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2238 ;; "/user@host" "/[user@host"
2239 (tramp-completion-file-name-structure5
2240 (list (concat tramp-prefix-regexp
2241 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2242 "\\(" tramp-host-regexp x-nil
"\\)$")
2244 ;; "/user@[ipv6" "/[user@ipv6"
2245 (tramp-completion-file-name-structure6
2246 (list (concat tramp-prefix-regexp
2247 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2248 tramp-prefix-ipv6-regexp
2249 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2251 ;; "/method:user" "/[method/user" "/method://user"
2252 (tramp-completion-file-name-structure7
2253 (list (concat tramp-prefix-regexp
2254 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2255 "\\(" tramp-user-regexp x-nil
"\\)$")
2257 ;; "/method:host" "/[method/host" "/method://host"
2258 (tramp-completion-file-name-structure8
2259 (list (concat tramp-prefix-regexp
2260 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2261 "\\(" tramp-host-regexp x-nil
"\\)$")
2263 ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6"
2264 (tramp-completion-file-name-structure9
2265 (list (concat tramp-prefix-regexp
2266 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2267 tramp-prefix-ipv6-regexp
2268 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2270 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
2271 (tramp-completion-file-name-structure10
2272 (list (concat tramp-prefix-regexp
2273 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2274 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2275 "\\(" tramp-host-regexp x-nil
"\\)$")
2277 ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6"
2278 (tramp-completion-file-name-structure11
2279 (list (concat tramp-prefix-regexp
2280 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2281 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2282 tramp-prefix-ipv6-regexp
2283 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2285 ;; "/method: "/method:/"
2286 (tramp-completion-file-name-structure12
2288 (if (equal tramp-syntax
'url
)
2289 (concat tramp-prefix-regexp
2290 "\\(" tramp-method-regexp
"\\)"
2291 "\\(" (substring tramp-postfix-method-regexp
0 1)
2292 "\\|" (substring tramp-postfix-method-regexp
1 2) "\\)"
2294 ;; Should not match if not URL syntax.
2295 (concat tramp-prefix-regexp
"/$"))
2297 ;; "/method: "/method:/"
2298 (tramp-completion-file-name-structure13
2300 (if (equal tramp-syntax
'url
)
2301 (concat tramp-prefix-regexp
2302 "\\(" tramp-method-regexp
"\\)"
2303 "\\(" (substring tramp-postfix-method-regexp
0 1)
2304 "\\|" (substring tramp-postfix-method-regexp
1 2) "\\)"
2306 ;; Should not match if not URL syntax.
2307 (concat tramp-prefix-regexp
"/$"))
2310 (mapc (lambda (regexp)
2311 (add-to-list 'result
2312 (tramp-completion-dissect-file-name1 regexp name
)))
2314 tramp-completion-file-name-structure1
2315 tramp-completion-file-name-structure2
2316 tramp-completion-file-name-structure3
2317 tramp-completion-file-name-structure4
2318 tramp-completion-file-name-structure5
2319 tramp-completion-file-name-structure6
2320 tramp-completion-file-name-structure7
2321 tramp-completion-file-name-structure8
2322 tramp-completion-file-name-structure9
2323 tramp-completion-file-name-structure10
2324 tramp-completion-file-name-structure11
2325 tramp-completion-file-name-structure12
2326 tramp-completion-file-name-structure13
2327 tramp-file-name-structure
))
2331 (defun tramp-completion-dissect-file-name1 (structure name
)
2332 "Returns a `tramp-file-name' structure matching STRUCTURE.
2333 The structure consists of remote method, remote user,
2334 remote host and localname (filename on remote host)."
2337 (when (string-match (nth 0 structure
) name
)
2338 (let ((method (and (nth 1 structure
)
2339 (match-string (nth 1 structure
) name
)))
2340 (user (and (nth 2 structure
)
2341 (match-string (nth 2 structure
) name
)))
2342 (host (and (nth 3 structure
)
2343 (match-string (nth 3 structure
) name
)))
2344 (localname (and (nth 4 structure
)
2345 (match-string (nth 4 structure
) name
))))
2346 (vector method user host localname
)))))
2348 ;; This function returns all possible method completions, adding the
2349 ;; trailing method delimiter.
2350 (defun tramp-get-completion-methods (partial-method)
2351 "Returns all method completions for PARTIAL-METHOD."
2355 (string-match (concat "^" (regexp-quote partial-method
)) method
)
2356 (tramp-completion-make-tramp-file-name method nil nil nil
)))
2357 (mapcar 'car tramp-methods
)))
2359 ;; Compares partial user and host names with possible completions.
2360 (defun tramp-get-completion-user-host (method partial-user partial-host user host
)
2361 "Returns the most expanded string for user and host name completion.
2362 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2365 ((and partial-user partial-host
)
2367 (string-match (concat "^" (regexp-quote partial-host
)) host
)
2368 (string-equal partial-user
(or user partial-user
)))
2369 (setq user partial-user
)
2376 (and user
(string-match (concat "^" (regexp-quote partial-user
)) user
))
2382 (and host
(string-match (concat "^" (regexp-quote partial-host
)) host
))
2388 (unless (zerop (+ (length user
) (length host
)))
2389 (tramp-completion-make-tramp-file-name method user host nil
)))
2391 ;;;###tramp-autoload
2392 (defun tramp-parse-rhosts (filename)
2393 "Return a list of (user host) tuples allowed to access.
2394 Either user or host may be nil."
2395 ;; On Windows, there are problems in completion when
2396 ;; `default-directory' is remote.
2397 (let ((default-directory (tramp-compat-temporary-file-directory))
2399 (when (file-readable-p filename
)
2401 (insert-file-contents filename
)
2402 (goto-char (point-min))
2404 (push (tramp-parse-rhosts-group) res
))))
2407 (defun tramp-parse-rhosts-group ()
2408 "Return a (user host) tuple allowed to access.
2409 Either user or host may be nil."
2413 "^\\(" tramp-host-regexp
"\\)"
2414 "\\([ \t]+" "\\(" tramp-user-regexp
"\\)" "\\)?")))
2415 (narrow-to-region (point) (point-at-eol))
2416 (when (re-search-forward regexp nil t
)
2417 (setq result
(append (list (match-string 3) (match-string 1)))))
2422 ;;;###tramp-autoload
2423 (defun tramp-parse-shosts (filename)
2424 "Return a list of (user host) tuples allowed to access.
2425 User is always nil."
2426 ;; On Windows, there are problems in completion when
2427 ;; `default-directory' is remote.
2428 (let ((default-directory (tramp-compat-temporary-file-directory))
2430 (when (file-readable-p filename
)
2432 (insert-file-contents filename
)
2433 (goto-char (point-min))
2435 (push (tramp-parse-shosts-group) res
))))
2438 (defun tramp-parse-shosts-group ()
2439 "Return a (user host) tuple allowed to access.
2440 User is always nil."
2442 (regexp (concat "^\\(" tramp-host-regexp
"\\)")))
2443 (narrow-to-region (point) (point-at-eol))
2444 (when (re-search-forward regexp nil t
)
2445 (setq result
(list nil
(match-string 1))))
2448 (> (skip-chars-forward ",") 0)
2452 ;;;###tramp-autoload
2453 (defun tramp-parse-sconfig (filename)
2454 "Return a list of (user host) tuples allowed to access.
2455 User is always nil."
2456 ;; On Windows, there are problems in completion when
2457 ;; `default-directory' is remote.
2458 (let ((default-directory (tramp-compat-temporary-file-directory))
2460 (when (file-readable-p filename
)
2462 (insert-file-contents filename
)
2463 (goto-char (point-min))
2465 (push (tramp-parse-sconfig-group) res
))))
2468 (defun tramp-parse-sconfig-group ()
2469 "Return a (user host) tuple allowed to access.
2470 User is always nil."
2472 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp
"\\)")))
2473 (narrow-to-region (point) (point-at-eol))
2474 (when (re-search-forward regexp nil t
)
2475 (setq result
(list nil
(match-string 1))))
2478 (> (skip-chars-forward ",") 0)
2482 ;;;###tramp-autoload
2483 (defun tramp-parse-shostkeys (dirname)
2484 "Return a list of (user host) tuples allowed to access.
2485 User is always nil."
2486 ;; On Windows, there are problems in completion when
2487 ;; `default-directory' is remote.
2488 (let* ((default-directory (tramp-compat-temporary-file-directory))
2489 (regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp
"\\)\\.pub$"))
2490 (files (when (file-directory-p dirname
) (directory-files dirname
)))
2493 (when (string-match regexp
(car files
))
2494 (push (list nil
(match-string 1 (car files
))) result
))
2495 (setq files
(cdr files
)))
2498 (defun tramp-parse-sknownhosts (dirname)
2499 "Return a list of (user host) tuples allowed to access.
2500 User is always nil."
2501 ;; On Windows, there are problems in completion when
2502 ;; `default-directory' is remote.
2503 (let* ((default-directory (tramp-compat-temporary-file-directory))
2504 (regexp (concat "^\\(" tramp-host-regexp
2505 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
2506 (files (when (file-directory-p dirname
) (directory-files dirname
)))
2509 (when (string-match regexp
(car files
))
2510 (push (list nil
(match-string 1 (car files
))) result
))
2511 (setq files
(cdr files
)))
2514 ;;;###tramp-autoload
2515 (defun tramp-parse-hosts (filename)
2516 "Return a list of (user host) tuples allowed to access.
2517 User is always nil."
2518 ;; On Windows, there are problems in completion when
2519 ;; `default-directory' is remote.
2520 (let ((default-directory (tramp-compat-temporary-file-directory))
2522 (when (file-readable-p filename
)
2524 (insert-file-contents filename
)
2525 (goto-char (point-min))
2527 (push (tramp-parse-hosts-group) res
))))
2530 (defun tramp-parse-hosts-group ()
2531 "Return a (user host) tuple allowed to access.
2532 User is always nil."
2535 (concat "^\\(" tramp-ipv6-regexp
"\\|" tramp-host-regexp
"\\)")))
2536 (narrow-to-region (point) (point-at-eol))
2537 (when (re-search-forward regexp nil t
)
2538 (setq result
(list nil
(match-string 1))))
2541 (> (skip-chars-forward " \t") 0)
2545 ;; For su-alike methods it would be desirable to return "root@localhost"
2546 ;; as default. Unfortunately, we have no information whether any user name
2547 ;; has been typed already. So we use `tramp-current-user' as indication,
2548 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
2549 ;;;###tramp-autoload
2550 (defun tramp-parse-passwd (filename)
2551 "Return a list of (user host) tuples allowed to access.
2552 Host is always \"localhost\"."
2553 ;; On Windows, there are problems in completion when
2554 ;; `default-directory' is remote.
2555 (let ((default-directory (tramp-compat-temporary-file-directory))
2557 (if (zerop (length tramp-current-user
))
2559 (when (file-readable-p filename
)
2561 (insert-file-contents filename
)
2562 (goto-char (point-min))
2564 (push (tramp-parse-passwd-group) res
))))
2567 (defun tramp-parse-passwd-group ()
2568 "Return a (user host) tuple allowed to access.
2569 Host is always \"localhost\"."
2571 (regexp (concat "^\\(" tramp-user-regexp
"\\):")))
2572 (narrow-to-region (point) (point-at-eol))
2573 (when (re-search-forward regexp nil t
)
2574 (setq result
(list (match-string 1) "localhost")))
2579 ;;;###tramp-autoload
2580 (defun tramp-parse-netrc (filename)
2581 "Return a list of (user host) tuples allowed to access.
2583 ;; On Windows, there are problems in completion when
2584 ;; `default-directory' is remote.
2585 (let ((default-directory (tramp-compat-temporary-file-directory))
2587 (when (file-readable-p filename
)
2589 (insert-file-contents filename
)
2590 (goto-char (point-min))
2592 (push (tramp-parse-netrc-group) res
))))
2595 (defun tramp-parse-netrc-group ()
2596 "Return a (user host) tuple allowed to access.
2601 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp
"\\)"
2602 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp
"\\)" "\\)?")))
2603 (narrow-to-region (point) (point-at-eol))
2604 (when (re-search-forward regexp nil t
)
2605 (setq result
(list (match-string 3) (match-string 1))))
2610 ;;;###tramp-autoload
2611 (defun tramp-parse-putty (registry)
2612 "Return a list of (user host) tuples allowed to access.
2613 User is always nil."
2614 ;; On Windows, there are problems in completion when
2615 ;; `default-directory' is remote.
2616 (let ((default-directory (tramp-compat-temporary-file-directory))
2619 (when (zerop (tramp-compat-call-process "reg" nil t nil
"query" registry
))
2620 (goto-char (point-min))
2622 (push (tramp-parse-putty-group registry
) res
))))
2625 (defun tramp-parse-putty-group (registry)
2626 "Return a (user host) tuple allowed to access.
2627 User is always nil."
2629 (regexp (concat (regexp-quote registry
) "\\\\\\(.+\\)")))
2630 (narrow-to-region (point) (point-at-eol))
2631 (when (re-search-forward regexp nil t
)
2632 (setq result
(list nil
(match-string 1))))
2637 ;;; Common file name handler functions for different backends:
2639 (defvar tramp-handle-file-local-copy-hook nil
2640 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2642 (defvar tramp-handle-write-region-hook nil
2643 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2645 (defun tramp-handle-directory-file-name (directory)
2646 "Like `directory-file-name' for Tramp files."
2647 ;; If localname component of filename is "/", leave it unchanged.
2648 ;; Otherwise, remove any trailing slash from localname component.
2649 ;; Method, host, etc, are unchanged. Does it make sense to try
2650 ;; to avoid parsing the filename?
2651 (with-parsed-tramp-file-name directory nil
2652 (if (and (not (zerop (length localname
)))
2653 (eq (aref localname
(1- (length localname
))) ?
/)
2654 (not (string= localname
"/")))
2655 (substring directory
0 -
1)
2658 (defun tramp-handle-directory-files
2659 (directory &optional full match nosort files-only
)
2660 "Like `directory-files' for Tramp files."
2661 ;; FILES-ONLY is valid for XEmacs only.
2662 (when (file-directory-p directory
)
2663 (setq directory
(file-name-as-directory (expand-file-name directory
)))
2664 (let ((temp (nreverse (file-name-all-completions "" directory
)))
2668 (setq item
(directory-file-name (pop temp
)))
2669 (when (and (or (null match
) (string-match match item
))
2670 (or (null files-only
)
2672 (and (equal files-only t
) (file-regular-p item
))
2673 ;; Directories only.
2674 (file-directory-p item
)))
2675 (push (if full
(concat directory item
) item
)
2677 (if nosort result
(sort result
'string
<)))))
2679 (defun tramp-handle-directory-files-and-attributes
2680 (directory &optional full match nosort id-format
)
2681 "Like `directory-files-and-attributes' for Tramp files."
2684 (cons x
(tramp-compat-file-attributes
2685 (if full x
(expand-file-name x directory
)) id-format
)))
2686 (directory-files directory full match nosort
)))
2688 (defun tramp-handle-dired-uncache (dir &optional dir-p
)
2689 "Like `dired-uncache' for Tramp files."
2690 ;; DIR-P is valid for XEmacs only.
2691 (with-parsed-tramp-file-name
2692 (if (or dir-p
(file-directory-p dir
)) dir
(file-name-directory dir
)) nil
2693 (tramp-flush-directory-property v localname
)))
2695 (defun tramp-handle-file-exists-p (filename)
2696 "Like `file-exists-p' for Tramp files."
2697 (not (null (file-attributes filename
))))
2699 (defun tramp-handle-file-modes (filename)
2700 "Like `file-modes' for Tramp files."
2701 (let ((truename (or (file-truename filename
) filename
)))
2702 (when (file-exists-p truename
)
2703 (tramp-mode-string-to-int (nth 8 (file-attributes truename
))))))
2705 ;; Localname manipulation functions that grok Tramp localnames...
2706 (defun tramp-handle-file-name-as-directory (file)
2707 "Like `file-name-as-directory' but aware of Tramp files."
2708 ;; `file-name-as-directory' would be sufficient except localname is
2709 ;; the empty string.
2710 (let ((v (tramp-dissect-file-name file t
)))
2711 ;; Run the command on the localname portion only.
2712 (tramp-make-tramp-file-name
2713 (tramp-file-name-method v
)
2714 (tramp-file-name-user v
)
2715 (tramp-file-name-host v
)
2716 (tramp-run-real-handler
2717 'file-name-as-directory
(list (or (tramp-file-name-localname v
) ""))))))
2719 (defun tramp-handle-file-name-completion
2720 (filename directory
&optional predicate
)
2721 "Like `file-name-completion' for Tramp files."
2722 (unless (tramp-tramp-file-p directory
)
2724 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2728 (mapcar 'list
(file-name-all-completions filename directory
))
2730 (lambda (x) (funcall predicate
(expand-file-name (car x
) directory
))))))
2732 (defun tramp-handle-file-name-directory (file)
2733 "Like `file-name-directory' but aware of Tramp files."
2734 ;; Everything except the last filename thing is the directory. We
2735 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2736 ;; the remote file name parts. This is a problem when we are in
2737 ;; file name completion.
2738 (let ((v (tramp-dissect-file-name file t
)))
2739 ;; Run the command on the localname portion only.
2740 (tramp-make-tramp-file-name
2741 (tramp-file-name-method v
)
2742 (tramp-file-name-user v
)
2743 (tramp-file-name-host v
)
2744 (tramp-run-real-handler
2745 'file-name-directory
(list (or (tramp-file-name-localname v
) ""))))))
2747 (defun tramp-handle-file-name-nondirectory (file)
2748 "Like `file-name-nondirectory' but aware of Tramp files."
2749 (with-parsed-tramp-file-name file nil
2750 (tramp-run-real-handler 'file-name-nondirectory
(list localname
))))
2752 (defun tramp-handle-file-newer-than-file-p (file1 file2
)
2753 "Like `file-newer-than-file-p' for Tramp files."
2755 ((not (file-exists-p file1
)) nil
)
2756 ((not (file-exists-p file2
)) t
)
2757 (t (tramp-time-less-p (nth 5 (file-attributes file2
))
2758 (nth 5 (file-attributes file1
))))))
2760 (defun tramp-handle-file-regular-p (filename)
2761 "Like `file-regular-p' for Tramp files."
2762 (and (file-exists-p filename
)
2763 (eq ?-
(aref (nth 8 (file-attributes filename
)) 0))))
2765 (defun tramp-handle-file-remote-p (filename &optional identification connected
)
2766 "Like `file-remote-p' for Tramp files."
2767 (let ((tramp-verbose 3))
2768 (when (tramp-tramp-file-p filename
)
2769 (let* ((v (tramp-dissect-file-name filename
))
2770 (p (tramp-get-connection-process v
))
2771 (c (and p
(processp p
) (memq (process-status p
) '(run open
)))))
2772 ;; We expand the file name only, if there is already a connection.
2773 (with-parsed-tramp-file-name
2774 (if c
(expand-file-name filename
) filename
) nil
2775 (and (or (not connected
) c
)
2777 ((eq identification
'method
) method
)
2778 ((eq identification
'user
) user
)
2779 ((eq identification
'host
) host
)
2780 ((eq identification
'localname
) localname
)
2781 (t (tramp-make-tramp-file-name method user host
"")))))))))
2783 (defun tramp-handle-file-symlink-p (filename)
2784 "Like `file-symlink-p' for Tramp files."
2785 (with-parsed-tramp-file-name filename nil
2786 (let ((x (car (file-attributes filename
))))
2788 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2789 ;; might do weird things.
2790 (if (file-name-absolute-p x
)
2791 (tramp-make-tramp-file-name method user host x
)
2794 (defun tramp-handle-find-backup-file-name (filename)
2795 "Like `find-backup-file-name' for Tramp files."
2796 (with-parsed-tramp-file-name filename nil
2797 ;; We set both variables. It doesn't matter whether it is
2799 (let ((backup-directory-alist
2801 (when (boundp 'backup-directory-alist
)
2802 (if (symbol-value 'tramp-backup-directory-alist
)
2807 (if (and (stringp (cdr x
))
2808 (file-name-absolute-p (cdr x
))
2809 (not (tramp-file-name-p (cdr x
))))
2810 (tramp-make-tramp-file-name method user host
(cdr x
))
2812 (symbol-value 'tramp-backup-directory-alist
))
2813 (symbol-value 'backup-directory-alist
))))
2815 (bkup-backup-directory-info
2817 (when (boundp 'bkup-backup-directory-info
)
2818 (if (symbol-value 'tramp-bkup-backup-directory-info
)
2824 (if (and (stringp (car (cdr x
)))
2825 (file-name-absolute-p (car (cdr x
)))
2826 (not (tramp-file-name-p (car (cdr x
)))))
2827 (tramp-make-tramp-file-name
2828 method user host
(car (cdr x
)))
2831 (symbol-value 'tramp-bkup-backup-directory-info
))
2832 (symbol-value 'bkup-backup-directory-info
)))))
2834 (tramp-run-real-handler 'find-backup-file-name
(list filename
)))))
2836 (defun tramp-handle-insert-file-contents
2837 (filename &optional visit beg end replace
)
2838 "Like `insert-file-contents' for Tramp files."
2839 (barf-if-buffer-read-only)
2840 (setq filename
(expand-file-name filename
))
2841 (let (result local-copy remote-copy
)
2842 (with-parsed-tramp-file-name filename nil
2844 (if (not (file-exists-p filename
))
2845 ;; We don't raise a Tramp error, because it might be
2846 ;; suppressed, like in `find-file-noselect-1'.
2848 (list "File not found on remote host" filename
))
2850 (if (and (tramp-local-host-p v
)
2851 (let (file-name-handler-alist)
2852 (file-readable-p localname
)))
2853 ;; Short track: if we are on the local host, we can
2856 (tramp-run-real-handler
2857 'insert-file-contents
2858 (list localname visit beg end replace
)))
2860 ;; When we shall insert only a part of the file, we copy
2863 (setq remote-copy
(tramp-make-tramp-temp-file v
))
2864 ;; This is defined in tramp-sh.el. Let's assume this
2865 ;; is loaded already.
2866 (tramp-compat-funcall 'tramp-send-command
2870 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
2871 beg
(tramp-shell-quote-argument localname
)
2872 (- end beg
) remote-copy
))
2874 (format "dd bs=1 skip=%d if=%s of=%s"
2875 beg
(tramp-shell-quote-argument localname
)
2878 (format "dd bs=1 count=%d if=%s of=%s"
2879 end
(tramp-shell-quote-argument localname
)
2882 ;; `insert-file-contents-literally' takes care to avoid
2883 ;; calling jka-compr. By let-binding
2884 ;; `inhibit-file-name-operation', we propagate that care
2885 ;; to the `file-local-copy' operation.
2887 (let ((inhibit-file-name-operation
2888 (when (eq inhibit-file-name-operation
2889 'insert-file-contents
)
2892 ((stringp remote-copy
)
2894 (tramp-make-tramp-file-name
2895 method user host remote-copy
)))
2896 ((stringp tramp-temp-buffer-file-name
)
2897 (copy-file filename tramp-temp-buffer-file-name
'ok
)
2898 tramp-temp-buffer-file-name
)
2899 (t (file-local-copy filename
)))))
2901 ;; When the file is not readable for the owner, it
2902 ;; cannot be inserted, even if it is readable for the
2903 ;; group or for everybody.
2904 (set-file-modes local-copy
(tramp-compat-octal-to-decimal "0600"))
2906 (when (and (null remote-copy
)
2907 (tramp-get-method-parameter
2908 method
'tramp-copy-keep-tmpfile
))
2909 ;; We keep the local file for performance reasons,
2910 ;; useful for "rsync".
2911 (setq tramp-temp-buffer-file-name local-copy
))
2913 (tramp-with-progress-reporter
2914 v
3 (format "Inserting local temp file `%s'" local-copy
)
2915 ;; We must ensure that `file-coding-system-alist'
2916 ;; matches `local-copy'.
2917 (let ((file-coding-system-alist
2918 (tramp-find-file-name-coding-system-alist
2919 filename local-copy
)))
2921 (insert-file-contents
2922 local-copy nil nil nil replace
))))))
2927 (setq buffer-file-name filename
)
2928 (setq buffer-read-only
(not (file-writable-p filename
)))
2929 (set-visited-file-modtime)
2930 (set-buffer-modified-p nil
))
2931 (when (and (stringp local-copy
)
2932 (or remote-copy
(null tramp-temp-buffer-file-name
)))
2933 (delete-file local-copy
))
2934 (when (stringp remote-copy
)
2936 (tramp-make-tramp-file-name method user host remote-copy
))))))
2939 (list (expand-file-name filename
)
2942 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix
)
2943 "Like `load' for Tramp files."
2944 (with-parsed-tramp-file-name (expand-file-name file
) nil
2946 (cond ((file-exists-p (concat file
".elc"))
2947 (setq file
(concat file
".elc")))
2948 ((file-exists-p (concat file
".el"))
2949 (setq file
(concat file
".el")))))
2951 ;; The first condition is always true for absolute file names.
2952 ;; Included for safety's sake.
2953 (unless (or (file-name-directory file
)
2954 (string-match "\\.elc?\\'" file
))
2957 "File `%s' does not include a `.el' or `.elc' suffix" file
)))
2959 (when (not (file-exists-p file
))
2960 (tramp-error v
'file-error
"Cannot load nonexistent file `%s'" file
)))
2961 (if (not (file-exists-p file
))
2963 (let ((tramp-message-show-message (not nomessage
)))
2964 (tramp-with-progress-reporter v
0 (format "Loading %s" file
)
2965 (let ((local-copy (file-local-copy file
)))
2966 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2968 (load local-copy noerror t t
)
2969 (delete-file local-copy
)))))
2972 (defun tramp-handle-substitute-in-file-name (filename)
2973 "Like `substitute-in-file-name' for Tramp files.
2974 \"//\" and \"/~\" substitute only in the local filename part.
2975 If the URL Tramp syntax is chosen, \"//\" as method delimiter and \"/~\" at
2976 beginning of local filename are not substituted."
2977 ;; First, we must replace environment variables.
2978 (setq filename
(tramp-replace-environment-variables filename
))
2979 (with-parsed-tramp-file-name filename nil
2980 (if (equal tramp-syntax
'url
)
2981 ;; We need to check localname only. The other parts cannot contain
2983 (if (and (> (length localname
) 1)
2984 (or (string-match "//" localname
)
2985 (string-match "/~" localname
1)))
2986 (tramp-run-real-handler 'substitute-in-file-name
(list filename
))
2987 (tramp-make-tramp-file-name
2988 (when method
(substitute-in-file-name method
))
2989 (when user
(substitute-in-file-name user
))
2990 (when host
(substitute-in-file-name host
))
2992 (tramp-run-real-handler
2993 'substitute-in-file-name
(list localname
)))))
2994 ;; Ignore in LOCALNAME everything before "//" or "/~".
2995 (when (and (stringp localname
) (string-match ".+?/\\(/\\|~\\)" localname
))
2997 (concat (file-remote-p filename
)
2998 (replace-match "\\1" nil nil localname
)))
2999 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3000 (when (string-match "~$" filename
)
3001 (setq filename
(concat filename
"/"))))
3002 (tramp-run-real-handler 'substitute-in-file-name
(list filename
)))))
3004 (defun tramp-handle-unhandled-file-name-directory (filename)
3005 "Like `unhandled-file-name-directory' for Tramp files."
3006 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3007 ;; for backward compatibility.
3008 (expand-file-name "~/"))
3010 ;;; Functions for establishing connection:
3012 ;; The following functions are actions to be taken when seeing certain
3013 ;; prompts from the remote host. See the variable
3014 ;; `tramp-actions-before-shell' for usage of these functions.
3016 (defun tramp-action-login (proc vec
)
3017 "Send the login name."
3018 (when (not (stringp tramp-current-user
))
3019 (save-window-excursion
3020 (let ((enable-recursive-minibuffers t
))
3021 (pop-to-buffer (tramp-get-connection-buffer vec
))
3022 (setq tramp-current-user
(read-string (match-string 0))))))
3023 (tramp-message vec
3 "Sending login name `%s'" tramp-current-user
)
3024 (with-current-buffer (tramp-get-connection-buffer vec
)
3025 (tramp-message vec
6 "\n%s" (buffer-string)))
3026 (tramp-send-string vec tramp-current-user
))
3028 (defun tramp-action-password (proc vec
)
3029 "Query the user for a password."
3030 (with-current-buffer (process-buffer proc
)
3031 (tramp-check-for-regexp proc tramp-password-prompt-regexp
)
3032 (tramp-message vec
3 "Sending %s" (match-string 1))
3033 (tramp-enter-password proc
)
3034 ;; Hide password prompt.
3035 (narrow-to-region (point-max) (point-max))))
3037 (defun tramp-action-succeed (proc vec
)
3038 "Signal success in finding shell prompt."
3039 (throw 'tramp-action
'ok
))
3041 (defun tramp-action-permission-denied (proc vec
)
3042 "Signal permission denied."
3044 (throw 'tramp-action
'permission-denied
))
3046 (defun tramp-action-yesno (proc vec
)
3047 "Ask the user for confirmation using `yes-or-no-p'.
3048 Send \"yes\" to remote process on confirmation, abort otherwise.
3049 See also `tramp-action-yn'."
3050 (save-window-excursion
3051 (let ((enable-recursive-minibuffers t
))
3052 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec
)))
3053 (unless (yes-or-no-p (match-string 0))
3055 (throw 'tramp-action
'permission-denied
))
3056 (with-current-buffer (tramp-get-connection-buffer vec
)
3057 (tramp-message vec
6 "\n%s" (buffer-string)))
3058 (tramp-send-string vec
"yes"))))
3060 (defun tramp-action-yn (proc vec
)
3061 "Ask the user for confirmation using `y-or-n-p'.
3062 Send \"y\" to remote process on confirmation, abort otherwise.
3063 See also `tramp-action-yesno'."
3064 (save-window-excursion
3065 (let ((enable-recursive-minibuffers t
))
3066 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec
)))
3067 (unless (y-or-n-p (match-string 0))
3069 (throw 'tramp-action
'permission-denied
))
3070 (with-current-buffer (tramp-get-connection-buffer vec
)
3071 (tramp-message vec
6 "\n%s" (buffer-string)))
3072 (tramp-send-string vec
"y"))))
3074 (defun tramp-action-terminal (proc vec
)
3075 "Tell the remote host which terminal type to use.
3076 The terminal type can be configured with `tramp-terminal-type'."
3077 (tramp-message vec
5 "Setting `%s' as terminal type." tramp-terminal-type
)
3078 (with-current-buffer (tramp-get-connection-buffer vec
)
3079 (tramp-message vec
6 "\n%s" (buffer-string)))
3080 (tramp-send-string vec tramp-terminal-type
))
3082 (defun tramp-action-process-alive (proc vec
)
3083 "Check, whether a process has finished."
3084 (unless (memq (process-status proc
) '(run open
))
3085 (throw 'tramp-action
'process-died
)))
3087 (defun tramp-action-out-of-band (proc vec
)
3088 "Check, whether an out-of-band copy has finished."
3089 (cond ((and (memq (process-status proc
) '(stop exit
))
3090 (zerop (process-exit-status proc
)))
3091 (tramp-message vec
3 "Process has finished.")
3092 (throw 'tramp-action
'ok
))
3093 ((or (and (memq (process-status proc
) '(stop exit
))
3094 (not (zerop (process-exit-status proc
))))
3095 (memq (process-status proc
) '(signal)))
3096 ;; `scp' could have copied correctly, but set modes could have failed.
3097 ;; This can be ignored.
3098 (with-current-buffer (process-buffer proc
)
3099 (goto-char (point-min))
3100 (if (re-search-forward tramp-operation-not-permitted-regexp nil t
)
3102 (tramp-message vec
5 "'set mode' error ignored.")
3103 (tramp-message vec
3 "Process has finished.")
3104 (throw 'tramp-action
'ok
))
3105 (tramp-message vec
3 "Process has died.")
3106 (throw 'tramp-action
'process-died
))))
3109 ;;; Functions for processing the actions:
3111 (defun tramp-process-one-action (proc vec actions
)
3112 "Wait for output from the shell and perform one action."
3113 (let (found todo item pattern action
)
3115 ;; Reread output once all actions have been performed.
3116 ;; Obviously, the output was not complete.
3117 (tramp-accept-process-output proc
1)
3120 (setq item
(pop todo
))
3121 (setq pattern
(format "\\(%s\\)\\'" (symbol-value (nth 0 item
))))
3122 (setq action
(nth 1 item
))
3124 vec
5 "Looking for regexp \"%s\" from remote shell" pattern
)
3125 (when (tramp-check-for-regexp proc pattern
)
3126 (tramp-message vec
5 "Call `%s'" (symbol-name action
))
3127 (setq found
(funcall action proc vec
)))))
3130 (defun tramp-process-actions (proc vec pos actions
&optional timeout
)
3131 "Perform ACTIONS until success or TIMEOUT.
3132 PROC and VEC indicate the remote connection to be used. POS, if
3133 set, is the starting point of the region to be deleted in the
3135 ;; Preserve message for `progress-reporter'.
3136 (tramp-compat-with-temp-message ""
3137 ;; Enable auth-source and password-cache. We must use
3138 ;; tramp-current-* variables in case we have several hops.
3139 (tramp-set-connection-property
3140 (tramp-dissect-file-name
3141 (tramp-make-tramp-file-name
3142 tramp-current-method tramp-current-user tramp-current-host
""))
3143 "first-password-request" t
)
3147 (tramp-message proc
3 "Waiting for prompts from remote shell")
3149 (catch 'tramp-action
3151 (with-timeout (timeout)
3152 (tramp-process-one-action proc vec actions
))
3153 (tramp-process-one-action proc vec actions
)))))
3154 (with-current-buffer (tramp-get-connection-buffer vec
)
3156 (tramp-message vec
6 "\n%s" (buffer-string)))
3157 (unless (eq exit
'ok
)
3158 (tramp-clear-passwd vec
)
3159 (tramp-error-with-buffer
3162 ((eq exit
'permission-denied
) "Permission denied")
3163 ((eq exit
'process-died
) "Process died")
3164 (t "Login failed"))))
3166 (with-current-buffer (tramp-get-connection-buffer vec
)
3167 (let (buffer-read-only) (delete-region pos
(point)))))))))
3169 :;; Utility functions:
3171 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs
)
3172 "Like `accept-process-output' for Tramp processes.
3173 This is needed in order to hide `last-coding-system-used', which is set
3174 for process communication also."
3175 (with-current-buffer (process-buffer proc
)
3176 (tramp-message proc
10 "%s %s" proc
(process-status proc
))
3177 (let (buffer-read-only last-coding-system-used
)
3178 ;; Under Windows XP, accept-process-output doesn't return
3179 ;; sometimes. So we add an additional timeout.
3180 (with-timeout ((or timeout
1))
3181 (accept-process-output proc timeout timeout-msecs
)))
3182 (tramp-message proc
10 "\n%s" (buffer-string))))
3184 (defun tramp-check-for-regexp (proc regexp
)
3185 "Check, whether REGEXP is contained in process buffer of PROC.
3186 Erase echoed commands if exists."
3187 (with-current-buffer (process-buffer proc
)
3188 (goto-char (point-min))
3190 ;; Check whether we need to remove echo output.
3191 (when (and (tramp-get-connection-property proc
"check-remote-echo" nil
)
3192 (re-search-forward tramp-echoed-echo-mark-regexp nil t
))
3193 (let ((begin (match-beginning 0)))
3194 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t
)
3195 ;; Discard echo from remote output.
3196 (tramp-set-connection-property proc
"check-remote-echo" nil
)
3197 (tramp-message proc
5 "echo-mark found")
3199 (delete-region begin
(point))
3200 (goto-char (point-min)))))
3202 (when (or (not (tramp-get-connection-property proc
"check-remote-echo" nil
))
3203 ;; Sometimes, the echo string is suppressed on the remote side.
3205 (tramp-compat-funcall
3206 'substring-no-properties tramp-echo-mark-marker
3207 0 (min tramp-echo-mark-marker-length
(1- (point-max))))
3208 (tramp-compat-funcall
3209 'buffer-substring-no-properties
3210 1 (min (1+ tramp-echo-mark-marker-length
) (point-max))))))
3211 ;; No echo to be handled, now we can look for the regexp.
3212 (goto-char (point-min))
3213 (re-search-forward regexp nil t
))))
3215 (defun tramp-wait-for-regexp (proc timeout regexp
)
3216 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3217 Expects the output of PROC to be sent to the current buffer. Returns
3218 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3220 (with-current-buffer (process-buffer proc
)
3221 (let ((found (tramp-check-for-regexp proc regexp
))
3222 (start-time (current-time)))
3224 ;; Work around a bug in XEmacs 21, where the timeout
3225 ;; expires faster than it should. This degenerates
3226 ;; to polling for buggy XEmacsen, but oh, well.
3227 (while (and (not found
)
3228 (< (tramp-time-diff (current-time) start-time
)
3230 (with-timeout (timeout)
3232 (tramp-accept-process-output proc
1)
3233 (unless (memq (process-status proc
) '(run open
))
3234 (tramp-error-with-buffer
3235 nil proc
'file-error
"Process has died"))
3236 (setq found
(tramp-check-for-regexp proc regexp
))))))
3239 (tramp-accept-process-output proc
1)
3240 (unless (memq (process-status proc
) '(run open
))
3241 (tramp-error-with-buffer
3242 nil proc
'file-error
"Process has died"))
3243 (setq found
(tramp-check-for-regexp proc regexp
)))))
3244 (tramp-message proc
6 "\n%s" (buffer-string))
3248 proc
'file-error
"[[Regexp `%s' not found in %d secs]]"
3250 (tramp-error proc
'file-error
"[[Regexp `%s' not found]]" regexp
)))
3253 ;; We don't call `tramp-send-string' in order to hide the password
3254 ;; from the debug buffer, and because end-of-line handling of the
3256 (defun tramp-enter-password (proc)
3257 "Prompt for a password and send it to the remote end."
3258 (process-send-string
3259 proc
(concat (tramp-read-passwd proc
)
3260 (or (tramp-get-method-parameter
3261 tramp-current-method
3262 'tramp-password-end-of-line
)
3263 tramp-default-password-end-of-line
))))
3265 ;; It seems that Tru64 Unix does not like it if long strings are sent
3266 ;; to it in one go. (This happens when sending the Perl
3267 ;; `file-attributes' implementation, for instance.) Therefore, we
3268 ;; have this function which sends the string in chunks.
3269 (defun tramp-send-string (vec string
)
3270 "Send the STRING via connection VEC.
3272 The STRING is expected to use Unix line-endings, but the lines sent to
3273 the remote host use line-endings as defined in the variable
3274 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3275 (let* ((p (tramp-get-connection-process vec
))
3276 (chunksize (tramp-get-connection-property p
"chunksize" nil
)))
3279 vec
'file-error
"Can't send string to remote host -- not logged in"))
3280 (tramp-set-connection-property p
"last-cmd-time" (current-time))
3281 (tramp-message vec
10 "%s" string
)
3282 (with-current-buffer (tramp-get-connection-buffer vec
)
3283 ;; Clean up the buffer. We cannot call `erase-buffer' because
3284 ;; narrowing might be in effect.
3285 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3286 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3288 (mapconcat 'identity
3289 (tramp-compat-split-string string
"\n")
3290 tramp-rsh-end-of-line
))
3291 (unless (or (string= string
"")
3292 (string-equal (substring string -
1) tramp-rsh-end-of-line
))
3293 (setq string
(concat string tramp-rsh-end-of-line
)))
3295 (if (and chunksize
(not (zerop chunksize
)))
3297 (end (length string
)))
3300 vec
10 "Sending chunk from %s to %s"
3301 pos
(min (+ pos chunksize
) end
))
3302 (process-send-string
3303 p
(substring string pos
(min (+ pos chunksize
) end
)))
3304 (setq pos
(+ pos chunksize
))))
3305 (process-send-string p string
)))))
3307 (defun tramp-get-inode (vec)
3308 "Returns the virtual inode number.
3309 If it doesn't exist, generate a new one."
3310 (let ((string (tramp-make-tramp-file-name
3311 (tramp-file-name-method vec
)
3312 (tramp-file-name-user vec
)
3313 (tramp-file-name-host vec
)
3315 (unless (assoc string tramp-inodes
)
3316 (add-to-list 'tramp-inodes
3317 (list string
(length tramp-inodes
))))
3318 (nth 1 (assoc string tramp-inodes
))))
3320 (defun tramp-get-device (vec)
3321 "Returns the virtual device number.
3322 If it doesn't exist, generate a new one."
3323 (let ((string (tramp-make-tramp-file-name
3324 (tramp-file-name-method vec
)
3325 (tramp-file-name-user vec
)
3326 (tramp-file-name-host vec
)
3328 (unless (assoc string tramp-devices
)
3329 (add-to-list 'tramp-devices
3330 (list string
(length tramp-devices
))))
3331 (cons -
1 (nth 1 (assoc string tramp-devices
)))))
3333 (defun tramp-equal-remote (file1 file2
)
3334 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3335 The check depends on method, user and host name of the files. If
3336 one of the components is missing, the default values are used.
3337 The local file name parts of FILE1 and FILE2 are not taken into
3342 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3344 would yield `t'. On the other hand, the following check results in nil:
3346 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3347 (and (stringp (file-remote-p file1
))
3348 (stringp (file-remote-p file2
))
3349 (string-equal (file-remote-p file1
) (file-remote-p file2
))))
3351 (defun tramp-get-method-parameter (method param
)
3352 "Return the method parameter PARAM.
3353 If the `tramp-methods' entry does not exist, return nil."
3354 (let ((entry (assoc param
(assoc method tramp-methods
))))
3355 (when entry
(cadr entry
))))
3357 (defun tramp-mode-string-to-int (mode-string)
3358 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3359 (let* (case-fold-search
3360 (mode-chars (string-to-vector mode-string
))
3361 (owner-read (aref mode-chars
1))
3362 (owner-write (aref mode-chars
2))
3363 (owner-execute-or-setid (aref mode-chars
3))
3364 (group-read (aref mode-chars
4))
3365 (group-write (aref mode-chars
5))
3366 (group-execute-or-setid (aref mode-chars
6))
3367 (other-read (aref mode-chars
7))
3368 (other-write (aref mode-chars
8))
3369 (other-execute-or-sticky (aref mode-chars
9)))
3373 ((char-equal owner-read ?r
) (tramp-compat-octal-to-decimal "00400"))
3374 ((char-equal owner-read ?-
) 0)
3375 (t (error "Second char `%c' must be one of `r-'" owner-read
)))
3377 ((char-equal owner-write ?w
) (tramp-compat-octal-to-decimal "00200"))
3378 ((char-equal owner-write ?-
) 0)
3379 (t (error "Third char `%c' must be one of `w-'" owner-write
)))
3381 ((char-equal owner-execute-or-setid ?x
)
3382 (tramp-compat-octal-to-decimal "00100"))
3383 ((char-equal owner-execute-or-setid ?S
)
3384 (tramp-compat-octal-to-decimal "04000"))
3385 ((char-equal owner-execute-or-setid ?s
)
3386 (tramp-compat-octal-to-decimal "04100"))
3387 ((char-equal owner-execute-or-setid ?-
) 0)
3388 (t (error "Fourth char `%c' must be one of `xsS-'"
3389 owner-execute-or-setid
)))
3391 ((char-equal group-read ?r
) (tramp-compat-octal-to-decimal "00040"))
3392 ((char-equal group-read ?-
) 0)
3393 (t (error "Fifth char `%c' must be one of `r-'" group-read
)))
3395 ((char-equal group-write ?w
) (tramp-compat-octal-to-decimal "00020"))
3396 ((char-equal group-write ?-
) 0)
3397 (t (error "Sixth char `%c' must be one of `w-'" group-write
)))
3399 ((char-equal group-execute-or-setid ?x
)
3400 (tramp-compat-octal-to-decimal "00010"))
3401 ((char-equal group-execute-or-setid ?S
)
3402 (tramp-compat-octal-to-decimal "02000"))
3403 ((char-equal group-execute-or-setid ?s
)
3404 (tramp-compat-octal-to-decimal "02010"))
3405 ((char-equal group-execute-or-setid ?-
) 0)
3406 (t (error "Seventh char `%c' must be one of `xsS-'"
3407 group-execute-or-setid
)))
3409 ((char-equal other-read ?r
)
3410 (tramp-compat-octal-to-decimal "00004"))
3411 ((char-equal other-read ?-
) 0)
3412 (t (error "Eighth char `%c' must be one of `r-'" other-read
)))
3414 ((char-equal other-write ?w
) (tramp-compat-octal-to-decimal "00002"))
3415 ((char-equal other-write ?-
) 0)
3416 (t (error "Nineth char `%c' must be one of `w-'" other-write
)))
3418 ((char-equal other-execute-or-sticky ?x
)
3419 (tramp-compat-octal-to-decimal "00001"))
3420 ((char-equal other-execute-or-sticky ?T
)
3421 (tramp-compat-octal-to-decimal "01000"))
3422 ((char-equal other-execute-or-sticky ?t
)
3423 (tramp-compat-octal-to-decimal "01001"))
3424 ((char-equal other-execute-or-sticky ?-
) 0)
3425 (t (error "Tenth char `%c' must be one of `xtT-'"
3426 other-execute-or-sticky
)))))))
3428 (defun tramp-local-host-p (vec)
3429 "Return t if this points to the local host, nil otherwise."
3430 ;; We cannot use `tramp-file-name-real-host'. A port is an
3431 ;; indication for an ssh tunnel or alike.
3432 (let ((host (tramp-file-name-host vec
)))
3435 (string-match tramp-local-host-regexp host
)
3436 ;; The method shall be applied to one of the shell file name
3437 ;; handler. `tramp-local-host-p' is also called for "smb" and
3438 ;; alike, where it must fail.
3439 (tramp-get-method-parameter
3440 (tramp-file-name-method vec
) 'tramp-login-program
)
3441 ;; The local temp directory must be writable for the other user.
3443 (tramp-make-tramp-file-name
3444 (tramp-file-name-method vec
)
3445 (tramp-file-name-user vec
)
3447 (tramp-compat-temporary-file-directory)))
3448 ;; On some systems, chown runs only for root.
3449 (or (zerop (user-uid))
3450 ;; This is defined in tramp-sh.el. Let's assume this is
3452 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec
'integer
))))))
3454 (defun tramp-make-tramp-temp-file (vec)
3455 "Create a temporary file on the remote host identified by VEC.
3456 Return the local name of the temporary file."
3458 (tramp-make-tramp-file-name
3459 (tramp-file-name-method vec
)
3460 (tramp-file-name-user vec
)
3461 (tramp-file-name-host vec
)
3462 (tramp-drop-volume-letter
3464 tramp-temp-name-prefix
3465 ;; This is defined in tramp-sh.el. Let's assume this is
3467 (tramp-compat-funcall 'tramp-get-remote-tmpdir vec
)))))
3470 ;; `make-temp-file' would be the natural choice for
3471 ;; implementation. But it calls `write-region' internally,
3472 ;; which also needs a temporary file - we would end in an
3474 (setq result
(make-temp-name prefix
))
3475 (if (file-exists-p result
)
3477 ;; This creates the file by side effect.
3478 (set-file-times result
)
3479 (set-file-modes result
(tramp-compat-octal-to-decimal "0700"))))
3481 ;; Return the local part.
3482 (with-parsed-tramp-file-name result nil localname
)))
3484 (defun tramp-delete-temp-file-function ()
3485 "Remove temporary files related to current buffer."
3486 (when (stringp tramp-temp-buffer-file-name
)
3487 (ignore-errors (delete-file tramp-temp-buffer-file-name
))))
3489 (add-hook 'kill-buffer-hook
'tramp-delete-temp-file-function
)
3490 (add-hook 'tramp-cache-unload-hook
3492 (remove-hook 'kill-buffer-hook
3493 'tramp-delete-temp-file-function
)))
3495 ;;; Auto saving to a special directory:
3497 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name
)
3498 (defadvice make-auto-save-file-name
3499 (around tramp-advice-make-auto-save-file-name
() activate
)
3500 "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files."
3501 (if (tramp-tramp-file-p (buffer-file-name))
3502 ;; We cannot call `tramp-handle-make-auto-save-file-name'
3503 ;; directly, because this would bypass the locking mechanism.
3504 (setq ad-return-value
3505 (tramp-file-name-handler 'make-auto-save-file-name
))
3511 'make-auto-save-file-name
3512 'around
'tramp-advice-make-auto-save-file-name
)
3513 (ad-activate 'make-auto-save-file-name
))))
3515 ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus
3516 ;; umask. This is a security threat.
3518 (defun tramp-set-auto-save-file-modes ()
3519 "Set permissions of autosaved remote files to the original permissions."
3520 (let ((bfn (buffer-file-name)))
3521 (when (and (tramp-tramp-file-p bfn
)
3523 (stringp buffer-auto-save-file-name
)
3524 (not (equal bfn buffer-auto-save-file-name
)))
3525 (unless (file-exists-p buffer-auto-save-file-name
)
3526 (write-region "" nil buffer-auto-save-file-name
))
3527 ;; Permissions should be set always, because there might be an old
3528 ;; auto-saved file belonging to another original file. This could
3529 ;; be a security threat.
3531 buffer-auto-save-file-name
3532 (or (file-modes bfn
) (tramp-compat-octal-to-decimal "0600"))))))
3534 (unless (and (featurep 'xemacs
)
3535 (= emacs-major-version
21)
3536 (> emacs-minor-version
4))
3537 (add-hook 'auto-save-hook
'tramp-set-auto-save-file-modes
)
3538 (add-hook 'tramp-unload-hook
3540 (remove-hook 'auto-save-hook
'tramp-set-auto-save-file-modes
))))
3542 (defun tramp-subst-strs-in-string (alist string
)
3543 "Replace all occurrences of the string FROM with TO in STRING.
3544 ALIST is of the form ((FROM . TO) ...)."
3547 (let* ((pr (car alist
))
3550 (while (string-match (regexp-quote from
) string
)
3551 (setq string
(replace-match to t t string
)))
3552 (setq alist
(cdr alist
))))
3555 ;;; Compatibility functions section:
3557 (defun tramp-read-passwd (proc &optional prompt
)
3558 "Read a password from user (compat function).
3559 Consults the auth-source package.
3560 Invokes `password-read' if available, `read-passwd' else."
3561 (let* ((key (tramp-make-tramp-file-name
3562 tramp-current-method tramp-current-user
3563 tramp-current-host
""))
3566 (with-current-buffer (process-buffer proc
)
3567 (tramp-check-for-regexp proc tramp-password-prompt-regexp
)
3568 (format "%s for %s " (capitalize (match-string 1)) key
))))
3569 auth-info auth-passwd
)
3570 (with-parsed-tramp-file-name key nil
3573 ;; See if auth-sources contains something useful, if it's
3574 ;; bound. `auth-source-user-or-password' is an obsoleted
3575 ;; function, it has been replaced by `auth-source-search'.
3576 (and (boundp 'auth-sources
)
3577 (tramp-get-connection-property v
"first-password-request" nil
)
3578 ;; Try with Tramp's current method.
3579 (if (fboundp 'auth-source-search
)
3581 (tramp-compat-funcall
3584 :user
(or tramp-current-user t
)
3585 :host tramp-current-host
3586 :port tramp-current-method
)
3587 auth-passwd
(plist-get (nth 0 auth-info
) :secret
)
3588 auth-passwd
(if (functionp auth-passwd
)
3589 (funcall auth-passwd
)
3591 (tramp-compat-funcall
3592 'auth-source-user-or-password
3593 "password" tramp-current-host tramp-current-method
)))
3594 ;; Try the password cache.
3595 (when (functionp 'password-read
)
3596 (unless (tramp-get-connection-property
3597 v
"first-password-request" nil
)
3598 (tramp-compat-funcall 'password-cache-remove key
))
3600 (tramp-compat-funcall 'password-read pw-prompt key
)))
3601 (tramp-compat-funcall 'password-cache-add key password
)
3603 ;; Else, get the password interactively.
3604 (read-passwd pw-prompt
))
3605 (tramp-set-connection-property v
"first-password-request" nil
)))))
3607 (defun tramp-clear-passwd (vec)
3608 "Clear password cache for connection related to VEC."
3609 (tramp-compat-funcall
3610 'password-cache-remove
3611 (tramp-make-tramp-file-name
3612 (tramp-file-name-method vec
)
3613 (tramp-file-name-user vec
)
3614 (tramp-file-name-host vec
)
3617 ;; Snarfed code from time-date.el and parse-time.el
3619 (defconst tramp-half-a-year
'(241 17024)
3620 "Evaluated by \"(days-to-time 183)\".")
3622 (defconst tramp-parse-time-months
3623 '(("jan" .
1) ("feb" .
2) ("mar" .
3)
3624 ("apr" .
4) ("may" .
5) ("jun" .
6)
3625 ("jul" .
7) ("aug" .
8) ("sep" .
9)
3626 ("oct" .
10) ("nov" .
11) ("dec" .
12))
3627 "Alist mapping month names to integers.")
3629 (defun tramp-time-less-p (t1 t2
)
3630 "Say whether time value T1 is less than time value T2."
3631 (unless t1
(setq t1
'(0 0)))
3632 (unless t2
(setq t2
'(0 0)))
3633 (or (< (car t1
) (car t2
))
3634 (and (= (car t1
) (car t2
))
3635 (< (nth 1 t1
) (nth 1 t2
)))))
3637 (defun tramp-time-subtract (t1 t2
)
3638 "Subtract two time values.
3639 Return the difference in the format of a time value."
3640 (unless t1
(setq t1
'(0 0)))
3641 (unless t2
(setq t2
'(0 0)))
3642 (let ((borrow (< (cadr t1
) (cadr t2
))))
3643 (list (- (car t1
) (car t2
) (if borrow
1 0))
3644 (- (+ (if borrow
65536 0) (cadr t1
)) (cadr t2
)))))
3646 (defun tramp-time-diff (t1 t2
)
3647 "Return the difference between the two times, in seconds.
3648 T1 and T2 are time values (as returned by `current-time' for example)."
3649 (cond ((and (fboundp 'subtract-time
)
3650 (fboundp 'float-time
))
3651 (tramp-compat-funcall
3652 'float-time
(tramp-compat-funcall 'subtract-time t1 t2
)))
3653 ((and (fboundp 'subtract-time
)
3654 (fboundp 'time-to-seconds
))
3655 (tramp-compat-funcall
3656 'time-to-seconds
(tramp-compat-funcall 'subtract-time t1 t2
)))
3657 ((fboundp 'itimer-time-difference
)
3658 (tramp-compat-funcall
3659 'itimer-time-difference
3660 (if (< (length t1
) 3) (append t1
'(0)) t1
)
3661 (if (< (length t2
) 3) (append t2
'(0)) t2
)))
3663 (let ((time (tramp-time-subtract t1 t2
)))
3664 (+ (* (car time
) 65536.0)
3666 (/ (or (nth 2 time
) 0) 1000000.0))))))
3668 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
3669 ;; does not deal well with newline characters. Newline is replaced by
3670 ;; backslash newline. But if, say, the string `a backslash newline b'
3671 ;; is passed to a shell, the shell will expand this into "ab",
3672 ;; completely omitting the newline. This is not what was intended.
3673 ;; It does not appear to be possible to make the function
3674 ;; `shell-quote-argument' work with newlines without making it
3675 ;; dependent on the shell used. But within this package, we know that
3676 ;; we will always use a Bourne-like shell, so we use an approach which
3679 ;; The approach is simple: we call `shell-quote-argument', then
3680 ;; massage the newline part of the result.
3682 ;; This function should produce a string which is grokked by a Unix
3683 ;; shell, even if the Emacs is running on Windows. Since this is the
3684 ;; kludges section, we bind `system-type' in such a way that
3685 ;; `shell-quote-arguments' behaves as if on Unix.
3687 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
3688 ;; function to work with Bourne-like shells.
3690 ;; CCC: This function should be rewritten so that
3691 ;; `shell-quote-argument' is not used. This way, we are safe from
3692 ;; changes in `shell-quote-argument'.
3693 ;;;###tramp-autoload
3694 (defun tramp-shell-quote-argument (s)
3695 "Similar to `shell-quote-argument', but groks newlines.
3696 Only works for Bourne-like shells."
3697 (let ((system-type 'not-windows
))
3699 (let ((result (shell-quote-argument s
))
3700 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line
))))
3701 (when (and (>= (length result
) 2)
3702 (string= (substring result
0 2) "\\~"))
3703 (setq result
(substring result
1)))
3704 (while (string-match nl result
)
3705 (setq result
(replace-match (format "'%s'" tramp-rsh-end-of-line
)
3709 ;; Checklist for `tramp-unload-hook'
3710 ;; - Unload all `tramp-*' packages
3711 ;; - Reset `file-name-handler-alist'
3712 ;; - Cleanup hooks where Tramp functions are in
3713 ;; - Cleanup advised functions
3714 ;; - Cleanup autoloads
3716 (defun tramp-unload-tramp ()
3717 "Discard Tramp from loading remote files."
3719 ;; ange-ftp settings must be enabled.
3720 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp
)
3721 ;; Maybe it's not loaded yet.
3722 (ignore-errors (unload-feature 'tramp
'force
)))
3728 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
3729 ;; `shell-quote-argument'.
3730 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
3731 ;; by the files in that directory. Add this here.
3732 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
3733 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
3734 ;; * abbreviate-file-name
3735 ;; * Better error checking. At least whenever we see something
3736 ;; strange when doing zerop, we should kill the process and start
3737 ;; again. (Greg Stark)
3738 ;; * Username and hostname completion.
3739 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
3740 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
3741 ;; Code is nearly identical.
3742 ;; * Make `tramp-default-user' obsolete.
3743 ;; * Implement a general server-local-variable mechanism, as there are
3744 ;; probably other variables that need different values for different
3745 ;; servers too. The user could then configure a variable (such as
3746 ;; tramp-server-local-variable-alist) to define any such variables
3747 ;; that they need to, which would then be let bound as appropriate
3748 ;; in tramp functions. (Jason Rumney)
3749 ;; * IMHO, it's a drawback that currently Tramp doesn't support
3750 ;; Unicode in Dired file names by default. Is it possible to
3751 ;; improve Tramp to set LC_ALL to "C" only for commands where Tramp
3752 ;; expects English? Or just to set LC_MESSAGES to "C" if Tramp
3753 ;; expects only English messages? (Juri Linkov)
3754 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
3755 ;; * I was wondering it it would be possible to use tramp even if I'm
3756 ;; actually using sshfs. But when I launch a command I would like
3757 ;; to get it executed on the remote machine where the files really
3758 ;; are. (Andrea Crotti)
3759 ;; * Run emerge on two remote files. Bug is described here:
3760 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
3763 ;; Functions for file-name-handler-alist:
3764 ;; diff-latest-backup-file -- in diff.el
3766 ;;; tramp.el ends here