1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2013 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 (eval-when-compile (require 'cl)) ; ignore-errors
61 (require 'tramp-compat)
63 ;;; User Customizable Internal Variables:
66 "Edit remote files with a combination of ssh, scp, etc."
71 ;; Maybe we need once a real Tramp mode, with key bindings etc.
73 (defcustom tramp-mode t
74 "Whether Tramp is enabled.
75 If it is set to nil, all remote file names are used literally."
79 (defcustom tramp-verbose 3
80 "Verbosity level for Tramp messages.
81 Any level x includes messages for all levels 1 .. x-1. The levels are
83 0 silent (no tramp messages at all)
86 3 connection to remote hosts (default level)
89 6 sent and received strings
91 8 connection properties
99 (when (boundp 'backup-directory-alist)
100 (defcustom tramp-backup-directory-alist nil
101 "Alist of filename patterns and backup directory names.
102 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
103 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
104 is a local file name, the backup directory is prepended with Tramp file
105 name prefix \(method, user, host\) of file.
107 \(setq tramp-backup-directory-alist backup-directory-alist\)
109 gives the same backup policy for Tramp files on their hosts like the
110 policy for local files."
112 :type '(repeat (cons (regexp :tag "Regexp matching filename")
113 (directory :tag "Backup directory name"))))))
115 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
116 ;; the package "backup-dir" might not be loaded yet.
118 (when (featurep 'xemacs)
119 (defcustom tramp-bkup-backup-directory-info nil
120 "Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
121 It has the same meaning like `bkup-backup-directory-info' from package
122 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
123 file name, the backup directory is prepended with Tramp file name prefix
124 \(method, user, host\) of file.
126 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
128 gives the same backup policy for Tramp files on their hosts like the
129 policy for local files."
131 (list (regexp :tag "File regexp")
132 (string :tag "Backup Dir")
137 (const search-upward))))
140 (defcustom tramp-auto-save-directory nil
141 "Put auto-save files in this directory, if set.
142 The idea is to use a local directory so that auto-saving is faster."
144 :type '(choice (const nil) string))
146 (defcustom tramp-encoding-shell
147 (if (memq system-type '(windows-nt))
150 "Use this program for encoding and decoding commands on the local host.
151 This shell is used to execute the encoding and decoding command on the
152 local host, so if you want to use `~' in those commands, you should
153 choose a shell here which groks tilde expansion. `/bin/sh' normally
154 does not understand tilde expansion.
156 For encoding and decoding, commands like the following are executed:
158 /bin/sh -c COMMAND < INPUT > OUTPUT
160 This variable can be used to change the \"/bin/sh\" part. See the
161 variable `tramp-encoding-command-switch' for the \"-c\" part.
163 If the shell must be forced to be interactive, see
164 `tramp-encoding-command-interactive'.
166 Note that this variable is not used for remote commands. There are
167 mechanisms in tramp.el which automatically determine the right shell to
168 use for the remote host."
170 :type '(file :must-match t))
172 (defcustom tramp-encoding-command-switch
173 (if (string-match "cmd\\.exe" tramp-encoding-shell)
176 "Use this switch together with `tramp-encoding-shell' for local commands.
177 See the variable `tramp-encoding-shell' for more information."
181 (defcustom tramp-encoding-command-interactive
182 (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i")
183 "Use this switch together with `tramp-encoding-shell' for interactive shells.
184 See the variable `tramp-encoding-shell' for more information."
187 :type '(choice (const nil) string))
190 (defvar tramp-methods nil
191 "Alist of methods for remote files.
192 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
193 Each NAME stands for a remote access method. Each PARAM is a
194 pair of the form (KEY VALUE). The following KEYs are defined:
195 * `tramp-remote-shell'
196 This specifies the shell to use on the remote host. This
197 MUST be a Bourne-like shell. It is normally not necessary to
198 set this to any value other than \"/bin/sh\": Tramp wants to
199 use a shell which groks tilde expansion, but it can search
200 for it. Also note that \"/bin/sh\" exists on all Unixen,
201 this might not be true for the value that you decide to use.
202 You Have Been Warned.
203 * `tramp-remote-shell-args'
204 For implementation of `shell-command', this specifies the
205 arguments to let `tramp-remote-shell' run a single command.
206 * `tramp-login-program'
207 This specifies the name of the program to use for logging in to the
208 remote host. This may be the name of rsh or a workalike program,
209 or the name of telnet or a workalike, or the name of su or a workalike.
211 This specifies the list of arguments to pass to the above
212 mentioned program. Please note that this is a list of list of arguments,
213 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
214 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
215 There are some patterns: \"%h\" in this list is replaced by the host
216 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
217 port number, and \"%%\" can be used to obtain a literal percent character.
218 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
219 expansion (i.e. no host or no user specified), this list is not used as
220 argument. By this, arguments like (\"-l\" \"%u\") are optional.
221 \"%t\" is replaced by the temporary file name produced with
222 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
223 parameter of a program, if exists.
225 When an asynchronous process is started, we know already that
226 the connection works. Therefore, we can pass additional
227 parameters to suppress diagnostic messages, in order not to
228 tamper the process output.
229 * `tramp-copy-program'
230 This specifies the name of the program to use for remotely copying
231 the file; this might be the absolute filename of rcp or the name of
234 This specifies the list of parameters to pass to the above mentioned
235 program, the hints for `tramp-login-args' also apply here.
236 * `tramp-copy-keep-date'
237 This specifies whether the copying program when the preserves the
238 timestamp of the original file.
239 * `tramp-copy-keep-tmpfile'
240 This specifies whether a temporary local file shall be kept
241 for optimization reasons (useful for \"rsync\" methods).
242 * `tramp-copy-recursive'
243 Whether the operation copies directories recursively.
244 * `tramp-default-port'
245 The default port of a method is needed in case of gateway connections.
246 Additionally, it is used as indication which method is prepared for
249 As the attribute name says, additional arguments are specified here
250 when a method is applied via a gateway.
252 A directory on the remote host for temporary files. If not
253 specified, \"/tmp\" is taken as default.
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 performs
295 ;; much better 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."
385 (defcustom tramp-default-host-alist nil
386 "Default host to use for specific method/user pairs.
387 This is an alist of items (METHOD USER HOST). The first matching item
388 specifies the host to use for a file name which does not specify a
389 host. METHOD and HOST are regular expressions or nil, which is
390 interpreted as a regular expression which always matches. If no entry
391 matches, the variable `tramp-default-host' takes effect.
393 If the file name does not specify the method, lookup is done using the
394 empty string for the method name."
397 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
398 (choice :tag " User regexp" regexp sexp)
399 (choice :tag " Host name" string (const nil)))))
401 (defcustom tramp-default-proxies-alist nil
402 "Route to be followed for specific host/user pairs.
403 This is an alist of items (HOST USER PROXY). The first matching
404 item specifies the proxy to be passed for a file name located on
405 a remote target matching USER@HOST. HOST and USER are regular
406 expressions. PROXY must be a Tramp filename without a localname
407 part. Method and user name on PROXY are optional, which is
408 interpreted with the default values. PROXY can contain the
409 patterns %h and %u, which are replaced by the strings matching
410 HOST or USER, respectively.
412 HOST, USER or PROXY could also be Lisp forms, which will be
413 evaluated. The result must be a string or nil, which is
414 interpreted as a regular expression which always matches."
416 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
417 (choice :tag "User regexp" regexp sexp)
418 (choice :tag " Proxy name" string (const nil)))))
420 (defcustom tramp-save-ad-hoc-proxies nil
421 "Whether to save ad-hoc proxies persistently."
426 (defcustom tramp-restricted-shell-hosts-alist
427 (when (memq system-type '(windows-nt))
428 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
429 "List of hosts, which run a restricted shell.
430 This is a list of regular expressions, which denote hosts running
431 a registered shell like \"rbash\". Those hosts can be used as
432 proxies only, see `tramp-default-proxies-alist'. If the local
433 host runs a registered shell, it shall be added to this list, too."
436 :type '(repeat (regexp :tag "Host regexp")))
439 (defconst tramp-local-host-regexp
443 (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t)
445 "Host names which are regarded as local host.")
447 (defvar tramp-completion-function-alist nil
448 "Alist of methods for remote files.
449 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\).
450 Each NAME stands for a remote access method. Each PAIR is of the form
451 \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host
452 names from FILE for completion. The following predefined FUNCTIONs exists:
454 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
455 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
456 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
457 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
458 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
459 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
460 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
461 * `tramp-parse-netrc' for \"~/.netrc\" like files.
462 * `tramp-parse-putty' for PuTTY registered sessions.
464 FUNCTION can also be a customer defined function. For more details see
467 (defconst tramp-echo-mark-marker "_echo"
468 "String marker to surround echoed commands.")
470 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
471 "String length of `tramp-echo-mark-marker'.")
473 (defconst tramp-echo-mark
474 (concat tramp-echo-mark-marker
475 (make-string tramp-echo-mark-marker-length ?\b))
476 "String mark to be transmitted around shell commands.
477 Used to separate their echo from the output they produce. This
478 will only be used if we cannot disable remote echo via stty.
479 This string must have no effect on the remote shell except for
480 producing some echo which can later be detected by
481 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
482 followed by an equal number of backspaces to erase them will
485 (defconst tramp-echoed-echo-mark-regexp
486 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
487 tramp-echo-mark-marker tramp-echo-mark-marker-length)
488 "Regexp which matches `tramp-echo-mark' as it gets echoed by
491 (defcustom tramp-local-end-of-line
492 (if (memq system-type '(windows-nt)) "\r\n" "\n")
493 "String used for end of line in local processes."
498 (defcustom tramp-rsh-end-of-line "\n"
499 "String used for end of line in rsh connections.
500 I don't think this ever needs to be changed, so please tell me about it
501 if you need to change this."
505 (defcustom tramp-login-prompt-regexp
506 ".*ogin\\( .*\\)?: *"
507 "Regexp matching login-like prompts.
508 The regexp should match at end of buffer.
510 Sometimes the prompt is reported to look like \"login as:\"."
514 (defcustom tramp-shell-prompt-pattern
515 ;; Allow a prompt to start right after a ^M since it indeed would be
516 ;; displayed at the beginning of the line (and Zsh uses it). This
517 ;; regexp works only for GNU Emacs.
518 ;; Allow also [] style prompts. They can appear only during
519 ;; connection initialization; Tramp redefines the prompt afterwards.
520 (concat (if (featurep 'xemacs) "" "\\(?:^\\|\r\\)")
521 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
522 "Regexp to match prompts from remote shell.
523 Normally, Tramp expects you to configure `shell-prompt-pattern'
524 correctly, but sometimes it happens that you are connecting to a
525 remote host which sends a different kind of shell prompt. Therefore,
526 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
527 and also things matched by this variable. The default value of this
528 variable is similar to the default value of `shell-prompt-pattern',
529 which should work well in many cases.
531 This regexp must match both `tramp-initial-end-of-output' and
532 `tramp-end-of-output'."
536 (defcustom tramp-password-prompt-regexp
537 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
538 "Regexp matching password-like prompts.
539 The regexp should match at end of buffer.
541 The `sudo' program appears to insert a `^@' character into the prompt."
545 (defcustom tramp-wrong-passwd-regexp
547 ;; These strings should be on the last line
548 (regexp-opt '("Permission denied"
553 "Timeout, server not responding."
555 "Name or service not known"
556 "Host key verification failed."
557 "No supported authentication methods left to try!") t)
561 ;; Here comes a list of regexes, separated by \\|
562 "Received signal [0-9]+"
564 "Regexp matching a `login failed' message.
565 The regexp should match at end of buffer."
569 (defcustom tramp-yesno-prompt-regexp
571 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
573 "Regular expression matching all yes/no queries which need to be confirmed.
574 The confirmation should be done with yes or no.
575 The regexp should match at end of buffer.
576 See also `tramp-yn-prompt-regexp'."
580 (defcustom tramp-yn-prompt-regexp
582 (regexp-opt '("Store key in cache? (y/n)"
583 "Update cached key? (y/n, Return cancels connection)") t)
585 "Regular expression matching all y/n queries which need to be confirmed.
586 The confirmation should be done with y or n.
587 The regexp should match at end of buffer.
588 See also `tramp-yesno-prompt-regexp'."
592 (defcustom tramp-terminal-prompt-regexp
596 "Terminal type\\? \\[.*\\]"
598 "Regular expression matching all terminal setting prompts.
599 The regexp should match at end of buffer.
600 The answer will be provided by `tramp-action-terminal', which see."
604 (defcustom tramp-operation-not-permitted-regexp
605 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
606 (regexp-opt '("Operation not permitted") t))
607 "Regular expression matching keep-date problems in (s)cp operations.
608 Copying has been performed successfully already, so this message can
613 (defcustom tramp-copy-failed-regexp
615 (regexp-opt '("Permission denied"
618 "No such file or directory") t)
620 "Regular expression matching copy problems in (s)cp operations."
624 (defcustom tramp-process-alive-regexp
626 "Regular expression indicating a process has finished.
627 In fact this expression is empty by intention, it will be used only to
628 check regularly the status of the associated process.
629 The answer will be provided by `tramp-action-process-alive',
630 `tramp-action-out-of-band', which see."
634 (defconst tramp-temp-name-prefix "tramp."
635 "Prefix to use for temporary files.
636 If this is a relative file name (such as \"tramp.\"), it is considered
637 relative to the directory name returned by the function
638 `tramp-compat-temporary-file-directory' (which see). It may also be an
639 absolute file name; don't forget to include a prefix for the filename
642 (defconst tramp-temp-buffer-name " *tramp temp*"
643 "Buffer name for a temporary buffer.
644 It shall be used in combination with `generate-new-buffer-name'.")
646 (defvar tramp-temp-buffer-file-name nil
647 "File name of a persistent local temporary file.
648 Useful for \"rsync\" like methods.")
649 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
650 (put 'tramp-temp-buffer-file-name 'permanent-local t)
652 ;; XEmacs is distributed with few Lisp packages. Further packages are
653 ;; installed using EFS. If we use a unified filename format, then
654 ;; Tramp is required in addition to EFS. (But why can't Tramp just
655 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
656 ;; just like before.) Another reason for using a separate filename
657 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
658 ;; Tramp only knows how to deal with `file-name-handler-alist', not
661 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
663 (defcustom tramp-syntax
664 (if (featurep 'xemacs) 'sep 'ftp)
665 "Tramp filename syntax to be used.
667 It can have the following values:
669 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
670 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
671 'url -- URL-like syntax."
673 :type (if (featurep 'xemacs)
674 '(choice (const :tag "EFS" ftp)
675 (const :tag "XEmacs" sep)
676 (const :tag "URL" url))
677 '(choice (const :tag "Ange-FTP" ftp)
678 (const :tag "URL" url))))
680 (defconst tramp-prefix-format
681 (cond ((equal tramp-syntax 'ftp) "/")
682 ((equal tramp-syntax 'sep) "/[")
683 ((equal tramp-syntax 'url) "/")
684 (t (error "Wrong `tramp-syntax' defined")))
685 "String matching the very beginning of Tramp file names.
686 Used in `tramp-make-tramp-file-name'.")
688 (defconst tramp-prefix-regexp
689 (concat "^" (regexp-quote tramp-prefix-format))
690 "Regexp matching the very beginning of Tramp file names.
691 Should always start with \"^\". Derived from `tramp-prefix-format'.")
693 (defconst tramp-method-regexp
695 "Regexp matching methods identifiers.")
697 (defconst tramp-postfix-method-format
698 (cond ((equal tramp-syntax 'ftp) ":")
699 ((equal tramp-syntax 'sep) "/")
700 ((equal tramp-syntax 'url) "://")
701 (t (error "Wrong `tramp-syntax' defined")))
702 "String matching delimiter between method and user or host names.
703 Used in `tramp-make-tramp-file-name'.")
705 (defconst tramp-postfix-method-regexp
706 (regexp-quote tramp-postfix-method-format)
707 "Regexp matching delimiter between method and user or host names.
708 Derived from `tramp-postfix-method-format'.")
710 (defconst tramp-user-regexp "[^/|: \t]+"
711 "Regexp matching user names.")
714 (defconst tramp-prefix-domain-format "%"
715 "String matching delimiter between user and domain names.")
718 (defconst tramp-prefix-domain-regexp
719 (regexp-quote tramp-prefix-domain-format)
720 "Regexp matching delimiter between user and domain names.
721 Derived from `tramp-prefix-domain-format'.")
723 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
724 "Regexp matching domain names.")
726 (defconst tramp-user-with-domain-regexp
727 (concat "\\(" tramp-user-regexp "\\)"
728 tramp-prefix-domain-regexp
729 "\\(" tramp-domain-regexp "\\)")
730 "Regexp matching user names with domain names.")
732 (defconst tramp-postfix-user-format "@"
733 "String matching delimiter between user and host names.
734 Used in `tramp-make-tramp-file-name'.")
736 (defconst tramp-postfix-user-regexp
737 (regexp-quote tramp-postfix-user-format)
738 "Regexp matching delimiter between user and host names.
739 Derived from `tramp-postfix-user-format'.")
741 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
742 "Regexp matching host names.")
744 (defconst tramp-prefix-ipv6-format
745 (cond ((equal tramp-syntax 'ftp) "[")
746 ((equal tramp-syntax 'sep) "")
747 ((equal tramp-syntax 'url) "[")
748 (t (error "Wrong `tramp-syntax' defined")))
749 "String matching left hand side of IPv6 addresses.
750 Used in `tramp-make-tramp-file-name'.")
752 (defconst tramp-prefix-ipv6-regexp
753 (regexp-quote tramp-prefix-ipv6-format)
754 "Regexp matching left hand side of IPv6 addresses.
755 Derived from `tramp-prefix-ipv6-format'.")
757 ;; The following regexp is a bit sloppy. But it shall serve our
758 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
759 ;; "::ffff:192.168.0.1".
760 (defconst tramp-ipv6-regexp
761 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
762 "Regexp matching IPv6 addresses.")
764 (defconst tramp-postfix-ipv6-format
765 (cond ((equal tramp-syntax 'ftp) "]")
766 ((equal tramp-syntax 'sep) "")
767 ((equal tramp-syntax 'url) "]")
768 (t (error "Wrong `tramp-syntax' defined")))
769 "String matching right hand side of IPv6 addresses.
770 Used in `tramp-make-tramp-file-name'.")
772 (defconst tramp-postfix-ipv6-regexp
773 (regexp-quote tramp-postfix-ipv6-format)
774 "Regexp matching right hand side of IPv6 addresses.
775 Derived from `tramp-postfix-ipv6-format'.")
777 (defconst tramp-prefix-port-format
778 (cond ((equal tramp-syntax 'ftp) "#")
779 ((equal tramp-syntax 'sep) "#")
780 ((equal tramp-syntax 'url) ":")
781 (t (error "Wrong `tramp-syntax' defined")))
782 "String matching delimiter between host names and port numbers.")
784 (defconst tramp-prefix-port-regexp
785 (regexp-quote tramp-prefix-port-format)
786 "Regexp matching delimiter between host names and port numbers.
787 Derived from `tramp-prefix-port-format'.")
789 (defconst tramp-port-regexp "[0-9]+"
790 "Regexp matching port numbers.")
792 (defconst tramp-host-with-port-regexp
793 (concat "\\(" tramp-host-regexp "\\)"
794 tramp-prefix-port-regexp
795 "\\(" tramp-port-regexp "\\)")
796 "Regexp matching host names with port numbers.")
798 (defconst tramp-postfix-hop-format "|"
799 "String matching delimiter after ad-hoc hop definitions.")
801 (defconst tramp-postfix-hop-regexp
802 (regexp-quote tramp-postfix-hop-format)
803 "Regexp matching delimiter after ad-hoc hop definitions.
804 Derived from `tramp-postfix-hop-format'.")
806 (defconst tramp-postfix-host-format
807 (cond ((equal tramp-syntax 'ftp) ":")
808 ((equal tramp-syntax 'sep) "]")
809 ((equal tramp-syntax 'url) "")
810 (t (error "Wrong `tramp-syntax' defined")))
811 "String matching delimiter between host names and localnames.
812 Used in `tramp-make-tramp-file-name'.")
814 (defconst tramp-postfix-host-regexp
815 (regexp-quote tramp-postfix-host-format)
816 "Regexp matching delimiter between host names and localnames.
817 Derived from `tramp-postfix-host-format'.")
819 (defconst tramp-localname-regexp ".*$"
820 "Regexp matching localnames.")
822 ;;; File name format:
824 (defconst tramp-remote-file-name-spec-regexp
826 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
827 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
828 "\\(" "\\(?:" tramp-host-regexp "\\|"
829 tramp-prefix-ipv6-regexp tramp-ipv6-regexp
830 tramp-postfix-ipv6-regexp "\\)"
831 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
832 "Regular expression matching a Tramp file name between prefix and postfix.")
834 (defconst tramp-file-name-structure
838 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
839 tramp-postfix-hop-regexp "\\)+" "\\)?"
840 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
841 "\\(" tramp-localname-regexp "\\)")
843 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
844 the Tramp file name structure.
846 The first element REGEXP is a regular expression matching a Tramp file
847 name. The regex should contain parentheses around the method name,
848 the user name, the host name, and the file name parts.
850 The second element METHOD is a number, saying which pair of
851 parentheses matches the method name. The third element USER is
852 similar, but for the user name. The fourth element HOST is similar,
853 but for the host name. The fifth element FILE is for the file name.
854 The last element HOP is the ad-hoc hop definition, which could be a
855 cascade of several hops.
857 These numbers are passed directly to `match-string', which see. That
858 means the opening parentheses are counted to identify the pair.
860 See also `tramp-file-name-regexp'.")
863 (defconst tramp-file-name-regexp-unified
864 (if (memq system-type '(cygwin windows-nt))
865 "\\`/\\([^[/|:]\\{2,\\}\\|[^/|]\\{2,\\}]\\):"
866 "\\`/\\([^[/|:]+\\|[^/|]+]\\):")
867 "Value for `tramp-file-name-regexp' for unified remoting.
868 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
869 Tramp. See `tramp-file-name-structure' for more explanations.
871 On W32 systems, the volume letter must be ignored.")
874 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
875 "Value for `tramp-file-name-regexp' for separate remoting.
876 XEmacs uses a separate filename syntax for Tramp and EFS.
877 See `tramp-file-name-structure' for more explanations.")
880 (defconst tramp-file-name-regexp-url "\\`/[^/|:]+://"
881 "Value for `tramp-file-name-regexp' for URL-like remoting.
882 See `tramp-file-name-structure' for more explanations.")
885 (defconst tramp-file-name-regexp
886 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
887 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
888 ((equal tramp-syntax 'url) tramp-file-name-regexp-url)
889 (t (error "Wrong `tramp-syntax' defined")))
890 "Regular expression matching file names handled by Tramp.
891 This regexp should match Tramp file names but no other file names.
892 When tramp.el is loaded, this regular expression is prepended to
893 `file-name-handler-alist', and that is searched sequentially. Thus,
894 if the Tramp entry appears rather early in the `file-name-handler-alist'
895 and is a bit too general, then some files might be considered Tramp
896 files which are not really Tramp files.
898 Please note that the entry in `file-name-handler-alist' is made when
899 this file \(tramp.el\) is loaded. This means that this variable must be set
900 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
901 updated after changing this variable.
903 Also see `tramp-file-name-structure'.")
906 (defconst tramp-completion-file-name-regexp-unified
907 (if (memq system-type '(cygwin windows-nt))
908 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
909 "Value for `tramp-completion-file-name-regexp' for unified remoting.
910 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
911 See `tramp-file-name-structure' for more explanations.
913 On W32 systems, the volume letter must be ignored.")
916 (defconst tramp-completion-file-name-regexp-separate
917 "\\`/\\([[][^]]*\\)?\\'"
918 "Value for `tramp-completion-file-name-regexp' for separate remoting.
919 XEmacs uses a separate filename syntax for Tramp and EFS.
920 See `tramp-file-name-structure' for more explanations.")
923 (defconst tramp-completion-file-name-regexp-url
924 "\\`/[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?\\'"
925 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
926 See `tramp-file-name-structure' for more explanations.")
929 (defconst tramp-completion-file-name-regexp
930 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
931 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
932 ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url)
933 (t (error "Wrong `tramp-syntax' defined")))
934 "Regular expression matching file names handled by Tramp completion.
935 This regexp should match partial Tramp file names only.
937 Please note that the entry in `file-name-handler-alist' is made when
938 this file \(tramp.el\) is loaded. This means that this variable must be set
939 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
940 updated after changing this variable.
942 Also see `tramp-file-name-structure'.")
944 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
945 ;; known to have a bug in `process-send-string'; some ssh connections appear
946 ;; to drop bytes when data is sent too quickly. There is also a connection
947 ;; buffer local variable, which is computed depending on remote host properties
948 ;; when `tramp-chunksize' is zero or nil.
949 (defcustom tramp-chunksize
950 (when (and (not (featurep 'xemacs))
951 (memq system-type '(hpux)))
953 ;; Parentheses in docstring starting at beginning of line are escaped.
954 ;; Fontification is messed up when
955 ;; `open-paren-in-column-0-is-defun-start' set to t.
956 "If non-nil, chunksize for sending input to local process.
957 It is necessary only on systems which have a buggy `process-send-string'
958 implementation. The necessity, whether this variable must be set, can be
959 checked via the following code:
962 (let* ((user \"xxx\") (host \"yyy\")
964 (sent init) (received init))
965 (while (= sent received)
966 (setq sent (+ sent step))
968 (let ((proc (start-process (buffer-name) (current-buffer)
969 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
970 (when (memq (process-status proc) '(run open))
971 (process-send-string proc (make-string sent ?\\ ))
972 (process-send-eof proc)
973 (process-send-eof proc))
974 (while (not (progn (goto-char (point-min))
975 (re-search-forward \"\\\\w+\" (point-max) t)))
976 (accept-process-output proc 1))
977 (when (memq (process-status proc) '(run open))
978 (setq received (string-to-number (match-string 0)))
979 (delete-process proc)
980 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
982 (if (> sent (+ init step))
983 (message \"You should set `tramp-chunksize' to a maximum of %s\"
985 (message \"Test does not work\")
986 (display-buffer (current-buffer))
989 In the Emacs normally running Tramp, evaluate the above code
990 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
991 respectively\). You can do this, for example, by pasting it into
992 the `*scratch*' buffer and then hitting C-j with the cursor after the
993 last closing parenthesis. Note that it works only if you have configured
994 \"ssh\" to run without password query, see ssh-agent\(1\).
996 You will see the number of bytes sent successfully to the remote host.
997 If that number exceeds 1000, you can stop the execution by hitting
998 C-g, because your Emacs is likely clean.
1000 When it is necessary to set `tramp-chunksize', you might consider to
1001 use an out-of-the-band method \(like \"scp\"\) instead of an internal one
1002 \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases
1005 If your Emacs is buggy, the code stops and gives you an indication
1006 about the value `tramp-chunksize' should be set. Maybe you could just
1007 experiment a bit, e.g. changing the values of `init' and `step'
1008 in the third line of the code.
1010 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1011 this variable to be set as well."
1013 :type '(choice (const nil) integer))
1015 ;; Logging in to a remote host normally requires obtaining a pty. But
1016 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1017 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1018 ;; for an override of the system default.
1019 (defcustom tramp-process-connection-type t
1020 "Overrides `process-connection-type' for connections from Tramp.
1021 Tramp binds `process-connection-type' to the value given here before
1022 opening a connection to a remote host."
1024 :type '(choice (const nil) (const t) (const pty)))
1026 (defcustom tramp-connection-min-time-diff 5
1027 "Defines seconds between two consecutive connection attempts.
1028 This is necessary as self defense mechanism, in order to avoid
1029 yo-yo connection attempts when the remote host is unavailable.
1031 A value of 0 or `nil' suppresses this check. This might be
1032 necessary, when several out-of-order copy operations are
1033 performed, or when several asynchronous processes will be started
1034 in a short time frame. In those cases it is recommended to
1035 let-bind this variable."
1038 :type '(choice (const nil) integer))
1040 (defcustom tramp-completion-reread-directory-timeout 10
1041 "Defines seconds since last remote command before rereading a directory.
1042 A remote directory might have changed its contents. In order to
1043 make it visible during file name completion in the minibuffer,
1044 Tramp flushes its cache and rereads the directory contents when
1045 more than `tramp-completion-reread-directory-timeout' seconds
1046 have been gone since last remote command execution. A value of `t'
1047 would require an immediate reread during filename completion, `nil'
1048 means to use always cached values for the directory contents."
1050 :type '(choice (const nil) (const t) integer))
1052 ;;; Internal Variables:
1054 (defvar tramp-current-method nil
1055 "Connection method for this *tramp* buffer.")
1057 (defvar tramp-current-user nil
1058 "Remote login name for this *tramp* buffer.")
1060 (defvar tramp-current-host nil
1061 "Remote host for this *tramp* buffer.")
1064 (defconst tramp-completion-file-name-handler-alist
1065 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1066 (file-name-completion . tramp-completion-handle-file-name-completion))
1067 "Alist of completion handler functions.
1068 Used for file names matching `tramp-file-name-regexp'. Operations
1069 not mentioned here will be handled by Tramp's file name handler
1070 functions, or the normal Emacs functions.")
1072 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1073 ;;;###tramp-autoload
1074 (defvar tramp-foreign-file-name-handler-alist nil
1075 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1076 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1079 ;;; Internal functions which must come first:
1081 ;; Conversion functions between external representation and
1082 ;; internal data structure. Convenience functions for internal
1085 (defun tramp-get-method-parameter (method param)
1086 "Return the method parameter PARAM.
1087 If the `tramp-methods' entry does not exist, return nil."
1088 (let ((entry (assoc param (assoc method tramp-methods))))
1089 (when entry (cadr entry))))
1091 (defun tramp-file-name-p (vec)
1092 "Check, whether VEC is a Tramp object."
1093 (and (vectorp vec) (= 5 (length vec))))
1095 (defun tramp-file-name-method (vec)
1096 "Return method component of VEC."
1097 (and (tramp-file-name-p vec) (aref vec 0)))
1099 (defun tramp-file-name-user (vec)
1100 "Return user component of VEC."
1101 (and (tramp-file-name-p vec) (aref vec 1)))
1103 (defun tramp-file-name-host (vec)
1104 "Return host component of VEC."
1105 (and (tramp-file-name-p vec) (aref vec 2)))
1107 (defun tramp-file-name-localname (vec)
1108 "Return localname component of VEC."
1109 (and (tramp-file-name-p vec) (aref vec 3)))
1111 (defun tramp-file-name-hop (vec)
1112 "Return hop component of VEC."
1113 (and (tramp-file-name-p vec) (aref vec 4)))
1115 ;; The user part of a Tramp file name vector can be of kind
1116 ;; "user%domain". Sometimes, we must extract these parts.
1117 (defun tramp-file-name-real-user (vec)
1118 "Return the user name of VEC without domain."
1120 (let ((user (tramp-file-name-user vec)))
1121 (if (and (stringp user)
1122 (string-match tramp-user-with-domain-regexp user))
1123 (match-string 1 user)
1126 (defun tramp-file-name-domain (vec)
1127 "Return the domain name of VEC."
1129 (let ((user (tramp-file-name-user vec)))
1131 (string-match tramp-user-with-domain-regexp user)
1132 (match-string 2 user)))))
1134 ;; The host part of a Tramp file name vector can be of kind
1135 ;; "host#port". Sometimes, we must extract these parts.
1136 (defun tramp-file-name-real-host (vec)
1137 "Return the host name of VEC without port."
1139 (let ((host (tramp-file-name-host vec)))
1140 (if (and (stringp host)
1141 (string-match tramp-host-with-port-regexp host))
1142 (match-string 1 host)
1145 (defun tramp-file-name-port (vec)
1146 "Return the port number of VEC."
1148 (let ((method (tramp-file-name-method vec))
1149 (host (tramp-file-name-host vec)))
1150 (or (and (stringp host)
1151 (string-match tramp-host-with-port-regexp host)
1152 (string-to-number (match-string 2 host)))
1153 (tramp-get-method-parameter method 'tramp-default-port)))))
1155 ;;;###tramp-autoload
1156 (defun tramp-tramp-file-p (name)
1157 "Return t if NAME is a string with Tramp file name syntax.
1158 It checks also, whether NAME is unibyte encoded."
1161 ; (string-equal name (string-as-unibyte name))
1162 (string-match tramp-file-name-regexp name))))
1164 (defun tramp-find-method (method user host)
1165 "Return the right method string to use.
1166 This is METHOD, if non-nil. Otherwise, do a lookup in
1167 `tramp-default-method-alist'."
1169 (let ((choices tramp-default-method-alist)
1172 (setq item (pop choices))
1173 (when (and (string-match (or (nth 0 item) "") (or host ""))
1174 (string-match (or (nth 1 item) "") (or user "")))
1175 (setq lmethod (nth 2 item))
1176 (setq choices nil)))
1178 tramp-default-method))
1180 (defun tramp-find-user (method user host)
1181 "Return the right user string to use.
1182 This is USER, if non-nil. Otherwise, do a lookup in
1183 `tramp-default-user-alist'."
1185 (let ((choices tramp-default-user-alist)
1188 (setq item (pop choices))
1189 (when (and (string-match (or (nth 0 item) "") (or method ""))
1190 (string-match (or (nth 1 item) "") (or host "")))
1191 (setq luser (nth 2 item))
1192 (setq choices nil)))
1194 tramp-default-user))
1196 (defun tramp-find-host (method user host)
1197 "Return the right host string to use.
1198 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1199 (or (and (> (length host) 0) host)
1200 (let ((choices tramp-default-host-alist)
1203 (setq item (pop choices))
1204 (when (and (string-match (or (nth 0 item) "") (or method ""))
1205 (string-match (or (nth 1 item) "") (or user "")))
1206 (setq lhost (nth 2 item))
1207 (setq choices nil)))
1209 tramp-default-host))
1211 (defun tramp-dissect-file-name (name &optional nodefault)
1212 "Return a `tramp-file-name' structure.
1213 The structure consists of remote method, remote user, remote host
1214 and localname (file name on remote host). If NODEFAULT is
1215 non-nil, the file name parts are not expanded to their default
1218 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1219 (unless match (error "Not a Tramp file name: %s" name))
1220 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1221 (user (match-string (nth 2 tramp-file-name-structure) name))
1222 (host (match-string (nth 3 tramp-file-name-structure) name))
1223 (localname (match-string (nth 4 tramp-file-name-structure) name))
1224 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1226 (when (string-match tramp-prefix-ipv6-regexp host)
1227 (setq host (replace-match "" nil t host)))
1228 (when (string-match tramp-postfix-ipv6-regexp host)
1229 (setq host (replace-match "" nil t host))))
1231 (vector method user host localname hop)
1233 (tramp-find-method method user host)
1234 (tramp-find-user method user host)
1235 (tramp-find-host method user host)
1238 (defun tramp-buffer-name (vec)
1239 "A name for the connection buffer VEC."
1240 ;; We must use `tramp-file-name-real-host', because for gateway
1241 ;; methods the default port will be expanded later on, which would
1243 (let ((method (tramp-file-name-method vec))
1244 (user (tramp-file-name-user vec))
1245 (host (tramp-file-name-real-host vec)))
1246 (if (not (zerop (length user)))
1247 (format "*tramp/%s %s@%s*" method user host)
1248 (format "*tramp/%s %s*" method host))))
1250 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1251 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1252 When not nil, an optional HOP is prepended."
1253 (concat tramp-prefix-format hop
1254 (when (not (zerop (length method)))
1255 (concat method tramp-postfix-method-format))
1256 (when (not (zerop (length user)))
1257 (concat user tramp-postfix-user-format))
1259 (if (string-match tramp-ipv6-regexp host)
1260 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1262 tramp-postfix-host-format
1263 (when localname localname)))
1265 (defun tramp-completion-make-tramp-file-name (method user host localname)
1266 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1267 It must not be a complete Tramp file name, but as long as there are
1268 necessary only. This function will be used in file name completion."
1269 (concat tramp-prefix-format
1270 (when (not (zerop (length method)))
1271 (concat method tramp-postfix-method-format))
1272 (when (not (zerop (length user)))
1273 (concat user tramp-postfix-user-format))
1274 (when (not (zerop (length host)))
1276 (if (string-match tramp-ipv6-regexp host)
1278 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1280 tramp-postfix-host-format))
1281 (when localname localname)))
1283 (defun tramp-get-buffer (vec)
1284 "Get the connection buffer to be used for VEC."
1285 (or (get-buffer (tramp-buffer-name vec))
1286 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1287 (setq buffer-undo-list t)
1288 (setq default-directory
1289 (tramp-make-tramp-file-name
1290 (tramp-file-name-method vec)
1291 (tramp-file-name-user vec)
1292 (tramp-file-name-host vec)
1296 (defun tramp-get-connection-buffer (vec)
1297 "Get the connection buffer to be used for VEC.
1298 In case a second asynchronous communication has been started, it is different
1299 from `tramp-get-buffer'."
1300 (or (tramp-get-connection-property vec "process-buffer" nil)
1301 (tramp-get-buffer vec)))
1303 (defun tramp-get-connection-name (vec)
1304 "Get the connection name to be used for VEC.
1305 In case a second asynchronous communication has been started, it is different
1306 from the default one."
1307 (or (tramp-get-connection-property vec "process-name" nil)
1308 (tramp-buffer-name vec)))
1310 (defun tramp-get-connection-process (vec)
1311 "Get the connection process to be used for VEC.
1312 In case a second asynchronous communication has been started, it is different
1313 from the default one."
1314 (get-process (tramp-get-connection-name vec)))
1316 (defun tramp-debug-buffer-name (vec)
1317 "A name for the debug buffer for VEC."
1318 ;; We must use `tramp-file-name-real-host', because for gateway
1319 ;; methods the default port will be expanded later on, which would
1321 (let ((method (tramp-file-name-method vec))
1322 (user (tramp-file-name-user vec))
1323 (host (tramp-file-name-real-host vec)))
1324 (if (not (zerop (length user)))
1325 (format "*debug tramp/%s %s@%s*" method user host)
1326 (format "*debug tramp/%s %s*" method host))))
1328 (defconst tramp-debug-outline-regexp
1329 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1330 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1332 (defun tramp-debug-outline-level ()
1333 "Return the depth to which a statement is nested in the outline.
1334 Point must be at the beginning of a header line.
1336 The outline level is equal to the verbosity of the Tramp message."
1337 (1+ (string-to-number (match-string 1))))
1339 (defun tramp-get-debug-buffer (vec)
1340 "Get the debug buffer for VEC."
1341 (with-current-buffer
1342 (get-buffer-create (tramp-debug-buffer-name vec))
1344 (setq buffer-undo-list t)
1345 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1346 ;; `outline-mode-hook'. We must prevent that local processes
1347 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1348 ;; Furthermore, `outline-regexp' must have the correct value
1349 ;; already, because it is used by `font-lock-compile-keywords'.
1350 (let ((default-directory (tramp-compat-temporary-file-directory))
1351 (outline-regexp tramp-debug-outline-regexp))
1353 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1354 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1357 (defsubst tramp-debug-message (vec fmt-string &rest args)
1358 "Append message to debug buffer.
1359 Message is formatted with FMT-STRING as control string and the remaining
1360 ARGS to actually emit the message (if applicable)."
1361 (when (get-buffer (tramp-buffer-name vec))
1362 (with-current-buffer (tramp-get-debug-buffer vec)
1363 (goto-char (point-max))
1368 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1369 (if (featurep 'sxemacs) "SX" (if (featurep 'xemacs) "X" "GNU "))
1370 emacs-version tramp-version)))
1374 (let ((now (current-time)))
1375 (insert (format-time-string "%T." now))
1376 (insert (format "%06d " (nth 2 now))))
1377 ;; Calling Tramp function. We suppress compat and trace
1378 ;; functions from being displayed.
1379 (let ((btn 1) btf fn)
1381 (setq btf (nth 1 (backtrace-frame btn)))
1385 (setq fn (symbol-name btf))
1388 (string-match "^tramp" fn)
1394 '("tramp-compat-funcall"
1395 "tramp-compat-with-temp-message"
1396 "tramp-debug-message"
1398 "tramp-error-with-buffer"
1404 (setq btn (1+ btn))))
1405 ;; The following code inserts filename and line number.
1406 ;; Should be inactive by default, because it is time
1408 ; (let ((ffn (find-function-noselect (intern fn))))
1412 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1413 ; (with-current-buffer (car ffn)
1414 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1415 (insert (format "%s " fn)))
1417 (insert (apply 'format fmt-string args)))))
1419 (defvar tramp-message-show-message t
1420 "Show Tramp message in the minibuffer.
1421 This variable is used to disable messages from `tramp-error'.
1422 The messages are visible anyway, because an error is raised.")
1424 (defvar tramp-message-show-progress-reporter-message t
1425 "Show Tramp progress reporter message in the minibuffer.
1426 This variable is used to disable recursive progress reporter messages.")
1428 (defsubst tramp-message (vec-or-proc level fmt-string &rest args)
1429 "Emit a message depending on verbosity level.
1430 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1431 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1432 less than LEVEL. The message is emitted only if `tramp-verbose' is
1433 greater than or equal to LEVEL.
1435 The message is also logged into the debug buffer when `tramp-verbose'
1436 is greater than or equal 4.
1438 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1439 control string and the remaining ARGS to actually emit the message (if
1442 (when (<= level tramp-verbose)
1443 ;; Match data must be preserved!
1445 ;; Display only when there is a minimum level.
1446 (when (and tramp-message-show-message (<= level 3))
1452 ((= level 2) "Warning: ")
1456 ;; Log only when there is a minimum level.
1457 (when (>= tramp-verbose 4)
1458 (when (and vec-or-proc
1459 (processp vec-or-proc)
1460 (buffer-name (process-buffer vec-or-proc)))
1461 (with-current-buffer (process-buffer vec-or-proc)
1462 ;; Translate proc to vec.
1463 (setq vec-or-proc (tramp-dissect-file-name default-directory))))
1464 (when (and vec-or-proc (vectorp vec-or-proc))
1465 (apply 'tramp-debug-message
1467 (concat (format "(%d) # " level) fmt-string)
1470 (defsubst tramp-error (vec-or-proc signal fmt-string &rest args)
1472 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1473 signal identifier to be raised, remaining args passed to
1474 `tramp-message'. Finally, signal SIGNAL is raised."
1475 (let (tramp-message-show-message)
1478 (error-message-string
1480 (get signal 'error-message)
1481 (apply 'format fmt-string args))))
1482 (signal signal (list (apply 'format fmt-string args)))))
1484 (defsubst tramp-error-with-buffer
1485 (buffer vec-or-proc signal fmt-string &rest args)
1486 "Emit an error, and show BUFFER.
1487 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
1488 an input event arrives. The other arguments are passed to `tramp-error'."
1489 (save-window-excursion
1491 (apply 'tramp-error vec-or-proc signal fmt-string args)
1492 (when (and vec-or-proc
1493 tramp-message-show-message
1494 (not (zerop tramp-verbose))
1495 (not (tramp-completion-mode-p)))
1496 (let ((enable-recursive-minibuffers t))
1498 (or (and (bufferp buffer) buffer)
1499 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1500 (tramp-get-connection-buffer vec-or-proc)))
1501 (when (string-equal fmt-string "Process died")
1504 "Tramp failed to connect. If this happens repeatedly, try"
1505 "`M-x tramp-cleanup-this-connection'"))
1508 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1509 "Parse a Tramp filename and make components available in the body.
1511 First arg FILENAME is evaluated and dissected into its components.
1512 Second arg VAR is a symbol. It is used as a variable name to hold
1513 the filename structure. It is also used as a prefix for the variables
1514 holding the components. For example, if VAR is the symbol `foo', then
1515 `foo' will be bound to the whole structure, `foo-method' will be bound to
1516 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1519 Remaining args are Lisp expressions to be evaluated (inside an implicit
1522 If VAR is nil, then we bind `v' to the structure and `method', `user',
1523 `host', `localname', `hop' to the components."
1524 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1525 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
1526 (tramp-file-name-method ,(or var 'v)))
1527 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
1528 (tramp-file-name-user ,(or var 'v)))
1529 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
1530 (tramp-file-name-host ,(or var 'v)))
1531 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
1532 (tramp-file-name-localname ,(or var 'v)))
1533 (,(if var (intern (concat (symbol-name var) "-hop")) 'hop)
1534 (tramp-file-name-hop ,(or var 'v))))
1537 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1538 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1539 (tramp-compat-font-lock-add-keywords
1540 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1542 (defun tramp-progress-reporter-update (reporter &optional value)
1543 (let* ((parameters (cdr reporter))
1544 (message (aref parameters 3)))
1545 (when (string-match message (or (current-message) ""))
1546 (tramp-compat-funcall 'progress-reporter-update reporter value))))
1548 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1549 "Executes BODY, spinning a progress reporter with MESSAGE.
1550 If LEVEL does not fit for visible messages, or if this is a
1551 nested call of the macro, there are only traces without a visible
1553 (declare (indent 3) (debug t))
1555 (tramp-message ,vec ,level "%s..." ,message)
1556 ;; We start a pulsing progress reporter after 3 seconds. Feature
1557 ;; introduced in Emacs 24.1.
1558 (when (and tramp-message-show-progress-reporter-message
1559 tramp-message-show-message
1560 ;; Display only when there is a minimum level.
1561 (<= ,level (min tramp-verbose 3)))
1563 (setq pr (tramp-compat-funcall 'make-progress-reporter ,message)
1565 (run-at-time 3 0.1 'tramp-progress-reporter-update pr)))))
1567 ;; Execute the body. Suppress concurrent progress reporter
1569 (let ((tramp-message-show-progress-reporter-message
1570 (and tramp-message-show-progress-reporter-message (not tm))))
1572 ;; Stop progress reporter.
1573 (if tm (tramp-compat-funcall 'cancel-timer tm))
1574 (tramp-message ,vec ,level "%s...done" ,message))))
1576 (tramp-compat-font-lock-add-keywords
1577 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1579 (defmacro with-tramp-file-property (vec file property &rest body)
1580 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1581 FILE must be a local file name on a connection identified via VEC."
1582 `(if (file-name-absolute-p ,file)
1583 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1584 (when (eq value 'undef)
1585 ;; We cannot pass @body as parameter to
1586 ;; `tramp-set-file-property' because it mangles our
1588 (setq value (progn ,@body))
1589 (tramp-set-file-property ,vec ,file ,property value))
1593 (put 'with-tramp-file-property 'lisp-indent-function 3)
1594 (put 'with-tramp-file-property 'edebug-form-spec t)
1595 (tramp-compat-font-lock-add-keywords
1596 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1598 (defmacro with-tramp-connection-property (key property &rest body)
1599 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1600 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1601 (when (eq value 'undef)
1602 ;; We cannot pass ,@body as parameter to
1603 ;; `tramp-set-connection-property' because it mangles our debug
1605 (setq value (progn ,@body))
1606 (tramp-set-connection-property ,key ,property value))
1609 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1610 (put 'with-tramp-connection-property 'edebug-form-spec t)
1611 (tramp-compat-font-lock-add-keywords
1612 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1614 (defalias 'tramp-drop-volume-letter
1615 (if (memq system-type '(cygwin windows-nt))
1617 "Cut off unnecessary drive letter from file NAME.
1618 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1619 locally on a remote file name. When the local system is a W32 system
1620 but the remote system is Unix, this introduces a superfluous drive
1621 letter into the file name. This function removes it."
1623 (if (string-match "\\`[a-zA-Z]:/" name)
1624 (replace-match "/" nil t name)
1629 (if (featurep 'xemacs)
1630 (defalias 'tramp-drop-volume-letter 'identity))
1632 (defun tramp-cleanup (vec)
1633 "Cleanup connection VEC, but keep the debug buffer."
1634 (with-current-buffer (tramp-get-debug-buffer vec)
1635 ;; Keep the debug buffer.
1637 (generate-new-buffer-name tramp-temp-buffer-name) 'unique)
1638 (tramp-cleanup-connection vec)
1639 (if (= (point-min) (point-max))
1641 (rename-buffer (tramp-debug-buffer-name vec) 'unique))
1642 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
1643 (tramp-get-buffer vec)))
1645 ;;; Config Manipulation Functions:
1647 ;;;###tramp-autoload
1648 (defun tramp-set-completion-function (method function-list)
1649 "Sets the list of completion functions for METHOD.
1650 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1651 The FUNCTION is intended to parse FILE according its syntax.
1652 It might be a predefined FUNCTION, or a user defined FUNCTION.
1653 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1657 (tramp-set-completion-function
1659 '((tramp-parse-sconfig \"/etc/ssh_config\")
1660 (tramp-parse-sconfig \"~/.ssh/config\")))"
1662 (let ((r function-list)
1664 (setq tramp-completion-function-alist
1665 (delete (assoc method tramp-completion-function-alist)
1666 tramp-completion-function-alist))
1669 ;; Remove double entries.
1670 (when (member (car v) (cdr v))
1671 (setcdr v (delete (car v) (cdr v))))
1672 ;; Check for function and file or registry key.
1673 (unless (and (functionp (nth 0 (car v)))
1674 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1675 ;; Windows registry.
1676 (and (memq system-type '(cygwin windows-nt))
1678 (tramp-compat-call-process
1679 "reg" nil nil nil "query" (nth 1 (car v)))))
1680 ;; Configuration file.
1681 (file-exists-p (nth 1 (car v)))))
1682 (setq r (delete (car v) r)))
1686 (add-to-list 'tramp-completion-function-alist
1689 (defun tramp-get-completion-function (method)
1690 "Returns a list of completion functions for METHOD.
1691 For definition of that list see `tramp-set-completion-function'."
1693 ;; Hosts visited once shall be remembered.
1694 `(tramp-parse-connection-properties ,method)
1695 ;; The method related defaults.
1696 (cdr (assoc method tramp-completion-function-alist))))
1699 ;;; Fontification of `read-file-name':
1701 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1702 (defvar tramp-rfn-eshadow-overlay)
1703 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1705 (defun tramp-rfn-eshadow-setup-minibuffer ()
1706 "Set up a minibuffer for `file-name-shadow-mode'.
1707 Adds another overlay hiding filename parts according to Tramp's
1708 special handling of `substitute-in-file-name'."
1709 (when (symbol-value 'minibuffer-completing-file-name)
1710 (setq tramp-rfn-eshadow-overlay
1711 (tramp-compat-funcall
1713 (tramp-compat-funcall 'minibuffer-prompt-end)
1714 (tramp-compat-funcall 'minibuffer-prompt-end)))
1715 ;; Copy rfn-eshadow-overlay properties.
1716 (let ((props (tramp-compat-funcall
1717 'overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1719 ;; The `field' property prevents correct minibuffer
1720 ;; completion; we exclude it.
1721 (if (not (eq (car props) 'field))
1722 (tramp-compat-funcall
1723 'overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1724 (pop props) (pop props))))))
1726 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
1727 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1728 'tramp-rfn-eshadow-setup-minibuffer)
1729 (add-hook 'tramp-unload-hook
1731 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1732 'tramp-rfn-eshadow-setup-minibuffer))))
1734 (defconst tramp-rfn-eshadow-update-overlay-regexp
1735 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1737 (defun tramp-rfn-eshadow-update-overlay ()
1738 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1739 This is intended to be used as a minibuffer `post-command-hook' for
1740 `file-name-shadow-mode'; the minibuffer should have already
1741 been set up by `rfn-eshadow-setup-minibuffer'."
1742 ;; In remote files name, there is a shadowing just for the local part.
1744 (let ((end (or (tramp-compat-funcall
1745 'overlay-end (symbol-value 'rfn-eshadow-overlay))
1746 (tramp-compat-funcall 'minibuffer-prompt-end)))
1747 ;; We do not want to send any remote command.
1751 (tramp-compat-funcall
1752 'buffer-substring-no-properties end (point-max)))
1756 (1+ (or (string-match
1757 tramp-rfn-eshadow-update-overlay-regexp
1758 (buffer-string) end)
1761 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1762 (rfn-eshadow-update-overlay-hook nil)
1763 file-name-handler-alist)
1764 (tramp-compat-funcall
1765 'move-overlay rfn-eshadow-overlay (point-max) (point-max))
1766 (tramp-compat-funcall 'rfn-eshadow-update-overlay))))))))
1768 (when (boundp 'rfn-eshadow-update-overlay-hook)
1769 (add-hook 'rfn-eshadow-update-overlay-hook
1770 'tramp-rfn-eshadow-update-overlay)
1771 (add-hook 'tramp-unload-hook
1773 (remove-hook 'rfn-eshadow-update-overlay-hook
1774 'tramp-rfn-eshadow-update-overlay))))
1776 ;; Inodes don't exist for some file systems. Therefore we must
1777 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1778 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1779 ;; performance isn't the major issue given that file transfer will
1781 (defvar tramp-inodes 0
1782 "Keeps virtual inodes numbers.")
1784 ;; Devices must distinguish physical file systems. The device numbers
1785 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1786 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1787 ;; EFS use device number "-1". In order to be different, we use device number
1788 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1789 (defvar tramp-devices 0
1790 "Keeps virtual device numbers.")
1792 (defun tramp-default-file-modes (filename)
1793 "Return file modes of FILENAME as integer.
1794 If the file modes of FILENAME cannot be determined, return the
1795 value of `default-file-modes', without execute permissions."
1796 (or (file-modes filename)
1797 (logand (default-file-modes) (tramp-compat-octal-to-decimal "0666"))))
1799 (defun tramp-replace-environment-variables (filename)
1800 "Replace environment variables in FILENAME.
1801 Return the string with the replaced variables."
1803 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1804 ;; We need an own implementation.
1806 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1807 ;; `$' is coded as `$$'.
1809 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1810 (getenv (match-string 1 filename)))
1813 (substitute-in-file-name (match-string 0 filename))
1817 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
1818 ;; which calls corresponding functions (see minibuf.el).
1819 (when (fboundp 'minibuffer-electric-separator)
1824 (around ,(intern (format "tramp-advice-%s" x)) activate)
1825 "Invoke `substitute-in-file-name' for Tramp files."
1826 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
1827 (tramp-tramp-file-p (buffer-substring)))
1828 ;; We don't need to handle `last-input-event', because
1829 ;; due to the key map we know it must be ?/ or ?~.
1830 (let ((s (concat (buffer-substring (point-min) (point))
1831 (string last-command-char))))
1832 (delete-region (point-min) (point))
1833 (insert (substitute-in-file-name s))
1834 (setq ad-return-value last-command-char))
1840 (ad-remove-advice ',x 'around ',(intern (format "tramp-advice-%s" x)))
1841 (ad-activate ',x)))))
1843 '(minibuffer-electric-separator
1844 minibuffer-electric-tilde)))
1846 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1847 "Like `find-operation-coding-system' for Tramp filenames.
1848 Tramp's `insert-file-contents' and `write-region' work over
1849 temporary file names. If `file-coding-system-alist' contains an
1850 expression, which matches more than the file name suffix, the
1851 coding system might not be determined. This function repairs it."
1853 (dolist (elt file-coding-system-alist result)
1854 (when (and (consp elt) (string-match (car elt) filename))
1855 ;; We found a matching entry in `file-coding-system-alist'.
1856 ;; So we add a similar entry, but with the temporary file name
1859 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1862 (progn (defun tramp-run-real-handler (operation args)
1863 "Invoke normal file name handler for OPERATION.
1864 First arg specifies the OPERATION, second arg is a list of arguments to
1865 pass to the OPERATION."
1866 (let* ((inhibit-file-name-handlers
1867 `(tramp-file-name-handler
1868 tramp-vc-file-name-handler
1869 tramp-completion-file-name-handler
1870 cygwin-mount-name-hook-function
1871 cygwin-mount-map-drive-hook-function
1873 ,(and (eq inhibit-file-name-operation operation)
1874 inhibit-file-name-handlers)))
1875 (inhibit-file-name-operation operation))
1876 (apply operation args))))
1879 (progn (defun tramp-completion-run-real-handler (operation args)
1880 "Invoke `tramp-file-name-handler' for OPERATION.
1881 First arg specifies the OPERATION, second arg is a list of arguments to
1882 pass to the OPERATION."
1883 (let* ((inhibit-file-name-handlers
1884 `(tramp-completion-file-name-handler
1885 cygwin-mount-name-hook-function
1886 cygwin-mount-map-drive-hook-function
1888 ,(and (eq inhibit-file-name-operation operation)
1889 inhibit-file-name-handlers)))
1890 (inhibit-file-name-operation operation))
1891 (apply operation args))))
1893 ;; We handle here all file primitives. Most of them have the file
1894 ;; name as first parameter; nevertheless we check for them explicitly
1895 ;; in order to be signaled if a new primitive appears. This
1896 ;; scenario is needed because there isn't a way to decide by
1897 ;; syntactical means whether a foreign method must be called. It would
1898 ;; ease the life if `file-name-handler-alist' would support a decision
1899 ;; function as well but regexp only.
1900 (defun tramp-file-name-for-operation (operation &rest args)
1901 "Return file name related to OPERATION file primitive.
1902 ARGS are the arguments OPERATION has been called with."
1904 ;; FILE resp DIRECTORY.
1906 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
1907 'delete-file 'diff-latest-backup-file 'directory-file-name
1908 'directory-files 'directory-files-and-attributes
1909 'dired-compress-file 'dired-uncache
1910 'file-accessible-directory-p 'file-attributes
1911 'file-directory-p 'file-executable-p 'file-exists-p
1912 'file-local-copy 'file-remote-p 'file-modes
1913 'file-name-as-directory 'file-name-directory
1914 'file-name-nondirectory 'file-name-sans-versions
1915 'file-ownership-preserved-p 'file-readable-p
1916 'file-regular-p 'file-symlink-p 'file-truename
1917 'file-writable-p 'find-backup-file-name 'find-file-noselect
1918 'get-file-buffer 'insert-directory 'insert-file-contents
1919 'load 'make-directory 'make-directory-internal
1920 'set-file-modes 'substitute-in-file-name
1921 'unhandled-file-name-directory 'vc-registered
1925 'file-acl 'file-selinux-context
1926 'set-file-acl 'set-file-selinux-context
1928 'abbreviate-file-name 'create-file-buffer
1929 'dired-file-modtime 'dired-make-compressed-filename
1930 'dired-recursive-delete-directory 'dired-set-file-modtime
1931 'dired-shell-unhandle-file-name 'dired-uucode-file
1932 'insert-file-contents-literally 'make-temp-name 'recover-file
1933 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
1934 (if (file-name-absolute-p (nth 0 args))
1936 (expand-file-name (nth 0 args))))
1937 ;; FILE DIRECTORY resp FILE1 FILE2.
1939 (list 'add-name-to-file 'copy-file 'expand-file-name
1940 'file-name-all-completions 'file-name-completion
1941 'file-newer-than-file-p 'make-symbolic-link 'rename-file
1945 'file-in-directory-p 'file-equal-p
1947 'dired-make-relative-symlink
1948 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
1951 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
1952 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
1953 (t (buffer-file-name (current-buffer))))))
1955 ((eq operation 'write-region)
1959 (list 'set-visited-file-modtime 'verify-visited-file-modtime
1961 'make-auto-save-file-name
1965 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1968 (list ;; not in Emacs 23+.
1977 'dired-print-file 'dired-shell-call-process))
1979 ;; Unknown file primitive.
1980 (t (error "unknown file I/O primitive: %s" operation))))
1982 (defun tramp-find-foreign-file-name-handler (filename)
1983 "Return foreign file name handler if exists."
1984 (when (tramp-tramp-file-p filename)
1985 (let ((v (tramp-dissect-file-name filename t))
1986 (handler tramp-foreign-file-name-handler-alist)
1988 ;; When we are not fully sure that filename completion is safe,
1989 ;; we should not return a handler.
1990 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
1991 (and (tramp-file-name-host v)
1992 (not (member (tramp-file-name-host v)
1993 (mapcar 'car tramp-methods))))
1994 (not (tramp-completion-mode-p)))
1996 (setq elt (car handler)
1997 handler (cdr handler))
1998 (when (funcall (car elt) filename)
2005 (defun tramp-file-name-handler (operation &rest args)
2006 "Invoke Tramp file name handler.
2007 Falls back to normal file name handler if no Tramp file name handler exists."
2011 (tramp-replace-environment-variables
2012 (apply 'tramp-file-name-for-operation operation args)))
2013 (completion (tramp-completion-mode-p))
2014 (foreign (tramp-find-foreign-file-name-handler filename)))
2015 (with-parsed-tramp-file-name filename nil
2016 ;; Call the backend function.
2018 (tramp-compat-condition-case-unless-debug err
2019 (let ((sf (symbol-function foreign))
2021 ;; Some packages set the default directory to a
2022 ;; remote path, before respective Tramp packages
2023 ;; are already loaded. This results in
2024 ;; recursive loading. Therefore, we load the
2025 ;; Tramp packages locally.
2026 (when (and (listp sf) (eq (car sf) 'autoload))
2027 (let ((default-directory
2028 (tramp-compat-temporary-file-directory)))
2029 (load (cadr sf) 'noerror 'nomessage)))
2030 ;; If `non-essential' is non-nil, Tramp shall
2031 ;; not open a new connection.
2032 ;; If Tramp detects that it shouldn't continue
2033 ;; to work, it throws the `suppress' event.
2034 ;; This could happen for example, when Tramp
2035 ;; tries to open the same connection twice in a
2036 ;; short time frame.
2037 ;; In both cases, we try the default handler then.
2039 (catch 'non-essential
2041 (apply foreign operation args))))
2043 ((eq result 'non-essential)
2045 v 5 "Non-essential received in operation %s"
2046 (append (list operation) args))
2047 (tramp-run-real-handler operation args))
2048 ((eq result 'suppress)
2049 (let (tramp-message-show-message)
2051 v 1 "Suppress received in operation %s"
2052 (append (list operation) args))
2054 (tramp-run-real-handler operation args)))
2057 ;; Trace that somebody has interrupted the operation.
2059 (let (tramp-message-show-message)
2061 v 1 "Interrupt received in operation %s"
2062 (append (list operation) args)))
2063 ;; Propagate the quit signal.
2064 (signal (car err) (cdr err)))
2066 ;; When we are in completion mode, some failed
2067 ;; operations shall return at least a default value
2068 ;; in order to give the user a chance to correct the
2069 ;; file name in the minibuffer.
2070 ;; In order to get a full backtrace, one could apply
2071 ;; (setq debug-on-error t debug-on-signal t)
2074 ((and completion (zerop (length localname))
2075 (memq operation '(file-exists-p file-directory-p)))
2077 ((and completion (zerop (length localname))
2079 '(expand-file-name file-name-as-directory)))
2081 ;; Propagate the error.
2082 (t (signal (car err) (cdr err))))))
2084 ;; Nothing to do for us.
2085 (tramp-run-real-handler operation args)))))
2087 ;; When `tramp-mode' is not enabled, we don't do anything.
2088 (tramp-run-real-handler operation args)))
2090 ;; In Emacs, there is some concurrency due to timers. If a timer
2091 ;; interrupts Tramp and wishes to use the same connection buffer as
2092 ;; the "main" Emacs, then garbage might occur in the connection
2093 ;; buffer. Therefore, we need to make sure that a timer does not use
2094 ;; the same connection buffer as the "main" Emacs. We implement a
2095 ;; cheap global lock, instead of locking each connection buffer
2096 ;; separately. The global lock is based on two variables,
2097 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2098 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2099 ;; processing of a single file operation, so we need to allow
2100 ;; recursive calls. That's where the `tramp-locker' variable comes in
2101 ;; -- it is let-bound to t during the execution of the current
2102 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2103 ;; then we should just proceed because we have been called
2104 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2105 ;; interrupting the "main" Emacs, and then we signal an error.
2107 (defvar tramp-locked nil
2108 "If non-nil, then Tramp is currently busy.
2109 Together with `tramp-locker', this implements a locking mechanism
2110 preventing reentrant calls of Tramp.")
2112 (defvar tramp-locker nil
2113 "If non-nil, then a caller has locked Tramp.
2114 Together with `tramp-locked', this implements a locking mechanism
2115 preventing reentrant calls of Tramp.")
2118 (progn (defun tramp-completion-file-name-handler (operation &rest args)
2119 "Invoke Tramp file name completion handler.
2120 Falls back to normal file name handler if no Tramp file name handler exists."
2121 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
2122 ;; would otherwise use backslash.
2123 (let ((directory-sep-char ?/)
2124 (fn (assoc operation tramp-completion-file-name-handler-alist)))
2126 ;; When `tramp-mode' is not enabled, we don't do anything.
2128 ;; For other syntaxes than `sep', the regexp matches many common
2129 ;; situations where the user doesn't actually want to use Tramp.
2130 ;; So to avoid autoloading Tramp after typing just "/s", we
2131 ;; disable this part of the completion, unless the user implicitly
2132 ;; indicated his interest in using a fancier completion system.
2133 (or (eq tramp-syntax 'sep)
2134 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2135 ;; `partial-completion-mode' does not exist in XEmacs.
2136 ;; It is obsoleted with Emacs 24.1.
2137 (and (boundp 'partial-completion-mode)
2138 (symbol-value 'partial-completion-mode))
2139 ;; FIXME: These may have been loaded even if the user never
2140 ;; intended to use them.
2142 (featurep 'icicles)))
2143 (save-match-data (apply (cdr fn) args))
2144 (tramp-completion-run-real-handler operation args)))))
2147 (progn (defun tramp-register-file-name-handlers ()
2148 "Add Tramp file name handlers to `file-name-handler-alist'."
2149 ;; Remove autoloaded handlers from file name handler alist. Useful,
2150 ;; if `tramp-syntax' has been changed.
2151 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
2152 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
2154 'tramp-completion-file-name-handler file-name-handler-alist)))
2155 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
2156 ;; Add the handlers.
2157 (add-to-list 'file-name-handler-alist
2158 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2159 (put 'tramp-file-name-handler 'safe-magic t)
2160 (add-to-list 'file-name-handler-alist
2161 (cons tramp-completion-file-name-regexp
2162 'tramp-completion-file-name-handler))
2163 (put 'tramp-completion-file-name-handler 'safe-magic t)
2164 ;; If jka-compr or epa-file are already loaded, move them to the
2165 ;; front of `file-name-handler-alist'.
2166 (dolist (fnh '(epa-file-handler jka-compr-handler))
2167 (let ((entry (rassoc fnh file-name-handler-alist)))
2169 (setq file-name-handler-alist
2170 (cons entry (delete entry file-name-handler-alist))))))))
2172 ;; `tramp-file-name-handler' must be registered before evaluation of
2173 ;; site-start and init files, because there might exist remote files
2174 ;; already, f.e. files kept via recentf-mode.
2176 (tramp-register-file-name-handlers)
2178 (defun tramp-exists-file-name-handler (operation &rest args)
2179 "Check, whether OPERATION runs a file name handler."
2180 ;; The file name handler is determined on base of either an
2181 ;; argument, `buffer-file-name', or `default-directory'.
2183 (let* ((buffer-file-name "/")
2184 (default-directory "/")
2185 (fnha file-name-handler-alist)
2186 (check-file-name-operation operation)
2187 (file-name-handler-alist
2190 (lambda (operation &rest args)
2191 "Returns OPERATION if it is the one to be checked."
2192 (if (equal check-file-name-operation operation)
2194 (let ((file-name-handler-alist fnha))
2195 (apply operation args))))))))
2196 (equal (apply operation args) operation))))
2199 (defun tramp-unload-file-name-handlers ()
2200 (setq file-name-handler-alist
2201 (delete (rassoc 'tramp-file-name-handler
2202 file-name-handler-alist)
2203 (delete (rassoc 'tramp-completion-file-name-handler
2204 file-name-handler-alist)
2205 file-name-handler-alist))))
2207 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2209 ;;; File name handler functions for completion mode:
2211 (defvar tramp-completion-mode nil
2212 "If non-nil, external packages signal that they are in file name completion.
2214 This is necessary, because Tramp uses a heuristic depending on last
2215 input event. This fails when external packages use other characters
2216 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2217 should never be set globally, the intention is to let-bind it.")
2219 ;; Necessary because `tramp-file-name-regexp-unified' and
2220 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2221 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2222 ;; to `tramp-file-name-handler'). Otherwise, it takes
2223 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2224 ;; risky, because completing a file might require loading other files,
2225 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2226 ;; variable. On the other hand, those files shouldn't have partial
2227 ;; Tramp file name syntax. Maybe another variable should be introduced
2228 ;; overwriting this check in such cases. Or we change Tramp file name
2229 ;; syntax in order to avoid ambiguities, like in XEmacs ...
2230 ;;;###tramp-autoload
2231 (defun tramp-completion-mode-p ()
2232 "Check, whether method / user name / host name completion is active."
2234 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2235 (and (boundp 'non-essential) (symbol-value 'non-essential))
2236 tramp-completion-mode
2238 (equal last-input-event 'tab)
2239 (and (natnump last-input-event)
2241 ;; ?\t has event-modifier 'control.
2242 (equal last-input-event ?\t)
2243 (and (not (event-modifiers last-input-event))
2244 (or (equal last-input-event ?\?)
2245 (equal last-input-event ?\ )))))
2247 (and (featurep 'xemacs)
2248 ;; `last-input-event' might be nil.
2249 (not (null last-input-event))
2250 ;; `last-input-event' may have no character approximation.
2251 (tramp-compat-funcall 'event-to-character last-input-event)
2253 ;; ?\t has event-modifier 'control.
2255 (tramp-compat-funcall 'event-to-character last-input-event) ?\t)
2256 (and (not (event-modifiers last-input-event))
2258 (tramp-compat-funcall 'event-to-character last-input-event)
2261 (tramp-compat-funcall 'event-to-character last-input-event)
2264 (defun tramp-connectable-p (filename)
2265 "Check, whether it is possible to connect the remote host w/o side-effects.
2266 This is true, if either the remote host is already connected, or if we are
2267 not in completion mode."
2268 (and (tramp-tramp-file-p filename)
2269 (with-parsed-tramp-file-name filename nil
2270 (or (not (tramp-completion-mode-p))
2271 (let ((p (tramp-get-connection-process v)))
2272 (and p (processp p) (memq (process-status p) '(run open))))))))
2274 ;; Method, host name and user name completion.
2275 ;; `tramp-completion-dissect-file-name' returns a list of
2276 ;; tramp-file-name structures. For all of them we return possible completions.
2278 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2279 "Like `file-name-all-completions' for partial Tramp files."
2282 (tramp-drop-volume-letter (expand-file-name filename directory)))
2285 ;; Suppress hop from completion.
2289 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2290 tramp-postfix-hop-regexp
2293 (setq hop (match-string 1 fullname)
2294 fullname (replace-match "" nil nil fullname 1)))
2296 ;; Possible completion structures.
2297 (dolist (elt (tramp-completion-dissect-file-name fullname))
2298 (let* ((method (tramp-file-name-method elt))
2299 (user (tramp-file-name-user elt))
2300 (host (tramp-file-name-host elt))
2301 (localname (tramp-file-name-localname elt))
2302 (m (tramp-find-method method user host))
2303 (tramp-current-user user) ; see `tramp-parse-passwd'
2306 (unless localname ;; Nothing to complete.
2310 ;; Method dependent user / host combinations.
2314 (setq all-user-hosts
2315 (append all-user-hosts
2316 (funcall (nth 0 x) (nth 1 x)))))
2317 (tramp-get-completion-function m))
2323 (tramp-get-completion-user-host
2324 method user host (nth 0 x) (nth 1 x)))
2325 (delq nil all-user-hosts)))))
2327 ;; Possible methods.
2329 (append result (tramp-get-completion-methods m)))))))
2331 ;; Unify list, add hop, remove nil elements.
2332 (dolist (elt result)
2334 (string-match tramp-prefix-regexp elt)
2335 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2338 (substring elt (length (tramp-drop-volume-letter directory))))))
2340 ;; Complete local parts.
2344 (apply (if (tramp-connectable-p fullname)
2345 'tramp-completion-run-real-handler
2346 'tramp-run-real-handler)
2347 'file-name-all-completions (list (list filename directory)))))))
2349 ;; Method, host name and user name completion for a file.
2351 (defun tramp-completion-handle-file-name-completion
2352 (filename directory &optional predicate)
2353 "Like `file-name-completion' for Tramp files."
2356 (mapcar 'list (file-name-all-completions filename directory))
2357 (when (and predicate
2358 (tramp-connectable-p (expand-file-name filename directory)))
2359 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2361 ;; I misuse a little bit the tramp-file-name structure in order to handle
2362 ;; completion possibilities for partial methods / user names / host names.
2363 ;; Return value is a list of tramp-file-name structures according to possible
2364 ;; completions. If "localname" is non-nil it means there
2365 ;; shouldn't be a completion anymore.
2367 ;; Expected results:
2369 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2370 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2371 ;; [nil "x" nil nil]
2372 ;; ["x" nil nil nil]
2374 ;; "/x:" "/x:y" "/x:y:"
2375 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2377 ;; ["x" nil "" nil] ["x" nil "y" nil]
2378 ;; ["x" "" nil nil] ["x" "y" nil nil]
2380 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2381 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2382 ;; "/[x/y@" "/[x/y@z"
2383 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2384 (defun tramp-completion-dissect-file-name (name)
2385 "Returns a list of `tramp-file-name' structures.
2386 They are collected by `tramp-completion-dissect-file-name1'."
2390 (tramp-completion-ipv6-regexp
2393 (if (zerop (length tramp-postfix-ipv6-format))
2394 tramp-postfix-host-format
2395 tramp-postfix-ipv6-format)))
2396 ;; "/method" "/[method"
2397 (tramp-completion-file-name-structure1
2398 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2401 (tramp-completion-file-name-structure2
2402 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2405 (tramp-completion-file-name-structure3
2406 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2408 ;; "/[ipv6" "/[ipv6"
2409 (tramp-completion-file-name-structure4
2410 (list (concat tramp-prefix-regexp
2411 tramp-prefix-ipv6-regexp
2412 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2414 ;; "/user@host" "/[user@host"
2415 (tramp-completion-file-name-structure5
2416 (list (concat tramp-prefix-regexp
2417 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2418 "\\(" tramp-host-regexp x-nil "\\)$")
2420 ;; "/user@[ipv6" "/[user@ipv6"
2421 (tramp-completion-file-name-structure6
2422 (list (concat tramp-prefix-regexp
2423 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2424 tramp-prefix-ipv6-regexp
2425 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2427 ;; "/method:user" "/[method/user" "/method://user"
2428 (tramp-completion-file-name-structure7
2429 (list (concat tramp-prefix-regexp
2430 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2431 "\\(" tramp-user-regexp x-nil "\\)$")
2433 ;; "/method:host" "/[method/host" "/method://host"
2434 (tramp-completion-file-name-structure8
2435 (list (concat tramp-prefix-regexp
2436 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2437 "\\(" tramp-host-regexp x-nil "\\)$")
2439 ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6"
2440 (tramp-completion-file-name-structure9
2441 (list (concat tramp-prefix-regexp
2442 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2443 tramp-prefix-ipv6-regexp
2444 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2446 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
2447 (tramp-completion-file-name-structure10
2448 (list (concat tramp-prefix-regexp
2449 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2450 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2451 "\\(" tramp-host-regexp x-nil "\\)$")
2453 ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6"
2454 (tramp-completion-file-name-structure11
2455 (list (concat tramp-prefix-regexp
2456 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2457 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2458 tramp-prefix-ipv6-regexp
2459 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2461 ;; "/method: "/method:/"
2462 (tramp-completion-file-name-structure12
2464 (if (equal tramp-syntax 'url)
2465 (concat tramp-prefix-regexp
2466 "\\(" tramp-method-regexp "\\)"
2467 "\\(" (substring tramp-postfix-method-regexp 0 1)
2468 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
2470 ;; Should not match if not URL syntax.
2471 (concat tramp-prefix-regexp "/$"))
2473 ;; "/method: "/method:/"
2474 (tramp-completion-file-name-structure13
2476 (if (equal tramp-syntax 'url)
2477 (concat tramp-prefix-regexp
2478 "\\(" tramp-method-regexp "\\)"
2479 "\\(" (substring tramp-postfix-method-regexp 0 1)
2480 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
2482 ;; Should not match if not URL syntax.
2483 (concat tramp-prefix-regexp "/$"))
2486 (mapc (lambda (structure)
2487 (add-to-list 'result
2488 (tramp-completion-dissect-file-name1 structure name)))
2490 tramp-completion-file-name-structure1
2491 tramp-completion-file-name-structure2
2492 tramp-completion-file-name-structure3
2493 tramp-completion-file-name-structure4
2494 tramp-completion-file-name-structure5
2495 tramp-completion-file-name-structure6
2496 tramp-completion-file-name-structure7
2497 tramp-completion-file-name-structure8
2498 tramp-completion-file-name-structure9
2499 tramp-completion-file-name-structure10
2500 tramp-completion-file-name-structure11
2501 tramp-completion-file-name-structure12
2502 tramp-completion-file-name-structure13
2503 tramp-file-name-structure))
2507 (defun tramp-completion-dissect-file-name1 (structure name)
2508 "Returns a `tramp-file-name' structure matching STRUCTURE.
2509 The structure consists of remote method, remote user,
2510 remote host and localname (filename on remote host)."
2513 (when (string-match (nth 0 structure) name)
2514 (let ((method (and (nth 1 structure)
2515 (match-string (nth 1 structure) name)))
2516 (user (and (nth 2 structure)
2517 (match-string (nth 2 structure) name)))
2518 (host (and (nth 3 structure)
2519 (match-string (nth 3 structure) name)))
2520 (localname (and (nth 4 structure)
2521 (match-string (nth 4 structure) name))))
2522 (vector method user host localname nil)))))
2524 ;; This function returns all possible method completions, adding the
2525 ;; trailing method delimiter.
2526 (defun tramp-get-completion-methods (partial-method)
2527 "Returns all method completions for PARTIAL-METHOD."
2531 (string-match (concat "^" (regexp-quote partial-method)) method)
2532 (tramp-completion-make-tramp-file-name method nil nil nil)))
2533 (mapcar 'car tramp-methods)))
2535 ;; Compares partial user and host names with possible completions.
2536 (defun tramp-get-completion-user-host
2537 (method partial-user partial-host user host)
2538 "Returns the most expanded string for user and host name completion.
2539 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2542 ((and partial-user partial-host)
2544 (string-match (concat "^" (regexp-quote partial-host)) host)
2545 (string-equal partial-user (or user partial-user)))
2546 (setq user partial-user)
2553 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2559 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2565 (unless (zerop (+ (length user) (length host)))
2566 (tramp-completion-make-tramp-file-name method user host nil)))
2568 ;; Generic function.
2569 (defun tramp-parse-group (regexp match-level skip-regexp)
2570 "Return a (user host) tuple allowed to access.
2571 User is always nil."
2573 (when (re-search-forward regexp (point-at-eol) t)
2574 (setq result (list nil (match-string match-level))))
2576 (> (skip-chars-forward skip-regexp) 0)
2580 ;; Generic function.
2581 (defun tramp-parse-file (filename function)
2582 "Return a list of (user host) tuples allowed to access.
2583 User is always nil."
2584 ;; On Windows, there are problems in completion when
2585 ;; `default-directory' is remote.
2586 (let ((default-directory (tramp-compat-temporary-file-directory)))
2587 (when (file-readable-p filename)
2589 (insert-file-contents filename)
2590 (goto-char (point-min))
2591 (loop while (not (eobp)) collect (funcall function))))))
2593 ;;;###tramp-autoload
2594 (defun tramp-parse-rhosts (filename)
2595 "Return a list of (user host) tuples allowed to access.
2596 Either user or host may be nil."
2597 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2599 (defun tramp-parse-rhosts-group ()
2600 "Return a (user host) tuple allowed to access.
2601 Either user or host may be nil."
2605 "^\\(" tramp-host-regexp "\\)"
2606 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2607 (when (re-search-forward regexp (point-at-eol) t)
2608 (setq result (append (list (match-string 3) (match-string 1)))))
2612 ;;;###tramp-autoload
2613 (defun tramp-parse-shosts (filename)
2614 "Return a list of (user host) tuples allowed to access.
2615 User is always nil."
2616 (tramp-parse-file filename 'tramp-parse-shosts-group))
2618 (defun tramp-parse-shosts-group ()
2619 "Return a (user host) tuple allowed to access.
2620 User is always nil."
2621 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2623 ;;;###tramp-autoload
2624 (defun tramp-parse-sconfig (filename)
2625 "Return a list of (user host) tuples allowed to access.
2626 User is always nil."
2627 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2629 (defun tramp-parse-sconfig-group ()
2630 "Return a (user host) tuple allowed to access.
2631 User is always nil."
2633 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2635 ;; Generic function.
2636 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2637 "Return a list of (user host) tuples allowed to access.
2638 User is always nil."
2639 ;; On Windows, there are problems in completion when
2640 ;; `default-directory' is remote.
2641 (let* ((default-directory (tramp-compat-temporary-file-directory))
2642 (files (and (file-directory-p dirname) (directory-files dirname))))
2643 (loop for f in files
2644 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2645 collect (list nil (match-string 1 f)))))
2647 ;;;###tramp-autoload
2648 (defun tramp-parse-shostkeys (dirname)
2649 "Return a list of (user host) tuples allowed to access.
2650 User is always nil."
2651 (tramp-parse-shostkeys-sknownhosts
2652 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2654 ;;;###tramp-autoload
2655 (defun tramp-parse-sknownhosts (dirname)
2656 "Return a list of (user host) tuples allowed to access.
2657 User is always nil."
2658 (tramp-parse-shostkeys-sknownhosts
2660 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2662 ;;;###tramp-autoload
2663 (defun tramp-parse-hosts (filename)
2664 "Return a list of (user host) tuples allowed to access.
2665 User is always nil."
2666 (tramp-parse-file filename 'tramp-parse-hosts-group))
2668 (defun tramp-parse-hosts-group ()
2669 "Return a (user host) tuple allowed to access.
2670 User is always nil."
2672 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2674 ;; For su-alike methods it would be desirable to return "root@localhost"
2675 ;; as default. Unfortunately, we have no information whether any user name
2676 ;; has been typed already. So we use `tramp-current-user' as indication,
2677 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
2678 ;;;###tramp-autoload
2679 (defun tramp-parse-passwd (filename)
2680 "Return a list of (user host) tuples allowed to access.
2681 Host is always \"localhost\"."
2682 (if (zerop (length tramp-current-user))
2684 (tramp-parse-file filename 'tramp-parse-passwd-group)))
2686 (defun tramp-parse-passwd-group ()
2687 "Return a (user host) tuple allowed to access.
2688 Host is always \"localhost\"."
2690 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2691 (when (re-search-forward regexp (point-at-eol) t)
2692 (setq result (list (match-string 1) "localhost")))
2696 ;;;###tramp-autoload
2697 (defun tramp-parse-netrc (filename)
2698 "Return a list of (user host) tuples allowed to access.
2700 (tramp-parse-file filename 'tramp-parse-netrc-group))
2702 (defun tramp-parse-netrc-group ()
2703 "Return a (user host) tuple allowed to access.
2708 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2709 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2710 (when (re-search-forward regexp (point-at-eol) t)
2711 (setq result (list (match-string 3) (match-string 1))))
2715 ;;;###tramp-autoload
2716 (defun tramp-parse-putty (registry-or-dirname)
2717 "Return a list of (user host) tuples allowed to access.
2718 User is always nil."
2719 (if (memq system-type '(windows-nt))
2721 (when (zerop (tramp-compat-call-process
2722 "reg" nil t nil "query" registry-or-dirname))
2723 (goto-char (point-min))
2724 (loop while (not (eobp)) collect
2725 (tramp-parse-putty-group registry-or-dirname))))
2727 (tramp-parse-shostkeys-sknownhosts
2728 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2730 (defun tramp-parse-putty-group (registry)
2731 "Return a (user host) tuple allowed to access.
2732 User is always nil."
2734 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2735 (when (re-search-forward regexp (point-at-eol) t)
2736 (setq result (list nil (match-string 1))))
2740 ;;; Common file name handler functions for different backends:
2742 (defvar tramp-handle-file-local-copy-hook nil
2743 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2745 (defvar tramp-handle-write-region-hook nil
2746 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2748 (defun tramp-handle-directory-file-name (directory)
2749 "Like `directory-file-name' for Tramp files."
2750 ;; If localname component of filename is "/", leave it unchanged.
2751 ;; Otherwise, remove any trailing slash from localname component.
2752 ;; Method, host, etc, are unchanged. Does it make sense to try
2753 ;; to avoid parsing the filename?
2754 (with-parsed-tramp-file-name directory nil
2755 (if (and (not (zerop (length localname)))
2756 (eq (aref localname (1- (length localname))) ?/)
2757 (not (string= localname "/")))
2758 (substring directory 0 -1)
2761 (defun tramp-handle-directory-files
2762 (directory &optional full match nosort files-only)
2763 "Like `directory-files' for Tramp files."
2764 ;; FILES-ONLY is valid for XEmacs only.
2765 (when (file-directory-p directory)
2766 (setq directory (file-name-as-directory (expand-file-name directory)))
2767 (let ((temp (nreverse (file-name-all-completions "" directory)))
2771 (setq item (directory-file-name (pop temp)))
2772 (when (and (or (null match) (string-match match item))
2773 (or (null files-only)
2775 (and (equal files-only t) (file-regular-p item))
2776 ;; Directories only.
2777 (file-directory-p item)))
2778 (push (if full (concat directory item) item)
2780 (if nosort result (sort result 'string<)))))
2782 (defun tramp-handle-directory-files-and-attributes
2783 (directory &optional full match nosort id-format)
2784 "Like `directory-files-and-attributes' for Tramp files."
2787 (cons x (tramp-compat-file-attributes
2788 (if full x (expand-file-name x directory)) id-format)))
2789 (directory-files directory full match nosort)))
2791 (defun tramp-handle-dired-uncache (dir &optional dir-p)
2792 "Like `dired-uncache' for Tramp files."
2793 ;; DIR-P is valid for XEmacs only.
2794 (with-parsed-tramp-file-name
2795 (if (or dir-p (file-directory-p dir)) dir (file-name-directory dir)) nil
2796 (tramp-flush-directory-property v localname)))
2798 (defun tramp-handle-file-accessible-directory-p (filename)
2799 "Like `file-accessible-directory-p' for Tramp files."
2800 (and (file-directory-p filename)
2801 (file-executable-p filename)))
2803 (defun tramp-handle-file-exists-p (filename)
2804 "Like `file-exists-p' for Tramp files."
2805 (not (null (file-attributes filename))))
2807 (defun tramp-handle-file-modes (filename)
2808 "Like `file-modes' for Tramp files."
2809 (let ((truename (or (file-truename filename) filename)))
2810 (when (file-exists-p truename)
2811 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2813 ;; Localname manipulation functions that grok Tramp localnames...
2814 (defun tramp-handle-file-name-as-directory (file)
2815 "Like `file-name-as-directory' but aware of Tramp files."
2816 ;; `file-name-as-directory' would be sufficient except localname is
2817 ;; the empty string.
2818 (let ((v (tramp-dissect-file-name file t)))
2819 ;; Run the command on the localname portion only.
2820 (tramp-make-tramp-file-name
2821 (tramp-file-name-method v)
2822 (tramp-file-name-user v)
2823 (tramp-file-name-host v)
2824 (tramp-run-real-handler
2825 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))))
2827 (defun tramp-handle-file-name-completion
2828 (filename directory &optional predicate)
2829 "Like `file-name-completion' for Tramp files."
2830 (unless (tramp-tramp-file-p directory)
2832 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2836 (mapcar 'list (file-name-all-completions filename directory))
2838 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2840 (defun tramp-handle-file-name-directory (file)
2841 "Like `file-name-directory' but aware of Tramp files."
2842 ;; Everything except the last filename thing is the directory. We
2843 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2844 ;; the remote file name parts. This is a problem when we are in
2845 ;; file name completion.
2846 (let ((v (tramp-dissect-file-name file t)))
2847 ;; Run the command on the localname portion only.
2848 (tramp-make-tramp-file-name
2849 (tramp-file-name-method v)
2850 (tramp-file-name-user v)
2851 (tramp-file-name-host v)
2852 (tramp-run-real-handler
2853 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2855 (defun tramp-handle-file-name-nondirectory (file)
2856 "Like `file-name-nondirectory' but aware of Tramp files."
2857 (with-parsed-tramp-file-name file nil
2858 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2860 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2861 "Like `file-newer-than-file-p' for Tramp files."
2863 ((not (file-exists-p file1)) nil)
2864 ((not (file-exists-p file2)) t)
2865 (t (tramp-time-less-p (nth 5 (file-attributes file2))
2866 (nth 5 (file-attributes file1))))))
2868 (defun tramp-handle-file-regular-p (filename)
2869 "Like `file-regular-p' for Tramp files."
2870 (and (file-exists-p filename)
2871 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2873 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2874 "Like `file-remote-p' for Tramp files."
2875 (let ((tramp-verbose 3))
2876 (when (tramp-tramp-file-p filename)
2877 (let* ((v (tramp-dissect-file-name filename))
2878 (p (tramp-get-connection-process v))
2879 (c (and p (processp p) (memq (process-status p) '(run open)))))
2880 ;; We expand the file name only, if there is already a connection.
2881 (with-parsed-tramp-file-name
2882 (if c (expand-file-name filename) filename) nil
2883 (and (or (not connected) c)
2885 ((eq identification 'method) method)
2886 ((eq identification 'user) user)
2887 ((eq identification 'host) host)
2888 ((eq identification 'localname) localname)
2889 (t (tramp-make-tramp-file-name method user host "")))))))))
2891 (defun tramp-handle-file-symlink-p (filename)
2892 "Like `file-symlink-p' for Tramp files."
2893 (with-parsed-tramp-file-name filename nil
2894 (let ((x (car (file-attributes filename))))
2896 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2897 ;; might do weird things.
2898 (if (file-name-absolute-p x)
2899 (tramp-make-tramp-file-name method user host x)
2902 (defun tramp-handle-find-backup-file-name (filename)
2903 "Like `find-backup-file-name' for Tramp files."
2904 (with-parsed-tramp-file-name filename nil
2905 ;; We set both variables. It doesn't matter whether it is
2907 (let ((backup-directory-alist
2909 (when (boundp 'backup-directory-alist)
2910 (if (symbol-value 'tramp-backup-directory-alist)
2915 (if (and (stringp (cdr x))
2916 (file-name-absolute-p (cdr x))
2917 (not (tramp-file-name-p (cdr x))))
2918 (tramp-make-tramp-file-name method user host (cdr x))
2920 (symbol-value 'tramp-backup-directory-alist))
2921 (symbol-value 'backup-directory-alist))))
2923 (bkup-backup-directory-info
2925 (when (boundp 'bkup-backup-directory-info)
2926 (if (symbol-value 'tramp-bkup-backup-directory-info)
2932 (if (and (stringp (car (cdr x)))
2933 (file-name-absolute-p (car (cdr x)))
2934 (not (tramp-file-name-p (car (cdr x)))))
2935 (tramp-make-tramp-file-name
2936 method user host (car (cdr x)))
2939 (symbol-value 'tramp-bkup-backup-directory-info))
2940 (symbol-value 'bkup-backup-directory-info)))))
2942 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2944 (defun tramp-handle-insert-file-contents
2945 (filename &optional visit beg end replace)
2946 "Like `insert-file-contents' for Tramp files."
2947 (barf-if-buffer-read-only)
2948 (setq filename (expand-file-name filename))
2949 (let (result local-copy remote-copy)
2950 (with-parsed-tramp-file-name filename nil
2951 (with-tramp-progress-reporter
2952 v 3 (format "Inserting `%s'" filename)
2954 (if (not (file-exists-p filename))
2955 ;; We don't raise a Tramp error, because it might be
2956 ;; suppressed, like in `find-file-noselect-1'.
2958 (list "File not found on remote host" filename))
2960 (if (and (tramp-local-host-p v)
2961 (let (file-name-handler-alist)
2962 (file-readable-p localname)))
2963 ;; Short track: if we are on the local host, we can
2966 (tramp-run-real-handler
2967 'insert-file-contents
2968 (list localname visit beg end replace)))
2970 ;; When we shall insert only a part of the file, we
2973 (setq remote-copy (tramp-make-tramp-temp-file v))
2974 ;; This is defined in tramp-sh.el. Let's assume
2975 ;; this is loaded already.
2976 (tramp-compat-funcall
2981 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
2982 beg (tramp-shell-quote-argument localname)
2983 (- end beg) remote-copy))
2985 (format "dd bs=1 skip=%d if=%s of=%s"
2986 beg (tramp-shell-quote-argument localname)
2989 (format "dd bs=1 count=%d if=%s of=%s"
2990 end (tramp-shell-quote-argument localname)
2993 ;; `insert-file-contents-literally' takes care to
2994 ;; avoid calling jka-compr. By let-binding
2995 ;; `inhibit-file-name-operation', we propagate that
2996 ;; care to the `file-local-copy' operation.
2998 (let ((inhibit-file-name-operation
2999 (when (eq inhibit-file-name-operation
3000 'insert-file-contents)
3003 ((stringp remote-copy)
3005 (tramp-make-tramp-file-name
3006 method user host remote-copy)))
3007 ((stringp tramp-temp-buffer-file-name)
3008 (copy-file filename tramp-temp-buffer-file-name 'ok)
3009 tramp-temp-buffer-file-name)
3010 (t (file-local-copy filename)))))
3012 ;; When the file is not readable for the owner, it
3013 ;; cannot be inserted, even if it is readable for the
3014 ;; group or for everybody.
3016 local-copy (tramp-compat-octal-to-decimal "0600"))
3018 (when (and (null remote-copy)
3019 (tramp-get-method-parameter
3020 method 'tramp-copy-keep-tmpfile))
3021 ;; We keep the local file for performance reasons,
3022 ;; useful for "rsync".
3023 (setq tramp-temp-buffer-file-name local-copy))
3025 ;; We must ensure that `file-coding-system-alist'
3026 ;; matches `local-copy'.
3027 (let ((file-coding-system-alist
3028 (tramp-find-file-name-coding-system-alist
3029 filename local-copy)))
3031 (insert-file-contents
3032 local-copy nil nil nil replace)))))
3037 (setq buffer-file-name filename)
3038 (setq buffer-read-only (not (file-writable-p filename)))
3039 (set-visited-file-modtime)
3040 (set-buffer-modified-p nil))
3041 (when (and (stringp local-copy)
3042 (or remote-copy (null tramp-temp-buffer-file-name)))
3043 (delete-file local-copy))
3044 (when (stringp remote-copy)
3046 (tramp-make-tramp-file-name method user host remote-copy)))))))
3049 (list (expand-file-name filename)
3052 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3053 "Like `load' for Tramp files."
3054 (with-parsed-tramp-file-name (expand-file-name file) nil
3056 (cond ((file-exists-p (concat file ".elc"))
3057 (setq file (concat file ".elc")))
3058 ((file-exists-p (concat file ".el"))
3059 (setq file (concat file ".el")))))
3061 ;; The first condition is always true for absolute file names.
3062 ;; Included for safety's sake.
3063 (unless (or (file-name-directory file)
3064 (string-match "\\.elc?\\'" file))
3067 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3069 (when (not (file-exists-p file))
3070 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
3071 (if (not (file-exists-p file))
3073 (let ((tramp-message-show-message (not nomessage)))
3074 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3075 (let ((local-copy (file-local-copy file)))
3076 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
3078 (load local-copy noerror t t)
3079 (delete-file local-copy)))))
3082 (defun tramp-handle-shell-command
3083 (command &optional output-buffer error-buffer)
3084 "Like `shell-command' for Tramp files."
3085 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3086 ;; We cannot use `shell-file-name' and `shell-command-switch',
3087 ;; they are variables of the local host.
3090 (tramp-get-method-parameter
3091 (tramp-file-name-method
3092 (tramp-dissect-file-name default-directory))
3093 'tramp-remote-shell)
3094 (tramp-get-method-parameter
3095 (tramp-file-name-method
3096 (tramp-dissect-file-name default-directory))
3097 'tramp-remote-shell-args))
3098 (list (substring command 0 asynchronous))))
3102 ((bufferp output-buffer) output-buffer)
3103 ((stringp output-buffer) (get-buffer-create output-buffer))
3105 (setq current-buffer-p t)
3107 (t (get-buffer-create
3109 "*Async Shell Command*"
3110 "*Shell Command Output*")))))
3113 ((bufferp error-buffer) error-buffer)
3114 ((stringp error-buffer) (get-buffer-create error-buffer))))
3116 (if (and (not asynchronous) error-buffer)
3117 (with-parsed-tramp-file-name default-directory nil
3118 (list output-buffer (tramp-make-tramp-temp-file v)))
3120 (p (get-buffer-process output-buffer)))
3122 ;; Check whether there is another process running. Tramp does not
3123 ;; support 2 (asynchronous) processes in parallel.
3125 (if (yes-or-no-p "A command is running. Kill it? ")
3126 (ignore-errors (kill-process p))
3127 (error "Shell command in progress")))
3129 (if current-buffer-p
3131 (barf-if-buffer-read-only)
3133 (with-current-buffer output-buffer
3134 (setq buffer-read-only nil)
3137 (if (and (not current-buffer-p) (integerp asynchronous))
3140 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3142 (pop-to-buffer output-buffer)
3143 (setq mode-line-process '(":%s"))
3145 (set-process-sentinel p 'shell-command-sentinel)
3146 (set-process-filter p 'comint-output-filter))
3150 (apply 'process-file (car args) nil buffer nil (cdr args))
3151 ;; Insert error messages if they were separated.
3152 (when (listp buffer)
3153 (with-current-buffer error-buffer
3154 (insert-file-contents (cadr buffer)))
3155 (delete-file (cadr buffer)))
3156 (if current-buffer-p
3157 ;; This is like exchange-point-and-mark, but doesn't
3158 ;; activate the mark. It is cleaner to avoid activation,
3159 ;; even though the command loop would deactivate the mark
3160 ;; because we inserted text.
3161 (goto-char (prog1 (mark t)
3162 (set-marker (mark-marker) (point)
3164 ;; There's some output, display it.
3165 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3166 (if (functionp 'display-message-or-buffer)
3167 (tramp-compat-funcall 'display-message-or-buffer output-buffer)
3168 (pop-to-buffer output-buffer))))))))
3170 (defun tramp-handle-substitute-in-file-name (filename)
3171 "Like `substitute-in-file-name' for Tramp files.
3172 \"//\" and \"/~\" substitute only in the local filename part.
3173 If the URL Tramp syntax is chosen, \"//\" as method delimiter and \"/~\" at
3174 beginning of local filename are not substituted."
3175 ;; First, we must replace environment variables.
3176 (setq filename (tramp-replace-environment-variables filename))
3177 (with-parsed-tramp-file-name filename nil
3178 (if (equal tramp-syntax 'url)
3179 ;; We need to check localname only. The other parts cannot contain
3181 (if (and (> (length localname) 1)
3182 (or (string-match "//" localname)
3183 (string-match "/~" localname 1)))
3184 (tramp-run-real-handler 'substitute-in-file-name (list filename))
3185 (tramp-make-tramp-file-name
3186 (when method (substitute-in-file-name method))
3187 (when user (substitute-in-file-name user))
3188 (when host (substitute-in-file-name host))
3190 (tramp-run-real-handler
3191 'substitute-in-file-name (list localname)))))
3192 ;; Ignore in LOCALNAME everything before "//" or "/~".
3193 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3195 (concat (file-remote-p filename)
3196 (replace-match "\\1" nil nil localname)))
3197 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3198 (when (string-match "~$" filename)
3199 (setq filename (concat filename "/"))))
3200 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3202 (defun tramp-handle-unhandled-file-name-directory (filename)
3203 "Like `unhandled-file-name-directory' for Tramp files."
3204 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3205 ;; for backward compatibility.
3206 (expand-file-name "~/"))
3208 ;;; Functions for establishing connection:
3210 ;; The following functions are actions to be taken when seeing certain
3211 ;; prompts from the remote host. See the variable
3212 ;; `tramp-actions-before-shell' for usage of these functions.
3214 (defun tramp-action-login (proc vec)
3215 "Send the login name."
3216 (when (not (stringp tramp-current-user))
3217 (setq tramp-current-user
3218 (with-tramp-connection-property vec "login-as"
3219 (save-window-excursion
3220 (let ((enable-recursive-minibuffers t))
3221 (pop-to-buffer (tramp-get-connection-buffer vec))
3222 (read-string (match-string 0)))))))
3223 (with-current-buffer (tramp-get-connection-buffer vec)
3224 (tramp-message vec 6 "\n%s" (buffer-string)))
3225 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3226 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3228 (defun tramp-action-password (proc vec)
3229 "Query the user for a password."
3230 (with-current-buffer (process-buffer proc)
3231 (let ((enable-recursive-minibuffers t))
3232 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3233 (tramp-message vec 3 "Sending %s" (match-string 1))
3234 ;; We don't call `tramp-send-string' in order to hide the
3235 ;; password from the debug buffer.
3236 (process-send-string
3237 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3238 ;; Hide password prompt.
3239 (narrow-to-region (point-max) (point-max)))))
3241 (defun tramp-action-succeed (proc vec)
3242 "Signal success in finding shell prompt."
3243 (throw 'tramp-action 'ok))
3245 (defun tramp-action-permission-denied (proc vec)
3246 "Signal permission denied."
3248 (throw 'tramp-action 'permission-denied))
3250 (defun tramp-action-yesno (proc vec)
3251 "Ask the user for confirmation using `yes-or-no-p'.
3252 Send \"yes\" to remote process on confirmation, abort otherwise.
3253 See also `tramp-action-yn'."
3254 (save-window-excursion
3255 (let ((enable-recursive-minibuffers t))
3256 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3257 (unless (yes-or-no-p (match-string 0))
3259 (throw 'tramp-action 'permission-denied))
3260 (with-current-buffer (tramp-get-connection-buffer vec)
3261 (tramp-message vec 6 "\n%s" (buffer-string)))
3262 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3264 (defun tramp-action-yn (proc vec)
3265 "Ask the user for confirmation using `y-or-n-p'.
3266 Send \"y\" to remote process on confirmation, abort otherwise.
3267 See also `tramp-action-yesno'."
3268 (save-window-excursion
3269 (let ((enable-recursive-minibuffers t))
3270 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3271 (unless (y-or-n-p (match-string 0))
3273 (throw 'tramp-action 'permission-denied))
3274 (with-current-buffer (tramp-get-connection-buffer vec)
3275 (tramp-message vec 6 "\n%s" (buffer-string)))
3276 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3278 (defun tramp-action-terminal (proc vec)
3279 "Tell the remote host which terminal type to use.
3280 The terminal type can be configured with `tramp-terminal-type'."
3281 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3282 (with-current-buffer (tramp-get-connection-buffer vec)
3283 (tramp-message vec 6 "\n%s" (buffer-string)))
3284 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3286 (defun tramp-action-process-alive (proc vec)
3287 "Check, whether a process has finished."
3288 (unless (memq (process-status proc) '(run open))
3289 (throw 'tramp-action 'process-died)))
3291 (defun tramp-action-out-of-band (proc vec)
3292 "Check, whether an out-of-band copy has finished."
3293 (cond ((and (memq (process-status proc) '(stop exit))
3294 (zerop (process-exit-status proc)))
3295 (tramp-message vec 3 "Process has finished.")
3296 (throw 'tramp-action 'ok))
3297 ((or (and (memq (process-status proc) '(stop exit))
3298 (not (zerop (process-exit-status proc))))
3299 (memq (process-status proc) '(signal)))
3300 ;; `scp' could have copied correctly, but set modes could have failed.
3301 ;; This can be ignored.
3302 (with-current-buffer (process-buffer proc)
3303 (goto-char (point-min))
3304 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3306 (tramp-message vec 5 "'set mode' error ignored.")
3307 (tramp-message vec 3 "Process has finished.")
3308 (throw 'tramp-action 'ok))
3309 (tramp-message vec 3 "Process has died.")
3310 (throw 'tramp-action 'process-died))))
3313 ;;; Functions for processing the actions:
3315 (defun tramp-process-one-action (proc vec actions)
3316 "Wait for output from the shell and perform one action."
3317 (let (found todo item pattern action)
3319 ;; Reread output once all actions have been performed.
3320 ;; Obviously, the output was not complete.
3321 (tramp-accept-process-output proc 1)
3324 (setq item (pop todo))
3325 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3326 (setq action (nth 1 item))
3328 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3329 (when (tramp-check-for-regexp proc pattern)
3330 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3331 (setq found (funcall action proc vec)))))
3334 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3335 "Perform ACTIONS until success or TIMEOUT.
3336 PROC and VEC indicate the remote connection to be used. POS, if
3337 set, is the starting point of the region to be deleted in the
3339 ;; Preserve message for `progress-reporter'.
3340 (tramp-compat-with-temp-message ""
3341 ;; Enable `auth-source' and `password-cache'. We must use
3342 ;; tramp-current-* variables in case we have several hops.
3343 (tramp-set-connection-property
3344 (tramp-dissect-file-name
3345 (tramp-make-tramp-file-name
3346 tramp-current-method tramp-current-user tramp-current-host ""))
3347 "first-password-request" t)
3351 (tramp-message proc 3 "Waiting for prompts from remote shell")
3353 (catch 'tramp-action
3355 (with-timeout (timeout)
3356 (tramp-process-one-action proc vec actions))
3357 (tramp-process-one-action proc vec actions)))))
3358 (with-current-buffer (tramp-get-connection-buffer vec)
3360 (tramp-message vec 6 "\n%s" (buffer-string)))
3361 (unless (eq exit 'ok)
3362 (tramp-clear-passwd vec)
3363 (tramp-error-with-buffer
3366 ((eq exit 'permission-denied) "Permission denied")
3367 ((eq exit 'process-died) "Process died")
3368 (t "Login failed"))))
3370 (with-current-buffer (tramp-get-connection-buffer vec)
3371 (let (buffer-read-only) (delete-region pos (point)))))))))
3373 :;; Utility functions:
3375 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3376 "Like `accept-process-output' for Tramp processes.
3377 This is needed in order to hide `last-coding-system-used', which is set
3378 for process communication also."
3379 (with-current-buffer (process-buffer proc)
3380 (tramp-message proc 10 "%s %s" proc (process-status proc))
3381 (let (buffer-read-only last-coding-system-used)
3382 ;; Under Windows XP, accept-process-output doesn't return
3383 ;; sometimes. So we add an additional timeout.
3384 (with-timeout ((or timeout 1))
3385 (if (featurep 'xemacs)
3386 (accept-process-output proc timeout timeout-msecs)
3387 (accept-process-output proc timeout timeout-msecs (and proc t)))))
3388 (tramp-message proc 10 "\n%s" (buffer-string))))
3390 (defun tramp-check-for-regexp (proc regexp)
3391 "Check, whether REGEXP is contained in process buffer of PROC.
3392 Erase echoed commands if exists."
3393 (with-current-buffer (process-buffer proc)
3394 (goto-char (point-min))
3396 ;; Check whether we need to remove echo output.
3397 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3398 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3399 (let ((begin (match-beginning 0)))
3400 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3401 ;; Discard echo from remote output.
3402 (tramp-set-connection-property proc "check-remote-echo" nil)
3403 (tramp-message proc 5 "echo-mark found")
3405 (delete-region begin (point))
3406 (goto-char (point-min)))))
3408 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3409 ;; Sometimes, the echo string is suppressed on the remote side.
3411 (tramp-compat-funcall
3412 'substring-no-properties tramp-echo-mark-marker
3413 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3414 (tramp-compat-funcall
3415 'buffer-substring-no-properties
3416 1 (min (1+ tramp-echo-mark-marker-length) (point-max))))))
3417 ;; No echo to be handled, now we can look for the regexp.
3418 ;; Sometimes, lines are much to long, and we run into a "Stack
3419 ;; overflow in regexp matcher". For example, //DIRED// lines of
3420 ;; directory listings with some thousand files. Therefore, we
3421 ;; look from the end.
3422 (goto-char (point-max))
3423 (ignore-errors (re-search-backward regexp nil t)))))
3425 (defun tramp-wait-for-regexp (proc timeout regexp)
3426 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3427 Expects the output of PROC to be sent to the current buffer. Returns
3428 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3430 (with-current-buffer (process-buffer proc)
3431 (let ((found (tramp-check-for-regexp proc regexp))
3432 (start-time (current-time)))
3434 ;; Work around a bug in XEmacs 21, where the timeout
3435 ;; expires faster than it should. This degenerates
3436 ;; to polling for buggy XEmacsen, but oh, well.
3437 (while (and (not found)
3438 (< (tramp-time-diff (current-time) start-time)
3440 (with-timeout (timeout)
3442 (tramp-accept-process-output proc 1)
3443 (unless (memq (process-status proc) '(run open))
3444 (tramp-error-with-buffer
3445 nil proc 'file-error "Process has died"))
3446 (setq found (tramp-check-for-regexp proc regexp))))))
3449 (tramp-accept-process-output proc 1)
3450 (unless (memq (process-status proc) '(run open))
3451 (tramp-error-with-buffer
3452 nil proc 'file-error "Process has died"))
3453 (setq found (tramp-check-for-regexp proc regexp)))))
3454 (tramp-message proc 6 "\n%s" (buffer-string))
3458 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3460 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3463 ;; It seems that Tru64 Unix does not like it if long strings are sent
3464 ;; to it in one go. (This happens when sending the Perl
3465 ;; `file-attributes' implementation, for instance.) Therefore, we
3466 ;; have this function which sends the string in chunks.
3467 (defun tramp-send-string (vec string)
3468 "Send the STRING via connection VEC.
3470 The STRING is expected to use Unix line-endings, but the lines sent to
3471 the remote host use line-endings as defined in the variable
3472 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3473 (let* ((p (tramp-get-connection-process vec))
3474 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3477 vec 'file-error "Can't send string to remote host -- not logged in"))
3478 (tramp-set-connection-property p "last-cmd-time" (current-time))
3479 (tramp-message vec 10 "%s" string)
3480 (with-current-buffer (tramp-get-connection-buffer vec)
3481 ;; Clean up the buffer. We cannot call `erase-buffer' because
3482 ;; narrowing might be in effect.
3483 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3484 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3486 (mapconcat 'identity
3487 (tramp-compat-split-string string "\n")
3488 tramp-rsh-end-of-line))
3489 (unless (or (string= string "")
3490 (string-equal (substring string -1) tramp-rsh-end-of-line))
3491 (setq string (concat string tramp-rsh-end-of-line)))
3493 (if (and chunksize (not (zerop chunksize)))
3495 (end (length string)))
3498 vec 10 "Sending chunk from %s to %s"
3499 pos (min (+ pos chunksize) end))
3500 (process-send-string
3501 p (substring string pos (min (+ pos chunksize) end)))
3502 (setq pos (+ pos chunksize))))
3503 (process-send-string p string)))))
3505 (defun tramp-get-inode (vec)
3506 "Returns the virtual inode number.
3507 If it doesn't exist, generate a new one."
3508 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3509 (setq tramp-inodes (1+ tramp-inodes))))
3511 (defun tramp-get-device (vec)
3512 "Returns the virtual device number.
3513 If it doesn't exist, generate a new one."
3514 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3515 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3517 (defun tramp-equal-remote (file1 file2)
3518 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3519 The check depends on method, user and host name of the files. If
3520 one of the components is missing, the default values are used.
3521 The local file name parts of FILE1 and FILE2 are not taken into
3526 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3528 would yield `t'. On the other hand, the following check results in nil:
3530 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3531 (and (stringp (file-remote-p file1))
3532 (stringp (file-remote-p file2))
3533 (string-equal (file-remote-p file1) (file-remote-p file2))))
3535 ;;;###tramp-autoload
3536 (defun tramp-mode-string-to-int (mode-string)
3537 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3538 (let* (case-fold-search
3539 (mode-chars (string-to-vector mode-string))
3540 (owner-read (aref mode-chars 1))
3541 (owner-write (aref mode-chars 2))
3542 (owner-execute-or-setid (aref mode-chars 3))
3543 (group-read (aref mode-chars 4))
3544 (group-write (aref mode-chars 5))
3545 (group-execute-or-setid (aref mode-chars 6))
3546 (other-read (aref mode-chars 7))
3547 (other-write (aref mode-chars 8))
3548 (other-execute-or-sticky (aref mode-chars 9)))
3552 ((char-equal owner-read ?r) (tramp-compat-octal-to-decimal "00400"))
3553 ((char-equal owner-read ?-) 0)
3554 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3556 ((char-equal owner-write ?w) (tramp-compat-octal-to-decimal "00200"))
3557 ((char-equal owner-write ?-) 0)
3558 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3560 ((char-equal owner-execute-or-setid ?x)
3561 (tramp-compat-octal-to-decimal "00100"))
3562 ((char-equal owner-execute-or-setid ?S)
3563 (tramp-compat-octal-to-decimal "04000"))
3564 ((char-equal owner-execute-or-setid ?s)
3565 (tramp-compat-octal-to-decimal "04100"))
3566 ((char-equal owner-execute-or-setid ?-) 0)
3567 (t (error "Fourth char `%c' must be one of `xsS-'"
3568 owner-execute-or-setid)))
3570 ((char-equal group-read ?r) (tramp-compat-octal-to-decimal "00040"))
3571 ((char-equal group-read ?-) 0)
3572 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3574 ((char-equal group-write ?w) (tramp-compat-octal-to-decimal "00020"))
3575 ((char-equal group-write ?-) 0)
3576 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3578 ((char-equal group-execute-or-setid ?x)
3579 (tramp-compat-octal-to-decimal "00010"))
3580 ((char-equal group-execute-or-setid ?S)
3581 (tramp-compat-octal-to-decimal "02000"))
3582 ((char-equal group-execute-or-setid ?s)
3583 (tramp-compat-octal-to-decimal "02010"))
3584 ((char-equal group-execute-or-setid ?-) 0)
3585 (t (error "Seventh char `%c' must be one of `xsS-'"
3586 group-execute-or-setid)))
3588 ((char-equal other-read ?r)
3589 (tramp-compat-octal-to-decimal "00004"))
3590 ((char-equal other-read ?-) 0)
3591 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3593 ((char-equal other-write ?w) (tramp-compat-octal-to-decimal "00002"))
3594 ((char-equal other-write ?-) 0)
3595 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3597 ((char-equal other-execute-or-sticky ?x)
3598 (tramp-compat-octal-to-decimal "00001"))
3599 ((char-equal other-execute-or-sticky ?T)
3600 (tramp-compat-octal-to-decimal "01000"))
3601 ((char-equal other-execute-or-sticky ?t)
3602 (tramp-compat-octal-to-decimal "01001"))
3603 ((char-equal other-execute-or-sticky ?-) 0)
3604 (t (error "Tenth char `%c' must be one of `xtT-'"
3605 other-execute-or-sticky)))))))
3607 ;;;###tramp-autoload
3608 (defun tramp-local-host-p (vec)
3609 "Return t if this points to the local host, nil otherwise."
3610 ;; We cannot use `tramp-file-name-real-host'. A port is an
3611 ;; indication for an ssh tunnel or alike.
3612 (let ((host (tramp-file-name-host vec)))
3615 (string-match tramp-local-host-regexp host)
3616 ;; The method shall be applied to one of the shell file name
3617 ;; handler. `tramp-local-host-p' is also called for "smb" and
3618 ;; alike, where it must fail.
3619 (tramp-get-method-parameter
3620 (tramp-file-name-method vec) 'tramp-login-program)
3621 ;; The local temp directory must be writable for the other user.
3623 (tramp-make-tramp-file-name
3624 (tramp-file-name-method vec)
3625 (tramp-file-name-user vec)
3627 (tramp-compat-temporary-file-directory)))
3628 ;; On some systems, chown runs only for root.
3629 (or (zerop (user-uid))
3630 ;; This is defined in tramp-sh.el. Let's assume this is
3632 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3634 (defun tramp-get-remote-tmpdir (vec)
3635 "Return directory for temporary files on the remote host identified by VEC."
3636 (with-tramp-connection-property vec "tmpdir"
3637 (let ((dir (tramp-make-tramp-file-name
3638 (tramp-file-name-method vec)
3639 (tramp-file-name-user vec)
3640 (tramp-file-name-host vec)
3642 (tramp-get-method-parameter
3643 (tramp-file-name-method vec) 'tramp-tmpdir)
3645 (if (and (file-directory-p dir) (file-writable-p dir))
3647 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
3649 ;;;###tramp-autoload
3650 (defun tramp-make-tramp-temp-file (vec)
3651 "Create a temporary file on the remote host identified by VEC.
3652 Return the local name of the temporary file."
3653 (let ((prefix (expand-file-name
3654 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3657 ;; `make-temp-file' would be the natural choice for
3658 ;; implementation. But it calls `write-region' internally,
3659 ;; which also needs a temporary file - we would end in an
3661 (setq result (make-temp-name prefix))
3662 (if (file-exists-p result)
3664 ;; This creates the file by side effect.
3665 (set-file-times result)
3666 (set-file-modes result (tramp-compat-octal-to-decimal "0700"))))
3668 ;; Return the local part.
3669 (with-parsed-tramp-file-name result nil localname)))
3671 (defun tramp-delete-temp-file-function ()
3672 "Remove temporary files related to current buffer."
3673 (when (stringp tramp-temp-buffer-file-name)
3674 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3676 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3677 (add-hook 'tramp-unload-hook
3679 (remove-hook 'kill-buffer-hook
3680 'tramp-delete-temp-file-function)))
3682 ;;; Auto saving to a special directory:
3684 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
3685 (defadvice make-auto-save-file-name
3686 (around tramp-advice-make-auto-save-file-name () activate)
3687 "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files."
3688 (if (tramp-tramp-file-p (buffer-file-name))
3689 ;; We cannot call `tramp-handle-make-auto-save-file-name'
3690 ;; directly, because this would bypass the locking mechanism.
3691 (setq ad-return-value
3692 (tramp-file-name-handler 'make-auto-save-file-name))
3698 'make-auto-save-file-name
3699 'around 'tramp-advice-make-auto-save-file-name)
3700 (ad-activate 'make-auto-save-file-name))))
3702 ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus
3703 ;; umask. This is a security threat.
3705 (defun tramp-set-auto-save-file-modes ()
3706 "Set permissions of autosaved remote files to the original permissions."
3707 (let ((bfn (buffer-file-name)))
3708 (when (and (tramp-tramp-file-p bfn)
3710 (stringp buffer-auto-save-file-name)
3711 (not (equal bfn buffer-auto-save-file-name)))
3712 (unless (file-exists-p buffer-auto-save-file-name)
3713 (write-region "" nil buffer-auto-save-file-name))
3714 ;; Permissions should be set always, because there might be an old
3715 ;; auto-saved file belonging to another original file. This could
3716 ;; be a security threat.
3718 buffer-auto-save-file-name
3719 (or (file-modes bfn) (tramp-compat-octal-to-decimal "0600"))))))
3721 (unless (and (featurep 'xemacs)
3722 (= emacs-major-version 21)
3723 (> emacs-minor-version 4))
3724 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
3725 (add-hook 'tramp-unload-hook
3727 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
3729 (defun tramp-subst-strs-in-string (alist string)
3730 "Replace all occurrences of the string FROM with TO in STRING.
3731 ALIST is of the form ((FROM . TO) ...)."
3734 (let* ((pr (car alist))
3737 (while (string-match (regexp-quote from) string)
3738 (setq string (replace-match to t t string)))
3739 (setq alist (cdr alist))))
3742 ;;; Compatibility functions section:
3744 ;;;###tramp-autoload
3745 (defun tramp-read-passwd (proc &optional prompt)
3746 "Read a password from user (compat function).
3747 Consults the auth-source package.
3748 Invokes `password-read' if available, `read-passwd' else."
3749 (let* ((key (tramp-make-tramp-file-name
3750 tramp-current-method tramp-current-user
3751 tramp-current-host ""))
3754 (with-current-buffer (process-buffer proc)
3755 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3756 (format "%s for %s " (capitalize (match-string 1)) key))))
3757 auth-info auth-passwd)
3758 (with-parsed-tramp-file-name key nil
3761 ;; See if auth-sources contains something useful, if it's
3762 ;; bound. `auth-source-user-or-password' is an obsoleted
3763 ;; function, it has been replaced by `auth-source-search'.
3764 (and (boundp 'auth-sources)
3765 (tramp-get-connection-property v "first-password-request" nil)
3766 ;; Try with Tramp's current method.
3767 (if (fboundp 'auth-source-search)
3769 (tramp-compat-funcall
3772 :user (or tramp-current-user t)
3773 :host tramp-current-host
3774 :port tramp-current-method)
3775 auth-passwd (plist-get (nth 0 auth-info) :secret)
3776 auth-passwd (if (functionp auth-passwd)
3777 (funcall auth-passwd)
3779 (tramp-compat-funcall
3780 'auth-source-user-or-password
3781 "password" tramp-current-host tramp-current-method)))
3782 ;; Try the password cache.
3783 (when (functionp 'password-read)
3784 (unless (tramp-get-connection-property
3785 v "first-password-request" nil)
3786 (tramp-compat-funcall 'password-cache-remove key))
3788 (tramp-compat-funcall 'password-read pw-prompt key)))
3789 (tramp-compat-funcall 'password-cache-add key password)
3791 ;; Else, get the password interactively.
3792 (read-passwd pw-prompt))
3793 (tramp-set-connection-property v "first-password-request" nil)))))
3795 ;;;###tramp-autoload
3796 (defun tramp-clear-passwd (vec)
3797 "Clear password cache for connection related to VEC."
3798 (tramp-compat-funcall
3799 'password-cache-remove
3800 (tramp-make-tramp-file-name
3801 (tramp-file-name-method vec)
3802 (tramp-file-name-user vec)
3803 (tramp-file-name-host vec)
3806 ;; Snarfed code from time-date.el and parse-time.el
3808 (defconst tramp-half-a-year '(241 17024)
3809 "Evaluated by \"(days-to-time 183)\".")
3811 (defconst tramp-parse-time-months
3812 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
3813 ("apr" . 4) ("may" . 5) ("jun" . 6)
3814 ("jul" . 7) ("aug" . 8) ("sep" . 9)
3815 ("oct" . 10) ("nov" . 11) ("dec" . 12))
3816 "Alist mapping month names to integers.")
3818 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
3819 ;;;###tramp-autoload
3820 (defun tramp-time-less-p (t1 t2)
3821 "Say whether time value T1 is less than time value T2."
3822 (unless t1 (setq t1 '(0 0)))
3823 (unless t2 (setq t2 '(0 0)))
3824 (or (< (car t1) (car t2))
3825 (and (= (car t1) (car t2))
3826 (< (nth 1 t1) (nth 1 t2)))))
3828 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
3829 (defun tramp-time-subtract (t1 t2)
3830 "Subtract two time values.
3831 Return the difference in the format of a time value."
3832 (unless t1 (setq t1 '(0 0)))
3833 (unless t2 (setq t2 '(0 0)))
3834 (let ((borrow (< (cadr t1) (cadr t2))))
3835 (list (- (car t1) (car t2) (if borrow 1 0))
3836 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
3838 ;;;###tramp-autoload
3839 (defun tramp-time-diff (t1 t2)
3840 "Return the difference between the two times, in seconds.
3841 T1 and T2 are time values (as returned by `current-time' for example)."
3842 (cond ((and (fboundp 'subtract-time)
3843 (fboundp 'float-time))
3844 (tramp-compat-funcall
3845 'float-time (tramp-compat-funcall 'subtract-time t1 t2)))
3846 ((and (fboundp 'subtract-time)
3847 (fboundp 'time-to-seconds))
3848 (tramp-compat-funcall
3849 'time-to-seconds (tramp-compat-funcall 'subtract-time t1 t2)))
3850 ((fboundp 'itimer-time-difference)
3851 (tramp-compat-funcall
3852 'itimer-time-difference
3853 (if (< (length t1) 3) (append t1 '(0)) t1)
3854 (if (< (length t2) 3) (append t2 '(0)) t2)))
3856 (let ((time (tramp-time-subtract t1 t2)))
3857 (+ (* (car time) 65536.0)
3859 (/ (or (nth 2 time) 0) 1000000.0))))))
3861 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
3862 ;; does not deal well with newline characters. Newline is replaced by
3863 ;; backslash newline. But if, say, the string `a backslash newline b'
3864 ;; is passed to a shell, the shell will expand this into "ab",
3865 ;; completely omitting the newline. This is not what was intended.
3866 ;; It does not appear to be possible to make the function
3867 ;; `shell-quote-argument' work with newlines without making it
3868 ;; dependent on the shell used. But within this package, we know that
3869 ;; we will always use a Bourne-like shell, so we use an approach which
3872 ;; The approach is simple: we call `shell-quote-argument', then
3873 ;; massage the newline part of the result.
3875 ;; This function should produce a string which is grokked by a Unix
3876 ;; shell, even if the Emacs is running on Windows. Since this is the
3877 ;; kludges section, we bind `system-type' in such a way that
3878 ;; `shell-quote-arguments' behaves as if on Unix.
3880 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
3881 ;; function to work with Bourne-like shells.
3883 ;; CCC: This function should be rewritten so that
3884 ;; `shell-quote-argument' is not used. This way, we are safe from
3885 ;; changes in `shell-quote-argument'.
3886 ;;;###tramp-autoload
3887 (defun tramp-shell-quote-argument (s)
3888 "Similar to `shell-quote-argument', but groks newlines.
3889 Only works for Bourne-like shells."
3890 (let ((system-type 'not-windows))
3892 (let ((result (shell-quote-argument s))
3893 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
3894 (when (and (>= (length result) 2)
3895 (string= (substring result 0 2) "\\~"))
3896 (setq result (substring result 1)))
3897 (while (string-match nl result)
3898 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
3902 ;;; Integration of eshell.el:
3905 (defvar eshell-path-env))
3907 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
3908 ;; when `default-directory' points to another host.
3909 (defun tramp-eshell-directory-change ()
3910 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
3911 (setq eshell-path-env
3912 (if (file-remote-p default-directory)
3913 (with-parsed-tramp-file-name default-directory nil
3917 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
3918 ;; the remote path is only set in the session cache.
3919 (tramp-get-connection-property
3920 (tramp-get-connection-process v) "remote-path" nil)
3921 (tramp-get-connection-property v "remote-path" nil))
3925 (eval-after-load "esh-util"
3927 (tramp-eshell-directory-change)
3928 (add-hook 'eshell-directory-change-hook
3929 'tramp-eshell-directory-change)
3930 (add-hook 'tramp-unload-hook
3932 (remove-hook 'eshell-directory-change-hook
3933 'tramp-eshell-directory-change)))))
3935 ;; Checklist for `tramp-unload-hook'
3936 ;; - Unload all `tramp-*' packages
3937 ;; - Reset `file-name-handler-alist'
3938 ;; - Cleanup hooks where Tramp functions are in
3939 ;; - Cleanup advised functions
3940 ;; - Cleanup autoloads
3942 (defun tramp-unload-tramp ()
3943 "Discard Tramp from loading remote files."
3945 ;; ange-ftp settings must be enabled.
3946 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
3947 ;; Maybe it's not loaded yet.
3948 (ignore-errors (unload-feature 'tramp 'force)))
3954 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
3955 ;; `shell-quote-argument'.
3956 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
3957 ;; by the files in that directory. Add this here.
3958 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
3959 ;; * abbreviate-file-name
3960 ;; * Better error checking. At least whenever we see something
3961 ;; strange when doing zerop, we should kill the process and start
3962 ;; again. (Greg Stark)
3963 ;; * Username and hostname completion.
3964 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
3965 ;; * Make `tramp-default-user' obsolete.
3966 ;; * Implement a general server-local-variable mechanism, as there are
3967 ;; probably other variables that need different values for different
3968 ;; servers too. The user could then configure a variable (such as
3969 ;; tramp-server-local-variable-alist) to define any such variables
3970 ;; that they need to, which would then be let bound as appropriate
3971 ;; in tramp functions. (Jason Rumney)
3972 ;; * IMHO, it's a drawback that currently Tramp doesn't support
3973 ;; Unicode in Dired file names by default. Is it possible to
3974 ;; improve Tramp to set LC_ALL to "C" only for commands where Tramp
3975 ;; expects English? Or just to set LC_MESSAGES to "C" if Tramp
3976 ;; expects only English messages? (Juri Linkov)
3977 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
3978 ;; * I was wondering if it would be possible to use tramp even if I'm
3979 ;; actually using sshfs. But when I launch a command I would like
3980 ;; to get it executed on the remote machine where the files really
3981 ;; are. (Andrea Crotti)
3982 ;; * Run emerge on two remote files. Bug is described here:
3983 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
3986 ;;; tramp.el ends here