1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2014 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 Git. You can find instructions about this at the following URL:
53 ;; http://savannah.gnu.org/projects/tramp/
55 ;; Don't forget to put on your asbestos longjohns, first!
59 (require 'tramp-compat)
61 ;; Pacify byte-compiler.
64 (defvar bkup-backup-directory-info)
65 (defvar directory-sep-char)
66 (defvar eshell-path-env)
67 (defvar file-notify-descriptors)
68 (defvar ls-lisp-use-insert-directory-program)
69 (defvar outline-regexp)
71 ;;; User Customizable Internal Variables:
74 "Edit remote files with a combination of ssh, scp, etc."
79 ;; Maybe we need once a real Tramp mode, with key bindings etc.
81 (defcustom tramp-mode t
82 "Whether Tramp is enabled.
83 If it is set to nil, all remote file names are used literally."
87 (defcustom tramp-verbose 3
88 "Verbosity level for Tramp messages.
89 Any level x includes messages for all levels 1 .. x-1. The levels are
91 0 silent (no tramp messages at all)
94 3 connection to remote hosts (default level)
97 6 sent and received strings
99 8 connection properties
107 (when (boundp 'backup-directory-alist)
108 (defcustom tramp-backup-directory-alist nil
109 "Alist of filename patterns and backup directory names.
110 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
111 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
112 is a local file name, the backup directory is prepended with Tramp file
113 name prefix \(method, user, host\) of file.
115 \(setq tramp-backup-directory-alist backup-directory-alist\)
117 gives the same backup policy for Tramp files on their hosts like the
118 policy for local files."
120 :type '(repeat (cons (regexp :tag "Regexp matching filename")
121 (directory :tag "Backup directory name"))))))
123 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
124 ;; the package "backup-dir" might not be loaded yet.
126 (when (featurep 'xemacs)
127 (defcustom tramp-bkup-backup-directory-info nil
128 "Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
129 It has the same meaning like `bkup-backup-directory-info' from package
130 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
131 file name, the backup directory is prepended with Tramp file name prefix
132 \(method, user, host\) of file.
134 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
136 gives the same backup policy for Tramp files on their hosts like the
137 policy for local files."
139 (list (regexp :tag "File regexp")
140 (string :tag "Backup Dir")
145 (const search-upward))))
148 (defcustom tramp-auto-save-directory nil
149 "Put auto-save files in this directory, if set.
150 The idea is to use a local directory so that auto-saving is faster."
152 :type '(choice (const nil) string))
154 (defcustom tramp-encoding-shell
155 (if (memq system-type '(windows-nt))
158 "Use this program for encoding and decoding commands on the local host.
159 This shell is used to execute the encoding and decoding command on the
160 local host, so if you want to use `~' in those commands, you should
161 choose a shell here which groks tilde expansion. `/bin/sh' normally
162 does not understand tilde expansion.
164 For encoding and decoding, commands like the following are executed:
166 /bin/sh -c COMMAND < INPUT > OUTPUT
168 This variable can be used to change the \"/bin/sh\" part. See the
169 variable `tramp-encoding-command-switch' for the \"-c\" part.
171 If the shell must be forced to be interactive, see
172 `tramp-encoding-command-interactive'.
174 Note that this variable is not used for remote commands. There are
175 mechanisms in tramp.el which automatically determine the right shell to
176 use for the remote host."
178 :type '(file :must-match t))
180 (defcustom tramp-encoding-command-switch
181 (if (string-match "cmd\\.exe" tramp-encoding-shell)
184 "Use this switch together with `tramp-encoding-shell' for local commands.
185 See the variable `tramp-encoding-shell' for more information."
189 (defcustom tramp-encoding-command-interactive
190 (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i")
191 "Use this switch together with `tramp-encoding-shell' for interactive shells.
192 See the variable `tramp-encoding-shell' for more information."
195 :type '(choice (const nil) string))
198 (defvar tramp-methods nil
199 "Alist of methods for remote files.
200 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
201 Each NAME stands for a remote access method. Each PARAM is a
202 pair of the form (KEY VALUE). The following KEYs are defined:
203 * `tramp-remote-shell'
204 This specifies the shell to use on the remote host. This
205 MUST be a Bourne-like shell. It is normally not necessary to
206 set this to any value other than \"/bin/sh\": Tramp wants to
207 use a shell which groks tilde expansion, but it can search
208 for it. Also note that \"/bin/sh\" exists on all Unixen,
209 this might not be true for the value that you decide to use.
210 You Have Been Warned.
211 * `tramp-remote-shell-args'
212 For implementation of `shell-command', this specifies the
213 arguments to let `tramp-remote-shell' run a single command.
214 * `tramp-login-program'
215 This specifies the name of the program to use for logging in to the
216 remote host. This may be the name of rsh or a workalike program,
217 or the name of telnet or a workalike, or the name of su or a workalike.
219 This specifies the list of arguments to pass to the above
220 mentioned program. Please note that this is a list of list of arguments,
221 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
222 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
223 There are some patterns: \"%h\" in this list is replaced by the host
224 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
225 port number, and \"%%\" can be used to obtain a literal percent character.
226 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
227 expansion (i.e. no host or no user specified), this list is not used as
228 argument. By this, arguments like (\"-l\" \"%u\") are optional.
229 \"%t\" is replaced by the temporary file name produced with
230 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
231 parameter of a program, if exists. \"%c\" adds additional
232 `tramp-ssh-controlmaster-options' options for the first hop.
234 A list of environment variables and their values, which will
235 be set when calling `tramp-login-program'.
237 When an asynchronous process is started, we know already that
238 the connection works. Therefore, we can pass additional
239 parameters to suppress diagnostic messages, in order not to
240 tamper the process output.
241 * `tramp-copy-program'
242 This specifies the name of the program to use for remotely copying
243 the file; this might be the absolute filename of rcp or the name of
246 This specifies the list of parameters to pass to the above mentioned
247 program, the hints for `tramp-login-args' also apply here.
249 A list of environment variables and their values, which will
250 be set when calling `tramp-copy-program'.
251 * `tramp-copy-keep-date'
252 This specifies whether the copying program when the preserves the
253 timestamp of the original file.
254 * `tramp-copy-keep-tmpfile'
255 This specifies whether a temporary local file shall be kept
256 for optimization reasons (useful for \"rsync\" methods).
257 * `tramp-copy-recursive'
258 Whether the operation copies directories recursively.
259 * `tramp-default-port'
260 The default port of a method is needed in case of gateway connections.
261 Additionally, it is used as indication which method is prepared for
264 As the attribute name says, additional arguments are specified here
265 when a method is applied via a gateway.
267 A directory on the remote host for temporary files. If not
268 specified, \"/tmp\" is taken as default.
269 * `tramp-connection-timeout'
270 This is the maximum time to be spent for establishing a connection.
271 In general, the global default value shall be used, but for
272 some methods, like \"su\" or \"sudo\", a shorter timeout
275 What does all this mean? Well, you should specify `tramp-login-program'
276 for all methods; this program is used to log in to the remote site. Then,
277 there are two ways to actually transfer the files between the local and the
278 remote side. One way is using an additional rcp-like program. If you want
279 to do this, set `tramp-copy-program' in the method.
281 Another possibility for file transfer is inline transfer, i.e. the
282 file is passed through the same buffer used by `tramp-login-program'. In
283 this case, the file contents need to be protected since the
284 `tramp-login-program' might use escape codes or the connection might not
285 be eight-bit clean. Therefore, file contents are encoded for transit.
286 See the variables `tramp-local-coding-commands' and
287 `tramp-remote-coding-commands' for details.
289 So, to summarize: if the method is an out-of-band method, then you
290 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
291 inline method, then these two parameters should be nil. Methods which
292 are fit for gateways must have `tramp-default-port' at least.
296 When using `su' or `sudo' the phrase `open connection to a remote
297 host' sounds strange, but it is used nevertheless, for consistency.
298 No connection is opened to a remote host, but `su' or `sudo' is
299 started on the local host. You should specify a remote host
300 `localhost' or the name of the local host. Another host name is
301 useful only in combination with `tramp-default-proxies-alist'.")
304 (defconst tramp-ssh-controlmaster-options
308 (call-process "ssh" nil t nil "-o" "ControlMaster")
309 (goto-char (point-min))
310 (when (search-forward-regexp "Missing ControlMaster argument" nil t)
311 (setq result "-o ControlPath=%t.%%r@%%h:%%p -o ControlMaster=auto")))
314 (call-process "ssh" nil t nil "-o" "ControlPersist")
315 (goto-char (point-min))
316 (when (search-forward-regexp "Missing ControlPersist argument" nil t)
317 (setq result (concat result " -o ControlPersist=no"))))))
319 "Call ssh to detect whether it supports the Control* arguments.
320 Return a string to be used in `tramp-methods'.")
323 (defcustom tramp-use-ssh-controlmaster-options
324 (not (zerop (length tramp-ssh-controlmaster-options)))
325 "Whether to use `tramp-ssh-controlmaster-options'."
330 (defcustom tramp-default-method
331 ;; An external copy method seems to be preferred, because it performs
332 ;; much better for large files, and it hasn't too serious delays
333 ;; for small files. But it must be ensured that there aren't
334 ;; permanent password queries. Either a password agent like
335 ;; "ssh-agent" or "Pageant" shall run, or the optional
336 ;; password-cache.el or auth-sources.el packages shall be active for
337 ;; password caching. If we detect that the user is running OpenSSH
338 ;; 4.0 or newer, we could reuse the connection, which calls also for
339 ;; an external method.
341 ;; PuTTY is installed. We don't take it, if it is installed on a
342 ;; non-windows system, or pscp from the pssh (parallel ssh) package
344 ((and (eq system-type 'windows-nt)
345 (executable-find "pscp"))
346 (if (or (fboundp 'password-read)
347 (fboundp 'auth-source-user-or-password)
348 (fboundp 'auth-source-search)
349 ;; Pageant is running.
350 (tramp-compat-process-running-p "Pageant"))
353 ;; There is an ssh installation.
354 ((executable-find "scp")
355 (if (or (fboundp 'password-read)
356 (fboundp 'auth-source-user-or-password)
357 (fboundp 'auth-source-search)
358 ;; ssh-agent is running.
359 (getenv "SSH_AUTH_SOCK")
360 (getenv "SSH_AGENT_PID")
361 ;; We could reuse the connection.
362 (> (length tramp-ssh-controlmaster-options) 0))
367 "Default method to use for transferring files.
368 See `tramp-methods' for possibilities.
369 Also see `tramp-default-method-alist'."
374 (defcustom tramp-default-method-alist nil
375 "Default method to use for specific host/user pairs.
376 This is an alist of items (HOST USER METHOD). The first matching item
377 specifies the method to use for a file name which does not specify a
378 method. HOST and USER are regular expressions or nil, which is
379 interpreted as a regular expression which always matches. If no entry
380 matches, the variable `tramp-default-method' takes effect.
382 If the file name does not specify the user, lookup is done using the
383 empty string for the user name.
385 See `tramp-methods' for a list of possibilities for METHOD."
387 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
388 (choice :tag "User regexp" regexp sexp)
389 (choice :tag "Method name" string (const nil)))))
391 (defcustom tramp-default-user nil
392 "Default user to use for transferring files.
393 It is nil by default; otherwise settings in configuration files like
394 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
396 This variable is regarded as obsolete, and will be removed soon."
398 :type '(choice (const nil) string))
401 (defcustom tramp-default-user-alist nil
402 "Default user to use for specific method/host pairs.
403 This is an alist of items (METHOD HOST USER). The first matching item
404 specifies the user to use for a file name which does not specify a
405 user. METHOD and USER are regular expressions or nil, which is
406 interpreted as a regular expression which always matches. If no entry
407 matches, the variable `tramp-default-user' takes effect.
409 If the file name does not specify the method, lookup is done using the
410 empty string for the method name."
412 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
413 (choice :tag " Host regexp" regexp sexp)
414 (choice :tag " User name" string (const nil)))))
416 (defcustom tramp-default-host (system-name)
417 "Default host to use for transferring files.
418 Useful for su and sudo methods mostly."
423 (defcustom tramp-default-host-alist nil
424 "Default host to use for specific method/user pairs.
425 This is an alist of items (METHOD USER HOST). The first matching item
426 specifies the host to use for a file name which does not specify a
427 host. METHOD and HOST are regular expressions or nil, which is
428 interpreted as a regular expression which always matches. If no entry
429 matches, the variable `tramp-default-host' takes effect.
431 If the file name does not specify the method, lookup is done using the
432 empty string for the method name."
435 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
436 (choice :tag " User regexp" regexp sexp)
437 (choice :tag " Host name" string (const nil)))))
439 (defcustom tramp-default-proxies-alist nil
440 "Route to be followed for specific host/user pairs.
441 This is an alist of items (HOST USER PROXY). The first matching
442 item specifies the proxy to be passed for a file name located on
443 a remote target matching USER@HOST. HOST and USER are regular
444 expressions. PROXY must be a Tramp filename without a localname
445 part. Method and user name on PROXY are optional, which is
446 interpreted with the default values. PROXY can contain the
447 patterns %h and %u, which are replaced by the strings matching
448 HOST or USER, respectively.
450 HOST, USER or PROXY could also be Lisp forms, which will be
451 evaluated. The result must be a string or nil, which is
452 interpreted as a regular expression which always matches."
454 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
455 (choice :tag "User regexp" regexp sexp)
456 (choice :tag " Proxy name" string (const nil)))))
458 (defcustom tramp-save-ad-hoc-proxies nil
459 "Whether to save ad-hoc proxies persistently."
464 (defcustom tramp-restricted-shell-hosts-alist
465 (when (memq system-type '(windows-nt))
466 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
467 "List of hosts, which run a restricted shell.
468 This is a list of regular expressions, which denote hosts running
469 a registered shell like \"rbash\". Those hosts can be used as
470 proxies only, see `tramp-default-proxies-alist'. If the local
471 host runs a registered shell, it shall be added to this list, too."
474 :type '(repeat (regexp :tag "Host regexp")))
477 (defconst tramp-local-host-regexp
481 (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t)
483 "Host names which are regarded as local host.")
485 (defvar tramp-completion-function-alist nil
486 "Alist of methods for remote files.
487 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\).
488 Each NAME stands for a remote access method. Each PAIR is of the form
489 \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host
490 names from FILE for completion. The following predefined FUNCTIONs exists:
492 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
493 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
494 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
495 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
496 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
497 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
498 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
499 * `tramp-parse-netrc' for \"~/.netrc\" like files.
500 * `tramp-parse-putty' for PuTTY registered sessions.
502 FUNCTION can also be a customer defined function. For more details see
505 (defconst tramp-echo-mark-marker "_echo"
506 "String marker to surround echoed commands.")
508 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
509 "String length of `tramp-echo-mark-marker'.")
511 (defconst tramp-echo-mark
512 (concat tramp-echo-mark-marker
513 (make-string tramp-echo-mark-marker-length ?\b))
514 "String mark to be transmitted around shell commands.
515 Used to separate their echo from the output they produce. This
516 will only be used if we cannot disable remote echo via stty.
517 This string must have no effect on the remote shell except for
518 producing some echo which can later be detected by
519 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
520 followed by an equal number of backspaces to erase them will
523 (defconst tramp-echoed-echo-mark-regexp
524 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
525 tramp-echo-mark-marker tramp-echo-mark-marker-length)
526 "Regexp which matches `tramp-echo-mark' as it gets echoed by
529 (defcustom tramp-local-end-of-line
530 (if (memq system-type '(windows-nt)) "\r\n" "\n")
531 "String used for end of line in local processes."
536 (defcustom tramp-rsh-end-of-line "\n"
537 "String used for end of line in rsh connections.
538 I don't think this ever needs to be changed, so please tell me about it
539 if you need to change this."
543 (defcustom tramp-login-prompt-regexp
544 ".*ogin\\( .*\\)?: *"
545 "Regexp matching login-like prompts.
546 The regexp should match at end of buffer.
548 Sometimes the prompt is reported to look like \"login as:\"."
552 (defcustom tramp-shell-prompt-pattern
553 ;; Allow a prompt to start right after a ^M since it indeed would be
554 ;; displayed at the beginning of the line (and Zsh uses it). This
555 ;; regexp works only for GNU Emacs.
556 ;; Allow also [] style prompts. They can appear only during
557 ;; connection initialization; Tramp redefines the prompt afterwards.
558 (concat (if (featurep 'xemacs) "" "\\(?:^\\|\r\\)")
559 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
560 "Regexp to match prompts from remote shell.
561 Normally, Tramp expects you to configure `shell-prompt-pattern'
562 correctly, but sometimes it happens that you are connecting to a
563 remote host which sends a different kind of shell prompt. Therefore,
564 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
565 and also things matched by this variable. The default value of this
566 variable is similar to the default value of `shell-prompt-pattern',
567 which should work well in many cases.
569 This regexp must match both `tramp-initial-end-of-output' and
570 `tramp-end-of-output'."
574 (defcustom tramp-password-prompt-regexp
575 (format "^.*\\(%s\\).*:\^@? *"
576 (if (boundp 'password-word-equivalents)
577 (regexp-opt (symbol-value 'password-word-equivalents))
578 "password\\|passphrase"))
579 "Regexp matching password-like prompts.
580 The regexp should match at end of buffer.
582 The `sudo' program appears to insert a `^@' character into the prompt."
587 (defcustom tramp-wrong-passwd-regexp
589 ;; These strings should be on the last line
590 (regexp-opt '("Permission denied"
595 "Timeout, server not responding."
597 "Name or service not known"
598 "Host key verification failed."
599 "No supported authentication methods left to try!") t)
603 ;; Here comes a list of regexes, separated by \\|
604 "Received signal [0-9]+"
606 "Regexp matching a `login failed' message.
607 The regexp should match at end of buffer."
611 (defcustom tramp-yesno-prompt-regexp
613 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
615 "Regular expression matching all yes/no queries which need to be confirmed.
616 The confirmation should be done with yes or no.
617 The regexp should match at end of buffer.
618 See also `tramp-yn-prompt-regexp'."
622 (defcustom tramp-yn-prompt-regexp
624 (regexp-opt '("Store key in cache? (y/n)"
625 "Update cached key? (y/n, Return cancels connection)") t)
627 "Regular expression matching all y/n queries which need to be confirmed.
628 The confirmation should be done with y or n.
629 The regexp should match at end of buffer.
630 See also `tramp-yesno-prompt-regexp'."
634 (defcustom tramp-terminal-prompt-regexp
638 "Terminal type\\? \\[.*\\]"
640 "Regular expression matching all terminal setting prompts.
641 The regexp should match at end of buffer.
642 The answer will be provided by `tramp-action-terminal', which see."
646 (defcustom tramp-operation-not-permitted-regexp
647 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
648 (regexp-opt '("Operation not permitted") t))
649 "Regular expression matching keep-date problems in (s)cp operations.
650 Copying has been performed successfully already, so this message can
655 (defcustom tramp-copy-failed-regexp
657 (regexp-opt '("Permission denied"
660 "No such file or directory") t)
662 "Regular expression matching copy problems in (s)cp operations."
666 (defcustom tramp-process-alive-regexp
668 "Regular expression indicating a process has finished.
669 In fact this expression is empty by intention, it will be used only to
670 check regularly the status of the associated process.
671 The answer will be provided by `tramp-action-process-alive',
672 `tramp-action-out-of-band', which see."
676 (defconst tramp-temp-name-prefix "tramp."
677 "Prefix to use for temporary files.
678 If this is a relative file name (such as \"tramp.\"), it is considered
679 relative to the directory name returned by the function
680 `tramp-compat-temporary-file-directory' (which see). It may also be an
681 absolute file name; don't forget to include a prefix for the filename
684 (defconst tramp-temp-buffer-name " *tramp temp*"
685 "Buffer name for a temporary buffer.
686 It shall be used in combination with `generate-new-buffer-name'.")
688 (defvar tramp-temp-buffer-file-name nil
689 "File name of a persistent local temporary file.
690 Useful for \"rsync\" like methods.")
691 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
692 (put 'tramp-temp-buffer-file-name 'permanent-local t)
694 ;; XEmacs is distributed with few Lisp packages. Further packages are
695 ;; installed using EFS. If we use a unified filename format, then
696 ;; Tramp is required in addition to EFS. (But why can't Tramp just
697 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
698 ;; just like before.) Another reason for using a separate filename
699 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
700 ;; Tramp only knows how to deal with `file-name-handler-alist', not
703 ;; Currently, we have the choice between 'ftp and 'sep.
705 (defcustom tramp-syntax
706 (if (featurep 'xemacs) 'sep 'ftp)
707 "Tramp filename syntax to be used.
709 It can have the following values:
711 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
712 'sep -- Syntax as defined for XEmacs."
715 :type `(choice (const :tag ,(if (featurep 'xemacs) "EFS" "Ange-FTP") ftp)
716 (const :tag "XEmacs" sep)))
718 (defconst tramp-prefix-format
719 (cond ((equal tramp-syntax 'ftp) "/")
720 ((equal tramp-syntax 'sep) "/[")
721 (t (error "Wrong `tramp-syntax' defined")))
722 "String matching the very beginning of Tramp file names.
723 Used in `tramp-make-tramp-file-name'.")
725 (defconst tramp-prefix-regexp
726 (concat "^" (regexp-quote tramp-prefix-format))
727 "Regexp matching the very beginning of Tramp file names.
728 Should always start with \"^\". Derived from `tramp-prefix-format'.")
730 (defconst tramp-method-regexp
732 "Regexp matching methods identifiers.")
734 (defconst tramp-postfix-method-format
735 (cond ((equal tramp-syntax 'ftp) ":")
736 ((equal tramp-syntax 'sep) "/")
737 (t (error "Wrong `tramp-syntax' defined")))
738 "String matching delimiter between method and user or host names.
739 Used in `tramp-make-tramp-file-name'.")
741 (defconst tramp-postfix-method-regexp
742 (regexp-quote tramp-postfix-method-format)
743 "Regexp matching delimiter between method and user or host names.
744 Derived from `tramp-postfix-method-format'.")
746 (defconst tramp-user-regexp "[^/|: \t]+"
747 "Regexp matching user names.")
750 (defconst tramp-prefix-domain-format "%"
751 "String matching delimiter between user and domain names.")
754 (defconst tramp-prefix-domain-regexp
755 (regexp-quote tramp-prefix-domain-format)
756 "Regexp matching delimiter between user and domain names.
757 Derived from `tramp-prefix-domain-format'.")
759 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
760 "Regexp matching domain names.")
762 (defconst tramp-user-with-domain-regexp
763 (concat "\\(" tramp-user-regexp "\\)"
764 tramp-prefix-domain-regexp
765 "\\(" tramp-domain-regexp "\\)")
766 "Regexp matching user names with domain names.")
768 (defconst tramp-postfix-user-format "@"
769 "String matching delimiter between user and host names.
770 Used in `tramp-make-tramp-file-name'.")
772 (defconst tramp-postfix-user-regexp
773 (regexp-quote tramp-postfix-user-format)
774 "Regexp matching delimiter between user and host names.
775 Derived from `tramp-postfix-user-format'.")
777 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
778 "Regexp matching host names.")
780 (defconst tramp-prefix-ipv6-format
781 (cond ((equal tramp-syntax 'ftp) "[")
782 ((equal tramp-syntax 'sep) "")
783 (t (error "Wrong `tramp-syntax' defined")))
784 "String matching left hand side of IPv6 addresses.
785 Used in `tramp-make-tramp-file-name'.")
787 (defconst tramp-prefix-ipv6-regexp
788 (regexp-quote tramp-prefix-ipv6-format)
789 "Regexp matching left hand side of IPv6 addresses.
790 Derived from `tramp-prefix-ipv6-format'.")
792 ;; The following regexp is a bit sloppy. But it shall serve our
793 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
794 ;; "::ffff:192.168.0.1".
795 (defconst tramp-ipv6-regexp
796 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
797 "Regexp matching IPv6 addresses.")
799 (defconst tramp-postfix-ipv6-format
800 (cond ((equal tramp-syntax 'ftp) "]")
801 ((equal tramp-syntax 'sep) "")
802 (t (error "Wrong `tramp-syntax' defined")))
803 "String matching right hand side of IPv6 addresses.
804 Used in `tramp-make-tramp-file-name'.")
806 (defconst tramp-postfix-ipv6-regexp
807 (regexp-quote tramp-postfix-ipv6-format)
808 "Regexp matching right hand side of IPv6 addresses.
809 Derived from `tramp-postfix-ipv6-format'.")
811 (defconst tramp-prefix-port-format
812 (cond ((equal tramp-syntax 'ftp) "#")
813 ((equal tramp-syntax 'sep) "#")
814 (t (error "Wrong `tramp-syntax' defined")))
815 "String matching delimiter between host names and port numbers.")
817 (defconst tramp-prefix-port-regexp
818 (regexp-quote tramp-prefix-port-format)
819 "Regexp matching delimiter between host names and port numbers.
820 Derived from `tramp-prefix-port-format'.")
822 (defconst tramp-port-regexp "[0-9]+"
823 "Regexp matching port numbers.")
825 (defconst tramp-host-with-port-regexp
826 (concat "\\(" tramp-host-regexp "\\)"
827 tramp-prefix-port-regexp
828 "\\(" tramp-port-regexp "\\)")
829 "Regexp matching host names with port numbers.")
831 (defconst tramp-postfix-hop-format "|"
832 "String matching delimiter after ad-hoc hop definitions.")
834 (defconst tramp-postfix-hop-regexp
835 (regexp-quote tramp-postfix-hop-format)
836 "Regexp matching delimiter after ad-hoc hop definitions.
837 Derived from `tramp-postfix-hop-format'.")
839 (defconst tramp-postfix-host-format
840 (cond ((equal tramp-syntax 'ftp) ":")
841 ((equal tramp-syntax 'sep) "]")
842 (t (error "Wrong `tramp-syntax' defined")))
843 "String matching delimiter between host names and localnames.
844 Used in `tramp-make-tramp-file-name'.")
846 (defconst tramp-postfix-host-regexp
847 (regexp-quote tramp-postfix-host-format)
848 "Regexp matching delimiter between host names and localnames.
849 Derived from `tramp-postfix-host-format'.")
851 (defconst tramp-localname-regexp ".*$"
852 "Regexp matching localnames.")
854 ;;; File name format:
856 (defconst tramp-remote-file-name-spec-regexp
858 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
859 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
860 "\\(" "\\(?:" tramp-host-regexp "\\|"
861 tramp-prefix-ipv6-regexp "\\(?:" tramp-ipv6-regexp "\\)?"
862 tramp-postfix-ipv6-regexp "\\)"
863 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
864 "Regular expression matching a Tramp file name between prefix and postfix.")
866 (defconst tramp-file-name-structure
870 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
871 tramp-postfix-hop-regexp "\\)+" "\\)?"
872 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
873 "\\(" tramp-localname-regexp "\\)")
875 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
876 the Tramp file name structure.
878 The first element REGEXP is a regular expression matching a Tramp file
879 name. The regex should contain parentheses around the method name,
880 the user name, the host name, and the file name parts.
882 The second element METHOD is a number, saying which pair of
883 parentheses matches the method name. The third element USER is
884 similar, but for the user name. The fourth element HOST is similar,
885 but for the host name. The fifth element FILE is for the file name.
886 The last element HOP is the ad-hoc hop definition, which could be a
887 cascade of several hops.
889 These numbers are passed directly to `match-string', which see. That
890 means the opening parentheses are counted to identify the pair.
892 See also `tramp-file-name-regexp'.")
895 (defconst tramp-file-name-regexp-unified
896 (if (memq system-type '(cygwin windows-nt))
897 "\\`/\\(\\[.*\\]\\|[^/|:]\\{2,\\}[^/|]*\\):"
899 "Value for `tramp-file-name-regexp' for unified remoting.
900 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
901 Tramp. See `tramp-file-name-structure' for more explanations.
903 On W32 systems, the volume letter must be ignored.")
906 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
907 "Value for `tramp-file-name-regexp' for separate remoting.
908 XEmacs uses a separate filename syntax for Tramp and EFS.
909 See `tramp-file-name-structure' for more explanations.")
912 (defconst tramp-file-name-regexp
913 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
914 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
915 (t (error "Wrong `tramp-syntax' defined")))
916 "Regular expression matching file names handled by Tramp.
917 This regexp should match Tramp file names but no other file names.
918 When tramp.el is loaded, this regular expression is prepended to
919 `file-name-handler-alist', and that is searched sequentially. Thus,
920 if the Tramp entry appears rather early in the `file-name-handler-alist'
921 and is a bit too general, then some files might be considered Tramp
922 files which are not really Tramp files.
924 Please note that the entry in `file-name-handler-alist' is made when
925 this file \(tramp.el\) is loaded. This means that this variable must be set
926 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
927 updated after changing this variable.
929 Also see `tramp-file-name-structure'.")
932 (defconst tramp-completion-file-name-regexp-unified
933 (if (memq system-type '(cygwin windows-nt))
934 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
935 "Value for `tramp-completion-file-name-regexp' for unified remoting.
936 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
937 See `tramp-file-name-structure' for more explanations.
939 On W32 systems, the volume letter must be ignored.")
942 (defconst tramp-completion-file-name-regexp-separate
943 "\\`/\\([[][^]]*\\)?\\'"
944 "Value for `tramp-completion-file-name-regexp' for separate remoting.
945 XEmacs uses a separate filename syntax for Tramp and EFS.
946 See `tramp-file-name-structure' for more explanations.")
949 (defconst tramp-completion-file-name-regexp
950 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
951 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
952 (t (error "Wrong `tramp-syntax' defined")))
953 "Regular expression matching file names handled by Tramp completion.
954 This regexp should match partial Tramp file names only.
956 Please note that the entry in `file-name-handler-alist' is made when
957 this file \(tramp.el\) is loaded. This means that this variable must be set
958 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
959 updated after changing this variable.
961 Also see `tramp-file-name-structure'.")
963 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
964 ;; known to have a bug in `process-send-string'; some ssh connections appear
965 ;; to drop bytes when data is sent too quickly. There is also a connection
966 ;; buffer local variable, which is computed depending on remote host properties
967 ;; when `tramp-chunksize' is zero or nil.
968 (defcustom tramp-chunksize
969 (when (and (not (featurep 'xemacs))
970 (memq system-type '(hpux)))
972 ;; Parentheses in docstring starting at beginning of line are escaped.
973 ;; Fontification is messed up when
974 ;; `open-paren-in-column-0-is-defun-start' set to t.
975 "If non-nil, chunksize for sending input to local process.
976 It is necessary only on systems which have a buggy `process-send-string'
977 implementation. The necessity, whether this variable must be set, can be
978 checked via the following code:
981 (let* ((user \"xxx\") (host \"yyy\")
983 (sent init) (received init))
984 (while (= sent received)
985 (setq sent (+ sent step))
987 (let ((proc (start-process (buffer-name) (current-buffer)
988 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
989 (when (memq (process-status proc) '(run open))
990 (process-send-string proc (make-string sent ?\\ ))
991 (process-send-eof proc)
992 (process-send-eof proc))
993 (while (not (progn (goto-char (point-min))
994 (re-search-forward \"\\\\w+\" (point-max) t)))
995 (accept-process-output proc 1))
996 (when (memq (process-status proc) '(run open))
997 (setq received (string-to-number (match-string 0)))
998 (delete-process proc)
999 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1001 (if (> sent (+ init step))
1002 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1004 (message \"Test does not work\")
1005 (display-buffer (current-buffer))
1008 In the Emacs normally running Tramp, evaluate the above code
1009 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1010 respectively\). You can do this, for example, by pasting it into
1011 the `*scratch*' buffer and then hitting C-j with the cursor after the
1012 last closing parenthesis. Note that it works only if you have configured
1013 \"ssh\" to run without password query, see ssh-agent\(1\).
1015 You will see the number of bytes sent successfully to the remote host.
1016 If that number exceeds 1000, you can stop the execution by hitting
1017 C-g, because your Emacs is likely clean.
1019 When it is necessary to set `tramp-chunksize', you might consider to
1020 use an out-of-the-band method \(like \"scp\"\) instead of an internal one
1021 \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases
1024 If your Emacs is buggy, the code stops and gives you an indication
1025 about the value `tramp-chunksize' should be set. Maybe you could just
1026 experiment a bit, e.g. changing the values of `init' and `step'
1027 in the third line of the code.
1029 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1030 this variable to be set as well."
1032 :type '(choice (const nil) integer))
1034 ;; Logging in to a remote host normally requires obtaining a pty. But
1035 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1036 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1037 ;; for an override of the system default.
1038 (defcustom tramp-process-connection-type t
1039 "Overrides `process-connection-type' for connections from Tramp.
1040 Tramp binds `process-connection-type' to the value given here before
1041 opening a connection to a remote host."
1043 :type '(choice (const nil) (const t) (const pty)))
1045 (defcustom tramp-connection-timeout 60
1046 "Defines the max time to wait for establishing a connection (in seconds).
1047 This can be overwritten for different connection types in `tramp-methods'."
1052 (defcustom tramp-connection-min-time-diff 5
1053 "Defines seconds between two consecutive connection attempts.
1054 This is necessary as self defense mechanism, in order to avoid
1055 yo-yo connection attempts when the remote host is unavailable.
1057 A value of 0 or `nil' suppresses this check. This might be
1058 necessary, when several out-of-order copy operations are
1059 performed, or when several asynchronous processes will be started
1060 in a short time frame. In those cases it is recommended to
1061 let-bind this variable."
1064 :type '(choice (const nil) integer))
1066 (defcustom tramp-completion-reread-directory-timeout 10
1067 "Defines seconds since last remote command before rereading a directory.
1068 A remote directory might have changed its contents. In order to
1069 make it visible during file name completion in the minibuffer,
1070 Tramp flushes its cache and rereads the directory contents when
1071 more than `tramp-completion-reread-directory-timeout' seconds
1072 have been gone since last remote command execution. A value of `t'
1073 would require an immediate reread during filename completion, `nil'
1074 means to use always cached values for the directory contents."
1076 :type '(choice (const nil) (const t) integer))
1078 ;;; Internal Variables:
1080 (defvar tramp-current-method nil
1081 "Connection method for this *tramp* buffer.")
1083 (defvar tramp-current-user nil
1084 "Remote login name for this *tramp* buffer.")
1086 (defvar tramp-current-host nil
1087 "Remote host for this *tramp* buffer.")
1089 (defvar tramp-current-connection nil
1090 "Last connection timestamp.")
1093 (defconst tramp-completion-file-name-handler-alist
1094 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1095 (file-name-completion . tramp-completion-handle-file-name-completion))
1096 "Alist of completion handler functions.
1097 Used for file names matching `tramp-file-name-regexp'. Operations
1098 not mentioned here will be handled by Tramp's file name handler
1099 functions, or the normal Emacs functions.")
1101 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1102 ;;;###tramp-autoload
1103 (defvar tramp-foreign-file-name-handler-alist nil
1104 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1105 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1108 ;;; Internal functions which must come first:
1110 (defsubst tramp-user-error (vec-or-proc format &rest args)
1111 "Signal a pilot error."
1113 'tramp-error vec-or-proc
1114 (if (fboundp 'user-error) 'user-error 'error) format args))
1116 ;; Conversion functions between external representation and
1117 ;; internal data structure. Convenience functions for internal
1120 (defun tramp-get-method-parameter (method param)
1121 "Return the method parameter PARAM.
1122 If the `tramp-methods' entry does not exist, return nil."
1123 (let ((entry (assoc param (assoc method tramp-methods))))
1124 (when entry (cadr entry))))
1126 (defun tramp-file-name-p (vec)
1127 "Check, whether VEC is a Tramp object."
1128 (and (vectorp vec) (= 5 (length vec))))
1130 (defun tramp-file-name-method (vec)
1131 "Return method component of VEC."
1132 (and (tramp-file-name-p vec) (aref vec 0)))
1134 (defun tramp-file-name-user (vec)
1135 "Return user component of VEC."
1136 (and (tramp-file-name-p vec) (aref vec 1)))
1138 (defun tramp-file-name-host (vec)
1139 "Return host component of VEC."
1140 (and (tramp-file-name-p vec) (aref vec 2)))
1142 (defun tramp-file-name-localname (vec)
1143 "Return localname component of VEC."
1144 (and (tramp-file-name-p vec) (aref vec 3)))
1146 (defun tramp-file-name-hop (vec)
1147 "Return hop component of VEC."
1148 (and (tramp-file-name-p vec) (aref vec 4)))
1150 ;; The user part of a Tramp file name vector can be of kind
1151 ;; "user%domain". Sometimes, we must extract these parts.
1152 (defun tramp-file-name-real-user (vec)
1153 "Return the user name of VEC without domain."
1155 (let ((user (tramp-file-name-user vec)))
1156 (if (and (stringp user)
1157 (string-match tramp-user-with-domain-regexp user))
1158 (match-string 1 user)
1161 (defun tramp-file-name-domain (vec)
1162 "Return the domain name of VEC."
1164 (let ((user (tramp-file-name-user vec)))
1166 (string-match tramp-user-with-domain-regexp user)
1167 (match-string 2 user)))))
1169 ;; The host part of a Tramp file name vector can be of kind
1170 ;; "host#port". Sometimes, we must extract these parts.
1171 (defun tramp-file-name-real-host (vec)
1172 "Return the host name of VEC without port."
1174 (let ((host (tramp-file-name-host vec)))
1175 (if (and (stringp host)
1176 (string-match tramp-host-with-port-regexp host))
1177 (match-string 1 host)
1180 (defun tramp-file-name-port (vec)
1181 "Return the port number of VEC."
1183 (let ((method (tramp-file-name-method vec))
1184 (host (tramp-file-name-host vec)))
1185 (or (and (stringp host)
1186 (string-match tramp-host-with-port-regexp host)
1187 (string-to-number (match-string 2 host)))
1188 (tramp-get-method-parameter method 'tramp-default-port)))))
1190 ;;;###tramp-autoload
1191 (defun tramp-tramp-file-p (name)
1192 "Return t if NAME is a string with Tramp file name syntax."
1195 (string-match tramp-file-name-regexp name))))
1197 ;; Obsoleted with Tramp 2.2.7.
1198 (defconst tramp-obsolete-methods
1199 '("ssh1" "ssh2" "scp1" "scp2" "scpc" "rsyncc" "plink1")
1200 "Obsolete methods.")
1202 (defvar tramp-warned-obsolete-methods nil
1203 "Which methods the user has been warned to be obsolete.")
1205 (defun tramp-find-method (method user host)
1206 "Return the right method string to use.
1207 This is METHOD, if non-nil. Otherwise, do a lookup in
1208 `tramp-default-method-alist'. It maps also obsolete methods to
1212 (let ((choices tramp-default-method-alist)
1215 (setq item (pop choices))
1216 (when (and (string-match (or (nth 0 item) "") (or host ""))
1217 (string-match (or (nth 1 item) "") (or user "")))
1218 (setq lmethod (nth 2 item))
1219 (setq choices nil)))
1221 tramp-default-method)))
1222 ;; This is needed for a transition period only.
1223 (when (member result tramp-obsolete-methods)
1224 (unless (member result tramp-warned-obsolete-methods)
1226 (warn "Method %s is obsolete, using %s"
1227 result (substring result 0 -1))
1228 (unless (y-or-n-p (format "Method \"%s\" is obsolete, use \"%s\"? "
1229 result (substring result 0 -1)))
1230 (tramp-user-error nil "Method \"%s\" not supported" result)))
1231 (add-to-list 'tramp-warned-obsolete-methods result))
1232 ;; This works with the current set of `tramp-obsolete-methods'.
1233 ;; Must be improved, if their are more sophisticated replacements.
1234 (setq result (substring result 0 -1)))
1235 ;; We must mark, whether a default value has been used. Not
1236 ;; applicable for XEmacs.
1237 (if (or method (null result) (null (functionp 'propertize)))
1239 (tramp-compat-funcall 'propertize result 'tramp-default t))))
1241 (defun tramp-find-user (method user host)
1242 "Return the right user string to use.
1243 This is USER, if non-nil. Otherwise, do a lookup in
1244 `tramp-default-user-alist'."
1247 (let ((choices tramp-default-user-alist)
1250 (setq item (pop choices))
1251 (when (and (string-match (or (nth 0 item) "") (or method ""))
1252 (string-match (or (nth 1 item) "") (or host "")))
1253 (setq luser (nth 2 item))
1254 (setq choices nil)))
1256 tramp-default-user)))
1257 ;; We must mark, whether a default value has been used. Not
1258 ;; applicable for XEmacs.
1259 (if (or user (null result) (null (functionp 'propertize)))
1261 (tramp-compat-funcall 'propertize result 'tramp-default t))))
1263 (defun tramp-find-host (method user host)
1264 "Return the right host string to use.
1265 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1266 (or (and (> (length host) 0) host)
1267 (let ((choices tramp-default-host-alist)
1270 (setq item (pop choices))
1271 (when (and (string-match (or (nth 0 item) "") (or method ""))
1272 (string-match (or (nth 1 item) "") (or user "")))
1273 (setq lhost (nth 2 item))
1274 (setq choices nil)))
1276 tramp-default-host))
1278 (defun tramp-check-proper-method-and-host (vec)
1279 "Check method and host name of VEC."
1280 (let ((method (tramp-file-name-method vec))
1281 (user (tramp-file-name-user vec))
1282 (host (tramp-file-name-host vec))
1283 (methods (mapcar 'car tramp-methods)))
1284 (when (and method (not (member method methods)))
1285 (tramp-cleanup-connection vec)
1286 (tramp-user-error vec "Unknown method \"%s\"" method))
1287 (when (and (equal tramp-syntax 'ftp) host
1288 (or (null method) (get-text-property 0 'tramp-default method))
1289 (or (null user) (get-text-property 0 'tramp-default user))
1290 (member host methods))
1291 (tramp-cleanup-connection vec)
1292 (tramp-user-error vec "Host name must not match method \"%s\"" host))))
1294 (defun tramp-dissect-file-name (name &optional nodefault)
1295 "Return a `tramp-file-name' structure.
1296 The structure consists of remote method, remote user, remote host
1297 and localname (file name on remote host). If NODEFAULT is
1298 non-nil, the file name parts are not expanded to their default
1301 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1302 (unless match (tramp-user-error nil "Not a Tramp file name: \"%s\"" name))
1303 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1304 (user (match-string (nth 2 tramp-file-name-structure) name))
1305 (host (match-string (nth 3 tramp-file-name-structure) name))
1306 (localname (match-string (nth 4 tramp-file-name-structure) name))
1307 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1309 (when (string-match tramp-prefix-ipv6-regexp host)
1310 (setq host (replace-match "" nil t host)))
1311 (when (string-match tramp-postfix-ipv6-regexp host)
1312 (setq host (replace-match "" nil t host))))
1314 (vector method user host localname hop)
1316 (tramp-find-method method user host)
1317 (tramp-find-user method user host)
1318 (tramp-find-host method user host)
1321 (defun tramp-buffer-name (vec)
1322 "A name for the connection buffer VEC."
1323 ;; We must use `tramp-file-name-real-host', because for gateway
1324 ;; methods the default port will be expanded later on, which would
1326 (let ((method (tramp-file-name-method vec))
1327 (user (tramp-file-name-user vec))
1328 (host (tramp-file-name-real-host vec)))
1329 (if (not (zerop (length user)))
1330 (format "*tramp/%s %s@%s*" method user host)
1331 (format "*tramp/%s %s*" method host))))
1333 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1334 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1335 When not nil, an optional HOP is prepended."
1336 (concat tramp-prefix-format hop
1337 (when (not (zerop (length method)))
1338 (concat method tramp-postfix-method-format))
1339 (when (not (zerop (length user)))
1340 (concat user tramp-postfix-user-format))
1342 (if (string-match tramp-ipv6-regexp host)
1343 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1345 tramp-postfix-host-format
1346 (when localname localname)))
1348 (defun tramp-completion-make-tramp-file-name (method user host localname)
1349 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1350 It must not be a complete Tramp file name, but as long as there are
1351 necessary only. This function will be used in file name completion."
1352 (concat tramp-prefix-format
1353 (when (not (zerop (length method)))
1354 (concat method tramp-postfix-method-format))
1355 (when (not (zerop (length user)))
1356 (concat user tramp-postfix-user-format))
1357 (when (not (zerop (length host)))
1359 (if (string-match tramp-ipv6-regexp host)
1361 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1363 tramp-postfix-host-format))
1364 (when localname localname)))
1366 (defun tramp-get-buffer (vec)
1367 "Get the connection buffer to be used for VEC."
1368 (or (get-buffer (tramp-buffer-name vec))
1369 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1370 (setq buffer-undo-list t)
1371 (setq default-directory
1372 (tramp-make-tramp-file-name
1373 (tramp-file-name-method vec)
1374 (tramp-file-name-user vec)
1375 (tramp-file-name-host vec)
1379 (defun tramp-get-connection-buffer (vec)
1380 "Get the connection buffer to be used for VEC.
1381 In case a second asynchronous communication has been started, it is different
1382 from `tramp-get-buffer'."
1383 (or (tramp-get-connection-property vec "process-buffer" nil)
1384 (tramp-get-buffer vec)))
1386 (defun tramp-get-connection-name (vec)
1387 "Get the connection name to be used for VEC.
1388 In case a second asynchronous communication has been started, it is different
1389 from the default one."
1390 (or (tramp-get-connection-property vec "process-name" nil)
1391 (tramp-buffer-name vec)))
1393 (defun tramp-get-connection-process (vec)
1394 "Get the connection process to be used for VEC.
1395 In case a second asynchronous communication has been started, it is different
1396 from the default one."
1397 (get-process (tramp-get-connection-name vec)))
1399 (defun tramp-debug-buffer-name (vec)
1400 "A name for the debug buffer for VEC."
1401 ;; We must use `tramp-file-name-real-host', because for gateway
1402 ;; methods the default port will be expanded later on, which would
1404 (let ((method (tramp-file-name-method vec))
1405 (user (tramp-file-name-user vec))
1406 (host (tramp-file-name-real-host vec)))
1407 (if (not (zerop (length user)))
1408 (format "*debug tramp/%s %s@%s*" method user host)
1409 (format "*debug tramp/%s %s*" method host))))
1411 (defconst tramp-debug-outline-regexp
1412 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1413 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1415 (defun tramp-debug-outline-level ()
1416 "Return the depth to which a statement is nested in the outline.
1417 Point must be at the beginning of a header line.
1419 The outline level is equal to the verbosity of the Tramp message."
1420 (1+ (string-to-number (match-string 1))))
1422 (defun tramp-get-debug-buffer (vec)
1423 "Get the debug buffer for VEC."
1424 (with-current-buffer
1425 (get-buffer-create (tramp-debug-buffer-name vec))
1427 (setq buffer-undo-list t)
1428 ;; So it does not get loaded while `outline-regexp' is let-bound.
1430 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1431 ;; `outline-mode-hook'. We must prevent that local processes
1432 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1433 ;; Furthermore, `outline-regexp' must have the correct value
1434 ;; already, because it is used by `font-lock-compile-keywords'.
1435 (let ((default-directory (tramp-compat-temporary-file-directory))
1436 (outline-regexp tramp-debug-outline-regexp))
1438 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1439 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1442 (defsubst tramp-debug-message (vec fmt-string &rest arguments)
1443 "Append message to debug buffer.
1444 Message is formatted with FMT-STRING as control string and the remaining
1445 ARGUMENTS to actually emit the message (if applicable)."
1446 (with-current-buffer (tramp-get-debug-buffer vec)
1447 (goto-char (point-max))
1452 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1453 (if (featurep 'sxemacs) "SX" (if (featurep 'xemacs) "X" "GNU "))
1454 emacs-version tramp-version)))
1458 (let ((now (current-time)))
1459 (insert (format-time-string "%T." now))
1460 (insert (format "%06d " (nth 2 now))))
1461 ;; Calling Tramp function. We suppress compat and trace functions
1462 ;; from being displayed.
1463 (let ((btn 1) btf fn)
1465 (setq btf (nth 1 (backtrace-frame btn)))
1469 (setq fn (symbol-name btf))
1472 (string-match "^tramp" fn)
1479 "tramp-compat-condition-case-unless-debug"
1480 "tramp-compat-funcall"
1481 "tramp-compat-with-temp-message"
1482 "tramp-condition-case-unless-debug"
1483 "tramp-debug-message"
1485 "tramp-error-with-buffer"
1492 (setq btn (1+ btn))))
1493 ;; The following code inserts filename and line number. Should
1494 ;; be inactive by default, because it is time consuming.
1495 ; (let ((ffn (find-function-noselect (intern fn))))
1499 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1500 ; (with-current-buffer (car ffn)
1501 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1502 (insert (format "%s " fn)))
1504 (insert (apply 'format fmt-string arguments))))
1506 (defvar tramp-message-show-message t
1507 "Show Tramp message in the minibuffer.
1508 This variable is used to disable messages from `tramp-error'.
1509 The messages are visible anyway, because an error is raised.")
1511 (defsubst tramp-message (vec-or-proc level fmt-string &rest arguments)
1512 "Emit a message depending on verbosity level.
1513 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1514 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1515 less than LEVEL. The message is emitted only if `tramp-verbose' is
1516 greater than or equal to LEVEL.
1518 The message is also logged into the debug buffer when `tramp-verbose'
1519 is greater than or equal 4.
1521 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1522 control string and the remaining ARGUMENTS to actually emit the message (if
1525 (when (<= level tramp-verbose)
1526 ;; Match data must be preserved!
1528 ;; Display only when there is a minimum level.
1529 (when (and tramp-message-show-message (<= level 3))
1535 ((= level 2) "Warning: ")
1539 ;; Log only when there is a minimum level.
1540 (when (>= tramp-verbose 4)
1541 ;; Translate proc to vec.
1542 (when (processp vec-or-proc)
1543 (let ((tramp-verbose 0))
1545 (tramp-get-connection-property vec-or-proc "vector" nil))))
1547 (when (vectorp vec-or-proc)
1548 (apply 'tramp-debug-message
1550 (concat (format "(%d) # " level) fmt-string)
1553 (defsubst tramp-backtrace (&optional vec-or-proc)
1554 "Dump a backtrace into the debug buffer.
1555 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1556 function is meant for debugging purposes."
1558 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace)))
1559 (if (>= tramp-verbose 10)
1560 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1562 (defsubst tramp-error (vec-or-proc signal fmt-string &rest arguments)
1564 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1565 signal identifier to be raised, remaining arguments passed to
1566 `tramp-message'. Finally, signal SIGNAL is raised."
1567 (let (tramp-message-show-message)
1568 (tramp-backtrace vec-or-proc)
1572 (error-message-string
1574 (get signal 'error-message)
1575 (apply 'format fmt-string arguments)))))
1576 (signal signal (list (apply 'format fmt-string arguments)))))
1578 (defsubst tramp-error-with-buffer
1579 (buf vec-or-proc signal fmt-string &rest arguments)
1580 "Emit an error, and show BUF.
1581 If BUF is nil, show the connection buf. Wait for 30\", or until
1582 an input event arrives. The other arguments are passed to `tramp-error'."
1583 (save-window-excursion
1584 (let* ((buf (or (and (bufferp buf) buf)
1585 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1586 (and (vectorp vec-or-proc)
1587 (tramp-get-connection-buffer vec-or-proc))))
1588 (vec (or (and (vectorp vec-or-proc) vec-or-proc)
1589 (and buf (with-current-buffer buf
1590 (tramp-dissect-file-name default-directory))))))
1592 (apply 'tramp-error vec-or-proc signal fmt-string arguments)
1595 tramp-message-show-message
1596 (not (zerop tramp-verbose))
1597 (not (tramp-completion-mode-p)))
1598 (let ((enable-recursive-minibuffers t))
1599 ;; `tramp-error' does not show messages. So we must do it
1601 (message fmt-string arguments)
1606 ;; Reset timestamp. It would be wrong after waiting for a while.
1607 (when (equal (butlast (append vec nil) 2)
1608 (car tramp-current-connection))
1609 (setcdr tramp-current-connection (current-time)))))))
1611 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1612 "Parse a Tramp filename and make components available in the body.
1614 First arg FILENAME is evaluated and dissected into its components.
1615 Second arg VAR is a symbol. It is used as a variable name to hold
1616 the filename structure. It is also used as a prefix for the variables
1617 holding the components. For example, if VAR is the symbol `foo', then
1618 `foo' will be bound to the whole structure, `foo-method' will be bound to
1619 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1622 Remaining args are Lisp expressions to be evaluated (inside an implicit
1625 If VAR is nil, then we bind `v' to the structure and `method', `user',
1626 `host', `localname', `hop' to the components."
1628 (mapcar (lambda (elem)
1629 `(,(if var (intern (format "%s-%s" var elem)) elem)
1630 (,(intern (format "tramp-file-name-%s" elem))
1632 '(method user host localname hop))))
1633 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1635 ;; We don't know which of those vars will be used, so we bind them all,
1636 ;; and then add here a dummy use of all those variables, so we don't get
1637 ;; flooded by warnings about those vars `body' didn't use.
1638 (ignore ,@(mapcar #'car bindings))
1641 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1642 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1643 (tramp-compat-font-lock-add-keywords
1644 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1646 (defun tramp-progress-reporter-update (reporter &optional value)
1647 (let* ((parameters (cdr reporter))
1648 (message (aref parameters 3)))
1649 (when (string-match message (or (current-message) ""))
1650 (tramp-compat-funcall 'progress-reporter-update reporter value))))
1652 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1653 "Executes BODY, spinning a progress reporter with MESSAGE.
1654 If LEVEL does not fit for visible messages, there are only traces
1655 without a visible progress reporter."
1656 (declare (indent 3) (debug t))
1658 (tramp-message ,vec ,level "%s..." ,message)
1659 (let ((cookie "failed")
1661 ;; We start a pulsing progress reporter after 3 seconds. Feature
1662 ;; introduced in Emacs 24.1.
1663 (when (and tramp-message-show-message
1664 ;; Display only when there is a minimum level.
1665 (<= ,level (min tramp-verbose 3)))
1667 (let ((pr (tramp-compat-funcall
1668 #'make-progress-reporter ,message)))
1671 #'tramp-progress-reporter-update pr)))))))
1673 ;; Execute the body.
1674 (prog1 (progn ,@body) (setq cookie "done"))
1675 ;; Stop progress reporter.
1676 (if tm (tramp-compat-funcall 'cancel-timer tm))
1677 (tramp-message ,vec ,level "%s...%s" ,message cookie)))))
1679 (tramp-compat-font-lock-add-keywords
1680 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1682 (defmacro with-tramp-file-property (vec file property &rest body)
1683 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1684 FILE must be a local file name on a connection identified via VEC."
1685 `(if (file-name-absolute-p ,file)
1686 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1687 (when (eq value 'undef)
1688 ;; We cannot pass @body as parameter to
1689 ;; `tramp-set-file-property' because it mangles our
1691 (setq value (progn ,@body))
1692 (tramp-set-file-property ,vec ,file ,property value))
1696 (put 'with-tramp-file-property 'lisp-indent-function 3)
1697 (put 'with-tramp-file-property 'edebug-form-spec t)
1698 (tramp-compat-font-lock-add-keywords
1699 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1701 (defmacro with-tramp-connection-property (key property &rest body)
1702 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1703 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1704 (when (eq value 'undef)
1705 ;; We cannot pass ,@body as parameter to
1706 ;; `tramp-set-connection-property' because it mangles our debug
1708 (setq value (progn ,@body))
1709 (tramp-set-connection-property ,key ,property value))
1712 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1713 (put 'with-tramp-connection-property 'edebug-form-spec t)
1714 (tramp-compat-font-lock-add-keywords
1715 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1717 (defun tramp-drop-volume-letter (name)
1718 "Cut off unnecessary drive letter from file NAME.
1719 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1720 locally on a remote file name. When the local system is a W32 system
1721 but the remote system is Unix, this introduces a superfluous drive
1722 letter into the file name. This function removes it."
1724 (if (string-match "\\`[a-zA-Z]:/" name)
1725 (replace-match "/" nil t name)
1728 ;;; Config Manipulation Functions:
1730 ;;;###tramp-autoload
1731 (defun tramp-set-completion-function (method function-list)
1732 "Sets the list of completion functions for METHOD.
1733 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1734 The FUNCTION is intended to parse FILE according its syntax.
1735 It might be a predefined FUNCTION, or a user defined FUNCTION.
1736 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1740 (tramp-set-completion-function
1742 '((tramp-parse-sconfig \"/etc/ssh_config\")
1743 (tramp-parse-sconfig \"~/.ssh/config\")))"
1745 (let ((r function-list)
1747 (setq tramp-completion-function-alist
1748 (delete (assoc method tramp-completion-function-alist)
1749 tramp-completion-function-alist))
1752 ;; Remove double entries.
1753 (when (member (car v) (cdr v))
1754 (setcdr v (delete (car v) (cdr v))))
1755 ;; Check for function and file or registry key.
1756 (unless (and (functionp (nth 0 (car v)))
1757 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1758 ;; Windows registry.
1759 (and (memq system-type '(cygwin windows-nt))
1762 "reg" nil nil nil "query" (nth 1 (car v)))))
1763 ;; Configuration file.
1764 (file-exists-p (nth 1 (car v)))))
1765 (setq r (delete (car v) r)))
1769 (add-to-list 'tramp-completion-function-alist
1772 (defun tramp-get-completion-function (method)
1773 "Returns a list of completion functions for METHOD.
1774 For definition of that list see `tramp-set-completion-function'."
1776 ;; Hosts visited once shall be remembered.
1777 `(tramp-parse-connection-properties ,method)
1778 ;; The method related defaults.
1779 (cdr (assoc method tramp-completion-function-alist))))
1782 ;;; Fontification of `read-file-name':
1784 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1785 (defvar tramp-rfn-eshadow-overlay)
1786 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1788 (defun tramp-rfn-eshadow-setup-minibuffer ()
1789 "Set up a minibuffer for `file-name-shadow-mode'.
1790 Adds another overlay hiding filename parts according to Tramp's
1791 special handling of `substitute-in-file-name'."
1792 (when (symbol-value 'minibuffer-completing-file-name)
1793 (setq tramp-rfn-eshadow-overlay
1794 (tramp-compat-funcall
1796 (tramp-compat-funcall 'minibuffer-prompt-end)
1797 (tramp-compat-funcall 'minibuffer-prompt-end)))
1798 ;; Copy rfn-eshadow-overlay properties.
1799 (let ((props (tramp-compat-funcall
1800 'overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1802 ;; The `field' property prevents correct minibuffer
1803 ;; completion; we exclude it.
1804 (if (not (eq (car props) 'field))
1805 (tramp-compat-funcall
1806 'overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1807 (pop props) (pop props))))))
1809 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
1810 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1811 'tramp-rfn-eshadow-setup-minibuffer)
1812 (add-hook 'tramp-unload-hook
1814 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1815 'tramp-rfn-eshadow-setup-minibuffer))))
1817 (defconst tramp-rfn-eshadow-update-overlay-regexp
1818 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1820 (defun tramp-rfn-eshadow-update-overlay ()
1821 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1822 This is intended to be used as a minibuffer `post-command-hook' for
1823 `file-name-shadow-mode'; the minibuffer should have already
1824 been set up by `rfn-eshadow-setup-minibuffer'."
1825 ;; In remote files name, there is a shadowing just for the local part.
1827 (let ((end (or (tramp-compat-funcall
1828 'overlay-end (symbol-value 'rfn-eshadow-overlay))
1829 (tramp-compat-funcall 'minibuffer-prompt-end)))
1830 ;; We do not want to send any remote command.
1834 (tramp-compat-funcall
1835 'buffer-substring-no-properties end (point-max)))
1839 (1+ (or (string-match
1840 tramp-rfn-eshadow-update-overlay-regexp
1841 (buffer-string) end)
1844 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1845 (rfn-eshadow-update-overlay-hook nil)
1846 file-name-handler-alist)
1847 (tramp-compat-funcall
1848 'move-overlay rfn-eshadow-overlay (point-max) (point-max))
1849 (tramp-compat-funcall 'rfn-eshadow-update-overlay))))))))
1851 (when (boundp 'rfn-eshadow-update-overlay-hook)
1852 (add-hook 'rfn-eshadow-update-overlay-hook
1853 'tramp-rfn-eshadow-update-overlay)
1854 (add-hook 'tramp-unload-hook
1856 (remove-hook 'rfn-eshadow-update-overlay-hook
1857 'tramp-rfn-eshadow-update-overlay))))
1859 ;; Inodes don't exist for some file systems. Therefore we must
1860 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1861 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1862 ;; performance isn't the major issue given that file transfer will
1864 (defvar tramp-inodes 0
1865 "Keeps virtual inodes numbers.")
1867 ;; Devices must distinguish physical file systems. The device numbers
1868 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1869 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1870 ;; EFS use device number "-1". In order to be different, we use device number
1871 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1872 (defvar tramp-devices 0
1873 "Keeps virtual device numbers.")
1875 (defun tramp-default-file-modes (filename)
1876 "Return file modes of FILENAME as integer.
1877 If the file modes of FILENAME cannot be determined, return the
1878 value of `default-file-modes', without execute permissions."
1879 (or (file-modes filename)
1880 (logand (default-file-modes) (tramp-compat-octal-to-decimal "0666"))))
1882 (defun tramp-replace-environment-variables (filename)
1883 "Replace environment variables in FILENAME.
1884 Return the string with the replaced variables."
1886 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1887 ;; We need an own implementation.
1889 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1890 ;; `$' is coded as `$$'.
1892 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1893 (getenv (match-string 1 filename)))
1896 (substitute-in-file-name (match-string 0 filename))
1900 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
1901 ;; which calls corresponding functions (see minibuf.el).
1902 (when (fboundp 'minibuffer-electric-separator)
1907 (around ,(intern (format "tramp-advice-%s" x)) activate)
1908 "Invoke `substitute-in-file-name' for Tramp files."
1909 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
1910 (tramp-tramp-file-p (buffer-substring)))
1911 ;; We don't need to handle `last-input-event', because
1912 ;; due to the key map we know it must be ?/ or ?~.
1913 (let ((s (concat (buffer-substring (point-min) (point))
1914 (string last-command-char))))
1915 (delete-region (point-min) (point))
1916 (insert (substitute-in-file-name s))
1917 (setq ad-return-value last-command-char))
1923 (ad-remove-advice ',x 'around ',(intern (format "tramp-advice-%s" x)))
1924 (ad-activate ',x)))))
1926 '(minibuffer-electric-separator
1927 minibuffer-electric-tilde)))
1929 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1930 "Like `find-operation-coding-system' for Tramp filenames.
1931 Tramp's `insert-file-contents' and `write-region' work over
1932 temporary file names. If `file-coding-system-alist' contains an
1933 expression, which matches more than the file name suffix, the
1934 coding system might not be determined. This function repairs it."
1936 (dolist (elt file-coding-system-alist result)
1937 (when (and (consp elt) (string-match (car elt) filename))
1938 ;; We found a matching entry in `file-coding-system-alist'.
1939 ;; So we add a similar entry, but with the temporary file name
1942 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1945 (progn (defun tramp-run-real-handler (operation args)
1946 "Invoke normal file name handler for OPERATION.
1947 First arg specifies the OPERATION, second arg is a list of arguments to
1948 pass to the OPERATION."
1949 (let* ((inhibit-file-name-handlers
1950 `(tramp-file-name-handler
1951 tramp-vc-file-name-handler
1952 tramp-completion-file-name-handler
1953 cygwin-mount-name-hook-function
1954 cygwin-mount-map-drive-hook-function
1956 ,(and (eq inhibit-file-name-operation operation)
1957 inhibit-file-name-handlers)))
1958 (inhibit-file-name-operation operation))
1959 (apply operation args))))
1962 (progn (defun tramp-completion-run-real-handler (operation args)
1963 "Invoke `tramp-file-name-handler' for OPERATION.
1964 First arg specifies the OPERATION, second arg is a list of arguments to
1965 pass to the OPERATION."
1966 (let* ((inhibit-file-name-handlers
1967 `(tramp-completion-file-name-handler
1968 cygwin-mount-name-hook-function
1969 cygwin-mount-map-drive-hook-function
1971 ,(and (eq inhibit-file-name-operation operation)
1972 inhibit-file-name-handlers)))
1973 (inhibit-file-name-operation operation))
1974 (apply operation args))))
1976 ;; We handle here all file primitives. Most of them have the file
1977 ;; name as first parameter; nevertheless we check for them explicitly
1978 ;; in order to be signaled if a new primitive appears. This
1979 ;; scenario is needed because there isn't a way to decide by
1980 ;; syntactical means whether a foreign method must be called. It would
1981 ;; ease the life if `file-name-handler-alist' would support a decision
1982 ;; function as well but regexp only.
1983 (defun tramp-file-name-for-operation (operation &rest args)
1984 "Return file name related to OPERATION file primitive.
1985 ARGS are the arguments OPERATION has been called with."
1987 ;; FILE resp DIRECTORY.
1989 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
1990 'delete-file 'diff-latest-backup-file 'directory-file-name
1991 'directory-files 'directory-files-and-attributes
1992 'dired-compress-file 'dired-uncache
1993 'file-accessible-directory-p 'file-attributes
1994 'file-directory-p 'file-executable-p 'file-exists-p
1995 'file-local-copy 'file-modes
1996 'file-name-as-directory 'file-name-directory
1997 'file-name-nondirectory 'file-name-sans-versions
1998 'file-ownership-preserved-p 'file-readable-p
1999 'file-regular-p 'file-remote-p 'file-symlink-p 'file-truename
2000 'file-writable-p 'find-backup-file-name 'find-file-noselect
2001 'get-file-buffer 'insert-directory 'insert-file-contents
2002 'load 'make-directory 'make-directory-internal
2003 'set-file-modes 'substitute-in-file-name
2004 'unhandled-file-name-directory 'vc-registered
2008 'file-acl 'file-notify-add-watch
2009 'file-selinux-context 'set-file-acl 'set-file-selinux-context
2011 'abbreviate-file-name 'create-file-buffer
2012 'dired-file-modtime 'dired-make-compressed-filename
2013 'dired-recursive-delete-directory 'dired-set-file-modtime
2014 'dired-shell-unhandle-file-name 'dired-uucode-file
2015 'insert-file-contents-literally 'make-temp-name 'recover-file
2016 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
2017 (if (file-name-absolute-p (nth 0 args))
2019 (expand-file-name (nth 0 args))))
2020 ;; FILE DIRECTORY resp FILE1 FILE2.
2022 (list 'add-name-to-file 'copy-file 'expand-file-name
2023 'file-name-all-completions 'file-name-completion
2024 'file-newer-than-file-p 'make-symbolic-link 'rename-file
2028 'file-equal-p 'file-in-directory-p
2030 'dired-make-relative-symlink
2031 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
2034 ((tramp-tramp-file-p (nth 0 args)) (nth 0 args))
2035 ((tramp-tramp-file-p (nth 1 args)) (nth 1 args))
2036 (t (buffer-file-name (current-buffer))))))
2038 ((eq operation 'write-region)
2042 (list 'set-visited-file-modtime 'verify-visited-file-modtime
2044 'make-auto-save-file-name
2048 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
2051 (list ;; not in Emacs 23+.
2060 'dired-print-file 'dired-shell-call-process))
2063 ((eq operation 'file-notify-rm-watch)
2064 (when (processp (nth 0 args))
2065 (with-current-buffer (process-buffer (nth 0 args))
2066 default-directory)))
2067 ;; Unknown file primitive.
2068 (t (error "unknown file I/O primitive: %s" operation))))
2070 (defun tramp-find-foreign-file-name-handler (filename)
2071 "Return foreign file name handler if exists."
2072 (when (tramp-tramp-file-p filename)
2073 (let ((v (tramp-dissect-file-name filename t))
2074 (handler tramp-foreign-file-name-handler-alist)
2076 ;; When we are not fully sure that filename completion is safe,
2077 ;; we should not return a handler.
2078 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
2079 (and (tramp-file-name-host v)
2080 (not (member (tramp-file-name-host v)
2081 (mapcar 'car tramp-methods))))
2082 (not (tramp-completion-mode-p)))
2084 (setq elt (car handler)
2085 handler (cdr handler))
2086 (when (funcall (car elt) filename)
2091 (defvar tramp-debug-on-error nil
2092 "Like `debug-on-error' but used Tramp internal.")
2094 (defmacro tramp-condition-case-unless-debug
2095 (var bodyform &rest handlers)
2096 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
2097 `(let ((debug-on-error tramp-debug-on-error))
2098 (tramp-compat-condition-case-unless-debug ,var ,bodyform ,@handlers)))
2102 (defun tramp-file-name-handler (operation &rest args)
2103 "Invoke Tramp file name handler.
2104 Falls back to normal file name handler if no Tramp file name handler exists."
2108 (tramp-replace-environment-variables
2109 (apply 'tramp-file-name-for-operation operation args)))
2110 (completion (tramp-completion-mode-p))
2111 (foreign (tramp-find-foreign-file-name-handler filename)))
2112 (with-parsed-tramp-file-name filename nil
2113 ;; Call the backend function.
2115 (tramp-condition-case-unless-debug err
2116 (let ((sf (symbol-function foreign))
2118 ;; Some packages set the default directory to a
2119 ;; remote path, before respective Tramp packages
2120 ;; are already loaded. This results in
2121 ;; recursive loading. Therefore, we load the
2122 ;; Tramp packages locally.
2123 (when (and (listp sf) (eq (car sf) 'autoload))
2124 (let ((default-directory
2125 (tramp-compat-temporary-file-directory)))
2126 (load (cadr sf) 'noerror 'nomessage)))
2127 ;; If `non-essential' is non-nil, Tramp shall
2128 ;; not open a new connection.
2129 ;; If Tramp detects that it shouldn't continue
2130 ;; to work, it throws the `suppress' event.
2131 ;; This could happen for example, when Tramp
2132 ;; tries to open the same connection twice in a
2133 ;; short time frame.
2134 ;; In both cases, we try the default handler then.
2136 (catch 'non-essential
2138 (apply foreign operation args))))
2140 ((eq result 'non-essential)
2142 v 5 "Non-essential received in operation %s"
2143 (append (list operation) args))
2144 (tramp-run-real-handler operation args))
2145 ((eq result 'suppress)
2146 (let (tramp-message-show-message)
2148 v 1 "Suppress received in operation %s"
2149 (append (list operation) args))
2150 (tramp-cleanup-connection v t)
2151 (tramp-run-real-handler operation args)))
2154 ;; Trace that somebody has interrupted the operation.
2156 (let (tramp-message-show-message)
2158 v 1 "Interrupt received in operation %s"
2159 (append (list operation) args)))
2160 ;; Propagate the quit signal.
2161 (signal (car err) (cdr err)))
2163 ;; When we are in completion mode, some failed
2164 ;; operations shall return at least a default value
2165 ;; in order to give the user a chance to correct the
2166 ;; file name in the minibuffer.
2167 ;; In order to get a full backtrace, one could apply
2168 ;; (setq tramp-debug-on-error t)
2171 ((and completion (zerop (length localname))
2172 (memq operation '(file-exists-p file-directory-p)))
2174 ((and completion (zerop (length localname))
2176 '(expand-file-name file-name-as-directory)))
2178 ;; Propagate the error.
2179 (t (signal (car err) (cdr err))))))
2181 ;; Nothing to do for us.
2182 (tramp-run-real-handler operation args)))))
2184 ;; When `tramp-mode' is not enabled, we don't do anything.
2185 (tramp-run-real-handler operation args)))
2187 ;; In Emacs, there is some concurrency due to timers. If a timer
2188 ;; interrupts Tramp and wishes to use the same connection buffer as
2189 ;; the "main" Emacs, then garbage might occur in the connection
2190 ;; buffer. Therefore, we need to make sure that a timer does not use
2191 ;; the same connection buffer as the "main" Emacs. We implement a
2192 ;; cheap global lock, instead of locking each connection buffer
2193 ;; separately. The global lock is based on two variables,
2194 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2195 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2196 ;; processing of a single file operation, so we need to allow
2197 ;; recursive calls. That's where the `tramp-locker' variable comes in
2198 ;; -- it is let-bound to t during the execution of the current
2199 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2200 ;; then we should just proceed because we have been called
2201 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2202 ;; interrupting the "main" Emacs, and then we signal an error.
2204 (defvar tramp-locked nil
2205 "If non-nil, then Tramp is currently busy.
2206 Together with `tramp-locker', this implements a locking mechanism
2207 preventing reentrant calls of Tramp.")
2209 (defvar tramp-locker nil
2210 "If non-nil, then a caller has locked Tramp.
2211 Together with `tramp-locked', this implements a locking mechanism
2212 preventing reentrant calls of Tramp.")
2215 (progn (defun tramp-completion-file-name-handler (operation &rest args)
2216 "Invoke Tramp file name completion handler.
2217 Falls back to normal file name handler if no Tramp file name handler exists."
2218 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
2219 ;; would otherwise use backslash.
2220 (let ((directory-sep-char ?/)
2221 (fn (assoc operation tramp-completion-file-name-handler-alist)))
2223 ;; When `tramp-mode' is not enabled, we don't do anything.
2225 ;; For other syntaxes than `sep', the regexp matches many common
2226 ;; situations where the user doesn't actually want to use Tramp.
2227 ;; So to avoid autoloading Tramp after typing just "/s", we
2228 ;; disable this part of the completion, unless the user implicitly
2229 ;; indicated his interest in using a fancier completion system.
2230 (or (eq tramp-syntax 'sep)
2231 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2232 ;; `partial-completion-mode' does not exist in XEmacs.
2233 ;; It is obsoleted with Emacs 24.1.
2234 (and (boundp 'partial-completion-mode)
2235 (symbol-value 'partial-completion-mode))
2236 ;; FIXME: These may have been loaded even if the user never
2237 ;; intended to use them.
2239 (featurep 'icicles)))
2240 (save-match-data (apply (cdr fn) args))
2241 (tramp-completion-run-real-handler operation args)))))
2244 (progn (defun tramp-register-file-name-handlers ()
2245 "Add Tramp file name handlers to `file-name-handler-alist'."
2246 ;; Remove autoloaded handlers from file name handler alist. Useful,
2247 ;; if `tramp-syntax' has been changed.
2248 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
2249 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
2251 'tramp-completion-file-name-handler file-name-handler-alist)))
2252 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
2253 ;; Add the handlers.
2254 (add-to-list 'file-name-handler-alist
2255 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2256 (put 'tramp-file-name-handler 'safe-magic t)
2257 (add-to-list 'file-name-handler-alist
2258 (cons tramp-completion-file-name-regexp
2259 'tramp-completion-file-name-handler))
2260 (put 'tramp-completion-file-name-handler 'safe-magic t)
2261 ;; If jka-compr or epa-file are already loaded, move them to the
2262 ;; front of `file-name-handler-alist'.
2263 (dolist (fnh '(epa-file-handler jka-compr-handler))
2264 (let ((entry (rassoc fnh file-name-handler-alist)))
2266 (setq file-name-handler-alist
2267 (cons entry (delete entry file-name-handler-alist))))))))
2269 ;; `tramp-file-name-handler' must be registered before evaluation of
2270 ;; site-start and init files, because there might exist remote files
2271 ;; already, f.e. files kept via recentf-mode.
2273 (tramp-register-file-name-handlers)
2275 (defun tramp-exists-file-name-handler (operation &rest args)
2276 "Check, whether OPERATION runs a file name handler."
2277 ;; The file name handler is determined on base of either an
2278 ;; argument, `buffer-file-name', or `default-directory'.
2280 (let* ((buffer-file-name "/")
2281 (default-directory "/")
2282 (fnha file-name-handler-alist)
2283 (check-file-name-operation operation)
2284 (file-name-handler-alist
2287 (lambda (operation &rest args)
2288 "Returns OPERATION if it is the one to be checked."
2289 (if (equal check-file-name-operation operation)
2291 (let ((file-name-handler-alist fnha))
2292 (apply operation args))))))))
2293 (equal (apply operation args) operation))))
2296 (defun tramp-unload-file-name-handlers ()
2297 (setq file-name-handler-alist
2298 (delete (rassoc 'tramp-file-name-handler
2299 file-name-handler-alist)
2300 (delete (rassoc 'tramp-completion-file-name-handler
2301 file-name-handler-alist)
2302 file-name-handler-alist))))
2304 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2306 ;;; File name handler functions for completion mode:
2308 (defvar tramp-completion-mode nil
2309 "If non-nil, external packages signal that they are in file name completion.
2311 This is necessary, because Tramp uses a heuristic depending on last
2312 input event. This fails when external packages use other characters
2313 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2314 should never be set globally, the intention is to let-bind it.")
2316 ;; Necessary because `tramp-file-name-regexp-unified' and
2317 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2318 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2319 ;; to `tramp-file-name-handler'). Otherwise, it takes
2320 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2321 ;; risky, because completing a file might require loading other files,
2322 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2323 ;; variable. On the other hand, those files shouldn't have partial
2324 ;; Tramp file name syntax. Maybe another variable should be introduced
2325 ;; overwriting this check in such cases. Or we change Tramp file name
2326 ;; syntax in order to avoid ambiguities, like in XEmacs ...
2327 ;;;###tramp-autoload
2328 (defun tramp-completion-mode-p ()
2329 "Check, whether method / user name / host name completion is active."
2331 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2332 (and (boundp 'non-essential) (symbol-value 'non-essential))
2333 tramp-completion-mode
2335 (equal last-input-event 'tab)
2336 (and (natnump last-input-event)
2338 ;; ?\t has event-modifier 'control.
2339 (equal last-input-event ?\t)
2340 (and (not (event-modifiers last-input-event))
2341 (or (equal last-input-event ?\?)
2342 (equal last-input-event ?\ )))))
2344 (and (featurep 'xemacs)
2345 ;; `last-input-event' might be nil.
2346 (not (null last-input-event))
2347 ;; `last-input-event' may have no character approximation.
2348 (tramp-compat-funcall 'event-to-character last-input-event)
2350 ;; ?\t has event-modifier 'control.
2352 (tramp-compat-funcall 'event-to-character last-input-event) ?\t)
2353 (and (not (event-modifiers last-input-event))
2355 (tramp-compat-funcall 'event-to-character last-input-event)
2358 (tramp-compat-funcall 'event-to-character last-input-event)
2361 (defun tramp-connectable-p (filename)
2362 "Check, whether it is possible to connect the remote host w/o side-effects.
2363 This is true, if either the remote host is already connected, or if we are
2364 not in completion mode."
2365 (and (tramp-tramp-file-p filename)
2366 (with-parsed-tramp-file-name filename nil
2367 (or (not (tramp-completion-mode-p))
2368 (let* ((tramp-verbose 0)
2369 (p (tramp-get-connection-process v)))
2370 (and p (processp p) (memq (process-status p) '(run open))))))))
2372 ;; Method, host name and user name completion.
2373 ;; `tramp-completion-dissect-file-name' returns a list of
2374 ;; tramp-file-name structures. For all of them we return possible completions.
2376 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2377 "Like `file-name-all-completions' for partial Tramp files."
2380 (tramp-drop-volume-letter (expand-file-name filename directory)))
2383 ;; Suppress hop from completion.
2387 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2388 tramp-postfix-hop-regexp
2391 (setq hop (match-string 1 fullname)
2392 fullname (replace-match "" nil nil fullname 1)))
2394 ;; Possible completion structures.
2395 (dolist (elt (tramp-completion-dissect-file-name fullname))
2396 (let* ((method (tramp-file-name-method elt))
2397 (user (tramp-file-name-user elt))
2398 (host (tramp-file-name-host elt))
2399 (localname (tramp-file-name-localname elt))
2400 (m (tramp-find-method method user host))
2401 (tramp-current-user user) ; see `tramp-parse-passwd'
2404 (unless localname ;; Nothing to complete.
2408 ;; Method dependent user / host combinations.
2412 (setq all-user-hosts
2413 (append all-user-hosts
2414 (funcall (nth 0 x) (nth 1 x)))))
2415 (tramp-get-completion-function m))
2421 (tramp-get-completion-user-host
2422 method user host (nth 0 x) (nth 1 x)))
2423 (delq nil all-user-hosts)))))
2425 ;; Possible methods.
2427 (append result (tramp-get-completion-methods m)))))))
2429 ;; Unify list, add hop, remove nil elements.
2430 (dolist (elt result)
2432 (string-match tramp-prefix-regexp elt)
2433 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2436 (substring elt (length (tramp-drop-volume-letter directory))))))
2438 ;; Complete local parts.
2442 (apply (if (tramp-connectable-p fullname)
2443 'tramp-completion-run-real-handler
2444 'tramp-run-real-handler)
2445 'file-name-all-completions (list (list filename directory)))))))
2447 ;; Method, host name and user name completion for a file.
2449 (defun tramp-completion-handle-file-name-completion
2450 (filename directory &optional predicate)
2451 "Like `file-name-completion' for Tramp files."
2454 (mapcar 'list (file-name-all-completions filename directory))
2455 (when (and predicate
2456 (tramp-connectable-p (expand-file-name filename directory)))
2457 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2459 ;; I misuse a little bit the tramp-file-name structure in order to handle
2460 ;; completion possibilities for partial methods / user names / host names.
2461 ;; Return value is a list of tramp-file-name structures according to possible
2462 ;; completions. If "localname" is non-nil it means there
2463 ;; shouldn't be a completion anymore.
2465 ;; Expected results:
2467 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2468 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2469 ;; [nil "x" nil nil]
2470 ;; ["x" nil nil nil]
2472 ;; "/x:" "/x:y" "/x:y:"
2473 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2475 ;; ["x" nil "" nil] ["x" nil "y" nil]
2476 ;; ["x" "" nil nil] ["x" "y" nil nil]
2478 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2479 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2480 ;; "/[x/y@" "/[x/y@z"
2481 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2482 (defun tramp-completion-dissect-file-name (name)
2483 "Returns a list of `tramp-file-name' structures.
2484 They are collected by `tramp-completion-dissect-file-name1'."
2488 (tramp-completion-ipv6-regexp
2491 (if (zerop (length tramp-postfix-ipv6-format))
2492 tramp-postfix-host-format
2493 tramp-postfix-ipv6-format)))
2494 ;; "/method" "/[method"
2495 (tramp-completion-file-name-structure1
2496 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2499 (tramp-completion-file-name-structure2
2500 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2503 (tramp-completion-file-name-structure3
2504 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2506 ;; "/[ipv6" "/[ipv6"
2507 (tramp-completion-file-name-structure4
2508 (list (concat tramp-prefix-regexp
2509 tramp-prefix-ipv6-regexp
2510 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2512 ;; "/user@host" "/[user@host"
2513 (tramp-completion-file-name-structure5
2514 (list (concat tramp-prefix-regexp
2515 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2516 "\\(" tramp-host-regexp x-nil "\\)$")
2518 ;; "/user@[ipv6" "/[user@ipv6"
2519 (tramp-completion-file-name-structure6
2520 (list (concat tramp-prefix-regexp
2521 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2522 tramp-prefix-ipv6-regexp
2523 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2525 ;; "/method:user" "/[method/user"
2526 (tramp-completion-file-name-structure7
2527 (list (concat tramp-prefix-regexp
2528 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2529 "\\(" tramp-user-regexp x-nil "\\)$")
2531 ;; "/method:host" "/[method/host"
2532 (tramp-completion-file-name-structure8
2533 (list (concat tramp-prefix-regexp
2534 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2535 "\\(" tramp-host-regexp x-nil "\\)$")
2537 ;; "/method:[ipv6" "/[method/ipv6"
2538 (tramp-completion-file-name-structure9
2539 (list (concat tramp-prefix-regexp
2540 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2541 tramp-prefix-ipv6-regexp
2542 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2544 ;; "/method:user@host" "/[method/user@host"
2545 (tramp-completion-file-name-structure10
2546 (list (concat tramp-prefix-regexp
2547 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2548 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2549 "\\(" tramp-host-regexp x-nil "\\)$")
2551 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2552 (tramp-completion-file-name-structure11
2553 (list (concat tramp-prefix-regexp
2554 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2555 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2556 tramp-prefix-ipv6-regexp
2557 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2560 (mapc (lambda (structure)
2561 (add-to-list 'result
2562 (tramp-completion-dissect-file-name1 structure name)))
2564 tramp-completion-file-name-structure1
2565 tramp-completion-file-name-structure2
2566 tramp-completion-file-name-structure3
2567 tramp-completion-file-name-structure4
2568 tramp-completion-file-name-structure5
2569 tramp-completion-file-name-structure6
2570 tramp-completion-file-name-structure7
2571 tramp-completion-file-name-structure8
2572 tramp-completion-file-name-structure9
2573 tramp-completion-file-name-structure10
2574 tramp-completion-file-name-structure11
2575 tramp-file-name-structure))
2579 (defun tramp-completion-dissect-file-name1 (structure name)
2580 "Returns a `tramp-file-name' structure matching STRUCTURE.
2581 The structure consists of remote method, remote user,
2582 remote host and localname (filename on remote host)."
2585 (when (string-match (nth 0 structure) name)
2586 (let ((method (and (nth 1 structure)
2587 (match-string (nth 1 structure) name)))
2588 (user (and (nth 2 structure)
2589 (match-string (nth 2 structure) name)))
2590 (host (and (nth 3 structure)
2591 (match-string (nth 3 structure) name)))
2592 (localname (and (nth 4 structure)
2593 (match-string (nth 4 structure) name))))
2594 (vector method user host localname nil)))))
2596 ;; This function returns all possible method completions, adding the
2597 ;; trailing method delimiter.
2598 (defun tramp-get-completion-methods (partial-method)
2599 "Returns all method completions for PARTIAL-METHOD."
2603 (string-match (concat "^" (regexp-quote partial-method)) method)
2604 (tramp-completion-make-tramp-file-name method nil nil nil)))
2605 (mapcar 'car tramp-methods)))
2607 ;; Compares partial user and host names with possible completions.
2608 (defun tramp-get-completion-user-host
2609 (method partial-user partial-host user host)
2610 "Returns the most expanded string for user and host name completion.
2611 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2614 ((and partial-user partial-host)
2616 (string-match (concat "^" (regexp-quote partial-host)) host)
2617 (string-equal partial-user (or user partial-user)))
2618 (setq user partial-user)
2625 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2631 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2637 (unless (zerop (+ (length user) (length host)))
2638 (tramp-completion-make-tramp-file-name method user host nil)))
2640 ;; Generic function.
2641 (defun tramp-parse-group (regexp match-level skip-regexp)
2642 "Return a (user host) tuple allowed to access.
2643 User is always nil."
2645 (when (re-search-forward regexp (point-at-eol) t)
2646 (setq result (list nil (match-string match-level))))
2648 (> (skip-chars-forward skip-regexp) 0)
2652 ;; Generic function.
2653 (defun tramp-parse-file (filename function)
2654 "Return a list of (user host) tuples allowed to access.
2655 User is always nil."
2656 ;; On Windows, there are problems in completion when
2657 ;; `default-directory' is remote.
2658 (let ((default-directory (tramp-compat-temporary-file-directory)))
2659 (when (file-readable-p filename)
2661 (insert-file-contents filename)
2662 (goto-char (point-min))
2663 (loop while (not (eobp)) collect (funcall function))))))
2665 ;;;###tramp-autoload
2666 (defun tramp-parse-rhosts (filename)
2667 "Return a list of (user host) tuples allowed to access.
2668 Either user or host may be nil."
2669 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2671 (defun tramp-parse-rhosts-group ()
2672 "Return a (user host) tuple allowed to access.
2673 Either user or host may be nil."
2677 "^\\(" tramp-host-regexp "\\)"
2678 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2679 (when (re-search-forward regexp (point-at-eol) t)
2680 (setq result (append (list (match-string 3) (match-string 1)))))
2684 ;;;###tramp-autoload
2685 (defun tramp-parse-shosts (filename)
2686 "Return a list of (user host) tuples allowed to access.
2687 User is always nil."
2688 (tramp-parse-file filename 'tramp-parse-shosts-group))
2690 (defun tramp-parse-shosts-group ()
2691 "Return a (user host) tuple allowed to access.
2692 User is always nil."
2693 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2695 ;;;###tramp-autoload
2696 (defun tramp-parse-sconfig (filename)
2697 "Return a list of (user host) tuples allowed to access.
2698 User is always nil."
2699 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2701 (defun tramp-parse-sconfig-group ()
2702 "Return a (user host) tuple allowed to access.
2703 User is always nil."
2705 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2707 ;; Generic function.
2708 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2709 "Return a list of (user host) tuples allowed to access.
2710 User is always nil."
2711 ;; On Windows, there are problems in completion when
2712 ;; `default-directory' is remote.
2713 (let* ((default-directory (tramp-compat-temporary-file-directory))
2714 (files (and (file-directory-p dirname) (directory-files dirname))))
2715 (loop for f in files
2716 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2717 collect (list nil (match-string 1 f)))))
2719 ;;;###tramp-autoload
2720 (defun tramp-parse-shostkeys (dirname)
2721 "Return a list of (user host) tuples allowed to access.
2722 User is always nil."
2723 (tramp-parse-shostkeys-sknownhosts
2724 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2726 ;;;###tramp-autoload
2727 (defun tramp-parse-sknownhosts (dirname)
2728 "Return a list of (user host) tuples allowed to access.
2729 User is always nil."
2730 (tramp-parse-shostkeys-sknownhosts
2732 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2734 ;;;###tramp-autoload
2735 (defun tramp-parse-hosts (filename)
2736 "Return a list of (user host) tuples allowed to access.
2737 User is always nil."
2738 (tramp-parse-file filename 'tramp-parse-hosts-group))
2740 (defun tramp-parse-hosts-group ()
2741 "Return a (user host) tuple allowed to access.
2742 User is always nil."
2744 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2746 ;; For su-alike methods it would be desirable to return "root@localhost"
2747 ;; as default. Unfortunately, we have no information whether any user name
2748 ;; has been typed already. So we use `tramp-current-user' as indication,
2749 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
2750 ;;;###tramp-autoload
2751 (defun tramp-parse-passwd (filename)
2752 "Return a list of (user host) tuples allowed to access.
2753 Host is always \"localhost\"."
2754 (if (zerop (length tramp-current-user))
2756 (tramp-parse-file filename 'tramp-parse-passwd-group)))
2758 (defun tramp-parse-passwd-group ()
2759 "Return a (user host) tuple allowed to access.
2760 Host is always \"localhost\"."
2762 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2763 (when (re-search-forward regexp (point-at-eol) t)
2764 (setq result (list (match-string 1) "localhost")))
2768 ;;;###tramp-autoload
2769 (defun tramp-parse-netrc (filename)
2770 "Return a list of (user host) tuples allowed to access.
2772 (tramp-parse-file filename 'tramp-parse-netrc-group))
2774 (defun tramp-parse-netrc-group ()
2775 "Return a (user host) tuple allowed to access.
2780 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2781 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2782 (when (re-search-forward regexp (point-at-eol) t)
2783 (setq result (list (match-string 3) (match-string 1))))
2787 ;;;###tramp-autoload
2788 (defun tramp-parse-putty (registry-or-dirname)
2789 "Return a list of (user host) tuples allowed to access.
2790 User is always nil."
2791 (if (memq system-type '(windows-nt))
2793 (when (zerop (tramp-call-process
2794 "reg" nil t nil "query" registry-or-dirname))
2795 (goto-char (point-min))
2796 (loop while (not (eobp)) collect
2797 (tramp-parse-putty-group registry-or-dirname))))
2799 (tramp-parse-shostkeys-sknownhosts
2800 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2802 (defun tramp-parse-putty-group (registry)
2803 "Return a (user host) tuple allowed to access.
2804 User is always nil."
2806 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2807 (when (re-search-forward regexp (point-at-eol) t)
2808 (setq result (list nil (match-string 1))))
2812 ;;; Common file name handler functions for different backends:
2814 (defvar tramp-handle-file-local-copy-hook nil
2815 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2817 (defvar tramp-handle-write-region-hook nil
2818 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2820 (defun tramp-handle-directory-file-name (directory)
2821 "Like `directory-file-name' for Tramp files."
2822 ;; If localname component of filename is "/", leave it unchanged.
2823 ;; Otherwise, remove any trailing slash from localname component.
2824 ;; Method, host, etc, are unchanged. Does it make sense to try
2825 ;; to avoid parsing the filename?
2826 (with-parsed-tramp-file-name directory nil
2827 (if (and (not (zerop (length localname)))
2828 (eq (aref localname (1- (length localname))) ?/)
2829 (not (string= localname "/")))
2830 (substring directory 0 -1)
2833 (defun tramp-handle-directory-files
2834 (directory &optional full match nosort files-only)
2835 "Like `directory-files' for Tramp files."
2836 ;; FILES-ONLY is valid for XEmacs only.
2837 (when (file-directory-p directory)
2838 (setq directory (file-name-as-directory (expand-file-name directory)))
2839 (let ((temp (nreverse (file-name-all-completions "" directory)))
2843 (setq item (directory-file-name (pop temp)))
2844 (when (and (or (null match) (string-match match item))
2845 (or (null files-only)
2847 (and (equal files-only t) (file-regular-p item))
2848 ;; Directories only.
2849 (file-directory-p item)))
2850 (push (if full (concat directory item) item)
2852 (if nosort result (sort result 'string<)))))
2854 (defun tramp-handle-directory-files-and-attributes
2855 (directory &optional full match nosort id-format)
2856 "Like `directory-files-and-attributes' for Tramp files."
2859 (cons x (tramp-compat-file-attributes
2860 (if full x (expand-file-name x directory)) id-format)))
2861 (directory-files directory full match nosort)))
2863 (defun tramp-handle-dired-uncache (dir &optional dir-p)
2864 "Like `dired-uncache' for Tramp files."
2865 ;; DIR-P is valid for XEmacs only.
2866 (with-parsed-tramp-file-name
2867 (if (or dir-p (file-directory-p dir)) dir (file-name-directory dir)) nil
2868 (tramp-flush-directory-property v localname)))
2870 (defun tramp-handle-file-accessible-directory-p (filename)
2871 "Like `file-accessible-directory-p' for Tramp files."
2872 (and (file-directory-p filename)
2873 (file-executable-p filename)))
2875 (defun tramp-handle-file-exists-p (filename)
2876 "Like `file-exists-p' for Tramp files."
2877 (not (null (file-attributes filename))))
2879 (defun tramp-handle-file-modes (filename)
2880 "Like `file-modes' for Tramp files."
2881 (let ((truename (or (file-truename filename) filename)))
2882 (when (file-exists-p truename)
2883 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2885 ;; Localname manipulation functions that grok Tramp localnames...
2886 (defun tramp-handle-file-name-as-directory (file)
2887 "Like `file-name-as-directory' but aware of Tramp files."
2888 ;; `file-name-as-directory' would be sufficient except localname is
2889 ;; the empty string.
2890 (let ((v (tramp-dissect-file-name file t)))
2891 ;; Run the command on the localname portion only.
2892 (tramp-make-tramp-file-name
2893 (tramp-file-name-method v)
2894 (tramp-file-name-user v)
2895 (tramp-file-name-host v)
2896 (tramp-run-real-handler
2897 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))))
2899 (defun tramp-handle-file-name-completion
2900 (filename directory &optional predicate)
2901 "Like `file-name-completion' for Tramp files."
2902 (unless (tramp-tramp-file-p directory)
2904 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2908 (mapcar 'list (file-name-all-completions filename directory))
2910 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2912 (defun tramp-handle-file-name-directory (file)
2913 "Like `file-name-directory' but aware of Tramp files."
2914 ;; Everything except the last filename thing is the directory. We
2915 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2916 ;; the remote file name parts. This is a problem when we are in
2917 ;; file name completion.
2918 (let ((v (tramp-dissect-file-name file t)))
2919 ;; Run the command on the localname portion only.
2920 (tramp-make-tramp-file-name
2921 (tramp-file-name-method v)
2922 (tramp-file-name-user v)
2923 (tramp-file-name-host v)
2924 (tramp-run-real-handler
2925 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2927 (defun tramp-handle-file-name-nondirectory (file)
2928 "Like `file-name-nondirectory' but aware of Tramp files."
2929 (with-parsed-tramp-file-name file nil
2930 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2932 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2933 "Like `file-newer-than-file-p' for Tramp files."
2935 ((not (file-exists-p file1)) nil)
2936 ((not (file-exists-p file2)) t)
2937 (t (tramp-time-less-p (nth 5 (file-attributes file2))
2938 (nth 5 (file-attributes file1))))))
2940 (defun tramp-handle-file-regular-p (filename)
2941 "Like `file-regular-p' for Tramp files."
2942 (and (file-exists-p filename)
2943 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2945 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2946 "Like `file-remote-p' for Tramp files."
2947 ;; We do not want traces in the debug buffer.
2948 (let ((tramp-verbose (min tramp-verbose 3)))
2949 (when (tramp-tramp-file-p filename)
2950 (let* ((v (tramp-dissect-file-name filename))
2951 (p (tramp-get-connection-process v))
2952 (c (and p (processp p) (memq (process-status p) '(run open)))))
2953 ;; We expand the file name only, if there is already a connection.
2954 (with-parsed-tramp-file-name
2955 (if c (expand-file-name filename) filename) nil
2956 (and (or (not connected) c)
2958 ((eq identification 'method) method)
2959 ((eq identification 'user) user)
2960 ((eq identification 'host) host)
2961 ((eq identification 'localname) localname)
2962 (t (tramp-make-tramp-file-name method user host "")))))))))
2964 (defun tramp-handle-file-symlink-p (filename)
2965 "Like `file-symlink-p' for Tramp files."
2966 (with-parsed-tramp-file-name filename nil
2967 (let ((x (car (file-attributes filename))))
2969 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2970 ;; might do weird things.
2971 (if (file-name-absolute-p x)
2972 (tramp-make-tramp-file-name method user host x)
2975 (defun tramp-handle-find-backup-file-name (filename)
2976 "Like `find-backup-file-name' for Tramp files."
2977 (with-parsed-tramp-file-name filename nil
2978 ;; We set both variables. It doesn't matter whether it is
2980 (let ((backup-directory-alist
2982 (when (boundp 'backup-directory-alist)
2983 (if (symbol-value 'tramp-backup-directory-alist)
2988 (if (and (stringp (cdr x))
2989 (file-name-absolute-p (cdr x))
2990 (not (tramp-file-name-p (cdr x))))
2991 (tramp-make-tramp-file-name method user host (cdr x))
2993 (symbol-value 'tramp-backup-directory-alist))
2994 (symbol-value 'backup-directory-alist))))
2996 (bkup-backup-directory-info
2998 (when (boundp 'bkup-backup-directory-info)
2999 (if (symbol-value 'tramp-bkup-backup-directory-info)
3005 (if (and (stringp (car (cdr x)))
3006 (file-name-absolute-p (car (cdr x)))
3007 (not (tramp-file-name-p (car (cdr x)))))
3008 (tramp-make-tramp-file-name
3009 method user host (car (cdr x)))
3012 (symbol-value 'tramp-bkup-backup-directory-info))
3013 (symbol-value 'bkup-backup-directory-info)))))
3015 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
3017 (defun tramp-handle-insert-directory
3018 (filename switches &optional wildcard full-directory-p)
3019 "Like `insert-directory' for Tramp files."
3020 (unless switches (setq switches ""))
3021 ;; Mark trailing "/".
3022 (when (and (zerop (length (file-name-nondirectory filename)))
3023 (not full-directory-p))
3024 (setq switches (concat switches "F")))
3025 (with-parsed-tramp-file-name (expand-file-name filename) nil
3026 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
3028 (let (ls-lisp-use-insert-directory-program start)
3029 (tramp-run-real-handler
3031 (list filename switches wildcard full-directory-p))
3032 ;; `ls-lisp' always returns full listings. We must remove
3033 ;; superfluous parts.
3034 (unless (string-match "l" switches)
3036 (goto-char (point-min))
3038 (text-property-not-all
3039 (point) (point-at-eol) 'dired-filename t))
3042 (or (text-property-any start (point-at-eol) 'dired-filename t)
3044 (if (= (point-at-bol) (point-at-eol))
3046 (delete-region (point) (progn (forward-line) (point)))
3047 (forward-line)))))))))
3049 (defun tramp-handle-insert-file-contents
3050 (filename &optional visit beg end replace)
3051 "Like `insert-file-contents' for Tramp files."
3052 (barf-if-buffer-read-only)
3053 (setq filename (expand-file-name filename))
3054 (let (result local-copy remote-copy)
3055 (with-parsed-tramp-file-name filename nil
3056 (with-tramp-progress-reporter
3057 v 3 (format "Inserting `%s'" filename)
3059 (if (not (file-exists-p filename))
3061 ;; We don't raise a Tramp error, because it might be
3062 ;; suppressed, like in `find-file-noselect-1'.
3064 v 1 "File not `%s' found on remote host" filename)
3066 (list "File not found on remote host" filename)))
3068 (if (and (tramp-local-host-p v)
3069 (let (file-name-handler-alist)
3070 (file-readable-p localname)))
3071 ;; Short track: if we are on the local host, we can
3074 (tramp-run-real-handler
3075 'insert-file-contents
3076 (list localname visit beg end replace)))
3078 ;; When we shall insert only a part of the file, we
3079 ;; copy this part. This works only for the shell file
3081 (when (and (or beg end)
3082 (tramp-get-method-parameter
3083 (tramp-file-name-method v) 'tramp-login-program))
3084 (setq remote-copy (tramp-make-tramp-temp-file v))
3085 ;; This is defined in tramp-sh.el. Let's assume
3086 ;; this is loaded already.
3087 (tramp-compat-funcall
3092 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
3093 beg (tramp-shell-quote-argument localname)
3094 (- end beg) remote-copy))
3096 (format "dd bs=1 skip=%d if=%s of=%s"
3097 beg (tramp-shell-quote-argument localname)
3100 (format "dd bs=1 count=%d if=%s of=%s"
3101 end (tramp-shell-quote-argument localname)
3103 (setq tramp-temp-buffer-file-name nil beg nil end nil))
3105 ;; `insert-file-contents-literally' takes care to
3106 ;; avoid calling jka-compr. By let-binding
3107 ;; `inhibit-file-name-operation', we propagate that
3108 ;; care to the `file-local-copy' operation.
3110 (let ((inhibit-file-name-operation
3111 (when (eq inhibit-file-name-operation
3112 'insert-file-contents)
3115 ((stringp remote-copy)
3117 (tramp-make-tramp-file-name
3118 method user host remote-copy)))
3119 ((stringp tramp-temp-buffer-file-name)
3120 (copy-file filename tramp-temp-buffer-file-name 'ok)
3121 tramp-temp-buffer-file-name)
3122 (t (file-local-copy filename)))))
3124 ;; When the file is not readable for the owner, it
3125 ;; cannot be inserted, even if it is readable for the
3126 ;; group or for everybody.
3128 local-copy (tramp-compat-octal-to-decimal "0600"))
3130 (when (and (null remote-copy)
3131 (tramp-get-method-parameter
3132 method 'tramp-copy-keep-tmpfile))
3133 ;; We keep the local file for performance reasons,
3134 ;; useful for "rsync".
3135 (setq tramp-temp-buffer-file-name local-copy))
3137 ;; We must ensure that `file-coding-system-alist'
3138 ;; matches `local-copy'. We must also use `visit',
3139 ;; otherwise there might be an error in the
3140 ;; `revert-buffer' function under XEmacs.
3141 (let ((file-coding-system-alist
3142 (tramp-find-file-name-coding-system-alist
3143 filename local-copy)))
3145 (insert-file-contents
3146 local-copy visit beg end replace)))))
3151 (setq buffer-file-name filename)
3152 (setq buffer-read-only (not (file-writable-p filename)))
3153 (set-visited-file-modtime)
3154 (set-buffer-modified-p nil))
3155 (when (and (stringp local-copy)
3156 (or remote-copy (null tramp-temp-buffer-file-name)))
3157 (delete-file local-copy))
3158 (when (stringp remote-copy)
3160 (tramp-make-tramp-file-name method user host remote-copy)))))))
3163 (list (expand-file-name filename)
3166 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3167 "Like `load' for Tramp files."
3168 (with-parsed-tramp-file-name (expand-file-name file) nil
3170 (cond ((file-exists-p (concat file ".elc"))
3171 (setq file (concat file ".elc")))
3172 ((file-exists-p (concat file ".el"))
3173 (setq file (concat file ".el")))))
3175 ;; The first condition is always true for absolute file names.
3176 ;; Included for safety's sake.
3177 (unless (or (file-name-directory file)
3178 (string-match "\\.elc?\\'" file))
3181 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3183 (when (not (file-exists-p file))
3184 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
3185 (if (not (file-exists-p file))
3187 (let ((tramp-message-show-message (not nomessage)))
3188 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3189 (let ((local-copy (file-local-copy file)))
3191 (tramp-compat-load local-copy noerror t nosuffix must-suffix)
3192 (delete-file local-copy)))))
3195 (defun tramp-handle-make-symbolic-link
3196 (filename linkname &optional ok-if-already-exists)
3197 "Like `make-symbolic-link' for Tramp files."
3198 (with-parsed-tramp-file-name
3199 (if (tramp-tramp-file-p filename) filename linkname) nil
3200 (tramp-error v 'file-error "make-symbolic-link not supported")))
3202 (defun tramp-handle-shell-command
3203 (command &optional output-buffer error-buffer)
3204 "Like `shell-command' for Tramp files."
3205 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3206 ;; We cannot use `shell-file-name' and `shell-command-switch',
3207 ;; they are variables of the local host.
3210 (tramp-get-method-parameter
3211 (tramp-file-name-method
3212 (tramp-dissect-file-name default-directory))
3213 'tramp-remote-shell)
3214 (tramp-get-method-parameter
3215 (tramp-file-name-method
3216 (tramp-dissect-file-name default-directory))
3217 'tramp-remote-shell-args))
3218 (list (substring command 0 asynchronous))))
3222 ((bufferp output-buffer) output-buffer)
3223 ((stringp output-buffer) (get-buffer-create output-buffer))
3225 (setq current-buffer-p t)
3227 (t (get-buffer-create
3229 "*Async Shell Command*"
3230 "*Shell Command Output*")))))
3233 ((bufferp error-buffer) error-buffer)
3234 ((stringp error-buffer) (get-buffer-create error-buffer))))
3236 (if (and (not asynchronous) error-buffer)
3237 (with-parsed-tramp-file-name default-directory nil
3238 (list output-buffer (tramp-make-tramp-temp-file v)))
3240 (p (get-buffer-process output-buffer)))
3242 ;; Check whether there is another process running. Tramp does not
3243 ;; support 2 (asynchronous) processes in parallel.
3245 (if (yes-or-no-p "A command is running. Kill it? ")
3246 (ignore-errors (kill-process p))
3247 (tramp-user-error p "Shell command in progress")))
3249 (if current-buffer-p
3251 (barf-if-buffer-read-only)
3253 (with-current-buffer output-buffer
3254 (setq buffer-read-only nil)
3257 (if (and (not current-buffer-p) (integerp asynchronous))
3260 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3262 (pop-to-buffer output-buffer)
3263 (setq mode-line-process '(":%s"))
3265 (set-process-sentinel p 'shell-command-sentinel)
3266 (set-process-filter p 'comint-output-filter))
3270 (apply 'process-file (car args) nil buffer nil (cdr args))
3271 ;; Insert error messages if they were separated.
3272 (when (listp buffer)
3273 (with-current-buffer error-buffer
3274 (insert-file-contents (cadr buffer)))
3275 (delete-file (cadr buffer)))
3276 (if current-buffer-p
3277 ;; This is like exchange-point-and-mark, but doesn't
3278 ;; activate the mark. It is cleaner to avoid activation,
3279 ;; even though the command loop would deactivate the mark
3280 ;; because we inserted text.
3281 (goto-char (prog1 (mark t)
3282 (set-marker (mark-marker) (point)
3284 ;; There's some output, display it.
3285 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3286 (if (functionp 'display-message-or-buffer)
3287 (tramp-compat-funcall 'display-message-or-buffer output-buffer)
3288 (pop-to-buffer output-buffer))))))))
3290 (defun tramp-handle-substitute-in-file-name (filename)
3291 "Like `substitute-in-file-name' for Tramp files.
3292 \"//\" and \"/~\" substitute only in the local filename part."
3293 ;; First, we must replace environment variables.
3294 (setq filename (tramp-replace-environment-variables filename))
3295 (with-parsed-tramp-file-name filename nil
3296 ;; Ignore in LOCALNAME everything before "//" or "/~".
3297 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3299 (concat (file-remote-p filename)
3300 (replace-match "\\1" nil nil localname)))
3301 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3302 (when (string-match "~$" filename)
3303 (setq filename (concat filename "/"))))
3304 ;; We do not want to replace environment variables, again.
3305 (let (process-environment)
3306 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3308 (defun tramp-handle-unhandled-file-name-directory (_filename)
3309 "Like `unhandled-file-name-directory' for Tramp files."
3310 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3311 ;; for backward compatibility.
3312 (expand-file-name "~/"))
3314 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
3315 "Like `set-visited-file-modtime' for Tramp files."
3316 (unless (buffer-file-name)
3317 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3320 (let ((remote-file-name-inhibit-cache t))
3321 ;; '(-1 65535) means file doesn't exists yet.
3323 (or (nth 5 (file-attributes (buffer-file-name))) '(-1 65535)))))
3324 ;; We use '(0 0) as a don't-know value.
3325 (unless (equal time-list '(0 0))
3326 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))))
3328 (defun tramp-handle-verify-visited-file-modtime (&optional buf)
3329 "Like `verify-visited-file-modtime' for Tramp files.
3330 At the time `verify-visited-file-modtime' calls this function, we
3331 already know that the buffer is visiting a file and that
3332 `visited-file-modtime' does not return 0. Do not call this
3333 function directly, unless those two cases are already taken care
3335 (with-current-buffer (or buf (current-buffer))
3336 (let ((f (buffer-file-name)))
3337 ;; There is no file visiting the buffer, or the buffer has no
3338 ;; recorded last modification time, or there is no established
3341 (eq (visited-file-modtime) 0)
3342 (not (tramp-file-name-handler 'file-remote-p f nil 'connected)))
3344 (with-parsed-tramp-file-name f nil
3345 (let* ((remote-file-name-inhibit-cache t)
3346 (attr (file-attributes f))
3347 (modtime (nth 5 attr))
3348 (mt (visited-file-modtime)))
3351 ;; File exists, and has a known modtime.
3352 ((and attr (not (equal modtime '(0 0))))
3353 (< (abs (tramp-time-diff
3355 ;; For compatibility, deal with both the old
3356 ;; (HIGH . LOW) and the new (HIGH LOW) return
3357 ;; values of `visited-file-modtime'.
3359 (list (car mt) (cdr mt))
3362 ;; Modtime has the don't know value.
3364 ;; If file does not exist, say it is not modified if and
3365 ;; only if that agrees with the buffer's record.
3366 (t (equal mt '(-1 65535))))))))))
3368 (defun tramp-handle-file-notify-add-watch (filename _flags _callback)
3369 "Like `file-notify-add-watch' for Tramp files."
3370 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3372 (setq filename (expand-file-name filename))
3373 (with-parsed-tramp-file-name filename nil
3375 v 'file-notify-error "File notification not supported for `%s'" filename)))
3377 (defun tramp-handle-file-notify-rm-watch (proc)
3378 "Like `file-notify-rm-watch' for Tramp files."
3379 ;; The descriptor must be a process object.
3380 (unless (and (processp proc) (gethash proc file-notify-descriptors))
3381 (tramp-error proc 'file-notify-error "Not a valid descriptor %S" proc))
3382 (tramp-message proc 6 "Kill %S" proc)
3383 (kill-process proc))
3385 ;;; Functions for establishing connection:
3387 ;; The following functions are actions to be taken when seeing certain
3388 ;; prompts from the remote host. See the variable
3389 ;; `tramp-actions-before-shell' for usage of these functions.
3391 (defun tramp-action-login (_proc vec)
3392 "Send the login name."
3393 (when (not (stringp tramp-current-user))
3394 (setq tramp-current-user
3395 (with-tramp-connection-property vec "login-as"
3396 (save-window-excursion
3397 (let ((enable-recursive-minibuffers t))
3398 (pop-to-buffer (tramp-get-connection-buffer vec))
3399 (read-string (match-string 0)))))))
3400 (with-current-buffer (tramp-get-connection-buffer vec)
3401 (tramp-message vec 6 "\n%s" (buffer-string)))
3402 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3403 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3405 (defun tramp-action-password (proc vec)
3406 "Query the user for a password."
3407 (with-current-buffer (process-buffer proc)
3408 (let ((enable-recursive-minibuffers t)
3409 (case-fold-search t))
3410 ;; Let's check whether a wrong password has been sent already.
3411 ;; Sometimes, the process returns a new password request
3412 ;; immediately after rejecting the previous (wrong) one.
3413 (goto-char (point-min))
3414 (when (search-forward-regexp tramp-wrong-passwd-regexp nil t)
3415 (tramp-clear-passwd vec))
3416 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3417 (tramp-message vec 3 "Sending %s" (match-string 1))
3418 ;; We don't call `tramp-send-string' in order to hide the
3419 ;; password from the debug buffer.
3420 (process-send-string
3421 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3422 ;; Hide password prompt.
3423 (narrow-to-region (point-max) (point-max)))))
3425 (defun tramp-action-succeed (_proc _vec)
3426 "Signal success in finding shell prompt."
3427 (throw 'tramp-action 'ok))
3429 (defun tramp-action-permission-denied (proc _vec)
3430 "Signal permission denied."
3432 (throw 'tramp-action 'permission-denied))
3434 (defun tramp-action-yesno (proc vec)
3435 "Ask the user for confirmation using `yes-or-no-p'.
3436 Send \"yes\" to remote process on confirmation, abort otherwise.
3437 See also `tramp-action-yn'."
3438 (save-window-excursion
3439 (let ((enable-recursive-minibuffers t))
3440 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3441 (unless (yes-or-no-p (match-string 0))
3443 (throw 'tramp-action 'permission-denied))
3444 (with-current-buffer (tramp-get-connection-buffer vec)
3445 (tramp-message vec 6 "\n%s" (buffer-string)))
3446 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3448 (defun tramp-action-yn (proc vec)
3449 "Ask the user for confirmation using `y-or-n-p'.
3450 Send \"y\" to remote process on confirmation, abort otherwise.
3451 See also `tramp-action-yesno'."
3452 (save-window-excursion
3453 (let ((enable-recursive-minibuffers t))
3454 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3455 (unless (y-or-n-p (match-string 0))
3457 (throw 'tramp-action 'permission-denied))
3458 (with-current-buffer (tramp-get-connection-buffer vec)
3459 (tramp-message vec 6 "\n%s" (buffer-string)))
3460 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3462 (defun tramp-action-terminal (_proc vec)
3463 "Tell the remote host which terminal type to use.
3464 The terminal type can be configured with `tramp-terminal-type'."
3465 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3466 (with-current-buffer (tramp-get-connection-buffer vec)
3467 (tramp-message vec 6 "\n%s" (buffer-string)))
3468 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3470 (defun tramp-action-process-alive (proc _vec)
3471 "Check, whether a process has finished."
3472 (unless (memq (process-status proc) '(run open))
3473 (throw 'tramp-action 'process-died)))
3475 (defun tramp-action-out-of-band (proc vec)
3476 "Check, whether an out-of-band copy has finished."
3477 ;; There might be pending output for the exit status.
3478 (tramp-accept-process-output proc 0.1)
3479 (cond ((and (memq (process-status proc) '(stop exit))
3480 (zerop (process-exit-status proc)))
3481 (tramp-message vec 3 "Process has finished.")
3482 (throw 'tramp-action 'ok))
3483 ((or (and (memq (process-status proc) '(stop exit))
3484 (not (zerop (process-exit-status proc))))
3485 (memq (process-status proc) '(signal)))
3486 ;; `scp' could have copied correctly, but set modes could have failed.
3487 ;; This can be ignored.
3488 (with-current-buffer (process-buffer proc)
3489 (goto-char (point-min))
3490 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3492 (tramp-message vec 5 "'set mode' error ignored.")
3493 (tramp-message vec 3 "Process has finished.")
3494 (throw 'tramp-action 'ok))
3495 (tramp-message vec 3 "Process has died.")
3496 (throw 'tramp-action 'process-died))))
3499 ;;; Functions for processing the actions:
3501 (defun tramp-process-one-action (proc vec actions)
3502 "Wait for output from the shell and perform one action."
3503 (let ((case-fold-search t)
3504 found todo item pattern action)
3506 ;; Reread output once all actions have been performed.
3507 ;; Obviously, the output was not complete.
3508 (tramp-accept-process-output proc 1)
3511 (setq item (pop todo))
3512 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3513 (setq action (nth 1 item))
3515 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3516 (when (tramp-check-for-regexp proc pattern)
3517 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3518 (setq found (funcall action proc vec)))))
3521 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3522 "Perform ACTIONS until success or TIMEOUT.
3523 PROC and VEC indicate the remote connection to be used. POS, if
3524 set, is the starting point of the region to be deleted in the
3526 ;; Enable `auth-source'. We must use tramp-current-* variables in
3527 ;; case we have several hops.
3528 (tramp-set-connection-property
3529 (tramp-dissect-file-name
3530 (tramp-make-tramp-file-name
3531 tramp-current-method tramp-current-user tramp-current-host ""))
3532 "first-password-request" t)
3534 (with-tramp-progress-reporter
3535 proc 3 "Waiting for prompts from remote shell"
3538 (with-timeout (timeout (setq exit 'timeout))
3541 (catch 'tramp-action
3542 (tramp-process-one-action proc vec actions)))))
3545 (catch 'tramp-action
3546 (tramp-process-one-action proc vec actions)))))
3547 (with-current-buffer (tramp-get-connection-buffer vec)
3549 (tramp-message vec 6 "\n%s" (buffer-string)))
3550 (unless (eq exit 'ok)
3551 (tramp-clear-passwd vec)
3552 (delete-process proc)
3553 (tramp-error-with-buffer
3554 (tramp-get-connection-buffer vec) vec 'file-error
3556 ((eq exit 'permission-denied) "Permission denied")
3557 ((eq exit 'process-died)
3559 "Tramp failed to connect. If this happens repeatedly, try\n"
3560 " `M-x tramp-cleanup-this-connection'"))
3563 "Timeout reached, see buffer `%s' for details"
3564 (tramp-get-connection-buffer vec)))
3565 (t "Login failed")))))
3567 (with-current-buffer (tramp-get-connection-buffer vec)
3568 (let (buffer-read-only) (delete-region pos (point))))))))
3570 :;; Utility functions:
3572 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3573 "Like `accept-process-output' for Tramp processes.
3574 This is needed in order to hide `last-coding-system-used', which is set
3575 for process communication also."
3576 (with-current-buffer (process-buffer proc)
3577 (tramp-message proc 10 "%s %s" proc (process-status proc))
3578 (let (buffer-read-only last-coding-system-used)
3579 ;; Under Windows XP, accept-process-output doesn't return
3580 ;; sometimes. So we add an additional timeout.
3581 (with-timeout ((or timeout 1))
3582 (if (featurep 'xemacs)
3583 (accept-process-output proc timeout timeout-msecs)
3584 (accept-process-output proc timeout timeout-msecs (and proc t)))))
3585 (tramp-message proc 10 "\n%s" (buffer-string))))
3587 (defun tramp-check-for-regexp (proc regexp)
3588 "Check, whether REGEXP is contained in process buffer of PROC.
3589 Erase echoed commands if exists."
3590 (with-current-buffer (process-buffer proc)
3591 (goto-char (point-min))
3593 ;; Check whether we need to remove echo output.
3594 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3595 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3596 (let ((begin (match-beginning 0)))
3597 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3598 ;; Discard echo from remote output.
3599 (tramp-set-connection-property proc "check-remote-echo" nil)
3600 (tramp-message proc 5 "echo-mark found")
3602 (delete-region begin (point))
3603 (goto-char (point-min)))))
3605 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3606 ;; Sometimes, the echo string is suppressed on the remote side.
3608 (tramp-compat-funcall
3609 'substring-no-properties tramp-echo-mark-marker
3610 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3611 (tramp-compat-funcall
3612 'buffer-substring-no-properties
3614 (min (+ (point-min) tramp-echo-mark-marker-length)
3616 ;; No echo to be handled, now we can look for the regexp.
3617 ;; Sometimes, lines are much to long, and we run into a "Stack
3618 ;; overflow in regexp matcher". For example, //DIRED// lines of
3619 ;; directory listings with some thousand files. Therefore, we
3620 ;; look from the end.
3621 (goto-char (point-max))
3622 (ignore-errors (re-search-backward regexp nil t)))))
3624 (defun tramp-wait-for-regexp (proc timeout regexp)
3625 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3626 Expects the output of PROC to be sent to the current buffer. Returns
3627 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3629 (with-current-buffer (process-buffer proc)
3630 (let ((found (tramp-check-for-regexp proc regexp))
3631 (start-time (current-time)))
3633 ;; Work around a bug in XEmacs 21, where the timeout
3634 ;; expires faster than it should. This degenerates
3635 ;; to polling for buggy XEmacsen, but oh, well.
3636 (while (and (not found)
3637 (< (tramp-time-diff (current-time) start-time)
3639 (with-timeout (timeout)
3641 (tramp-accept-process-output proc 1)
3642 (unless (memq (process-status proc) '(run open))
3643 (tramp-error-with-buffer
3644 nil proc 'file-error "Process has died"))
3645 (setq found (tramp-check-for-regexp proc regexp))))))
3648 (tramp-accept-process-output proc 1)
3649 (unless (memq (process-status proc) '(run open))
3650 (tramp-error-with-buffer
3651 nil proc 'file-error "Process has died"))
3652 (setq found (tramp-check-for-regexp proc regexp)))))
3653 (tramp-message proc 6 "\n%s" (buffer-string))
3657 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3659 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3662 ;; It seems that Tru64 Unix does not like it if long strings are sent
3663 ;; to it in one go. (This happens when sending the Perl
3664 ;; `file-attributes' implementation, for instance.) Therefore, we
3665 ;; have this function which sends the string in chunks.
3666 (defun tramp-send-string (vec string)
3667 "Send the STRING via connection VEC.
3669 The STRING is expected to use Unix line-endings, but the lines sent to
3670 the remote host use line-endings as defined in the variable
3671 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3672 (let* ((p (tramp-get-connection-process vec))
3673 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3676 vec 'file-error "Can't send string to remote host -- not logged in"))
3677 (tramp-set-connection-property p "last-cmd-time" (current-time))
3678 (tramp-message vec 10 "%s" string)
3679 (with-current-buffer (tramp-get-connection-buffer vec)
3680 ;; Clean up the buffer. We cannot call `erase-buffer' because
3681 ;; narrowing might be in effect.
3682 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3683 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3685 (mapconcat 'identity
3686 (tramp-compat-split-string string "\n")
3687 tramp-rsh-end-of-line))
3688 (unless (or (string= string "")
3689 (string-equal (substring string -1) tramp-rsh-end-of-line))
3690 (setq string (concat string tramp-rsh-end-of-line)))
3692 (if (and chunksize (not (zerop chunksize)))
3694 (end (length string)))
3697 vec 10 "Sending chunk from %s to %s"
3698 pos (min (+ pos chunksize) end))
3699 (process-send-string
3700 p (substring string pos (min (+ pos chunksize) end)))
3701 (setq pos (+ pos chunksize))))
3702 (process-send-string p string)))))
3704 (defun tramp-get-inode (vec)
3705 "Returns the virtual inode number.
3706 If it doesn't exist, generate a new one."
3707 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3708 (setq tramp-inodes (1+ tramp-inodes))))
3710 (defun tramp-get-device (vec)
3711 "Returns the virtual device number.
3712 If it doesn't exist, generate a new one."
3713 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3714 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3716 (defun tramp-equal-remote (file1 file2)
3717 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3718 The check depends on method, user and host name of the files. If
3719 one of the components is missing, the default values are used.
3720 The local file name parts of FILE1 and FILE2 are not taken into
3725 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3727 would yield `t'. On the other hand, the following check results in nil:
3729 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3730 (and (tramp-tramp-file-p file1)
3731 (tramp-tramp-file-p file2)
3732 (string-equal (file-remote-p file1) (file-remote-p file2))))
3734 ;;;###tramp-autoload
3735 (defun tramp-mode-string-to-int (mode-string)
3736 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3737 (let* (case-fold-search
3738 (mode-chars (string-to-vector mode-string))
3739 (owner-read (aref mode-chars 1))
3740 (owner-write (aref mode-chars 2))
3741 (owner-execute-or-setid (aref mode-chars 3))
3742 (group-read (aref mode-chars 4))
3743 (group-write (aref mode-chars 5))
3744 (group-execute-or-setid (aref mode-chars 6))
3745 (other-read (aref mode-chars 7))
3746 (other-write (aref mode-chars 8))
3747 (other-execute-or-sticky (aref mode-chars 9)))
3751 ((char-equal owner-read ?r) (tramp-compat-octal-to-decimal "00400"))
3752 ((char-equal owner-read ?-) 0)
3753 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3755 ((char-equal owner-write ?w) (tramp-compat-octal-to-decimal "00200"))
3756 ((char-equal owner-write ?-) 0)
3757 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3759 ((char-equal owner-execute-or-setid ?x)
3760 (tramp-compat-octal-to-decimal "00100"))
3761 ((char-equal owner-execute-or-setid ?S)
3762 (tramp-compat-octal-to-decimal "04000"))
3763 ((char-equal owner-execute-or-setid ?s)
3764 (tramp-compat-octal-to-decimal "04100"))
3765 ((char-equal owner-execute-or-setid ?-) 0)
3766 (t (error "Fourth char `%c' must be one of `xsS-'"
3767 owner-execute-or-setid)))
3769 ((char-equal group-read ?r) (tramp-compat-octal-to-decimal "00040"))
3770 ((char-equal group-read ?-) 0)
3771 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3773 ((char-equal group-write ?w) (tramp-compat-octal-to-decimal "00020"))
3774 ((char-equal group-write ?-) 0)
3775 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3777 ((char-equal group-execute-or-setid ?x)
3778 (tramp-compat-octal-to-decimal "00010"))
3779 ((char-equal group-execute-or-setid ?S)
3780 (tramp-compat-octal-to-decimal "02000"))
3781 ((char-equal group-execute-or-setid ?s)
3782 (tramp-compat-octal-to-decimal "02010"))
3783 ((char-equal group-execute-or-setid ?-) 0)
3784 (t (error "Seventh char `%c' must be one of `xsS-'"
3785 group-execute-or-setid)))
3787 ((char-equal other-read ?r)
3788 (tramp-compat-octal-to-decimal "00004"))
3789 ((char-equal other-read ?-) 0)
3790 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3792 ((char-equal other-write ?w) (tramp-compat-octal-to-decimal "00002"))
3793 ((char-equal other-write ?-) 0)
3794 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3796 ((char-equal other-execute-or-sticky ?x)
3797 (tramp-compat-octal-to-decimal "00001"))
3798 ((char-equal other-execute-or-sticky ?T)
3799 (tramp-compat-octal-to-decimal "01000"))
3800 ((char-equal other-execute-or-sticky ?t)
3801 (tramp-compat-octal-to-decimal "01001"))
3802 ((char-equal other-execute-or-sticky ?-) 0)
3803 (t (error "Tenth char `%c' must be one of `xtT-'"
3804 other-execute-or-sticky)))))))
3806 (defconst tramp-file-mode-type-map
3807 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
3809 (2 . "c") ; character device
3810 (3 . "m") ; multiplexed character device (v7)
3811 (4 . "d") ; directory
3812 (5 . "?") ; Named special file (XENIX)
3813 (6 . "b") ; block device
3814 (7 . "?") ; multiplexed block device (v7)
3815 (8 . "-") ; regular file
3816 (9 . "n") ; network special file (HP-UX)
3817 (10 . "l") ; symlink
3818 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
3820 (13 . "D") ; door special (Solaris)
3821 (14 . "w")) ; whiteout (BSD)
3822 "A list of file types returned from the `stat' system call.
3823 This is used to map a mode number to a permission string.")
3825 ;;;###tramp-autoload
3826 (defun tramp-file-mode-from-int (mode)
3827 "Turn an integer representing a file mode into an ls(1)-like string."
3829 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
3830 (user (logand (lsh mode -6) 7))
3831 (group (logand (lsh mode -3) 7))
3832 (other (logand (lsh mode -0) 7))
3833 (suid (> (logand (lsh mode -9) 4) 0))
3834 (sgid (> (logand (lsh mode -9) 2) 0))
3835 (sticky (> (logand (lsh mode -9) 1) 0)))
3836 (setq user (tramp-file-mode-permissions user suid "s"))
3837 (setq group (tramp-file-mode-permissions group sgid "s"))
3838 (setq other (tramp-file-mode-permissions other sticky "t"))
3839 (concat type user group other)))
3841 (defun tramp-file-mode-permissions (perm suid suid-text)
3842 "Convert a permission bitset into a string.
3843 This is used internally by `tramp-file-mode-from-int'."
3844 (let ((r (> (logand perm 4) 0))
3845 (w (> (logand perm 2) 0))
3846 (x (> (logand perm 1) 0)))
3847 (concat (or (and r "r") "-")
3848 (or (and w "w") "-")
3849 (or (and suid x suid-text) ; suid, execute
3850 (and suid (upcase suid-text)) ; suid, !execute
3851 (and x "x") "-")))) ; !suid
3853 ;;;###tramp-autoload
3854 (defun tramp-get-local-uid (id-format)
3855 (if (equal id-format 'integer) (user-uid) (user-login-name)))
3857 ;;;###tramp-autoload
3858 (defun tramp-get-local-gid (id-format)
3859 (if (and (fboundp 'group-gid) (equal id-format 'integer))
3860 (tramp-compat-funcall 'group-gid)
3861 (nth 3 (tramp-compat-file-attributes "~/" id-format))))
3863 ;;;###tramp-autoload
3864 (defun tramp-check-cached-permissions (vec access)
3865 "Check `file-attributes' caches for VEC.
3866 Return t if according to the cache access type ACCESS is known to
3872 ((eq ?x access) 3))))
3873 (dolist (suffix '("string" "integer") result)
3880 (tramp-get-file-property
3881 vec (tramp-file-name-localname vec)
3882 (concat "file-attributes-" suffix) nil)
3884 (tramp-make-tramp-file-name
3885 (tramp-file-name-method vec)
3886 (tramp-file-name-user vec)
3887 (tramp-file-name-host vec)
3888 (tramp-file-name-localname vec))
3891 (tramp-get-connection-property
3892 vec (concat "uid-" suffix) nil))
3894 (tramp-get-connection-property
3895 vec (concat "gid-" suffix) nil)))
3900 (eq t (car file-attr))
3901 (null (car file-attr)))
3903 ;; World accessible.
3904 (eq access (aref (nth 8 file-attr) (+ offset 6)))
3905 ;; User accessible and owned by user.
3907 (eq access (aref (nth 8 file-attr) offset))
3908 (equal remote-uid (nth 2 file-attr)))
3909 ;; Group accessible and owned by user's
3912 (eq access (aref (nth 8 file-attr) (+ offset 3)))
3913 (equal remote-gid (nth 3 file-attr)))))))))))
3915 ;;;###tramp-autoload
3916 (defun tramp-local-host-p (vec)
3917 "Return t if this points to the local host, nil otherwise."
3918 ;; We cannot use `tramp-file-name-real-host'. A port is an
3919 ;; indication for an ssh tunnel or alike.
3920 (let ((host (tramp-file-name-host vec)))
3923 (string-match tramp-local-host-regexp host)
3924 ;; The method shall be applied to one of the shell file name
3925 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3926 ;; alike, where it must fail.
3927 (tramp-get-method-parameter
3928 (tramp-file-name-method vec) 'tramp-login-program)
3929 ;; The local temp directory must be writable for the other user.
3931 (tramp-make-tramp-file-name
3932 (tramp-file-name-method vec)
3933 (tramp-file-name-user vec)
3935 (tramp-compat-temporary-file-directory)))
3936 ;; On some systems, chown runs only for root.
3937 (or (zerop (user-uid))
3938 ;; This is defined in tramp-sh.el. Let's assume this is
3940 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3942 (defun tramp-get-remote-tmpdir (vec)
3943 "Return directory for temporary files on the remote host identified by VEC."
3944 (with-tramp-connection-property vec "tmpdir"
3945 (let ((dir (tramp-make-tramp-file-name
3946 (tramp-file-name-method vec)
3947 (tramp-file-name-user vec)
3948 (tramp-file-name-host vec)
3950 (tramp-get-method-parameter
3951 (tramp-file-name-method vec) 'tramp-tmpdir)
3953 (if (and (file-directory-p dir) (file-writable-p dir))
3955 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
3957 ;;;###tramp-autoload
3958 (defun tramp-make-tramp-temp-file (vec)
3959 "Create a temporary file on the remote host identified by VEC.
3960 Return the local name of the temporary file."
3961 (let ((prefix (expand-file-name
3962 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3965 ;; `make-temp-file' would be the natural choice for
3966 ;; implementation. But it calls `write-region' internally,
3967 ;; which also needs a temporary file - we would end in an
3969 (setq result (make-temp-name prefix))
3970 (if (file-exists-p result)
3972 ;; This creates the file by side effect.
3973 (set-file-times result)
3974 (set-file-modes result (tramp-compat-octal-to-decimal "0700"))))
3976 ;; Return the local part.
3977 (with-parsed-tramp-file-name result nil localname)))
3979 (defun tramp-delete-temp-file-function ()
3980 "Remove temporary files related to current buffer."
3981 (when (stringp tramp-temp-buffer-file-name)
3982 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3984 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3985 (add-hook 'tramp-unload-hook
3987 (remove-hook 'kill-buffer-hook
3988 'tramp-delete-temp-file-function)))
3990 ;;; Auto saving to a special directory:
3992 (defun tramp-handle-make-auto-save-file-name ()
3993 "Like `make-auto-save-file-name' for Tramp files.
3994 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3995 (let ((tramp-auto-save-directory tramp-auto-save-directory)
3997 (tramp-subst-strs-in-string
4004 (buffer-file-name))))
4005 ;; File name must be unique. This is ensured with Emacs 22 (see
4006 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
4007 ;; all other cases we must do it ourselves.
4008 (when (boundp 'auto-save-file-name-transforms)
4011 (when (and (string-match (car x) buffer-file-name)
4012 (not (car (cddr x))))
4013 (setq tramp-auto-save-directory
4014 (or tramp-auto-save-directory
4015 (tramp-compat-temporary-file-directory)))))
4016 (symbol-value 'auto-save-file-name-transforms)))
4017 ;; Create directory.
4018 (when tramp-auto-save-directory
4019 (setq buffer-file-name
4020 (expand-file-name buffer-file-name tramp-auto-save-directory))
4021 (unless (file-exists-p tramp-auto-save-directory)
4022 (make-directory tramp-auto-save-directory t)))
4023 ;; Run plain `make-auto-save-file-name'. There might be an advice when
4024 ;; it is not a magic file name operation (since Emacs 22).
4025 ;; We must deactivate it temporarily.
4026 (if (not (ad-is-active 'make-auto-save-file-name))
4027 (tramp-run-real-handler 'make-auto-save-file-name nil)
4029 (ad-deactivate 'make-auto-save-file-name)
4031 (tramp-run-real-handler 'make-auto-save-file-name nil)
4032 (ad-activate 'make-auto-save-file-name)))))
4034 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
4035 (defadvice make-auto-save-file-name
4036 (around tramp-advice-make-auto-save-file-name () activate)
4037 "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files."
4038 (if (tramp-tramp-file-p (buffer-file-name))
4039 ;; We cannot call `tramp-handle-make-auto-save-file-name'
4040 ;; directly, because this would bypass the locking mechanism.
4041 (setq ad-return-value
4042 (tramp-file-name-handler 'make-auto-save-file-name))
4048 'make-auto-save-file-name
4049 'around 'tramp-advice-make-auto-save-file-name)
4050 (ad-activate 'make-auto-save-file-name))))
4052 ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus
4053 ;; umask. This is a security threat.
4055 (defun tramp-set-auto-save-file-modes ()
4056 "Set permissions of autosaved remote files to the original permissions."
4057 (let ((bfn (buffer-file-name)))
4058 (when (and (tramp-tramp-file-p bfn)
4060 (stringp buffer-auto-save-file-name)
4061 (not (equal bfn buffer-auto-save-file-name)))
4062 (unless (file-exists-p buffer-auto-save-file-name)
4063 (write-region "" nil buffer-auto-save-file-name))
4064 ;; Permissions should be set always, because there might be an old
4065 ;; auto-saved file belonging to another original file. This could
4066 ;; be a security threat.
4068 buffer-auto-save-file-name
4069 (or (file-modes bfn) (tramp-compat-octal-to-decimal "0600"))))))
4071 (unless (and (featurep 'xemacs)
4072 (= emacs-major-version 21)
4073 (> emacs-minor-version 4))
4074 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
4075 (add-hook 'tramp-unload-hook
4077 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
4079 (defun tramp-subst-strs-in-string (alist string)
4080 "Replace all occurrences of the string FROM with TO in STRING.
4081 ALIST is of the form ((FROM . TO) ...)."
4084 (let* ((pr (car alist))
4087 (while (string-match (regexp-quote from) string)
4088 (setq string (replace-match to t t string)))
4089 (setq alist (cdr alist))))
4092 ;;; Compatibility functions section:
4094 (defun tramp-call-process
4095 (program &optional infile destination display &rest args)
4096 "Calls `call-process' on the local host.
4097 This is needed because for some Emacs flavors Tramp has
4098 defadvised `call-process' to behave like `process-file'. The
4099 Lisp error raised when PROGRAM is nil is trapped also, returning 1.
4100 Furthermore, traces are written with verbosity of 6."
4102 (vector tramp-current-method tramp-current-user tramp-current-host nil nil)
4103 6 "`%s %s' %s %s" program (mapconcat 'identity args " ") infile destination)
4104 (if (executable-find program)
4105 (apply 'call-process program infile destination display args)
4108 ;;;###tramp-autoload
4109 (defun tramp-read-passwd (proc &optional prompt)
4110 "Read a password from user (compat function).
4111 Consults the auth-source package.
4112 Invokes `password-read' if available, `read-passwd' else."
4113 (let* ((case-fold-search t)
4114 (key (tramp-make-tramp-file-name
4115 tramp-current-method tramp-current-user
4116 tramp-current-host ""))
4119 (with-current-buffer (process-buffer proc)
4120 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
4121 (format "%s for %s " (capitalize (match-string 1)) key))))
4122 auth-info auth-passwd)
4123 (with-parsed-tramp-file-name key nil
4126 ;; See if auth-sources contains something useful, if it's
4127 ;; bound. `auth-source-user-or-password' is an obsoleted
4128 ;; function, it has been replaced by `auth-source-search'.
4129 (and (boundp 'auth-sources)
4130 (tramp-get-connection-property v "first-password-request" nil)
4131 ;; Try with Tramp's current method.
4132 (if (fboundp 'auth-source-search)
4134 (tramp-compat-funcall
4137 :user (or tramp-current-user t)
4138 :host tramp-current-host
4139 :port tramp-current-method)
4140 auth-passwd (plist-get (nth 0 auth-info) :secret)
4141 auth-passwd (if (functionp auth-passwd)
4142 (funcall auth-passwd)
4144 (tramp-compat-funcall
4145 'auth-source-user-or-password
4146 "password" tramp-current-host tramp-current-method)))
4147 ;; Try the password cache.
4148 (when (functionp 'password-read)
4150 (tramp-compat-funcall 'password-read pw-prompt key)))
4151 (tramp-compat-funcall 'password-cache-add key password)
4153 ;; Else, get the password interactively.
4154 (read-passwd pw-prompt))
4155 (tramp-set-connection-property v "first-password-request" nil)))))
4157 ;;;###tramp-autoload
4158 (defun tramp-clear-passwd (vec)
4159 "Clear password cache for connection related to VEC."
4160 (tramp-compat-funcall
4161 'password-cache-remove
4162 (tramp-make-tramp-file-name
4163 (tramp-file-name-method vec)
4164 (tramp-file-name-user vec)
4165 (tramp-file-name-host vec)
4168 ;; Snarfed code from time-date.el and parse-time.el
4170 (defconst tramp-half-a-year '(241 17024)
4171 "Evaluated by \"(days-to-time 183)\".")
4173 (defconst tramp-parse-time-months
4174 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
4175 ("apr" . 4) ("may" . 5) ("jun" . 6)
4176 ("jul" . 7) ("aug" . 8) ("sep" . 9)
4177 ("oct" . 10) ("nov" . 11) ("dec" . 12))
4178 "Alist mapping month names to integers.")
4180 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
4181 ;;;###tramp-autoload
4182 (defun tramp-time-less-p (t1 t2)
4183 "Say whether time value T1 is less than time value T2."
4184 (unless t1 (setq t1 '(0 0)))
4185 (unless t2 (setq t2 '(0 0)))
4186 (or (< (car t1) (car t2))
4187 (and (= (car t1) (car t2))
4188 (< (nth 1 t1) (nth 1 t2)))))
4190 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
4191 (defun tramp-time-subtract (t1 t2)
4192 "Subtract two time values.
4193 Return the difference in the format of a time value."
4194 (unless t1 (setq t1 '(0 0)))
4195 (unless t2 (setq t2 '(0 0)))
4196 (let ((borrow (< (cadr t1) (cadr t2))))
4197 (list (- (car t1) (car t2) (if borrow 1 0))
4198 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
4200 ;;;###tramp-autoload
4201 (defun tramp-time-diff (t1 t2)
4202 "Return the difference between the two times, in seconds.
4203 T1 and T2 are time values (as returned by `current-time' for example)."
4204 (cond ((and (fboundp 'subtract-time)
4205 (fboundp 'float-time))
4206 (tramp-compat-funcall
4207 'float-time (tramp-compat-funcall 'subtract-time t1 t2)))
4208 ((and (fboundp 'subtract-time)
4209 (fboundp 'time-to-seconds))
4210 (tramp-compat-funcall
4211 'time-to-seconds (tramp-compat-funcall 'subtract-time t1 t2)))
4212 ((fboundp 'itimer-time-difference)
4213 (tramp-compat-funcall
4214 'itimer-time-difference
4215 (if (< (length t1) 3) (append t1 '(0)) t1)
4216 (if (< (length t2) 3) (append t2 '(0)) t2)))
4218 (let ((time (tramp-time-subtract t1 t2)))
4219 (+ (* (car time) 65536.0)
4221 (/ (or (nth 2 time) 0) 1000000.0))))))
4223 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4224 ;; does not deal well with newline characters. Newline is replaced by
4225 ;; backslash newline. But if, say, the string `a backslash newline b'
4226 ;; is passed to a shell, the shell will expand this into "ab",
4227 ;; completely omitting the newline. This is not what was intended.
4228 ;; It does not appear to be possible to make the function
4229 ;; `shell-quote-argument' work with newlines without making it
4230 ;; dependent on the shell used. But within this package, we know that
4231 ;; we will always use a Bourne-like shell, so we use an approach which
4234 ;; The approach is simple: we call `shell-quote-argument', then
4235 ;; massage the newline part of the result.
4237 ;; This function should produce a string which is grokked by a Unix
4238 ;; shell, even if the Emacs is running on Windows. Since this is the
4239 ;; kludges section, we bind `system-type' in such a way that
4240 ;; `shell-quote-argument' behaves as if on Unix.
4242 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4243 ;; function to work with Bourne-like shells.
4245 ;; CCC: This function should be rewritten so that
4246 ;; `shell-quote-argument' is not used. This way, we are safe from
4247 ;; changes in `shell-quote-argument'.
4248 ;;;###tramp-autoload
4249 (defun tramp-shell-quote-argument (s)
4250 "Similar to `shell-quote-argument', but groks newlines.
4251 Only works for Bourne-like shells."
4252 (let ((system-type 'not-windows))
4254 (let ((result (shell-quote-argument s))
4255 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
4256 (when (and (>= (length result) 2)
4257 (string= (substring result 0 2) "\\~"))
4258 (setq result (substring result 1)))
4259 (while (string-match nl result)
4260 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
4264 ;;; Integration of eshell.el:
4266 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4267 ;; when `default-directory' points to another host.
4268 (defun tramp-eshell-directory-change ()
4269 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4270 (setq eshell-path-env
4271 (if (tramp-tramp-file-p default-directory)
4272 (with-parsed-tramp-file-name default-directory nil
4276 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4277 ;; the remote path is only set in the session cache.
4278 (tramp-get-connection-property
4279 (tramp-get-connection-process v) "remote-path" nil)
4280 (tramp-get-connection-property v "remote-path" nil))
4284 (eval-after-load "esh-util"
4286 (tramp-eshell-directory-change)
4287 (add-hook 'eshell-directory-change-hook
4288 'tramp-eshell-directory-change)
4289 (add-hook 'tramp-unload-hook
4291 (remove-hook 'eshell-directory-change-hook
4292 'tramp-eshell-directory-change)))))
4294 ;; Checklist for `tramp-unload-hook'
4295 ;; - Unload all `tramp-*' packages
4296 ;; - Reset `file-name-handler-alist'
4297 ;; - Cleanup hooks where Tramp functions are in
4298 ;; - Cleanup advised functions
4299 ;; - Cleanup autoloads
4301 (defun tramp-unload-tramp ()
4302 "Discard Tramp from loading remote files."
4304 ;; ange-ftp settings must be enabled.
4305 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
4306 ;; Maybe it's not loaded yet.
4307 (ignore-errors (unload-feature 'tramp 'force)))
4313 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
4314 ;; `shell-quote-argument'.
4315 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4316 ;; by the files in that directory. Add this here.
4317 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4318 ;; * abbreviate-file-name
4319 ;; * Better error checking. At least whenever we see something
4320 ;; strange when doing zerop, we should kill the process and start
4321 ;; again. (Greg Stark)
4322 ;; * Username and hostname completion.
4323 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
4324 ;; * Make `tramp-default-user' obsolete.
4325 ;; * Implement a general server-local-variable mechanism, as there are
4326 ;; probably other variables that need different values for different
4327 ;; servers too. The user could then configure a variable (such as
4328 ;; tramp-server-local-variable-alist) to define any such variables
4329 ;; that they need to, which would then be let bound as appropriate
4330 ;; in tramp functions. (Jason Rumney)
4331 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4332 ;; * I was wondering if it would be possible to use tramp even if I'm
4333 ;; actually using sshfs. But when I launch a command I would like
4334 ;; to get it executed on the remote machine where the files really
4335 ;; are. (Andrea Crotti)
4336 ;; * Run emerge on two remote files. Bug is described here:
4337 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4339 ;; * Use also port to distinguish connections. This is needed for
4340 ;; different hosts sitting behind a single router (distinguished by
4341 ;; different port numbers). (Tzvi Edelman)
4343 ;;; tramp.el ends here