1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2013 Free Software Foundation, Inc.
5 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
6 ;; Michael Albinus <michael.albinus@gmx.de>
7 ;; Keywords: comm, processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This package provides remote file editing, similar to ange-ftp.
28 ;; The difference is that ange-ftp uses FTP to transfer files between
29 ;; the local and the remote host, whereas tramp.el uses a combination
30 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
32 ;; For more detailed instructions, please see the info file.
37 ;; This package only works for Emacs 22.1 and higher, and for XEmacs 21.4
38 ;; and higher. For XEmacs 21, you need the package `fsf-compat' for
39 ;; the `with-timeout' macro.
41 ;; Also see the todo list at the bottom of this file.
43 ;; The current version of Tramp can be retrieved from the following URL:
44 ;; http://ftp.gnu.org/gnu/tramp/
46 ;; There's a mailing list for this, as well. Its name is:
47 ;; tramp-devel@gnu.org
48 ;; You can use the Web to subscribe, under the following URL:
49 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
51 ;; For the adventurous, the current development sources are available
52 ;; via CVS. You can find instructions about this at the following URL:
53 ;; http://savannah.gnu.org/projects/tramp/
54 ;; Click on "CVS" in the navigation bar near the top.
56 ;; Don't forget to put on your asbestos longjohns, first!
60 (eval-when-compile (require 'cl)) ; ignore-errors
61 (require 'tramp-compat)
63 ;;; User Customizable Internal Variables:
66 "Edit remote files with a combination of ssh, scp, etc."
71 ;; Maybe we need once a real Tramp mode, with key bindings etc.
73 (defcustom tramp-mode t
74 "Whether Tramp is enabled.
75 If it is set to nil, all remote file names are used literally."
79 (defcustom tramp-verbose 3
80 "Verbosity level for Tramp messages.
81 Any level x includes messages for all levels 1 .. x-1. The levels are
83 0 silent (no tramp messages at all)
86 3 connection to remote hosts (default level)
89 6 sent and received strings
91 8 connection properties
99 (when (boundp 'backup-directory-alist)
100 (defcustom tramp-backup-directory-alist nil
101 "Alist of filename patterns and backup directory names.
102 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
103 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
104 is a local file name, the backup directory is prepended with Tramp file
105 name prefix \(method, user, host\) of file.
107 \(setq tramp-backup-directory-alist backup-directory-alist\)
109 gives the same backup policy for Tramp files on their hosts like the
110 policy for local files."
112 :type '(repeat (cons (regexp :tag "Regexp matching filename")
113 (directory :tag "Backup directory name"))))))
115 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
116 ;; the package "backup-dir" might not be loaded yet.
118 (when (featurep 'xemacs)
119 (defcustom tramp-bkup-backup-directory-info nil
120 "Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
121 It has the same meaning like `bkup-backup-directory-info' from package
122 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
123 file name, the backup directory is prepended with Tramp file name prefix
124 \(method, user, host\) of file.
126 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
128 gives the same backup policy for Tramp files on their hosts like the
129 policy for local files."
131 (list (regexp :tag "File regexp")
132 (string :tag "Backup Dir")
137 (const search-upward))))
140 (defcustom tramp-auto-save-directory nil
141 "Put auto-save files in this directory, if set.
142 The idea is to use a local directory so that auto-saving is faster."
144 :type '(choice (const nil) string))
146 (defcustom tramp-encoding-shell
147 (if (memq system-type '(windows-nt))
150 "Use this program for encoding and decoding commands on the local host.
151 This shell is used to execute the encoding and decoding command on the
152 local host, so if you want to use `~' in those commands, you should
153 choose a shell here which groks tilde expansion. `/bin/sh' normally
154 does not understand tilde expansion.
156 For encoding and decoding, commands like the following are executed:
158 /bin/sh -c COMMAND < INPUT > OUTPUT
160 This variable can be used to change the \"/bin/sh\" part. See the
161 variable `tramp-encoding-command-switch' for the \"-c\" part.
163 If the shell must be forced to be interactive, see
164 `tramp-encoding-command-interactive'.
166 Note that this variable is not used for remote commands. There are
167 mechanisms in tramp.el which automatically determine the right shell to
168 use for the remote host."
170 :type '(file :must-match t))
172 (defcustom tramp-encoding-command-switch
173 (if (string-match "cmd\\.exe" tramp-encoding-shell)
176 "Use this switch together with `tramp-encoding-shell' for local commands.
177 See the variable `tramp-encoding-shell' for more information."
181 (defcustom tramp-encoding-command-interactive
182 (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i")
183 "Use this switch together with `tramp-encoding-shell' for interactive shells.
184 See the variable `tramp-encoding-shell' for more information."
187 :type '(choice (const nil) string))
190 (defvar tramp-methods nil
191 "Alist of methods for remote files.
192 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
193 Each NAME stands for a remote access method. Each PARAM is a
194 pair of the form (KEY VALUE). The following KEYs are defined:
195 * `tramp-remote-shell'
196 This specifies the shell to use on the remote host. This
197 MUST be a Bourne-like shell. It is normally not necessary to
198 set this to any value other than \"/bin/sh\": Tramp wants to
199 use a shell which groks tilde expansion, but it can search
200 for it. Also note that \"/bin/sh\" exists on all Unixen,
201 this might not be true for the value that you decide to use.
202 You Have Been Warned.
203 * `tramp-remote-shell-args'
204 For implementation of `shell-command', this specifies the
205 arguments to let `tramp-remote-shell' run a single command.
206 * `tramp-login-program'
207 This specifies the name of the program to use for logging in to the
208 remote host. This may be the name of rsh or a workalike program,
209 or the name of telnet or a workalike, or the name of su or a workalike.
211 This specifies the list of arguments to pass to the above
212 mentioned program. Please note that this is a list of list of arguments,
213 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
214 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
215 There are some patterns: \"%h\" in this list is replaced by the host
216 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
217 port number, and \"%%\" can be used to obtain a literal percent character.
218 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
219 expansion (i.e. no host or no user specified), this list is not used as
220 argument. By this, arguments like (\"-l\" \"%u\") are optional.
221 \"%t\" is replaced by the temporary file name produced with
222 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
223 parameter of a program, if exists.
225 When an asynchronous process is started, we know already that
226 the connection works. Therefore, we can pass additional
227 parameters to suppress diagnostic messages, in order not to
228 tamper the process output.
229 * `tramp-copy-program'
230 This specifies the name of the program to use for remotely copying
231 the file; this might be the absolute filename of rcp or the name of
234 This specifies the list of parameters to pass to the above mentioned
235 program, the hints for `tramp-login-args' also apply here.
236 * `tramp-copy-keep-date'
237 This specifies whether the copying program when the preserves the
238 timestamp of the original file.
239 * `tramp-copy-keep-tmpfile'
240 This specifies whether a temporary local file shall be kept
241 for optimization reasons (useful for \"rsync\" methods).
242 * `tramp-copy-recursive'
243 Whether the operation copies directories recursively.
244 * `tramp-default-port'
245 The default port of a method is needed in case of gateway connections.
246 Additionally, it is used as indication which method is prepared for
249 As the attribute name says, additional arguments are specified here
250 when a method is applied via a gateway.
252 A directory on the remote host for temporary files. If not
253 specified, \"/tmp\" is taken as default.
255 What does all this mean? Well, you should specify `tramp-login-program'
256 for all methods; this program is used to log in to the remote site. Then,
257 there are two ways to actually transfer the files between the local and the
258 remote side. One way is using an additional rcp-like program. If you want
259 to do this, set `tramp-copy-program' in the method.
261 Another possibility for file transfer is inline transfer, i.e. the
262 file is passed through the same buffer used by `tramp-login-program'. In
263 this case, the file contents need to be protected since the
264 `tramp-login-program' might use escape codes or the connection might not
265 be eight-bit clean. Therefore, file contents are encoded for transit.
266 See the variables `tramp-local-coding-commands' and
267 `tramp-remote-coding-commands' for details.
269 So, to summarize: if the method is an out-of-band method, then you
270 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
271 inline method, then these two parameters should be nil. Methods which
272 are fit for gateways must have `tramp-default-port' at least.
276 When using `su' or `sudo' the phrase `open connection to a remote
277 host' sounds strange, but it is used nevertheless, for consistency.
278 No connection is opened to a remote host, but `su' or `sudo' is
279 started on the local host. You should specify a remote host
280 `localhost' or the name of the local host. Another host name is
281 useful only in combination with `tramp-default-proxies-alist'.")
284 (defvar tramp-ssh-controlmaster-template
287 (call-process "ssh" nil t nil "-o" "ControlMaster")
288 (goto-char (point-min))
289 (when (search-forward-regexp "Missing ControlMaster argument" nil t)
290 '("-o" "ControlPath=%t.%%r@%%h:%%p"
291 "-o" "ControlMaster=auto"
292 "-o" "ControlPersist=no"))))
293 "Call ssh to detect whether it supports the ControlMaster argument.
294 Return a template to be used in `tramp-methods'.")
296 (defcustom tramp-default-method
297 ;; An external copy method seems to be preferred, because it performs
298 ;; much better for large files, and it hasn't too serious delays
299 ;; for small files. But it must be ensured that there aren't
300 ;; permanent password queries. Either a password agent like
301 ;; "ssh-agent" or "Pageant" shall run, or the optional
302 ;; password-cache.el or auth-sources.el packages shall be active for
303 ;; password caching. If we detect that the user is running OpenSSH
304 ;; 4.0 or newer, we could reuse the connection, which calls also for
305 ;; an external method.
307 ;; PuTTY is installed. We don't take it, if it is installed on a
308 ;; non-windows system, or pscp from the pssh (parallel ssh) package
310 ((and (eq system-type 'windows-nt)
311 (executable-find "pscp"))
312 (if (or (fboundp 'password-read)
313 (fboundp 'auth-source-user-or-password)
314 (fboundp 'auth-source-search)
315 ;; Pageant is running.
316 (tramp-compat-process-running-p "Pageant"))
319 ;; There is an ssh installation.
320 ((executable-find "scp")
321 (if (or (fboundp 'password-read)
322 (fboundp 'auth-source-user-or-password)
323 (fboundp 'auth-source-search)
324 ;; ssh-agent is running.
325 (getenv "SSH_AUTH_SOCK")
326 (getenv "SSH_AGENT_PID")
327 ;; We could reuse the connection.
328 tramp-ssh-controlmaster-template)
333 "Default method to use for transferring files.
334 See `tramp-methods' for possibilities.
335 Also see `tramp-default-method-alist'."
340 (defcustom tramp-default-method-alist nil
341 "Default method to use for specific host/user pairs.
342 This is an alist of items (HOST USER METHOD). The first matching item
343 specifies the method to use for a file name which does not specify a
344 method. HOST and USER are regular expressions or nil, which is
345 interpreted as a regular expression which always matches. If no entry
346 matches, the variable `tramp-default-method' takes effect.
348 If the file name does not specify the user, lookup is done using the
349 empty string for the user name.
351 See `tramp-methods' for a list of possibilities for METHOD."
353 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
354 (choice :tag "User regexp" regexp sexp)
355 (choice :tag "Method name" string (const nil)))))
357 (defcustom tramp-default-user nil
358 "Default user to use for transferring files.
359 It is nil by default; otherwise settings in configuration files like
360 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
362 This variable is regarded as obsolete, and will be removed soon."
364 :type '(choice (const nil) string))
367 (defcustom tramp-default-user-alist nil
368 "Default user to use for specific method/host pairs.
369 This is an alist of items (METHOD HOST USER). The first matching item
370 specifies the user to use for a file name which does not specify a
371 user. METHOD and USER are regular expressions or nil, which is
372 interpreted as a regular expression which always matches. If no entry
373 matches, the variable `tramp-default-user' takes effect.
375 If the file name does not specify the method, lookup is done using the
376 empty string for the method name."
378 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
379 (choice :tag " Host regexp" regexp sexp)
380 (choice :tag " User name" string (const nil)))))
382 (defcustom tramp-default-host (system-name)
383 "Default host to use for transferring files.
384 Useful for su and sudo methods mostly."
389 (defcustom tramp-default-host-alist nil
390 "Default host to use for specific method/user pairs.
391 This is an alist of items (METHOD USER HOST). The first matching item
392 specifies the host to use for a file name which does not specify a
393 host. METHOD and HOST are regular expressions or nil, which is
394 interpreted as a regular expression which always matches. If no entry
395 matches, the variable `tramp-default-host' takes effect.
397 If the file name does not specify the method, lookup is done using the
398 empty string for the method name."
401 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
402 (choice :tag " User regexp" regexp sexp)
403 (choice :tag " Host name" string (const nil)))))
405 (defcustom tramp-default-proxies-alist nil
406 "Route to be followed for specific host/user pairs.
407 This is an alist of items (HOST USER PROXY). The first matching
408 item specifies the proxy to be passed for a file name located on
409 a remote target matching USER@HOST. HOST and USER are regular
410 expressions. PROXY must be a Tramp filename without a localname
411 part. Method and user name on PROXY are optional, which is
412 interpreted with the default values. PROXY can contain the
413 patterns %h and %u, which are replaced by the strings matching
414 HOST or USER, respectively.
416 HOST, USER or PROXY could also be Lisp forms, which will be
417 evaluated. The result must be a string or nil, which is
418 interpreted as a regular expression which always matches."
420 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
421 (choice :tag "User regexp" regexp sexp)
422 (choice :tag " Proxy name" string (const nil)))))
424 (defcustom tramp-save-ad-hoc-proxies nil
425 "Whether to save ad-hoc proxies persistently."
430 (defcustom tramp-restricted-shell-hosts-alist
431 (when (memq system-type '(windows-nt))
432 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
433 "List of hosts, which run a restricted shell.
434 This is a list of regular expressions, which denote hosts running
435 a registered shell like \"rbash\". Those hosts can be used as
436 proxies only, see `tramp-default-proxies-alist'. If the local
437 host runs a registered shell, it shall be added to this list, too."
440 :type '(repeat (regexp :tag "Host regexp")))
443 (defconst tramp-local-host-regexp
447 (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t)
449 "Host names which are regarded as local host.")
451 (defvar tramp-completion-function-alist nil
452 "Alist of methods for remote files.
453 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\).
454 Each NAME stands for a remote access method. Each PAIR is of the form
455 \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host
456 names from FILE for completion. The following predefined FUNCTIONs exists:
458 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
459 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
460 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
461 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
462 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
463 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
464 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
465 * `tramp-parse-netrc' for \"~/.netrc\" like files.
466 * `tramp-parse-putty' for PuTTY registered sessions.
468 FUNCTION can also be a customer defined function. For more details see
471 (defconst tramp-echo-mark-marker "_echo"
472 "String marker to surround echoed commands.")
474 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
475 "String length of `tramp-echo-mark-marker'.")
477 (defconst tramp-echo-mark
478 (concat tramp-echo-mark-marker
479 (make-string tramp-echo-mark-marker-length ?\b))
480 "String mark to be transmitted around shell commands.
481 Used to separate their echo from the output they produce. This
482 will only be used if we cannot disable remote echo via stty.
483 This string must have no effect on the remote shell except for
484 producing some echo which can later be detected by
485 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
486 followed by an equal number of backspaces to erase them will
489 (defconst tramp-echoed-echo-mark-regexp
490 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
491 tramp-echo-mark-marker tramp-echo-mark-marker-length)
492 "Regexp which matches `tramp-echo-mark' as it gets echoed by
495 (defcustom tramp-local-end-of-line
496 (if (memq system-type '(windows-nt)) "\r\n" "\n")
497 "String used for end of line in local processes."
502 (defcustom tramp-rsh-end-of-line "\n"
503 "String used for end of line in rsh connections.
504 I don't think this ever needs to be changed, so please tell me about it
505 if you need to change this."
509 (defcustom tramp-login-prompt-regexp
510 ".*ogin\\( .*\\)?: *"
511 "Regexp matching login-like prompts.
512 The regexp should match at end of buffer.
514 Sometimes the prompt is reported to look like \"login as:\"."
518 (defcustom tramp-shell-prompt-pattern
519 ;; Allow a prompt to start right after a ^M since it indeed would be
520 ;; displayed at the beginning of the line (and Zsh uses it). This
521 ;; regexp works only for GNU Emacs.
522 ;; Allow also [] style prompts. They can appear only during
523 ;; connection initialization; Tramp redefines the prompt afterwards.
524 (concat (if (featurep 'xemacs) "" "\\(?:^\\|\r\\)")
525 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
526 "Regexp to match prompts from remote shell.
527 Normally, Tramp expects you to configure `shell-prompt-pattern'
528 correctly, but sometimes it happens that you are connecting to a
529 remote host which sends a different kind of shell prompt. Therefore,
530 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
531 and also things matched by this variable. The default value of this
532 variable is similar to the default value of `shell-prompt-pattern',
533 which should work well in many cases.
535 This regexp must match both `tramp-initial-end-of-output' and
536 `tramp-end-of-output'."
540 (defcustom tramp-password-prompt-regexp
541 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
542 "Regexp matching password-like prompts.
543 The regexp should match at end of buffer.
545 The `sudo' program appears to insert a `^@' character into the prompt."
549 (defcustom tramp-wrong-passwd-regexp
551 ;; These strings should be on the last line
552 (regexp-opt '("Permission denied"
557 "Timeout, server not responding."
559 "Name or service not known"
560 "Host key verification failed."
561 "No supported authentication methods left to try!") t)
565 ;; Here comes a list of regexes, separated by \\|
566 "Received signal [0-9]+"
568 "Regexp matching a `login failed' message.
569 The regexp should match at end of buffer."
573 (defcustom tramp-yesno-prompt-regexp
575 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
577 "Regular expression matching all yes/no queries which need to be confirmed.
578 The confirmation should be done with yes or no.
579 The regexp should match at end of buffer.
580 See also `tramp-yn-prompt-regexp'."
584 (defcustom tramp-yn-prompt-regexp
586 (regexp-opt '("Store key in cache? (y/n)"
587 "Update cached key? (y/n, Return cancels connection)") t)
589 "Regular expression matching all y/n queries which need to be confirmed.
590 The confirmation should be done with y or n.
591 The regexp should match at end of buffer.
592 See also `tramp-yesno-prompt-regexp'."
596 (defcustom tramp-terminal-prompt-regexp
600 "Terminal type\\? \\[.*\\]"
602 "Regular expression matching all terminal setting prompts.
603 The regexp should match at end of buffer.
604 The answer will be provided by `tramp-action-terminal', which see."
608 (defcustom tramp-operation-not-permitted-regexp
609 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
610 (regexp-opt '("Operation not permitted") t))
611 "Regular expression matching keep-date problems in (s)cp operations.
612 Copying has been performed successfully already, so this message can
617 (defcustom tramp-copy-failed-regexp
619 (regexp-opt '("Permission denied"
622 "No such file or directory") t)
624 "Regular expression matching copy problems in (s)cp operations."
628 (defcustom tramp-process-alive-regexp
630 "Regular expression indicating a process has finished.
631 In fact this expression is empty by intention, it will be used only to
632 check regularly the status of the associated process.
633 The answer will be provided by `tramp-action-process-alive',
634 `tramp-action-out-of-band', which see."
638 (defconst tramp-temp-name-prefix "tramp."
639 "Prefix to use for temporary files.
640 If this is a relative file name (such as \"tramp.\"), it is considered
641 relative to the directory name returned by the function
642 `tramp-compat-temporary-file-directory' (which see). It may also be an
643 absolute file name; don't forget to include a prefix for the filename
646 (defconst tramp-temp-buffer-name " *tramp temp*"
647 "Buffer name for a temporary buffer.
648 It shall be used in combination with `generate-new-buffer-name'.")
650 (defvar tramp-temp-buffer-file-name nil
651 "File name of a persistent local temporary file.
652 Useful for \"rsync\" like methods.")
653 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
654 (put 'tramp-temp-buffer-file-name 'permanent-local t)
656 ;; XEmacs is distributed with few Lisp packages. Further packages are
657 ;; installed using EFS. If we use a unified filename format, then
658 ;; Tramp is required in addition to EFS. (But why can't Tramp just
659 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
660 ;; just like before.) Another reason for using a separate filename
661 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
662 ;; Tramp only knows how to deal with `file-name-handler-alist', not
665 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
667 (defcustom tramp-syntax
668 (if (featurep 'xemacs) 'sep 'ftp)
669 "Tramp filename syntax to be used.
671 It can have the following values:
673 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
674 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
675 'url -- URL-like syntax."
677 :type (if (featurep 'xemacs)
678 '(choice (const :tag "EFS" ftp)
679 (const :tag "XEmacs" sep)
680 (const :tag "URL" url))
681 '(choice (const :tag "Ange-FTP" ftp)
682 (const :tag "URL" url))))
684 (defconst tramp-prefix-format
685 (cond ((equal tramp-syntax 'ftp) "/")
686 ((equal tramp-syntax 'sep) "/[")
687 ((equal tramp-syntax 'url) "/")
688 (t (error "Wrong `tramp-syntax' defined")))
689 "String matching the very beginning of Tramp file names.
690 Used in `tramp-make-tramp-file-name'.")
692 (defconst tramp-prefix-regexp
693 (concat "^" (regexp-quote tramp-prefix-format))
694 "Regexp matching the very beginning of Tramp file names.
695 Should always start with \"^\". Derived from `tramp-prefix-format'.")
697 (defconst tramp-method-regexp
699 "Regexp matching methods identifiers.")
701 (defconst tramp-postfix-method-format
702 (cond ((equal tramp-syntax 'ftp) ":")
703 ((equal tramp-syntax 'sep) "/")
704 ((equal tramp-syntax 'url) "://")
705 (t (error "Wrong `tramp-syntax' defined")))
706 "String matching delimiter between method and user or host names.
707 Used in `tramp-make-tramp-file-name'.")
709 (defconst tramp-postfix-method-regexp
710 (regexp-quote tramp-postfix-method-format)
711 "Regexp matching delimiter between method and user or host names.
712 Derived from `tramp-postfix-method-format'.")
714 (defconst tramp-user-regexp "[^/|: \t]+"
715 "Regexp matching user names.")
718 (defconst tramp-prefix-domain-format "%"
719 "String matching delimiter between user and domain names.")
722 (defconst tramp-prefix-domain-regexp
723 (regexp-quote tramp-prefix-domain-format)
724 "Regexp matching delimiter between user and domain names.
725 Derived from `tramp-prefix-domain-format'.")
727 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
728 "Regexp matching domain names.")
730 (defconst tramp-user-with-domain-regexp
731 (concat "\\(" tramp-user-regexp "\\)"
732 tramp-prefix-domain-regexp
733 "\\(" tramp-domain-regexp "\\)")
734 "Regexp matching user names with domain names.")
736 (defconst tramp-postfix-user-format "@"
737 "String matching delimiter between user and host names.
738 Used in `tramp-make-tramp-file-name'.")
740 (defconst tramp-postfix-user-regexp
741 (regexp-quote tramp-postfix-user-format)
742 "Regexp matching delimiter between user and host names.
743 Derived from `tramp-postfix-user-format'.")
745 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
746 "Regexp matching host names.")
748 (defconst tramp-prefix-ipv6-format
749 (cond ((equal tramp-syntax 'ftp) "[")
750 ((equal tramp-syntax 'sep) "")
751 ((equal tramp-syntax 'url) "[")
752 (t (error "Wrong `tramp-syntax' defined")))
753 "String matching left hand side of IPv6 addresses.
754 Used in `tramp-make-tramp-file-name'.")
756 (defconst tramp-prefix-ipv6-regexp
757 (regexp-quote tramp-prefix-ipv6-format)
758 "Regexp matching left hand side of IPv6 addresses.
759 Derived from `tramp-prefix-ipv6-format'.")
761 ;; The following regexp is a bit sloppy. But it shall serve our
762 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
763 ;; "::ffff:192.168.0.1".
764 (defconst tramp-ipv6-regexp
765 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
766 "Regexp matching IPv6 addresses.")
768 (defconst tramp-postfix-ipv6-format
769 (cond ((equal tramp-syntax 'ftp) "]")
770 ((equal tramp-syntax 'sep) "")
771 ((equal tramp-syntax 'url) "]")
772 (t (error "Wrong `tramp-syntax' defined")))
773 "String matching right hand side of IPv6 addresses.
774 Used in `tramp-make-tramp-file-name'.")
776 (defconst tramp-postfix-ipv6-regexp
777 (regexp-quote tramp-postfix-ipv6-format)
778 "Regexp matching right hand side of IPv6 addresses.
779 Derived from `tramp-postfix-ipv6-format'.")
781 (defconst tramp-prefix-port-format
782 (cond ((equal tramp-syntax 'ftp) "#")
783 ((equal tramp-syntax 'sep) "#")
784 ((equal tramp-syntax 'url) ":")
785 (t (error "Wrong `tramp-syntax' defined")))
786 "String matching delimiter between host names and port numbers.")
788 (defconst tramp-prefix-port-regexp
789 (regexp-quote tramp-prefix-port-format)
790 "Regexp matching delimiter between host names and port numbers.
791 Derived from `tramp-prefix-port-format'.")
793 (defconst tramp-port-regexp "[0-9]+"
794 "Regexp matching port numbers.")
796 (defconst tramp-host-with-port-regexp
797 (concat "\\(" tramp-host-regexp "\\)"
798 tramp-prefix-port-regexp
799 "\\(" tramp-port-regexp "\\)")
800 "Regexp matching host names with port numbers.")
802 (defconst tramp-postfix-hop-format "|"
803 "String matching delimiter after ad-hoc hop definitions.")
805 (defconst tramp-postfix-hop-regexp
806 (regexp-quote tramp-postfix-hop-format)
807 "Regexp matching delimiter after ad-hoc hop definitions.
808 Derived from `tramp-postfix-hop-format'.")
810 (defconst tramp-postfix-host-format
811 (cond ((equal tramp-syntax 'ftp) ":")
812 ((equal tramp-syntax 'sep) "]")
813 ((equal tramp-syntax 'url) "")
814 (t (error "Wrong `tramp-syntax' defined")))
815 "String matching delimiter between host names and localnames.
816 Used in `tramp-make-tramp-file-name'.")
818 (defconst tramp-postfix-host-regexp
819 (regexp-quote tramp-postfix-host-format)
820 "Regexp matching delimiter between host names and localnames.
821 Derived from `tramp-postfix-host-format'.")
823 (defconst tramp-localname-regexp ".*$"
824 "Regexp matching localnames.")
826 ;;; File name format:
828 (defconst tramp-remote-file-name-spec-regexp
830 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
831 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
832 "\\(" "\\(?:" tramp-host-regexp "\\|"
833 tramp-prefix-ipv6-regexp tramp-ipv6-regexp
834 tramp-postfix-ipv6-regexp "\\)"
835 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
836 "Regular expression matching a Tramp file name between prefix and postfix.")
838 (defconst tramp-file-name-structure
842 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
843 tramp-postfix-hop-regexp "\\)+" "\\)?"
844 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
845 "\\(" tramp-localname-regexp "\\)")
847 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
848 the Tramp file name structure.
850 The first element REGEXP is a regular expression matching a Tramp file
851 name. The regex should contain parentheses around the method name,
852 the user name, the host name, and the file name parts.
854 The second element METHOD is a number, saying which pair of
855 parentheses matches the method name. The third element USER is
856 similar, but for the user name. The fourth element HOST is similar,
857 but for the host name. The fifth element FILE is for the file name.
858 The last element HOP is the ad-hoc hop definition, which could be a
859 cascade of several hops.
861 These numbers are passed directly to `match-string', which see. That
862 means the opening parentheses are counted to identify the pair.
864 See also `tramp-file-name-regexp'.")
867 (defconst tramp-file-name-regexp-unified
868 (if (memq system-type '(cygwin windows-nt))
869 "\\`/\\([^[/|:]\\{2,\\}\\|[^/|]\\{2,\\}]\\):"
870 "\\`/\\([^[/|:]+\\|[^/|]+]\\):")
871 "Value for `tramp-file-name-regexp' for unified remoting.
872 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
873 Tramp. See `tramp-file-name-structure' for more explanations.
875 On W32 systems, the volume letter must be ignored.")
878 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
879 "Value for `tramp-file-name-regexp' for separate remoting.
880 XEmacs uses a separate filename syntax for Tramp and EFS.
881 See `tramp-file-name-structure' for more explanations.")
884 (defconst tramp-file-name-regexp-url "\\`/[^/|:]+://"
885 "Value for `tramp-file-name-regexp' for URL-like remoting.
886 See `tramp-file-name-structure' for more explanations.")
889 (defconst tramp-file-name-regexp
890 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
891 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
892 ((equal tramp-syntax 'url) tramp-file-name-regexp-url)
893 (t (error "Wrong `tramp-syntax' defined")))
894 "Regular expression matching file names handled by Tramp.
895 This regexp should match Tramp file names but no other file names.
896 When tramp.el is loaded, this regular expression is prepended to
897 `file-name-handler-alist', and that is searched sequentially. Thus,
898 if the Tramp entry appears rather early in the `file-name-handler-alist'
899 and is a bit too general, then some files might be considered Tramp
900 files which are not really Tramp files.
902 Please note that the entry in `file-name-handler-alist' is made when
903 this file \(tramp.el\) is loaded. This means that this variable must be set
904 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
905 updated after changing this variable.
907 Also see `tramp-file-name-structure'.")
910 (defconst tramp-completion-file-name-regexp-unified
911 (if (memq system-type '(cygwin windows-nt))
912 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
913 "Value for `tramp-completion-file-name-regexp' for unified remoting.
914 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
915 See `tramp-file-name-structure' for more explanations.
917 On W32 systems, the volume letter must be ignored.")
920 (defconst tramp-completion-file-name-regexp-separate
921 "\\`/\\([[][^]]*\\)?\\'"
922 "Value for `tramp-completion-file-name-regexp' for separate remoting.
923 XEmacs uses a separate filename syntax for Tramp and EFS.
924 See `tramp-file-name-structure' for more explanations.")
927 (defconst tramp-completion-file-name-regexp-url
928 "\\`/[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?\\'"
929 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
930 See `tramp-file-name-structure' for more explanations.")
933 (defconst tramp-completion-file-name-regexp
934 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
935 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
936 ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url)
937 (t (error "Wrong `tramp-syntax' defined")))
938 "Regular expression matching file names handled by Tramp completion.
939 This regexp should match partial Tramp file names only.
941 Please note that the entry in `file-name-handler-alist' is made when
942 this file \(tramp.el\) is loaded. This means that this variable must be set
943 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
944 updated after changing this variable.
946 Also see `tramp-file-name-structure'.")
948 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
949 ;; known to have a bug in `process-send-string'; some ssh connections appear
950 ;; to drop bytes when data is sent too quickly. There is also a connection
951 ;; buffer local variable, which is computed depending on remote host properties
952 ;; when `tramp-chunksize' is zero or nil.
953 (defcustom tramp-chunksize
954 (when (and (not (featurep 'xemacs))
955 (memq system-type '(hpux)))
957 ;; Parentheses in docstring starting at beginning of line are escaped.
958 ;; Fontification is messed up when
959 ;; `open-paren-in-column-0-is-defun-start' set to t.
960 "If non-nil, chunksize for sending input to local process.
961 It is necessary only on systems which have a buggy `process-send-string'
962 implementation. The necessity, whether this variable must be set, can be
963 checked via the following code:
966 (let* ((user \"xxx\") (host \"yyy\")
968 (sent init) (received init))
969 (while (= sent received)
970 (setq sent (+ sent step))
972 (let ((proc (start-process (buffer-name) (current-buffer)
973 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
974 (when (memq (process-status proc) '(run open))
975 (process-send-string proc (make-string sent ?\\ ))
976 (process-send-eof proc)
977 (process-send-eof proc))
978 (while (not (progn (goto-char (point-min))
979 (re-search-forward \"\\\\w+\" (point-max) t)))
980 (accept-process-output proc 1))
981 (when (memq (process-status proc) '(run open))
982 (setq received (string-to-number (match-string 0)))
983 (delete-process proc)
984 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
986 (if (> sent (+ init step))
987 (message \"You should set `tramp-chunksize' to a maximum of %s\"
989 (message \"Test does not work\")
990 (display-buffer (current-buffer))
993 In the Emacs normally running Tramp, evaluate the above code
994 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
995 respectively\). You can do this, for example, by pasting it into
996 the `*scratch*' buffer and then hitting C-j with the cursor after the
997 last closing parenthesis. Note that it works only if you have configured
998 \"ssh\" to run without password query, see ssh-agent\(1\).
1000 You will see the number of bytes sent successfully to the remote host.
1001 If that number exceeds 1000, you can stop the execution by hitting
1002 C-g, because your Emacs is likely clean.
1004 When it is necessary to set `tramp-chunksize', you might consider to
1005 use an out-of-the-band method \(like \"scp\"\) instead of an internal one
1006 \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases
1009 If your Emacs is buggy, the code stops and gives you an indication
1010 about the value `tramp-chunksize' should be set. Maybe you could just
1011 experiment a bit, e.g. changing the values of `init' and `step'
1012 in the third line of the code.
1014 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1015 this variable to be set as well."
1017 :type '(choice (const nil) integer))
1019 ;; Logging in to a remote host normally requires obtaining a pty. But
1020 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1021 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1022 ;; for an override of the system default.
1023 (defcustom tramp-process-connection-type t
1024 "Overrides `process-connection-type' for connections from Tramp.
1025 Tramp binds `process-connection-type' to the value given here before
1026 opening a connection to a remote host."
1028 :type '(choice (const nil) (const t) (const pty)))
1030 (defcustom tramp-connection-min-time-diff 5
1031 "Defines seconds between two consecutive connection attempts.
1032 This is necessary as self defense mechanism, in order to avoid
1033 yo-yo connection attempts when the remote host is unavailable.
1035 A value of 0 or `nil' suppresses this check. This might be
1036 necessary, when several out-of-order copy operations are
1037 performed, or when several asynchronous processes will be started
1038 in a short time frame. In those cases it is recommended to
1039 let-bind this variable."
1042 :type '(choice (const nil) integer))
1044 (defcustom tramp-completion-reread-directory-timeout 10
1045 "Defines seconds since last remote command before rereading a directory.
1046 A remote directory might have changed its contents. In order to
1047 make it visible during file name completion in the minibuffer,
1048 Tramp flushes its cache and rereads the directory contents when
1049 more than `tramp-completion-reread-directory-timeout' seconds
1050 have been gone since last remote command execution. A value of `t'
1051 would require an immediate reread during filename completion, `nil'
1052 means to use always cached values for the directory contents."
1054 :type '(choice (const nil) (const t) integer))
1056 ;;; Internal Variables:
1058 (defvar tramp-current-method nil
1059 "Connection method for this *tramp* buffer.")
1061 (defvar tramp-current-user nil
1062 "Remote login name for this *tramp* buffer.")
1064 (defvar tramp-current-host nil
1065 "Remote host for this *tramp* buffer.")
1068 (defconst tramp-completion-file-name-handler-alist
1069 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1070 (file-name-completion . tramp-completion-handle-file-name-completion))
1071 "Alist of completion handler functions.
1072 Used for file names matching `tramp-file-name-regexp'. Operations
1073 not mentioned here will be handled by Tramp's file name handler
1074 functions, or the normal Emacs functions.")
1076 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1077 ;;;###tramp-autoload
1078 (defvar tramp-foreign-file-name-handler-alist nil
1079 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1080 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1083 ;;; Internal functions which must come first:
1085 ;; Conversion functions between external representation and
1086 ;; internal data structure. Convenience functions for internal
1089 (defun tramp-get-method-parameter (method param)
1090 "Return the method parameter PARAM.
1091 If the `tramp-methods' entry does not exist, return nil."
1092 (let ((entry (assoc param (assoc method tramp-methods))))
1093 (when entry (cadr entry))))
1095 (defun tramp-file-name-p (vec)
1096 "Check, whether VEC is a Tramp object."
1097 (and (vectorp vec) (= 5 (length vec))))
1099 (defun tramp-file-name-method (vec)
1100 "Return method component of VEC."
1101 (and (tramp-file-name-p vec) (aref vec 0)))
1103 (defun tramp-file-name-user (vec)
1104 "Return user component of VEC."
1105 (and (tramp-file-name-p vec) (aref vec 1)))
1107 (defun tramp-file-name-host (vec)
1108 "Return host component of VEC."
1109 (and (tramp-file-name-p vec) (aref vec 2)))
1111 (defun tramp-file-name-localname (vec)
1112 "Return localname component of VEC."
1113 (and (tramp-file-name-p vec) (aref vec 3)))
1115 (defun tramp-file-name-hop (vec)
1116 "Return hop component of VEC."
1117 (and (tramp-file-name-p vec) (aref vec 4)))
1119 ;; The user part of a Tramp file name vector can be of kind
1120 ;; "user%domain". Sometimes, we must extract these parts.
1121 (defun tramp-file-name-real-user (vec)
1122 "Return the user name of VEC without domain."
1124 (let ((user (tramp-file-name-user vec)))
1125 (if (and (stringp user)
1126 (string-match tramp-user-with-domain-regexp user))
1127 (match-string 1 user)
1130 (defun tramp-file-name-domain (vec)
1131 "Return the domain name of VEC."
1133 (let ((user (tramp-file-name-user vec)))
1135 (string-match tramp-user-with-domain-regexp user)
1136 (match-string 2 user)))))
1138 ;; The host part of a Tramp file name vector can be of kind
1139 ;; "host#port". Sometimes, we must extract these parts.
1140 (defun tramp-file-name-real-host (vec)
1141 "Return the host name of VEC without port."
1143 (let ((host (tramp-file-name-host vec)))
1144 (if (and (stringp host)
1145 (string-match tramp-host-with-port-regexp host))
1146 (match-string 1 host)
1149 (defun tramp-file-name-port (vec)
1150 "Return the port number of VEC."
1152 (let ((method (tramp-file-name-method vec))
1153 (host (tramp-file-name-host vec)))
1154 (or (and (stringp host)
1155 (string-match tramp-host-with-port-regexp host)
1156 (string-to-number (match-string 2 host)))
1157 (tramp-get-method-parameter method 'tramp-default-port)))))
1159 ;;;###tramp-autoload
1160 (defun tramp-tramp-file-p (name)
1161 "Return t if NAME is a string with Tramp file name syntax.
1162 It checks also, whether NAME is unibyte encoded."
1165 ; (string-equal name (string-as-unibyte name))
1166 (string-match tramp-file-name-regexp name))))
1168 (defun tramp-find-method (method user host)
1169 "Return the right method string to use.
1170 This is METHOD, if non-nil. Otherwise, do a lookup in
1171 `tramp-default-method-alist'."
1173 (let ((choices tramp-default-method-alist)
1176 (setq item (pop choices))
1177 (when (and (string-match (or (nth 0 item) "") (or host ""))
1178 (string-match (or (nth 1 item) "") (or user "")))
1179 (setq lmethod (nth 2 item))
1180 (setq choices nil)))
1182 tramp-default-method))
1184 (defun tramp-find-user (method user host)
1185 "Return the right user string to use.
1186 This is USER, if non-nil. Otherwise, do a lookup in
1187 `tramp-default-user-alist'."
1189 (let ((choices tramp-default-user-alist)
1192 (setq item (pop choices))
1193 (when (and (string-match (or (nth 0 item) "") (or method ""))
1194 (string-match (or (nth 1 item) "") (or host "")))
1195 (setq luser (nth 2 item))
1196 (setq choices nil)))
1198 tramp-default-user))
1200 (defun tramp-find-host (method user host)
1201 "Return the right host string to use.
1202 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1203 (or (and (> (length host) 0) host)
1204 (let ((choices tramp-default-host-alist)
1207 (setq item (pop choices))
1208 (when (and (string-match (or (nth 0 item) "") (or method ""))
1209 (string-match (or (nth 1 item) "") (or user "")))
1210 (setq lhost (nth 2 item))
1211 (setq choices nil)))
1213 tramp-default-host))
1215 (defun tramp-dissect-file-name (name &optional nodefault)
1216 "Return a `tramp-file-name' structure.
1217 The structure consists of remote method, remote user, remote host
1218 and localname (file name on remote host). If NODEFAULT is
1219 non-nil, the file name parts are not expanded to their default
1222 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1223 (unless match (error "Not a Tramp file name: %s" name))
1224 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1225 (user (match-string (nth 2 tramp-file-name-structure) name))
1226 (host (match-string (nth 3 tramp-file-name-structure) name))
1227 (localname (match-string (nth 4 tramp-file-name-structure) name))
1228 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1230 (when (string-match tramp-prefix-ipv6-regexp host)
1231 (setq host (replace-match "" nil t host)))
1232 (when (string-match tramp-postfix-ipv6-regexp host)
1233 (setq host (replace-match "" nil t host))))
1235 (vector method user host localname hop)
1237 (tramp-find-method method user host)
1238 (tramp-find-user method user host)
1239 (tramp-find-host method user host)
1242 (defun tramp-buffer-name (vec)
1243 "A name for the connection buffer VEC."
1244 ;; We must use `tramp-file-name-real-host', because for gateway
1245 ;; methods the default port will be expanded later on, which would
1247 (let ((method (tramp-file-name-method vec))
1248 (user (tramp-file-name-user vec))
1249 (host (tramp-file-name-real-host vec)))
1250 (if (not (zerop (length user)))
1251 (format "*tramp/%s %s@%s*" method user host)
1252 (format "*tramp/%s %s*" method host))))
1254 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1255 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1256 When not nil, an optional HOP is prepended."
1257 (concat tramp-prefix-format hop
1258 (when (not (zerop (length method)))
1259 (concat method tramp-postfix-method-format))
1260 (when (not (zerop (length user)))
1261 (concat user tramp-postfix-user-format))
1263 (if (string-match tramp-ipv6-regexp host)
1264 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1266 tramp-postfix-host-format
1267 (when localname localname)))
1269 (defun tramp-completion-make-tramp-file-name (method user host localname)
1270 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1271 It must not be a complete Tramp file name, but as long as there are
1272 necessary only. This function will be used in file name completion."
1273 (concat tramp-prefix-format
1274 (when (not (zerop (length method)))
1275 (concat method tramp-postfix-method-format))
1276 (when (not (zerop (length user)))
1277 (concat user tramp-postfix-user-format))
1278 (when (not (zerop (length host)))
1280 (if (string-match tramp-ipv6-regexp host)
1282 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1284 tramp-postfix-host-format))
1285 (when localname localname)))
1287 (defun tramp-get-buffer (vec)
1288 "Get the connection buffer to be used for VEC."
1289 (or (get-buffer (tramp-buffer-name vec))
1290 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1291 (setq buffer-undo-list t)
1292 (setq default-directory
1293 (tramp-make-tramp-file-name
1294 (tramp-file-name-method vec)
1295 (tramp-file-name-user vec)
1296 (tramp-file-name-host vec)
1300 (defun tramp-get-connection-buffer (vec)
1301 "Get the connection buffer to be used for VEC.
1302 In case a second asynchronous communication has been started, it is different
1303 from `tramp-get-buffer'."
1304 (or (tramp-get-connection-property vec "process-buffer" nil)
1305 (tramp-get-buffer vec)))
1307 (defun tramp-get-connection-name (vec)
1308 "Get the connection name to be used for VEC.
1309 In case a second asynchronous communication has been started, it is different
1310 from the default one."
1311 (or (tramp-get-connection-property vec "process-name" nil)
1312 (tramp-buffer-name vec)))
1314 (defun tramp-get-connection-process (vec)
1315 "Get the connection process to be used for VEC.
1316 In case a second asynchronous communication has been started, it is different
1317 from the default one."
1318 (get-process (tramp-get-connection-name vec)))
1320 (defun tramp-debug-buffer-name (vec)
1321 "A name for the debug buffer for VEC."
1322 ;; We must use `tramp-file-name-real-host', because for gateway
1323 ;; methods the default port will be expanded later on, which would
1325 (let ((method (tramp-file-name-method vec))
1326 (user (tramp-file-name-user vec))
1327 (host (tramp-file-name-real-host vec)))
1328 (if (not (zerop (length user)))
1329 (format "*debug tramp/%s %s@%s*" method user host)
1330 (format "*debug tramp/%s %s*" method host))))
1332 (defconst tramp-debug-outline-regexp
1333 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1334 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1336 (defun tramp-debug-outline-level ()
1337 "Return the depth to which a statement is nested in the outline.
1338 Point must be at the beginning of a header line.
1340 The outline level is equal to the verbosity of the Tramp message."
1341 (1+ (string-to-number (match-string 1))))
1343 (defun tramp-get-debug-buffer (vec)
1344 "Get the debug buffer for VEC."
1345 (with-current-buffer
1346 (get-buffer-create (tramp-debug-buffer-name vec))
1348 (setq buffer-undo-list t)
1349 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1350 ;; `outline-mode-hook'. We must prevent that local processes
1351 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1352 ;; Furthermore, `outline-regexp' must have the correct value
1353 ;; already, because it is used by `font-lock-compile-keywords'.
1354 (let ((default-directory (tramp-compat-temporary-file-directory))
1355 (outline-regexp tramp-debug-outline-regexp))
1357 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1358 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1361 (defsubst tramp-debug-message (vec fmt-string &rest args)
1362 "Append message to debug buffer.
1363 Message is formatted with FMT-STRING as control string and the remaining
1364 ARGS to actually emit the message (if applicable)."
1365 (when (get-buffer (tramp-buffer-name vec))
1366 (with-current-buffer (tramp-get-debug-buffer vec)
1367 (goto-char (point-max))
1372 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1373 (if (featurep 'sxemacs) "SX" (if (featurep 'xemacs) "X" "GNU "))
1374 emacs-version tramp-version)))
1378 (let ((now (current-time)))
1379 (insert (format-time-string "%T." now))
1380 (insert (format "%06d " (nth 2 now))))
1381 ;; Calling Tramp function. We suppress compat and trace
1382 ;; functions from being displayed.
1383 (let ((btn 1) btf fn)
1385 (setq btf (nth 1 (backtrace-frame btn)))
1389 (setq fn (symbol-name btf))
1392 (string-match "^tramp" fn)
1399 "tramp-compat-condition-case-unless-debug"
1400 "tramp-compat-funcall"
1401 "tramp-compat-with-temp-message"
1402 "tramp-debug-message"
1404 "tramp-error-with-buffer"
1410 (setq btn (1+ btn))))
1411 ;; The following code inserts filename and line number.
1412 ;; Should be inactive by default, because it is time
1414 ; (let ((ffn (find-function-noselect (intern fn))))
1418 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1419 ; (with-current-buffer (car ffn)
1420 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1421 (insert (format "%s " fn)))
1423 (insert (apply 'format fmt-string args)))))
1425 (defvar tramp-message-show-message t
1426 "Show Tramp message in the minibuffer.
1427 This variable is used to disable messages from `tramp-error'.
1428 The messages are visible anyway, because an error is raised.")
1430 (defvar tramp-message-show-progress-reporter-message t
1431 "Show Tramp progress reporter message in the minibuffer.
1432 This variable is used to disable recursive progress reporter messages.")
1434 (defsubst tramp-message (vec-or-proc level fmt-string &rest args)
1435 "Emit a message depending on verbosity level.
1436 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1437 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1438 less than LEVEL. The message is emitted only if `tramp-verbose' is
1439 greater than or equal to LEVEL.
1441 The message is also logged into the debug buffer when `tramp-verbose'
1442 is greater than or equal 4.
1444 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1445 control string and the remaining ARGS to actually emit the message (if
1448 (when (<= level tramp-verbose)
1449 ;; Match data must be preserved!
1451 ;; Display only when there is a minimum level.
1452 (when (and tramp-message-show-message (<= level 3))
1458 ((= level 2) "Warning: ")
1462 ;; Log only when there is a minimum level.
1463 (when (>= tramp-verbose 4)
1464 (when (and vec-or-proc
1465 (processp vec-or-proc)
1466 (buffer-name (process-buffer vec-or-proc)))
1467 (with-current-buffer (process-buffer vec-or-proc)
1468 ;; Translate proc to vec.
1469 (setq vec-or-proc (tramp-dissect-file-name default-directory))))
1470 (when (and vec-or-proc (vectorp vec-or-proc))
1471 (apply 'tramp-debug-message
1473 (concat (format "(%d) # " level) fmt-string)
1476 (defsubst tramp-error (vec-or-proc signal fmt-string &rest args)
1478 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1479 signal identifier to be raised, remaining args passed to
1480 `tramp-message'. Finally, signal SIGNAL is raised."
1481 (let (tramp-message-show-message)
1484 (error-message-string
1486 (get signal 'error-message)
1487 (apply 'format fmt-string args))))
1488 (signal signal (list (apply 'format fmt-string args)))))
1490 (defsubst tramp-error-with-buffer
1491 (buffer vec-or-proc signal fmt-string &rest args)
1492 "Emit an error, and show BUFFER.
1493 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
1494 an input event arrives. The other arguments are passed to `tramp-error'."
1495 (save-window-excursion
1497 (apply 'tramp-error vec-or-proc signal fmt-string args)
1498 (when (and vec-or-proc
1499 tramp-message-show-message
1500 (not (zerop tramp-verbose))
1501 (not (tramp-completion-mode-p)))
1502 (let ((enable-recursive-minibuffers t))
1504 (or (and (bufferp buffer) buffer)
1505 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1506 (tramp-get-connection-buffer vec-or-proc)))
1507 (when (string-equal fmt-string "Process died")
1510 "Tramp failed to connect. If this happens repeatedly, try"
1511 "`M-x tramp-cleanup-this-connection'"))
1514 (defsubst tramp-backtrace (vec-or-proc)
1515 "Dump a backtrace into the debug buffer.
1516 This function is meant for debugging purposes."
1517 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace))))
1519 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1520 "Parse a Tramp filename and make components available in the body.
1522 First arg FILENAME is evaluated and dissected into its components.
1523 Second arg VAR is a symbol. It is used as a variable name to hold
1524 the filename structure. It is also used as a prefix for the variables
1525 holding the components. For example, if VAR is the symbol `foo', then
1526 `foo' will be bound to the whole structure, `foo-method' will be bound to
1527 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1530 Remaining args are Lisp expressions to be evaluated (inside an implicit
1533 If VAR is nil, then we bind `v' to the structure and `method', `user',
1534 `host', `localname', `hop' to the components."
1535 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1536 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
1537 (tramp-file-name-method ,(or var 'v)))
1538 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
1539 (tramp-file-name-user ,(or var 'v)))
1540 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
1541 (tramp-file-name-host ,(or var 'v)))
1542 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
1543 (tramp-file-name-localname ,(or var 'v)))
1544 (,(if var (intern (concat (symbol-name var) "-hop")) 'hop)
1545 (tramp-file-name-hop ,(or var 'v))))
1548 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1549 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1550 (tramp-compat-font-lock-add-keywords
1551 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1553 (defun tramp-progress-reporter-update (reporter &optional value)
1554 (let* ((parameters (cdr reporter))
1555 (message (aref parameters 3)))
1556 (when (string-match message (or (current-message) ""))
1557 (tramp-compat-funcall 'progress-reporter-update reporter value))))
1559 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1560 "Executes BODY, spinning a progress reporter with MESSAGE.
1561 If LEVEL does not fit for visible messages, or if this is a
1562 nested call of the macro, there are only traces without a visible
1564 (declare (indent 3) (debug t))
1566 (tramp-message ,vec ,level "%s..." ,message)
1567 ;; We start a pulsing progress reporter after 3 seconds. Feature
1568 ;; introduced in Emacs 24.1.
1569 (when (and tramp-message-show-progress-reporter-message
1570 tramp-message-show-message
1571 ;; Display only when there is a minimum level.
1572 (<= ,level (min tramp-verbose 3)))
1574 (setq pr (tramp-compat-funcall 'make-progress-reporter ,message)
1576 (run-at-time 3 0.1 'tramp-progress-reporter-update pr)))))
1578 ;; Execute the body. Suppress concurrent progress reporter
1580 (let ((tramp-message-show-progress-reporter-message
1581 (and tramp-message-show-progress-reporter-message (not tm))))
1583 ;; Stop progress reporter.
1584 (if tm (tramp-compat-funcall 'cancel-timer tm))
1585 (tramp-message ,vec ,level "%s...done" ,message))))
1587 (tramp-compat-font-lock-add-keywords
1588 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1590 (defmacro with-tramp-file-property (vec file property &rest body)
1591 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1592 FILE must be a local file name on a connection identified via VEC."
1593 `(if (file-name-absolute-p ,file)
1594 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1595 (when (eq value 'undef)
1596 ;; We cannot pass @body as parameter to
1597 ;; `tramp-set-file-property' because it mangles our
1599 (setq value (progn ,@body))
1600 (tramp-set-file-property ,vec ,file ,property value))
1604 (put 'with-tramp-file-property 'lisp-indent-function 3)
1605 (put 'with-tramp-file-property 'edebug-form-spec t)
1606 (tramp-compat-font-lock-add-keywords
1607 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1609 (defmacro with-tramp-connection-property (key property &rest body)
1610 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1611 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1612 (when (eq value 'undef)
1613 ;; We cannot pass ,@body as parameter to
1614 ;; `tramp-set-connection-property' because it mangles our debug
1616 (setq value (progn ,@body))
1617 (tramp-set-connection-property ,key ,property value))
1620 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1621 (put 'with-tramp-connection-property 'edebug-form-spec t)
1622 (tramp-compat-font-lock-add-keywords
1623 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1625 (defalias 'tramp-drop-volume-letter
1626 (if (memq system-type '(cygwin windows-nt))
1628 "Cut off unnecessary drive letter from file NAME.
1629 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1630 locally on a remote file name. When the local system is a W32 system
1631 but the remote system is Unix, this introduces a superfluous drive
1632 letter into the file name. This function removes it."
1634 (if (string-match "\\`[a-zA-Z]:/" name)
1635 (replace-match "/" nil t name)
1640 (if (featurep 'xemacs)
1641 (defalias 'tramp-drop-volume-letter 'identity))
1643 (defun tramp-cleanup (vec)
1644 "Cleanup connection VEC, but keep the debug buffer."
1645 (with-current-buffer (tramp-get-debug-buffer vec)
1646 ;; Keep the debug buffer.
1648 (generate-new-buffer-name tramp-temp-buffer-name) 'unique)
1649 (tramp-cleanup-connection vec)
1650 (if (= (point-min) (point-max))
1652 (rename-buffer (tramp-debug-buffer-name vec) 'unique))
1653 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
1654 (tramp-get-buffer vec)))
1656 ;;; Config Manipulation Functions:
1658 ;;;###tramp-autoload
1659 (defun tramp-set-completion-function (method function-list)
1660 "Sets the list of completion functions for METHOD.
1661 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1662 The FUNCTION is intended to parse FILE according its syntax.
1663 It might be a predefined FUNCTION, or a user defined FUNCTION.
1664 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1668 (tramp-set-completion-function
1670 '((tramp-parse-sconfig \"/etc/ssh_config\")
1671 (tramp-parse-sconfig \"~/.ssh/config\")))"
1673 (let ((r function-list)
1675 (setq tramp-completion-function-alist
1676 (delete (assoc method tramp-completion-function-alist)
1677 tramp-completion-function-alist))
1680 ;; Remove double entries.
1681 (when (member (car v) (cdr v))
1682 (setcdr v (delete (car v) (cdr v))))
1683 ;; Check for function and file or registry key.
1684 (unless (and (functionp (nth 0 (car v)))
1685 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1686 ;; Windows registry.
1687 (and (memq system-type '(cygwin windows-nt))
1689 (tramp-compat-call-process
1690 "reg" nil nil nil "query" (nth 1 (car v)))))
1691 ;; Configuration file.
1692 (file-exists-p (nth 1 (car v)))))
1693 (setq r (delete (car v) r)))
1697 (add-to-list 'tramp-completion-function-alist
1700 (defun tramp-get-completion-function (method)
1701 "Returns a list of completion functions for METHOD.
1702 For definition of that list see `tramp-set-completion-function'."
1704 ;; Hosts visited once shall be remembered.
1705 `(tramp-parse-connection-properties ,method)
1706 ;; The method related defaults.
1707 (cdr (assoc method tramp-completion-function-alist))))
1710 ;;; Fontification of `read-file-name':
1712 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1713 (defvar tramp-rfn-eshadow-overlay)
1714 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1716 (defun tramp-rfn-eshadow-setup-minibuffer ()
1717 "Set up a minibuffer for `file-name-shadow-mode'.
1718 Adds another overlay hiding filename parts according to Tramp's
1719 special handling of `substitute-in-file-name'."
1720 (when (symbol-value 'minibuffer-completing-file-name)
1721 (setq tramp-rfn-eshadow-overlay
1722 (tramp-compat-funcall
1724 (tramp-compat-funcall 'minibuffer-prompt-end)
1725 (tramp-compat-funcall 'minibuffer-prompt-end)))
1726 ;; Copy rfn-eshadow-overlay properties.
1727 (let ((props (tramp-compat-funcall
1728 'overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1730 ;; The `field' property prevents correct minibuffer
1731 ;; completion; we exclude it.
1732 (if (not (eq (car props) 'field))
1733 (tramp-compat-funcall
1734 'overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1735 (pop props) (pop props))))))
1737 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
1738 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1739 'tramp-rfn-eshadow-setup-minibuffer)
1740 (add-hook 'tramp-unload-hook
1742 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1743 'tramp-rfn-eshadow-setup-minibuffer))))
1745 (defconst tramp-rfn-eshadow-update-overlay-regexp
1746 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1748 (defun tramp-rfn-eshadow-update-overlay ()
1749 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1750 This is intended to be used as a minibuffer `post-command-hook' for
1751 `file-name-shadow-mode'; the minibuffer should have already
1752 been set up by `rfn-eshadow-setup-minibuffer'."
1753 ;; In remote files name, there is a shadowing just for the local part.
1755 (let ((end (or (tramp-compat-funcall
1756 'overlay-end (symbol-value 'rfn-eshadow-overlay))
1757 (tramp-compat-funcall 'minibuffer-prompt-end)))
1758 ;; We do not want to send any remote command.
1762 (tramp-compat-funcall
1763 'buffer-substring-no-properties end (point-max)))
1767 (1+ (or (string-match
1768 tramp-rfn-eshadow-update-overlay-regexp
1769 (buffer-string) end)
1772 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1773 (rfn-eshadow-update-overlay-hook nil)
1774 file-name-handler-alist)
1775 (tramp-compat-funcall
1776 'move-overlay rfn-eshadow-overlay (point-max) (point-max))
1777 (tramp-compat-funcall 'rfn-eshadow-update-overlay))))))))
1779 (when (boundp 'rfn-eshadow-update-overlay-hook)
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) (tramp-compat-octal-to-decimal "0666"))))
1810 (defun tramp-replace-environment-variables (filename)
1811 "Replace environment variables in FILENAME.
1812 Return the string with the replaced variables."
1814 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1815 ;; We need an own implementation.
1817 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1818 ;; `$' is coded as `$$'.
1820 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1821 (getenv (match-string 1 filename)))
1824 (substitute-in-file-name (match-string 0 filename))
1828 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
1829 ;; which calls corresponding functions (see minibuf.el).
1830 (when (fboundp 'minibuffer-electric-separator)
1835 (around ,(intern (format "tramp-advice-%s" x)) activate)
1836 "Invoke `substitute-in-file-name' for Tramp files."
1837 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
1838 (tramp-tramp-file-p (buffer-substring)))
1839 ;; We don't need to handle `last-input-event', because
1840 ;; due to the key map we know it must be ?/ or ?~.
1841 (let ((s (concat (buffer-substring (point-min) (point))
1842 (string last-command-char))))
1843 (delete-region (point-min) (point))
1844 (insert (substitute-in-file-name s))
1845 (setq ad-return-value last-command-char))
1851 (ad-remove-advice ',x 'around ',(intern (format "tramp-advice-%s" x)))
1852 (ad-activate ',x)))))
1854 '(minibuffer-electric-separator
1855 minibuffer-electric-tilde)))
1857 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1858 "Like `find-operation-coding-system' for Tramp filenames.
1859 Tramp's `insert-file-contents' and `write-region' work over
1860 temporary file names. If `file-coding-system-alist' contains an
1861 expression, which matches more than the file name suffix, the
1862 coding system might not be determined. This function repairs it."
1864 (dolist (elt file-coding-system-alist result)
1865 (when (and (consp elt) (string-match (car elt) filename))
1866 ;; We found a matching entry in `file-coding-system-alist'.
1867 ;; So we add a similar entry, but with the temporary file name
1870 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1873 (progn (defun tramp-run-real-handler (operation args)
1874 "Invoke normal file name handler for OPERATION.
1875 First arg specifies the OPERATION, second arg is a list of arguments to
1876 pass to the OPERATION."
1877 (let* ((inhibit-file-name-handlers
1878 `(tramp-file-name-handler
1879 tramp-vc-file-name-handler
1880 tramp-completion-file-name-handler
1881 cygwin-mount-name-hook-function
1882 cygwin-mount-map-drive-hook-function
1884 ,(and (eq inhibit-file-name-operation operation)
1885 inhibit-file-name-handlers)))
1886 (inhibit-file-name-operation operation))
1887 (apply operation args))))
1890 (progn (defun tramp-completion-run-real-handler (operation args)
1891 "Invoke `tramp-file-name-handler' for OPERATION.
1892 First arg specifies the OPERATION, second arg is a list of arguments to
1893 pass to the OPERATION."
1894 (let* ((inhibit-file-name-handlers
1895 `(tramp-completion-file-name-handler
1896 cygwin-mount-name-hook-function
1897 cygwin-mount-map-drive-hook-function
1899 ,(and (eq inhibit-file-name-operation operation)
1900 inhibit-file-name-handlers)))
1901 (inhibit-file-name-operation operation))
1902 (apply operation args))))
1904 ;; We handle here all file primitives. Most of them have the file
1905 ;; name as first parameter; nevertheless we check for them explicitly
1906 ;; in order to be signaled if a new primitive appears. This
1907 ;; scenario is needed because there isn't a way to decide by
1908 ;; syntactical means whether a foreign method must be called. It would
1909 ;; ease the life if `file-name-handler-alist' would support a decision
1910 ;; function as well but regexp only.
1911 (defun tramp-file-name-for-operation (operation &rest args)
1912 "Return file name related to OPERATION file primitive.
1913 ARGS are the arguments OPERATION has been called with."
1915 ;; FILE resp DIRECTORY.
1917 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
1918 'delete-file 'diff-latest-backup-file 'directory-file-name
1919 'directory-files 'directory-files-and-attributes
1920 'dired-compress-file 'dired-uncache
1921 'file-accessible-directory-p 'file-attributes
1922 'file-directory-p 'file-executable-p 'file-exists-p
1923 'file-local-copy 'file-remote-p 'file-modes
1924 'file-name-as-directory 'file-name-directory
1925 'file-name-nondirectory 'file-name-sans-versions
1926 'file-ownership-preserved-p 'file-readable-p
1927 'file-regular-p 'file-symlink-p 'file-truename
1928 'file-writable-p 'find-backup-file-name 'find-file-noselect
1929 'get-file-buffer 'insert-directory 'insert-file-contents
1930 'load 'make-directory 'make-directory-internal
1931 'set-file-modes 'substitute-in-file-name
1932 'unhandled-file-name-directory 'vc-registered
1936 'file-acl 'file-selinux-context
1937 'set-file-acl 'set-file-selinux-context
1939 'abbreviate-file-name 'create-file-buffer
1940 'dired-file-modtime 'dired-make-compressed-filename
1941 'dired-recursive-delete-directory 'dired-set-file-modtime
1942 'dired-shell-unhandle-file-name 'dired-uucode-file
1943 'insert-file-contents-literally 'make-temp-name 'recover-file
1944 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
1945 (if (file-name-absolute-p (nth 0 args))
1947 (expand-file-name (nth 0 args))))
1948 ;; FILE DIRECTORY resp FILE1 FILE2.
1950 (list 'add-name-to-file 'copy-file 'expand-file-name
1951 'file-name-all-completions 'file-name-completion
1952 'file-newer-than-file-p 'make-symbolic-link 'rename-file
1956 'file-in-directory-p 'file-equal-p
1958 'dired-make-relative-symlink
1959 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
1962 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
1963 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
1964 (t (buffer-file-name (current-buffer))))))
1966 ((eq operation 'write-region)
1970 (list 'set-visited-file-modtime 'verify-visited-file-modtime
1972 'make-auto-save-file-name
1976 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1979 (list ;; not in Emacs 23+.
1988 'dired-print-file 'dired-shell-call-process))
1990 ;; Unknown file primitive.
1991 (t (error "unknown file I/O primitive: %s" operation))))
1993 (defun tramp-find-foreign-file-name-handler (filename)
1994 "Return foreign file name handler if exists."
1995 (when (tramp-tramp-file-p filename)
1996 (let ((v (tramp-dissect-file-name filename t))
1997 (handler tramp-foreign-file-name-handler-alist)
1999 ;; When we are not fully sure that filename completion is safe,
2000 ;; we should not return a handler.
2001 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
2002 (and (tramp-file-name-host v)
2003 (not (member (tramp-file-name-host v)
2004 (mapcar 'car tramp-methods))))
2005 (not (tramp-completion-mode-p)))
2007 (setq elt (car handler)
2008 handler (cdr handler))
2009 (when (funcall (car elt) filename)
2016 (defun tramp-file-name-handler (operation &rest args)
2017 "Invoke Tramp file name handler.
2018 Falls back to normal file name handler if no Tramp file name handler exists."
2022 (tramp-replace-environment-variables
2023 (apply 'tramp-file-name-for-operation operation args)))
2024 (completion (tramp-completion-mode-p))
2025 (foreign (tramp-find-foreign-file-name-handler filename)))
2026 (with-parsed-tramp-file-name filename nil
2027 ;; Call the backend function.
2029 (tramp-compat-condition-case-unless-debug err
2030 (let ((sf (symbol-function foreign))
2032 ;; Some packages set the default directory to a
2033 ;; remote path, before respective Tramp packages
2034 ;; are already loaded. This results in
2035 ;; recursive loading. Therefore, we load the
2036 ;; Tramp packages locally.
2037 (when (and (listp sf) (eq (car sf) 'autoload))
2038 (let ((default-directory
2039 (tramp-compat-temporary-file-directory)))
2040 (load (cadr sf) 'noerror 'nomessage)))
2041 ;; If `non-essential' is non-nil, Tramp shall
2042 ;; not open a new connection.
2043 ;; If Tramp detects that it shouldn't continue
2044 ;; to work, it throws the `suppress' event.
2045 ;; This could happen for example, when Tramp
2046 ;; tries to open the same connection twice in a
2047 ;; short time frame.
2048 ;; In both cases, we try the default handler then.
2050 (catch 'non-essential
2052 (apply foreign operation args))))
2054 ((eq result 'non-essential)
2056 v 5 "Non-essential received in operation %s"
2057 (append (list operation) args))
2058 (tramp-run-real-handler operation args))
2059 ((eq result 'suppress)
2060 (let (tramp-message-show-message)
2062 v 1 "Suppress received in operation %s"
2063 (append (list operation) args))
2065 (tramp-run-real-handler operation args)))
2068 ;; Trace that somebody has interrupted the operation.
2070 (let (tramp-message-show-message)
2072 v 1 "Interrupt received in operation %s"
2073 (append (list operation) args)))
2074 ;; Propagate the quit signal.
2075 (signal (car err) (cdr err)))
2077 ;; When we are in completion mode, some failed
2078 ;; operations shall return at least a default value
2079 ;; in order to give the user a chance to correct the
2080 ;; file name in the minibuffer.
2081 ;; In order to get a full backtrace, one could apply
2082 ;; (setq debug-on-error t debug-on-signal t)
2085 ((and completion (zerop (length localname))
2086 (memq operation '(file-exists-p file-directory-p)))
2088 ((and completion (zerop (length localname))
2090 '(expand-file-name file-name-as-directory)))
2092 ;; Propagate the error.
2093 (t (signal (car err) (cdr err))))))
2095 ;; Nothing to do for us.
2096 (tramp-run-real-handler operation args)))))
2098 ;; When `tramp-mode' is not enabled, we don't do anything.
2099 (tramp-run-real-handler operation args)))
2101 ;; In Emacs, there is some concurrency due to timers. If a timer
2102 ;; interrupts Tramp and wishes to use the same connection buffer as
2103 ;; the "main" Emacs, then garbage might occur in the connection
2104 ;; buffer. Therefore, we need to make sure that a timer does not use
2105 ;; the same connection buffer as the "main" Emacs. We implement a
2106 ;; cheap global lock, instead of locking each connection buffer
2107 ;; separately. The global lock is based on two variables,
2108 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2109 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2110 ;; processing of a single file operation, so we need to allow
2111 ;; recursive calls. That's where the `tramp-locker' variable comes in
2112 ;; -- it is let-bound to t during the execution of the current
2113 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2114 ;; then we should just proceed because we have been called
2115 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2116 ;; interrupting the "main" Emacs, and then we signal an error.
2118 (defvar tramp-locked nil
2119 "If non-nil, then Tramp is currently busy.
2120 Together with `tramp-locker', this implements a locking mechanism
2121 preventing reentrant calls of Tramp.")
2123 (defvar tramp-locker nil
2124 "If non-nil, then a caller has locked Tramp.
2125 Together with `tramp-locked', this implements a locking mechanism
2126 preventing reentrant calls of Tramp.")
2129 (progn (defun tramp-completion-file-name-handler (operation &rest args)
2130 "Invoke Tramp file name completion handler.
2131 Falls back to normal file name handler if no Tramp file name handler exists."
2132 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
2133 ;; would otherwise use backslash.
2134 (let ((directory-sep-char ?/)
2135 (fn (assoc operation tramp-completion-file-name-handler-alist)))
2137 ;; When `tramp-mode' is not enabled, we don't do anything.
2139 ;; For other syntaxes than `sep', the regexp matches many common
2140 ;; situations where the user doesn't actually want to use Tramp.
2141 ;; So to avoid autoloading Tramp after typing just "/s", we
2142 ;; disable this part of the completion, unless the user implicitly
2143 ;; indicated his interest in using a fancier completion system.
2144 (or (eq tramp-syntax 'sep)
2145 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2146 ;; `partial-completion-mode' does not exist in XEmacs.
2147 ;; It is obsoleted with Emacs 24.1.
2148 (and (boundp 'partial-completion-mode)
2149 (symbol-value 'partial-completion-mode))
2150 ;; FIXME: These may have been loaded even if the user never
2151 ;; intended to use them.
2153 (featurep 'icicles)))
2154 (save-match-data (apply (cdr fn) args))
2155 (tramp-completion-run-real-handler operation args)))))
2158 (progn (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 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
2163 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
2165 'tramp-completion-file-name-handler 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 ;; `tramp-file-name-handler' must be registered before evaluation of
2184 ;; site-start and init files, because there might exist remote files
2185 ;; already, f.e. files kept via recentf-mode.
2187 (tramp-register-file-name-handlers)
2189 (defun tramp-exists-file-name-handler (operation &rest args)
2190 "Check, whether OPERATION runs a file name handler."
2191 ;; The file name handler is determined on base of either an
2192 ;; argument, `buffer-file-name', or `default-directory'.
2194 (let* ((buffer-file-name "/")
2195 (default-directory "/")
2196 (fnha file-name-handler-alist)
2197 (check-file-name-operation operation)
2198 (file-name-handler-alist
2201 (lambda (operation &rest args)
2202 "Returns OPERATION if it is the one to be checked."
2203 (if (equal check-file-name-operation operation)
2205 (let ((file-name-handler-alist fnha))
2206 (apply operation args))))))))
2207 (equal (apply operation args) operation))))
2210 (defun tramp-unload-file-name-handlers ()
2211 (setq file-name-handler-alist
2212 (delete (rassoc 'tramp-file-name-handler
2213 file-name-handler-alist)
2214 (delete (rassoc 'tramp-completion-file-name-handler
2215 file-name-handler-alist)
2216 file-name-handler-alist))))
2218 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2220 ;;; File name handler functions for completion mode:
2222 (defvar tramp-completion-mode nil
2223 "If non-nil, external packages signal that they are in file name completion.
2225 This is necessary, because Tramp uses a heuristic depending on last
2226 input event. This fails when external packages use other characters
2227 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2228 should never be set globally, the intention is to let-bind it.")
2230 ;; Necessary because `tramp-file-name-regexp-unified' and
2231 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2232 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2233 ;; to `tramp-file-name-handler'). Otherwise, it takes
2234 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2235 ;; risky, because completing a file might require loading other files,
2236 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2237 ;; variable. On the other hand, those files shouldn't have partial
2238 ;; Tramp file name syntax. Maybe another variable should be introduced
2239 ;; overwriting this check in such cases. Or we change Tramp file name
2240 ;; syntax in order to avoid ambiguities, like in XEmacs ...
2241 ;;;###tramp-autoload
2242 (defun tramp-completion-mode-p ()
2243 "Check, whether method / user name / host name completion is active."
2245 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2246 (and (boundp 'non-essential) (symbol-value 'non-essential))
2247 tramp-completion-mode
2249 (equal last-input-event 'tab)
2250 (and (natnump last-input-event)
2252 ;; ?\t has event-modifier 'control.
2253 (equal last-input-event ?\t)
2254 (and (not (event-modifiers last-input-event))
2255 (or (equal last-input-event ?\?)
2256 (equal last-input-event ?\ )))))
2258 (and (featurep 'xemacs)
2259 ;; `last-input-event' might be nil.
2260 (not (null last-input-event))
2261 ;; `last-input-event' may have no character approximation.
2262 (tramp-compat-funcall 'event-to-character last-input-event)
2264 ;; ?\t has event-modifier 'control.
2266 (tramp-compat-funcall 'event-to-character last-input-event) ?\t)
2267 (and (not (event-modifiers last-input-event))
2269 (tramp-compat-funcall 'event-to-character last-input-event)
2272 (tramp-compat-funcall 'event-to-character last-input-event)
2275 (defun tramp-connectable-p (filename)
2276 "Check, whether it is possible to connect the remote host w/o side-effects.
2277 This is true, if either the remote host is already connected, or if we are
2278 not in completion mode."
2279 (and (tramp-tramp-file-p filename)
2280 (with-parsed-tramp-file-name filename nil
2281 (or (not (tramp-completion-mode-p))
2282 (let ((p (tramp-get-connection-process v)))
2283 (and p (processp p) (memq (process-status p) '(run open))))))))
2285 ;; Method, host name and user name completion.
2286 ;; `tramp-completion-dissect-file-name' returns a list of
2287 ;; tramp-file-name structures. For all of them we return possible completions.
2289 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2290 "Like `file-name-all-completions' for partial Tramp files."
2293 (tramp-drop-volume-letter (expand-file-name filename directory)))
2296 ;; Suppress hop from completion.
2300 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2301 tramp-postfix-hop-regexp
2304 (setq hop (match-string 1 fullname)
2305 fullname (replace-match "" nil nil fullname 1)))
2307 ;; Possible completion structures.
2308 (dolist (elt (tramp-completion-dissect-file-name fullname))
2309 (let* ((method (tramp-file-name-method elt))
2310 (user (tramp-file-name-user elt))
2311 (host (tramp-file-name-host elt))
2312 (localname (tramp-file-name-localname elt))
2313 (m (tramp-find-method method user host))
2314 (tramp-current-user user) ; see `tramp-parse-passwd'
2317 (unless localname ;; Nothing to complete.
2321 ;; Method dependent user / host combinations.
2325 (setq all-user-hosts
2326 (append all-user-hosts
2327 (funcall (nth 0 x) (nth 1 x)))))
2328 (tramp-get-completion-function m))
2334 (tramp-get-completion-user-host
2335 method user host (nth 0 x) (nth 1 x)))
2336 (delq nil all-user-hosts)))))
2338 ;; Possible methods.
2340 (append result (tramp-get-completion-methods m)))))))
2342 ;; Unify list, add hop, remove nil elements.
2343 (dolist (elt result)
2345 (string-match tramp-prefix-regexp elt)
2346 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2349 (substring elt (length (tramp-drop-volume-letter directory))))))
2351 ;; Complete local parts.
2355 (apply (if (tramp-connectable-p fullname)
2356 'tramp-completion-run-real-handler
2357 'tramp-run-real-handler)
2358 'file-name-all-completions (list (list filename directory)))))))
2360 ;; Method, host name and user name completion for a file.
2362 (defun tramp-completion-handle-file-name-completion
2363 (filename directory &optional predicate)
2364 "Like `file-name-completion' for Tramp files."
2367 (mapcar 'list (file-name-all-completions filename directory))
2368 (when (and predicate
2369 (tramp-connectable-p (expand-file-name filename directory)))
2370 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2372 ;; I misuse a little bit the tramp-file-name structure in order to handle
2373 ;; completion possibilities for partial methods / user names / host names.
2374 ;; Return value is a list of tramp-file-name structures according to possible
2375 ;; completions. If "localname" is non-nil it means there
2376 ;; shouldn't be a completion anymore.
2378 ;; Expected results:
2380 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2381 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2382 ;; [nil "x" nil nil]
2383 ;; ["x" nil nil nil]
2385 ;; "/x:" "/x:y" "/x:y:"
2386 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2388 ;; ["x" nil "" nil] ["x" nil "y" nil]
2389 ;; ["x" "" nil nil] ["x" "y" nil nil]
2391 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2392 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2393 ;; "/[x/y@" "/[x/y@z"
2394 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2395 (defun tramp-completion-dissect-file-name (name)
2396 "Returns a list of `tramp-file-name' structures.
2397 They are collected by `tramp-completion-dissect-file-name1'."
2401 (tramp-completion-ipv6-regexp
2404 (if (zerop (length tramp-postfix-ipv6-format))
2405 tramp-postfix-host-format
2406 tramp-postfix-ipv6-format)))
2407 ;; "/method" "/[method"
2408 (tramp-completion-file-name-structure1
2409 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2412 (tramp-completion-file-name-structure2
2413 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2416 (tramp-completion-file-name-structure3
2417 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2419 ;; "/[ipv6" "/[ipv6"
2420 (tramp-completion-file-name-structure4
2421 (list (concat tramp-prefix-regexp
2422 tramp-prefix-ipv6-regexp
2423 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2425 ;; "/user@host" "/[user@host"
2426 (tramp-completion-file-name-structure5
2427 (list (concat tramp-prefix-regexp
2428 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2429 "\\(" tramp-host-regexp x-nil "\\)$")
2431 ;; "/user@[ipv6" "/[user@ipv6"
2432 (tramp-completion-file-name-structure6
2433 (list (concat tramp-prefix-regexp
2434 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2435 tramp-prefix-ipv6-regexp
2436 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2438 ;; "/method:user" "/[method/user" "/method://user"
2439 (tramp-completion-file-name-structure7
2440 (list (concat tramp-prefix-regexp
2441 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2442 "\\(" tramp-user-regexp x-nil "\\)$")
2444 ;; "/method:host" "/[method/host" "/method://host"
2445 (tramp-completion-file-name-structure8
2446 (list (concat tramp-prefix-regexp
2447 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2448 "\\(" tramp-host-regexp x-nil "\\)$")
2450 ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6"
2451 (tramp-completion-file-name-structure9
2452 (list (concat tramp-prefix-regexp
2453 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2454 tramp-prefix-ipv6-regexp
2455 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2457 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
2458 (tramp-completion-file-name-structure10
2459 (list (concat tramp-prefix-regexp
2460 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2461 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2462 "\\(" tramp-host-regexp x-nil "\\)$")
2464 ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6"
2465 (tramp-completion-file-name-structure11
2466 (list (concat tramp-prefix-regexp
2467 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2468 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2469 tramp-prefix-ipv6-regexp
2470 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2472 ;; "/method: "/method:/"
2473 (tramp-completion-file-name-structure12
2475 (if (equal tramp-syntax 'url)
2476 (concat tramp-prefix-regexp
2477 "\\(" tramp-method-regexp "\\)"
2478 "\\(" (substring tramp-postfix-method-regexp 0 1)
2479 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
2481 ;; Should not match if not URL syntax.
2482 (concat tramp-prefix-regexp "/$"))
2484 ;; "/method: "/method:/"
2485 (tramp-completion-file-name-structure13
2487 (if (equal tramp-syntax 'url)
2488 (concat tramp-prefix-regexp
2489 "\\(" tramp-method-regexp "\\)"
2490 "\\(" (substring tramp-postfix-method-regexp 0 1)
2491 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
2493 ;; Should not match if not URL syntax.
2494 (concat tramp-prefix-regexp "/$"))
2497 (mapc (lambda (structure)
2498 (add-to-list 'result
2499 (tramp-completion-dissect-file-name1 structure name)))
2501 tramp-completion-file-name-structure1
2502 tramp-completion-file-name-structure2
2503 tramp-completion-file-name-structure3
2504 tramp-completion-file-name-structure4
2505 tramp-completion-file-name-structure5
2506 tramp-completion-file-name-structure6
2507 tramp-completion-file-name-structure7
2508 tramp-completion-file-name-structure8
2509 tramp-completion-file-name-structure9
2510 tramp-completion-file-name-structure10
2511 tramp-completion-file-name-structure11
2512 tramp-completion-file-name-structure12
2513 tramp-completion-file-name-structure13
2514 tramp-file-name-structure))
2518 (defun tramp-completion-dissect-file-name1 (structure name)
2519 "Returns a `tramp-file-name' structure matching STRUCTURE.
2520 The structure consists of remote method, remote user,
2521 remote host and localname (filename on remote host)."
2524 (when (string-match (nth 0 structure) name)
2525 (let ((method (and (nth 1 structure)
2526 (match-string (nth 1 structure) name)))
2527 (user (and (nth 2 structure)
2528 (match-string (nth 2 structure) name)))
2529 (host (and (nth 3 structure)
2530 (match-string (nth 3 structure) name)))
2531 (localname (and (nth 4 structure)
2532 (match-string (nth 4 structure) name))))
2533 (vector method user host localname nil)))))
2535 ;; This function returns all possible method completions, adding the
2536 ;; trailing method delimiter.
2537 (defun tramp-get-completion-methods (partial-method)
2538 "Returns all method completions for PARTIAL-METHOD."
2542 (string-match (concat "^" (regexp-quote partial-method)) method)
2543 (tramp-completion-make-tramp-file-name method nil nil nil)))
2544 (mapcar 'car tramp-methods)))
2546 ;; Compares partial user and host names with possible completions.
2547 (defun tramp-get-completion-user-host
2548 (method partial-user partial-host user host)
2549 "Returns the most expanded string for user and host name completion.
2550 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2553 ((and partial-user partial-host)
2555 (string-match (concat "^" (regexp-quote partial-host)) host)
2556 (string-equal partial-user (or user partial-user)))
2557 (setq user partial-user)
2564 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2570 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2576 (unless (zerop (+ (length user) (length host)))
2577 (tramp-completion-make-tramp-file-name method user host nil)))
2579 ;; Generic function.
2580 (defun tramp-parse-group (regexp match-level skip-regexp)
2581 "Return a (user host) tuple allowed to access.
2582 User is always nil."
2584 (when (re-search-forward regexp (point-at-eol) t)
2585 (setq result (list nil (match-string match-level))))
2587 (> (skip-chars-forward skip-regexp) 0)
2591 ;; Generic function.
2592 (defun tramp-parse-file (filename function)
2593 "Return a list of (user host) tuples allowed to access.
2594 User is always nil."
2595 ;; On Windows, there are problems in completion when
2596 ;; `default-directory' is remote.
2597 (let ((default-directory (tramp-compat-temporary-file-directory)))
2598 (when (file-readable-p filename)
2600 (insert-file-contents filename)
2601 (goto-char (point-min))
2602 (loop while (not (eobp)) collect (funcall function))))))
2604 ;;;###tramp-autoload
2605 (defun tramp-parse-rhosts (filename)
2606 "Return a list of (user host) tuples allowed to access.
2607 Either user or host may be nil."
2608 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2610 (defun tramp-parse-rhosts-group ()
2611 "Return a (user host) tuple allowed to access.
2612 Either user or host may be nil."
2616 "^\\(" tramp-host-regexp "\\)"
2617 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2618 (when (re-search-forward regexp (point-at-eol) t)
2619 (setq result (append (list (match-string 3) (match-string 1)))))
2623 ;;;###tramp-autoload
2624 (defun tramp-parse-shosts (filename)
2625 "Return a list of (user host) tuples allowed to access.
2626 User is always nil."
2627 (tramp-parse-file filename 'tramp-parse-shosts-group))
2629 (defun tramp-parse-shosts-group ()
2630 "Return a (user host) tuple allowed to access.
2631 User is always nil."
2632 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2634 ;;;###tramp-autoload
2635 (defun tramp-parse-sconfig (filename)
2636 "Return a list of (user host) tuples allowed to access.
2637 User is always nil."
2638 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2640 (defun tramp-parse-sconfig-group ()
2641 "Return a (user host) tuple allowed to access.
2642 User is always nil."
2644 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2646 ;; Generic function.
2647 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2648 "Return a list of (user host) tuples allowed to access.
2649 User is always nil."
2650 ;; On Windows, there are problems in completion when
2651 ;; `default-directory' is remote.
2652 (let* ((default-directory (tramp-compat-temporary-file-directory))
2653 (files (and (file-directory-p dirname) (directory-files dirname))))
2654 (loop for f in files
2655 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2656 collect (list nil (match-string 1 f)))))
2658 ;;;###tramp-autoload
2659 (defun tramp-parse-shostkeys (dirname)
2660 "Return a list of (user host) tuples allowed to access.
2661 User is always nil."
2662 (tramp-parse-shostkeys-sknownhosts
2663 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2665 ;;;###tramp-autoload
2666 (defun tramp-parse-sknownhosts (dirname)
2667 "Return a list of (user host) tuples allowed to access.
2668 User is always nil."
2669 (tramp-parse-shostkeys-sknownhosts
2671 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2673 ;;;###tramp-autoload
2674 (defun tramp-parse-hosts (filename)
2675 "Return a list of (user host) tuples allowed to access.
2676 User is always nil."
2677 (tramp-parse-file filename 'tramp-parse-hosts-group))
2679 (defun tramp-parse-hosts-group ()
2680 "Return a (user host) tuple allowed to access.
2681 User is always nil."
2683 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2685 ;; For su-alike methods it would be desirable to return "root@localhost"
2686 ;; as default. Unfortunately, we have no information whether any user name
2687 ;; has been typed already. So we use `tramp-current-user' as indication,
2688 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
2689 ;;;###tramp-autoload
2690 (defun tramp-parse-passwd (filename)
2691 "Return a list of (user host) tuples allowed to access.
2692 Host is always \"localhost\"."
2693 (if (zerop (length tramp-current-user))
2695 (tramp-parse-file filename 'tramp-parse-passwd-group)))
2697 (defun tramp-parse-passwd-group ()
2698 "Return a (user host) tuple allowed to access.
2699 Host is always \"localhost\"."
2701 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2702 (when (re-search-forward regexp (point-at-eol) t)
2703 (setq result (list (match-string 1) "localhost")))
2707 ;;;###tramp-autoload
2708 (defun tramp-parse-netrc (filename)
2709 "Return a list of (user host) tuples allowed to access.
2711 (tramp-parse-file filename 'tramp-parse-netrc-group))
2713 (defun tramp-parse-netrc-group ()
2714 "Return a (user host) tuple allowed to access.
2719 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2720 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2721 (when (re-search-forward regexp (point-at-eol) t)
2722 (setq result (list (match-string 3) (match-string 1))))
2726 ;;;###tramp-autoload
2727 (defun tramp-parse-putty (registry-or-dirname)
2728 "Return a list of (user host) tuples allowed to access.
2729 User is always nil."
2730 (if (memq system-type '(windows-nt))
2732 (when (zerop (tramp-compat-call-process
2733 "reg" nil t nil "query" registry-or-dirname))
2734 (goto-char (point-min))
2735 (loop while (not (eobp)) collect
2736 (tramp-parse-putty-group registry-or-dirname))))
2738 (tramp-parse-shostkeys-sknownhosts
2739 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2741 (defun tramp-parse-putty-group (registry)
2742 "Return a (user host) tuple allowed to access.
2743 User is always nil."
2745 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2746 (when (re-search-forward regexp (point-at-eol) t)
2747 (setq result (list nil (match-string 1))))
2751 ;;; Common file name handler functions for different backends:
2753 (defvar tramp-handle-file-local-copy-hook nil
2754 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2756 (defvar tramp-handle-write-region-hook nil
2757 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2759 (defun tramp-handle-directory-file-name (directory)
2760 "Like `directory-file-name' for Tramp files."
2761 ;; If localname component of filename is "/", leave it unchanged.
2762 ;; Otherwise, remove any trailing slash from localname component.
2763 ;; Method, host, etc, are unchanged. Does it make sense to try
2764 ;; to avoid parsing the filename?
2765 (with-parsed-tramp-file-name directory nil
2766 (if (and (not (zerop (length localname)))
2767 (eq (aref localname (1- (length localname))) ?/)
2768 (not (string= localname "/")))
2769 (substring directory 0 -1)
2772 (defun tramp-handle-directory-files
2773 (directory &optional full match nosort files-only)
2774 "Like `directory-files' for Tramp files."
2775 ;; FILES-ONLY is valid for XEmacs only.
2776 (when (file-directory-p directory)
2777 (setq directory (file-name-as-directory (expand-file-name directory)))
2778 (let ((temp (nreverse (file-name-all-completions "" directory)))
2782 (setq item (directory-file-name (pop temp)))
2783 (when (and (or (null match) (string-match match item))
2784 (or (null files-only)
2786 (and (equal files-only t) (file-regular-p item))
2787 ;; Directories only.
2788 (file-directory-p item)))
2789 (push (if full (concat directory item) item)
2791 (if nosort result (sort result 'string<)))))
2793 (defun tramp-handle-directory-files-and-attributes
2794 (directory &optional full match nosort id-format)
2795 "Like `directory-files-and-attributes' for Tramp files."
2798 (cons x (tramp-compat-file-attributes
2799 (if full x (expand-file-name x directory)) id-format)))
2800 (directory-files directory full match nosort)))
2802 (defun tramp-handle-dired-uncache (dir &optional dir-p)
2803 "Like `dired-uncache' for Tramp files."
2804 ;; DIR-P is valid for XEmacs only.
2805 (with-parsed-tramp-file-name
2806 (if (or dir-p (file-directory-p dir)) dir (file-name-directory dir)) nil
2807 (tramp-flush-directory-property v localname)))
2809 (defun tramp-handle-file-accessible-directory-p (filename)
2810 "Like `file-accessible-directory-p' for Tramp files."
2811 (and (file-directory-p filename)
2812 (file-executable-p filename)))
2814 (defun tramp-handle-file-exists-p (filename)
2815 "Like `file-exists-p' for Tramp files."
2816 (not (null (file-attributes filename))))
2818 (defun tramp-handle-file-modes (filename)
2819 "Like `file-modes' for Tramp files."
2820 (let ((truename (or (file-truename filename) filename)))
2821 (when (file-exists-p truename)
2822 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2824 ;; Localname manipulation functions that grok Tramp localnames...
2825 (defun tramp-handle-file-name-as-directory (file)
2826 "Like `file-name-as-directory' but aware of Tramp files."
2827 ;; `file-name-as-directory' would be sufficient except localname is
2828 ;; the empty string.
2829 (let ((v (tramp-dissect-file-name file t)))
2830 ;; Run the command on the localname portion only.
2831 (tramp-make-tramp-file-name
2832 (tramp-file-name-method v)
2833 (tramp-file-name-user v)
2834 (tramp-file-name-host v)
2835 (tramp-run-real-handler
2836 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))))
2838 (defun tramp-handle-file-name-completion
2839 (filename directory &optional predicate)
2840 "Like `file-name-completion' for Tramp files."
2841 (unless (tramp-tramp-file-p directory)
2843 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2847 (mapcar 'list (file-name-all-completions filename directory))
2849 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2851 (defun tramp-handle-file-name-directory (file)
2852 "Like `file-name-directory' but aware of Tramp files."
2853 ;; Everything except the last filename thing is the directory. We
2854 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2855 ;; the remote file name parts. This is a problem when we are in
2856 ;; file name completion.
2857 (let ((v (tramp-dissect-file-name file t)))
2858 ;; Run the command on the localname portion only.
2859 (tramp-make-tramp-file-name
2860 (tramp-file-name-method v)
2861 (tramp-file-name-user v)
2862 (tramp-file-name-host v)
2863 (tramp-run-real-handler
2864 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2866 (defun tramp-handle-file-name-nondirectory (file)
2867 "Like `file-name-nondirectory' but aware of Tramp files."
2868 (with-parsed-tramp-file-name file nil
2869 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2871 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2872 "Like `file-newer-than-file-p' for Tramp files."
2874 ((not (file-exists-p file1)) nil)
2875 ((not (file-exists-p file2)) t)
2876 (t (tramp-time-less-p (nth 5 (file-attributes file2))
2877 (nth 5 (file-attributes file1))))))
2879 (defun tramp-handle-file-regular-p (filename)
2880 "Like `file-regular-p' for Tramp files."
2881 (and (file-exists-p filename)
2882 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2884 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2885 "Like `file-remote-p' for Tramp files."
2886 (let ((tramp-verbose 3))
2887 (when (tramp-tramp-file-p filename)
2888 (let* ((v (tramp-dissect-file-name filename))
2889 (p (tramp-get-connection-process v))
2890 (c (and p (processp p) (memq (process-status p) '(run open)))))
2891 ;; We expand the file name only, if there is already a connection.
2892 (with-parsed-tramp-file-name
2893 (if c (expand-file-name filename) filename) nil
2894 (and (or (not connected) c)
2896 ((eq identification 'method) method)
2897 ((eq identification 'user) user)
2898 ((eq identification 'host) host)
2899 ((eq identification 'localname) localname)
2900 (t (tramp-make-tramp-file-name method user host "")))))))))
2902 (defun tramp-handle-file-symlink-p (filename)
2903 "Like `file-symlink-p' for Tramp files."
2904 (with-parsed-tramp-file-name filename nil
2905 (let ((x (car (file-attributes filename))))
2907 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2908 ;; might do weird things.
2909 (if (file-name-absolute-p x)
2910 (tramp-make-tramp-file-name method user host x)
2913 (defun tramp-handle-find-backup-file-name (filename)
2914 "Like `find-backup-file-name' for Tramp files."
2915 (with-parsed-tramp-file-name filename nil
2916 ;; We set both variables. It doesn't matter whether it is
2918 (let ((backup-directory-alist
2920 (when (boundp 'backup-directory-alist)
2921 (if (symbol-value 'tramp-backup-directory-alist)
2926 (if (and (stringp (cdr x))
2927 (file-name-absolute-p (cdr x))
2928 (not (tramp-file-name-p (cdr x))))
2929 (tramp-make-tramp-file-name method user host (cdr x))
2931 (symbol-value 'tramp-backup-directory-alist))
2932 (symbol-value 'backup-directory-alist))))
2934 (bkup-backup-directory-info
2936 (when (boundp 'bkup-backup-directory-info)
2937 (if (symbol-value 'tramp-bkup-backup-directory-info)
2943 (if (and (stringp (car (cdr x)))
2944 (file-name-absolute-p (car (cdr x)))
2945 (not (tramp-file-name-p (car (cdr x)))))
2946 (tramp-make-tramp-file-name
2947 method user host (car (cdr x)))
2950 (symbol-value 'tramp-bkup-backup-directory-info))
2951 (symbol-value 'bkup-backup-directory-info)))))
2953 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2955 (defun tramp-handle-insert-file-contents
2956 (filename &optional visit beg end replace)
2957 "Like `insert-file-contents' for Tramp files."
2958 (barf-if-buffer-read-only)
2959 (setq filename (expand-file-name filename))
2960 (let (result local-copy remote-copy)
2961 (with-parsed-tramp-file-name filename nil
2962 (with-tramp-progress-reporter
2963 v 3 (format "Inserting `%s'" filename)
2965 (if (not (file-exists-p filename))
2966 ;; We don't raise a Tramp error, because it might be
2967 ;; suppressed, like in `find-file-noselect-1'.
2969 (list "File not found on remote host" 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
2984 (setq remote-copy (tramp-make-tramp-temp-file v))
2985 ;; This is defined in tramp-sh.el. Let's assume
2986 ;; this is loaded already.
2987 (tramp-compat-funcall
2992 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
2993 beg (tramp-shell-quote-argument localname)
2994 (- end beg) remote-copy))
2996 (format "dd bs=1 skip=%d if=%s of=%s"
2997 beg (tramp-shell-quote-argument localname)
3000 (format "dd bs=1 count=%d if=%s of=%s"
3001 end (tramp-shell-quote-argument localname)
3004 ;; `insert-file-contents-literally' takes care to
3005 ;; avoid calling jka-compr. By let-binding
3006 ;; `inhibit-file-name-operation', we propagate that
3007 ;; care to the `file-local-copy' operation.
3009 (let ((inhibit-file-name-operation
3010 (when (eq inhibit-file-name-operation
3011 'insert-file-contents)
3014 ((stringp remote-copy)
3016 (tramp-make-tramp-file-name
3017 method user host remote-copy)))
3018 ((stringp tramp-temp-buffer-file-name)
3019 (copy-file filename tramp-temp-buffer-file-name 'ok)
3020 tramp-temp-buffer-file-name)
3021 (t (file-local-copy filename)))))
3023 ;; When the file is not readable for the owner, it
3024 ;; cannot be inserted, even if it is readable for the
3025 ;; group or for everybody.
3027 local-copy (tramp-compat-octal-to-decimal "0600"))
3029 (when (and (null remote-copy)
3030 (tramp-get-method-parameter
3031 method 'tramp-copy-keep-tmpfile))
3032 ;; We keep the local file for performance reasons,
3033 ;; useful for "rsync".
3034 (setq tramp-temp-buffer-file-name local-copy))
3036 ;; We must ensure that `file-coding-system-alist'
3037 ;; matches `local-copy'. We must also use `visit',
3038 ;; otherwise there might be an error in the
3039 ;; `revert-buffer' function under XEmacs.
3040 (let ((file-coding-system-alist
3041 (tramp-find-file-name-coding-system-alist
3042 filename local-copy)))
3044 (insert-file-contents
3045 local-copy visit nil nil replace)))))
3050 (setq buffer-file-name filename)
3051 (setq buffer-read-only (not (file-writable-p filename)))
3052 (set-visited-file-modtime)
3053 (set-buffer-modified-p nil))
3054 (when (and (stringp local-copy)
3055 (or remote-copy (null tramp-temp-buffer-file-name)))
3056 (delete-file local-copy))
3057 (when (stringp remote-copy)
3059 (tramp-make-tramp-file-name method user host remote-copy)))))))
3062 (list (expand-file-name filename)
3065 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3066 "Like `load' for Tramp files."
3067 (with-parsed-tramp-file-name (expand-file-name file) nil
3069 (cond ((file-exists-p (concat file ".elc"))
3070 (setq file (concat file ".elc")))
3071 ((file-exists-p (concat file ".el"))
3072 (setq file (concat file ".el")))))
3074 ;; The first condition is always true for absolute file names.
3075 ;; Included for safety's sake.
3076 (unless (or (file-name-directory file)
3077 (string-match "\\.elc?\\'" file))
3080 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3082 (when (not (file-exists-p file))
3083 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
3084 (if (not (file-exists-p file))
3086 (let ((tramp-message-show-message (not nomessage)))
3087 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3088 (let ((local-copy (file-local-copy file)))
3089 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
3091 (load local-copy noerror t t)
3092 (delete-file local-copy)))))
3095 (defun tramp-handle-shell-command
3096 (command &optional output-buffer error-buffer)
3097 "Like `shell-command' for Tramp files."
3098 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3099 ;; We cannot use `shell-file-name' and `shell-command-switch',
3100 ;; they are variables of the local host.
3103 (tramp-get-method-parameter
3104 (tramp-file-name-method
3105 (tramp-dissect-file-name default-directory))
3106 'tramp-remote-shell)
3107 (tramp-get-method-parameter
3108 (tramp-file-name-method
3109 (tramp-dissect-file-name default-directory))
3110 'tramp-remote-shell-args))
3111 (list (substring command 0 asynchronous))))
3115 ((bufferp output-buffer) output-buffer)
3116 ((stringp output-buffer) (get-buffer-create output-buffer))
3118 (setq current-buffer-p t)
3120 (t (get-buffer-create
3122 "*Async Shell Command*"
3123 "*Shell Command Output*")))))
3126 ((bufferp error-buffer) error-buffer)
3127 ((stringp error-buffer) (get-buffer-create error-buffer))))
3129 (if (and (not asynchronous) error-buffer)
3130 (with-parsed-tramp-file-name default-directory nil
3131 (list output-buffer (tramp-make-tramp-temp-file v)))
3133 (p (get-buffer-process output-buffer)))
3135 ;; Check whether there is another process running. Tramp does not
3136 ;; support 2 (asynchronous) processes in parallel.
3138 (if (yes-or-no-p "A command is running. Kill it? ")
3139 (ignore-errors (kill-process p))
3140 (error "Shell command in progress")))
3142 (if current-buffer-p
3144 (barf-if-buffer-read-only)
3146 (with-current-buffer output-buffer
3147 (setq buffer-read-only nil)
3150 (if (and (not current-buffer-p) (integerp asynchronous))
3153 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3155 (pop-to-buffer output-buffer)
3156 (setq mode-line-process '(":%s"))
3158 (set-process-sentinel p 'shell-command-sentinel)
3159 (set-process-filter p 'comint-output-filter))
3163 (apply 'process-file (car args) nil buffer nil (cdr args))
3164 ;; Insert error messages if they were separated.
3165 (when (listp buffer)
3166 (with-current-buffer error-buffer
3167 (insert-file-contents (cadr buffer)))
3168 (delete-file (cadr buffer)))
3169 (if current-buffer-p
3170 ;; This is like exchange-point-and-mark, but doesn't
3171 ;; activate the mark. It is cleaner to avoid activation,
3172 ;; even though the command loop would deactivate the mark
3173 ;; because we inserted text.
3174 (goto-char (prog1 (mark t)
3175 (set-marker (mark-marker) (point)
3177 ;; There's some output, display it.
3178 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3179 (if (functionp 'display-message-or-buffer)
3180 (tramp-compat-funcall 'display-message-or-buffer output-buffer)
3181 (pop-to-buffer output-buffer))))))))
3183 (defun tramp-handle-substitute-in-file-name (filename)
3184 "Like `substitute-in-file-name' for Tramp files.
3185 \"//\" and \"/~\" substitute only in the local filename part.
3186 If the URL Tramp syntax is chosen, \"//\" as method delimiter and \"/~\" at
3187 beginning of local filename are not substituted."
3188 ;; First, we must replace environment variables.
3189 (setq filename (tramp-replace-environment-variables filename))
3190 (with-parsed-tramp-file-name filename nil
3191 (if (equal tramp-syntax 'url)
3192 ;; We need to check localname only. The other parts cannot contain
3194 (if (and (> (length localname) 1)
3195 (or (string-match "//" localname)
3196 (string-match "/~" localname 1)))
3197 (tramp-run-real-handler 'substitute-in-file-name (list filename))
3198 (tramp-make-tramp-file-name
3199 (when method (substitute-in-file-name method))
3200 (when user (substitute-in-file-name user))
3201 (when host (substitute-in-file-name host))
3203 (tramp-run-real-handler
3204 'substitute-in-file-name (list localname)))))
3205 ;; Ignore in LOCALNAME everything before "//" or "/~".
3206 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3208 (concat (file-remote-p filename)
3209 (replace-match "\\1" nil nil localname)))
3210 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3211 (when (string-match "~$" filename)
3212 (setq filename (concat filename "/"))))
3213 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3215 (defun tramp-handle-unhandled-file-name-directory (filename)
3216 "Like `unhandled-file-name-directory' for Tramp files."
3217 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3218 ;; for backward compatibility.
3219 (expand-file-name "~/"))
3221 ;;; Functions for establishing connection:
3223 ;; The following functions are actions to be taken when seeing certain
3224 ;; prompts from the remote host. See the variable
3225 ;; `tramp-actions-before-shell' for usage of these functions.
3227 (defun tramp-action-login (proc vec)
3228 "Send the login name."
3229 (when (not (stringp tramp-current-user))
3230 (setq tramp-current-user
3231 (with-tramp-connection-property vec "login-as"
3232 (save-window-excursion
3233 (let ((enable-recursive-minibuffers t))
3234 (pop-to-buffer (tramp-get-connection-buffer vec))
3235 (read-string (match-string 0)))))))
3236 (with-current-buffer (tramp-get-connection-buffer vec)
3237 (tramp-message vec 6 "\n%s" (buffer-string)))
3238 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3239 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3241 (defun tramp-action-password (proc vec)
3242 "Query the user for a password."
3243 (with-current-buffer (process-buffer proc)
3244 (let ((enable-recursive-minibuffers t))
3245 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3246 (tramp-message vec 3 "Sending %s" (match-string 1))
3247 ;; We don't call `tramp-send-string' in order to hide the
3248 ;; password from the debug buffer.
3249 (process-send-string
3250 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3251 ;; Hide password prompt.
3252 (narrow-to-region (point-max) (point-max)))))
3254 (defun tramp-action-succeed (proc vec)
3255 "Signal success in finding shell prompt."
3256 (throw 'tramp-action 'ok))
3258 (defun tramp-action-permission-denied (proc vec)
3259 "Signal permission denied."
3261 (throw 'tramp-action 'permission-denied))
3263 (defun tramp-action-yesno (proc vec)
3264 "Ask the user for confirmation using `yes-or-no-p'.
3265 Send \"yes\" to remote process on confirmation, abort otherwise.
3266 See also `tramp-action-yn'."
3267 (save-window-excursion
3268 (let ((enable-recursive-minibuffers t))
3269 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3270 (unless (yes-or-no-p (match-string 0))
3272 (throw 'tramp-action 'permission-denied))
3273 (with-current-buffer (tramp-get-connection-buffer vec)
3274 (tramp-message vec 6 "\n%s" (buffer-string)))
3275 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3277 (defun tramp-action-yn (proc vec)
3278 "Ask the user for confirmation using `y-or-n-p'.
3279 Send \"y\" to remote process on confirmation, abort otherwise.
3280 See also `tramp-action-yesno'."
3281 (save-window-excursion
3282 (let ((enable-recursive-minibuffers t))
3283 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3284 (unless (y-or-n-p (match-string 0))
3286 (throw 'tramp-action 'permission-denied))
3287 (with-current-buffer (tramp-get-connection-buffer vec)
3288 (tramp-message vec 6 "\n%s" (buffer-string)))
3289 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3291 (defun tramp-action-terminal (proc vec)
3292 "Tell the remote host which terminal type to use.
3293 The terminal type can be configured with `tramp-terminal-type'."
3294 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3295 (with-current-buffer (tramp-get-connection-buffer vec)
3296 (tramp-message vec 6 "\n%s" (buffer-string)))
3297 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3299 (defun tramp-action-process-alive (proc vec)
3300 "Check, whether a process has finished."
3301 (unless (memq (process-status proc) '(run open))
3302 (throw 'tramp-action 'process-died)))
3304 (defun tramp-action-out-of-band (proc vec)
3305 "Check, whether an out-of-band copy has finished."
3306 (cond ((and (memq (process-status proc) '(stop exit))
3307 (zerop (process-exit-status proc)))
3308 (tramp-message vec 3 "Process has finished.")
3309 (throw 'tramp-action 'ok))
3310 ((or (and (memq (process-status proc) '(stop exit))
3311 (not (zerop (process-exit-status proc))))
3312 (memq (process-status proc) '(signal)))
3313 ;; `scp' could have copied correctly, but set modes could have failed.
3314 ;; This can be ignored.
3315 (with-current-buffer (process-buffer proc)
3316 (goto-char (point-min))
3317 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3319 (tramp-message vec 5 "'set mode' error ignored.")
3320 (tramp-message vec 3 "Process has finished.")
3321 (throw 'tramp-action 'ok))
3322 (tramp-message vec 3 "Process has died.")
3323 (throw 'tramp-action 'process-died))))
3326 ;;; Functions for processing the actions:
3328 (defun tramp-process-one-action (proc vec actions)
3329 "Wait for output from the shell and perform one action."
3330 (let (found todo item pattern action)
3332 ;; Reread output once all actions have been performed.
3333 ;; Obviously, the output was not complete.
3334 (tramp-accept-process-output proc 1)
3337 (setq item (pop todo))
3338 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3339 (setq action (nth 1 item))
3341 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3342 (when (tramp-check-for-regexp proc pattern)
3343 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3344 (setq found (funcall action proc vec)))))
3347 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3348 "Perform ACTIONS until success or TIMEOUT.
3349 PROC and VEC indicate the remote connection to be used. POS, if
3350 set, is the starting point of the region to be deleted in the
3352 ;; Preserve message for `progress-reporter'.
3353 (tramp-compat-with-temp-message ""
3354 ;; Enable `auth-source' and `password-cache'. We must use
3355 ;; tramp-current-* variables in case we have several hops.
3356 (tramp-set-connection-property
3357 (tramp-dissect-file-name
3358 (tramp-make-tramp-file-name
3359 tramp-current-method tramp-current-user tramp-current-host ""))
3360 "first-password-request" t)
3364 (tramp-message proc 3 "Waiting for prompts from remote shell")
3366 (catch 'tramp-action
3368 (with-timeout (timeout)
3369 (tramp-process-one-action proc vec actions))
3370 (tramp-process-one-action proc vec actions)))))
3371 (with-current-buffer (tramp-get-connection-buffer vec)
3373 (tramp-message vec 6 "\n%s" (buffer-string)))
3374 (unless (eq exit 'ok)
3375 (tramp-clear-passwd vec)
3376 (tramp-error-with-buffer
3379 ((eq exit 'permission-denied) "Permission denied")
3380 ((eq exit 'process-died) "Process died")
3381 (t "Login failed"))))
3383 (with-current-buffer (tramp-get-connection-buffer vec)
3384 (let (buffer-read-only) (delete-region pos (point)))))))))
3386 :;; Utility functions:
3388 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3389 "Like `accept-process-output' for Tramp processes.
3390 This is needed in order to hide `last-coding-system-used', which is set
3391 for process communication also."
3392 (with-current-buffer (process-buffer proc)
3393 (tramp-message proc 10 "%s %s" proc (process-status proc))
3394 (let (buffer-read-only last-coding-system-used)
3395 ;; Under Windows XP, accept-process-output doesn't return
3396 ;; sometimes. So we add an additional timeout.
3397 (with-timeout ((or timeout 1))
3398 (if (featurep 'xemacs)
3399 (accept-process-output proc timeout timeout-msecs)
3400 (accept-process-output proc timeout timeout-msecs (and proc t)))))
3401 (tramp-message proc 10 "\n%s" (buffer-string))))
3403 (defun tramp-check-for-regexp (proc regexp)
3404 "Check, whether REGEXP is contained in process buffer of PROC.
3405 Erase echoed commands if exists."
3406 (with-current-buffer (process-buffer proc)
3407 (goto-char (point-min))
3409 ;; Check whether we need to remove echo output.
3410 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3411 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3412 (let ((begin (match-beginning 0)))
3413 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3414 ;; Discard echo from remote output.
3415 (tramp-set-connection-property proc "check-remote-echo" nil)
3416 (tramp-message proc 5 "echo-mark found")
3418 (delete-region begin (point))
3419 (goto-char (point-min)))))
3421 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3422 ;; Sometimes, the echo string is suppressed on the remote side.
3424 (tramp-compat-funcall
3425 'substring-no-properties tramp-echo-mark-marker
3426 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3427 (tramp-compat-funcall
3428 'buffer-substring-no-properties
3430 (min (+ (point-min) tramp-echo-mark-marker-length)
3432 ;; No echo to be handled, now we can look for the regexp.
3433 ;; Sometimes, lines are much to long, and we run into a "Stack
3434 ;; overflow in regexp matcher". For example, //DIRED// lines of
3435 ;; directory listings with some thousand files. Therefore, we
3436 ;; look from the end.
3437 (goto-char (point-max))
3438 (ignore-errors (re-search-backward regexp nil t)))))
3440 (defun tramp-wait-for-regexp (proc timeout regexp)
3441 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3442 Expects the output of PROC to be sent to the current buffer. Returns
3443 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3445 (with-current-buffer (process-buffer proc)
3446 (let ((found (tramp-check-for-regexp proc regexp))
3447 (start-time (current-time)))
3449 ;; Work around a bug in XEmacs 21, where the timeout
3450 ;; expires faster than it should. This degenerates
3451 ;; to polling for buggy XEmacsen, but oh, well.
3452 (while (and (not found)
3453 (< (tramp-time-diff (current-time) start-time)
3455 (with-timeout (timeout)
3457 (tramp-accept-process-output proc 1)
3458 (unless (memq (process-status proc) '(run open))
3459 (tramp-error-with-buffer
3460 nil proc 'file-error "Process has died"))
3461 (setq found (tramp-check-for-regexp proc regexp))))))
3464 (tramp-accept-process-output proc 1)
3465 (unless (memq (process-status proc) '(run open))
3466 (tramp-error-with-buffer
3467 nil proc 'file-error "Process has died"))
3468 (setq found (tramp-check-for-regexp proc regexp)))))
3469 (tramp-message proc 6 "\n%s" (buffer-string))
3473 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3475 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3478 ;; It seems that Tru64 Unix does not like it if long strings are sent
3479 ;; to it in one go. (This happens when sending the Perl
3480 ;; `file-attributes' implementation, for instance.) Therefore, we
3481 ;; have this function which sends the string in chunks.
3482 (defun tramp-send-string (vec string)
3483 "Send the STRING via connection VEC.
3485 The STRING is expected to use Unix line-endings, but the lines sent to
3486 the remote host use line-endings as defined in the variable
3487 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3488 (let* ((p (tramp-get-connection-process vec))
3489 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3492 vec 'file-error "Can't send string to remote host -- not logged in"))
3493 (tramp-set-connection-property p "last-cmd-time" (current-time))
3494 (tramp-message vec 10 "%s" string)
3495 (with-current-buffer (tramp-get-connection-buffer vec)
3496 ;; Clean up the buffer. We cannot call `erase-buffer' because
3497 ;; narrowing might be in effect.
3498 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3499 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3501 (mapconcat 'identity
3502 (tramp-compat-split-string string "\n")
3503 tramp-rsh-end-of-line))
3504 (unless (or (string= string "")
3505 (string-equal (substring string -1) tramp-rsh-end-of-line))
3506 (setq string (concat string tramp-rsh-end-of-line)))
3508 (if (and chunksize (not (zerop chunksize)))
3510 (end (length string)))
3513 vec 10 "Sending chunk from %s to %s"
3514 pos (min (+ pos chunksize) end))
3515 (process-send-string
3516 p (substring string pos (min (+ pos chunksize) end)))
3517 (setq pos (+ pos chunksize))))
3518 (process-send-string p string)))))
3520 (defun tramp-get-inode (vec)
3521 "Returns the virtual inode number.
3522 If it doesn't exist, generate a new one."
3523 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3524 (setq tramp-inodes (1+ tramp-inodes))))
3526 (defun tramp-get-device (vec)
3527 "Returns the virtual device number.
3528 If it doesn't exist, generate a new one."
3529 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3530 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3532 (defun tramp-equal-remote (file1 file2)
3533 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3534 The check depends on method, user and host name of the files. If
3535 one of the components is missing, the default values are used.
3536 The local file name parts of FILE1 and FILE2 are not taken into
3541 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3543 would yield `t'. On the other hand, the following check results in nil:
3545 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3546 (and (stringp (file-remote-p file1))
3547 (stringp (file-remote-p file2))
3548 (string-equal (file-remote-p file1) (file-remote-p file2))))
3550 ;;;###tramp-autoload
3551 (defun tramp-mode-string-to-int (mode-string)
3552 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3553 (let* (case-fold-search
3554 (mode-chars (string-to-vector mode-string))
3555 (owner-read (aref mode-chars 1))
3556 (owner-write (aref mode-chars 2))
3557 (owner-execute-or-setid (aref mode-chars 3))
3558 (group-read (aref mode-chars 4))
3559 (group-write (aref mode-chars 5))
3560 (group-execute-or-setid (aref mode-chars 6))
3561 (other-read (aref mode-chars 7))
3562 (other-write (aref mode-chars 8))
3563 (other-execute-or-sticky (aref mode-chars 9)))
3567 ((char-equal owner-read ?r) (tramp-compat-octal-to-decimal "00400"))
3568 ((char-equal owner-read ?-) 0)
3569 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3571 ((char-equal owner-write ?w) (tramp-compat-octal-to-decimal "00200"))
3572 ((char-equal owner-write ?-) 0)
3573 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3575 ((char-equal owner-execute-or-setid ?x)
3576 (tramp-compat-octal-to-decimal "00100"))
3577 ((char-equal owner-execute-or-setid ?S)
3578 (tramp-compat-octal-to-decimal "04000"))
3579 ((char-equal owner-execute-or-setid ?s)
3580 (tramp-compat-octal-to-decimal "04100"))
3581 ((char-equal owner-execute-or-setid ?-) 0)
3582 (t (error "Fourth char `%c' must be one of `xsS-'"
3583 owner-execute-or-setid)))
3585 ((char-equal group-read ?r) (tramp-compat-octal-to-decimal "00040"))
3586 ((char-equal group-read ?-) 0)
3587 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3589 ((char-equal group-write ?w) (tramp-compat-octal-to-decimal "00020"))
3590 ((char-equal group-write ?-) 0)
3591 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3593 ((char-equal group-execute-or-setid ?x)
3594 (tramp-compat-octal-to-decimal "00010"))
3595 ((char-equal group-execute-or-setid ?S)
3596 (tramp-compat-octal-to-decimal "02000"))
3597 ((char-equal group-execute-or-setid ?s)
3598 (tramp-compat-octal-to-decimal "02010"))
3599 ((char-equal group-execute-or-setid ?-) 0)
3600 (t (error "Seventh char `%c' must be one of `xsS-'"
3601 group-execute-or-setid)))
3603 ((char-equal other-read ?r)
3604 (tramp-compat-octal-to-decimal "00004"))
3605 ((char-equal other-read ?-) 0)
3606 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3608 ((char-equal other-write ?w) (tramp-compat-octal-to-decimal "00002"))
3609 ((char-equal other-write ?-) 0)
3610 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3612 ((char-equal other-execute-or-sticky ?x)
3613 (tramp-compat-octal-to-decimal "00001"))
3614 ((char-equal other-execute-or-sticky ?T)
3615 (tramp-compat-octal-to-decimal "01000"))
3616 ((char-equal other-execute-or-sticky ?t)
3617 (tramp-compat-octal-to-decimal "01001"))
3618 ((char-equal other-execute-or-sticky ?-) 0)
3619 (t (error "Tenth char `%c' must be one of `xtT-'"
3620 other-execute-or-sticky)))))))
3622 ;;;###tramp-autoload
3623 (defun tramp-local-host-p (vec)
3624 "Return t if this points to the local host, nil otherwise."
3625 ;; We cannot use `tramp-file-name-real-host'. A port is an
3626 ;; indication for an ssh tunnel or alike.
3627 (let ((host (tramp-file-name-host vec)))
3630 (string-match tramp-local-host-regexp host)
3631 ;; The method shall be applied to one of the shell file name
3632 ;; handler. `tramp-local-host-p' is also called for "smb" and
3633 ;; alike, where it must fail.
3634 (tramp-get-method-parameter
3635 (tramp-file-name-method vec) 'tramp-login-program)
3636 ;; The local temp directory must be writable for the other user.
3638 (tramp-make-tramp-file-name
3639 (tramp-file-name-method vec)
3640 (tramp-file-name-user vec)
3642 (tramp-compat-temporary-file-directory)))
3643 ;; On some systems, chown runs only for root.
3644 (or (zerop (user-uid))
3645 ;; This is defined in tramp-sh.el. Let's assume this is
3647 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3649 (defun tramp-get-remote-tmpdir (vec)
3650 "Return directory for temporary files on the remote host identified by VEC."
3651 (with-tramp-connection-property vec "tmpdir"
3652 (let ((dir (tramp-make-tramp-file-name
3653 (tramp-file-name-method vec)
3654 (tramp-file-name-user vec)
3655 (tramp-file-name-host vec)
3657 (tramp-get-method-parameter
3658 (tramp-file-name-method vec) 'tramp-tmpdir)
3660 (if (and (file-directory-p dir) (file-writable-p dir))
3662 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
3664 ;;;###tramp-autoload
3665 (defun tramp-make-tramp-temp-file (vec)
3666 "Create a temporary file on the remote host identified by VEC.
3667 Return the local name of the temporary file."
3668 (let ((prefix (expand-file-name
3669 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3672 ;; `make-temp-file' would be the natural choice for
3673 ;; implementation. But it calls `write-region' internally,
3674 ;; which also needs a temporary file - we would end in an
3676 (setq result (make-temp-name prefix))
3677 (if (file-exists-p result)
3679 ;; This creates the file by side effect.
3680 (set-file-times result)
3681 (set-file-modes result (tramp-compat-octal-to-decimal "0700"))))
3683 ;; Return the local part.
3684 (with-parsed-tramp-file-name result nil localname)))
3686 (defun tramp-delete-temp-file-function ()
3687 "Remove temporary files related to current buffer."
3688 (when (stringp tramp-temp-buffer-file-name)
3689 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3691 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3692 (add-hook 'tramp-unload-hook
3694 (remove-hook 'kill-buffer-hook
3695 'tramp-delete-temp-file-function)))
3697 ;;; Auto saving to a special directory:
3699 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
3700 (defadvice make-auto-save-file-name
3701 (around tramp-advice-make-auto-save-file-name () activate)
3702 "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files."
3703 (if (tramp-tramp-file-p (buffer-file-name))
3704 ;; We cannot call `tramp-handle-make-auto-save-file-name'
3705 ;; directly, because this would bypass the locking mechanism.
3706 (setq ad-return-value
3707 (tramp-file-name-handler 'make-auto-save-file-name))
3713 'make-auto-save-file-name
3714 'around 'tramp-advice-make-auto-save-file-name)
3715 (ad-activate 'make-auto-save-file-name))))
3717 ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus
3718 ;; umask. This is a security threat.
3720 (defun tramp-set-auto-save-file-modes ()
3721 "Set permissions of autosaved remote files to the original permissions."
3722 (let ((bfn (buffer-file-name)))
3723 (when (and (tramp-tramp-file-p bfn)
3725 (stringp buffer-auto-save-file-name)
3726 (not (equal bfn buffer-auto-save-file-name)))
3727 (unless (file-exists-p buffer-auto-save-file-name)
3728 (write-region "" nil buffer-auto-save-file-name))
3729 ;; Permissions should be set always, because there might be an old
3730 ;; auto-saved file belonging to another original file. This could
3731 ;; be a security threat.
3733 buffer-auto-save-file-name
3734 (or (file-modes bfn) (tramp-compat-octal-to-decimal "0600"))))))
3736 (unless (and (featurep 'xemacs)
3737 (= emacs-major-version 21)
3738 (> emacs-minor-version 4))
3739 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
3740 (add-hook 'tramp-unload-hook
3742 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
3744 (defun tramp-subst-strs-in-string (alist string)
3745 "Replace all occurrences of the string FROM with TO in STRING.
3746 ALIST is of the form ((FROM . TO) ...)."
3749 (let* ((pr (car alist))
3752 (while (string-match (regexp-quote from) string)
3753 (setq string (replace-match to t t string)))
3754 (setq alist (cdr alist))))
3757 ;;; Compatibility functions section:
3759 ;;;###tramp-autoload
3760 (defun tramp-read-passwd (proc &optional prompt)
3761 "Read a password from user (compat function).
3762 Consults the auth-source package.
3763 Invokes `password-read' if available, `read-passwd' else."
3764 (let* ((key (tramp-make-tramp-file-name
3765 tramp-current-method tramp-current-user
3766 tramp-current-host ""))
3769 (with-current-buffer (process-buffer proc)
3770 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3771 (format "%s for %s " (capitalize (match-string 1)) key))))
3772 auth-info auth-passwd)
3773 (with-parsed-tramp-file-name key nil
3776 ;; See if auth-sources contains something useful, if it's
3777 ;; bound. `auth-source-user-or-password' is an obsoleted
3778 ;; function, it has been replaced by `auth-source-search'.
3779 (and (boundp 'auth-sources)
3780 (tramp-get-connection-property v "first-password-request" nil)
3781 ;; Try with Tramp's current method.
3782 (if (fboundp 'auth-source-search)
3784 (tramp-compat-funcall
3787 :user (or tramp-current-user t)
3788 :host tramp-current-host
3789 :port tramp-current-method)
3790 auth-passwd (plist-get (nth 0 auth-info) :secret)
3791 auth-passwd (if (functionp auth-passwd)
3792 (funcall auth-passwd)
3794 (tramp-compat-funcall
3795 'auth-source-user-or-password
3796 "password" tramp-current-host tramp-current-method)))
3797 ;; Try the password cache.
3798 (when (functionp 'password-read)
3799 (unless (tramp-get-connection-property
3800 v "first-password-request" nil)
3801 (tramp-compat-funcall 'password-cache-remove key))
3803 (tramp-compat-funcall 'password-read pw-prompt key)))
3804 (tramp-compat-funcall 'password-cache-add key password)
3806 ;; Else, get the password interactively.
3807 (read-passwd pw-prompt))
3808 (tramp-set-connection-property v "first-password-request" nil)))))
3810 ;;;###tramp-autoload
3811 (defun tramp-clear-passwd (vec)
3812 "Clear password cache for connection related to VEC."
3813 (tramp-compat-funcall
3814 'password-cache-remove
3815 (tramp-make-tramp-file-name
3816 (tramp-file-name-method vec)
3817 (tramp-file-name-user vec)
3818 (tramp-file-name-host vec)
3821 ;; Snarfed code from time-date.el and parse-time.el
3823 (defconst tramp-half-a-year '(241 17024)
3824 "Evaluated by \"(days-to-time 183)\".")
3826 (defconst tramp-parse-time-months
3827 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
3828 ("apr" . 4) ("may" . 5) ("jun" . 6)
3829 ("jul" . 7) ("aug" . 8) ("sep" . 9)
3830 ("oct" . 10) ("nov" . 11) ("dec" . 12))
3831 "Alist mapping month names to integers.")
3833 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
3834 ;;;###tramp-autoload
3835 (defun tramp-time-less-p (t1 t2)
3836 "Say whether time value T1 is less than time value T2."
3837 (unless t1 (setq t1 '(0 0)))
3838 (unless t2 (setq t2 '(0 0)))
3839 (or (< (car t1) (car t2))
3840 (and (= (car t1) (car t2))
3841 (< (nth 1 t1) (nth 1 t2)))))
3843 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
3844 (defun tramp-time-subtract (t1 t2)
3845 "Subtract two time values.
3846 Return the difference in the format of a time value."
3847 (unless t1 (setq t1 '(0 0)))
3848 (unless t2 (setq t2 '(0 0)))
3849 (let ((borrow (< (cadr t1) (cadr t2))))
3850 (list (- (car t1) (car t2) (if borrow 1 0))
3851 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
3853 ;;;###tramp-autoload
3854 (defun tramp-time-diff (t1 t2)
3855 "Return the difference between the two times, in seconds.
3856 T1 and T2 are time values (as returned by `current-time' for example)."
3857 (cond ((and (fboundp 'subtract-time)
3858 (fboundp 'float-time))
3859 (tramp-compat-funcall
3860 'float-time (tramp-compat-funcall 'subtract-time t1 t2)))
3861 ((and (fboundp 'subtract-time)
3862 (fboundp 'time-to-seconds))
3863 (tramp-compat-funcall
3864 'time-to-seconds (tramp-compat-funcall 'subtract-time t1 t2)))
3865 ((fboundp 'itimer-time-difference)
3866 (tramp-compat-funcall
3867 'itimer-time-difference
3868 (if (< (length t1) 3) (append t1 '(0)) t1)
3869 (if (< (length t2) 3) (append t2 '(0)) t2)))
3871 (let ((time (tramp-time-subtract t1 t2)))
3872 (+ (* (car time) 65536.0)
3874 (/ (or (nth 2 time) 0) 1000000.0))))))
3876 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
3877 ;; does not deal well with newline characters. Newline is replaced by
3878 ;; backslash newline. But if, say, the string `a backslash newline b'
3879 ;; is passed to a shell, the shell will expand this into "ab",
3880 ;; completely omitting the newline. This is not what was intended.
3881 ;; It does not appear to be possible to make the function
3882 ;; `shell-quote-argument' work with newlines without making it
3883 ;; dependent on the shell used. But within this package, we know that
3884 ;; we will always use a Bourne-like shell, so we use an approach which
3887 ;; The approach is simple: we call `shell-quote-argument', then
3888 ;; massage the newline part of the result.
3890 ;; This function should produce a string which is grokked by a Unix
3891 ;; shell, even if the Emacs is running on Windows. Since this is the
3892 ;; kludges section, we bind `system-type' in such a way that
3893 ;; `shell-quote-arguments' behaves as if on Unix.
3895 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
3896 ;; function to work with Bourne-like shells.
3898 ;; CCC: This function should be rewritten so that
3899 ;; `shell-quote-argument' is not used. This way, we are safe from
3900 ;; changes in `shell-quote-argument'.
3901 ;;;###tramp-autoload
3902 (defun tramp-shell-quote-argument (s)
3903 "Similar to `shell-quote-argument', but groks newlines.
3904 Only works for Bourne-like shells."
3905 (let ((system-type 'not-windows))
3907 (let ((result (shell-quote-argument s))
3908 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
3909 (when (and (>= (length result) 2)
3910 (string= (substring result 0 2) "\\~"))
3911 (setq result (substring result 1)))
3912 (while (string-match nl result)
3913 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
3917 ;;; Integration of eshell.el:
3920 (defvar eshell-path-env))
3922 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
3923 ;; when `default-directory' points to another host.
3924 (defun tramp-eshell-directory-change ()
3925 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
3926 (setq eshell-path-env
3927 (if (file-remote-p default-directory)
3928 (with-parsed-tramp-file-name default-directory nil
3932 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
3933 ;; the remote path is only set in the session cache.
3934 (tramp-get-connection-property
3935 (tramp-get-connection-process v) "remote-path" nil)
3936 (tramp-get-connection-property v "remote-path" nil))
3940 (eval-after-load "esh-util"
3942 (tramp-eshell-directory-change)
3943 (add-hook 'eshell-directory-change-hook
3944 'tramp-eshell-directory-change)
3945 (add-hook 'tramp-unload-hook
3947 (remove-hook 'eshell-directory-change-hook
3948 'tramp-eshell-directory-change)))))
3950 ;; Checklist for `tramp-unload-hook'
3951 ;; - Unload all `tramp-*' packages
3952 ;; - Reset `file-name-handler-alist'
3953 ;; - Cleanup hooks where Tramp functions are in
3954 ;; - Cleanup advised functions
3955 ;; - Cleanup autoloads
3957 (defun tramp-unload-tramp ()
3958 "Discard Tramp from loading remote files."
3960 ;; ange-ftp settings must be enabled.
3961 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
3962 ;; Maybe it's not loaded yet.
3963 (ignore-errors (unload-feature 'tramp 'force)))
3969 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
3970 ;; `shell-quote-argument'.
3971 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
3972 ;; by the files in that directory. Add this here.
3973 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
3974 ;; * abbreviate-file-name
3975 ;; * Better error checking. At least whenever we see something
3976 ;; strange when doing zerop, we should kill the process and start
3977 ;; again. (Greg Stark)
3978 ;; * Username and hostname completion.
3979 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
3980 ;; * Make `tramp-default-user' obsolete.
3981 ;; * Implement a general server-local-variable mechanism, as there are
3982 ;; probably other variables that need different values for different
3983 ;; servers too. The user could then configure a variable (such as
3984 ;; tramp-server-local-variable-alist) to define any such variables
3985 ;; that they need to, which would then be let bound as appropriate
3986 ;; in tramp functions. (Jason Rumney)
3987 ;; * IMHO, it's a drawback that currently Tramp doesn't support
3988 ;; Unicode in Dired file names by default. Is it possible to
3989 ;; improve Tramp to set LC_ALL to "C" only for commands where Tramp
3990 ;; expects English? Or just to set LC_MESSAGES to "C" if Tramp
3991 ;; expects only English messages? (Juri Linkov)
3992 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
3993 ;; * I was wondering if it would be possible to use tramp even if I'm
3994 ;; actually using sshfs. But when I launch a command I would like
3995 ;; to get it executed on the remote machine where the files really
3996 ;; are. (Andrea Crotti)
3997 ;; * Run emerge on two remote files. Bug is described here:
3998 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4001 ;;; tramp.el ends here