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 (boundp 'w32-shell-name)
124 (symbol-value 'w32-shell-name)
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 (if (boundp 'w32-shell-name) "/c" "-c")
149 "Use this switch together with `tramp-encoding-shell' for local commands.
150 See the variable `tramp-encoding-shell' for more information."
154 (defcustom tramp-encoding-command-interactive
155 (unless (boundp 'w32-shell-name) "-i")
156 "Use this switch together with `tramp-encoding-shell' for interactive shells.
157 See the variable `tramp-encoding-shell' for more information."
160 :type '(choice (const nil) string))
163 (defvar tramp-methods nil
164 "Alist of methods for remote files.
165 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
166 Each NAME stands for a remote access method. Each PARAM is a
167 pair of the form (KEY VALUE). The following KEYs are defined:
168 * `tramp-remote-shell'
169 This specifies the shell to use on the remote host. This
170 MUST be a Bourne-like shell. It is normally not necessary to
171 set this to any value other than \"/bin/sh\": Tramp wants to
172 use a shell which groks tilde expansion, but it can search
173 for it. Also note that \"/bin/sh\" exists on all Unixen,
174 this might not be true for the value that you decide to use.
175 You Have Been Warned.
176 * `tramp-remote-shell-login'
177 This specifies the arguments to let `tramp-remote-shell' run
178 as a login shell. It defaults to (\"-l\"), but some shells,
179 like ksh, require another argument. See
180 `tramp-connection-properties' for a way to overwrite the
182 * `tramp-remote-shell-args'
183 For implementation of `shell-command', this specifies the
184 arguments to let `tramp-remote-shell' run a single command.
185 * `tramp-login-program'
186 This specifies the name of the program to use for logging in to the
187 remote host. This may be the name of rsh or a workalike program,
188 or the name of telnet or a workalike, or the name of su or a workalike.
190 This specifies the list of arguments to pass to the above
191 mentioned program. Please note that this is a list of list of arguments,
192 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
193 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
194 There are some patterns: \"%h\" in this list is replaced by the host
195 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
196 port number, and \"%%\" can be used to obtain a literal percent character.
197 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
198 expansion (i.e. no host or no user specified), this list is not used as
199 argument. By this, arguments like (\"-l\" \"%u\") are optional.
200 \"%t\" is replaced by the temporary file name produced with
201 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
202 parameter of a program, if exists. \"%c\" adds additional
203 `tramp-ssh-controlmaster-options' options for the first hop.
205 A list of environment variables and their values, which will
206 be set when calling `tramp-login-program'.
208 When an asynchronous process is started, we know already that
209 the connection works. Therefore, we can pass additional
210 parameters to suppress diagnostic messages, in order not to
211 tamper the process output.
212 * `tramp-copy-program'
213 This specifies the name of the program to use for remotely copying
214 the file; this might be the absolute filename of scp or the name of
215 a workalike program. It is always applied on the local host.
217 This specifies the list of parameters to pass to the above mentioned
218 program, the hints for `tramp-login-args' also apply here.
220 A list of environment variables and their values, which will
221 be set when calling `tramp-copy-program'.
222 * `tramp-remote-copy-program'
223 The listener program to be applied on remote side, if needed.
224 * `tramp-remote-copy-args'
225 The list of parameters to pass to the listener program, the hints
226 for `tramp-login-args' also apply here. Additionally, \"%r\" could
227 be used here and in `tramp-copy-args'. It denotes a randomly
228 chosen port for the remote listener.
229 * `tramp-copy-keep-date'
230 This specifies whether the copying program when the preserves the
231 timestamp of the original file.
232 * `tramp-copy-keep-tmpfile'
233 This specifies whether a temporary local file shall be kept
234 for optimization reasons (useful for \"rsync\" methods).
235 * `tramp-copy-recursive'
236 Whether the operation copies directories recursively.
237 * `tramp-default-port'
238 The default port of a method is needed in case of gateway connections.
239 Additionally, it is used as indication which method is prepared for
242 As the attribute name says, additional arguments are specified here
243 when a method is applied via a gateway.
245 A directory on the remote host for temporary files. If not
246 specified, \"/tmp\" is taken as default.
247 * `tramp-connection-timeout'
248 This is the maximum time to be spent for establishing a connection.
249 In general, the global default value shall be used, but for
250 some methods, like \"su\" or \"sudo\", a shorter timeout
253 What does all this mean? Well, you should specify `tramp-login-program'
254 for all methods; this program is used to log in to the remote site. Then,
255 there are two ways to actually transfer the files between the local and the
256 remote side. One way is using an additional scp-like program. If you want
257 to do this, set `tramp-copy-program' in the method.
259 Another possibility for file transfer is inline transfer, i.e. the
260 file is passed through the same buffer used by `tramp-login-program'. In
261 this case, the file contents need to be protected since the
262 `tramp-login-program' might use escape codes or the connection might not
263 be eight-bit clean. Therefore, file contents are encoded for transit.
264 See the variables `tramp-local-coding-commands' and
265 `tramp-remote-coding-commands' for details.
267 So, to summarize: if the method is an out-of-band method, then you
268 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
269 inline method, then these two parameters should be nil. Methods which
270 are fit for gateways must have `tramp-default-port' at least.
274 When using `su' or `sudo' the phrase \"open connection to a remote
275 host\" sounds strange, but it is used nevertheless, for consistency.
276 No connection is opened to a remote host, but `su' or `sudo' is
277 started on the local host. You should specify a remote host
278 `localhost' or the name of the local host. Another host name is
279 useful only in combination with `tramp-default-proxies-alist'.")
281 (defcustom tramp-default-method
282 ;; An external copy method seems to be preferred, because it performs
283 ;; much better for large files, and it hasn't too serious delays
284 ;; for small files. But it must be ensured that there aren't
285 ;; permanent password queries. Either a password agent like
286 ;; "ssh-agent" or "Pageant" shall run, or the optional
287 ;; password-cache.el or auth-sources.el packages shall be active for
288 ;; password caching. If we detect that the user is running OpenSSH
289 ;; 4.0 or newer, we could reuse the connection, which calls also for
290 ;; an external method.
292 ;; PuTTY is installed. We don't take it, if it is installed on a
293 ;; non-windows system, or pscp from the pssh (parallel ssh) package
295 ((and (eq system-type 'windows-nt) (executable-find "pscp")) "pscp")
296 ;; There is an ssh installation.
297 ((executable-find "scp") "scp")
300 "Default method to use for transferring files.
301 See `tramp-methods' for possibilities.
302 Also see `tramp-default-method-alist'."
307 (defcustom tramp-default-method-alist nil
308 "Default method to use for specific host/user pairs.
309 This is an alist of items (HOST USER METHOD). The first matching item
310 specifies the method to use for a file name which does not specify a
311 method. HOST and USER are regular expressions or nil, which is
312 interpreted as a regular expression which always matches. If no entry
313 matches, the variable `tramp-default-method' takes effect.
315 If the file name does not specify the user, lookup is done using the
316 empty string for the user name.
318 See `tramp-methods' for a list of possibilities for METHOD."
320 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
321 (choice :tag "User regexp" regexp sexp)
322 (choice :tag "Method name" string (const nil)))))
324 (defcustom tramp-default-user nil
325 "Default user to use for transferring files.
326 It is nil by default; otherwise settings in configuration files like
327 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
329 This variable is regarded as obsolete, and will be removed soon."
331 :type '(choice (const nil) string))
334 (defcustom tramp-default-user-alist nil
335 "Default user to use for specific method/host pairs.
336 This is an alist of items (METHOD HOST USER). The first matching item
337 specifies the user to use for a file name which does not specify a
338 user. METHOD and USER are regular expressions or nil, which is
339 interpreted as a regular expression which always matches. If no entry
340 matches, the variable `tramp-default-user' takes effect.
342 If the file name does not specify the method, lookup is done using the
343 empty string for the method name."
345 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
346 (choice :tag " Host regexp" regexp sexp)
347 (choice :tag " User name" string (const nil)))))
349 (defcustom tramp-default-host (system-name)
350 "Default host to use for transferring files.
351 Useful for su and sudo methods mostly."
356 (defcustom tramp-default-host-alist nil
357 "Default host to use for specific method/user pairs.
358 This is an alist of items (METHOD USER HOST). The first matching item
359 specifies the host to use for a file name which does not specify a
360 host. METHOD and HOST are regular expressions or nil, which is
361 interpreted as a regular expression which always matches. If no entry
362 matches, the variable `tramp-default-host' takes effect.
364 If the file name does not specify the method, lookup is done using the
365 empty string for the method name."
368 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
369 (choice :tag " User regexp" regexp sexp)
370 (choice :tag " Host name" string (const nil)))))
372 (defcustom tramp-default-proxies-alist nil
373 "Route to be followed for specific host/user pairs.
374 This is an alist of items (HOST USER PROXY). The first matching
375 item specifies the proxy to be passed for a file name located on
376 a remote target matching USER@HOST. HOST and USER are regular
377 expressions. PROXY must be a Tramp filename without a localname
378 part. Method and user name on PROXY are optional, which is
379 interpreted with the default values. PROXY can contain the
380 patterns %h and %u, which are replaced by the strings matching
381 HOST or USER, respectively.
383 HOST, USER or PROXY could also be Lisp forms, which will be
384 evaluated. The result must be a string or nil, which is
385 interpreted as a regular expression which always matches."
387 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
388 (choice :tag "User regexp" regexp sexp)
389 (choice :tag " Proxy name" string (const nil)))))
391 (defcustom tramp-save-ad-hoc-proxies nil
392 "Whether to save ad-hoc proxies persistently."
397 (defcustom tramp-restricted-shell-hosts-alist
398 (when (memq system-type '(windows-nt))
399 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
400 "List of hosts, which run a restricted shell.
401 This is a list of regular expressions, which denote hosts running
402 a registered shell like \"rbash\". Those hosts can be used as
403 proxies only, see `tramp-default-proxies-alist'. If the local
404 host runs a registered shell, it shall be added to this list, too."
407 :type '(repeat (regexp :tag "Host regexp")))
410 (defconst tramp-local-host-regexp
414 (list "localhost" "localhost6" (system-name) "127.0.0.1" "::1") t)
416 "Host names which are regarded as local host.")
418 (defvar tramp-completion-function-alist nil
419 "Alist of methods for remote files.
420 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...).
421 Each NAME stands for a remote access method. Each PAIR is of the form
422 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
423 names from FILE for completion. The following predefined FUNCTIONs exists:
425 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
426 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
427 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
428 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
429 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
430 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
431 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
432 * `tramp-parse-etc-group' for \"/etc/group\" like files.
433 * `tramp-parse-netrc' for \"~/.netrc\" like files.
434 * `tramp-parse-putty' for PuTTY registered sessions.
436 FUNCTION can also be a user defined function. For more details see
439 (defconst tramp-echo-mark-marker "_echo"
440 "String marker to surround echoed commands.")
442 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
443 "String length of `tramp-echo-mark-marker'.")
445 (defconst tramp-echo-mark
446 (concat tramp-echo-mark-marker
447 (make-string tramp-echo-mark-marker-length ?\b))
448 "String mark to be transmitted around shell commands.
449 Used to separate their echo from the output they produce. This
450 will only be used if we cannot disable remote echo via stty.
451 This string must have no effect on the remote shell except for
452 producing some echo which can later be detected by
453 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
454 followed by an equal number of backspaces to erase them will
457 (defconst tramp-echoed-echo-mark-regexp
458 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
459 tramp-echo-mark-marker tramp-echo-mark-marker-length)
460 "Regexp which matches `tramp-echo-mark' as it gets echoed by
463 (defcustom tramp-local-end-of-line
464 (if (memq system-type '(windows-nt)) "\r\n" "\n")
465 "String used for end of line in local processes."
470 (defcustom tramp-rsh-end-of-line "\n"
471 "String used for end of line in rsh connections.
472 I don't think this ever needs to be changed, so please tell me about it
473 if you need to change this."
477 (defcustom tramp-login-prompt-regexp
478 ".*\\(user\\|login\\)\\( .*\\)?: *"
479 "Regexp matching login-like prompts.
480 The regexp should match at end of buffer.
482 Sometimes the prompt is reported to look like \"login as:\"."
486 (defcustom tramp-shell-prompt-pattern
487 ;; Allow a prompt to start right after a ^M since it indeed would be
488 ;; displayed at the beginning of the line (and Zsh uses it). This
489 ;; regexp works only for GNU Emacs.
490 ;; Allow also [] style prompts. They can appear only during
491 ;; connection initialization; Tramp redefines the prompt afterwards.
492 (concat "\\(?:^\\|\r\\)"
493 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
494 "Regexp to match prompts from remote shell.
495 Normally, Tramp expects you to configure `shell-prompt-pattern'
496 correctly, but sometimes it happens that you are connecting to a
497 remote host which sends a different kind of shell prompt. Therefore,
498 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
499 and also things matched by this variable. The default value of this
500 variable is similar to the default value of `shell-prompt-pattern',
501 which should work well in many cases.
503 This regexp must match both `tramp-initial-end-of-output' and
504 `tramp-end-of-output'."
508 (defcustom tramp-password-prompt-regexp
509 (format "^.*\\(%s\\).*:\^@? *"
510 ;; `password-word-equivalents' has been introduced with Emacs 24.4.
511 (if (boundp 'password-word-equivalents)
512 (regexp-opt (symbol-value 'password-word-equivalents))
513 "password\\|passphrase"))
514 "Regexp matching password-like prompts.
515 The regexp should match at end of buffer.
517 The `sudo' program appears to insert a `^@' character into the prompt."
522 (defcustom tramp-wrong-passwd-regexp
524 ;; These strings should be on the last line
525 (regexp-opt '("Permission denied"
530 "Timeout, server not responding."
532 "Name or service not known"
533 "Host key verification failed."
534 "No supported authentication methods left to try!") t)
538 ;; Here comes a list of regexes, separated by \\|
539 "Received signal [0-9]+"
541 "Regexp matching a `login failed' message.
542 The regexp should match at end of buffer."
546 (defcustom tramp-yesno-prompt-regexp
548 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
550 "Regular expression matching all yes/no queries which need to be confirmed.
551 The confirmation should be done with yes or no.
552 The regexp should match at end of buffer.
553 See also `tramp-yn-prompt-regexp'."
557 (defcustom tramp-yn-prompt-regexp
559 (regexp-opt '("Store key in cache? (y/n)"
560 "Update cached key? (y/n, Return cancels connection)") t)
562 "Regular expression matching all y/n queries which need to be confirmed.
563 The confirmation should be done with y or n.
564 The regexp should match at end of buffer.
565 See also `tramp-yesno-prompt-regexp'."
569 (defcustom tramp-terminal-prompt-regexp
573 "Terminal type\\? \\[.*\\]"
575 "Regular expression matching all terminal setting prompts.
576 The regexp should match at end of buffer.
577 The answer will be provided by `tramp-action-terminal', which see."
581 (defcustom tramp-operation-not-permitted-regexp
582 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
583 (regexp-opt '("Operation not permitted") t))
584 "Regular expression matching keep-date problems in (s)cp operations.
585 Copying has been performed successfully already, so this message can
590 (defcustom tramp-copy-failed-regexp
592 (regexp-opt '("Permission denied"
595 "No such file or directory") t)
597 "Regular expression matching copy problems in (s)cp operations."
601 (defcustom tramp-process-alive-regexp
603 "Regular expression indicating a process has finished.
604 In fact this expression is empty by intention, it will be used only to
605 check regularly the status of the associated process.
606 The answer will be provided by `tramp-action-process-alive',
607 `tramp-action-out-of-band', which see."
611 (defconst tramp-temp-name-prefix "tramp."
612 "Prefix to use for temporary files.
613 If this is a relative file name (such as \"tramp.\"), it is considered
614 relative to the directory name returned by the function
615 `tramp-compat-temporary-file-directory' (which see). It may also be an
616 absolute file name; don't forget to include a prefix for the filename
619 (defconst tramp-temp-buffer-name " *tramp temp*"
620 "Buffer name for a temporary buffer.
621 It shall be used in combination with `generate-new-buffer-name'.")
623 (defvar tramp-temp-buffer-file-name nil
624 "File name of a persistent local temporary file.
625 Useful for \"rsync\" like methods.")
626 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
627 (put 'tramp-temp-buffer-file-name 'permanent-local t)
630 (defcustom tramp-syntax 'ftp
631 "Tramp filename syntax to be used.
633 It can have the following values:
635 `ftp' -- Ange-FTP like syntax
636 `sep' -- Syntax as defined for XEmacs originally."
639 :type '(choice (const :tag "Ange-FTP" ftp)
640 (const :tag "XEmacs" sep)))
642 (defconst tramp-prefix-format
643 (cond ((equal tramp-syntax 'ftp) "/")
644 ((equal tramp-syntax 'sep) "/[")
645 (t (error "Wrong `tramp-syntax' defined")))
646 "String matching the very beginning of Tramp file names.
647 Used in `tramp-make-tramp-file-name'.")
649 (defconst tramp-prefix-regexp
650 (concat "^" (regexp-quote tramp-prefix-format))
651 "Regexp matching the very beginning of Tramp file names.
652 Should always start with \"^\". Derived from `tramp-prefix-format'.")
654 (defconst tramp-method-regexp
656 "Regexp matching methods identifiers.")
658 (defconst tramp-postfix-method-format
659 (cond ((equal tramp-syntax 'ftp) ":")
660 ((equal tramp-syntax 'sep) "/")
661 (t (error "Wrong `tramp-syntax' defined")))
662 "String matching delimiter between method and user or host names.
663 Used in `tramp-make-tramp-file-name'.")
665 (defconst tramp-postfix-method-regexp
666 (regexp-quote tramp-postfix-method-format)
667 "Regexp matching delimiter between method and user or host names.
668 Derived from `tramp-postfix-method-format'.")
670 (defconst tramp-user-regexp "[^/|: \t]+"
671 "Regexp matching user names.")
674 (defconst tramp-prefix-domain-format "%"
675 "String matching delimiter between user and domain names.")
678 (defconst tramp-prefix-domain-regexp
679 (regexp-quote tramp-prefix-domain-format)
680 "Regexp matching delimiter between user and domain names.
681 Derived from `tramp-prefix-domain-format'.")
683 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
684 "Regexp matching domain names.")
686 (defconst tramp-user-with-domain-regexp
687 (concat "\\(" tramp-user-regexp "\\)"
688 tramp-prefix-domain-regexp
689 "\\(" tramp-domain-regexp "\\)")
690 "Regexp matching user names with domain names.")
692 (defconst tramp-postfix-user-format "@"
693 "String matching delimiter between user and host names.
694 Used in `tramp-make-tramp-file-name'.")
696 (defconst tramp-postfix-user-regexp
697 (regexp-quote tramp-postfix-user-format)
698 "Regexp matching delimiter between user and host names.
699 Derived from `tramp-postfix-user-format'.")
701 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
702 "Regexp matching host names.")
704 (defconst tramp-prefix-ipv6-format
705 (cond ((equal tramp-syntax 'ftp) "[")
706 ((equal tramp-syntax 'sep) "")
707 (t (error "Wrong `tramp-syntax' defined")))
708 "String matching left hand side of IPv6 addresses.
709 Used in `tramp-make-tramp-file-name'.")
711 (defconst tramp-prefix-ipv6-regexp
712 (regexp-quote tramp-prefix-ipv6-format)
713 "Regexp matching left hand side of IPv6 addresses.
714 Derived from `tramp-prefix-ipv6-format'.")
716 ;; The following regexp is a bit sloppy. But it shall serve our
717 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
718 ;; "::ffff:192.168.0.1".
719 (defconst tramp-ipv6-regexp
720 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
721 "Regexp matching IPv6 addresses.")
723 (defconst tramp-postfix-ipv6-format
724 (cond ((equal tramp-syntax 'ftp) "]")
725 ((equal tramp-syntax 'sep) "")
726 (t (error "Wrong `tramp-syntax' defined")))
727 "String matching right hand side of IPv6 addresses.
728 Used in `tramp-make-tramp-file-name'.")
730 (defconst tramp-postfix-ipv6-regexp
731 (regexp-quote tramp-postfix-ipv6-format)
732 "Regexp matching right hand side of IPv6 addresses.
733 Derived from `tramp-postfix-ipv6-format'.")
735 (defconst tramp-prefix-port-format
736 (cond ((equal tramp-syntax 'ftp) "#")
737 ((equal tramp-syntax 'sep) "#")
738 (t (error "Wrong `tramp-syntax' defined")))
739 "String matching delimiter between host names and port numbers.")
741 (defconst tramp-prefix-port-regexp
742 (regexp-quote tramp-prefix-port-format)
743 "Regexp matching delimiter between host names and port numbers.
744 Derived from `tramp-prefix-port-format'.")
746 (defconst tramp-port-regexp "[0-9]+"
747 "Regexp matching port numbers.")
749 (defconst tramp-host-with-port-regexp
750 (concat "\\(" tramp-host-regexp "\\)"
751 tramp-prefix-port-regexp
752 "\\(" tramp-port-regexp "\\)")
753 "Regexp matching host names with port numbers.")
755 (defconst tramp-postfix-hop-format "|"
756 "String matching delimiter after ad-hoc hop definitions.")
758 (defconst tramp-postfix-hop-regexp
759 (regexp-quote tramp-postfix-hop-format)
760 "Regexp matching delimiter after ad-hoc hop definitions.
761 Derived from `tramp-postfix-hop-format'.")
763 (defconst tramp-postfix-host-format
764 (cond ((equal tramp-syntax 'ftp) ":")
765 ((equal tramp-syntax 'sep) "]")
766 (t (error "Wrong `tramp-syntax' defined")))
767 "String matching delimiter between host names and localnames.
768 Used in `tramp-make-tramp-file-name'.")
770 (defconst tramp-postfix-host-regexp
771 (regexp-quote tramp-postfix-host-format)
772 "Regexp matching delimiter between host names and localnames.
773 Derived from `tramp-postfix-host-format'.")
775 (defconst tramp-localname-regexp ".*$"
776 "Regexp matching localnames.")
778 ;;; File name format:
780 (defconst tramp-remote-file-name-spec-regexp
782 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
783 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
784 "\\(" "\\(?:" tramp-host-regexp "\\|"
785 tramp-prefix-ipv6-regexp "\\(?:" tramp-ipv6-regexp "\\)?"
786 tramp-postfix-ipv6-regexp "\\)"
787 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
788 "Regular expression matching a Tramp file name between prefix and postfix.")
790 (defconst tramp-file-name-structure
794 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
795 tramp-postfix-hop-regexp "\\)+" "\\)?"
796 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
797 "\\(" tramp-localname-regexp "\\)")
799 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
800 the Tramp file name structure.
802 The first element REGEXP is a regular expression matching a Tramp file
803 name. The regex should contain parentheses around the method name,
804 the user name, the host name, and the file name parts.
806 The second element METHOD is a number, saying which pair of
807 parentheses matches the method name. The third element USER is
808 similar, but for the user name. The fourth element HOST is similar,
809 but for the host name. The fifth element FILE is for the file name.
810 The last element HOP is the ad-hoc hop definition, which could be a
811 cascade of several hops.
813 These numbers are passed directly to `match-string', which see. That
814 means the opening parentheses are counted to identify the pair.
816 See also `tramp-file-name-regexp'.")
819 (defconst tramp-file-name-regexp-unified
820 (if (memq system-type '(cygwin windows-nt))
821 "\\`/\\(\\[.*\\]\\|[^/|:]\\{2,\\}[^/|]*\\):"
823 "Value for `tramp-file-name-regexp' for unified remoting.
824 See `tramp-file-name-structure' for more explanations.
826 On W32 systems, the volume letter must be ignored.")
829 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
830 "Value for `tramp-file-name-regexp' for separate remoting.
831 See `tramp-file-name-structure' for more explanations.")
834 (defconst tramp-file-name-regexp
835 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
836 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
837 (t (error "Wrong `tramp-syntax' defined")))
838 "Regular expression matching file names handled by Tramp.
839 This regexp should match Tramp file names but no other file names.
840 When tramp.el is loaded, this regular expression is prepended to
841 `file-name-handler-alist', and that is searched sequentially. Thus,
842 if the Tramp entry appears rather early in the `file-name-handler-alist'
843 and is a bit too general, then some files might be considered Tramp
844 files which are not really Tramp files.
846 Please note that the entry in `file-name-handler-alist' is made when
847 this file \(tramp.el) is loaded. This means that this variable must be set
848 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
849 updated after changing this variable.
851 Also see `tramp-file-name-structure'.")
854 (defconst tramp-completion-file-name-regexp-unified
855 (if (memq system-type '(cygwin windows-nt))
856 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
857 "Value for `tramp-completion-file-name-regexp' for unified remoting.
858 See `tramp-file-name-structure' for more explanations.
860 On W32 systems, the volume letter must be ignored.")
863 (defconst tramp-completion-file-name-regexp-separate
864 "\\`/\\([[][^]]*\\)?\\'"
865 "Value for `tramp-completion-file-name-regexp' for separate remoting.
866 See `tramp-file-name-structure' for more explanations.")
869 (defconst tramp-completion-file-name-regexp
870 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
871 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
872 (t (error "Wrong `tramp-syntax' defined")))
873 "Regular expression matching file names handled by Tramp completion.
874 This regexp should match partial Tramp file names only.
876 Please note that the entry in `file-name-handler-alist' is made when
877 this file \(tramp.el) is loaded. This means that this variable must be set
878 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
879 updated after changing this variable.
881 Also see `tramp-file-name-structure'.")
883 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
884 ;; known to have a bug in `process-send-string'; some ssh connections appear
885 ;; to drop bytes when data is sent too quickly. There is also a connection
886 ;; buffer local variable, which is computed depending on remote host properties
887 ;; when `tramp-chunksize' is zero or nil.
888 (defcustom tramp-chunksize (when (memq system-type '(hpux)) 500)
889 ;; Parentheses in docstring starting at beginning of line are escaped.
890 ;; Fontification is messed up when
891 ;; `open-paren-in-column-0-is-defun-start' set to t.
892 "If non-nil, chunksize for sending input to local process.
893 It is necessary only on systems which have a buggy `process-send-string'
894 implementation. The necessity, whether this variable must be set, can be
895 checked via the following code:
898 (let* ((user \"xxx\") (host \"yyy\")
900 (sent init) (received init))
901 (while (= sent received)
902 (setq sent (+ sent step))
904 (let ((proc (start-process (buffer-name) (current-buffer)
905 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
906 (when (memq (process-status proc) \\='(run open))
907 (process-send-string proc (make-string sent ?\\ ))
908 (process-send-eof proc)
909 (process-send-eof proc))
910 (while (not (progn (goto-char (point-min))
911 (re-search-forward \"\\\\w+\" (point-max) t)))
912 (accept-process-output proc 1))
913 (when (memq (process-status proc) \\='(run open))
914 (setq received (string-to-number (match-string 0)))
915 (delete-process proc)
916 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
918 (if (> sent (+ init step))
919 (message \"You should set `tramp-chunksize' to a maximum of %s\"
921 (message \"Test does not work\")
922 (display-buffer (current-buffer))
925 In the Emacs normally running Tramp, evaluate the above code
926 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
927 respectively). You can do this, for example, by pasting it into
928 the `*scratch*' buffer and then hitting C-j with the cursor after the
929 last closing parenthesis. Note that it works only if you have configured
930 \"ssh\" to run without password query, see ssh-agent(1).
932 You will see the number of bytes sent successfully to the remote host.
933 If that number exceeds 1000, you can stop the execution by hitting
934 C-g, because your Emacs is likely clean.
936 When it is necessary to set `tramp-chunksize', you might consider to
937 use an out-of-the-band method \(like \"scp\") instead of an internal one
938 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
941 If your Emacs is buggy, the code stops and gives you an indication
942 about the value `tramp-chunksize' should be set. Maybe you could just
943 experiment a bit, e.g. changing the values of `init' and `step'
944 in the third line of the code.
946 Please raise a bug report via \"M-x tramp-bug\" if your system needs
947 this variable to be set as well."
949 :type '(choice (const nil) integer))
951 ;; Logging in to a remote host normally requires obtaining a pty. But
952 ;; Emacs on MacOS X has process-connection-type set to nil by default,
953 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
954 ;; for an override of the system default.
955 (defcustom tramp-process-connection-type t
956 "Overrides `process-connection-type' for connections from Tramp.
957 Tramp binds `process-connection-type' to the value given here before
958 opening a connection to a remote host."
960 :type '(choice (const nil) (const t) (const pty)))
962 (defcustom tramp-connection-timeout 60
963 "Defines the max time to wait for establishing a connection (in seconds).
964 This can be overwritten for different connection types in `tramp-methods'.
966 The timeout does not include the time reading a password."
971 (defcustom tramp-connection-min-time-diff 5
972 "Defines seconds between two consecutive connection attempts.
973 This is necessary as self defense mechanism, in order to avoid
974 yo-yo connection attempts when the remote host is unavailable.
976 A value of 0 or nil suppresses this check. This might be
977 necessary, when several out-of-order copy operations are
978 performed, or when several asynchronous processes will be started
979 in a short time frame. In those cases it is recommended to
980 let-bind this variable."
983 :type '(choice (const nil) integer))
985 (defcustom tramp-completion-reread-directory-timeout 10
986 "Defines seconds since last remote command before rereading a directory.
987 A remote directory might have changed its contents. In order to
988 make it visible during file name completion in the minibuffer,
989 Tramp flushes its cache and rereads the directory contents when
990 more than `tramp-completion-reread-directory-timeout' seconds
991 have been gone since last remote command execution. A value of t
992 would require an immediate reread during filename completion, nil
993 means to use always cached values for the directory contents."
995 :type '(choice (const nil) (const t) integer))
997 ;;; Internal Variables:
999 (defvar tramp-current-method nil
1000 "Connection method for this *tramp* buffer.")
1002 (defvar tramp-current-user nil
1003 "Remote login name for this *tramp* buffer.")
1005 (defvar tramp-current-host nil
1006 "Remote host for this *tramp* buffer.")
1008 (defvar tramp-current-connection nil
1009 "Last connection timestamp.")
1012 (defconst tramp-completion-file-name-handler-alist
1013 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1014 (file-name-completion . tramp-completion-handle-file-name-completion))
1015 "Alist of completion handler functions.
1016 Used for file names matching `tramp-file-name-regexp'. Operations
1017 not mentioned here will be handled by Tramp's file name handler
1018 functions, or the normal Emacs functions.")
1020 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1021 ;;;###tramp-autoload
1022 (defvar tramp-foreign-file-name-handler-alist nil
1023 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1024 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1027 ;;; Internal functions which must come first:
1029 (defsubst tramp-user-error (vec-or-proc format &rest args)
1030 "Signal a pilot error."
1032 'tramp-error vec-or-proc
1033 (if (fboundp 'user-error) 'user-error 'error) format args))
1035 ;; Conversion functions between external representation and
1036 ;; internal data structure. Convenience functions for internal
1039 (defun tramp-get-method-parameter (vec param)
1040 "Return the method parameter PARAM.
1041 If VEC is a vector, check first in connection properties.
1042 Afterwards, check in `tramp-methods'. If the `tramp-methods'
1043 entry does not exist, return nil."
1045 (replace-regexp-in-string "^tramp-" "" (symbol-name param))))
1046 (if (tramp-connection-property-p vec hash-entry)
1047 ;; We use the cached property.
1048 (tramp-get-connection-property vec hash-entry nil)
1049 ;; Use the static value from `tramp-methods'.
1050 (let ((methods-entry
1051 (assoc param (assoc (tramp-file-name-method vec) tramp-methods))))
1052 (when methods-entry (cadr methods-entry))))))
1054 (defun tramp-file-name-p (vec)
1055 "Check, whether VEC is a Tramp object."
1056 (and (vectorp vec) (= 5 (length vec))))
1058 (defun tramp-file-name-method (vec)
1059 "Return method component of VEC."
1060 (and (tramp-file-name-p vec) (aref vec 0)))
1062 (defun tramp-file-name-user (vec)
1063 "Return user component of VEC."
1064 (and (tramp-file-name-p vec) (aref vec 1)))
1066 (defun tramp-file-name-host (vec)
1067 "Return host component of VEC."
1068 (and (tramp-file-name-p vec) (aref vec 2)))
1070 (defun tramp-file-name-localname (vec)
1071 "Return localname component of VEC."
1072 (and (tramp-file-name-p vec) (aref vec 3)))
1074 (defun tramp-file-name-hop (vec)
1075 "Return hop component of VEC."
1076 (and (tramp-file-name-p vec) (aref vec 4)))
1078 ;; The user part of a Tramp file name vector can be of kind
1079 ;; "user%domain". Sometimes, we must extract these parts.
1080 (defun tramp-file-name-real-user (vec)
1081 "Return the user name of VEC without domain."
1083 (let ((user (tramp-file-name-user vec)))
1084 (if (and (stringp user)
1085 (string-match tramp-user-with-domain-regexp user))
1086 (match-string 1 user)
1089 (defun tramp-file-name-domain (vec)
1090 "Return the domain name of VEC."
1092 (let ((user (tramp-file-name-user vec)))
1094 (string-match tramp-user-with-domain-regexp user)
1095 (match-string 2 user)))))
1097 ;; The host part of a Tramp file name vector can be of kind
1098 ;; "host#port". Sometimes, we must extract these parts.
1099 (defun tramp-file-name-real-host (vec)
1100 "Return the host name of VEC without port."
1102 (let ((host (tramp-file-name-host vec)))
1103 (if (and (stringp host)
1104 (string-match tramp-host-with-port-regexp host))
1105 (match-string 1 host)
1108 (defun tramp-file-name-port (vec)
1109 "Return the port number of VEC."
1111 (let ((method (tramp-file-name-method vec))
1112 (host (tramp-file-name-host vec)))
1113 (or (and (stringp host)
1114 (string-match tramp-host-with-port-regexp host)
1115 (string-to-number (match-string 2 host)))
1116 (tramp-get-method-parameter vec 'tramp-default-port)))))
1118 ;;;###tramp-autoload
1119 (defun tramp-tramp-file-p (name)
1120 "Return t if NAME is a string with Tramp file name syntax."
1123 (string-match tramp-file-name-regexp name))))
1125 ;; Obsoleted with Tramp 2.2.7.
1126 (defconst tramp-obsolete-methods
1127 '("ssh1" "ssh2" "scp1" "scp2" "scpc" "rsyncc" "plink1")
1128 "Obsolete methods.")
1130 (defvar tramp-warned-obsolete-methods nil
1131 "Which methods the user has been warned to be obsolete.")
1133 (defun tramp-find-method (method user host)
1134 "Return the right method string to use.
1135 This is METHOD, if non-nil. Otherwise, do a lookup in
1136 `tramp-default-method-alist'. It maps also obsolete methods to
1140 (let ((choices tramp-default-method-alist)
1143 (setq item (pop choices))
1144 (when (and (string-match (or (nth 0 item) "") (or host ""))
1145 (string-match (or (nth 1 item) "") (or user "")))
1146 (setq lmethod (nth 2 item))
1147 (setq choices nil)))
1149 tramp-default-method)))
1150 ;; This is needed for a transition period only.
1151 (when (member result tramp-obsolete-methods)
1152 (unless (member result tramp-warned-obsolete-methods)
1154 (warn "Method %s is obsolete, using %s"
1155 result (substring result 0 -1))
1156 (unless (y-or-n-p (format "Method \"%s\" is obsolete, use \"%s\"? "
1157 result (substring result 0 -1)))
1158 (tramp-user-error nil "Method \"%s\" not supported" result)))
1159 (add-to-list 'tramp-warned-obsolete-methods result))
1160 ;; This works with the current set of `tramp-obsolete-methods'.
1161 ;; Must be improved, if their are more sophisticated replacements.
1162 (setq result (substring result 0 -1)))
1163 ;; We must mark, whether a default value has been used.
1164 (if (or method (null result))
1166 (propertize result 'tramp-default t))))
1168 (defun tramp-find-user (method user host)
1169 "Return the right user string to use.
1170 This is USER, if non-nil. Otherwise, do a lookup in
1171 `tramp-default-user-alist'."
1174 (let ((choices tramp-default-user-alist)
1177 (setq item (pop choices))
1178 (when (and (string-match (or (nth 0 item) "") (or method ""))
1179 (string-match (or (nth 1 item) "") (or host "")))
1180 (setq luser (nth 2 item))
1181 (setq choices nil)))
1183 tramp-default-user)))
1184 ;; We must mark, whether a default value has been used.
1185 (if (or user (null result))
1187 (propertize result 'tramp-default t))))
1189 (defun tramp-find-host (method user host)
1190 "Return the right host string to use.
1191 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1192 (or (and (> (length host) 0) host)
1193 (let ((choices tramp-default-host-alist)
1196 (setq item (pop choices))
1197 (when (and (string-match (or (nth 0 item) "") (or method ""))
1198 (string-match (or (nth 1 item) "") (or user "")))
1199 (setq lhost (nth 2 item))
1200 (setq choices nil)))
1202 tramp-default-host))
1204 (defun tramp-check-proper-method-and-host (vec)
1205 "Check method and host name of VEC."
1206 (let ((method (tramp-file-name-method vec))
1207 (user (tramp-file-name-user vec))
1208 (host (tramp-file-name-host vec))
1209 (methods (mapcar 'car tramp-methods)))
1210 (when (and method (not (member method methods)))
1211 (tramp-cleanup-connection vec)
1212 (tramp-user-error vec "Unknown method \"%s\"" method))
1213 (when (and (equal tramp-syntax 'ftp) host
1214 (or (null method) (get-text-property 0 'tramp-default method))
1215 (or (null user) (get-text-property 0 'tramp-default user))
1216 (member host methods))
1217 (tramp-cleanup-connection vec)
1218 (tramp-user-error vec "Host name must not match method \"%s\"" host))))
1220 (defun tramp-dissect-file-name (name &optional nodefault)
1221 "Return a `tramp-file-name' structure.
1222 The structure consists of remote method, remote user, remote host,
1223 localname (file name on remote host) and hop. If NODEFAULT is
1224 non-nil, the file name parts are not expanded to their default
1227 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1228 (unless match (tramp-user-error nil "Not a Tramp file name: \"%s\"" name))
1229 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1230 (user (match-string (nth 2 tramp-file-name-structure) name))
1231 (host (match-string (nth 3 tramp-file-name-structure) name))
1232 (localname (match-string (nth 4 tramp-file-name-structure) name))
1233 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1235 (when (string-match tramp-prefix-ipv6-regexp host)
1236 (setq host (replace-match "" nil t host)))
1237 (when (string-match tramp-postfix-ipv6-regexp host)
1238 (setq host (replace-match "" nil t host))))
1240 (vector method user host localname hop)
1242 (tramp-find-method method user host)
1243 (tramp-find-user method user host)
1244 (tramp-find-host method user host)
1247 (defun tramp-buffer-name (vec)
1248 "A name for the connection buffer VEC."
1249 ;; We must use `tramp-file-name-real-host', because for gateway
1250 ;; methods the default port will be expanded later on, which would
1252 (let ((method (tramp-file-name-method vec))
1253 (user (tramp-file-name-user vec))
1254 (host (tramp-file-name-real-host vec)))
1255 (if (not (zerop (length user)))
1256 (format "*tramp/%s %s@%s*" method user host)
1257 (format "*tramp/%s %s*" method host))))
1259 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1260 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1261 When not nil, an optional HOP is prepended."
1262 (concat tramp-prefix-format hop
1263 (when (not (zerop (length method)))
1264 (concat method tramp-postfix-method-format))
1265 (when (not (zerop (length user)))
1266 (concat user tramp-postfix-user-format))
1268 (if (string-match tramp-ipv6-regexp host)
1269 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1271 tramp-postfix-host-format
1272 (when localname localname)))
1274 (defun tramp-completion-make-tramp-file-name (method user host localname)
1275 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1276 It must not be a complete Tramp file name, but as long as there are
1277 necessary only. This function will be used in file name completion."
1278 (concat tramp-prefix-format
1279 (when (not (zerop (length method)))
1280 (concat method tramp-postfix-method-format))
1281 (when (not (zerop (length user)))
1282 (concat user tramp-postfix-user-format))
1283 (when (not (zerop (length host)))
1285 (if (string-match tramp-ipv6-regexp host)
1287 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1289 tramp-postfix-host-format))
1290 (when localname localname)))
1292 (defun tramp-get-buffer (vec)
1293 "Get the connection buffer to be used for VEC."
1294 (or (get-buffer (tramp-buffer-name vec))
1295 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1296 (setq buffer-undo-list t)
1297 (setq default-directory
1298 (tramp-make-tramp-file-name
1299 (tramp-file-name-method vec)
1300 (tramp-file-name-user vec)
1301 (tramp-file-name-host vec)
1305 (defun tramp-get-connection-buffer (vec)
1306 "Get the connection buffer to be used for VEC.
1307 In case a second asynchronous communication has been started, it is different
1308 from `tramp-get-buffer'."
1309 (or (tramp-get-connection-property vec "process-buffer" nil)
1310 (tramp-get-buffer vec)))
1312 (defun tramp-get-connection-name (vec)
1313 "Get the connection name to be used for VEC.
1314 In case a second asynchronous communication has been started, it is different
1315 from the default one."
1316 (or (tramp-get-connection-property vec "process-name" nil)
1317 (tramp-buffer-name vec)))
1319 (defun tramp-get-connection-process (vec)
1320 "Get the connection process to be used for VEC.
1321 In case a second asynchronous communication has been started, it is different
1322 from the default one."
1323 (get-process (tramp-get-connection-name vec)))
1325 (defun tramp-debug-buffer-name (vec)
1326 "A name for the debug buffer for VEC."
1327 ;; We must use `tramp-file-name-real-host', because for gateway
1328 ;; methods the default port will be expanded later on, which would
1330 (let ((method (tramp-file-name-method vec))
1331 (user (tramp-file-name-user vec))
1332 (host (tramp-file-name-real-host vec)))
1333 (if (not (zerop (length user)))
1334 (format "*debug tramp/%s %s@%s*" method user host)
1335 (format "*debug tramp/%s %s*" method host))))
1337 (defconst tramp-debug-outline-regexp
1338 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1339 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1341 (defun tramp-debug-outline-level ()
1342 "Return the depth to which a statement is nested in the outline.
1343 Point must be at the beginning of a header line.
1345 The outline level is equal to the verbosity of the Tramp message."
1346 (1+ (string-to-number (match-string 1))))
1348 (defun tramp-get-debug-buffer (vec)
1349 "Get the debug buffer for VEC."
1350 (with-current-buffer
1351 (get-buffer-create (tramp-debug-buffer-name vec))
1353 (setq buffer-undo-list t)
1354 ;; So it does not get loaded while `outline-regexp' is let-bound.
1356 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1357 ;; `outline-mode-hook'. We must prevent that local processes
1358 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1359 ;; Furthermore, `outline-regexp' must have the correct value
1360 ;; already, because it is used by `font-lock-compile-keywords'.
1361 (let ((default-directory (tramp-compat-temporary-file-directory))
1362 (outline-regexp tramp-debug-outline-regexp))
1364 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1365 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1368 (defsubst tramp-debug-message (vec fmt-string &rest arguments)
1369 "Append message to debug buffer.
1370 Message is formatted with FMT-STRING as control string and the remaining
1371 ARGUMENTS to actually emit the message (if applicable)."
1372 (with-current-buffer (tramp-get-debug-buffer vec)
1373 (goto-char (point-max))
1378 ";; Emacs: %s Tramp: %s -*- mode: outline; -*-"
1379 emacs-version tramp-version))
1380 (when (>= tramp-verbose 10)
1383 "\n;; Location: %s Git: %s"
1384 (locate-library "tramp") (tramp-repository-get-version)))))
1388 (let ((now (current-time)))
1389 (insert (format-time-string "%T." now))
1390 (insert (format "%06d " (nth 2 now))))
1391 ;; Calling Tramp function. We suppress compat and trace functions
1392 ;; from being displayed.
1393 (let ((btn 1) btf fn)
1395 (setq btf (nth 1 (backtrace-frame btn)))
1399 (setq fn (symbol-name btf))
1402 (string-match "^tramp" fn)
1409 "tramp-compat-condition-case-unless-debug"
1410 "tramp-compat-funcall"
1411 "tramp-condition-case-unless-debug"
1412 "tramp-debug-message"
1414 "tramp-error-with-buffer"
1421 (setq btn (1+ btn))))
1422 ;; The following code inserts filename and line number. Should
1423 ;; be inactive by default, because it is time consuming.
1424 ; (let ((ffn (find-function-noselect (intern fn))))
1428 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1429 ; (with-current-buffer (car ffn)
1430 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1431 (insert (format "%s " fn)))
1433 (insert (apply #'format-message fmt-string arguments))))
1435 (defvar tramp-message-show-message t
1436 "Show Tramp message in the minibuffer.
1437 This variable is used to disable messages from `tramp-error'.
1438 The messages are visible anyway, because an error is raised.")
1440 (defsubst tramp-message (vec-or-proc level fmt-string &rest arguments)
1441 "Emit a message depending on verbosity level.
1442 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1443 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1444 less than LEVEL. The message is emitted only if `tramp-verbose' is
1445 greater than or equal to LEVEL.
1447 The message is also logged into the debug buffer when `tramp-verbose'
1448 is greater than or equal 4.
1450 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1451 control string and the remaining ARGUMENTS to actually emit the message (if
1454 (when (<= level tramp-verbose)
1455 ;; Match data must be preserved!
1457 ;; Display only when there is a minimum level.
1458 (when (and tramp-message-show-message (<= level 3))
1464 ((= level 2) "Warning: ")
1468 ;; Log only when there is a minimum level.
1469 (when (>= tramp-verbose 4)
1470 ;; Translate proc to vec.
1471 (when (processp vec-or-proc)
1472 (let ((tramp-verbose 0))
1474 (tramp-get-connection-property vec-or-proc "vector" nil))))
1475 ;; Append connection buffer for error messages.
1477 (let ((tramp-verbose 0))
1478 (with-current-buffer (tramp-get-connection-buffer vec-or-proc)
1479 (setq fmt-string (concat fmt-string "\n%s")
1480 arguments (append arguments (list (buffer-string)))))))
1482 (when (vectorp vec-or-proc)
1483 (apply 'tramp-debug-message
1485 (concat (format "(%d) # " level) fmt-string)
1488 (defsubst tramp-backtrace (&optional vec-or-proc)
1489 "Dump a backtrace into the debug buffer.
1490 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1491 function is meant for debugging purposes."
1493 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace)))
1494 (if (>= tramp-verbose 10)
1495 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1497 (defsubst tramp-error (vec-or-proc signal fmt-string &rest arguments)
1499 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1500 signal identifier to be raised, remaining arguments passed to
1501 `tramp-message'. Finally, signal SIGNAL is raised."
1502 (let (tramp-message-show-message)
1503 (tramp-backtrace vec-or-proc)
1507 (error-message-string
1509 (get signal 'error-message)
1510 (apply #'format-message fmt-string arguments)))))
1511 (signal signal (list (apply #'format-message fmt-string arguments)))))
1513 (defsubst tramp-error-with-buffer
1514 (buf vec-or-proc signal fmt-string &rest arguments)
1515 "Emit an error, and show BUF.
1516 If BUF is nil, show the connection buf. Wait for 30\", or until
1517 an input event arrives. The other arguments are passed to `tramp-error'."
1518 (save-window-excursion
1519 (let* ((buf (or (and (bufferp buf) buf)
1520 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1521 (and (vectorp vec-or-proc)
1522 (tramp-get-connection-buffer vec-or-proc))))
1523 (vec (or (and (vectorp vec-or-proc) vec-or-proc)
1524 (and buf (with-current-buffer buf
1525 (tramp-dissect-file-name default-directory))))))
1527 (apply 'tramp-error vec-or-proc signal fmt-string arguments)
1530 tramp-message-show-message
1531 (not (zerop tramp-verbose))
1532 (not (tramp-completion-mode-p))
1533 ;; Show only when Emacs has started already.
1535 (let ((enable-recursive-minibuffers t))
1536 ;; `tramp-error' does not show messages. So we must do it
1538 (apply 'message fmt-string arguments)
1543 ;; Reset timestamp. It would be wrong after waiting for a while.
1544 (when (equal (butlast (append vec nil) 2)
1545 (car tramp-current-connection))
1546 (setcdr tramp-current-connection (current-time)))))))
1548 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1549 "Parse a Tramp filename and make components available in the body.
1551 First arg FILENAME is evaluated and dissected into its components.
1552 Second arg VAR is a symbol. It is used as a variable name to hold
1553 the filename structure. It is also used as a prefix for the variables
1554 holding the components. For example, if VAR is the symbol `foo', then
1555 `foo' will be bound to the whole structure, `foo-method' will be bound to
1556 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1559 Remaining args are Lisp expressions to be evaluated (inside an implicit
1562 If VAR is nil, then we bind `v' to the structure and `method', `user',
1563 `host', `localname', `hop' to the components."
1565 (mapcar (lambda (elem)
1566 `(,(if var (intern (format "%s-%s" var elem)) elem)
1567 (,(intern (format "tramp-file-name-%s" elem))
1569 '(method user host localname hop))))
1570 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1572 ;; We don't know which of those vars will be used, so we bind them all,
1573 ;; and then add here a dummy use of all those variables, so we don't get
1574 ;; flooded by warnings about those vars `body' didn't use.
1575 (ignore ,@(mapcar #'car bindings))
1578 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1579 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1580 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1582 (defun tramp-progress-reporter-update (reporter &optional value)
1583 (let* ((parameters (cdr reporter))
1584 (message (aref parameters 3)))
1585 (when (string-match message (or (current-message) ""))
1586 (progress-reporter-update reporter value))))
1588 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1589 "Executes BODY, spinning a progress reporter with MESSAGE.
1590 If LEVEL does not fit for visible messages, there are only traces
1591 without a visible progress reporter."
1592 (declare (indent 3) (debug t))
1594 (tramp-message ,vec ,level "%s..." ,message)
1595 (let ((cookie "failed")
1597 ;; We start a pulsing progress reporter after 3 seconds. Feature
1598 ;; introduced in Emacs 24.1.
1599 (when (and tramp-message-show-message
1600 ;; Display only when there is a minimum level.
1601 (<= ,level (min tramp-verbose 3)))
1603 (let ((pr (make-progress-reporter ,message nil nil)))
1606 3 0.1 #'tramp-progress-reporter-update pr)))))))
1608 ;; Execute the body.
1609 (prog1 (progn ,@body) (setq cookie "done"))
1610 ;; Stop progress reporter.
1611 (if tm (cancel-timer tm))
1612 (tramp-message ,vec ,level "%s...%s" ,message cookie)))))
1614 (font-lock-add-keywords
1615 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1617 (defmacro with-tramp-file-property (vec file property &rest body)
1618 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1619 FILE must be a local file name on a connection identified via VEC."
1620 `(if (file-name-absolute-p ,file)
1621 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1622 (when (eq value 'undef)
1623 ;; We cannot pass @body as parameter to
1624 ;; `tramp-set-file-property' because it mangles our
1626 (setq value (progn ,@body))
1627 (tramp-set-file-property ,vec ,file ,property value))
1631 (put 'with-tramp-file-property 'lisp-indent-function 3)
1632 (put 'with-tramp-file-property 'edebug-form-spec t)
1633 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1635 (defmacro with-tramp-connection-property (key property &rest body)
1636 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1637 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1638 (when (eq value 'undef)
1639 ;; We cannot pass ,@body as parameter to
1640 ;; `tramp-set-connection-property' because it mangles our debug
1642 (setq value (progn ,@body))
1643 (tramp-set-connection-property ,key ,property value))
1646 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1647 (put 'with-tramp-connection-property 'edebug-form-spec t)
1648 (font-lock-add-keywords
1649 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1651 (defun tramp-drop-volume-letter (name)
1652 "Cut off unnecessary drive letter from file NAME.
1653 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1654 locally on a remote file name. When the local system is a W32 system
1655 but the remote system is Unix, this introduces a superfluous drive
1656 letter into the file name. This function removes it."
1658 (if (string-match "\\`[a-zA-Z]:/" name)
1659 (replace-match "/" nil t name)
1662 ;;; Config Manipulation Functions:
1664 ;;;###tramp-autoload
1665 (defun tramp-set-completion-function (method function-list)
1666 "Sets the list of completion functions for METHOD.
1667 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1668 The FUNCTION is intended to parse FILE according its syntax.
1669 It might be a predefined FUNCTION, or a user defined FUNCTION.
1670 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1674 (tramp-set-completion-function
1676 \\='((tramp-parse-sconfig \"/etc/ssh_config\")
1677 (tramp-parse-sconfig \"~/.ssh/config\")))"
1679 (let ((r function-list)
1681 (setq tramp-completion-function-alist
1682 (delete (assoc method tramp-completion-function-alist)
1683 tramp-completion-function-alist))
1686 ;; Remove double entries.
1687 (when (member (car v) (cdr v))
1688 (setcdr v (delete (car v) (cdr v))))
1689 ;; Check for function and file or registry key.
1690 (unless (and (functionp (nth 0 (car v)))
1692 ;; Windows registry.
1693 ((string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1694 (and (memq system-type '(cygwin windows-nt))
1697 v "reg" nil nil nil "query" (nth 1 (car v))))))
1698 ;; Zeroconf service type.
1700 "^_[[:alpha:]]+\\._[[:alpha:]]+$" (nth 1 (car v))))
1701 ;; Configuration file.
1702 (t (file-exists-p (nth 1 (car v))))))
1703 (setq r (delete (car v) r)))
1707 (add-to-list 'tramp-completion-function-alist
1710 (defun tramp-get-completion-function (method)
1711 "Returns a list of completion functions for METHOD.
1712 For definition of that list see `tramp-set-completion-function'."
1714 ;; Hosts visited once shall be remembered.
1715 `(tramp-parse-connection-properties ,method)
1716 ;; The method related defaults.
1717 (cdr (assoc method tramp-completion-function-alist))))
1720 ;;; Fontification of `read-file-name':
1722 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1723 (defvar tramp-rfn-eshadow-overlay)
1724 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1726 (defun tramp-rfn-eshadow-setup-minibuffer ()
1727 "Set up a minibuffer for `file-name-shadow-mode'.
1728 Adds another overlay hiding filename parts according to Tramp's
1729 special handling of `substitute-in-file-name'."
1730 (when (symbol-value 'minibuffer-completing-file-name)
1731 (setq tramp-rfn-eshadow-overlay
1732 (make-overlay (minibuffer-prompt-end) (minibuffer-prompt-end)))
1733 ;; Copy rfn-eshadow-overlay properties.
1734 (let ((props (overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1736 ;; The `field' property prevents correct minibuffer
1737 ;; completion; we exclude it.
1738 (if (not (eq (car props) 'field))
1739 (overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1740 (pop props) (pop props))))))
1742 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1743 'tramp-rfn-eshadow-setup-minibuffer)
1744 (add-hook 'tramp-unload-hook
1746 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1747 'tramp-rfn-eshadow-setup-minibuffer)))
1749 (defconst tramp-rfn-eshadow-update-overlay-regexp
1750 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1752 (defun tramp-rfn-eshadow-update-overlay ()
1753 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1754 This is intended to be used as a minibuffer `post-command-hook' for
1755 `file-name-shadow-mode'; the minibuffer should have already
1756 been set up by `rfn-eshadow-setup-minibuffer'."
1757 ;; In remote files name, there is a shadowing just for the local part.
1759 (let ((end (or (overlay-end (symbol-value 'rfn-eshadow-overlay))
1760 (minibuffer-prompt-end)))
1761 ;; We do not want to send any remote command.
1765 (buffer-substring-no-properties end (point-max)))
1769 (1+ (or (string-match
1770 tramp-rfn-eshadow-update-overlay-regexp
1771 (buffer-string) end)
1774 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1775 (rfn-eshadow-update-overlay-hook nil)
1776 file-name-handler-alist)
1777 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
1778 (rfn-eshadow-update-overlay))))))))
1780 (add-hook 'rfn-eshadow-update-overlay-hook
1781 'tramp-rfn-eshadow-update-overlay)
1782 (add-hook 'tramp-unload-hook
1784 (remove-hook 'rfn-eshadow-update-overlay-hook
1785 'tramp-rfn-eshadow-update-overlay)))
1787 ;; Inodes don't exist for some file systems. Therefore we must
1788 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1789 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1790 ;; performance isn't the major issue given that file transfer will
1792 (defvar tramp-inodes 0
1793 "Keeps virtual inodes numbers.")
1795 ;; Devices must distinguish physical file systems. The device numbers
1796 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1797 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1798 ;; EFS use device number "-1". In order to be different, we use device number
1799 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1800 (defvar tramp-devices 0
1801 "Keeps virtual device numbers.")
1803 (defun tramp-default-file-modes (filename)
1804 "Return file modes of FILENAME as integer.
1805 If the file modes of FILENAME cannot be determined, return the
1806 value of `default-file-modes', without execute permissions."
1807 (or (file-modes filename)
1808 (logand (default-file-modes) (string-to-number "0666" 8))))
1810 (defun tramp-replace-environment-variables (filename)
1811 "Replace environment variables in FILENAME.
1812 Return the string with the replaced variables."
1814 ;; Optional arg has been introduced with Emacs 24 (?).
1815 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1816 ;; We need an own implementation.
1818 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1819 ;; `$' is coded as `$$'.
1821 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1822 (getenv (match-string 1 filename)))
1825 (substitute-in-file-name (match-string 0 filename))
1829 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1830 "Like `find-operation-coding-system' for Tramp filenames.
1831 Tramp's `insert-file-contents' and `write-region' work over
1832 temporary file names. If `file-coding-system-alist' contains an
1833 expression, which matches more than the file name suffix, the
1834 coding system might not be determined. This function repairs it."
1836 (dolist (elt file-coding-system-alist result)
1837 (when (and (consp elt) (string-match (car elt) filename))
1838 ;; We found a matching entry in `file-coding-system-alist'.
1839 ;; So we add a similar entry, but with the temporary file name
1842 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1844 (defun tramp-run-real-handler (operation args)
1845 "Invoke normal file name handler for OPERATION.
1846 First arg specifies the OPERATION, second arg is a list of arguments to
1847 pass to the OPERATION."
1848 (let* ((inhibit-file-name-handlers
1849 `(tramp-file-name-handler
1850 tramp-vc-file-name-handler
1851 tramp-completion-file-name-handler
1852 cygwin-mount-name-hook-function
1853 cygwin-mount-map-drive-hook-function
1855 ,(and (eq inhibit-file-name-operation operation)
1856 inhibit-file-name-handlers)))
1857 (inhibit-file-name-operation operation))
1858 (apply operation args)))
1861 (progn (defun tramp-completion-run-real-handler (operation args)
1862 "Invoke `tramp-file-name-handler' for OPERATION.
1863 First arg specifies the OPERATION, second arg is a list of arguments to
1864 pass to the OPERATION."
1865 (let* ((inhibit-file-name-handlers
1866 `(tramp-completion-file-name-handler
1867 cygwin-mount-name-hook-function
1868 cygwin-mount-map-drive-hook-function
1870 ,(and (eq inhibit-file-name-operation operation)
1871 inhibit-file-name-handlers)))
1872 (inhibit-file-name-operation operation))
1873 (apply operation args))))
1875 ;; We handle here all file primitives. Most of them have the file
1876 ;; name as first parameter; nevertheless we check for them explicitly
1877 ;; in order to be signaled if a new primitive appears. This
1878 ;; scenario is needed because there isn't a way to decide by
1879 ;; syntactical means whether a foreign method must be called. It would
1880 ;; ease the life if `file-name-handler-alist' would support a decision
1881 ;; function as well but regexp only.
1882 (defun tramp-file-name-for-operation (operation &rest args)
1883 "Return file name related to OPERATION file primitive.
1884 ARGS are the arguments OPERATION has been called with."
1886 ;; FILE resp DIRECTORY.
1888 '(access-file byte-compiler-base-file-name delete-directory
1889 delete-file diff-latest-backup-file directory-file-name
1890 directory-files directory-files-and-attributes
1891 dired-compress-file dired-uncache
1892 file-accessible-directory-p file-attributes
1893 file-directory-p file-executable-p file-exists-p
1894 file-local-copy file-modes
1895 file-name-as-directory file-name-directory
1896 file-name-nondirectory file-name-sans-versions
1897 file-ownership-preserved-p file-readable-p
1898 file-regular-p file-remote-p file-symlink-p file-truename
1899 file-writable-p find-backup-file-name find-file-noselect
1900 get-file-buffer insert-directory insert-file-contents
1901 load make-directory make-directory-internal
1902 set-file-modes set-file-times substitute-in-file-name
1903 unhandled-file-name-directory vc-registered
1905 file-acl file-notify-add-watch file-selinux-context
1906 set-file-acl set-file-selinux-context))
1907 (if (file-name-absolute-p (nth 0 args))
1909 (expand-file-name (nth 0 args))))
1910 ;; FILE DIRECTORY resp FILE1 FILE2.
1912 '(add-name-to-file copy-directory copy-file expand-file-name
1913 file-name-all-completions file-name-completion
1914 file-newer-than-file-p make-symbolic-link rename-file
1916 file-equal-p file-in-directory-p))
1919 ((tramp-tramp-file-p (nth 0 args)) (nth 0 args))
1920 ((tramp-tramp-file-p (nth 1 args)) (nth 1 args))
1921 (t (buffer-file-name (current-buffer))))))
1923 ((eq operation 'write-region)
1927 '(make-auto-save-file-name
1928 set-visited-file-modtime verify-visited-file-modtime))
1930 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1933 '(process-file shell-command start-file-process))
1937 '(;; Emacs 24+ only.
1938 file-notify-rm-watch
1940 file-notify-valid-p))
1941 (when (processp (nth 0 args))
1942 (with-current-buffer (process-buffer (nth 0 args))
1943 default-directory)))
1944 ;; Unknown file primitive.
1945 (t (error "unknown file I/O primitive: %s" operation))))
1947 (defun tramp-find-foreign-file-name-handler
1948 (filename &optional operation completion)
1949 "Return foreign file name handler if exists."
1950 (when (tramp-tramp-file-p filename)
1951 (let ((v (tramp-dissect-file-name filename t))
1952 (handler tramp-foreign-file-name-handler-alist)
1954 ;; When we are not fully sure that filename completion is safe,
1955 ;; we should not return a handler.
1956 (when (or (not completion)
1957 (tramp-file-name-method v) (tramp-file-name-user v)
1958 (and (tramp-file-name-host v)
1959 (not (member (tramp-file-name-host v)
1960 (mapcar 'car tramp-methods))))
1961 ;; Some operations are safe by default.
1964 '(file-name-as-directory
1966 file-name-nondirectory)))
1968 (setq elt (car handler)
1969 handler (cdr handler))
1970 (when (funcall (car elt) filename)
1975 (defvar tramp-debug-on-error nil
1976 "Like `debug-on-error' but used Tramp internal.")
1978 (defmacro tramp-condition-case-unless-debug
1979 (var bodyform &rest handlers)
1980 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
1981 `(let ((debug-on-error tramp-debug-on-error))
1982 (tramp-compat-condition-case-unless-debug ,var ,bodyform ,@handlers)))
1985 (defun tramp-file-name-handler (operation &rest args)
1986 "Invoke Tramp file name handler.
1987 Falls back to normal file name handler if no Tramp file name handler exists."
1991 (tramp-replace-environment-variables
1992 (apply 'tramp-file-name-for-operation operation args)))
1993 (completion (tramp-completion-mode-p))
1995 (tramp-find-foreign-file-name-handler
1996 filename operation completion))
1998 (with-parsed-tramp-file-name filename nil
1999 ;; Call the backend function.
2001 (tramp-condition-case-unless-debug err
2002 (let ((sf (symbol-function foreign)))
2003 ;; Some packages set the default directory to a
2004 ;; remote path, before respective Tramp packages
2005 ;; are already loaded. This results in
2006 ;; recursive loading. Therefore, we load the
2007 ;; Tramp packages locally.
2008 (when (and (listp sf) (eq (car sf) 'autoload))
2009 (let ((default-directory
2010 (tramp-compat-temporary-file-directory)))
2011 (load (cadr sf) 'noerror 'nomessage)))
2012 ;; If `non-essential' is non-nil, Tramp shall
2013 ;; not open a new connection.
2014 ;; If Tramp detects that it shouldn't continue
2015 ;; to work, it throws the `suppress' event.
2016 ;; This could happen for example, when Tramp
2017 ;; tries to open the same connection twice in a
2018 ;; short time frame.
2019 ;; In both cases, we try the default handler then.
2021 (catch 'non-essential
2023 (apply foreign operation args))))
2025 ((eq result 'non-essential)
2027 v 5 "Non-essential received in operation %s"
2028 (cons operation args))
2029 (tramp-run-real-handler operation args))
2030 ((eq result 'suppress)
2031 (let (tramp-message-show-message)
2033 v 1 "Suppress received in operation %s"
2034 (cons operation args))
2035 (tramp-cleanup-connection v t)
2036 (tramp-run-real-handler operation args)))
2039 ;; Trace that somebody has interrupted the operation.
2041 (let (tramp-message-show-message)
2043 v 1 "Interrupt received in operation %s"
2044 (cons operation args)))
2045 ;; Propagate the quit signal.
2046 (signal (car err) (cdr err)))
2048 ;; When we are in completion mode, some failed
2049 ;; operations shall return at least a default value
2050 ;; in order to give the user a chance to correct the
2051 ;; file name in the minibuffer.
2052 ;; In order to get a full backtrace, one could apply
2053 ;; (setq tramp-debug-on-error t)
2056 ((and completion (zerop (length localname))
2057 (memq operation '(file-exists-p file-directory-p)))
2059 ((and completion (zerop (length localname))
2061 '(expand-file-name file-name-as-directory)))
2063 ;; Propagate the error.
2064 (t (signal (car err) (cdr err))))))
2066 ;; Nothing to do for us. However, since we are in
2067 ;; `tramp-mode', we must suppress the volume letter on
2069 (setq result (tramp-run-real-handler operation args))
2070 (if (stringp result)
2071 (tramp-drop-volume-letter result)
2074 ;; When `tramp-mode' is not enabled, we don't do anything.
2075 (tramp-run-real-handler operation args)))
2077 ;; In Emacs, there is some concurrency due to timers. If a timer
2078 ;; interrupts Tramp and wishes to use the same connection buffer as
2079 ;; the "main" Emacs, then garbage might occur in the connection
2080 ;; buffer. Therefore, we need to make sure that a timer does not use
2081 ;; the same connection buffer as the "main" Emacs. We implement a
2082 ;; cheap global lock, instead of locking each connection buffer
2083 ;; separately. The global lock is based on two variables,
2084 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2085 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2086 ;; processing of a single file operation, so we need to allow
2087 ;; recursive calls. That's where the `tramp-locker' variable comes in
2088 ;; -- it is let-bound to t during the execution of the current
2089 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2090 ;; then we should just proceed because we have been called
2091 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2092 ;; interrupting the "main" Emacs, and then we signal an error.
2094 (defvar tramp-locked nil
2095 "If non-nil, then Tramp is currently busy.
2096 Together with `tramp-locker', this implements a locking mechanism
2097 preventing reentrant calls of Tramp.")
2099 (defvar tramp-locker nil
2100 "If non-nil, then a caller has locked Tramp.
2101 Together with `tramp-locked', this implements a locking mechanism
2102 preventing reentrant calls of Tramp.")
2105 (progn (defun tramp-completion-file-name-handler (operation &rest args)
2106 "Invoke Tramp file name completion handler.
2107 Falls back to normal file name handler if no Tramp file name handler exists."
2108 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
2110 ;; When `tramp-mode' is not enabled, we don't do anything.
2112 ;; For other syntaxes than `sep', the regexp matches many common
2113 ;; situations where the user doesn't actually want to use Tramp.
2114 ;; So to avoid autoloading Tramp after typing just "/s", we
2115 ;; disable this part of the completion, unless the user implicitly
2116 ;; indicated his interest in using a fancier completion system.
2117 (or (eq tramp-syntax 'sep)
2118 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2119 ;; `partial-completion-mode' is obsoleted with Emacs 24.1.
2120 (and (boundp 'partial-completion-mode)
2121 (symbol-value 'partial-completion-mode))
2122 ;; FIXME: These may have been loaded even if the user never
2123 ;; intended to use them.
2125 (featurep 'icicles)))
2126 (save-match-data (apply (cdr fn) args))
2127 (tramp-completion-run-real-handler operation args)))))
2130 (progn (defun tramp-autoload-file-name-handler (operation &rest args)
2131 "Load Tramp file name handler, and perform OPERATION."
2132 ;; Avoid recursive loading of tramp.el.
2133 (let ((default-directory temporary-file-directory))
2134 (load "tramp" nil t))
2135 (apply operation args)))
2137 ;; `tramp-autoload-file-name-handler' must be registered before
2138 ;; evaluation of site-start and init files, because there might exist
2139 ;; remote files already, f.e. files kept via recentf-mode. We cannot
2140 ;; autoload `tramp-file-name-handler', because it would result in
2141 ;; recursive loading of tramp.el when `default-directory' is set to
2144 (progn (defun tramp-register-autoload-file-name-handlers ()
2145 "Add Tramp file name handlers to `file-name-handler-alist' during autoload."
2146 (add-to-list 'file-name-handler-alist
2147 (cons tramp-file-name-regexp
2148 'tramp-autoload-file-name-handler))
2149 (put 'tramp-autoload-file-name-handler 'safe-magic t)
2150 (add-to-list 'file-name-handler-alist
2151 (cons tramp-completion-file-name-regexp
2152 'tramp-completion-file-name-handler))
2153 (put 'tramp-completion-file-name-handler 'safe-magic t)))
2156 (tramp-register-autoload-file-name-handlers)
2158 (defun tramp-register-file-name-handlers ()
2159 "Add Tramp file name handlers to `file-name-handler-alist'."
2160 ;; Remove autoloaded handlers from file name handler alist. Useful,
2161 ;; if `tramp-syntax' has been changed.
2162 (dolist (fnh '(tramp-file-name-handler
2163 tramp-completion-file-name-handler
2164 tramp-autoload-file-name-handler))
2165 (let ((a1 (rassq fnh file-name-handler-alist)))
2166 (setq file-name-handler-alist (delq a1 file-name-handler-alist))))
2167 ;; Add the handlers.
2168 (add-to-list 'file-name-handler-alist
2169 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2170 (put 'tramp-file-name-handler 'safe-magic t)
2171 (add-to-list 'file-name-handler-alist
2172 (cons tramp-completion-file-name-regexp
2173 'tramp-completion-file-name-handler))
2174 (put 'tramp-completion-file-name-handler 'safe-magic t)
2175 ;; If jka-compr or epa-file are already loaded, move them to the
2176 ;; front of `file-name-handler-alist'.
2177 (dolist (fnh '(epa-file-handler jka-compr-handler))
2178 (let ((entry (rassoc fnh file-name-handler-alist)))
2180 (setq file-name-handler-alist
2181 (cons entry (delete entry file-name-handler-alist)))))))
2183 (eval-after-load 'tramp (tramp-register-file-name-handlers))
2185 (defun tramp-exists-file-name-handler (operation &rest args)
2186 "Check, whether OPERATION runs a file name handler."
2187 ;; The file name handler is determined on base of either an
2188 ;; argument, `buffer-file-name', or `default-directory'.
2190 (let* ((buffer-file-name "/")
2191 (default-directory "/")
2192 (fnha file-name-handler-alist)
2193 (check-file-name-operation operation)
2194 (file-name-handler-alist
2197 (lambda (operation &rest args)
2198 "Returns OPERATION if it is the one to be checked."
2199 (if (equal check-file-name-operation operation)
2201 (let ((file-name-handler-alist fnha))
2202 (apply operation args))))))))
2203 (equal (apply operation args) operation))))
2206 (defun tramp-unload-file-name-handlers ()
2207 (setq file-name-handler-alist
2208 (delete (rassoc 'tramp-file-name-handler
2209 file-name-handler-alist)
2210 (delete (rassoc 'tramp-completion-file-name-handler
2211 file-name-handler-alist)
2212 file-name-handler-alist))))
2214 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2216 ;;; File name handler functions for completion mode:
2218 (defvar tramp-completion-mode nil
2219 "If non-nil, external packages signal that they are in file name completion.
2221 This is necessary, because Tramp uses a heuristic depending on last
2222 input event. This fails when external packages use other characters
2223 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2224 should never be set globally, the intention is to let-bind it.")
2226 ;; Necessary because `tramp-file-name-regexp-unified' and
2227 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2228 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2229 ;; to `tramp-file-name-handler'). Otherwise, it takes
2230 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2231 ;; risky, because completing a file might require loading other files,
2232 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2233 ;; variable. On the other hand, those files shouldn't have partial
2234 ;; Tramp file name syntax. Maybe another variable should be introduced
2235 ;; overwriting this check in such cases. Or we change Tramp file name
2236 ;; syntax in order to avoid ambiguities.
2237 ;;;###tramp-autoload
2238 (defun tramp-completion-mode-p ()
2239 "Check, whether method / user name / host name completion is active."
2241 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2242 (and (boundp 'non-essential) (symbol-value 'non-essential))
2243 tramp-completion-mode
2244 (equal last-input-event 'tab)
2245 (and (natnump last-input-event)
2247 ;; ?\t has event-modifier 'control.
2248 (equal last-input-event ?\t)
2249 (and (not (event-modifiers last-input-event))
2250 (or (equal last-input-event ?\?)
2251 (equal last-input-event ?\ )))))))
2253 (defun tramp-connectable-p (filename)
2254 "Check, whether it is possible to connect the remote host w/o side-effects.
2255 This is true, if either the remote host is already connected, or if we are
2256 not in completion mode."
2257 (and (tramp-tramp-file-p filename)
2258 (with-parsed-tramp-file-name filename nil
2259 (or (not (tramp-completion-mode-p))
2260 (let* ((tramp-verbose 0)
2261 (p (tramp-get-connection-process v)))
2262 (and p (processp p) (memq (process-status p) '(run open))))))))
2264 ;; Method, host name and user name completion.
2265 ;; `tramp-completion-dissect-file-name' returns a list of
2266 ;; tramp-file-name structures. For all of them we return possible completions.
2268 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2269 "Like `file-name-all-completions' for partial Tramp files."
2272 (tramp-drop-volume-letter (expand-file-name filename directory)))
2275 ;; Suppress hop from completion.
2279 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2280 tramp-postfix-hop-regexp
2283 (setq hop (match-string 1 fullname)
2284 fullname (replace-match "" nil nil fullname 1)))
2286 ;; Possible completion structures.
2287 (dolist (elt (tramp-completion-dissect-file-name fullname))
2288 (let* ((method (tramp-file-name-method elt))
2289 (user (tramp-file-name-user elt))
2290 (host (tramp-file-name-host elt))
2291 (localname (tramp-file-name-localname elt))
2292 (m (tramp-find-method method user host))
2293 (tramp-current-user user) ; see `tramp-parse-passwd'
2296 (unless localname ;; Nothing to complete.
2300 ;; Method dependent user / host combinations.
2304 (setq all-user-hosts
2305 (append all-user-hosts
2306 (funcall (nth 0 x) (nth 1 x)))))
2307 (tramp-get-completion-function m))
2313 (tramp-get-completion-user-host
2314 method user host (nth 0 x) (nth 1 x)))
2315 (delq nil all-user-hosts)))))
2317 ;; Possible methods.
2319 (append result (tramp-get-completion-methods m)))))))
2321 ;; Unify list, add hop, remove nil elements.
2322 (dolist (elt result)
2324 (string-match tramp-prefix-regexp elt)
2325 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2328 (substring elt (length (tramp-drop-volume-letter directory))))))
2330 ;; Complete local parts.
2334 (apply (if (tramp-connectable-p fullname)
2335 'tramp-completion-run-real-handler
2336 'tramp-run-real-handler)
2337 'file-name-all-completions (list (list filename directory)))))))
2339 ;; Method, host name and user name completion for a file.
2341 (defun tramp-completion-handle-file-name-completion
2342 (filename directory &optional predicate)
2343 "Like `file-name-completion' for Tramp files."
2346 (mapcar 'list (file-name-all-completions filename directory))
2347 (when (and predicate
2348 (tramp-connectable-p (expand-file-name filename directory)))
2349 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2351 ;; I misuse a little bit the tramp-file-name structure in order to handle
2352 ;; completion possibilities for partial methods / user names / host names.
2353 ;; Return value is a list of tramp-file-name structures according to possible
2354 ;; completions. If "localname" is non-nil it means there
2355 ;; shouldn't be a completion anymore.
2357 ;; Expected results:
2359 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2360 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2361 ;; [nil "x" nil nil]
2362 ;; ["x" nil nil nil]
2364 ;; "/x:" "/x:y" "/x:y:"
2365 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2367 ;; ["x" nil "" nil] ["x" nil "y" nil]
2368 ;; ["x" "" nil nil] ["x" "y" nil nil]
2370 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2371 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2372 ;; "/[x/y@" "/[x/y@z"
2373 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2374 (defun tramp-completion-dissect-file-name (name)
2375 "Returns a list of `tramp-file-name' structures.
2376 They are collected by `tramp-completion-dissect-file-name1'."
2380 (tramp-completion-ipv6-regexp
2383 (if (zerop (length tramp-postfix-ipv6-format))
2384 tramp-postfix-host-format
2385 tramp-postfix-ipv6-format)))
2386 ;; "/method" "/[method"
2387 (tramp-completion-file-name-structure1
2388 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2391 (tramp-completion-file-name-structure2
2392 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2395 (tramp-completion-file-name-structure3
2396 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2398 ;; "/[ipv6" "/[ipv6"
2399 (tramp-completion-file-name-structure4
2400 (list (concat tramp-prefix-regexp
2401 tramp-prefix-ipv6-regexp
2402 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2404 ;; "/user@host" "/[user@host"
2405 (tramp-completion-file-name-structure5
2406 (list (concat tramp-prefix-regexp
2407 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2408 "\\(" tramp-host-regexp x-nil "\\)$")
2410 ;; "/user@[ipv6" "/[user@ipv6"
2411 (tramp-completion-file-name-structure6
2412 (list (concat tramp-prefix-regexp
2413 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2414 tramp-prefix-ipv6-regexp
2415 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2417 ;; "/method:user" "/[method/user"
2418 (tramp-completion-file-name-structure7
2419 (list (concat tramp-prefix-regexp
2420 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2421 "\\(" tramp-user-regexp x-nil "\\)$")
2423 ;; "/method:host" "/[method/host"
2424 (tramp-completion-file-name-structure8
2425 (list (concat tramp-prefix-regexp
2426 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2427 "\\(" tramp-host-regexp x-nil "\\)$")
2429 ;; "/method:[ipv6" "/[method/ipv6"
2430 (tramp-completion-file-name-structure9
2431 (list (concat tramp-prefix-regexp
2432 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2433 tramp-prefix-ipv6-regexp
2434 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2436 ;; "/method:user@host" "/[method/user@host"
2437 (tramp-completion-file-name-structure10
2438 (list (concat tramp-prefix-regexp
2439 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2440 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2441 "\\(" tramp-host-regexp x-nil "\\)$")
2443 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2444 (tramp-completion-file-name-structure11
2445 (list (concat tramp-prefix-regexp
2446 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2447 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2448 tramp-prefix-ipv6-regexp
2449 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2452 (mapc (lambda (structure)
2453 (add-to-list 'result
2454 (tramp-completion-dissect-file-name1 structure name)))
2456 tramp-completion-file-name-structure1
2457 tramp-completion-file-name-structure2
2458 tramp-completion-file-name-structure3
2459 tramp-completion-file-name-structure4
2460 tramp-completion-file-name-structure5
2461 tramp-completion-file-name-structure6
2462 tramp-completion-file-name-structure7
2463 tramp-completion-file-name-structure8
2464 tramp-completion-file-name-structure9
2465 tramp-completion-file-name-structure10
2466 tramp-completion-file-name-structure11
2467 tramp-file-name-structure))
2471 (defun tramp-completion-dissect-file-name1 (structure name)
2472 "Returns a `tramp-file-name' structure matching STRUCTURE.
2473 The structure consists of remote method, remote user,
2474 remote host and localname (filename on remote host)."
2477 (when (string-match (nth 0 structure) name)
2478 (let ((method (and (nth 1 structure)
2479 (match-string (nth 1 structure) name)))
2480 (user (and (nth 2 structure)
2481 (match-string (nth 2 structure) name)))
2482 (host (and (nth 3 structure)
2483 (match-string (nth 3 structure) name)))
2484 (localname (and (nth 4 structure)
2485 (match-string (nth 4 structure) name))))
2486 (vector method user host localname nil)))))
2488 ;; This function returns all possible method completions, adding the
2489 ;; trailing method delimiter.
2490 (defun tramp-get-completion-methods (partial-method)
2491 "Returns all method completions for PARTIAL-METHOD."
2495 (string-match (concat "^" (regexp-quote partial-method)) method)
2496 (tramp-completion-make-tramp-file-name method nil nil nil)))
2497 (mapcar 'car tramp-methods)))
2499 ;; Compares partial user and host names with possible completions.
2500 (defun tramp-get-completion-user-host
2501 (method partial-user partial-host user host)
2502 "Returns the most expanded string for user and host name completion.
2503 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2506 ((and partial-user partial-host)
2508 (string-match (concat "^" (regexp-quote partial-host)) host)
2509 (string-equal partial-user (or user partial-user)))
2510 (setq user partial-user)
2517 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2523 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2529 (unless (zerop (+ (length user) (length host)))
2530 (tramp-completion-make-tramp-file-name method user host nil)))
2532 ;; Generic function.
2533 (defun tramp-parse-group (regexp match-level skip-regexp)
2534 "Return a (user host) tuple allowed to access.
2535 User is always nil."
2537 (when (re-search-forward regexp (point-at-eol) t)
2538 (setq result (list nil (match-string match-level))))
2540 (> (skip-chars-forward skip-regexp) 0)
2544 ;; Generic function.
2545 (defun tramp-parse-file (filename function)
2546 "Return a list of (user host) tuples allowed to access.
2547 User is always nil."
2548 ;; On Windows, there are problems in completion when
2549 ;; `default-directory' is remote.
2550 (let ((default-directory (tramp-compat-temporary-file-directory)))
2551 (when (file-readable-p filename)
2553 (insert-file-contents filename)
2554 (goto-char (point-min))
2555 (loop while (not (eobp)) collect (funcall function))))))
2557 ;;;###tramp-autoload
2558 (defun tramp-parse-rhosts (filename)
2559 "Return a list of (user host) tuples allowed to access.
2560 Either user or host may be nil."
2561 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2563 (defun tramp-parse-rhosts-group ()
2564 "Return a (user host) tuple allowed to access.
2565 Either user or host may be nil."
2569 "^\\(" tramp-host-regexp "\\)"
2570 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2571 (when (re-search-forward regexp (point-at-eol) t)
2572 (setq result (append (list (match-string 3) (match-string 1)))))
2576 ;;;###tramp-autoload
2577 (defun tramp-parse-shosts (filename)
2578 "Return a list of (user host) tuples allowed to access.
2579 User is always nil."
2580 (tramp-parse-file filename 'tramp-parse-shosts-group))
2582 (defun tramp-parse-shosts-group ()
2583 "Return a (user host) tuple allowed to access.
2584 User is always nil."
2585 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2587 ;;;###tramp-autoload
2588 (defun tramp-parse-sconfig (filename)
2589 "Return a list of (user host) tuples allowed to access.
2590 User is always nil."
2591 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2593 (defun tramp-parse-sconfig-group ()
2594 "Return a (user host) tuple allowed to access.
2595 User is always nil."
2597 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2599 ;; Generic function.
2600 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2601 "Return a list of (user host) tuples allowed to access.
2602 User is always nil."
2603 ;; On Windows, there are problems in completion when
2604 ;; `default-directory' is remote.
2605 (let* ((default-directory (tramp-compat-temporary-file-directory))
2606 (files (and (file-directory-p dirname) (directory-files dirname))))
2607 (loop for f in files
2608 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2609 collect (list nil (match-string 1 f)))))
2611 ;;;###tramp-autoload
2612 (defun tramp-parse-shostkeys (dirname)
2613 "Return a list of (user host) tuples allowed to access.
2614 User is always nil."
2615 (tramp-parse-shostkeys-sknownhosts
2616 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2618 ;;;###tramp-autoload
2619 (defun tramp-parse-sknownhosts (dirname)
2620 "Return a list of (user host) tuples allowed to access.
2621 User is always nil."
2622 (tramp-parse-shostkeys-sknownhosts
2624 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2626 ;;;###tramp-autoload
2627 (defun tramp-parse-hosts (filename)
2628 "Return a list of (user host) tuples allowed to access.
2629 User is always nil."
2630 (tramp-parse-file filename 'tramp-parse-hosts-group))
2632 (defun tramp-parse-hosts-group ()
2633 "Return a (user host) tuple allowed to access.
2634 User is always nil."
2636 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2638 ;;;###tramp-autoload
2639 (defun tramp-parse-passwd (filename)
2640 "Return a list of (user host) tuples allowed to access.
2641 Host is always \"localhost\"."
2642 (with-tramp-connection-property nil "parse-passwd"
2643 (if (executable-find "getent")
2645 (when (zerop (tramp-call-process nil "getent" nil t nil "passwd"))
2646 (goto-char (point-min))
2647 (loop while (not (eobp)) collect
2648 (tramp-parse-etc-group-group))))
2649 (tramp-parse-file filename 'tramp-parse-passwd-group))))
2651 (defun tramp-parse-passwd-group ()
2652 "Return a (user host) tuple allowed to access.
2653 Host is always \"localhost\"."
2655 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2656 (when (re-search-forward regexp (point-at-eol) t)
2657 (setq result (list (match-string 1) "localhost")))
2661 ;;;###tramp-autoload
2662 (defun tramp-parse-etc-group (filename)
2663 "Return a list of (group host) tuples allowed to access.
2664 Host is always \"localhost\"."
2665 (with-tramp-connection-property nil "parse-group"
2666 (if (executable-find "getent")
2668 (when (zerop (tramp-call-process nil "getent" nil t nil "group"))
2669 (goto-char (point-min))
2670 (loop while (not (eobp)) collect
2671 (tramp-parse-etc-group-group))))
2672 (tramp-parse-file filename 'tramp-parse-etc-group-group))))
2674 (defun tramp-parse-etc-group-group ()
2675 "Return a (group host) tuple allowed to access.
2676 Host is always \"localhost\"."
2678 (split (split-string (buffer-substring (point) (point-at-eol)) ":")))
2679 (when (member (user-login-name) (split-string (nth 3 split) "," 'omit))
2680 (setq result (list (nth 0 split) "localhost")))
2684 ;;;###tramp-autoload
2685 (defun tramp-parse-netrc (filename)
2686 "Return a list of (user host) tuples allowed to access.
2688 (tramp-parse-file filename 'tramp-parse-netrc-group))
2690 (defun tramp-parse-netrc-group ()
2691 "Return a (user host) tuple allowed to access.
2696 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2697 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2698 (when (re-search-forward regexp (point-at-eol) t)
2699 (setq result (list (match-string 3) (match-string 1))))
2703 ;;;###tramp-autoload
2704 (defun tramp-parse-putty (registry-or-dirname)
2705 "Return a list of (user host) tuples allowed to access.
2706 User is always nil."
2707 (if (memq system-type '(windows-nt))
2708 (with-tramp-connection-property nil "parse-putty"
2710 (when (zerop (tramp-call-process
2711 nil "reg" nil t nil "query" registry-or-dirname))
2712 (goto-char (point-min))
2713 (loop while (not (eobp)) collect
2714 (tramp-parse-putty-group registry-or-dirname)))))
2716 (tramp-parse-shostkeys-sknownhosts
2717 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2719 (defun tramp-parse-putty-group (registry)
2720 "Return a (user host) tuple allowed to access.
2721 User is always nil."
2723 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2724 (when (re-search-forward regexp (point-at-eol) t)
2725 (setq result (list nil (match-string 1))))
2729 ;;; Common file name handler functions for different backends:
2731 (defvar tramp-handle-file-local-copy-hook nil
2732 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2734 (defvar tramp-handle-write-region-hook nil
2735 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2737 (defun tramp-handle-directory-file-name (directory)
2738 "Like `directory-file-name' for Tramp files."
2739 ;; If localname component of filename is "/", leave it unchanged.
2740 ;; Otherwise, remove any trailing slash from localname component.
2741 ;; Method, host, etc, are unchanged. Does it make sense to try
2742 ;; to avoid parsing the filename?
2743 (with-parsed-tramp-file-name directory nil
2744 (if (and (not (zerop (length localname)))
2745 (eq (aref localname (1- (length localname))) ?/)
2746 (not (string= localname "/")))
2747 (substring directory 0 -1)
2750 (defun tramp-handle-directory-files (directory &optional full match nosort)
2751 "Like `directory-files' for Tramp files."
2752 (when (file-directory-p directory)
2753 (setq directory (file-name-as-directory (expand-file-name directory)))
2754 (let ((temp (nreverse (file-name-all-completions "" directory)))
2758 (setq item (directory-file-name (pop temp)))
2759 (when (or (null match) (string-match match item))
2760 (push (if full (concat directory item) item)
2762 (if nosort result (sort result 'string<)))))
2764 (defun tramp-handle-directory-files-and-attributes
2765 (directory &optional full match nosort id-format)
2766 "Like `directory-files-and-attributes' for Tramp files."
2769 (cons x (file-attributes
2770 (if full x (expand-file-name x directory)) id-format)))
2771 (directory-files directory full match nosort)))
2773 (defun tramp-handle-dired-uncache (dir)
2774 "Like `dired-uncache' for Tramp files."
2775 (with-parsed-tramp-file-name
2776 (if (file-directory-p dir) dir (file-name-directory dir)) nil
2777 (tramp-flush-directory-property v localname)))
2779 (defun tramp-handle-file-accessible-directory-p (filename)
2780 "Like `file-accessible-directory-p' for Tramp files."
2781 (and (file-directory-p filename)
2782 (file-readable-p filename)))
2784 (defun tramp-handle-file-equal-p (filename1 filename2)
2785 "Like `file-equalp-p' for Tramp files."
2786 ;; Native `file-equalp-p' calls `file-truename', which requires a
2787 ;; remote connection. This can be avoided, if FILENAME1 and
2788 ;; FILENAME2 are not located on the same remote host.
2790 (file-remote-p (expand-file-name filename1))
2791 (file-remote-p (expand-file-name filename2)))
2792 (tramp-run-real-handler 'file-equal-p (list filename1 filename2))))
2794 (defun tramp-handle-file-exists-p (filename)
2795 "Like `file-exists-p' for Tramp files."
2796 (not (null (file-attributes filename))))
2798 (defun tramp-handle-file-in-directory-p (filename directory)
2799 "Like `file-in-directory-p' for Tramp files."
2800 ;; Native `file-in-directory-p' calls `file-truename', which
2801 ;; requires a remote connection. This can be avoided, if FILENAME
2802 ;; and DIRECTORY are not located on the same remote host.
2804 (file-remote-p (expand-file-name filename))
2805 (file-remote-p (expand-file-name directory)))
2806 (tramp-run-real-handler 'file-in-directory-p (list filename directory))))
2808 (defun tramp-handle-file-modes (filename)
2809 "Like `file-modes' for Tramp files."
2810 (let ((truename (or (file-truename filename) filename)))
2811 (when (file-exists-p truename)
2812 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2814 ;; Localname manipulation functions that grok Tramp localnames...
2815 (defun tramp-handle-file-name-as-directory (file)
2816 "Like `file-name-as-directory' but aware of Tramp files."
2817 ;; `file-name-as-directory' would be sufficient except localname is
2818 ;; the empty string.
2819 (let ((v (tramp-dissect-file-name file t)))
2820 ;; Run the command on the localname portion only.
2821 (tramp-make-tramp-file-name
2822 (tramp-file-name-method v)
2823 (tramp-file-name-user v)
2824 (tramp-file-name-host v)
2825 (tramp-run-real-handler
2826 'file-name-as-directory (list (or (tramp-file-name-localname v) "")))
2827 (tramp-file-name-hop v))))
2829 (defun tramp-handle-file-name-completion
2830 (filename directory &optional predicate)
2831 "Like `file-name-completion' for Tramp files."
2832 (unless (tramp-tramp-file-p directory)
2834 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2838 (mapcar 'list (file-name-all-completions filename directory))
2840 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2842 (defun tramp-handle-file-name-directory (file)
2843 "Like `file-name-directory' but aware of Tramp files."
2844 ;; Everything except the last filename thing is the directory. We
2845 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2846 ;; the remote file name parts. This is a problem when we are in
2847 ;; file name completion.
2848 (let ((v (tramp-dissect-file-name file t)))
2849 ;; Run the command on the localname portion only.
2850 (tramp-make-tramp-file-name
2851 (tramp-file-name-method v)
2852 (tramp-file-name-user v)
2853 (tramp-file-name-host v)
2854 (tramp-run-real-handler
2855 'file-name-directory (list (or (tramp-file-name-localname v) "")))
2856 (tramp-file-name-hop v))))
2858 (defun tramp-handle-file-name-nondirectory (file)
2859 "Like `file-name-nondirectory' but aware of Tramp files."
2860 (with-parsed-tramp-file-name file nil
2861 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2863 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2864 "Like `file-newer-than-file-p' for Tramp files."
2866 ((not (file-exists-p file1)) nil)
2867 ((not (file-exists-p file2)) t)
2868 (t (time-less-p (nth 5 (file-attributes file2))
2869 (nth 5 (file-attributes file1))))))
2871 (defun tramp-handle-file-regular-p (filename)
2872 "Like `file-regular-p' for Tramp files."
2873 (and (file-exists-p filename)
2874 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2876 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2877 "Like `file-remote-p' for Tramp files."
2878 ;; We do not want traces in the debug buffer.
2879 (let ((tramp-verbose (min tramp-verbose 3)))
2880 (when (tramp-tramp-file-p filename)
2881 (let* ((v (tramp-dissect-file-name filename))
2882 (p (tramp-get-connection-process v))
2883 (c (and p (processp p) (memq (process-status p) '(run open))
2884 (tramp-get-connection-property p "connected" nil))))
2885 ;; We expand the file name only, if there is already a connection.
2886 (with-parsed-tramp-file-name
2887 (if c (expand-file-name filename) filename) nil
2888 (and (or (not connected) c)
2890 ((eq identification 'method) method)
2891 ((eq identification 'user) user)
2892 ((eq identification 'host) host)
2893 ((eq identification 'localname) localname)
2894 ((eq identification 'hop) hop)
2895 (t (tramp-make-tramp-file-name method user host "" hop)))))))))
2897 (defun tramp-handle-file-symlink-p (filename)
2898 "Like `file-symlink-p' for Tramp files."
2899 (with-parsed-tramp-file-name filename nil
2900 (let ((x (car (file-attributes filename))))
2902 (if (file-name-absolute-p x)
2903 (tramp-make-tramp-file-name method user host x)
2906 (defun tramp-handle-find-backup-file-name (filename)
2907 "Like `find-backup-file-name' for Tramp files."
2908 (with-parsed-tramp-file-name filename nil
2909 (let ((backup-directory-alist
2910 (if tramp-backup-directory-alist
2915 (if (and (stringp (cdr x))
2916 (file-name-absolute-p (cdr x))
2917 (not (tramp-file-name-p (cdr x))))
2918 (tramp-make-tramp-file-name method user host (cdr x))
2920 tramp-backup-directory-alist)
2921 backup-directory-alist)))
2922 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2924 (defun tramp-handle-insert-directory
2925 (filename switches &optional wildcard full-directory-p)
2926 "Like `insert-directory' for Tramp files."
2927 (unless switches (setq switches ""))
2928 ;; Mark trailing "/".
2929 (when (and (zerop (length (file-name-nondirectory filename)))
2930 (not full-directory-p))
2931 (setq switches (concat switches "F")))
2932 (with-parsed-tramp-file-name (expand-file-name filename) nil
2933 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
2935 (let (ls-lisp-use-insert-directory-program start)
2936 (tramp-run-real-handler
2938 (list filename switches wildcard full-directory-p))
2939 ;; `ls-lisp' always returns full listings. We must remove
2940 ;; superfluous parts.
2941 (unless (string-match "l" switches)
2943 (goto-char (point-min))
2945 (text-property-not-all
2946 (point) (point-at-eol) 'dired-filename t))
2949 (or (text-property-any start (point-at-eol) 'dired-filename t)
2951 (if (= (point-at-bol) (point-at-eol))
2953 (delete-region (point) (progn (forward-line) (point)))
2954 (forward-line)))))))))
2956 (defun tramp-handle-insert-file-contents
2957 (filename &optional visit beg end replace)
2958 "Like `insert-file-contents' for Tramp files."
2959 (barf-if-buffer-read-only)
2960 (setq filename (expand-file-name filename))
2961 (let (result local-copy remote-copy)
2962 (with-parsed-tramp-file-name filename nil
2964 (if (not (file-exists-p filename))
2966 v 'file-error "File `%s' not found on remote host" filename)
2968 (with-tramp-progress-reporter
2969 v 3 (format-message "Inserting `%s'" filename)
2971 (if (and (tramp-local-host-p v)
2972 (let (file-name-handler-alist)
2973 (file-readable-p localname)))
2974 ;; Short track: if we are on the local host, we can
2977 (tramp-run-real-handler
2978 'insert-file-contents
2979 (list localname visit beg end replace)))
2981 ;; When we shall insert only a part of the file, we
2982 ;; copy this part. This works only for the shell file
2984 (when (and (or beg end)
2985 (tramp-get-method-parameter
2986 v 'tramp-login-program))
2987 (setq remote-copy (tramp-make-tramp-temp-file v))
2988 ;; This is defined in tramp-sh.el. Let's assume
2989 ;; this is loaded already.
2990 (tramp-compat-funcall
2995 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
2996 beg (tramp-shell-quote-argument localname)
2997 (- end beg) remote-copy))
2999 (format "dd bs=1 skip=%d if=%s of=%s"
3000 beg (tramp-shell-quote-argument localname)
3003 (format "dd bs=1 count=%d if=%s of=%s"
3004 end (tramp-shell-quote-argument localname)
3006 (setq tramp-temp-buffer-file-name nil beg nil end nil))
3008 ;; `insert-file-contents-literally' takes care to
3009 ;; avoid calling jka-compr.el and epa.el. By
3010 ;; let-binding `inhibit-file-name-operation', we
3011 ;; propagate that care to the `file-local-copy'
3014 (let ((inhibit-file-name-operation
3015 (when (eq inhibit-file-name-operation
3016 'insert-file-contents)
3019 ((stringp remote-copy)
3021 (tramp-make-tramp-file-name
3022 method user host remote-copy)))
3023 ((stringp tramp-temp-buffer-file-name)
3025 filename tramp-temp-buffer-file-name 'ok)
3026 tramp-temp-buffer-file-name)
3027 (t (file-local-copy filename)))))
3029 ;; When the file is not readable for the owner, it
3030 ;; cannot be inserted, even if it is readable for the
3031 ;; group or for everybody.
3032 (set-file-modes local-copy (string-to-number "0600" 8))
3034 (when (and (null remote-copy)
3035 (tramp-get-method-parameter
3036 v 'tramp-copy-keep-tmpfile))
3037 ;; We keep the local file for performance reasons,
3038 ;; useful for "rsync".
3039 (setq tramp-temp-buffer-file-name local-copy))
3041 ;; We must ensure that `file-coding-system-alist'
3042 ;; matches `local-copy'.
3043 (let ((file-coding-system-alist
3044 (tramp-find-file-name-coding-system-alist
3045 filename local-copy)))
3047 (insert-file-contents
3048 local-copy visit beg end replace))))
3050 (add-hook 'find-file-not-found-functions
3051 `(lambda () (signal ',(car err) ',(cdr err)))
3053 (signal (car err) (cdr err))))))
3058 (setq buffer-file-name filename)
3059 (setq buffer-read-only (not (file-writable-p filename)))
3060 (set-visited-file-modtime)
3061 (set-buffer-modified-p nil))
3062 (when (and (stringp local-copy)
3063 (or remote-copy (null tramp-temp-buffer-file-name)))
3064 (delete-file local-copy))
3065 (when (stringp remote-copy)
3067 (tramp-make-tramp-file-name method user host remote-copy)))))
3070 (list (expand-file-name filename)
3073 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3074 "Like `load' for Tramp files."
3075 (with-parsed-tramp-file-name (expand-file-name file) nil
3077 (cond ((file-exists-p (concat file ".elc"))
3078 (setq file (concat file ".elc")))
3079 ((file-exists-p (concat file ".el"))
3080 (setq file (concat file ".el")))))
3082 ;; The first condition is always true for absolute file names.
3083 ;; Included for safety's sake.
3084 (unless (or (file-name-directory file)
3085 (string-match "\\.elc?\\'" file))
3088 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3090 (when (not (file-exists-p file))
3091 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
3092 (if (not (file-exists-p file))
3094 (let ((tramp-message-show-message (not nomessage)))
3095 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3096 (let ((local-copy (file-local-copy file)))
3098 (load local-copy noerror t nosuffix must-suffix)
3099 (delete-file local-copy)))))
3102 (defun tramp-handle-make-symbolic-link
3103 (filename linkname &optional _ok-if-already-exists)
3104 "Like `make-symbolic-link' for Tramp files."
3105 (with-parsed-tramp-file-name
3106 (if (tramp-tramp-file-p filename) filename linkname) nil
3107 (tramp-error v 'file-error "make-symbolic-link not supported")))
3109 (defun tramp-handle-shell-command
3110 (command &optional output-buffer error-buffer)
3111 "Like `shell-command' for Tramp files."
3112 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3113 ;; We cannot use `shell-file-name' and `shell-command-switch',
3114 ;; they are variables of the local host.
3117 (tramp-get-method-parameter
3118 (tramp-dissect-file-name default-directory)
3119 'tramp-remote-shell)
3120 (tramp-get-method-parameter
3121 (tramp-dissect-file-name default-directory)
3122 'tramp-remote-shell-args))
3123 (list (substring command 0 asynchronous))))
3127 ((bufferp output-buffer) output-buffer)
3128 ((stringp output-buffer) (get-buffer-create output-buffer))
3130 (setq current-buffer-p t)
3132 (t (get-buffer-create
3134 "*Async Shell Command*"
3135 "*Shell Command Output*")))))
3138 ((bufferp error-buffer) error-buffer)
3139 ((stringp error-buffer) (get-buffer-create error-buffer))))
3141 (if (and (not asynchronous) error-buffer)
3142 (with-parsed-tramp-file-name default-directory nil
3143 (list output-buffer (tramp-make-tramp-temp-file v)))
3145 (p (get-buffer-process output-buffer)))
3147 ;; Check whether there is another process running. Tramp does not
3148 ;; support 2 (asynchronous) processes in parallel.
3150 (if (yes-or-no-p "A command is running. Kill it? ")
3151 (ignore-errors (kill-process p))
3152 (tramp-user-error p "Shell command in progress")))
3154 (if current-buffer-p
3156 (barf-if-buffer-read-only)
3158 (with-current-buffer output-buffer
3159 (setq buffer-read-only nil)
3162 (if (and (not current-buffer-p) (integerp asynchronous))
3165 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3167 (with-current-buffer output-buffer
3168 (display-buffer output-buffer '(nil (allow-no-window . t)))
3169 (setq mode-line-process '(":%s"))
3171 (set-process-sentinel p 'shell-command-sentinel)
3172 (set-process-filter p 'comint-output-filter)))
3176 (apply 'process-file (car args) nil buffer nil (cdr args))
3177 ;; Insert error messages if they were separated.
3178 (when (listp buffer)
3179 (with-current-buffer error-buffer
3180 (insert-file-contents (cadr buffer)))
3181 (delete-file (cadr buffer)))
3182 (if current-buffer-p
3183 ;; This is like exchange-point-and-mark, but doesn't
3184 ;; activate the mark. It is cleaner to avoid activation,
3185 ;; even though the command loop would deactivate the mark
3186 ;; because we inserted text.
3187 (goto-char (prog1 (mark t)
3188 (set-marker (mark-marker) (point)
3190 ;; There's some output, display it.
3191 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3192 (display-message-or-buffer output-buffer)))))))
3194 (defun tramp-handle-substitute-in-file-name (filename)
3195 "Like `substitute-in-file-name' for Tramp files.
3196 \"//\" and \"/~\" substitute only in the local filename part."
3197 ;; First, we must replace environment variables.
3198 (setq filename (tramp-replace-environment-variables filename))
3199 (with-parsed-tramp-file-name filename nil
3200 ;; Ignore in LOCALNAME everything before "//" or "/~".
3201 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3203 (concat (file-remote-p filename)
3204 (replace-match "\\1" nil nil localname)))
3205 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3206 (when (string-match "~$" filename)
3207 (setq filename (concat filename "/"))))
3208 ;; We do not want to replace environment variables, again.
3209 (let (process-environment)
3210 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3212 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
3213 "Like `set-visited-file-modtime' for Tramp files."
3214 (unless (buffer-file-name)
3215 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3218 (let ((remote-file-name-inhibit-cache t))
3219 ;; '(-1 65535) means file doesn't exists yet.
3221 (or (nth 5 (file-attributes (buffer-file-name))) '(-1 65535)))))
3222 ;; We use '(0 0) as a don't-know value.
3223 (unless (equal time-list '(0 0))
3224 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))))
3226 (defun tramp-handle-verify-visited-file-modtime (&optional buf)
3227 "Like `verify-visited-file-modtime' for Tramp files.
3228 At the time `verify-visited-file-modtime' calls this function, we
3229 already know that the buffer is visiting a file and that
3230 `visited-file-modtime' does not return 0. Do not call this
3231 function directly, unless those two cases are already taken care
3233 (with-current-buffer (or buf (current-buffer))
3234 (let ((f (buffer-file-name)))
3235 ;; There is no file visiting the buffer, or the buffer has no
3236 ;; recorded last modification time, or there is no established
3239 (eq (visited-file-modtime) 0)
3240 (not (file-remote-p f nil 'connected)))
3242 (with-parsed-tramp-file-name f nil
3243 (let* ((remote-file-name-inhibit-cache t)
3244 (attr (file-attributes f))
3245 (modtime (nth 5 attr))
3246 (mt (visited-file-modtime)))
3249 ;; File exists, and has a known modtime.
3250 ((and attr (not (equal modtime '(0 0))))
3251 (< (abs (tramp-time-diff
3253 ;; For compatibility, deal with both the old
3254 ;; (HIGH . LOW) and the new (HIGH LOW) return
3255 ;; values of `visited-file-modtime'.
3257 (list (car mt) (cdr mt))
3260 ;; Modtime has the don't know value.
3262 ;; If file does not exist, say it is not modified if and
3263 ;; only if that agrees with the buffer's record.
3264 (t (equal mt '(-1 65535))))))))))
3266 (defun tramp-handle-file-notify-add-watch (filename _flags _callback)
3267 "Like `file-notify-add-watch' for Tramp files."
3268 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3270 (setq filename (expand-file-name filename))
3271 (with-parsed-tramp-file-name filename nil
3273 v 'file-notify-error "File notification not supported for `%s'" filename)))
3275 (defun tramp-handle-file-notify-rm-watch (proc)
3276 "Like `file-notify-rm-watch' for Tramp files."
3277 ;; The descriptor must be a process object.
3278 (unless (processp proc)
3279 (tramp-error proc 'file-notify-error "Not a valid descriptor %S" proc))
3280 (tramp-message proc 6 "Kill %S" proc)
3281 (delete-process proc))
3283 (defun tramp-handle-file-notify-valid-p (proc)
3284 "Like `file-notify-valid-p' for Tramp files."
3285 (and proc (processp proc) (memq (process-status proc) '(run open))
3286 ;; Sometimes, the process is still in status `run' when the
3287 ;; file or directory to be watched is deleted already.
3288 (with-current-buffer (process-buffer proc)
3290 (concat (file-remote-p default-directory)
3291 (process-get proc 'watch-name))))))
3293 ;;; Functions for establishing connection:
3295 ;; The following functions are actions to be taken when seeing certain
3296 ;; prompts from the remote host. See the variable
3297 ;; `tramp-actions-before-shell' for usage of these functions.
3299 (defun tramp-action-login (_proc vec)
3300 "Send the login name."
3301 (when (not (stringp tramp-current-user))
3302 (setq tramp-current-user
3303 (with-tramp-connection-property vec "login-as"
3304 (save-window-excursion
3305 (let ((enable-recursive-minibuffers t))
3306 (pop-to-buffer (tramp-get-connection-buffer vec))
3307 (read-string (match-string 0)))))))
3308 (with-current-buffer (tramp-get-connection-buffer vec)
3309 (tramp-message vec 6 "\n%s" (buffer-string)))
3310 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3311 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3313 (defun tramp-action-password (proc vec)
3314 "Query the user for a password."
3315 (with-current-buffer (process-buffer proc)
3316 (let ((enable-recursive-minibuffers t)
3317 (case-fold-search t))
3318 ;; Let's check whether a wrong password has been sent already.
3319 ;; Sometimes, the process returns a new password request
3320 ;; immediately after rejecting the previous (wrong) one.
3321 (unless (tramp-get-connection-property vec "first-password-request" nil)
3322 (tramp-clear-passwd vec))
3323 (goto-char (point-min))
3324 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3325 (tramp-message vec 3 "Sending %s" (match-string 1))
3326 ;; We don't call `tramp-send-string' in order to hide the
3327 ;; password from the debug buffer.
3328 (process-send-string
3329 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3330 ;; Hide password prompt.
3331 (narrow-to-region (point-max) (point-max)))))
3333 (defun tramp-action-succeed (_proc _vec)
3334 "Signal success in finding shell prompt."
3335 (throw 'tramp-action 'ok))
3337 (defun tramp-action-permission-denied (proc _vec)
3338 "Signal permission denied."
3340 (throw 'tramp-action 'permission-denied))
3342 (defun tramp-action-yesno (proc vec)
3343 "Ask the user for confirmation using `yes-or-no-p'.
3344 Send \"yes\" to remote process on confirmation, abort otherwise.
3345 See also `tramp-action-yn'."
3346 (save-window-excursion
3347 (let ((enable-recursive-minibuffers t))
3348 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3349 (unless (yes-or-no-p (match-string 0))
3351 (throw 'tramp-action 'permission-denied))
3352 (with-current-buffer (tramp-get-connection-buffer vec)
3353 (tramp-message vec 6 "\n%s" (buffer-string)))
3354 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3356 (defun tramp-action-yn (proc vec)
3357 "Ask the user for confirmation using `y-or-n-p'.
3358 Send \"y\" to remote process on confirmation, abort otherwise.
3359 See also `tramp-action-yesno'."
3360 (save-window-excursion
3361 (let ((enable-recursive-minibuffers t))
3362 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3363 (unless (y-or-n-p (match-string 0))
3365 (throw 'tramp-action 'permission-denied))
3366 (with-current-buffer (tramp-get-connection-buffer vec)
3367 (tramp-message vec 6 "\n%s" (buffer-string)))
3368 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3370 (defun tramp-action-terminal (_proc vec)
3371 "Tell the remote host which terminal type to use.
3372 The terminal type can be configured with `tramp-terminal-type'."
3373 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3374 (with-current-buffer (tramp-get-connection-buffer vec)
3375 (tramp-message vec 6 "\n%s" (buffer-string)))
3376 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3378 (defun tramp-action-process-alive (proc _vec)
3379 "Check, whether a process has finished."
3380 (unless (memq (process-status proc) '(run open))
3381 (throw 'tramp-action 'process-died)))
3383 (defun tramp-action-out-of-band (proc vec)
3384 "Check, whether an out-of-band copy has finished."
3385 ;; There might be pending output for the exit status.
3386 (tramp-accept-process-output proc 0.1)
3387 (cond ((and (memq (process-status proc) '(stop exit))
3388 (zerop (process-exit-status proc)))
3389 (tramp-message vec 3 "Process has finished.")
3390 (throw 'tramp-action 'ok))
3391 ((or (and (memq (process-status proc) '(stop exit))
3392 (not (zerop (process-exit-status proc))))
3393 (memq (process-status proc) '(signal)))
3394 ;; `scp' could have copied correctly, but set modes could have failed.
3395 ;; This can be ignored.
3396 (with-current-buffer (process-buffer proc)
3397 (goto-char (point-min))
3398 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3400 (tramp-message vec 5 "'set mode' error ignored.")
3401 (tramp-message vec 3 "Process has finished.")
3402 (throw 'tramp-action 'ok))
3403 (tramp-message vec 3 "Process has died.")
3404 (throw 'tramp-action 'process-died))))
3407 ;;; Functions for processing the actions:
3409 (defun tramp-process-one-action (proc vec actions)
3410 "Wait for output from the shell and perform one action."
3411 (let ((case-fold-search t)
3412 found todo item pattern action)
3414 ;; Reread output once all actions have been performed.
3415 ;; Obviously, the output was not complete.
3416 (tramp-accept-process-output proc 1)
3419 (setq item (pop todo))
3420 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3421 (setq action (nth 1 item))
3423 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3424 (when (tramp-check-for-regexp proc pattern)
3425 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3426 (setq found (funcall action proc vec)))))
3429 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3430 "Perform ACTIONS until success or TIMEOUT.
3431 PROC and VEC indicate the remote connection to be used. POS, if
3432 set, is the starting point of the region to be deleted in the
3434 ;; Enable `auth-source'. We must use tramp-current-* variables in
3435 ;; case we have several hops.
3436 (tramp-set-connection-property
3437 (tramp-dissect-file-name
3438 (tramp-make-tramp-file-name
3439 tramp-current-method tramp-current-user tramp-current-host ""))
3440 "first-password-request" t)
3442 (with-tramp-progress-reporter
3443 proc 3 "Waiting for prompts from remote shell"
3446 (with-timeout (timeout (setq exit 'timeout))
3449 (catch 'tramp-action
3450 (tramp-process-one-action proc vec actions)))))
3453 (catch 'tramp-action
3454 (tramp-process-one-action proc vec actions)))))
3455 (with-current-buffer (tramp-get-connection-buffer vec)
3457 (tramp-message vec 6 "\n%s" (buffer-string)))
3458 (unless (eq exit 'ok)
3459 (tramp-clear-passwd vec)
3460 (delete-process proc)
3461 (tramp-error-with-buffer
3462 (tramp-get-connection-buffer vec) vec 'file-error
3464 ((eq exit 'permission-denied) "Permission denied")
3465 ((eq exit 'process-died)
3466 (substitute-command-keys
3468 "Tramp failed to connect. If this happens repeatedly, try\n"
3469 " `\\[tramp-cleanup-this-connection]'")))
3472 "Timeout reached, see buffer `%s' for details"
3473 (tramp-get-connection-buffer vec)))
3474 (t "Login failed")))))
3476 (with-current-buffer (tramp-get-connection-buffer vec)
3477 (let (buffer-read-only) (delete-region pos (point))))))))
3479 :;; Utility functions:
3481 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3482 "Like `accept-process-output' for Tramp processes.
3483 This is needed in order to hide `last-coding-system-used', which is set
3484 for process communication also."
3485 (with-current-buffer (process-buffer proc)
3486 ;; FIXME: If there is a gateway process, we need communication
3487 ;; between several processes. Too complicate to implement, so we
3488 ;; read output from all processes.
3489 (let ((p (if (tramp-get-connection-property proc "gateway" nil) nil proc))
3490 buffer-read-only last-coding-system-used)
3491 ;; Under Windows XP, accept-process-output doesn't return
3492 ;; sometimes. So we add an additional timeout.
3493 (with-timeout ((or timeout 1))
3494 (accept-process-output p timeout timeout-msecs (and proc t)))
3495 (tramp-message proc 10 "%s %s %s\n%s"
3496 proc (process-status proc) p (buffer-string)))))
3498 (defun tramp-check-for-regexp (proc regexp)
3499 "Check, whether REGEXP is contained in process buffer of PROC.
3500 Erase echoed commands if exists."
3501 (with-current-buffer (process-buffer proc)
3502 (goto-char (point-min))
3504 ;; Check whether we need to remove echo output.
3505 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3506 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3507 (let ((begin (match-beginning 0)))
3508 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3509 ;; Discard echo from remote output.
3510 (tramp-set-connection-property proc "check-remote-echo" nil)
3511 (tramp-message proc 5 "echo-mark found")
3513 (delete-region begin (point))
3514 (goto-char (point-min)))))
3516 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3517 ;; Sometimes, the echo string is suppressed on the remote side.
3519 (substring-no-properties
3520 tramp-echo-mark-marker
3521 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3522 (buffer-substring-no-properties
3524 (min (+ (point-min) tramp-echo-mark-marker-length)
3526 ;; No echo to be handled, now we can look for the regexp.
3527 ;; Sometimes, lines are much to long, and we run into a "Stack
3528 ;; overflow in regexp matcher". For example, //DIRED// lines of
3529 ;; directory listings with some thousand files. Therefore, we
3530 ;; look from the end.
3531 (goto-char (point-max))
3532 (ignore-errors (re-search-backward regexp nil t)))))
3534 (defun tramp-wait-for-regexp (proc timeout regexp)
3535 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3536 Expects the output of PROC to be sent to the current buffer. Returns
3537 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3539 (with-current-buffer (process-buffer proc)
3540 (let ((found (tramp-check-for-regexp proc regexp)))
3542 (with-timeout (timeout)
3544 (tramp-accept-process-output proc 1)
3545 (unless (memq (process-status proc) '(run open))
3546 (tramp-error-with-buffer
3547 nil proc 'file-error "Process has died"))
3548 (setq found (tramp-check-for-regexp proc regexp)))))
3551 (tramp-accept-process-output proc 1)
3552 (unless (memq (process-status proc) '(run open))
3553 (tramp-error-with-buffer
3554 nil proc 'file-error "Process has died"))
3555 (setq found (tramp-check-for-regexp proc regexp)))))
3556 (tramp-message proc 6 "\n%s" (buffer-string))
3560 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3562 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3565 ;; It seems that Tru64 Unix does not like it if long strings are sent
3566 ;; to it in one go. (This happens when sending the Perl
3567 ;; `file-attributes' implementation, for instance.) Therefore, we
3568 ;; have this function which sends the string in chunks.
3569 (defun tramp-send-string (vec string)
3570 "Send the STRING via connection VEC.
3572 The STRING is expected to use Unix line-endings, but the lines sent to
3573 the remote host use line-endings as defined in the variable
3574 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3575 (let* ((p (tramp-get-connection-process vec))
3576 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3579 vec 'file-error "Can't send string to remote host -- not logged in"))
3580 (tramp-set-connection-property p "last-cmd-time" (current-time))
3581 (tramp-message vec 10 "%s" string)
3582 (with-current-buffer (tramp-get-connection-buffer vec)
3583 ;; Clean up the buffer. We cannot call `erase-buffer' because
3584 ;; narrowing might be in effect.
3585 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3586 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3589 'identity (split-string string "\n") tramp-rsh-end-of-line))
3590 (unless (or (string= string "")
3591 (string-equal (substring string -1) tramp-rsh-end-of-line))
3592 (setq string (concat string tramp-rsh-end-of-line)))
3594 (if (and chunksize (not (zerop chunksize)))
3596 (end (length string)))
3599 vec 10 "Sending chunk from %s to %s"
3600 pos (min (+ pos chunksize) end))
3601 (process-send-string
3602 p (substring string pos (min (+ pos chunksize) end)))
3603 (setq pos (+ pos chunksize))))
3604 (process-send-string p string)))))
3606 (defun tramp-get-inode (vec)
3607 "Returns the virtual inode number.
3608 If it doesn't exist, generate a new one."
3609 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3610 (setq tramp-inodes (1+ tramp-inodes))))
3612 (defun tramp-get-device (vec)
3613 "Returns the virtual device number.
3614 If it doesn't exist, generate a new one."
3615 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3616 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3618 (defun tramp-equal-remote (file1 file2)
3619 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3620 The check depends on method, user and host name of the files. If
3621 one of the components is missing, the default values are used.
3622 The local file name parts of FILE1 and FILE2 are not taken into
3627 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3629 would yield t. On the other hand, the following check results in nil:
3631 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3632 (and (tramp-tramp-file-p file1)
3633 (tramp-tramp-file-p file2)
3634 (string-equal (file-remote-p file1) (file-remote-p file2))))
3636 ;;;###tramp-autoload
3637 (defun tramp-mode-string-to-int (mode-string)
3638 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3639 (let* (case-fold-search
3640 (mode-chars (string-to-vector mode-string))
3641 (owner-read (aref mode-chars 1))
3642 (owner-write (aref mode-chars 2))
3643 (owner-execute-or-setid (aref mode-chars 3))
3644 (group-read (aref mode-chars 4))
3645 (group-write (aref mode-chars 5))
3646 (group-execute-or-setid (aref mode-chars 6))
3647 (other-read (aref mode-chars 7))
3648 (other-write (aref mode-chars 8))
3649 (other-execute-or-sticky (aref mode-chars 9)))
3653 ((char-equal owner-read ?r) (string-to-number "00400" 8))
3654 ((char-equal owner-read ?-) 0)
3655 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3657 ((char-equal owner-write ?w) (string-to-number "00200" 8))
3658 ((char-equal owner-write ?-) 0)
3659 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3661 ((char-equal owner-execute-or-setid ?x) (string-to-number "00100" 8))
3662 ((char-equal owner-execute-or-setid ?S) (string-to-number "04000" 8))
3663 ((char-equal owner-execute-or-setid ?s) (string-to-number "04100" 8))
3664 ((char-equal owner-execute-or-setid ?-) 0)
3665 (t (error "Fourth char `%c' must be one of `xsS-'"
3666 owner-execute-or-setid)))
3668 ((char-equal group-read ?r) (string-to-number "00040" 8))
3669 ((char-equal group-read ?-) 0)
3670 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3672 ((char-equal group-write ?w) (string-to-number "00020" 8))
3673 ((char-equal group-write ?-) 0)
3674 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3676 ((char-equal group-execute-or-setid ?x) (string-to-number "00010" 8))
3677 ((char-equal group-execute-or-setid ?S) (string-to-number "02000" 8))
3678 ((char-equal group-execute-or-setid ?s) (string-to-number "02010" 8))
3679 ((char-equal group-execute-or-setid ?-) 0)
3680 (t (error "Seventh char `%c' must be one of `xsS-'"
3681 group-execute-or-setid)))
3683 ((char-equal other-read ?r) (string-to-number "00004" 8))
3684 ((char-equal other-read ?-) 0)
3685 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3687 ((char-equal other-write ?w) (string-to-number "00002" 8))
3688 ((char-equal other-write ?-) 0)
3689 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3691 ((char-equal other-execute-or-sticky ?x) (string-to-number "00001" 8))
3692 ((char-equal other-execute-or-sticky ?T) (string-to-number "01000" 8))
3693 ((char-equal other-execute-or-sticky ?t) (string-to-number "01001" 8))
3694 ((char-equal other-execute-or-sticky ?-) 0)
3695 (t (error "Tenth char `%c' must be one of `xtT-'"
3696 other-execute-or-sticky)))))))
3698 (defconst tramp-file-mode-type-map
3699 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
3701 (2 . "c") ; character device
3702 (3 . "m") ; multiplexed character device (v7)
3703 (4 . "d") ; directory
3704 (5 . "?") ; Named special file (XENIX)
3705 (6 . "b") ; block device
3706 (7 . "?") ; multiplexed block device (v7)
3707 (8 . "-") ; regular file
3708 (9 . "n") ; network special file (HP-UX)
3709 (10 . "l") ; symlink
3710 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
3712 (13 . "D") ; door special (Solaris)
3713 (14 . "w")) ; whiteout (BSD)
3714 "A list of file types returned from the `stat' system call.
3715 This is used to map a mode number to a permission string.")
3717 ;;;###tramp-autoload
3718 (defun tramp-file-mode-from-int (mode)
3719 "Turn an integer representing a file mode into an ls(1)-like string."
3721 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
3722 (user (logand (lsh mode -6) 7))
3723 (group (logand (lsh mode -3) 7))
3724 (other (logand (lsh mode -0) 7))
3725 (suid (> (logand (lsh mode -9) 4) 0))
3726 (sgid (> (logand (lsh mode -9) 2) 0))
3727 (sticky (> (logand (lsh mode -9) 1) 0)))
3728 (setq user (tramp-file-mode-permissions user suid "s"))
3729 (setq group (tramp-file-mode-permissions group sgid "s"))
3730 (setq other (tramp-file-mode-permissions other sticky "t"))
3731 (concat type user group other)))
3733 (defun tramp-file-mode-permissions (perm suid suid-text)
3734 "Convert a permission bitset into a string.
3735 This is used internally by `tramp-file-mode-from-int'."
3736 (let ((r (> (logand perm 4) 0))
3737 (w (> (logand perm 2) 0))
3738 (x (> (logand perm 1) 0)))
3739 (concat (or (and r "r") "-")
3740 (or (and w "w") "-")
3741 (or (and suid x suid-text) ; suid, execute
3742 (and suid (upcase suid-text)) ; suid, !execute
3743 (and x "x") "-")))) ; !suid
3745 ;;;###tramp-autoload
3746 (defun tramp-get-local-uid (id-format)
3747 (if (equal id-format 'integer) (user-uid) (user-login-name)))
3749 ;;;###tramp-autoload
3750 (defun tramp-get-local-gid (id-format)
3751 ;; `group-gid' has been introduced with Emacs 24.4.
3752 (if (and (fboundp 'group-gid) (equal id-format 'integer))
3753 (tramp-compat-funcall 'group-gid)
3754 (nth 3 (file-attributes "~/" id-format))))
3756 (defun tramp-get-local-locale (&optional vec)
3757 ;; We use key nil for local connection properties.
3758 (with-tramp-connection-property nil "locale"
3759 (let ((candidates '("en_US.utf8" "C.utf8" "en_US.UTF-8"))
3762 (unless (or (memq system-type '(windows-nt))
3763 (not (zerop (tramp-call-process
3764 nil "locale" nil t nil "-a"))))
3766 (goto-char (point-min))
3767 (if (string-match (format "^%s\r?$" (regexp-quote (car candidates)))
3769 (setq locale (car candidates)
3771 (setq candidates (cdr candidates))))))
3773 (when vec (tramp-message vec 7 "locale %s" (or locale "C")))
3776 ;;;###tramp-autoload
3777 (defun tramp-check-cached-permissions (vec access)
3778 "Check `file-attributes' caches for VEC.
3779 Return t if according to the cache access type ACCESS is known to
3785 ((eq ?x access) 3))))
3786 (dolist (suffix '("string" "integer") result)
3793 (tramp-get-file-property
3794 vec (tramp-file-name-localname vec)
3795 (concat "file-attributes-" suffix) nil)
3797 (tramp-make-tramp-file-name
3798 (tramp-file-name-method vec)
3799 (tramp-file-name-user vec)
3800 (tramp-file-name-host vec)
3801 (tramp-file-name-localname vec)
3802 (tramp-file-name-hop vec))
3805 (tramp-get-connection-property
3806 vec (concat "uid-" suffix) nil))
3808 (tramp-get-connection-property
3809 vec (concat "gid-" suffix) nil)))
3814 (eq t (car file-attr))
3815 (null (car file-attr)))
3817 ;; World accessible.
3818 (eq access (aref (nth 8 file-attr) (+ offset 6)))
3819 ;; User accessible and owned by user.
3821 (eq access (aref (nth 8 file-attr) offset))
3822 (equal remote-uid (nth 2 file-attr)))
3823 ;; Group accessible and owned by user's
3826 (eq access (aref (nth 8 file-attr) (+ offset 3)))
3827 (equal remote-gid (nth 3 file-attr)))))))))))
3829 ;;;###tramp-autoload
3830 (defun tramp-local-host-p (vec)
3831 "Return t if this points to the local host, nil otherwise."
3832 ;; We cannot use `tramp-file-name-real-host'. A port is an
3833 ;; indication for an ssh tunnel or alike.
3834 (let ((host (tramp-file-name-host vec)))
3837 (string-match tramp-local-host-regexp host)
3838 ;; The method shall be applied to one of the shell file name
3839 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3840 ;; alike, where it must fail.
3841 (tramp-get-method-parameter vec 'tramp-login-program)
3842 ;; The local temp directory must be writable for the other user.
3844 (tramp-make-tramp-file-name
3845 (tramp-file-name-method vec)
3846 (tramp-file-name-user vec)
3848 (tramp-compat-temporary-file-directory)))
3849 ;; On some systems, chown runs only for root.
3850 (or (zerop (user-uid))
3851 ;; This is defined in tramp-sh.el. Let's assume this is
3853 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3855 (defun tramp-get-remote-tmpdir (vec)
3856 "Return directory for temporary files on the remote host identified by VEC."
3857 (when (file-remote-p (tramp-get-connection-property vec "tmpdir" ""))
3858 ;; Compatibility code: Cached value shall be the local path only.
3859 (tramp-set-connection-property vec "tmpdir" 'undef))
3860 (let ((dir (tramp-make-tramp-file-name
3861 (tramp-file-name-method vec)
3862 (tramp-file-name-user vec)
3863 (tramp-file-name-host vec)
3864 (or (tramp-get-method-parameter vec 'tramp-tmpdir) "/tmp"))))
3865 (with-tramp-connection-property vec "tmpdir"
3866 (or (and (file-directory-p dir) (file-writable-p dir)
3867 (file-remote-p dir 'localname))
3868 (tramp-error vec 'file-error "Directory %s not accessible" dir)))
3871 ;;;###tramp-autoload
3872 (defun tramp-make-tramp-temp-file (vec)
3873 "Create a temporary file on the remote host identified by VEC.
3874 Return the local name of the temporary file."
3875 (let ((prefix (expand-file-name
3876 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3879 ;; `make-temp-file' would be the natural choice for
3880 ;; implementation. But it calls `write-region' internally,
3881 ;; which also needs a temporary file - we would end in an
3883 (setq result (make-temp-name prefix))
3884 (if (file-exists-p result)
3886 ;; This creates the file by side effect.
3887 (set-file-times result)
3888 (set-file-modes result (string-to-number "0700" 8))))
3890 ;; Return the local part.
3891 (with-parsed-tramp-file-name result nil localname)))
3893 (defun tramp-delete-temp-file-function ()
3894 "Remove temporary files related to current buffer."
3895 (when (stringp tramp-temp-buffer-file-name)
3896 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3898 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3899 (add-hook 'tramp-unload-hook
3901 (remove-hook 'kill-buffer-hook
3902 'tramp-delete-temp-file-function)))
3904 (defun tramp-handle-make-auto-save-file-name ()
3905 "Like `make-auto-save-file-name' for Tramp files.
3906 Returns a file name in `tramp-auto-save-directory' for autosaving
3907 this file, if that variable is non-nil."
3908 (when (stringp tramp-auto-save-directory)
3909 (setq tramp-auto-save-directory
3910 (expand-file-name tramp-auto-save-directory)))
3911 ;; Create directory.
3912 (unless (or (null tramp-auto-save-directory)
3913 (file-exists-p tramp-auto-save-directory))
3914 (make-directory tramp-auto-save-directory t))
3916 (let ((system-type 'not-windows)
3917 (auto-save-file-name-transforms
3918 (if (null tramp-auto-save-directory)
3919 auto-save-file-name-transforms))
3921 (if (null tramp-auto-save-directory)
3924 (tramp-subst-strs-in-string
3932 tramp-auto-save-directory))))
3933 ;; Run plain `make-auto-save-file-name'.
3934 (tramp-run-real-handler 'make-auto-save-file-name nil)))
3936 (defun tramp-subst-strs-in-string (alist string)
3937 "Replace all occurrences of the string FROM with TO in STRING.
3938 ALIST is of the form ((FROM . TO) ...)."
3941 (let* ((pr (car alist))
3944 (while (string-match (regexp-quote from) string)
3945 (setq string (replace-match to t t string)))
3946 (setq alist (cdr alist))))
3949 ;;; Compatibility functions section:
3951 (defun tramp-call-process
3952 (vec program &optional infile destination display &rest args)
3953 "Calls `call-process' on the local host.
3954 It always returns a return code. The Lisp error raised when
3955 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
3956 are written with verbosity of 6."
3958 (vector tramp-current-method tramp-current-user
3959 tramp-current-host nil nil)))
3960 (destination (if (eq destination t) (current-buffer) destination))
3964 program (mapconcat 'identity args " ") infile destination)
3969 'call-process program infile (or destination t) display args))
3970 ;; `result' could also be an error string.
3971 (when (stringp result)
3972 (signal 'file-error (list result)))
3973 (with-current-buffer
3974 (if (bufferp destination) destination (current-buffer))
3975 (tramp-message v 6 "%d\n%s" result (buffer-string))))
3978 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
3981 (defun tramp-call-process-region
3982 (vec start end program &optional delete buffer display &rest args)
3983 "Calls `call-process-region' on the local host.
3984 It always returns a return code. The Lisp error raised when
3985 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
3986 are written with verbosity of 6."
3988 (vector tramp-current-method tramp-current-user
3989 tramp-current-host nil nil)))
3990 (buffer (if (eq buffer t) (current-buffer) buffer))
3993 v 6 "`%s %s' %s %s %s %s"
3994 program (mapconcat 'identity args " ") start end delete buffer)
3999 'call-process-region
4000 start end program delete buffer display args))
4001 ;; `result' could also be an error string.
4002 (when (stringp result)
4003 (signal 'file-error (list result)))
4004 (with-current-buffer (if (bufferp buffer) buffer (current-buffer))
4006 (tramp-message v 6 "%d" result)
4007 (tramp-message v 6 "%d\n%s" result (buffer-string)))))
4010 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
4013 ;;;###tramp-autoload
4014 (defun tramp-read-passwd (proc &optional prompt)
4015 "Read a password from user (compat function).
4016 Consults the auth-source package.
4017 Invokes `password-read' if available, `read-passwd' else."
4018 (let* ((case-fold-search t)
4019 (key (tramp-make-tramp-file-name
4020 tramp-current-method tramp-current-user
4021 tramp-current-host ""))
4024 (with-current-buffer (process-buffer proc)
4025 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
4026 (format "%s for %s " (capitalize (match-string 1)) key))))
4027 ;; We suspend the timers while reading the password.
4028 (stimers (with-timeout-suspend))
4029 auth-info auth-passwd)
4032 (with-parsed-tramp-file-name key nil
4035 ;; See if auth-sources contains something useful.
4036 ;; `auth-source-user-or-password' is an obsoleted
4037 ;; function since Emacs 24.1, it has been replaced by
4038 ;; `auth-source-search'.
4040 (and (tramp-get-connection-property
4041 v "first-password-request" nil)
4042 ;; Try with Tramp's current method.
4043 (if (fboundp 'auth-source-search)
4047 :user (or tramp-current-user t)
4048 :host tramp-current-host
4049 :port tramp-current-method)
4050 auth-passwd (plist-get
4051 (nth 0 auth-info) :secret)
4052 auth-passwd (if (functionp auth-passwd)
4053 (funcall auth-passwd)
4055 (tramp-compat-funcall 'auth-source-user-or-password
4056 "password" tramp-current-host tramp-current-method))))
4057 ;; Try the password cache.
4058 (let ((password (password-read pw-prompt key)))
4059 (password-cache-add key password)
4061 ;; Else, get the password interactively.
4062 (read-passwd pw-prompt))
4063 (tramp-set-connection-property v "first-password-request" nil)))
4064 ;; Reenable the timers.
4065 (with-timeout-unsuspend stimers))))
4067 ;;;###tramp-autoload
4068 (defun tramp-clear-passwd (vec)
4069 "Clear password cache for connection related to VEC."
4070 (let ((hop (tramp-file-name-hop vec)))
4072 ;; Clear also the passwords of the hops.
4074 (tramp-dissect-file-name
4077 (replace-regexp-in-string
4078 (concat tramp-postfix-hop-regexp "$")
4079 tramp-postfix-host-format hop))))))
4080 (password-cache-remove
4081 (tramp-make-tramp-file-name
4082 (tramp-file-name-method vec)
4083 (tramp-file-name-user vec)
4084 (tramp-file-name-host vec)
4087 ;; Snarfed code from time-date.el and parse-time.el
4089 (defconst tramp-half-a-year '(241 17024)
4090 "Evaluated by \"(days-to-time 183)\".")
4092 (defconst tramp-parse-time-months
4093 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
4094 ("apr" . 4) ("may" . 5) ("jun" . 6)
4095 ("jul" . 7) ("aug" . 8) ("sep" . 9)
4096 ("oct" . 10) ("nov" . 11) ("dec" . 12))
4097 "Alist mapping month names to integers.")
4099 ;;;###tramp-autoload
4100 (defun tramp-time-diff (t1 t2)
4101 "Return the difference between the two times, in seconds.
4102 T1 and T2 are time values (as returned by `current-time' for example)."
4103 (float-time (subtract-time t1 t2)))
4105 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4106 ;; does not deal well with newline characters. Newline is replaced by
4107 ;; backslash newline. But if, say, the string `a backslash newline b'
4108 ;; is passed to a shell, the shell will expand this into "ab",
4109 ;; completely omitting the newline. This is not what was intended.
4110 ;; It does not appear to be possible to make the function
4111 ;; `shell-quote-argument' work with newlines without making it
4112 ;; dependent on the shell used. But within this package, we know that
4113 ;; we will always use a Bourne-like shell, so we use an approach which
4116 ;; The approach is simple: we call `shell-quote-argument', then
4117 ;; massage the newline part of the result.
4119 ;; This function should produce a string which is grokked by a Unix
4120 ;; shell, even if the Emacs is running on Windows. Since this is the
4121 ;; kludges section, we bind `system-type' in such a way that
4122 ;; `shell-quote-argument' behaves as if on Unix.
4124 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4125 ;; function to work with Bourne-like shells.
4127 ;; CCC: This function should be rewritten so that
4128 ;; `shell-quote-argument' is not used. This way, we are safe from
4129 ;; changes in `shell-quote-argument'.
4130 ;;;###tramp-autoload
4131 (defun tramp-shell-quote-argument (s)
4132 "Similar to `shell-quote-argument', but groks newlines.
4133 Only works for Bourne-like shells."
4134 (let ((system-type 'not-windows))
4136 (let ((result (shell-quote-argument s))
4137 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
4138 (when (and (>= (length result) 2)
4139 (string= (substring result 0 2) "\\~"))
4140 (setq result (substring result 1)))
4141 (while (string-match nl result)
4142 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
4146 ;;; Integration of eshell.el:
4148 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4149 ;; when `default-directory' points to another host.
4150 (defun tramp-eshell-directory-change ()
4151 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4152 (setq eshell-path-env
4153 (if (tramp-tramp-file-p default-directory)
4154 (with-parsed-tramp-file-name default-directory nil
4158 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4159 ;; the remote path is only set in the session cache.
4160 (tramp-get-connection-property
4161 (tramp-get-connection-process v) "remote-path" nil)
4162 (tramp-get-connection-property v "remote-path" nil))
4166 (eval-after-load "esh-util"
4168 (tramp-eshell-directory-change)
4169 (add-hook 'eshell-directory-change-hook
4170 'tramp-eshell-directory-change)
4171 (add-hook 'tramp-unload-hook
4173 (remove-hook 'eshell-directory-change-hook
4174 'tramp-eshell-directory-change)))))
4176 ;; Checklist for `tramp-unload-hook'
4177 ;; - Unload all `tramp-*' packages
4178 ;; - Reset `file-name-handler-alist'
4179 ;; - Cleanup hooks where Tramp functions are in
4180 ;; - Cleanup advised functions
4181 ;; - Cleanup autoloads
4183 (defun tramp-unload-tramp ()
4184 "Discard Tramp from loading remote files."
4186 ;; ange-ftp settings must be enabled.
4187 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
4188 ;; Maybe it's not loaded yet.
4189 (ignore-errors (unload-feature 'tramp 'force)))
4195 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4196 ;; by the files in that directory. Add this here.
4197 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4198 ;; * Better error checking. At least whenever we see something
4199 ;; strange when doing zerop, we should kill the process and start
4200 ;; again. (Greg Stark)
4201 ;; * Username and hostname completion.
4202 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
4203 ;; * Make `tramp-default-user' obsolete.
4204 ;; * Implement a general server-local-variable mechanism, as there are
4205 ;; probably other variables that need different values for different
4206 ;; servers too. The user could then configure a variable (such as
4207 ;; tramp-server-local-variable-alist) to define any such variables
4208 ;; that they need to, which would then be let bound as appropriate
4209 ;; in tramp functions. (Jason Rumney)
4210 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4211 ;; * I was wondering if it would be possible to use tramp even if I'm
4212 ;; actually using sshfs. But when I launch a command I would like
4213 ;; to get it executed on the remote machine where the files really
4214 ;; are. (Andrea Crotti)
4215 ;; * Run emerge on two remote files. Bug is described here:
4216 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4218 ;; * Use also port to distinguish connections. This is needed for
4219 ;; different hosts sitting behind a single router (distinguished by
4220 ;; different port numbers). (Tzvi Edelman)
4222 ;;; tramp.el ends here