1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2016 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 23.1 and higher.
39 ;; Also see the todo list at the bottom of this file.
41 ;; The current version of Tramp can be retrieved from the following URL:
42 ;; http://ftp.gnu.org/gnu/tramp/
44 ;; There's a mailing list for this, as well. Its name is:
45 ;; tramp-devel@gnu.org
46 ;; You can use the Web to subscribe, under the following URL:
47 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
49 ;; For the adventurous, the current development sources are available
50 ;; via Git. You can find instructions about this at the following URL:
51 ;; http://savannah.gnu.org/projects/tramp/
53 ;; Don't forget to put on your asbestos longjohns, first!
57 (require 'tramp-compat)
59 ;; Pacify byte-compiler.
62 (defvar eshell-path-env)
64 ;;; User Customizable Internal Variables:
67 "Edit remote files with a combination of ssh, scp, etc."
70 :link '(custom-manual "(tramp)Top")
73 ;; Maybe we need once a real Tramp mode, with key bindings etc.
75 (defcustom tramp-mode t
76 "Whether Tramp is enabled.
77 If it is set to nil, all remote file names are used literally."
81 (defcustom tramp-verbose 3
82 "Verbosity level for Tramp messages.
83 Any level x includes messages for all levels 1 .. x-1. The levels are
85 0 silent (no tramp messages at all)
88 3 connection to remote hosts (default level)
91 6 sent and received strings
93 8 connection properties
99 (defcustom tramp-backup-directory-alist nil
100 "Alist of filename patterns and backup directory names.
101 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
102 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
103 is a local file name, the backup directory is prepended with Tramp file
104 name prefix \(method, user, host) of file.
106 \(setq tramp-backup-directory-alist backup-directory-alist)
108 gives the same backup policy for Tramp files on their hosts like the
109 policy for local files."
111 :type '(repeat (cons (regexp :tag "Regexp matching filename")
112 (directory :tag "Backup directory name"))))
114 (defcustom tramp-auto-save-directory nil
115 "Put auto-save files in this directory, if set.
116 The idea is to use a local directory so that auto-saving is faster.
117 This setting has precedence over `auto-save-file-name-transforms'."
119 :type '(choice (const :tag "Use default" nil)
120 (directory :tag "Auto save directory name")))
122 (defcustom tramp-encoding-shell
123 (if (memq system-type '(windows-nt))
126 "Use this program for encoding and decoding commands on the local host.
127 This shell is used to execute the encoding and decoding command on the
128 local host, so if you want to use `~' in those commands, you should
129 choose a shell here which groks tilde expansion. `/bin/sh' normally
130 does not understand tilde expansion.
132 For encoding and decoding, commands like the following are executed:
134 /bin/sh -c COMMAND < INPUT > OUTPUT
136 This variable can be used to change the \"/bin/sh\" part. See the
137 variable `tramp-encoding-command-switch' for the \"-c\" part.
139 If the shell must be forced to be interactive, see
140 `tramp-encoding-command-interactive'.
142 Note that this variable is not used for remote commands. There are
143 mechanisms in tramp.el which automatically determine the right shell to
144 use for the remote host."
146 :type '(file :must-match t))
148 (defcustom tramp-encoding-command-switch
149 (if (string-match "cmd\\.exe" tramp-encoding-shell)
152 "Use this switch together with `tramp-encoding-shell' for local commands.
153 See the variable `tramp-encoding-shell' for more information."
157 (defcustom tramp-encoding-command-interactive
158 (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i")
159 "Use this switch together with `tramp-encoding-shell' for interactive shells.
160 See the variable `tramp-encoding-shell' for more information."
163 :type '(choice (const nil) string))
166 (defvar tramp-methods nil
167 "Alist of methods for remote files.
168 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
169 Each NAME stands for a remote access method. Each PARAM is a
170 pair of the form (KEY VALUE). The following KEYs are defined:
171 * `tramp-remote-shell'
172 This specifies the shell to use on the remote host. This
173 MUST be a Bourne-like shell. It is normally not necessary to
174 set this to any value other than \"/bin/sh\": Tramp wants to
175 use a shell which groks tilde expansion, but it can search
176 for it. Also note that \"/bin/sh\" exists on all Unixen,
177 this might not be true for the value that you decide to use.
178 You Have Been Warned.
179 * `tramp-remote-shell-login'
180 This specifies the arguments to let `tramp-remote-shell' run
181 as a login shell. It defaults to (\"-l\"), but some shells,
182 like ksh, require another argument. See
183 `tramp-connection-properties' for a way to overwrite the
185 * `tramp-remote-shell-args'
186 For implementation of `shell-command', this specifies the
187 arguments to let `tramp-remote-shell' run a single command.
188 * `tramp-login-program'
189 This specifies the name of the program to use for logging in to the
190 remote host. This may be the name of rsh or a workalike program,
191 or the name of telnet or a workalike, or the name of su or a workalike.
193 This specifies the list of arguments to pass to the above
194 mentioned program. Please note that this is a list of list of arguments,
195 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
196 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
197 There are some patterns: \"%h\" in this list is replaced by the host
198 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
199 port number, and \"%%\" can be used to obtain a literal percent character.
200 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
201 expansion (i.e. no host or no user specified), this list is not used as
202 argument. By this, arguments like (\"-l\" \"%u\") are optional.
203 \"%t\" is replaced by the temporary file name produced with
204 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
205 parameter of a program, if exists. \"%c\" adds additional
206 `tramp-ssh-controlmaster-options' options for the first hop.
208 A list of environment variables and their values, which will
209 be set when calling `tramp-login-program'.
211 When an asynchronous process is started, we know already that
212 the connection works. Therefore, we can pass additional
213 parameters to suppress diagnostic messages, in order not to
214 tamper the process output.
215 * `tramp-copy-program'
216 This specifies the name of the program to use for remotely copying
217 the file; this might be the absolute filename of scp or the name of
218 a workalike program. It is always applied on the local host.
220 This specifies the list of parameters to pass to the above mentioned
221 program, the hints for `tramp-login-args' also apply here.
223 A list of environment variables and their values, which will
224 be set when calling `tramp-copy-program'.
225 * `tramp-remote-copy-program'
226 The listener program to be applied on remote side, if needed.
227 * `tramp-remote-copy-args'
228 The list of parameters to pass to the listener program, the hints
229 for `tramp-login-args' also apply here. Additionally, \"%r\" could
230 be used here and in `tramp-copy-args'. It denotes a randomly
231 chosen port for the remote listener.
232 * `tramp-copy-keep-date'
233 This specifies whether the copying program when the preserves the
234 timestamp of the original file.
235 * `tramp-copy-keep-tmpfile'
236 This specifies whether a temporary local file shall be kept
237 for optimization reasons (useful for \"rsync\" methods).
238 * `tramp-copy-recursive'
239 Whether the operation copies directories recursively.
240 * `tramp-default-port'
241 The default port of a method is needed in case of gateway connections.
242 Additionally, it is used as indication which method is prepared for
245 As the attribute name says, additional arguments are specified here
246 when a method is applied via a gateway.
248 A directory on the remote host for temporary files. If not
249 specified, \"/tmp\" is taken as default.
250 * `tramp-connection-timeout'
251 This is the maximum time to be spent for establishing a connection.
252 In general, the global default value shall be used, but for
253 some methods, like \"su\" or \"sudo\", a shorter timeout
256 What does all this mean? Well, you should specify `tramp-login-program'
257 for all methods; this program is used to log in to the remote site. Then,
258 there are two ways to actually transfer the files between the local and the
259 remote side. One way is using an additional scp-like program. If you want
260 to do this, set `tramp-copy-program' in the method.
262 Another possibility for file transfer is inline transfer, i.e. the
263 file is passed through the same buffer used by `tramp-login-program'. In
264 this case, the file contents need to be protected since the
265 `tramp-login-program' might use escape codes or the connection might not
266 be eight-bit clean. Therefore, file contents are encoded for transit.
267 See the variables `tramp-local-coding-commands' and
268 `tramp-remote-coding-commands' for details.
270 So, to summarize: if the method is an out-of-band method, then you
271 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
272 inline method, then these two parameters should be nil. Methods which
273 are fit for gateways must have `tramp-default-port' at least.
277 When using `su' or `sudo' the phrase \"open connection to a remote
278 host\" sounds strange, but it is used nevertheless, for consistency.
279 No connection is opened to a remote host, but `su' or `sudo' is
280 started on the local host. You should specify a remote host
281 `localhost' or the name of the local host. Another host name is
282 useful only in combination with `tramp-default-proxies-alist'.")
284 (defcustom tramp-default-method
285 ;; An external copy method seems to be preferred, because it performs
286 ;; much better for large files, and it hasn't too serious delays
287 ;; for small files. But it must be ensured that there aren't
288 ;; permanent password queries. Either a password agent like
289 ;; "ssh-agent" or "Pageant" shall run, or the optional
290 ;; password-cache.el or auth-sources.el packages shall be active for
291 ;; password caching. If we detect that the user is running OpenSSH
292 ;; 4.0 or newer, we could reuse the connection, which calls also for
293 ;; an external method.
295 ;; PuTTY is installed. We don't take it, if it is installed on a
296 ;; non-windows system, or pscp from the pssh (parallel ssh) package
298 ((and (eq system-type 'windows-nt) (executable-find "pscp")) "pscp")
299 ;; There is an ssh installation.
300 ((executable-find "scp") "scp")
303 "Default method to use for transferring files.
304 See `tramp-methods' for possibilities.
305 Also see `tramp-default-method-alist'."
310 (defcustom tramp-default-method-alist nil
311 "Default method to use for specific host/user pairs.
312 This is an alist of items (HOST USER METHOD). The first matching item
313 specifies the method to use for a file name which does not specify a
314 method. HOST and USER are regular expressions or nil, which is
315 interpreted as a regular expression which always matches. If no entry
316 matches, the variable `tramp-default-method' takes effect.
318 If the file name does not specify the user, lookup is done using the
319 empty string for the user name.
321 See `tramp-methods' for a list of possibilities for METHOD."
323 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
324 (choice :tag "User regexp" regexp sexp)
325 (choice :tag "Method name" string (const nil)))))
327 (defcustom tramp-default-user nil
328 "Default user to use for transferring files.
329 It is nil by default; otherwise settings in configuration files like
330 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
332 This variable is regarded as obsolete, and will be removed soon."
334 :type '(choice (const nil) string))
337 (defcustom tramp-default-user-alist nil
338 "Default user to use for specific method/host pairs.
339 This is an alist of items (METHOD HOST USER). The first matching item
340 specifies the user to use for a file name which does not specify a
341 user. METHOD and USER are regular expressions or nil, which is
342 interpreted as a regular expression which always matches. If no entry
343 matches, the variable `tramp-default-user' takes effect.
345 If the file name does not specify the method, lookup is done using the
346 empty string for the method name."
348 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
349 (choice :tag " Host regexp" regexp sexp)
350 (choice :tag " User name" string (const nil)))))
352 (defcustom tramp-default-host (system-name)
353 "Default host to use for transferring files.
354 Useful for su and sudo methods mostly."
359 (defcustom tramp-default-host-alist nil
360 "Default host to use for specific method/user pairs.
361 This is an alist of items (METHOD USER HOST). The first matching item
362 specifies the host to use for a file name which does not specify a
363 host. METHOD and HOST are regular expressions or nil, which is
364 interpreted as a regular expression which always matches. If no entry
365 matches, the variable `tramp-default-host' takes effect.
367 If the file name does not specify the method, lookup is done using the
368 empty string for the method name."
371 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
372 (choice :tag " User regexp" regexp sexp)
373 (choice :tag " Host name" string (const nil)))))
375 (defcustom tramp-default-proxies-alist nil
376 "Route to be followed for specific host/user pairs.
377 This is an alist of items (HOST USER PROXY). The first matching
378 item specifies the proxy to be passed for a file name located on
379 a remote target matching USER@HOST. HOST and USER are regular
380 expressions. PROXY must be a Tramp filename without a localname
381 part. Method and user name on PROXY are optional, which is
382 interpreted with the default values. PROXY can contain the
383 patterns %h and %u, which are replaced by the strings matching
384 HOST or USER, respectively.
386 HOST, USER or PROXY could also be Lisp forms, which will be
387 evaluated. The result must be a string or nil, which is
388 interpreted as a regular expression which always matches."
390 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
391 (choice :tag "User regexp" regexp sexp)
392 (choice :tag " Proxy name" string (const nil)))))
394 (defcustom tramp-save-ad-hoc-proxies nil
395 "Whether to save ad-hoc proxies persistently."
400 (defcustom tramp-restricted-shell-hosts-alist
401 (when (memq system-type '(windows-nt))
402 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
403 "List of hosts, which run a restricted shell.
404 This is a list of regular expressions, which denote hosts running
405 a registered shell like \"rbash\". Those hosts can be used as
406 proxies only, see `tramp-default-proxies-alist'. If the local
407 host runs a registered shell, it shall be added to this list, too."
410 :type '(repeat (regexp :tag "Host regexp")))
413 (defconst tramp-local-host-regexp
417 (list "localhost" "localhost6" (system-name) "127.0.0.1" "::1") t)
419 "Host names which are regarded as local host.")
421 (defvar tramp-completion-function-alist nil
422 "Alist of methods for remote files.
423 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...).
424 Each NAME stands for a remote access method. Each PAIR is of the form
425 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
426 names from FILE for completion. The following predefined FUNCTIONs exists:
428 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
429 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
430 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
431 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
432 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
433 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
434 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
435 * `tramp-parse-etc-group' for \"/etc/group\" like files.
436 * `tramp-parse-netrc' for \"~/.netrc\" like files.
437 * `tramp-parse-putty' for PuTTY registered sessions.
439 FUNCTION can also be a user defined function. For more details see
442 (defconst tramp-echo-mark-marker "_echo"
443 "String marker to surround echoed commands.")
445 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
446 "String length of `tramp-echo-mark-marker'.")
448 (defconst tramp-echo-mark
449 (concat tramp-echo-mark-marker
450 (make-string tramp-echo-mark-marker-length ?\b))
451 "String mark to be transmitted around shell commands.
452 Used to separate their echo from the output they produce. This
453 will only be used if we cannot disable remote echo via stty.
454 This string must have no effect on the remote shell except for
455 producing some echo which can later be detected by
456 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
457 followed by an equal number of backspaces to erase them will
460 (defconst tramp-echoed-echo-mark-regexp
461 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
462 tramp-echo-mark-marker tramp-echo-mark-marker-length)
463 "Regexp which matches `tramp-echo-mark' as it gets echoed by
466 (defcustom tramp-local-end-of-line
467 (if (memq system-type '(windows-nt)) "\r\n" "\n")
468 "String used for end of line in local processes."
473 (defcustom tramp-rsh-end-of-line "\n"
474 "String used for end of line in rsh connections.
475 I don't think this ever needs to be changed, so please tell me about it
476 if you need to change this."
480 (defcustom tramp-login-prompt-regexp
481 ".*\\(user\\|login\\)\\( .*\\)?: *"
482 "Regexp matching login-like prompts.
483 The regexp should match at end of buffer.
485 Sometimes the prompt is reported to look like \"login as:\"."
489 (defcustom tramp-shell-prompt-pattern
490 ;; Allow a prompt to start right after a ^M since it indeed would be
491 ;; displayed at the beginning of the line (and Zsh uses it). This
492 ;; regexp works only for GNU Emacs.
493 ;; Allow also [] style prompts. They can appear only during
494 ;; connection initialization; Tramp redefines the prompt afterwards.
495 (concat "\\(?:^\\|\r\\)"
496 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
497 "Regexp to match prompts from remote shell.
498 Normally, Tramp expects you to configure `shell-prompt-pattern'
499 correctly, but sometimes it happens that you are connecting to a
500 remote host which sends a different kind of shell prompt. Therefore,
501 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
502 and also things matched by this variable. The default value of this
503 variable is similar to the default value of `shell-prompt-pattern',
504 which should work well in many cases.
506 This regexp must match both `tramp-initial-end-of-output' and
507 `tramp-end-of-output'."
511 (defcustom tramp-password-prompt-regexp
512 (format "^.*\\(%s\\).*:\^@? *"
513 ;; `password-word-equivalents' has been introduced with Emacs 24.4.
514 (if (boundp 'password-word-equivalents)
515 (regexp-opt (symbol-value 'password-word-equivalents))
516 "password\\|passphrase"))
517 "Regexp matching password-like prompts.
518 The regexp should match at end of buffer.
520 The `sudo' program appears to insert a `^@' character into the prompt."
525 (defcustom tramp-wrong-passwd-regexp
527 ;; These strings should be on the last line
528 (regexp-opt '("Permission denied"
533 "Timeout, server not responding."
535 "Name or service not known"
536 "Host key verification failed."
537 "No supported authentication methods left to try!") t)
541 ;; Here comes a list of regexes, separated by \\|
542 "Received signal [0-9]+"
544 "Regexp matching a `login failed' message.
545 The regexp should match at end of buffer."
549 (defcustom tramp-yesno-prompt-regexp
551 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
553 "Regular expression matching all yes/no queries which need to be confirmed.
554 The confirmation should be done with yes or no.
555 The regexp should match at end of buffer.
556 See also `tramp-yn-prompt-regexp'."
560 (defcustom tramp-yn-prompt-regexp
562 (regexp-opt '("Store key in cache? (y/n)"
563 "Update cached key? (y/n, Return cancels connection)") t)
565 "Regular expression matching all y/n queries which need to be confirmed.
566 The confirmation should be done with y or n.
567 The regexp should match at end of buffer.
568 See also `tramp-yesno-prompt-regexp'."
572 (defcustom tramp-terminal-prompt-regexp
576 "Terminal type\\? \\[.*\\]"
578 "Regular expression matching all terminal setting prompts.
579 The regexp should match at end of buffer.
580 The answer will be provided by `tramp-action-terminal', which see."
584 (defcustom tramp-operation-not-permitted-regexp
585 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
586 (regexp-opt '("Operation not permitted") t))
587 "Regular expression matching keep-date problems in (s)cp operations.
588 Copying has been performed successfully already, so this message can
593 (defcustom tramp-copy-failed-regexp
595 (regexp-opt '("Permission denied"
598 "No such file or directory") t)
600 "Regular expression matching copy problems in (s)cp operations."
604 (defcustom tramp-process-alive-regexp
606 "Regular expression indicating a process has finished.
607 In fact this expression is empty by intention, it will be used only to
608 check regularly the status of the associated process.
609 The answer will be provided by `tramp-action-process-alive',
610 `tramp-action-out-of-band', which see."
614 (defconst tramp-temp-name-prefix "tramp."
615 "Prefix to use for temporary files.
616 If this is a relative file name (such as \"tramp.\"), it is considered
617 relative to the directory name returned by the function
618 `tramp-compat-temporary-file-directory' (which see). It may also be an
619 absolute file name; don't forget to include a prefix for the filename
622 (defconst tramp-temp-buffer-name " *tramp temp*"
623 "Buffer name for a temporary buffer.
624 It shall be used in combination with `generate-new-buffer-name'.")
626 (defvar tramp-temp-buffer-file-name nil
627 "File name of a persistent local temporary file.
628 Useful for \"rsync\" like methods.")
629 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
630 (put 'tramp-temp-buffer-file-name 'permanent-local t)
633 (defcustom tramp-syntax 'ftp
634 "Tramp filename syntax to be used.
636 It can have the following values:
638 `ftp' -- Ange-FTP like syntax
639 `sep' -- Syntax as defined for XEmacs originally."
642 :type '(choice (const :tag "Ange-FTP" ftp)
643 (const :tag "XEmacs" sep)))
645 (defconst tramp-prefix-format
646 (cond ((equal tramp-syntax 'ftp) "/")
647 ((equal tramp-syntax 'sep) "/[")
648 (t (error "Wrong `tramp-syntax' defined")))
649 "String matching the very beginning of Tramp file names.
650 Used in `tramp-make-tramp-file-name'.")
652 (defconst tramp-prefix-regexp
653 (concat "^" (regexp-quote tramp-prefix-format))
654 "Regexp matching the very beginning of Tramp file names.
655 Should always start with \"^\". Derived from `tramp-prefix-format'.")
657 (defconst tramp-method-regexp
659 "Regexp matching methods identifiers.")
661 (defconst tramp-postfix-method-format
662 (cond ((equal tramp-syntax 'ftp) ":")
663 ((equal tramp-syntax 'sep) "/")
664 (t (error "Wrong `tramp-syntax' defined")))
665 "String matching delimiter between method and user or host names.
666 Used in `tramp-make-tramp-file-name'.")
668 (defconst tramp-postfix-method-regexp
669 (regexp-quote tramp-postfix-method-format)
670 "Regexp matching delimiter between method and user or host names.
671 Derived from `tramp-postfix-method-format'.")
673 (defconst tramp-user-regexp "[^/|: \t]+"
674 "Regexp matching user names.")
677 (defconst tramp-prefix-domain-format "%"
678 "String matching delimiter between user and domain names.")
681 (defconst tramp-prefix-domain-regexp
682 (regexp-quote tramp-prefix-domain-format)
683 "Regexp matching delimiter between user and domain names.
684 Derived from `tramp-prefix-domain-format'.")
686 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
687 "Regexp matching domain names.")
689 (defconst tramp-user-with-domain-regexp
690 (concat "\\(" tramp-user-regexp "\\)"
691 tramp-prefix-domain-regexp
692 "\\(" tramp-domain-regexp "\\)")
693 "Regexp matching user names with domain names.")
695 (defconst tramp-postfix-user-format "@"
696 "String matching delimiter between user and host names.
697 Used in `tramp-make-tramp-file-name'.")
699 (defconst tramp-postfix-user-regexp
700 (regexp-quote tramp-postfix-user-format)
701 "Regexp matching delimiter between user and host names.
702 Derived from `tramp-postfix-user-format'.")
704 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
705 "Regexp matching host names.")
707 (defconst tramp-prefix-ipv6-format
708 (cond ((equal tramp-syntax 'ftp) "[")
709 ((equal tramp-syntax 'sep) "")
710 (t (error "Wrong `tramp-syntax' defined")))
711 "String matching left hand side of IPv6 addresses.
712 Used in `tramp-make-tramp-file-name'.")
714 (defconst tramp-prefix-ipv6-regexp
715 (regexp-quote tramp-prefix-ipv6-format)
716 "Regexp matching left hand side of IPv6 addresses.
717 Derived from `tramp-prefix-ipv6-format'.")
719 ;; The following regexp is a bit sloppy. But it shall serve our
720 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
721 ;; "::ffff:192.168.0.1".
722 (defconst tramp-ipv6-regexp
723 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
724 "Regexp matching IPv6 addresses.")
726 (defconst tramp-postfix-ipv6-format
727 (cond ((equal tramp-syntax 'ftp) "]")
728 ((equal tramp-syntax 'sep) "")
729 (t (error "Wrong `tramp-syntax' defined")))
730 "String matching right hand side of IPv6 addresses.
731 Used in `tramp-make-tramp-file-name'.")
733 (defconst tramp-postfix-ipv6-regexp
734 (regexp-quote tramp-postfix-ipv6-format)
735 "Regexp matching right hand side of IPv6 addresses.
736 Derived from `tramp-postfix-ipv6-format'.")
738 (defconst tramp-prefix-port-format
739 (cond ((equal tramp-syntax 'ftp) "#")
740 ((equal tramp-syntax 'sep) "#")
741 (t (error "Wrong `tramp-syntax' defined")))
742 "String matching delimiter between host names and port numbers.")
744 (defconst tramp-prefix-port-regexp
745 (regexp-quote tramp-prefix-port-format)
746 "Regexp matching delimiter between host names and port numbers.
747 Derived from `tramp-prefix-port-format'.")
749 (defconst tramp-port-regexp "[0-9]+"
750 "Regexp matching port numbers.")
752 (defconst tramp-host-with-port-regexp
753 (concat "\\(" tramp-host-regexp "\\)"
754 tramp-prefix-port-regexp
755 "\\(" tramp-port-regexp "\\)")
756 "Regexp matching host names with port numbers.")
758 (defconst tramp-postfix-hop-format "|"
759 "String matching delimiter after ad-hoc hop definitions.")
761 (defconst tramp-postfix-hop-regexp
762 (regexp-quote tramp-postfix-hop-format)
763 "Regexp matching delimiter after ad-hoc hop definitions.
764 Derived from `tramp-postfix-hop-format'.")
766 (defconst tramp-postfix-host-format
767 (cond ((equal tramp-syntax 'ftp) ":")
768 ((equal tramp-syntax 'sep) "]")
769 (t (error "Wrong `tramp-syntax' defined")))
770 "String matching delimiter between host names and localnames.
771 Used in `tramp-make-tramp-file-name'.")
773 (defconst tramp-postfix-host-regexp
774 (regexp-quote tramp-postfix-host-format)
775 "Regexp matching delimiter between host names and localnames.
776 Derived from `tramp-postfix-host-format'.")
778 (defconst tramp-localname-regexp ".*$"
779 "Regexp matching localnames.")
781 ;;; File name format:
783 (defconst tramp-remote-file-name-spec-regexp
785 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
786 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
787 "\\(" "\\(?:" tramp-host-regexp "\\|"
788 tramp-prefix-ipv6-regexp "\\(?:" tramp-ipv6-regexp "\\)?"
789 tramp-postfix-ipv6-regexp "\\)"
790 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
791 "Regular expression matching a Tramp file name between prefix and postfix.")
793 (defconst tramp-file-name-structure
797 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
798 tramp-postfix-hop-regexp "\\)+" "\\)?"
799 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
800 "\\(" tramp-localname-regexp "\\)")
802 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
803 the Tramp file name structure.
805 The first element REGEXP is a regular expression matching a Tramp file
806 name. The regex should contain parentheses around the method name,
807 the user name, the host name, and the file name parts.
809 The second element METHOD is a number, saying which pair of
810 parentheses matches the method name. The third element USER is
811 similar, but for the user name. The fourth element HOST is similar,
812 but for the host name. The fifth element FILE is for the file name.
813 The last element HOP is the ad-hoc hop definition, which could be a
814 cascade of several hops.
816 These numbers are passed directly to `match-string', which see. That
817 means the opening parentheses are counted to identify the pair.
819 See also `tramp-file-name-regexp'.")
822 (defconst tramp-file-name-regexp-unified
823 (if (memq system-type '(cygwin windows-nt))
824 "\\`/\\(\\[.*\\]\\|[^/|:]\\{2,\\}[^/|]*\\):"
826 "Value for `tramp-file-name-regexp' for unified remoting.
827 See `tramp-file-name-structure' for more explanations.
829 On W32 systems, the volume letter must be ignored.")
832 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
833 "Value for `tramp-file-name-regexp' for separate remoting.
834 See `tramp-file-name-structure' for more explanations.")
837 (defconst tramp-file-name-regexp
838 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
839 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
840 (t (error "Wrong `tramp-syntax' defined")))
841 "Regular expression matching file names handled by Tramp.
842 This regexp should match Tramp file names but no other file names.
843 When tramp.el is loaded, this regular expression is prepended to
844 `file-name-handler-alist', and that is searched sequentially. Thus,
845 if the Tramp entry appears rather early in the `file-name-handler-alist'
846 and is a bit too general, then some files might be considered Tramp
847 files which are not really Tramp files.
849 Please note that the entry in `file-name-handler-alist' is made when
850 this file \(tramp.el) is loaded. This means that this variable must be set
851 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
852 updated after changing this variable.
854 Also see `tramp-file-name-structure'.")
857 (defconst tramp-completion-file-name-regexp-unified
858 (if (memq system-type '(cygwin windows-nt))
859 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
860 "Value for `tramp-completion-file-name-regexp' for unified remoting.
861 See `tramp-file-name-structure' for more explanations.
863 On W32 systems, the volume letter must be ignored.")
866 (defconst tramp-completion-file-name-regexp-separate
867 "\\`/\\([[][^]]*\\)?\\'"
868 "Value for `tramp-completion-file-name-regexp' for separate remoting.
869 See `tramp-file-name-structure' for more explanations.")
872 (defconst tramp-completion-file-name-regexp
873 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
874 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
875 (t (error "Wrong `tramp-syntax' defined")))
876 "Regular expression matching file names handled by Tramp completion.
877 This regexp should match partial Tramp file names only.
879 Please note that the entry in `file-name-handler-alist' is made when
880 this file \(tramp.el) is loaded. This means that this variable must be set
881 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
882 updated after changing this variable.
884 Also see `tramp-file-name-structure'.")
886 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
887 ;; known to have a bug in `process-send-string'; some ssh connections appear
888 ;; to drop bytes when data is sent too quickly. There is also a connection
889 ;; buffer local variable, which is computed depending on remote host properties
890 ;; when `tramp-chunksize' is zero or nil.
891 (defcustom tramp-chunksize (when (memq system-type '(hpux)) 500)
892 ;; Parentheses in docstring starting at beginning of line are escaped.
893 ;; Fontification is messed up when
894 ;; `open-paren-in-column-0-is-defun-start' set to t.
895 "If non-nil, chunksize for sending input to local process.
896 It is necessary only on systems which have a buggy `process-send-string'
897 implementation. The necessity, whether this variable must be set, can be
898 checked via the following code:
901 (let* ((user \"xxx\") (host \"yyy\")
903 (sent init) (received init))
904 (while (= sent received)
905 (setq sent (+ sent step))
907 (let ((proc (start-process (buffer-name) (current-buffer)
908 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
909 (when (memq (process-status proc) \\='(run open))
910 (process-send-string proc (make-string sent ?\\ ))
911 (process-send-eof proc)
912 (process-send-eof proc))
913 (while (not (progn (goto-char (point-min))
914 (re-search-forward \"\\\\w+\" (point-max) t)))
915 (accept-process-output proc 1))
916 (when (memq (process-status proc) \\='(run open))
917 (setq received (string-to-number (match-string 0)))
918 (delete-process proc)
919 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
921 (if (> sent (+ init step))
922 (message \"You should set `tramp-chunksize' to a maximum of %s\"
924 (message \"Test does not work\")
925 (display-buffer (current-buffer))
928 In the Emacs normally running Tramp, evaluate the above code
929 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
930 respectively). You can do this, for example, by pasting it into
931 the `*scratch*' buffer and then hitting C-j with the cursor after the
932 last closing parenthesis. Note that it works only if you have configured
933 \"ssh\" to run without password query, see ssh-agent(1).
935 You will see the number of bytes sent successfully to the remote host.
936 If that number exceeds 1000, you can stop the execution by hitting
937 C-g, because your Emacs is likely clean.
939 When it is necessary to set `tramp-chunksize', you might consider to
940 use an out-of-the-band method \(like \"scp\") instead of an internal one
941 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
944 If your Emacs is buggy, the code stops and gives you an indication
945 about the value `tramp-chunksize' should be set. Maybe you could just
946 experiment a bit, e.g. changing the values of `init' and `step'
947 in the third line of the code.
949 Please raise a bug report via \"M-x tramp-bug\" if your system needs
950 this variable to be set as well."
952 :type '(choice (const nil) integer))
954 ;; Logging in to a remote host normally requires obtaining a pty. But
955 ;; Emacs on MacOS X has process-connection-type set to nil by default,
956 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
957 ;; for an override of the system default.
958 (defcustom tramp-process-connection-type t
959 "Overrides `process-connection-type' for connections from Tramp.
960 Tramp binds `process-connection-type' to the value given here before
961 opening a connection to a remote host."
963 :type '(choice (const nil) (const t) (const pty)))
965 (defcustom tramp-connection-timeout 60
966 "Defines the max time to wait for establishing a connection (in seconds).
967 This can be overwritten for different connection types in `tramp-methods'.
969 The timeout does not include the time reading a password."
974 (defcustom tramp-connection-min-time-diff 5
975 "Defines seconds between two consecutive connection attempts.
976 This is necessary as self defense mechanism, in order to avoid
977 yo-yo connection attempts when the remote host is unavailable.
979 A value of 0 or nil suppresses this check. This might be
980 necessary, when several out-of-order copy operations are
981 performed, or when several asynchronous processes will be started
982 in a short time frame. In those cases it is recommended to
983 let-bind this variable."
986 :type '(choice (const nil) integer))
988 (defcustom tramp-completion-reread-directory-timeout 10
989 "Defines seconds since last remote command before rereading a directory.
990 A remote directory might have changed its contents. In order to
991 make it visible during file name completion in the minibuffer,
992 Tramp flushes its cache and rereads the directory contents when
993 more than `tramp-completion-reread-directory-timeout' seconds
994 have been gone since last remote command execution. A value of t
995 would require an immediate reread during filename completion, nil
996 means to use always cached values for the directory contents."
998 :type '(choice (const nil) (const t) integer))
1000 ;;; Internal Variables:
1002 (defvar tramp-current-method nil
1003 "Connection method for this *tramp* buffer.")
1005 (defvar tramp-current-user nil
1006 "Remote login name for this *tramp* buffer.")
1008 (defvar tramp-current-host nil
1009 "Remote host for this *tramp* buffer.")
1011 (defvar tramp-current-connection nil
1012 "Last connection timestamp.")
1015 (defconst tramp-completion-file-name-handler-alist
1016 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1017 (file-name-completion . tramp-completion-handle-file-name-completion))
1018 "Alist of completion handler functions.
1019 Used for file names matching `tramp-file-name-regexp'. Operations
1020 not mentioned here will be handled by Tramp's file name handler
1021 functions, or the normal Emacs functions.")
1023 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1024 ;;;###tramp-autoload
1025 (defvar tramp-foreign-file-name-handler-alist nil
1026 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1027 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1030 ;;; Internal functions which must come first:
1032 (defsubst tramp-user-error (vec-or-proc format &rest args)
1033 "Signal a pilot error."
1035 'tramp-error vec-or-proc
1036 (if (fboundp 'user-error) 'user-error 'error) format args))
1038 ;; Conversion functions between external representation and
1039 ;; internal data structure. Convenience functions for internal
1042 (defun tramp-get-method-parameter (vec param)
1043 "Return the method parameter PARAM.
1044 If VEC is a vector, check first in connection properties.
1045 Afterwards, check in `tramp-methods'. If the `tramp-methods'
1046 entry does not exist, return nil."
1048 (replace-regexp-in-string "^tramp-" "" (symbol-name param))))
1049 (if (tramp-connection-property-p vec hash-entry)
1050 ;; We use the cached property.
1051 (tramp-get-connection-property vec hash-entry nil)
1052 ;; Use the static value from `tramp-methods'.
1053 (let ((methods-entry
1054 (assoc param (assoc (tramp-file-name-method vec) tramp-methods))))
1055 (when methods-entry (cadr methods-entry))))))
1057 (defun tramp-file-name-p (vec)
1058 "Check, whether VEC is a Tramp object."
1059 (and (vectorp vec) (= 5 (length vec))))
1061 (defun tramp-file-name-method (vec)
1062 "Return method component of VEC."
1063 (and (tramp-file-name-p vec) (aref vec 0)))
1065 (defun tramp-file-name-user (vec)
1066 "Return user component of VEC."
1067 (and (tramp-file-name-p vec) (aref vec 1)))
1069 (defun tramp-file-name-host (vec)
1070 "Return host component of VEC."
1071 (and (tramp-file-name-p vec) (aref vec 2)))
1073 (defun tramp-file-name-localname (vec)
1074 "Return localname component of VEC."
1075 (and (tramp-file-name-p vec) (aref vec 3)))
1077 (defun tramp-file-name-hop (vec)
1078 "Return hop component of VEC."
1079 (and (tramp-file-name-p vec) (aref vec 4)))
1081 ;; The user part of a Tramp file name vector can be of kind
1082 ;; "user%domain". Sometimes, we must extract these parts.
1083 (defun tramp-file-name-real-user (vec)
1084 "Return the user name of VEC without domain."
1086 (let ((user (tramp-file-name-user vec)))
1087 (if (and (stringp user)
1088 (string-match tramp-user-with-domain-regexp user))
1089 (match-string 1 user)
1092 (defun tramp-file-name-domain (vec)
1093 "Return the domain name of VEC."
1095 (let ((user (tramp-file-name-user vec)))
1097 (string-match tramp-user-with-domain-regexp user)
1098 (match-string 2 user)))))
1100 ;; The host part of a Tramp file name vector can be of kind
1101 ;; "host#port". Sometimes, we must extract these parts.
1102 (defun tramp-file-name-real-host (vec)
1103 "Return the host name of VEC without port."
1105 (let ((host (tramp-file-name-host vec)))
1106 (if (and (stringp host)
1107 (string-match tramp-host-with-port-regexp host))
1108 (match-string 1 host)
1111 (defun tramp-file-name-port (vec)
1112 "Return the port number of VEC."
1114 (let ((method (tramp-file-name-method vec))
1115 (host (tramp-file-name-host vec)))
1116 (or (and (stringp host)
1117 (string-match tramp-host-with-port-regexp host)
1118 (string-to-number (match-string 2 host)))
1119 (tramp-get-method-parameter vec 'tramp-default-port)))))
1121 ;;;###tramp-autoload
1122 (defun tramp-tramp-file-p (name)
1123 "Return t if NAME is a string with Tramp file name syntax."
1126 (string-match tramp-file-name-regexp name))))
1128 ;; Obsoleted with Tramp 2.2.7.
1129 (defconst tramp-obsolete-methods
1130 '("ssh1" "ssh2" "scp1" "scp2" "scpc" "rsyncc" "plink1")
1131 "Obsolete methods.")
1133 (defvar tramp-warned-obsolete-methods nil
1134 "Which methods the user has been warned to be obsolete.")
1136 (defun tramp-find-method (method user host)
1137 "Return the right method string to use.
1138 This is METHOD, if non-nil. Otherwise, do a lookup in
1139 `tramp-default-method-alist'. It maps also obsolete methods to
1143 (let ((choices tramp-default-method-alist)
1146 (setq item (pop choices))
1147 (when (and (string-match (or (nth 0 item) "") (or host ""))
1148 (string-match (or (nth 1 item) "") (or user "")))
1149 (setq lmethod (nth 2 item))
1150 (setq choices nil)))
1152 tramp-default-method)))
1153 ;; This is needed for a transition period only.
1154 (when (member result tramp-obsolete-methods)
1155 (unless (member result tramp-warned-obsolete-methods)
1157 (warn "Method %s is obsolete, using %s"
1158 result (substring result 0 -1))
1159 (unless (y-or-n-p (format "Method \"%s\" is obsolete, use \"%s\"? "
1160 result (substring result 0 -1)))
1161 (tramp-user-error nil "Method \"%s\" not supported" result)))
1162 (add-to-list 'tramp-warned-obsolete-methods result))
1163 ;; This works with the current set of `tramp-obsolete-methods'.
1164 ;; Must be improved, if their are more sophisticated replacements.
1165 (setq result (substring result 0 -1)))
1166 ;; We must mark, whether a default value has been used.
1167 (if (or method (null result))
1169 (propertize result 'tramp-default t))))
1171 (defun tramp-find-user (method user host)
1172 "Return the right user string to use.
1173 This is USER, if non-nil. Otherwise, do a lookup in
1174 `tramp-default-user-alist'."
1177 (let ((choices tramp-default-user-alist)
1180 (setq item (pop choices))
1181 (when (and (string-match (or (nth 0 item) "") (or method ""))
1182 (string-match (or (nth 1 item) "") (or host "")))
1183 (setq luser (nth 2 item))
1184 (setq choices nil)))
1186 tramp-default-user)))
1187 ;; We must mark, whether a default value has been used.
1188 (if (or user (null result))
1190 (propertize result 'tramp-default t))))
1192 (defun tramp-find-host (method user host)
1193 "Return the right host string to use.
1194 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1195 (or (and (> (length host) 0) host)
1196 (let ((choices tramp-default-host-alist)
1199 (setq item (pop choices))
1200 (when (and (string-match (or (nth 0 item) "") (or method ""))
1201 (string-match (or (nth 1 item) "") (or user "")))
1202 (setq lhost (nth 2 item))
1203 (setq choices nil)))
1205 tramp-default-host))
1207 (defun tramp-check-proper-method-and-host (vec)
1208 "Check method and host name of VEC."
1209 (let ((method (tramp-file-name-method vec))
1210 (user (tramp-file-name-user vec))
1211 (host (tramp-file-name-host vec))
1212 (methods (mapcar 'car tramp-methods)))
1213 (when (and method (not (member method methods)))
1214 (tramp-cleanup-connection vec)
1215 (tramp-user-error vec "Unknown method \"%s\"" method))
1216 (when (and (equal tramp-syntax 'ftp) host
1217 (or (null method) (get-text-property 0 'tramp-default method))
1218 (or (null user) (get-text-property 0 'tramp-default user))
1219 (member host methods))
1220 (tramp-cleanup-connection vec)
1221 (tramp-user-error vec "Host name must not match method \"%s\"" host))))
1223 (defun tramp-dissect-file-name (name &optional nodefault)
1224 "Return a `tramp-file-name' structure.
1225 The structure consists of remote method, remote user, remote host,
1226 localname (file name on remote host) and hop. If NODEFAULT is
1227 non-nil, the file name parts are not expanded to their default
1230 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1231 (unless match (tramp-user-error nil "Not a Tramp file name: \"%s\"" name))
1232 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1233 (user (match-string (nth 2 tramp-file-name-structure) name))
1234 (host (match-string (nth 3 tramp-file-name-structure) name))
1235 (localname (match-string (nth 4 tramp-file-name-structure) name))
1236 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1238 (when (string-match tramp-prefix-ipv6-regexp host)
1239 (setq host (replace-match "" nil t host)))
1240 (when (string-match tramp-postfix-ipv6-regexp host)
1241 (setq host (replace-match "" nil t host))))
1243 (vector method user host localname hop)
1245 (tramp-find-method method user host)
1246 (tramp-find-user method user host)
1247 (tramp-find-host method user host)
1250 (defun tramp-buffer-name (vec)
1251 "A name for the connection buffer VEC."
1252 ;; We must use `tramp-file-name-real-host', because for gateway
1253 ;; methods the default port will be expanded later on, which would
1255 (let ((method (tramp-file-name-method vec))
1256 (user (tramp-file-name-user vec))
1257 (host (tramp-file-name-real-host vec)))
1258 (if (not (zerop (length user)))
1259 (format "*tramp/%s %s@%s*" method user host)
1260 (format "*tramp/%s %s*" method host))))
1262 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1263 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1264 When not nil, an optional HOP is prepended."
1265 (concat tramp-prefix-format hop
1266 (when (not (zerop (length method)))
1267 (concat method tramp-postfix-method-format))
1268 (when (not (zerop (length user)))
1269 (concat user tramp-postfix-user-format))
1271 (if (string-match tramp-ipv6-regexp host)
1272 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1274 tramp-postfix-host-format
1275 (when localname localname)))
1277 (defun tramp-completion-make-tramp-file-name (method user host localname)
1278 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1279 It must not be a complete Tramp file name, but as long as there are
1280 necessary only. This function will be used in file name completion."
1281 (concat tramp-prefix-format
1282 (when (not (zerop (length method)))
1283 (concat method tramp-postfix-method-format))
1284 (when (not (zerop (length user)))
1285 (concat user tramp-postfix-user-format))
1286 (when (not (zerop (length host)))
1288 (if (string-match tramp-ipv6-regexp host)
1290 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1292 tramp-postfix-host-format))
1293 (when localname localname)))
1295 (defun tramp-get-buffer (vec)
1296 "Get the connection buffer to be used for VEC."
1297 (or (get-buffer (tramp-buffer-name vec))
1298 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1299 (setq buffer-undo-list t)
1300 (setq default-directory
1301 (tramp-make-tramp-file-name
1302 (tramp-file-name-method vec)
1303 (tramp-file-name-user vec)
1304 (tramp-file-name-host vec)
1308 (defun tramp-get-connection-buffer (vec)
1309 "Get the connection buffer to be used for VEC.
1310 In case a second asynchronous communication has been started, it is different
1311 from `tramp-get-buffer'."
1312 (or (tramp-get-connection-property vec "process-buffer" nil)
1313 (tramp-get-buffer vec)))
1315 (defun tramp-get-connection-name (vec)
1316 "Get the connection name to be used for VEC.
1317 In case a second asynchronous communication has been started, it is different
1318 from the default one."
1319 (or (tramp-get-connection-property vec "process-name" nil)
1320 (tramp-buffer-name vec)))
1322 (defun tramp-get-connection-process (vec)
1323 "Get the connection process to be used for VEC.
1324 In case a second asynchronous communication has been started, it is different
1325 from the default one."
1326 (get-process (tramp-get-connection-name vec)))
1328 (defun tramp-debug-buffer-name (vec)
1329 "A name for the debug buffer for VEC."
1330 ;; We must use `tramp-file-name-real-host', because for gateway
1331 ;; methods the default port will be expanded later on, which would
1333 (let ((method (tramp-file-name-method vec))
1334 (user (tramp-file-name-user vec))
1335 (host (tramp-file-name-real-host vec)))
1336 (if (not (zerop (length user)))
1337 (format "*debug tramp/%s %s@%s*" method user host)
1338 (format "*debug tramp/%s %s*" method host))))
1340 (defconst tramp-debug-outline-regexp
1341 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1342 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1344 (defun tramp-debug-outline-level ()
1345 "Return the depth to which a statement is nested in the outline.
1346 Point must be at the beginning of a header line.
1348 The outline level is equal to the verbosity of the Tramp message."
1349 (1+ (string-to-number (match-string 1))))
1351 (defun tramp-get-debug-buffer (vec)
1352 "Get the debug buffer for VEC."
1353 (with-current-buffer
1354 (get-buffer-create (tramp-debug-buffer-name vec))
1356 (setq buffer-undo-list t)
1357 ;; So it does not get loaded while `outline-regexp' is let-bound.
1359 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1360 ;; `outline-mode-hook'. We must prevent that local processes
1361 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1362 ;; Furthermore, `outline-regexp' must have the correct value
1363 ;; already, because it is used by `font-lock-compile-keywords'.
1364 (let ((default-directory (tramp-compat-temporary-file-directory))
1365 (outline-regexp tramp-debug-outline-regexp))
1367 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1368 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1371 (defsubst tramp-debug-message (vec fmt-string &rest arguments)
1372 "Append message to debug buffer.
1373 Message is formatted with FMT-STRING as control string and the remaining
1374 ARGUMENTS to actually emit the message (if applicable)."
1375 (with-current-buffer (tramp-get-debug-buffer vec)
1376 (goto-char (point-max))
1381 ";; Emacs: %s Tramp: %s -*- mode: outline; -*-"
1382 emacs-version tramp-version))
1383 (when (>= tramp-verbose 10)
1386 "\n;; Location: %s Git: %s"
1387 (locate-library "tramp") (tramp-repository-get-version)))))
1391 (let ((now (current-time)))
1392 (insert (format-time-string "%T." now))
1393 (insert (format "%06d " (nth 2 now))))
1394 ;; Calling Tramp function. We suppress compat and trace functions
1395 ;; from being displayed.
1396 (let ((btn 1) btf fn)
1398 (setq btf (nth 1 (backtrace-frame btn)))
1402 (setq fn (symbol-name btf))
1405 (string-match "^tramp" fn)
1412 "tramp-compat-condition-case-unless-debug"
1413 "tramp-compat-funcall"
1414 "tramp-condition-case-unless-debug"
1415 "tramp-debug-message"
1417 "tramp-error-with-buffer"
1424 (setq btn (1+ btn))))
1425 ;; The following code inserts filename and line number. Should
1426 ;; be inactive by default, because it is time consuming.
1427 ; (let ((ffn (find-function-noselect (intern fn))))
1431 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1432 ; (with-current-buffer (car ffn)
1433 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1434 (insert (format "%s " fn)))
1436 (insert (apply #'format-message fmt-string arguments))))
1438 (defvar tramp-message-show-message t
1439 "Show Tramp message in the minibuffer.
1440 This variable is used to disable messages from `tramp-error'.
1441 The messages are visible anyway, because an error is raised.")
1443 (defsubst tramp-message (vec-or-proc level fmt-string &rest arguments)
1444 "Emit a message depending on verbosity level.
1445 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1446 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1447 less than LEVEL. The message is emitted only if `tramp-verbose' is
1448 greater than or equal to LEVEL.
1450 The message is also logged into the debug buffer when `tramp-verbose'
1451 is greater than or equal 4.
1453 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1454 control string and the remaining ARGUMENTS to actually emit the message (if
1457 (when (<= level tramp-verbose)
1458 ;; Match data must be preserved!
1460 ;; Display only when there is a minimum level.
1461 (when (and tramp-message-show-message (<= level 3))
1467 ((= level 2) "Warning: ")
1471 ;; Log only when there is a minimum level.
1472 (when (>= tramp-verbose 4)
1473 ;; Translate proc to vec.
1474 (when (processp vec-or-proc)
1475 (let ((tramp-verbose 0))
1477 (tramp-get-connection-property vec-or-proc "vector" nil))))
1478 ;; Append connection buffer for error messages.
1480 (let ((tramp-verbose 0))
1481 (with-current-buffer (tramp-get-connection-buffer vec-or-proc)
1482 (setq fmt-string (concat fmt-string "\n%s")
1483 arguments (append arguments (list (buffer-string)))))))
1485 (when (vectorp vec-or-proc)
1486 (apply 'tramp-debug-message
1488 (concat (format "(%d) # " level) fmt-string)
1491 (defsubst tramp-backtrace (&optional vec-or-proc)
1492 "Dump a backtrace into the debug buffer.
1493 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1494 function is meant for debugging purposes."
1496 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace)))
1497 (if (>= tramp-verbose 10)
1498 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1500 (defsubst tramp-error (vec-or-proc signal fmt-string &rest arguments)
1502 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1503 signal identifier to be raised, remaining arguments passed to
1504 `tramp-message'. Finally, signal SIGNAL is raised."
1505 (let (tramp-message-show-message)
1506 (tramp-backtrace vec-or-proc)
1510 (error-message-string
1512 (get signal 'error-message)
1513 (apply #'format-message fmt-string arguments)))))
1514 (signal signal (list (apply #'format-message fmt-string arguments)))))
1516 (defsubst tramp-error-with-buffer
1517 (buf vec-or-proc signal fmt-string &rest arguments)
1518 "Emit an error, and show BUF.
1519 If BUF is nil, show the connection buf. Wait for 30\", or until
1520 an input event arrives. The other arguments are passed to `tramp-error'."
1521 (save-window-excursion
1522 (let* ((buf (or (and (bufferp buf) buf)
1523 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1524 (and (vectorp vec-or-proc)
1525 (tramp-get-connection-buffer vec-or-proc))))
1526 (vec (or (and (vectorp vec-or-proc) vec-or-proc)
1527 (and buf (with-current-buffer buf
1528 (tramp-dissect-file-name default-directory))))))
1530 (apply 'tramp-error vec-or-proc signal fmt-string arguments)
1533 tramp-message-show-message
1534 (not (zerop tramp-verbose))
1535 (not (tramp-completion-mode-p))
1536 ;; Show only when Emacs has started already.
1538 (let ((enable-recursive-minibuffers t))
1539 ;; `tramp-error' does not show messages. So we must do it
1541 (apply 'message fmt-string arguments)
1546 ;; Reset timestamp. It would be wrong after waiting for a while.
1547 (when (equal (butlast (append vec nil) 2)
1548 (car tramp-current-connection))
1549 (setcdr tramp-current-connection (current-time)))))))
1551 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1552 "Parse a Tramp filename and make components available in the body.
1554 First arg FILENAME is evaluated and dissected into its components.
1555 Second arg VAR is a symbol. It is used as a variable name to hold
1556 the filename structure. It is also used as a prefix for the variables
1557 holding the components. For example, if VAR is the symbol `foo', then
1558 `foo' will be bound to the whole structure, `foo-method' will be bound to
1559 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1562 Remaining args are Lisp expressions to be evaluated (inside an implicit
1565 If VAR is nil, then we bind `v' to the structure and `method', `user',
1566 `host', `localname', `hop' to the components."
1568 (mapcar (lambda (elem)
1569 `(,(if var (intern (format "%s-%s" var elem)) elem)
1570 (,(intern (format "tramp-file-name-%s" elem))
1572 '(method user host localname hop))))
1573 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1575 ;; We don't know which of those vars will be used, so we bind them all,
1576 ;; and then add here a dummy use of all those variables, so we don't get
1577 ;; flooded by warnings about those vars `body' didn't use.
1578 (ignore ,@(mapcar #'car bindings))
1581 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1582 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1583 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1585 (defun tramp-progress-reporter-update (reporter &optional value)
1586 (let* ((parameters (cdr reporter))
1587 (message (aref parameters 3)))
1588 (when (string-match message (or (current-message) ""))
1589 (progress-reporter-update reporter value))))
1591 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1592 "Executes BODY, spinning a progress reporter with MESSAGE.
1593 If LEVEL does not fit for visible messages, there are only traces
1594 without a visible progress reporter."
1595 (declare (indent 3) (debug t))
1597 (tramp-message ,vec ,level "%s..." ,message)
1598 (let ((cookie "failed")
1600 ;; We start a pulsing progress reporter after 3 seconds. Feature
1601 ;; introduced in Emacs 24.1.
1602 (when (and tramp-message-show-message
1603 ;; Display only when there is a minimum level.
1604 (<= ,level (min tramp-verbose 3)))
1606 (let ((pr (make-progress-reporter ,message nil nil)))
1609 3 0.1 #'tramp-progress-reporter-update pr)))))))
1611 ;; Execute the body.
1612 (prog1 (progn ,@body) (setq cookie "done"))
1613 ;; Stop progress reporter.
1614 (if tm (cancel-timer tm))
1615 (tramp-message ,vec ,level "%s...%s" ,message cookie)))))
1617 (font-lock-add-keywords
1618 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1620 (defmacro with-tramp-file-property (vec file property &rest body)
1621 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1622 FILE must be a local file name on a connection identified via VEC."
1623 `(if (file-name-absolute-p ,file)
1624 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1625 (when (eq value 'undef)
1626 ;; We cannot pass @body as parameter to
1627 ;; `tramp-set-file-property' because it mangles our
1629 (setq value (progn ,@body))
1630 (tramp-set-file-property ,vec ,file ,property value))
1634 (put 'with-tramp-file-property 'lisp-indent-function 3)
1635 (put 'with-tramp-file-property 'edebug-form-spec t)
1636 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1638 (defmacro with-tramp-connection-property (key property &rest body)
1639 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1640 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1641 (when (eq value 'undef)
1642 ;; We cannot pass ,@body as parameter to
1643 ;; `tramp-set-connection-property' because it mangles our debug
1645 (setq value (progn ,@body))
1646 (tramp-set-connection-property ,key ,property value))
1649 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1650 (put 'with-tramp-connection-property 'edebug-form-spec t)
1651 (font-lock-add-keywords
1652 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1654 (defun tramp-drop-volume-letter (name)
1655 "Cut off unnecessary drive letter from file NAME.
1656 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1657 locally on a remote file name. When the local system is a W32 system
1658 but the remote system is Unix, this introduces a superfluous drive
1659 letter into the file name. This function removes it."
1661 (if (string-match "\\`[a-zA-Z]:/" name)
1662 (replace-match "/" nil t name)
1665 ;;; Config Manipulation Functions:
1667 ;;;###tramp-autoload
1668 (defun tramp-set-completion-function (method function-list)
1669 "Sets the list of completion functions for METHOD.
1670 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1671 The FUNCTION is intended to parse FILE according its syntax.
1672 It might be a predefined FUNCTION, or a user defined FUNCTION.
1673 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1677 (tramp-set-completion-function
1679 \\='((tramp-parse-sconfig \"/etc/ssh_config\")
1680 (tramp-parse-sconfig \"~/.ssh/config\")))"
1682 (let ((r function-list)
1684 (setq tramp-completion-function-alist
1685 (delete (assoc method tramp-completion-function-alist)
1686 tramp-completion-function-alist))
1689 ;; Remove double entries.
1690 (when (member (car v) (cdr v))
1691 (setcdr v (delete (car v) (cdr v))))
1692 ;; Check for function and file or registry key.
1693 (unless (and (functionp (nth 0 (car v)))
1695 ;; Windows registry.
1696 ((string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1697 (and (memq system-type '(cygwin windows-nt))
1700 v "reg" nil nil nil "query" (nth 1 (car v))))))
1701 ;; Zeroconf service type.
1703 "^_[[:alpha:]]+\\._[[:alpha:]]+$" (nth 1 (car v))))
1704 ;; Configuration file.
1705 (t (file-exists-p (nth 1 (car v))))))
1706 (setq r (delete (car v) r)))
1710 (add-to-list 'tramp-completion-function-alist
1713 (defun tramp-get-completion-function (method)
1714 "Returns a list of completion functions for METHOD.
1715 For definition of that list see `tramp-set-completion-function'."
1717 ;; Hosts visited once shall be remembered.
1718 `(tramp-parse-connection-properties ,method)
1719 ;; The method related defaults.
1720 (cdr (assoc method tramp-completion-function-alist))))
1723 ;;; Fontification of `read-file-name':
1725 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1726 (defvar tramp-rfn-eshadow-overlay)
1727 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1729 (defun tramp-rfn-eshadow-setup-minibuffer ()
1730 "Set up a minibuffer for `file-name-shadow-mode'.
1731 Adds another overlay hiding filename parts according to Tramp's
1732 special handling of `substitute-in-file-name'."
1733 (when (symbol-value 'minibuffer-completing-file-name)
1734 (setq tramp-rfn-eshadow-overlay
1735 (make-overlay (minibuffer-prompt-end) (minibuffer-prompt-end)))
1736 ;; Copy rfn-eshadow-overlay properties.
1737 (let ((props (overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1739 ;; The `field' property prevents correct minibuffer
1740 ;; completion; we exclude it.
1741 (if (not (eq (car props) 'field))
1742 (overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1743 (pop props) (pop props))))))
1745 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1746 'tramp-rfn-eshadow-setup-minibuffer)
1747 (add-hook 'tramp-unload-hook
1749 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1750 'tramp-rfn-eshadow-setup-minibuffer)))
1752 (defconst tramp-rfn-eshadow-update-overlay-regexp
1753 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1755 (defun tramp-rfn-eshadow-update-overlay ()
1756 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1757 This is intended to be used as a minibuffer `post-command-hook' for
1758 `file-name-shadow-mode'; the minibuffer should have already
1759 been set up by `rfn-eshadow-setup-minibuffer'."
1760 ;; In remote files name, there is a shadowing just for the local part.
1762 (let ((end (or (overlay-end (symbol-value 'rfn-eshadow-overlay))
1763 (minibuffer-prompt-end)))
1764 ;; We do not want to send any remote command.
1768 (buffer-substring-no-properties end (point-max)))
1772 (1+ (or (string-match
1773 tramp-rfn-eshadow-update-overlay-regexp
1774 (buffer-string) end)
1777 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1778 (rfn-eshadow-update-overlay-hook nil)
1779 file-name-handler-alist)
1780 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
1781 (rfn-eshadow-update-overlay))))))))
1783 (add-hook 'rfn-eshadow-update-overlay-hook
1784 'tramp-rfn-eshadow-update-overlay)
1785 (add-hook 'tramp-unload-hook
1787 (remove-hook 'rfn-eshadow-update-overlay-hook
1788 'tramp-rfn-eshadow-update-overlay)))
1790 ;; Inodes don't exist for some file systems. Therefore we must
1791 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1792 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1793 ;; performance isn't the major issue given that file transfer will
1795 (defvar tramp-inodes 0
1796 "Keeps virtual inodes numbers.")
1798 ;; Devices must distinguish physical file systems. The device numbers
1799 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1800 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1801 ;; EFS use device number "-1". In order to be different, we use device number
1802 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1803 (defvar tramp-devices 0
1804 "Keeps virtual device numbers.")
1806 (defun tramp-default-file-modes (filename)
1807 "Return file modes of FILENAME as integer.
1808 If the file modes of FILENAME cannot be determined, return the
1809 value of `default-file-modes', without execute permissions."
1810 (or (file-modes filename)
1811 (logand (default-file-modes) (string-to-number "0666" 8))))
1813 (defun tramp-replace-environment-variables (filename)
1814 "Replace environment variables in FILENAME.
1815 Return the string with the replaced variables."
1817 ;; Optional arg has been introduced with Emacs 24 (?).
1818 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1819 ;; We need an own implementation.
1821 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1822 ;; `$' is coded as `$$'.
1824 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1825 (getenv (match-string 1 filename)))
1828 (substitute-in-file-name (match-string 0 filename))
1832 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1833 "Like `find-operation-coding-system' for Tramp filenames.
1834 Tramp's `insert-file-contents' and `write-region' work over
1835 temporary file names. If `file-coding-system-alist' contains an
1836 expression, which matches more than the file name suffix, the
1837 coding system might not be determined. This function repairs it."
1839 (dolist (elt file-coding-system-alist result)
1840 (when (and (consp elt) (string-match (car elt) filename))
1841 ;; We found a matching entry in `file-coding-system-alist'.
1842 ;; So we add a similar entry, but with the temporary file name
1845 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1847 (defun tramp-run-real-handler (operation args)
1848 "Invoke normal file name handler for OPERATION.
1849 First arg specifies the OPERATION, second arg is a list of arguments to
1850 pass to the OPERATION."
1851 (let* ((inhibit-file-name-handlers
1852 `(tramp-file-name-handler
1853 tramp-vc-file-name-handler
1854 tramp-completion-file-name-handler
1855 cygwin-mount-name-hook-function
1856 cygwin-mount-map-drive-hook-function
1858 ,(and (eq inhibit-file-name-operation operation)
1859 inhibit-file-name-handlers)))
1860 (inhibit-file-name-operation operation))
1861 (apply operation args)))
1864 (progn (defun tramp-completion-run-real-handler (operation args)
1865 "Invoke `tramp-file-name-handler' for OPERATION.
1866 First arg specifies the OPERATION, second arg is a list of arguments to
1867 pass to the OPERATION."
1868 (let* ((inhibit-file-name-handlers
1869 `(tramp-completion-file-name-handler
1870 cygwin-mount-name-hook-function
1871 cygwin-mount-map-drive-hook-function
1873 ,(and (eq inhibit-file-name-operation operation)
1874 inhibit-file-name-handlers)))
1875 (inhibit-file-name-operation operation))
1876 (apply operation args))))
1878 ;; We handle here all file primitives. Most of them have the file
1879 ;; name as first parameter; nevertheless we check for them explicitly
1880 ;; in order to be signaled if a new primitive appears. This
1881 ;; scenario is needed because there isn't a way to decide by
1882 ;; syntactical means whether a foreign method must be called. It would
1883 ;; ease the life if `file-name-handler-alist' would support a decision
1884 ;; function as well but regexp only.
1885 (defun tramp-file-name-for-operation (operation &rest args)
1886 "Return file name related to OPERATION file primitive.
1887 ARGS are the arguments OPERATION has been called with."
1889 ;; FILE resp DIRECTORY.
1891 '(access-file byte-compiler-base-file-name delete-directory
1892 delete-file diff-latest-backup-file directory-file-name
1893 directory-files directory-files-and-attributes
1894 dired-compress-file dired-uncache
1895 file-accessible-directory-p file-attributes
1896 file-directory-p file-executable-p file-exists-p
1897 file-local-copy file-modes
1898 file-name-as-directory file-name-directory
1899 file-name-nondirectory file-name-sans-versions
1900 file-ownership-preserved-p file-readable-p
1901 file-regular-p file-remote-p file-symlink-p file-truename
1902 file-writable-p find-backup-file-name find-file-noselect
1903 get-file-buffer insert-directory insert-file-contents
1904 load make-directory make-directory-internal
1905 set-file-modes set-file-times substitute-in-file-name
1906 unhandled-file-name-directory vc-registered
1908 file-acl file-notify-add-watch file-selinux-context
1909 set-file-acl set-file-selinux-context))
1910 (if (file-name-absolute-p (nth 0 args))
1912 (expand-file-name (nth 0 args))))
1913 ;; FILE DIRECTORY resp FILE1 FILE2.
1915 '(add-name-to-file copy-directory copy-file expand-file-name
1916 file-name-all-completions file-name-completion
1917 file-newer-than-file-p make-symbolic-link rename-file
1919 file-equal-p file-in-directory-p))
1922 ((tramp-tramp-file-p (nth 0 args)) (nth 0 args))
1923 ((tramp-tramp-file-p (nth 1 args)) (nth 1 args))
1924 (t (buffer-file-name (current-buffer))))))
1926 ((eq operation 'write-region)
1930 '(make-auto-save-file-name
1931 set-visited-file-modtime verify-visited-file-modtime))
1933 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1936 '(process-file shell-command start-file-process))
1940 '(;; Emacs 24+ only.
1941 file-notify-rm-watch
1943 file-notify-valid-p))
1944 (when (processp (nth 0 args))
1945 (with-current-buffer (process-buffer (nth 0 args))
1946 default-directory)))
1947 ;; Unknown file primitive.
1948 (t (error "unknown file I/O primitive: %s" operation))))
1950 (defun tramp-find-foreign-file-name-handler (filename)
1951 "Return foreign file name handler if exists."
1952 (when (tramp-tramp-file-p filename)
1953 (let ((v (tramp-dissect-file-name filename t))
1954 (handler tramp-foreign-file-name-handler-alist)
1956 ;; When we are not fully sure that filename completion is safe,
1957 ;; we should not return a handler.
1958 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
1959 (and (tramp-file-name-host v)
1960 (not (member (tramp-file-name-host v)
1961 (mapcar 'car tramp-methods))))
1962 (not (tramp-completion-mode-p)))
1964 (setq elt (car handler)
1965 handler (cdr handler))
1966 (when (funcall (car elt) filename)
1971 (defvar tramp-debug-on-error nil
1972 "Like `debug-on-error' but used Tramp internal.")
1974 (defmacro tramp-condition-case-unless-debug
1975 (var bodyform &rest handlers)
1976 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
1977 `(let ((debug-on-error tramp-debug-on-error))
1978 (tramp-compat-condition-case-unless-debug ,var ,bodyform ,@handlers)))
1981 (defun tramp-file-name-handler (operation &rest args)
1982 "Invoke Tramp file name handler.
1983 Falls back to normal file name handler if no Tramp file name handler exists."
1987 (tramp-replace-environment-variables
1988 (apply 'tramp-file-name-for-operation operation args)))
1989 (completion (tramp-completion-mode-p))
1990 (foreign (tramp-find-foreign-file-name-handler filename)))
1991 (with-parsed-tramp-file-name filename nil
1992 ;; Call the backend function.
1994 (tramp-condition-case-unless-debug err
1995 (let ((sf (symbol-function foreign))
1997 ;; Some packages set the default directory to a
1998 ;; remote path, before respective Tramp packages
1999 ;; are already loaded. This results in
2000 ;; recursive loading. Therefore, we load the
2001 ;; Tramp packages locally.
2002 (when (and (listp sf) (eq (car sf) 'autoload))
2003 (let ((default-directory
2004 (tramp-compat-temporary-file-directory)))
2005 (load (cadr sf) 'noerror 'nomessage)))
2006 ;; If `non-essential' is non-nil, Tramp shall
2007 ;; not open a new connection.
2008 ;; If Tramp detects that it shouldn't continue
2009 ;; to work, it throws the `suppress' event.
2010 ;; This could happen for example, when Tramp
2011 ;; tries to open the same connection twice in a
2012 ;; short time frame.
2013 ;; In both cases, we try the default handler then.
2015 (catch 'non-essential
2017 (apply foreign operation args))))
2019 ((eq result 'non-essential)
2021 v 5 "Non-essential received in operation %s"
2022 (cons operation args))
2023 (tramp-run-real-handler operation args))
2024 ((eq result 'suppress)
2025 (let (tramp-message-show-message)
2027 v 1 "Suppress received in operation %s"
2028 (cons operation args))
2029 (tramp-cleanup-connection v t)
2030 (tramp-run-real-handler operation args)))
2033 ;; Trace that somebody has interrupted the operation.
2035 (let (tramp-message-show-message)
2037 v 1 "Interrupt received in operation %s"
2038 (cons operation args)))
2039 ;; Propagate the quit signal.
2040 (signal (car err) (cdr err)))
2042 ;; When we are in completion mode, some failed
2043 ;; operations shall return at least a default value
2044 ;; in order to give the user a chance to correct the
2045 ;; file name in the minibuffer.
2046 ;; In order to get a full backtrace, one could apply
2047 ;; (setq tramp-debug-on-error t)
2050 ((and completion (zerop (length localname))
2051 (memq operation '(file-exists-p file-directory-p)))
2053 ((and completion (zerop (length localname))
2055 '(expand-file-name file-name-as-directory)))
2057 ;; Propagate the error.
2058 (t (signal (car err) (cdr err))))))
2060 ;; Nothing to do for us.
2061 (tramp-run-real-handler operation args)))))
2063 ;; When `tramp-mode' is not enabled, we don't do anything.
2064 (tramp-run-real-handler operation args)))
2066 ;; In Emacs, there is some concurrency due to timers. If a timer
2067 ;; interrupts Tramp and wishes to use the same connection buffer as
2068 ;; the "main" Emacs, then garbage might occur in the connection
2069 ;; buffer. Therefore, we need to make sure that a timer does not use
2070 ;; the same connection buffer as the "main" Emacs. We implement a
2071 ;; cheap global lock, instead of locking each connection buffer
2072 ;; separately. The global lock is based on two variables,
2073 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2074 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2075 ;; processing of a single file operation, so we need to allow
2076 ;; recursive calls. That's where the `tramp-locker' variable comes in
2077 ;; -- it is let-bound to t during the execution of the current
2078 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2079 ;; then we should just proceed because we have been called
2080 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2081 ;; interrupting the "main" Emacs, and then we signal an error.
2083 (defvar tramp-locked nil
2084 "If non-nil, then Tramp is currently busy.
2085 Together with `tramp-locker', this implements a locking mechanism
2086 preventing reentrant calls of Tramp.")
2088 (defvar tramp-locker nil
2089 "If non-nil, then a caller has locked Tramp.
2090 Together with `tramp-locked', this implements a locking mechanism
2091 preventing reentrant calls of Tramp.")
2094 (progn (defun tramp-completion-file-name-handler (operation &rest args)
2095 "Invoke Tramp file name completion handler.
2096 Falls back to normal file name handler if no Tramp file name handler exists."
2097 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
2099 ;; When `tramp-mode' is not enabled, we don't do anything.
2101 ;; For other syntaxes than `sep', the regexp matches many common
2102 ;; situations where the user doesn't actually want to use Tramp.
2103 ;; So to avoid autoloading Tramp after typing just "/s", we
2104 ;; disable this part of the completion, unless the user implicitly
2105 ;; indicated his interest in using a fancier completion system.
2106 (or (eq tramp-syntax 'sep)
2107 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2108 ;; `partial-completion-mode' is obsoleted with Emacs 24.1.
2109 (and (boundp 'partial-completion-mode)
2110 (symbol-value 'partial-completion-mode))
2111 ;; FIXME: These may have been loaded even if the user never
2112 ;; intended to use them.
2114 (featurep 'icicles)))
2115 (save-match-data (apply (cdr fn) args))
2116 (tramp-completion-run-real-handler operation args)))))
2119 (progn (defun tramp-autoload-file-name-handler (operation &rest args)
2120 "Load Tramp file name handler, and perform OPERATION."
2121 ;; Avoid recursive loading of tramp.el.
2122 (let ((default-directory temporary-file-directory))
2123 (load "tramp" nil t))
2124 (apply operation args)))
2126 ;; `tramp-autoload-file-name-handler' must be registered before
2127 ;; evaluation of site-start and init files, because there might exist
2128 ;; remote files already, f.e. files kept via recentf-mode. We cannot
2129 ;; autoload `tramp-file-name-handler', because it would result in
2130 ;; recursive loading of tramp.el when `default-directory' is set to
2133 (progn (defun tramp-register-autoload-file-name-handlers ()
2134 "Add Tramp file name handlers to `file-name-handler-alist' during autoload."
2135 (add-to-list 'file-name-handler-alist
2136 (cons tramp-file-name-regexp
2137 'tramp-autoload-file-name-handler))
2138 (put 'tramp-autoload-file-name-handler 'safe-magic t)
2139 (add-to-list 'file-name-handler-alist
2140 (cons tramp-completion-file-name-regexp
2141 'tramp-completion-file-name-handler))
2142 (put 'tramp-completion-file-name-handler 'safe-magic t)))
2145 (tramp-register-autoload-file-name-handlers)
2147 (defun tramp-register-file-name-handlers ()
2148 "Add Tramp file name handlers to `file-name-handler-alist'."
2149 ;; Remove autoloaded handlers from file name handler alist. Useful,
2150 ;; if `tramp-syntax' has been changed.
2151 (dolist (fnh '(tramp-file-name-handler
2152 tramp-completion-file-name-handler
2153 tramp-autoload-file-name-handler))
2154 (let ((a1 (rassq fnh file-name-handler-alist)))
2155 (setq file-name-handler-alist (delq a1 file-name-handler-alist))))
2156 ;; Add the handlers.
2157 (add-to-list 'file-name-handler-alist
2158 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2159 (put 'tramp-file-name-handler 'safe-magic t)
2160 (add-to-list 'file-name-handler-alist
2161 (cons tramp-completion-file-name-regexp
2162 'tramp-completion-file-name-handler))
2163 (put 'tramp-completion-file-name-handler 'safe-magic t)
2164 ;; If jka-compr or epa-file are already loaded, move them to the
2165 ;; front of `file-name-handler-alist'.
2166 (dolist (fnh '(epa-file-handler jka-compr-handler))
2167 (let ((entry (rassoc fnh file-name-handler-alist)))
2169 (setq file-name-handler-alist
2170 (cons entry (delete entry file-name-handler-alist)))))))
2172 (eval-after-load 'tramp (tramp-register-file-name-handlers))
2174 (defun tramp-exists-file-name-handler (operation &rest args)
2175 "Check, whether OPERATION runs a file name handler."
2176 ;; The file name handler is determined on base of either an
2177 ;; argument, `buffer-file-name', or `default-directory'.
2179 (let* ((buffer-file-name "/")
2180 (default-directory "/")
2181 (fnha file-name-handler-alist)
2182 (check-file-name-operation operation)
2183 (file-name-handler-alist
2186 (lambda (operation &rest args)
2187 "Returns OPERATION if it is the one to be checked."
2188 (if (equal check-file-name-operation operation)
2190 (let ((file-name-handler-alist fnha))
2191 (apply operation args))))))))
2192 (equal (apply operation args) operation))))
2195 (defun tramp-unload-file-name-handlers ()
2196 (setq file-name-handler-alist
2197 (delete (rassoc 'tramp-file-name-handler
2198 file-name-handler-alist)
2199 (delete (rassoc 'tramp-completion-file-name-handler
2200 file-name-handler-alist)
2201 file-name-handler-alist))))
2203 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2205 ;;; File name handler functions for completion mode:
2207 (defvar tramp-completion-mode nil
2208 "If non-nil, external packages signal that they are in file name completion.
2210 This is necessary, because Tramp uses a heuristic depending on last
2211 input event. This fails when external packages use other characters
2212 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2213 should never be set globally, the intention is to let-bind it.")
2215 ;; Necessary because `tramp-file-name-regexp-unified' and
2216 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2217 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2218 ;; to `tramp-file-name-handler'). Otherwise, it takes
2219 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2220 ;; risky, because completing a file might require loading other files,
2221 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2222 ;; variable. On the other hand, those files shouldn't have partial
2223 ;; Tramp file name syntax. Maybe another variable should be introduced
2224 ;; overwriting this check in such cases. Or we change Tramp file name
2225 ;; syntax in order to avoid ambiguities.
2226 ;;;###tramp-autoload
2227 (defun tramp-completion-mode-p ()
2228 "Check, whether method / user name / host name completion is active."
2230 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2231 (and (boundp 'non-essential) (symbol-value 'non-essential))
2232 tramp-completion-mode
2233 (equal last-input-event 'tab)
2234 (and (natnump last-input-event)
2236 ;; ?\t has event-modifier 'control.
2237 (equal last-input-event ?\t)
2238 (and (not (event-modifiers last-input-event))
2239 (or (equal last-input-event ?\?)
2240 (equal last-input-event ?\ )))))))
2242 (defun tramp-connectable-p (filename)
2243 "Check, whether it is possible to connect the remote host w/o side-effects.
2244 This is true, if either the remote host is already connected, or if we are
2245 not in completion mode."
2246 (and (tramp-tramp-file-p filename)
2247 (with-parsed-tramp-file-name filename nil
2248 (or (not (tramp-completion-mode-p))
2249 (let* ((tramp-verbose 0)
2250 (p (tramp-get-connection-process v)))
2251 (and p (processp p) (memq (process-status p) '(run open))))))))
2253 ;; Method, host name and user name completion.
2254 ;; `tramp-completion-dissect-file-name' returns a list of
2255 ;; tramp-file-name structures. For all of them we return possible completions.
2257 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2258 "Like `file-name-all-completions' for partial Tramp files."
2261 (tramp-drop-volume-letter (expand-file-name filename directory)))
2264 ;; Suppress hop from completion.
2268 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2269 tramp-postfix-hop-regexp
2272 (setq hop (match-string 1 fullname)
2273 fullname (replace-match "" nil nil fullname 1)))
2275 ;; Possible completion structures.
2276 (dolist (elt (tramp-completion-dissect-file-name fullname))
2277 (let* ((method (tramp-file-name-method elt))
2278 (user (tramp-file-name-user elt))
2279 (host (tramp-file-name-host elt))
2280 (localname (tramp-file-name-localname elt))
2281 (m (tramp-find-method method user host))
2282 (tramp-current-user user) ; see `tramp-parse-passwd'
2285 (unless localname ;; Nothing to complete.
2289 ;; Method dependent user / host combinations.
2293 (setq all-user-hosts
2294 (append all-user-hosts
2295 (funcall (nth 0 x) (nth 1 x)))))
2296 (tramp-get-completion-function m))
2302 (tramp-get-completion-user-host
2303 method user host (nth 0 x) (nth 1 x)))
2304 (delq nil all-user-hosts)))))
2306 ;; Possible methods.
2308 (append result (tramp-get-completion-methods m)))))))
2310 ;; Unify list, add hop, remove nil elements.
2311 (dolist (elt result)
2313 (string-match tramp-prefix-regexp elt)
2314 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2317 (substring elt (length (tramp-drop-volume-letter directory))))))
2319 ;; Complete local parts.
2323 (apply (if (tramp-connectable-p fullname)
2324 'tramp-completion-run-real-handler
2325 'tramp-run-real-handler)
2326 'file-name-all-completions (list (list filename directory)))))))
2328 ;; Method, host name and user name completion for a file.
2330 (defun tramp-completion-handle-file-name-completion
2331 (filename directory &optional predicate)
2332 "Like `file-name-completion' for Tramp files."
2335 (mapcar 'list (file-name-all-completions filename directory))
2336 (when (and predicate
2337 (tramp-connectable-p (expand-file-name filename directory)))
2338 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2340 ;; I misuse a little bit the tramp-file-name structure in order to handle
2341 ;; completion possibilities for partial methods / user names / host names.
2342 ;; Return value is a list of tramp-file-name structures according to possible
2343 ;; completions. If "localname" is non-nil it means there
2344 ;; shouldn't be a completion anymore.
2346 ;; Expected results:
2348 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2349 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2350 ;; [nil "x" nil nil]
2351 ;; ["x" nil nil nil]
2353 ;; "/x:" "/x:y" "/x:y:"
2354 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2356 ;; ["x" nil "" nil] ["x" nil "y" nil]
2357 ;; ["x" "" nil nil] ["x" "y" nil nil]
2359 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2360 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2361 ;; "/[x/y@" "/[x/y@z"
2362 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2363 (defun tramp-completion-dissect-file-name (name)
2364 "Returns a list of `tramp-file-name' structures.
2365 They are collected by `tramp-completion-dissect-file-name1'."
2369 (tramp-completion-ipv6-regexp
2372 (if (zerop (length tramp-postfix-ipv6-format))
2373 tramp-postfix-host-format
2374 tramp-postfix-ipv6-format)))
2375 ;; "/method" "/[method"
2376 (tramp-completion-file-name-structure1
2377 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2380 (tramp-completion-file-name-structure2
2381 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2384 (tramp-completion-file-name-structure3
2385 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2387 ;; "/[ipv6" "/[ipv6"
2388 (tramp-completion-file-name-structure4
2389 (list (concat tramp-prefix-regexp
2390 tramp-prefix-ipv6-regexp
2391 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2393 ;; "/user@host" "/[user@host"
2394 (tramp-completion-file-name-structure5
2395 (list (concat tramp-prefix-regexp
2396 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2397 "\\(" tramp-host-regexp x-nil "\\)$")
2399 ;; "/user@[ipv6" "/[user@ipv6"
2400 (tramp-completion-file-name-structure6
2401 (list (concat tramp-prefix-regexp
2402 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2403 tramp-prefix-ipv6-regexp
2404 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2406 ;; "/method:user" "/[method/user"
2407 (tramp-completion-file-name-structure7
2408 (list (concat tramp-prefix-regexp
2409 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2410 "\\(" tramp-user-regexp x-nil "\\)$")
2412 ;; "/method:host" "/[method/host"
2413 (tramp-completion-file-name-structure8
2414 (list (concat tramp-prefix-regexp
2415 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2416 "\\(" tramp-host-regexp x-nil "\\)$")
2418 ;; "/method:[ipv6" "/[method/ipv6"
2419 (tramp-completion-file-name-structure9
2420 (list (concat tramp-prefix-regexp
2421 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2422 tramp-prefix-ipv6-regexp
2423 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2425 ;; "/method:user@host" "/[method/user@host"
2426 (tramp-completion-file-name-structure10
2427 (list (concat tramp-prefix-regexp
2428 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2429 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2430 "\\(" tramp-host-regexp x-nil "\\)$")
2432 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2433 (tramp-completion-file-name-structure11
2434 (list (concat tramp-prefix-regexp
2435 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2436 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2437 tramp-prefix-ipv6-regexp
2438 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2441 (mapc (lambda (structure)
2442 (add-to-list 'result
2443 (tramp-completion-dissect-file-name1 structure name)))
2445 tramp-completion-file-name-structure1
2446 tramp-completion-file-name-structure2
2447 tramp-completion-file-name-structure3
2448 tramp-completion-file-name-structure4
2449 tramp-completion-file-name-structure5
2450 tramp-completion-file-name-structure6
2451 tramp-completion-file-name-structure7
2452 tramp-completion-file-name-structure8
2453 tramp-completion-file-name-structure9
2454 tramp-completion-file-name-structure10
2455 tramp-completion-file-name-structure11
2456 tramp-file-name-structure))
2460 (defun tramp-completion-dissect-file-name1 (structure name)
2461 "Returns a `tramp-file-name' structure matching STRUCTURE.
2462 The structure consists of remote method, remote user,
2463 remote host and localname (filename on remote host)."
2466 (when (string-match (nth 0 structure) name)
2467 (let ((method (and (nth 1 structure)
2468 (match-string (nth 1 structure) name)))
2469 (user (and (nth 2 structure)
2470 (match-string (nth 2 structure) name)))
2471 (host (and (nth 3 structure)
2472 (match-string (nth 3 structure) name)))
2473 (localname (and (nth 4 structure)
2474 (match-string (nth 4 structure) name))))
2475 (vector method user host localname nil)))))
2477 ;; This function returns all possible method completions, adding the
2478 ;; trailing method delimiter.
2479 (defun tramp-get-completion-methods (partial-method)
2480 "Returns all method completions for PARTIAL-METHOD."
2484 (string-match (concat "^" (regexp-quote partial-method)) method)
2485 (tramp-completion-make-tramp-file-name method nil nil nil)))
2486 (mapcar 'car tramp-methods)))
2488 ;; Compares partial user and host names with possible completions.
2489 (defun tramp-get-completion-user-host
2490 (method partial-user partial-host user host)
2491 "Returns the most expanded string for user and host name completion.
2492 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2495 ((and partial-user partial-host)
2497 (string-match (concat "^" (regexp-quote partial-host)) host)
2498 (string-equal partial-user (or user partial-user)))
2499 (setq user partial-user)
2506 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2512 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2518 (unless (zerop (+ (length user) (length host)))
2519 (tramp-completion-make-tramp-file-name method user host nil)))
2521 ;; Generic function.
2522 (defun tramp-parse-group (regexp match-level skip-regexp)
2523 "Return a (user host) tuple allowed to access.
2524 User is always nil."
2526 (when (re-search-forward regexp (point-at-eol) t)
2527 (setq result (list nil (match-string match-level))))
2529 (> (skip-chars-forward skip-regexp) 0)
2533 ;; Generic function.
2534 (defun tramp-parse-file (filename function)
2535 "Return a list of (user host) tuples allowed to access.
2536 User is always nil."
2537 ;; On Windows, there are problems in completion when
2538 ;; `default-directory' is remote.
2539 (let ((default-directory (tramp-compat-temporary-file-directory)))
2540 (when (file-readable-p filename)
2542 (insert-file-contents filename)
2543 (goto-char (point-min))
2544 (loop while (not (eobp)) collect (funcall function))))))
2546 ;;;###tramp-autoload
2547 (defun tramp-parse-rhosts (filename)
2548 "Return a list of (user host) tuples allowed to access.
2549 Either user or host may be nil."
2550 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2552 (defun tramp-parse-rhosts-group ()
2553 "Return a (user host) tuple allowed to access.
2554 Either user or host may be nil."
2558 "^\\(" tramp-host-regexp "\\)"
2559 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2560 (when (re-search-forward regexp (point-at-eol) t)
2561 (setq result (append (list (match-string 3) (match-string 1)))))
2565 ;;;###tramp-autoload
2566 (defun tramp-parse-shosts (filename)
2567 "Return a list of (user host) tuples allowed to access.
2568 User is always nil."
2569 (tramp-parse-file filename 'tramp-parse-shosts-group))
2571 (defun tramp-parse-shosts-group ()
2572 "Return a (user host) tuple allowed to access.
2573 User is always nil."
2574 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2576 ;;;###tramp-autoload
2577 (defun tramp-parse-sconfig (filename)
2578 "Return a list of (user host) tuples allowed to access.
2579 User is always nil."
2580 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2582 (defun tramp-parse-sconfig-group ()
2583 "Return a (user host) tuple allowed to access.
2584 User is always nil."
2586 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2588 ;; Generic function.
2589 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2590 "Return a list of (user host) tuples allowed to access.
2591 User is always nil."
2592 ;; On Windows, there are problems in completion when
2593 ;; `default-directory' is remote.
2594 (let* ((default-directory (tramp-compat-temporary-file-directory))
2595 (files (and (file-directory-p dirname) (directory-files dirname))))
2596 (loop for f in files
2597 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2598 collect (list nil (match-string 1 f)))))
2600 ;;;###tramp-autoload
2601 (defun tramp-parse-shostkeys (dirname)
2602 "Return a list of (user host) tuples allowed to access.
2603 User is always nil."
2604 (tramp-parse-shostkeys-sknownhosts
2605 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2607 ;;;###tramp-autoload
2608 (defun tramp-parse-sknownhosts (dirname)
2609 "Return a list of (user host) tuples allowed to access.
2610 User is always nil."
2611 (tramp-parse-shostkeys-sknownhosts
2613 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2615 ;;;###tramp-autoload
2616 (defun tramp-parse-hosts (filename)
2617 "Return a list of (user host) tuples allowed to access.
2618 User is always nil."
2619 (tramp-parse-file filename 'tramp-parse-hosts-group))
2621 (defun tramp-parse-hosts-group ()
2622 "Return a (user host) tuple allowed to access.
2623 User is always nil."
2625 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2627 ;;;###tramp-autoload
2628 (defun tramp-parse-passwd (filename)
2629 "Return a list of (user host) tuples allowed to access.
2630 Host is always \"localhost\"."
2631 (with-tramp-connection-property nil "parse-passwd"
2632 (if (executable-find "getent")
2634 (when (zerop (tramp-call-process nil "getent" nil t nil "passwd"))
2635 (goto-char (point-min))
2636 (loop while (not (eobp)) collect
2637 (tramp-parse-etc-group-group))))
2638 (tramp-parse-file filename 'tramp-parse-passwd-group))))
2640 (defun tramp-parse-passwd-group ()
2641 "Return a (user host) tuple allowed to access.
2642 Host is always \"localhost\"."
2644 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2645 (when (re-search-forward regexp (point-at-eol) t)
2646 (setq result (list (match-string 1) "localhost")))
2650 ;;;###tramp-autoload
2651 (defun tramp-parse-etc-group (filename)
2652 "Return a list of (group host) tuples allowed to access.
2653 Host is always \"localhost\"."
2654 (with-tramp-connection-property nil "parse-group"
2655 (if (executable-find "getent")
2657 (when (zerop (tramp-call-process nil "getent" nil t nil "group"))
2658 (goto-char (point-min))
2659 (loop while (not (eobp)) collect
2660 (tramp-parse-etc-group-group))))
2661 (tramp-parse-file filename 'tramp-parse-etc-group-group))))
2663 (defun tramp-parse-etc-group-group ()
2664 "Return a (group host) tuple allowed to access.
2665 Host is always \"localhost\"."
2667 (split (split-string (buffer-substring (point) (point-at-eol)) ":")))
2668 (when (member (user-login-name) (split-string (nth 3 split) "," 'omit))
2669 (setq result (list (nth 0 split) "localhost")))
2673 ;;;###tramp-autoload
2674 (defun tramp-parse-netrc (filename)
2675 "Return a list of (user host) tuples allowed to access.
2677 (tramp-parse-file filename 'tramp-parse-netrc-group))
2679 (defun tramp-parse-netrc-group ()
2680 "Return a (user host) tuple allowed to access.
2685 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2686 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2687 (when (re-search-forward regexp (point-at-eol) t)
2688 (setq result (list (match-string 3) (match-string 1))))
2692 ;;;###tramp-autoload
2693 (defun tramp-parse-putty (registry-or-dirname)
2694 "Return a list of (user host) tuples allowed to access.
2695 User is always nil."
2696 (if (memq system-type '(windows-nt))
2697 (with-tramp-connection-property nil "parse-putty"
2699 (when (zerop (tramp-call-process
2700 nil "reg" nil t nil "query" registry-or-dirname))
2701 (goto-char (point-min))
2702 (loop while (not (eobp)) collect
2703 (tramp-parse-putty-group registry-or-dirname)))))
2705 (tramp-parse-shostkeys-sknownhosts
2706 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2708 (defun tramp-parse-putty-group (registry)
2709 "Return a (user host) tuple allowed to access.
2710 User is always nil."
2712 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2713 (when (re-search-forward regexp (point-at-eol) t)
2714 (setq result (list nil (match-string 1))))
2718 ;;; Common file name handler functions for different backends:
2720 (defvar tramp-handle-file-local-copy-hook nil
2721 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2723 (defvar tramp-handle-write-region-hook nil
2724 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2726 (defun tramp-handle-directory-file-name (directory)
2727 "Like `directory-file-name' for Tramp files."
2728 ;; If localname component of filename is "/", leave it unchanged.
2729 ;; Otherwise, remove any trailing slash from localname component.
2730 ;; Method, host, etc, are unchanged. Does it make sense to try
2731 ;; to avoid parsing the filename?
2732 (with-parsed-tramp-file-name directory nil
2733 (if (and (not (zerop (length localname)))
2734 (eq (aref localname (1- (length localname))) ?/)
2735 (not (string= localname "/")))
2736 (substring directory 0 -1)
2739 (defun tramp-handle-directory-files (directory &optional full match nosort)
2740 "Like `directory-files' for Tramp files."
2741 (when (file-directory-p directory)
2742 (setq directory (file-name-as-directory (expand-file-name directory)))
2743 (let ((temp (nreverse (file-name-all-completions "" directory)))
2747 (setq item (directory-file-name (pop temp)))
2748 (when (or (null match) (string-match match item))
2749 (push (if full (concat directory item) item)
2751 (if nosort result (sort result 'string<)))))
2753 (defun tramp-handle-directory-files-and-attributes
2754 (directory &optional full match nosort id-format)
2755 "Like `directory-files-and-attributes' for Tramp files."
2758 (cons x (file-attributes
2759 (if full x (expand-file-name x directory)) id-format)))
2760 (directory-files directory full match nosort)))
2762 (defun tramp-handle-dired-uncache (dir)
2763 "Like `dired-uncache' for Tramp files."
2764 (with-parsed-tramp-file-name
2765 (if (file-directory-p dir) dir (file-name-directory dir)) nil
2766 (tramp-flush-directory-property v localname)))
2768 (defun tramp-handle-file-accessible-directory-p (filename)
2769 "Like `file-accessible-directory-p' for Tramp files."
2770 (and (file-directory-p filename)
2771 (file-readable-p filename)))
2773 (defun tramp-handle-file-equal-p (filename1 filename2)
2774 "Like `file-equalp-p' for Tramp files."
2775 ;; Native `file-equalp-p' calls `file-truename', which requires a
2776 ;; remote connection. This can be avoided, if FILENAME1 and
2777 ;; FILENAME2 are not located on the same remote host.
2779 (file-remote-p (expand-file-name filename1))
2780 (file-remote-p (expand-file-name filename2)))
2781 (tramp-run-real-handler 'file-equal-p (list filename1 filename2))))
2783 (defun tramp-handle-file-exists-p (filename)
2784 "Like `file-exists-p' for Tramp files."
2785 (not (null (file-attributes filename))))
2787 (defun tramp-handle-file-in-directory-p (filename directory)
2788 "Like `file-in-directory-p' for Tramp files."
2789 ;; Native `file-in-directory-p' calls `file-truename', which
2790 ;; requires a remote connection. This can be avoided, if FILENAME
2791 ;; and DIRECTORY are not located on the same remote host.
2793 (file-remote-p (expand-file-name filename))
2794 (file-remote-p (expand-file-name directory)))
2795 (tramp-run-real-handler 'file-in-directory-p (list filename directory))))
2797 (defun tramp-handle-file-modes (filename)
2798 "Like `file-modes' for Tramp files."
2799 (let ((truename (or (file-truename filename) filename)))
2800 (when (file-exists-p truename)
2801 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2803 ;; Localname manipulation functions that grok Tramp localnames...
2804 (defun tramp-handle-file-name-as-directory (file)
2805 "Like `file-name-as-directory' but aware of Tramp files."
2806 ;; `file-name-as-directory' would be sufficient except localname is
2807 ;; the empty string.
2808 (let ((v (tramp-dissect-file-name file t)))
2809 ;; Run the command on the localname portion only.
2810 (tramp-make-tramp-file-name
2811 (tramp-file-name-method v)
2812 (tramp-file-name-user v)
2813 (tramp-file-name-host v)
2814 (tramp-run-real-handler
2815 'file-name-as-directory (list (or (tramp-file-name-localname v) "")))
2816 (tramp-file-name-hop v))))
2818 (defun tramp-handle-file-name-completion
2819 (filename directory &optional predicate)
2820 "Like `file-name-completion' for Tramp files."
2821 (unless (tramp-tramp-file-p directory)
2823 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2827 (mapcar 'list (file-name-all-completions filename directory))
2829 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2831 (defun tramp-handle-file-name-directory (file)
2832 "Like `file-name-directory' but aware of Tramp files."
2833 ;; Everything except the last filename thing is the directory. We
2834 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2835 ;; the remote file name parts. This is a problem when we are in
2836 ;; file name completion.
2837 (let ((v (tramp-dissect-file-name file t)))
2838 ;; Run the command on the localname portion only.
2839 (tramp-make-tramp-file-name
2840 (tramp-file-name-method v)
2841 (tramp-file-name-user v)
2842 (tramp-file-name-host v)
2843 (tramp-run-real-handler
2844 'file-name-directory (list (or (tramp-file-name-localname v) "")))
2845 (tramp-file-name-hop v))))
2847 (defun tramp-handle-file-name-nondirectory (file)
2848 "Like `file-name-nondirectory' but aware of Tramp files."
2849 (with-parsed-tramp-file-name file nil
2850 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2852 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2853 "Like `file-newer-than-file-p' for Tramp files."
2855 ((not (file-exists-p file1)) nil)
2856 ((not (file-exists-p file2)) t)
2857 (t (time-less-p (nth 5 (file-attributes file2))
2858 (nth 5 (file-attributes file1))))))
2860 (defun tramp-handle-file-regular-p (filename)
2861 "Like `file-regular-p' for Tramp files."
2862 (and (file-exists-p filename)
2863 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2865 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2866 "Like `file-remote-p' for Tramp files."
2867 ;; We do not want traces in the debug buffer.
2868 (let ((tramp-verbose (min tramp-verbose 3)))
2869 (when (tramp-tramp-file-p filename)
2870 (let* ((v (tramp-dissect-file-name filename))
2871 (p (tramp-get-connection-process v))
2872 (c (and p (processp p) (memq (process-status p) '(run open))
2873 (tramp-get-connection-property p "connected" nil))))
2874 ;; We expand the file name only, if there is already a connection.
2875 (with-parsed-tramp-file-name
2876 (if c (expand-file-name filename) filename) nil
2877 (and (or (not connected) c)
2879 ((eq identification 'method) method)
2880 ((eq identification 'user) user)
2881 ((eq identification 'host) host)
2882 ((eq identification 'localname) localname)
2883 ((eq identification 'hop) hop)
2884 (t (tramp-make-tramp-file-name method user host "" hop)))))))))
2886 (defun tramp-handle-file-symlink-p (filename)
2887 "Like `file-symlink-p' for Tramp files."
2888 (with-parsed-tramp-file-name filename nil
2889 (let ((x (car (file-attributes filename))))
2891 (if (file-name-absolute-p x)
2892 (tramp-make-tramp-file-name method user host x)
2895 (defun tramp-handle-find-backup-file-name (filename)
2896 "Like `find-backup-file-name' for Tramp files."
2897 (with-parsed-tramp-file-name filename nil
2898 (let ((backup-directory-alist
2899 (if tramp-backup-directory-alist
2904 (if (and (stringp (cdr x))
2905 (file-name-absolute-p (cdr x))
2906 (not (tramp-file-name-p (cdr x))))
2907 (tramp-make-tramp-file-name method user host (cdr x))
2909 tramp-backup-directory-alist)
2910 backup-directory-alist)))
2911 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2913 (defun tramp-handle-insert-directory
2914 (filename switches &optional wildcard full-directory-p)
2915 "Like `insert-directory' for Tramp files."
2916 (unless switches (setq switches ""))
2917 ;; Mark trailing "/".
2918 (when (and (zerop (length (file-name-nondirectory filename)))
2919 (not full-directory-p))
2920 (setq switches (concat switches "F")))
2921 (with-parsed-tramp-file-name (expand-file-name filename) nil
2922 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
2924 (let (ls-lisp-use-insert-directory-program start)
2925 (tramp-run-real-handler
2927 (list filename switches wildcard full-directory-p))
2928 ;; `ls-lisp' always returns full listings. We must remove
2929 ;; superfluous parts.
2930 (unless (string-match "l" switches)
2932 (goto-char (point-min))
2934 (text-property-not-all
2935 (point) (point-at-eol) 'dired-filename t))
2938 (or (text-property-any start (point-at-eol) 'dired-filename t)
2940 (if (= (point-at-bol) (point-at-eol))
2942 (delete-region (point) (progn (forward-line) (point)))
2943 (forward-line)))))))))
2945 (defun tramp-handle-insert-file-contents
2946 (filename &optional visit beg end replace)
2947 "Like `insert-file-contents' for Tramp files."
2948 (barf-if-buffer-read-only)
2949 (setq filename (expand-file-name filename))
2950 (let (result local-copy remote-copy)
2951 (with-parsed-tramp-file-name filename nil
2953 (if (not (file-exists-p filename))
2955 v 'file-error "File `%s' not found on remote host" filename)
2957 (with-tramp-progress-reporter
2958 v 3 (format-message "Inserting `%s'" filename)
2960 (if (and (tramp-local-host-p v)
2961 (let (file-name-handler-alist)
2962 (file-readable-p localname)))
2963 ;; Short track: if we are on the local host, we can
2966 (tramp-run-real-handler
2967 'insert-file-contents
2968 (list localname visit beg end replace)))
2970 ;; When we shall insert only a part of the file, we
2971 ;; copy this part. This works only for the shell file
2973 (when (and (or beg end)
2974 (tramp-get-method-parameter
2975 v 'tramp-login-program))
2976 (setq remote-copy (tramp-make-tramp-temp-file v))
2977 ;; This is defined in tramp-sh.el. Let's assume
2978 ;; this is loaded already.
2979 (tramp-compat-funcall
2984 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
2985 beg (tramp-shell-quote-argument localname)
2986 (- end beg) remote-copy))
2988 (format "dd bs=1 skip=%d if=%s of=%s"
2989 beg (tramp-shell-quote-argument localname)
2992 (format "dd bs=1 count=%d if=%s of=%s"
2993 end (tramp-shell-quote-argument localname)
2995 (setq tramp-temp-buffer-file-name nil beg nil end nil))
2997 ;; `insert-file-contents-literally' takes care to
2998 ;; avoid calling jka-compr.el and epa.el. By
2999 ;; let-binding `inhibit-file-name-operation', we
3000 ;; propagate that care to the `file-local-copy'
3003 (let ((inhibit-file-name-operation
3004 (when (eq inhibit-file-name-operation
3005 'insert-file-contents)
3008 ((stringp remote-copy)
3010 (tramp-make-tramp-file-name
3011 method user host remote-copy)))
3012 ((stringp tramp-temp-buffer-file-name)
3014 filename tramp-temp-buffer-file-name 'ok)
3015 tramp-temp-buffer-file-name)
3016 (t (file-local-copy filename)))))
3018 ;; When the file is not readable for the owner, it
3019 ;; cannot be inserted, even if it is readable for the
3020 ;; group or for everybody.
3021 (set-file-modes local-copy (string-to-number "0600" 8))
3023 (when (and (null remote-copy)
3024 (tramp-get-method-parameter
3025 v 'tramp-copy-keep-tmpfile))
3026 ;; We keep the local file for performance reasons,
3027 ;; useful for "rsync".
3028 (setq tramp-temp-buffer-file-name local-copy))
3030 ;; We must ensure that `file-coding-system-alist'
3031 ;; matches `local-copy'.
3032 (let ((file-coding-system-alist
3033 (tramp-find-file-name-coding-system-alist
3034 filename local-copy)))
3036 (insert-file-contents
3037 local-copy visit beg end replace))))
3039 (add-hook 'find-file-not-found-functions
3040 `(lambda () (signal ',(car err) ',(cdr err)))
3042 (signal (car err) (cdr err))))))
3047 (setq buffer-file-name filename)
3048 (setq buffer-read-only (not (file-writable-p filename)))
3049 (set-visited-file-modtime)
3050 (set-buffer-modified-p nil))
3051 (when (and (stringp local-copy)
3052 (or remote-copy (null tramp-temp-buffer-file-name)))
3053 (delete-file local-copy))
3054 (when (stringp remote-copy)
3056 (tramp-make-tramp-file-name method user host remote-copy)))))
3059 (list (expand-file-name filename)
3062 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3063 "Like `load' for Tramp files."
3064 (with-parsed-tramp-file-name (expand-file-name file) nil
3066 (cond ((file-exists-p (concat file ".elc"))
3067 (setq file (concat file ".elc")))
3068 ((file-exists-p (concat file ".el"))
3069 (setq file (concat file ".el")))))
3071 ;; The first condition is always true for absolute file names.
3072 ;; Included for safety's sake.
3073 (unless (or (file-name-directory file)
3074 (string-match "\\.elc?\\'" file))
3077 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3079 (when (not (file-exists-p file))
3080 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
3081 (if (not (file-exists-p file))
3083 (let ((tramp-message-show-message (not nomessage)))
3084 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3085 (let ((local-copy (file-local-copy file)))
3087 (load local-copy noerror t nosuffix must-suffix)
3088 (delete-file local-copy)))))
3091 (defun tramp-handle-make-symbolic-link
3092 (filename linkname &optional _ok-if-already-exists)
3093 "Like `make-symbolic-link' for Tramp files."
3094 (with-parsed-tramp-file-name
3095 (if (tramp-tramp-file-p filename) filename linkname) nil
3096 (tramp-error v 'file-error "make-symbolic-link not supported")))
3098 (defun tramp-handle-shell-command
3099 (command &optional output-buffer error-buffer)
3100 "Like `shell-command' for Tramp files."
3101 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3102 ;; We cannot use `shell-file-name' and `shell-command-switch',
3103 ;; they are variables of the local host.
3106 (tramp-get-method-parameter
3107 (tramp-dissect-file-name default-directory)
3108 'tramp-remote-shell)
3109 (tramp-get-method-parameter
3110 (tramp-dissect-file-name default-directory)
3111 'tramp-remote-shell-args))
3112 (list (substring command 0 asynchronous))))
3116 ((bufferp output-buffer) output-buffer)
3117 ((stringp output-buffer) (get-buffer-create output-buffer))
3119 (setq current-buffer-p t)
3121 (t (get-buffer-create
3123 "*Async Shell Command*"
3124 "*Shell Command Output*")))))
3127 ((bufferp error-buffer) error-buffer)
3128 ((stringp error-buffer) (get-buffer-create error-buffer))))
3130 (if (and (not asynchronous) error-buffer)
3131 (with-parsed-tramp-file-name default-directory nil
3132 (list output-buffer (tramp-make-tramp-temp-file v)))
3134 (p (get-buffer-process output-buffer)))
3136 ;; Check whether there is another process running. Tramp does not
3137 ;; support 2 (asynchronous) processes in parallel.
3139 (if (yes-or-no-p "A command is running. Kill it? ")
3140 (ignore-errors (kill-process p))
3141 (tramp-user-error p "Shell command in progress")))
3143 (if current-buffer-p
3145 (barf-if-buffer-read-only)
3147 (with-current-buffer output-buffer
3148 (setq buffer-read-only nil)
3151 (if (and (not current-buffer-p) (integerp asynchronous))
3154 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3156 (with-current-buffer output-buffer
3157 (display-buffer output-buffer '(nil (allow-no-window . t)))
3158 (setq mode-line-process '(":%s"))
3160 (set-process-sentinel p 'shell-command-sentinel)
3161 (set-process-filter p 'comint-output-filter)))
3165 (apply 'process-file (car args) nil buffer nil (cdr args))
3166 ;; Insert error messages if they were separated.
3167 (when (listp buffer)
3168 (with-current-buffer error-buffer
3169 (insert-file-contents (cadr buffer)))
3170 (delete-file (cadr buffer)))
3171 (if current-buffer-p
3172 ;; This is like exchange-point-and-mark, but doesn't
3173 ;; activate the mark. It is cleaner to avoid activation,
3174 ;; even though the command loop would deactivate the mark
3175 ;; because we inserted text.
3176 (goto-char (prog1 (mark t)
3177 (set-marker (mark-marker) (point)
3179 ;; There's some output, display it.
3180 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3181 (display-message-or-buffer output-buffer)))))))
3183 (defun tramp-handle-substitute-in-file-name (filename)
3184 "Like `substitute-in-file-name' for Tramp files.
3185 \"//\" and \"/~\" substitute only in the local filename part."
3186 ;; First, we must replace environment variables.
3187 (setq filename (tramp-replace-environment-variables filename))
3188 (with-parsed-tramp-file-name filename nil
3189 ;; Ignore in LOCALNAME everything before "//" or "/~".
3190 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3192 (concat (file-remote-p filename)
3193 (replace-match "\\1" nil nil localname)))
3194 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3195 (when (string-match "~$" filename)
3196 (setq filename (concat filename "/"))))
3197 ;; We do not want to replace environment variables, again.
3198 (let (process-environment)
3199 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3201 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
3202 "Like `set-visited-file-modtime' for Tramp files."
3203 (unless (buffer-file-name)
3204 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3207 (let ((remote-file-name-inhibit-cache t))
3208 ;; '(-1 65535) means file doesn't exists yet.
3210 (or (nth 5 (file-attributes (buffer-file-name))) '(-1 65535)))))
3211 ;; We use '(0 0) as a don't-know value.
3212 (unless (equal time-list '(0 0))
3213 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))))
3215 (defun tramp-handle-verify-visited-file-modtime (&optional buf)
3216 "Like `verify-visited-file-modtime' for Tramp files.
3217 At the time `verify-visited-file-modtime' calls this function, we
3218 already know that the buffer is visiting a file and that
3219 `visited-file-modtime' does not return 0. Do not call this
3220 function directly, unless those two cases are already taken care
3222 (with-current-buffer (or buf (current-buffer))
3223 (let ((f (buffer-file-name)))
3224 ;; There is no file visiting the buffer, or the buffer has no
3225 ;; recorded last modification time, or there is no established
3228 (eq (visited-file-modtime) 0)
3229 (not (file-remote-p f nil 'connected)))
3231 (with-parsed-tramp-file-name f nil
3232 (let* ((remote-file-name-inhibit-cache t)
3233 (attr (file-attributes f))
3234 (modtime (nth 5 attr))
3235 (mt (visited-file-modtime)))
3238 ;; File exists, and has a known modtime.
3239 ((and attr (not (equal modtime '(0 0))))
3240 (< (abs (tramp-time-diff
3242 ;; For compatibility, deal with both the old
3243 ;; (HIGH . LOW) and the new (HIGH LOW) return
3244 ;; values of `visited-file-modtime'.
3246 (list (car mt) (cdr mt))
3249 ;; Modtime has the don't know value.
3251 ;; If file does not exist, say it is not modified if and
3252 ;; only if that agrees with the buffer's record.
3253 (t (equal mt '(-1 65535))))))))))
3255 (defun tramp-handle-file-notify-add-watch (filename _flags _callback)
3256 "Like `file-notify-add-watch' for Tramp files."
3257 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3259 (setq filename (expand-file-name filename))
3260 (with-parsed-tramp-file-name filename nil
3262 v 'file-notify-error "File notification not supported for `%s'" filename)))
3264 (defun tramp-handle-file-notify-rm-watch (proc)
3265 "Like `file-notify-rm-watch' for Tramp files."
3266 ;; The descriptor must be a process object.
3267 (unless (processp proc)
3268 (tramp-error proc 'file-notify-error "Not a valid descriptor %S" proc))
3269 (tramp-message proc 6 "Kill %S" proc)
3270 (delete-process proc))
3272 (defun tramp-handle-file-notify-valid-p (proc)
3273 "Like `file-notify-valid-p' for Tramp files."
3274 (and proc (processp proc) (memq (process-status proc) '(run open))
3275 ;; Sometimes, the process is still in status `run' when the
3276 ;; file or directory to be watched is deleted already.
3277 (with-current-buffer (process-buffer proc)
3279 (concat (file-remote-p default-directory)
3280 (process-get proc 'watch-name))))))
3282 ;;; Functions for establishing connection:
3284 ;; The following functions are actions to be taken when seeing certain
3285 ;; prompts from the remote host. See the variable
3286 ;; `tramp-actions-before-shell' for usage of these functions.
3288 (defun tramp-action-login (_proc vec)
3289 "Send the login name."
3290 (when (not (stringp tramp-current-user))
3291 (setq tramp-current-user
3292 (with-tramp-connection-property vec "login-as"
3293 (save-window-excursion
3294 (let ((enable-recursive-minibuffers t))
3295 (pop-to-buffer (tramp-get-connection-buffer vec))
3296 (read-string (match-string 0)))))))
3297 (with-current-buffer (tramp-get-connection-buffer vec)
3298 (tramp-message vec 6 "\n%s" (buffer-string)))
3299 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3300 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3302 (defun tramp-action-password (proc vec)
3303 "Query the user for a password."
3304 (with-current-buffer (process-buffer proc)
3305 (let ((enable-recursive-minibuffers t)
3306 (case-fold-search t))
3307 ;; Let's check whether a wrong password has been sent already.
3308 ;; Sometimes, the process returns a new password request
3309 ;; immediately after rejecting the previous (wrong) one.
3310 (unless (tramp-get-connection-property vec "first-password-request" nil)
3311 (tramp-clear-passwd vec))
3312 (goto-char (point-min))
3313 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3314 (tramp-message vec 3 "Sending %s" (match-string 1))
3315 ;; We don't call `tramp-send-string' in order to hide the
3316 ;; password from the debug buffer.
3317 (process-send-string
3318 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3319 ;; Hide password prompt.
3320 (narrow-to-region (point-max) (point-max)))))
3322 (defun tramp-action-succeed (_proc _vec)
3323 "Signal success in finding shell prompt."
3324 (throw 'tramp-action 'ok))
3326 (defun tramp-action-permission-denied (proc _vec)
3327 "Signal permission denied."
3329 (throw 'tramp-action 'permission-denied))
3331 (defun tramp-action-yesno (proc vec)
3332 "Ask the user for confirmation using `yes-or-no-p'.
3333 Send \"yes\" to remote process on confirmation, abort otherwise.
3334 See also `tramp-action-yn'."
3335 (save-window-excursion
3336 (let ((enable-recursive-minibuffers t))
3337 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3338 (unless (yes-or-no-p (match-string 0))
3340 (throw 'tramp-action 'permission-denied))
3341 (with-current-buffer (tramp-get-connection-buffer vec)
3342 (tramp-message vec 6 "\n%s" (buffer-string)))
3343 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3345 (defun tramp-action-yn (proc vec)
3346 "Ask the user for confirmation using `y-or-n-p'.
3347 Send \"y\" to remote process on confirmation, abort otherwise.
3348 See also `tramp-action-yesno'."
3349 (save-window-excursion
3350 (let ((enable-recursive-minibuffers t))
3351 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3352 (unless (y-or-n-p (match-string 0))
3354 (throw 'tramp-action 'permission-denied))
3355 (with-current-buffer (tramp-get-connection-buffer vec)
3356 (tramp-message vec 6 "\n%s" (buffer-string)))
3357 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3359 (defun tramp-action-terminal (_proc vec)
3360 "Tell the remote host which terminal type to use.
3361 The terminal type can be configured with `tramp-terminal-type'."
3362 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3363 (with-current-buffer (tramp-get-connection-buffer vec)
3364 (tramp-message vec 6 "\n%s" (buffer-string)))
3365 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3367 (defun tramp-action-process-alive (proc _vec)
3368 "Check, whether a process has finished."
3369 (unless (memq (process-status proc) '(run open))
3370 (throw 'tramp-action 'process-died)))
3372 (defun tramp-action-out-of-band (proc vec)
3373 "Check, whether an out-of-band copy has finished."
3374 ;; There might be pending output for the exit status.
3375 (tramp-accept-process-output proc 0.1)
3376 (cond ((and (memq (process-status proc) '(stop exit))
3377 (zerop (process-exit-status proc)))
3378 (tramp-message vec 3 "Process has finished.")
3379 (throw 'tramp-action 'ok))
3380 ((or (and (memq (process-status proc) '(stop exit))
3381 (not (zerop (process-exit-status proc))))
3382 (memq (process-status proc) '(signal)))
3383 ;; `scp' could have copied correctly, but set modes could have failed.
3384 ;; This can be ignored.
3385 (with-current-buffer (process-buffer proc)
3386 (goto-char (point-min))
3387 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3389 (tramp-message vec 5 "'set mode' error ignored.")
3390 (tramp-message vec 3 "Process has finished.")
3391 (throw 'tramp-action 'ok))
3392 (tramp-message vec 3 "Process has died.")
3393 (throw 'tramp-action 'process-died))))
3396 ;;; Functions for processing the actions:
3398 (defun tramp-process-one-action (proc vec actions)
3399 "Wait for output from the shell and perform one action."
3400 (let ((case-fold-search t)
3401 found todo item pattern action)
3403 ;; Reread output once all actions have been performed.
3404 ;; Obviously, the output was not complete.
3405 (tramp-accept-process-output proc 1)
3408 (setq item (pop todo))
3409 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3410 (setq action (nth 1 item))
3412 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3413 (when (tramp-check-for-regexp proc pattern)
3414 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3415 (setq found (funcall action proc vec)))))
3418 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3419 "Perform ACTIONS until success or TIMEOUT.
3420 PROC and VEC indicate the remote connection to be used. POS, if
3421 set, is the starting point of the region to be deleted in the
3423 ;; Enable `auth-source'. We must use tramp-current-* variables in
3424 ;; case we have several hops.
3425 (tramp-set-connection-property
3426 (tramp-dissect-file-name
3427 (tramp-make-tramp-file-name
3428 tramp-current-method tramp-current-user tramp-current-host ""))
3429 "first-password-request" t)
3431 (with-tramp-progress-reporter
3432 proc 3 "Waiting for prompts from remote shell"
3435 (with-timeout (timeout (setq exit 'timeout))
3438 (catch 'tramp-action
3439 (tramp-process-one-action proc vec actions)))))
3442 (catch 'tramp-action
3443 (tramp-process-one-action proc vec actions)))))
3444 (with-current-buffer (tramp-get-connection-buffer vec)
3446 (tramp-message vec 6 "\n%s" (buffer-string)))
3447 (unless (eq exit 'ok)
3448 (tramp-clear-passwd vec)
3449 (delete-process proc)
3450 (tramp-error-with-buffer
3451 (tramp-get-connection-buffer vec) vec 'file-error
3453 ((eq exit 'permission-denied) "Permission denied")
3454 ((eq exit 'process-died)
3455 (substitute-command-keys
3457 "Tramp failed to connect. If this happens repeatedly, try\n"
3458 " `\\[tramp-cleanup-this-connection]'")))
3461 "Timeout reached, see buffer `%s' for details"
3462 (tramp-get-connection-buffer vec)))
3463 (t "Login failed")))))
3465 (with-current-buffer (tramp-get-connection-buffer vec)
3466 (let (buffer-read-only) (delete-region pos (point))))))))
3468 :;; Utility functions:
3470 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3471 "Like `accept-process-output' for Tramp processes.
3472 This is needed in order to hide `last-coding-system-used', which is set
3473 for process communication also."
3474 (with-current-buffer (process-buffer proc)
3475 ;; FIXME: If there is a gateway process, we need communication
3476 ;; between several processes. Too complicate to implement, so we
3477 ;; read output from all processes.
3478 (let ((p (if (tramp-get-connection-property proc "gateway" nil) nil proc))
3479 buffer-read-only last-coding-system-used)
3480 ;; Under Windows XP, accept-process-output doesn't return
3481 ;; sometimes. So we add an additional timeout.
3482 (with-timeout ((or timeout 1))
3483 (accept-process-output p timeout timeout-msecs (and proc t)))
3484 (tramp-message proc 10 "%s %s %s\n%s"
3485 proc (process-status proc) p (buffer-string)))))
3487 (defun tramp-check-for-regexp (proc regexp)
3488 "Check, whether REGEXP is contained in process buffer of PROC.
3489 Erase echoed commands if exists."
3490 (with-current-buffer (process-buffer proc)
3491 (goto-char (point-min))
3493 ;; Check whether we need to remove echo output.
3494 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3495 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3496 (let ((begin (match-beginning 0)))
3497 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3498 ;; Discard echo from remote output.
3499 (tramp-set-connection-property proc "check-remote-echo" nil)
3500 (tramp-message proc 5 "echo-mark found")
3502 (delete-region begin (point))
3503 (goto-char (point-min)))))
3505 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3506 ;; Sometimes, the echo string is suppressed on the remote side.
3508 (substring-no-properties
3509 tramp-echo-mark-marker
3510 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3511 (buffer-substring-no-properties
3513 (min (+ (point-min) tramp-echo-mark-marker-length)
3515 ;; No echo to be handled, now we can look for the regexp.
3516 ;; Sometimes, lines are much to long, and we run into a "Stack
3517 ;; overflow in regexp matcher". For example, //DIRED// lines of
3518 ;; directory listings with some thousand files. Therefore, we
3519 ;; look from the end.
3520 (goto-char (point-max))
3521 (ignore-errors (re-search-backward regexp nil t)))))
3523 (defun tramp-wait-for-regexp (proc timeout regexp)
3524 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3525 Expects the output of PROC to be sent to the current buffer. Returns
3526 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3528 (with-current-buffer (process-buffer proc)
3529 (let ((found (tramp-check-for-regexp proc regexp)))
3531 (with-timeout (timeout)
3533 (tramp-accept-process-output proc 1)
3534 (unless (memq (process-status proc) '(run open))
3535 (tramp-error-with-buffer
3536 nil proc 'file-error "Process has died"))
3537 (setq found (tramp-check-for-regexp proc regexp)))))
3540 (tramp-accept-process-output proc 1)
3541 (unless (memq (process-status proc) '(run open))
3542 (tramp-error-with-buffer
3543 nil proc 'file-error "Process has died"))
3544 (setq found (tramp-check-for-regexp proc regexp)))))
3545 (tramp-message proc 6 "\n%s" (buffer-string))
3549 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3551 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3554 ;; It seems that Tru64 Unix does not like it if long strings are sent
3555 ;; to it in one go. (This happens when sending the Perl
3556 ;; `file-attributes' implementation, for instance.) Therefore, we
3557 ;; have this function which sends the string in chunks.
3558 (defun tramp-send-string (vec string)
3559 "Send the STRING via connection VEC.
3561 The STRING is expected to use Unix line-endings, but the lines sent to
3562 the remote host use line-endings as defined in the variable
3563 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3564 (let* ((p (tramp-get-connection-process vec))
3565 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3568 vec 'file-error "Can't send string to remote host -- not logged in"))
3569 (tramp-set-connection-property p "last-cmd-time" (current-time))
3570 (tramp-message vec 10 "%s" string)
3571 (with-current-buffer (tramp-get-connection-buffer vec)
3572 ;; Clean up the buffer. We cannot call `erase-buffer' because
3573 ;; narrowing might be in effect.
3574 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3575 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3578 'identity (split-string string "\n") tramp-rsh-end-of-line))
3579 (unless (or (string= string "")
3580 (string-equal (substring string -1) tramp-rsh-end-of-line))
3581 (setq string (concat string tramp-rsh-end-of-line)))
3583 (if (and chunksize (not (zerop chunksize)))
3585 (end (length string)))
3588 vec 10 "Sending chunk from %s to %s"
3589 pos (min (+ pos chunksize) end))
3590 (process-send-string
3591 p (substring string pos (min (+ pos chunksize) end)))
3592 (setq pos (+ pos chunksize))))
3593 (process-send-string p string)))))
3595 (defun tramp-get-inode (vec)
3596 "Returns the virtual inode number.
3597 If it doesn't exist, generate a new one."
3598 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3599 (setq tramp-inodes (1+ tramp-inodes))))
3601 (defun tramp-get-device (vec)
3602 "Returns the virtual device number.
3603 If it doesn't exist, generate a new one."
3604 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3605 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3607 (defun tramp-equal-remote (file1 file2)
3608 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3609 The check depends on method, user and host name of the files. If
3610 one of the components is missing, the default values are used.
3611 The local file name parts of FILE1 and FILE2 are not taken into
3616 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3618 would yield t. On the other hand, the following check results in nil:
3620 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3621 (and (tramp-tramp-file-p file1)
3622 (tramp-tramp-file-p file2)
3623 (string-equal (file-remote-p file1) (file-remote-p file2))))
3625 ;;;###tramp-autoload
3626 (defun tramp-mode-string-to-int (mode-string)
3627 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3628 (let* (case-fold-search
3629 (mode-chars (string-to-vector mode-string))
3630 (owner-read (aref mode-chars 1))
3631 (owner-write (aref mode-chars 2))
3632 (owner-execute-or-setid (aref mode-chars 3))
3633 (group-read (aref mode-chars 4))
3634 (group-write (aref mode-chars 5))
3635 (group-execute-or-setid (aref mode-chars 6))
3636 (other-read (aref mode-chars 7))
3637 (other-write (aref mode-chars 8))
3638 (other-execute-or-sticky (aref mode-chars 9)))
3642 ((char-equal owner-read ?r) (string-to-number "00400" 8))
3643 ((char-equal owner-read ?-) 0)
3644 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3646 ((char-equal owner-write ?w) (string-to-number "00200" 8))
3647 ((char-equal owner-write ?-) 0)
3648 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3650 ((char-equal owner-execute-or-setid ?x) (string-to-number "00100" 8))
3651 ((char-equal owner-execute-or-setid ?S) (string-to-number "04000" 8))
3652 ((char-equal owner-execute-or-setid ?s) (string-to-number "04100" 8))
3653 ((char-equal owner-execute-or-setid ?-) 0)
3654 (t (error "Fourth char `%c' must be one of `xsS-'"
3655 owner-execute-or-setid)))
3657 ((char-equal group-read ?r) (string-to-number "00040" 8))
3658 ((char-equal group-read ?-) 0)
3659 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3661 ((char-equal group-write ?w) (string-to-number "00020" 8))
3662 ((char-equal group-write ?-) 0)
3663 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3665 ((char-equal group-execute-or-setid ?x) (string-to-number "00010" 8))
3666 ((char-equal group-execute-or-setid ?S) (string-to-number "02000" 8))
3667 ((char-equal group-execute-or-setid ?s) (string-to-number "02010" 8))
3668 ((char-equal group-execute-or-setid ?-) 0)
3669 (t (error "Seventh char `%c' must be one of `xsS-'"
3670 group-execute-or-setid)))
3672 ((char-equal other-read ?r) (string-to-number "00004" 8))
3673 ((char-equal other-read ?-) 0)
3674 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3676 ((char-equal other-write ?w) (string-to-number "00002" 8))
3677 ((char-equal other-write ?-) 0)
3678 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3680 ((char-equal other-execute-or-sticky ?x) (string-to-number "00001" 8))
3681 ((char-equal other-execute-or-sticky ?T) (string-to-number "01000" 8))
3682 ((char-equal other-execute-or-sticky ?t) (string-to-number "01001" 8))
3683 ((char-equal other-execute-or-sticky ?-) 0)
3684 (t (error "Tenth char `%c' must be one of `xtT-'"
3685 other-execute-or-sticky)))))))
3687 (defconst tramp-file-mode-type-map
3688 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
3690 (2 . "c") ; character device
3691 (3 . "m") ; multiplexed character device (v7)
3692 (4 . "d") ; directory
3693 (5 . "?") ; Named special file (XENIX)
3694 (6 . "b") ; block device
3695 (7 . "?") ; multiplexed block device (v7)
3696 (8 . "-") ; regular file
3697 (9 . "n") ; network special file (HP-UX)
3698 (10 . "l") ; symlink
3699 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
3701 (13 . "D") ; door special (Solaris)
3702 (14 . "w")) ; whiteout (BSD)
3703 "A list of file types returned from the `stat' system call.
3704 This is used to map a mode number to a permission string.")
3706 ;;;###tramp-autoload
3707 (defun tramp-file-mode-from-int (mode)
3708 "Turn an integer representing a file mode into an ls(1)-like string."
3710 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
3711 (user (logand (lsh mode -6) 7))
3712 (group (logand (lsh mode -3) 7))
3713 (other (logand (lsh mode -0) 7))
3714 (suid (> (logand (lsh mode -9) 4) 0))
3715 (sgid (> (logand (lsh mode -9) 2) 0))
3716 (sticky (> (logand (lsh mode -9) 1) 0)))
3717 (setq user (tramp-file-mode-permissions user suid "s"))
3718 (setq group (tramp-file-mode-permissions group sgid "s"))
3719 (setq other (tramp-file-mode-permissions other sticky "t"))
3720 (concat type user group other)))
3722 (defun tramp-file-mode-permissions (perm suid suid-text)
3723 "Convert a permission bitset into a string.
3724 This is used internally by `tramp-file-mode-from-int'."
3725 (let ((r (> (logand perm 4) 0))
3726 (w (> (logand perm 2) 0))
3727 (x (> (logand perm 1) 0)))
3728 (concat (or (and r "r") "-")
3729 (or (and w "w") "-")
3730 (or (and suid x suid-text) ; suid, execute
3731 (and suid (upcase suid-text)) ; suid, !execute
3732 (and x "x") "-")))) ; !suid
3734 ;;;###tramp-autoload
3735 (defun tramp-get-local-uid (id-format)
3736 (if (equal id-format 'integer) (user-uid) (user-login-name)))
3738 ;;;###tramp-autoload
3739 (defun tramp-get-local-gid (id-format)
3740 ;; `group-gid' has been introduced with Emacs 24.4.
3741 (if (and (fboundp 'group-gid) (equal id-format 'integer))
3742 (tramp-compat-funcall 'group-gid)
3743 (nth 3 (file-attributes "~/" id-format))))
3745 ;;;###tramp-autoload
3746 (defun tramp-check-cached-permissions (vec access)
3747 "Check `file-attributes' caches for VEC.
3748 Return t if according to the cache access type ACCESS is known to
3754 ((eq ?x access) 3))))
3755 (dolist (suffix '("string" "integer") result)
3762 (tramp-get-file-property
3763 vec (tramp-file-name-localname vec)
3764 (concat "file-attributes-" suffix) nil)
3766 (tramp-make-tramp-file-name
3767 (tramp-file-name-method vec)
3768 (tramp-file-name-user vec)
3769 (tramp-file-name-host vec)
3770 (tramp-file-name-localname vec)
3771 (tramp-file-name-hop vec))
3774 (tramp-get-connection-property
3775 vec (concat "uid-" suffix) nil))
3777 (tramp-get-connection-property
3778 vec (concat "gid-" suffix) nil)))
3783 (eq t (car file-attr))
3784 (null (car file-attr)))
3786 ;; World accessible.
3787 (eq access (aref (nth 8 file-attr) (+ offset 6)))
3788 ;; User accessible and owned by user.
3790 (eq access (aref (nth 8 file-attr) offset))
3791 (equal remote-uid (nth 2 file-attr)))
3792 ;; Group accessible and owned by user's
3795 (eq access (aref (nth 8 file-attr) (+ offset 3)))
3796 (equal remote-gid (nth 3 file-attr)))))))))))
3798 ;;;###tramp-autoload
3799 (defun tramp-local-host-p (vec)
3800 "Return t if this points to the local host, nil otherwise."
3801 ;; We cannot use `tramp-file-name-real-host'. A port is an
3802 ;; indication for an ssh tunnel or alike.
3803 (let ((host (tramp-file-name-host vec)))
3806 (string-match tramp-local-host-regexp host)
3807 ;; The method shall be applied to one of the shell file name
3808 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3809 ;; alike, where it must fail.
3810 (tramp-get-method-parameter vec 'tramp-login-program)
3811 ;; The local temp directory must be writable for the other user.
3813 (tramp-make-tramp-file-name
3814 (tramp-file-name-method vec)
3815 (tramp-file-name-user vec)
3817 (tramp-compat-temporary-file-directory)))
3818 ;; On some systems, chown runs only for root.
3819 (or (zerop (user-uid))
3820 ;; This is defined in tramp-sh.el. Let's assume this is
3822 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3824 (defun tramp-get-remote-tmpdir (vec)
3825 "Return directory for temporary files on the remote host identified by VEC."
3826 (when (file-remote-p (tramp-get-connection-property vec "tmpdir" ""))
3827 ;; Compatibility code: Cached value shall be the local path only.
3828 (tramp-set-connection-property vec "tmpdir" 'undef))
3829 (let ((dir (tramp-make-tramp-file-name
3830 (tramp-file-name-method vec)
3831 (tramp-file-name-user vec)
3832 (tramp-file-name-host vec)
3833 (or (tramp-get-method-parameter vec 'tramp-tmpdir) "/tmp"))))
3834 (with-tramp-connection-property vec "tmpdir"
3835 (or (and (file-directory-p dir) (file-writable-p dir)
3836 (file-remote-p dir 'localname))
3837 (tramp-error vec 'file-error "Directory %s not accessible" dir)))
3840 ;;;###tramp-autoload
3841 (defun tramp-make-tramp-temp-file (vec)
3842 "Create a temporary file on the remote host identified by VEC.
3843 Return the local name of the temporary file."
3844 (let ((prefix (expand-file-name
3845 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3848 ;; `make-temp-file' would be the natural choice for
3849 ;; implementation. But it calls `write-region' internally,
3850 ;; which also needs a temporary file - we would end in an
3852 (setq result (make-temp-name prefix))
3853 (if (file-exists-p result)
3855 ;; This creates the file by side effect.
3856 (set-file-times result)
3857 (set-file-modes result (string-to-number "0700" 8))))
3859 ;; Return the local part.
3860 (with-parsed-tramp-file-name result nil localname)))
3862 (defun tramp-delete-temp-file-function ()
3863 "Remove temporary files related to current buffer."
3864 (when (stringp tramp-temp-buffer-file-name)
3865 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3867 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3868 (add-hook 'tramp-unload-hook
3870 (remove-hook 'kill-buffer-hook
3871 'tramp-delete-temp-file-function)))
3873 (defun tramp-handle-make-auto-save-file-name ()
3874 "Like `make-auto-save-file-name' for Tramp files.
3875 Returns a file name in `tramp-auto-save-directory' for autosaving
3876 this file, if that variable is non-nil."
3877 (when (stringp tramp-auto-save-directory)
3878 (setq tramp-auto-save-directory
3879 (expand-file-name tramp-auto-save-directory)))
3880 ;; Create directory.
3881 (unless (or (null tramp-auto-save-directory)
3882 (file-exists-p tramp-auto-save-directory))
3883 (make-directory tramp-auto-save-directory t))
3885 (let ((system-type 'not-windows)
3886 (auto-save-file-name-transforms
3887 (if (null tramp-auto-save-directory)
3888 auto-save-file-name-transforms))
3890 (if (null tramp-auto-save-directory)
3893 (tramp-subst-strs-in-string
3901 tramp-auto-save-directory))))
3902 ;; Run plain `make-auto-save-file-name'.
3903 (tramp-run-real-handler 'make-auto-save-file-name nil)))
3905 (defun tramp-subst-strs-in-string (alist string)
3906 "Replace all occurrences of the string FROM with TO in STRING.
3907 ALIST is of the form ((FROM . TO) ...)."
3910 (let* ((pr (car alist))
3913 (while (string-match (regexp-quote from) string)
3914 (setq string (replace-match to t t string)))
3915 (setq alist (cdr alist))))
3918 ;;; Compatibility functions section:
3920 (defun tramp-call-process
3921 (vec program &optional infile destination display &rest args)
3922 "Calls `call-process' on the local host.
3923 It always returns a return code. The Lisp error raised when
3924 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
3925 are written with verbosity of 6."
3927 (vector tramp-current-method tramp-current-user
3928 tramp-current-host nil nil)))
3929 (destination (if (eq destination t) (current-buffer) destination))
3933 program (mapconcat 'identity args " ") infile destination)
3938 'call-process program infile (or destination t) display args))
3939 ;; `result' could also be an error string.
3940 (when (stringp result)
3941 (signal 'file-error (list result)))
3942 (with-current-buffer
3943 (if (bufferp destination) destination (current-buffer))
3944 (tramp-message v 6 "%d\n%s" result (buffer-string))))
3947 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
3950 (defun tramp-call-process-region
3951 (vec start end program &optional delete buffer display &rest args)
3952 "Calls `call-process-region' on the local host.
3953 It always returns a return code. The Lisp error raised when
3954 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
3955 are written with verbosity of 6."
3957 (vector tramp-current-method tramp-current-user
3958 tramp-current-host nil nil)))
3959 (buffer (if (eq buffer t) (current-buffer) buffer))
3962 v 6 "`%s %s' %s %s %s %s"
3963 program (mapconcat 'identity args " ") start end delete buffer)
3968 'call-process-region
3969 start end program delete buffer display args))
3970 ;; `result' could also be an error string.
3971 (when (stringp result)
3972 (signal 'file-error (list result)))
3973 (with-current-buffer (if (bufferp buffer) buffer (current-buffer))
3975 (tramp-message v 6 "%d" result)
3976 (tramp-message v 6 "%d\n%s" result (buffer-string)))))
3979 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
3982 ;;;###tramp-autoload
3983 (defun tramp-read-passwd (proc &optional prompt)
3984 "Read a password from user (compat function).
3985 Consults the auth-source package.
3986 Invokes `password-read' if available, `read-passwd' else."
3987 (let* ((case-fold-search t)
3988 (key (tramp-make-tramp-file-name
3989 tramp-current-method tramp-current-user
3990 tramp-current-host ""))
3993 (with-current-buffer (process-buffer proc)
3994 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3995 (format "%s for %s " (capitalize (match-string 1)) key))))
3996 ;; We suspend the timers while reading the password.
3997 (stimers (with-timeout-suspend))
3998 auth-info auth-passwd)
4001 (with-parsed-tramp-file-name key nil
4004 ;; See if auth-sources contains something useful.
4005 ;; `auth-source-user-or-password' is an obsoleted
4006 ;; function since Emacs 24.1, it has been replaced by
4007 ;; `auth-source-search'.
4009 (and (tramp-get-connection-property
4010 v "first-password-request" nil)
4011 ;; Try with Tramp's current method.
4012 (if (fboundp 'auth-source-search)
4016 :user (or tramp-current-user t)
4017 :host tramp-current-host
4018 :port tramp-current-method)
4019 auth-passwd (plist-get
4020 (nth 0 auth-info) :secret)
4021 auth-passwd (if (functionp auth-passwd)
4022 (funcall auth-passwd)
4024 (tramp-compat-funcall 'auth-source-user-or-password
4025 "password" tramp-current-host tramp-current-method))))
4026 ;; Try the password cache.
4027 (let ((password (password-read pw-prompt key)))
4028 (password-cache-add key password)
4030 ;; Else, get the password interactively.
4031 (read-passwd pw-prompt))
4032 (tramp-set-connection-property v "first-password-request" nil)))
4033 ;; Reenable the timers.
4034 (with-timeout-unsuspend stimers))))
4036 ;;;###tramp-autoload
4037 (defun tramp-clear-passwd (vec)
4038 "Clear password cache for connection related to VEC."
4039 (let ((hop (tramp-file-name-hop vec)))
4041 ;; Clear also the passwords of the hops.
4043 (tramp-dissect-file-name
4046 (replace-regexp-in-string
4047 (concat tramp-postfix-hop-regexp "$")
4048 tramp-postfix-host-format hop))))))
4049 (password-cache-remove
4050 (tramp-make-tramp-file-name
4051 (tramp-file-name-method vec)
4052 (tramp-file-name-user vec)
4053 (tramp-file-name-host vec)
4056 ;; Snarfed code from time-date.el and parse-time.el
4058 (defconst tramp-half-a-year '(241 17024)
4059 "Evaluated by \"(days-to-time 183)\".")
4061 (defconst tramp-parse-time-months
4062 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
4063 ("apr" . 4) ("may" . 5) ("jun" . 6)
4064 ("jul" . 7) ("aug" . 8) ("sep" . 9)
4065 ("oct" . 10) ("nov" . 11) ("dec" . 12))
4066 "Alist mapping month names to integers.")
4068 ;;;###tramp-autoload
4069 (defun tramp-time-diff (t1 t2)
4070 "Return the difference between the two times, in seconds.
4071 T1 and T2 are time values (as returned by `current-time' for example)."
4072 (float-time (subtract-time t1 t2)))
4074 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4075 ;; does not deal well with newline characters. Newline is replaced by
4076 ;; backslash newline. But if, say, the string `a backslash newline b'
4077 ;; is passed to a shell, the shell will expand this into "ab",
4078 ;; completely omitting the newline. This is not what was intended.
4079 ;; It does not appear to be possible to make the function
4080 ;; `shell-quote-argument' work with newlines without making it
4081 ;; dependent on the shell used. But within this package, we know that
4082 ;; we will always use a Bourne-like shell, so we use an approach which
4085 ;; The approach is simple: we call `shell-quote-argument', then
4086 ;; massage the newline part of the result.
4088 ;; This function should produce a string which is grokked by a Unix
4089 ;; shell, even if the Emacs is running on Windows. Since this is the
4090 ;; kludges section, we bind `system-type' in such a way that
4091 ;; `shell-quote-argument' behaves as if on Unix.
4093 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4094 ;; function to work with Bourne-like shells.
4096 ;; CCC: This function should be rewritten so that
4097 ;; `shell-quote-argument' is not used. This way, we are safe from
4098 ;; changes in `shell-quote-argument'.
4099 ;;;###tramp-autoload
4100 (defun tramp-shell-quote-argument (s)
4101 "Similar to `shell-quote-argument', but groks newlines.
4102 Only works for Bourne-like shells."
4103 (let ((system-type 'not-windows))
4105 (let ((result (shell-quote-argument s))
4106 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
4107 (when (and (>= (length result) 2)
4108 (string= (substring result 0 2) "\\~"))
4109 (setq result (substring result 1)))
4110 (while (string-match nl result)
4111 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
4115 ;;; Integration of eshell.el:
4117 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4118 ;; when `default-directory' points to another host.
4119 (defun tramp-eshell-directory-change ()
4120 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4121 (setq eshell-path-env
4122 (if (tramp-tramp-file-p default-directory)
4123 (with-parsed-tramp-file-name default-directory nil
4127 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4128 ;; the remote path is only set in the session cache.
4129 (tramp-get-connection-property
4130 (tramp-get-connection-process v) "remote-path" nil)
4131 (tramp-get-connection-property v "remote-path" nil))
4135 (eval-after-load "esh-util"
4137 (tramp-eshell-directory-change)
4138 (add-hook 'eshell-directory-change-hook
4139 'tramp-eshell-directory-change)
4140 (add-hook 'tramp-unload-hook
4142 (remove-hook 'eshell-directory-change-hook
4143 'tramp-eshell-directory-change)))))
4145 ;; Checklist for `tramp-unload-hook'
4146 ;; - Unload all `tramp-*' packages
4147 ;; - Reset `file-name-handler-alist'
4148 ;; - Cleanup hooks where Tramp functions are in
4149 ;; - Cleanup advised functions
4150 ;; - Cleanup autoloads
4152 (defun tramp-unload-tramp ()
4153 "Discard Tramp from loading remote files."
4155 ;; ange-ftp settings must be enabled.
4156 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
4157 ;; Maybe it's not loaded yet.
4158 (ignore-errors (unload-feature 'tramp 'force)))
4164 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4165 ;; by the files in that directory. Add this here.
4166 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4167 ;; * Better error checking. At least whenever we see something
4168 ;; strange when doing zerop, we should kill the process and start
4169 ;; again. (Greg Stark)
4170 ;; * Username and hostname completion.
4171 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
4172 ;; * Make `tramp-default-user' obsolete.
4173 ;; * Implement a general server-local-variable mechanism, as there are
4174 ;; probably other variables that need different values for different
4175 ;; servers too. The user could then configure a variable (such as
4176 ;; tramp-server-local-variable-alist) to define any such variables
4177 ;; that they need to, which would then be let bound as appropriate
4178 ;; in tramp functions. (Jason Rumney)
4179 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4180 ;; * I was wondering if it would be possible to use tramp even if I'm
4181 ;; actually using sshfs. But when I launch a command I would like
4182 ;; to get it executed on the remote machine where the files really
4183 ;; are. (Andrea Crotti)
4184 ;; * Run emerge on two remote files. Bug is described here:
4185 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4187 ;; * Use also port to distinguish connections. This is needed for
4188 ;; different hosts sitting behind a single router (distinguished by
4189 ;; different port numbers). (Tzvi Edelman)
4191 ;;; tramp.el ends here