1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2014 Free Software Foundation, Inc.
5 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
6 ;; Michael Albinus <michael.albinus@gmx.de>
7 ;; Keywords: comm, processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This package provides remote file editing, similar to ange-ftp.
28 ;; The difference is that ange-ftp uses FTP to transfer files between
29 ;; the local and the remote host, whereas tramp.el uses a combination
30 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
32 ;; For more detailed instructions, please see the info file.
37 ;; This package only works for Emacs 22.1 and higher, and for XEmacs 21.4
38 ;; and higher. For XEmacs 21, you need the package `fsf-compat' for
39 ;; the `with-timeout' macro.
41 ;; Also see the todo list at the bottom of this file.
43 ;; The current version of Tramp can be retrieved from the following URL:
44 ;; http://ftp.gnu.org/gnu/tramp/
46 ;; There's a mailing list for this, as well. Its name is:
47 ;; tramp-devel@gnu.org
48 ;; You can use the Web to subscribe, under the following URL:
49 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
51 ;; For the adventurous, the current development sources are available
52 ;; via 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 (require 'tramp-compat
)
62 ;; Pacify byte-compiler.
65 (defvar bkup-backup-directory-info
)
66 (defvar directory-sep-char
)
67 (defvar eshell-path-env
)
68 (defvar file-notify-descriptors
)
69 (defvar outline-regexp
)
71 ;;; User Customizable Internal Variables:
74 "Edit remote files with a combination of ssh, scp, etc."
79 ;; Maybe we need once a real Tramp mode, with key bindings etc.
81 (defcustom tramp-mode t
82 "Whether Tramp is enabled.
83 If it is set to nil, all remote file names are used literally."
87 (defcustom tramp-verbose
3
88 "Verbosity level for Tramp messages.
89 Any level x includes messages for all levels 1 .. x-1. The levels are
91 0 silent (no tramp messages at all)
94 3 connection to remote hosts (default level)
97 6 sent and received strings
99 8 connection properties
107 (when (boundp 'backup-directory-alist
)
108 (defcustom tramp-backup-directory-alist nil
109 "Alist of filename patterns and backup directory names.
110 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
111 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
112 is a local file name, the backup directory is prepended with Tramp file
113 name prefix \(method, user, host\) of file.
115 \(setq tramp-backup-directory-alist backup-directory-alist\)
117 gives the same backup policy for Tramp files on their hosts like the
118 policy for local files."
120 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
121 (directory :tag
"Backup directory name"))))))
123 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
124 ;; the package "backup-dir" might not be loaded yet.
126 (when (featurep 'xemacs
)
127 (defcustom tramp-bkup-backup-directory-info nil
128 "Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
129 It has the same meaning like `bkup-backup-directory-info' from package
130 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
131 file name, the backup directory is prepended with Tramp file name prefix
132 \(method, user, host\) of file.
134 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
136 gives the same backup policy for Tramp files on their hosts like the
137 policy for local files."
139 (list (regexp :tag
"File regexp")
140 (string :tag
"Backup Dir")
145 (const search-upward
))))
148 (defcustom tramp-auto-save-directory nil
149 "Put auto-save files in this directory, if set.
150 The idea is to use a local directory so that auto-saving is faster."
152 :type
'(choice (const nil
) string
))
154 (defcustom tramp-encoding-shell
155 (if (memq system-type
'(windows-nt))
158 "Use this program for encoding and decoding commands on the local host.
159 This shell is used to execute the encoding and decoding command on the
160 local host, so if you want to use `~' in those commands, you should
161 choose a shell here which groks tilde expansion. `/bin/sh' normally
162 does not understand tilde expansion.
164 For encoding and decoding, commands like the following are executed:
166 /bin/sh -c COMMAND < INPUT > OUTPUT
168 This variable can be used to change the \"/bin/sh\" part. See the
169 variable `tramp-encoding-command-switch' for the \"-c\" part.
171 If the shell must be forced to be interactive, see
172 `tramp-encoding-command-interactive'.
174 Note that this variable is not used for remote commands. There are
175 mechanisms in tramp.el which automatically determine the right shell to
176 use for the remote host."
178 :type
'(file :must-match t
))
180 (defcustom tramp-encoding-command-switch
181 (if (string-match "cmd\\.exe" tramp-encoding-shell
)
184 "Use this switch together with `tramp-encoding-shell' for local commands.
185 See the variable `tramp-encoding-shell' for more information."
189 (defcustom tramp-encoding-command-interactive
190 (unless (string-match "cmd\\.exe" tramp-encoding-shell
) "-i")
191 "Use this switch together with `tramp-encoding-shell' for interactive shells.
192 See the variable `tramp-encoding-shell' for more information."
195 :type
'(choice (const nil
) string
))
198 (defvar tramp-methods nil
199 "Alist of methods for remote files.
200 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
201 Each NAME stands for a remote access method. Each PARAM is a
202 pair of the form (KEY VALUE). The following KEYs are defined:
203 * `tramp-remote-shell'
204 This specifies the shell to use on the remote host. This
205 MUST be a Bourne-like shell. It is normally not necessary to
206 set this to any value other than \"/bin/sh\": Tramp wants to
207 use a shell which groks tilde expansion, but it can search
208 for it. Also note that \"/bin/sh\" exists on all Unixen,
209 this might not be true for the value that you decide to use.
210 You Have Been Warned.
211 * `tramp-remote-shell-args'
212 For implementation of `shell-command', this specifies the
213 arguments to let `tramp-remote-shell' run a single command.
214 * `tramp-login-program'
215 This specifies the name of the program to use for logging in to the
216 remote host. This may be the name of rsh or a workalike program,
217 or the name of telnet or a workalike, or the name of su or a workalike.
219 This specifies the list of arguments to pass to the above
220 mentioned program. Please note that this is a list of list of arguments,
221 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
222 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
223 There are some patterns: \"%h\" in this list is replaced by the host
224 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
225 port number, and \"%%\" can be used to obtain a literal percent character.
226 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
227 expansion (i.e. no host or no user specified), this list is not used as
228 argument. By this, arguments like (\"-l\" \"%u\") are optional.
229 \"%t\" is replaced by the temporary file name produced with
230 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
231 parameter of a program, if exists. \"%c\" adds additional
232 `tramp-ssh-controlmaster-options' options for the first hop.
234 When an asynchronous process is started, we know already that
235 the connection works. Therefore, we can pass additional
236 parameters to suppress diagnostic messages, in order not to
237 tamper the process output.
238 * `tramp-copy-program'
239 This specifies the name of the program to use for remotely copying
240 the file; this might be the absolute filename of rcp or the name of
243 This specifies the list of parameters to pass to the above mentioned
244 program, the hints for `tramp-login-args' also apply here.
245 * `tramp-copy-keep-date'
246 This specifies whether the copying program when the preserves the
247 timestamp of the original file.
248 * `tramp-copy-keep-tmpfile'
249 This specifies whether a temporary local file shall be kept
250 for optimization reasons (useful for \"rsync\" methods).
251 * `tramp-copy-recursive'
252 Whether the operation copies directories recursively.
253 * `tramp-default-port'
254 The default port of a method is needed in case of gateway connections.
255 Additionally, it is used as indication which method is prepared for
258 As the attribute name says, additional arguments are specified here
259 when a method is applied via a gateway.
261 A directory on the remote host for temporary files. If not
262 specified, \"/tmp\" is taken as default.
263 * `tramp-connection-timeout'
264 This is the maximum time to be spent for establishing a connection.
265 In general, the global default value shall be used, but for
266 some methods, like \"su\" or \"sudo\", a shorter timeout
269 What does all this mean? Well, you should specify `tramp-login-program'
270 for all methods; this program is used to log in to the remote site. Then,
271 there are two ways to actually transfer the files between the local and the
272 remote side. One way is using an additional rcp-like program. If you want
273 to do this, set `tramp-copy-program' in the method.
275 Another possibility for file transfer is inline transfer, i.e. the
276 file is passed through the same buffer used by `tramp-login-program'. In
277 this case, the file contents need to be protected since the
278 `tramp-login-program' might use escape codes or the connection might not
279 be eight-bit clean. Therefore, file contents are encoded for transit.
280 See the variables `tramp-local-coding-commands' and
281 `tramp-remote-coding-commands' for details.
283 So, to summarize: if the method is an out-of-band method, then you
284 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
285 inline method, then these two parameters should be nil. Methods which
286 are fit for gateways must have `tramp-default-port' at least.
290 When using `su' or `sudo' the phrase `open connection to a remote
291 host' sounds strange, but it is used nevertheless, for consistency.
292 No connection is opened to a remote host, but `su' or `sudo' is
293 started on the local host. You should specify a remote host
294 `localhost' or the name of the local host. Another host name is
295 useful only in combination with `tramp-default-proxies-alist'.")
298 (defconst tramp-ssh-controlmaster-options
302 (call-process "ssh" nil t nil
"-o" "ControlMaster")
303 (goto-char (point-min))
304 (when (search-forward-regexp "Missing ControlMaster argument" nil t
)
305 (setq result
"-o ControlPath=%t.%%r@%%h:%%p -o ControlMaster=auto")))
308 (call-process "ssh" nil t nil
"-o" "ControlPersist")
309 (goto-char (point-min))
310 (when (search-forward-regexp "Missing ControlPersist argument" nil t
)
311 (setq result
(concat result
" -o ControlPersist=no"))))))
313 "Call ssh to detect whether it supports the Control* arguments.
314 Return a string to be used in `tramp-methods'.")
317 (defcustom tramp-use-ssh-controlmaster-options
318 (not (zerop (length tramp-ssh-controlmaster-options
)))
319 "Whether to use `tramp-ssh-controlmaster-options'."
324 (defcustom tramp-default-method
325 ;; An external copy method seems to be preferred, because it performs
326 ;; much better for large files, and it hasn't too serious delays
327 ;; for small files. But it must be ensured that there aren't
328 ;; permanent password queries. Either a password agent like
329 ;; "ssh-agent" or "Pageant" shall run, or the optional
330 ;; password-cache.el or auth-sources.el packages shall be active for
331 ;; password caching. If we detect that the user is running OpenSSH
332 ;; 4.0 or newer, we could reuse the connection, which calls also for
333 ;; an external method.
335 ;; PuTTY is installed. We don't take it, if it is installed on a
336 ;; non-windows system, or pscp from the pssh (parallel ssh) package
338 ((and (eq system-type
'windows-nt
)
339 (executable-find "pscp"))
340 (if (or (fboundp 'password-read
)
341 (fboundp 'auth-source-user-or-password
)
342 (fboundp 'auth-source-search
)
343 ;; Pageant is running.
344 (tramp-compat-process-running-p "Pageant"))
347 ;; There is an ssh installation.
348 ((executable-find "scp")
349 (if (or (fboundp 'password-read
)
350 (fboundp 'auth-source-user-or-password
)
351 (fboundp 'auth-source-search
)
352 ;; ssh-agent is running.
353 (getenv "SSH_AUTH_SOCK")
354 (getenv "SSH_AGENT_PID")
355 ;; We could reuse the connection.
356 (> (length tramp-ssh-controlmaster-options
) 0))
361 "Default method to use for transferring files.
362 See `tramp-methods' for possibilities.
363 Also see `tramp-default-method-alist'."
368 (defcustom tramp-default-method-alist nil
369 "Default method to use for specific host/user pairs.
370 This is an alist of items (HOST USER METHOD). The first matching item
371 specifies the method to use for a file name which does not specify a
372 method. HOST and USER are regular expressions or nil, which is
373 interpreted as a regular expression which always matches. If no entry
374 matches, the variable `tramp-default-method' takes effect.
376 If the file name does not specify the user, lookup is done using the
377 empty string for the user name.
379 See `tramp-methods' for a list of possibilities for METHOD."
381 :type
'(repeat (list (choice :tag
"Host regexp" regexp sexp
)
382 (choice :tag
"User regexp" regexp sexp
)
383 (choice :tag
"Method name" string
(const nil
)))))
385 (defcustom tramp-default-user nil
386 "Default user to use for transferring files.
387 It is nil by default; otherwise settings in configuration files like
388 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
390 This variable is regarded as obsolete, and will be removed soon."
392 :type
'(choice (const nil
) string
))
395 (defcustom tramp-default-user-alist nil
396 "Default user to use for specific method/host pairs.
397 This is an alist of items (METHOD HOST USER). The first matching item
398 specifies the user to use for a file name which does not specify a
399 user. METHOD and USER are regular expressions or nil, which is
400 interpreted as a regular expression which always matches. If no entry
401 matches, the variable `tramp-default-user' takes effect.
403 If the file name does not specify the method, lookup is done using the
404 empty string for the method name."
406 :type
'(repeat (list (choice :tag
"Method regexp" regexp sexp
)
407 (choice :tag
" Host regexp" regexp sexp
)
408 (choice :tag
" User name" string
(const nil
)))))
410 (defcustom tramp-default-host
(system-name)
411 "Default host to use for transferring files.
412 Useful for su and sudo methods mostly."
417 (defcustom tramp-default-host-alist nil
418 "Default host to use for specific method/user pairs.
419 This is an alist of items (METHOD USER HOST). The first matching item
420 specifies the host to use for a file name which does not specify a
421 host. METHOD and HOST are regular expressions or nil, which is
422 interpreted as a regular expression which always matches. If no entry
423 matches, the variable `tramp-default-host' takes effect.
425 If the file name does not specify the method, lookup is done using the
426 empty string for the method name."
429 :type
'(repeat (list (choice :tag
"Method regexp" regexp sexp
)
430 (choice :tag
" User regexp" regexp sexp
)
431 (choice :tag
" Host name" string
(const nil
)))))
433 (defcustom tramp-default-proxies-alist nil
434 "Route to be followed for specific host/user pairs.
435 This is an alist of items (HOST USER PROXY). The first matching
436 item specifies the proxy to be passed for a file name located on
437 a remote target matching USER@HOST. HOST and USER are regular
438 expressions. PROXY must be a Tramp filename without a localname
439 part. Method and user name on PROXY are optional, which is
440 interpreted with the default values. PROXY can contain the
441 patterns %h and %u, which are replaced by the strings matching
442 HOST or USER, respectively.
444 HOST, USER or PROXY could also be Lisp forms, which will be
445 evaluated. The result must be a string or nil, which is
446 interpreted as a regular expression which always matches."
448 :type
'(repeat (list (choice :tag
"Host regexp" regexp sexp
)
449 (choice :tag
"User regexp" regexp sexp
)
450 (choice :tag
" Proxy name" string
(const nil
)))))
452 (defcustom tramp-save-ad-hoc-proxies nil
453 "Whether to save ad-hoc proxies persistently."
458 (defcustom tramp-restricted-shell-hosts-alist
459 (when (memq system-type
'(windows-nt))
460 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
461 "List of hosts, which run a restricted shell.
462 This is a list of regular expressions, which denote hosts running
463 a registered shell like \"rbash\". Those hosts can be used as
464 proxies only, see `tramp-default-proxies-alist'. If the local
465 host runs a registered shell, it shall be added to this list, too."
468 :type
'(repeat (regexp :tag
"Host regexp")))
471 (defconst tramp-local-host-regexp
475 (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t
)
477 "Host names which are regarded as local host.")
479 (defvar tramp-completion-function-alist nil
480 "Alist of methods for remote files.
481 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\).
482 Each NAME stands for a remote access method. Each PAIR is of the form
483 \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host
484 names from FILE for completion. The following predefined FUNCTIONs exists:
486 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
487 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
488 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
489 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
490 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
491 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
492 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
493 * `tramp-parse-netrc' for \"~/.netrc\" like files.
494 * `tramp-parse-putty' for PuTTY registered sessions.
496 FUNCTION can also be a customer defined function. For more details see
499 (defconst tramp-echo-mark-marker
"_echo"
500 "String marker to surround echoed commands.")
502 (defconst tramp-echo-mark-marker-length
(length tramp-echo-mark-marker
)
503 "String length of `tramp-echo-mark-marker'.")
505 (defconst tramp-echo-mark
506 (concat tramp-echo-mark-marker
507 (make-string tramp-echo-mark-marker-length ?
\b))
508 "String mark to be transmitted around shell commands.
509 Used to separate their echo from the output they produce. This
510 will only be used if we cannot disable remote echo via stty.
511 This string must have no effect on the remote shell except for
512 producing some echo which can later be detected by
513 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
514 followed by an equal number of backspaces to erase them will
517 (defconst tramp-echoed-echo-mark-regexp
518 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
519 tramp-echo-mark-marker tramp-echo-mark-marker-length
)
520 "Regexp which matches `tramp-echo-mark' as it gets echoed by
523 (defcustom tramp-local-end-of-line
524 (if (memq system-type
'(windows-nt)) "\r\n" "\n")
525 "String used for end of line in local processes."
530 (defcustom tramp-rsh-end-of-line
"\n"
531 "String used for end of line in rsh connections.
532 I don't think this ever needs to be changed, so please tell me about it
533 if you need to change this."
537 (defcustom tramp-login-prompt-regexp
538 ".*ogin\\( .*\\)?: *"
539 "Regexp matching login-like prompts.
540 The regexp should match at end of buffer.
542 Sometimes the prompt is reported to look like \"login as:\"."
546 (defcustom tramp-shell-prompt-pattern
547 ;; Allow a prompt to start right after a ^M since it indeed would be
548 ;; displayed at the beginning of the line (and Zsh uses it). This
549 ;; regexp works only for GNU Emacs.
550 ;; Allow also [] style prompts. They can appear only during
551 ;; connection initialization; Tramp redefines the prompt afterwards.
552 (concat (if (featurep 'xemacs
) "" "\\(?:^\\|\r\\)")
553 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
554 "Regexp to match prompts from remote shell.
555 Normally, Tramp expects you to configure `shell-prompt-pattern'
556 correctly, but sometimes it happens that you are connecting to a
557 remote host which sends a different kind of shell prompt. Therefore,
558 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
559 and also things matched by this variable. The default value of this
560 variable is similar to the default value of `shell-prompt-pattern',
561 which should work well in many cases.
563 This regexp must match both `tramp-initial-end-of-output' and
564 `tramp-end-of-output'."
568 (defcustom tramp-password-prompt-regexp
569 (format "^.*\\(%s\\).*:\^@? *"
570 (if (boundp 'password-word-equivalents
)
571 (regexp-opt (symbol-value 'password-word-equivalents
))
572 "password\\|passphrase"))
573 "Regexp matching password-like prompts.
574 The regexp should match at end of buffer.
576 The `sudo' program appears to insert a `^@' character into the prompt."
580 (defcustom tramp-wrong-passwd-regexp
582 ;; These strings should be on the last line
583 (regexp-opt '("Permission denied"
588 "Timeout, server not responding."
590 "Name or service not known"
591 "Host key verification failed."
592 "No supported authentication methods left to try!") t
)
596 ;; Here comes a list of regexes, separated by \\|
597 "Received signal [0-9]+"
599 "Regexp matching a `login failed' message.
600 The regexp should match at end of buffer."
604 (defcustom tramp-yesno-prompt-regexp
606 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t
)
608 "Regular expression matching all yes/no queries which need to be confirmed.
609 The confirmation should be done with yes or no.
610 The regexp should match at end of buffer.
611 See also `tramp-yn-prompt-regexp'."
615 (defcustom tramp-yn-prompt-regexp
617 (regexp-opt '("Store key in cache? (y/n)"
618 "Update cached key? (y/n, Return cancels connection)") t
)
620 "Regular expression matching all y/n queries which need to be confirmed.
621 The confirmation should be done with y or n.
622 The regexp should match at end of buffer.
623 See also `tramp-yesno-prompt-regexp'."
627 (defcustom tramp-terminal-prompt-regexp
631 "Terminal type\\? \\[.*\\]"
633 "Regular expression matching all terminal setting prompts.
634 The regexp should match at end of buffer.
635 The answer will be provided by `tramp-action-terminal', which see."
639 (defcustom tramp-operation-not-permitted-regexp
640 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
641 (regexp-opt '("Operation not permitted") t
))
642 "Regular expression matching keep-date problems in (s)cp operations.
643 Copying has been performed successfully already, so this message can
648 (defcustom tramp-copy-failed-regexp
650 (regexp-opt '("Permission denied"
653 "No such file or directory") t
)
655 "Regular expression matching copy problems in (s)cp operations."
659 (defcustom tramp-process-alive-regexp
661 "Regular expression indicating a process has finished.
662 In fact this expression is empty by intention, it will be used only to
663 check regularly the status of the associated process.
664 The answer will be provided by `tramp-action-process-alive',
665 `tramp-action-out-of-band', which see."
669 (defconst tramp-temp-name-prefix
"tramp."
670 "Prefix to use for temporary files.
671 If this is a relative file name (such as \"tramp.\"), it is considered
672 relative to the directory name returned by the function
673 `tramp-compat-temporary-file-directory' (which see). It may also be an
674 absolute file name; don't forget to include a prefix for the filename
677 (defconst tramp-temp-buffer-name
" *tramp temp*"
678 "Buffer name for a temporary buffer.
679 It shall be used in combination with `generate-new-buffer-name'.")
681 (defvar tramp-temp-buffer-file-name nil
682 "File name of a persistent local temporary file.
683 Useful for \"rsync\" like methods.")
684 (make-variable-buffer-local 'tramp-temp-buffer-file-name
)
685 (put 'tramp-temp-buffer-file-name
'permanent-local t
)
687 ;; XEmacs is distributed with few Lisp packages. Further packages are
688 ;; installed using EFS. If we use a unified filename format, then
689 ;; Tramp is required in addition to EFS. (But why can't Tramp just
690 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
691 ;; just like before.) Another reason for using a separate filename
692 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
693 ;; Tramp only knows how to deal with `file-name-handler-alist', not
696 ;; Currently, we have the choice between 'ftp and 'sep.
698 (defcustom tramp-syntax
699 (if (featurep 'xemacs
) 'sep
'ftp
)
700 "Tramp filename syntax to be used.
702 It can have the following values:
704 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
705 'sep -- Syntax as defined for XEmacs."
708 :type
`(choice (const :tag
,(if (featurep 'xemacs
) "EFS" "Ange-FTP") ftp
)
709 (const :tag
"XEmacs" sep
)))
711 (defconst tramp-prefix-format
712 (cond ((equal tramp-syntax
'ftp
) "/")
713 ((equal tramp-syntax
'sep
) "/[")
714 (t (error "Wrong `tramp-syntax' defined")))
715 "String matching the very beginning of Tramp file names.
716 Used in `tramp-make-tramp-file-name'.")
718 (defconst tramp-prefix-regexp
719 (concat "^" (regexp-quote tramp-prefix-format
))
720 "Regexp matching the very beginning of Tramp file names.
721 Should always start with \"^\". Derived from `tramp-prefix-format'.")
723 (defconst tramp-method-regexp
725 "Regexp matching methods identifiers.")
727 (defconst tramp-postfix-method-format
728 (cond ((equal tramp-syntax
'ftp
) ":")
729 ((equal tramp-syntax
'sep
) "/")
730 (t (error "Wrong `tramp-syntax' defined")))
731 "String matching delimiter between method and user or host names.
732 Used in `tramp-make-tramp-file-name'.")
734 (defconst tramp-postfix-method-regexp
735 (regexp-quote tramp-postfix-method-format
)
736 "Regexp matching delimiter between method and user or host names.
737 Derived from `tramp-postfix-method-format'.")
739 (defconst tramp-user-regexp
"[^/|: \t]+"
740 "Regexp matching user names.")
743 (defconst tramp-prefix-domain-format
"%"
744 "String matching delimiter between user and domain names.")
747 (defconst tramp-prefix-domain-regexp
748 (regexp-quote tramp-prefix-domain-format
)
749 "Regexp matching delimiter between user and domain names.
750 Derived from `tramp-prefix-domain-format'.")
752 (defconst tramp-domain-regexp
"[-a-zA-Z0-9_.]+"
753 "Regexp matching domain names.")
755 (defconst tramp-user-with-domain-regexp
756 (concat "\\(" tramp-user-regexp
"\\)"
757 tramp-prefix-domain-regexp
758 "\\(" tramp-domain-regexp
"\\)")
759 "Regexp matching user names with domain names.")
761 (defconst tramp-postfix-user-format
"@"
762 "String matching delimiter between user and host names.
763 Used in `tramp-make-tramp-file-name'.")
765 (defconst tramp-postfix-user-regexp
766 (regexp-quote tramp-postfix-user-format
)
767 "Regexp matching delimiter between user and host names.
768 Derived from `tramp-postfix-user-format'.")
770 (defconst tramp-host-regexp
"[a-zA-Z0-9_.-]+"
771 "Regexp matching host names.")
773 (defconst tramp-prefix-ipv6-format
774 (cond ((equal tramp-syntax
'ftp
) "[")
775 ((equal tramp-syntax
'sep
) "")
776 (t (error "Wrong `tramp-syntax' defined")))
777 "String matching left hand side of IPv6 addresses.
778 Used in `tramp-make-tramp-file-name'.")
780 (defconst tramp-prefix-ipv6-regexp
781 (regexp-quote tramp-prefix-ipv6-format
)
782 "Regexp matching left hand side of IPv6 addresses.
783 Derived from `tramp-prefix-ipv6-format'.")
785 ;; The following regexp is a bit sloppy. But it shall serve our
786 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
787 ;; "::ffff:192.168.0.1".
788 (defconst tramp-ipv6-regexp
789 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
790 "Regexp matching IPv6 addresses.")
792 (defconst tramp-postfix-ipv6-format
793 (cond ((equal tramp-syntax
'ftp
) "]")
794 ((equal tramp-syntax
'sep
) "")
795 (t (error "Wrong `tramp-syntax' defined")))
796 "String matching right hand side of IPv6 addresses.
797 Used in `tramp-make-tramp-file-name'.")
799 (defconst tramp-postfix-ipv6-regexp
800 (regexp-quote tramp-postfix-ipv6-format
)
801 "Regexp matching right hand side of IPv6 addresses.
802 Derived from `tramp-postfix-ipv6-format'.")
804 (defconst tramp-prefix-port-format
805 (cond ((equal tramp-syntax
'ftp
) "#")
806 ((equal tramp-syntax
'sep
) "#")
807 (t (error "Wrong `tramp-syntax' defined")))
808 "String matching delimiter between host names and port numbers.")
810 (defconst tramp-prefix-port-regexp
811 (regexp-quote tramp-prefix-port-format
)
812 "Regexp matching delimiter between host names and port numbers.
813 Derived from `tramp-prefix-port-format'.")
815 (defconst tramp-port-regexp
"[0-9]+"
816 "Regexp matching port numbers.")
818 (defconst tramp-host-with-port-regexp
819 (concat "\\(" tramp-host-regexp
"\\)"
820 tramp-prefix-port-regexp
821 "\\(" tramp-port-regexp
"\\)")
822 "Regexp matching host names with port numbers.")
824 (defconst tramp-postfix-hop-format
"|"
825 "String matching delimiter after ad-hoc hop definitions.")
827 (defconst tramp-postfix-hop-regexp
828 (regexp-quote tramp-postfix-hop-format
)
829 "Regexp matching delimiter after ad-hoc hop definitions.
830 Derived from `tramp-postfix-hop-format'.")
832 (defconst tramp-postfix-host-format
833 (cond ((equal tramp-syntax
'ftp
) ":")
834 ((equal tramp-syntax
'sep
) "]")
835 (t (error "Wrong `tramp-syntax' defined")))
836 "String matching delimiter between host names and localnames.
837 Used in `tramp-make-tramp-file-name'.")
839 (defconst tramp-postfix-host-regexp
840 (regexp-quote tramp-postfix-host-format
)
841 "Regexp matching delimiter between host names and localnames.
842 Derived from `tramp-postfix-host-format'.")
844 (defconst tramp-localname-regexp
".*$"
845 "Regexp matching localnames.")
847 ;;; File name format:
849 (defconst tramp-remote-file-name-spec-regexp
851 "\\(?:" "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
"\\)?"
852 "\\(?:" "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
"\\)?"
853 "\\(" "\\(?:" tramp-host-regexp
"\\|"
854 tramp-prefix-ipv6-regexp
"\\(?:" tramp-ipv6-regexp
"\\)?"
855 tramp-postfix-ipv6-regexp
"\\)"
856 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp
"\\)?" "\\)?")
857 "Regular expression matching a Tramp file name between prefix and postfix.")
859 (defconst tramp-file-name-structure
863 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
864 tramp-postfix-hop-regexp
"\\)+" "\\)?"
865 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
866 "\\(" tramp-localname-regexp
"\\)")
868 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
869 the Tramp file name structure.
871 The first element REGEXP is a regular expression matching a Tramp file
872 name. The regex should contain parentheses around the method name,
873 the user name, the host name, and the file name parts.
875 The second element METHOD is a number, saying which pair of
876 parentheses matches the method name. The third element USER is
877 similar, but for the user name. The fourth element HOST is similar,
878 but for the host name. The fifth element FILE is for the file name.
879 The last element HOP is the ad-hoc hop definition, which could be a
880 cascade of several hops.
882 These numbers are passed directly to `match-string', which see. That
883 means the opening parentheses are counted to identify the pair.
885 See also `tramp-file-name-regexp'.")
888 (defconst tramp-file-name-regexp-unified
889 (if (memq system-type
'(cygwin windows-nt
))
890 "\\`/\\(\\[.*\\]\\|[^/|:]\\{2,\\}[^/|]*\\):"
892 "Value for `tramp-file-name-regexp' for unified remoting.
893 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
894 Tramp. See `tramp-file-name-structure' for more explanations.
896 On W32 systems, the volume letter must be ignored.")
899 (defconst tramp-file-name-regexp-separate
"\\`/\\[.*\\]"
900 "Value for `tramp-file-name-regexp' for separate remoting.
901 XEmacs uses a separate filename syntax for Tramp and EFS.
902 See `tramp-file-name-structure' for more explanations.")
905 (defconst tramp-file-name-regexp
906 (cond ((equal tramp-syntax
'ftp
) tramp-file-name-regexp-unified
)
907 ((equal tramp-syntax
'sep
) tramp-file-name-regexp-separate
)
908 (t (error "Wrong `tramp-syntax' defined")))
909 "Regular expression matching file names handled by Tramp.
910 This regexp should match Tramp file names but no other file names.
911 When tramp.el is loaded, this regular expression is prepended to
912 `file-name-handler-alist', and that is searched sequentially. Thus,
913 if the Tramp entry appears rather early in the `file-name-handler-alist'
914 and is a bit too general, then some files might be considered Tramp
915 files which are not really Tramp files.
917 Please note that the entry in `file-name-handler-alist' is made when
918 this file \(tramp.el\) is loaded. This means that this variable must be set
919 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
920 updated after changing this variable.
922 Also see `tramp-file-name-structure'.")
925 (defconst tramp-completion-file-name-regexp-unified
926 (if (memq system-type
'(cygwin windows-nt
))
927 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
928 "Value for `tramp-completion-file-name-regexp' for unified remoting.
929 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
930 See `tramp-file-name-structure' for more explanations.
932 On W32 systems, the volume letter must be ignored.")
935 (defconst tramp-completion-file-name-regexp-separate
936 "\\`/\\([[][^]]*\\)?\\'"
937 "Value for `tramp-completion-file-name-regexp' for separate remoting.
938 XEmacs uses a separate filename syntax for Tramp and EFS.
939 See `tramp-file-name-structure' for more explanations.")
942 (defconst tramp-completion-file-name-regexp
943 (cond ((equal tramp-syntax
'ftp
) tramp-completion-file-name-regexp-unified
)
944 ((equal tramp-syntax
'sep
) tramp-completion-file-name-regexp-separate
)
945 (t (error "Wrong `tramp-syntax' defined")))
946 "Regular expression matching file names handled by Tramp completion.
947 This regexp should match partial Tramp file names only.
949 Please note that the entry in `file-name-handler-alist' is made when
950 this file \(tramp.el\) is loaded. This means that this variable must be set
951 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
952 updated after changing this variable.
954 Also see `tramp-file-name-structure'.")
956 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
957 ;; known to have a bug in `process-send-string'; some ssh connections appear
958 ;; to drop bytes when data is sent too quickly. There is also a connection
959 ;; buffer local variable, which is computed depending on remote host properties
960 ;; when `tramp-chunksize' is zero or nil.
961 (defcustom tramp-chunksize
962 (when (and (not (featurep 'xemacs
))
963 (memq system-type
'(hpux)))
965 ;; Parentheses in docstring starting at beginning of line are escaped.
966 ;; Fontification is messed up when
967 ;; `open-paren-in-column-0-is-defun-start' set to t.
968 "If non-nil, chunksize for sending input to local process.
969 It is necessary only on systems which have a buggy `process-send-string'
970 implementation. The necessity, whether this variable must be set, can be
971 checked via the following code:
974 (let* ((user \"xxx\") (host \"yyy\")
976 (sent init) (received init))
977 (while (= sent received)
978 (setq sent (+ sent step))
980 (let ((proc (start-process (buffer-name) (current-buffer)
981 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
982 (when (memq (process-status proc) '(run open))
983 (process-send-string proc (make-string sent ?\\ ))
984 (process-send-eof proc)
985 (process-send-eof proc))
986 (while (not (progn (goto-char (point-min))
987 (re-search-forward \"\\\\w+\" (point-max) t)))
988 (accept-process-output proc 1))
989 (when (memq (process-status proc) '(run open))
990 (setq received (string-to-number (match-string 0)))
991 (delete-process proc)
992 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
994 (if (> sent (+ init step))
995 (message \"You should set `tramp-chunksize' to a maximum of %s\"
997 (message \"Test does not work\")
998 (display-buffer (current-buffer))
1001 In the Emacs normally running Tramp, evaluate the above code
1002 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1003 respectively\). You can do this, for example, by pasting it into
1004 the `*scratch*' buffer and then hitting C-j with the cursor after the
1005 last closing parenthesis. Note that it works only if you have configured
1006 \"ssh\" to run without password query, see ssh-agent\(1\).
1008 You will see the number of bytes sent successfully to the remote host.
1009 If that number exceeds 1000, you can stop the execution by hitting
1010 C-g, because your Emacs is likely clean.
1012 When it is necessary to set `tramp-chunksize', you might consider to
1013 use an out-of-the-band method \(like \"scp\"\) instead of an internal one
1014 \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases
1017 If your Emacs is buggy, the code stops and gives you an indication
1018 about the value `tramp-chunksize' should be set. Maybe you could just
1019 experiment a bit, e.g. changing the values of `init' and `step'
1020 in the third line of the code.
1022 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1023 this variable to be set as well."
1025 :type
'(choice (const nil
) integer
))
1027 ;; Logging in to a remote host normally requires obtaining a pty. But
1028 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1029 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1030 ;; for an override of the system default.
1031 (defcustom tramp-process-connection-type t
1032 "Overrides `process-connection-type' for connections from Tramp.
1033 Tramp binds `process-connection-type' to the value given here before
1034 opening a connection to a remote host."
1036 :type
'(choice (const nil
) (const t
) (const pty
)))
1038 (defcustom tramp-connection-timeout
60
1039 "Defines the max time to wait for establishing a connection (in seconds).
1040 This can be overwritten for different connection types in `tramp-methods'."
1045 (defcustom tramp-connection-min-time-diff
5
1046 "Defines seconds between two consecutive connection attempts.
1047 This is necessary as self defense mechanism, in order to avoid
1048 yo-yo connection attempts when the remote host is unavailable.
1050 A value of 0 or `nil' suppresses this check. This might be
1051 necessary, when several out-of-order copy operations are
1052 performed, or when several asynchronous processes will be started
1053 in a short time frame. In those cases it is recommended to
1054 let-bind this variable."
1057 :type
'(choice (const nil
) integer
))
1059 (defcustom tramp-completion-reread-directory-timeout
10
1060 "Defines seconds since last remote command before rereading a directory.
1061 A remote directory might have changed its contents. In order to
1062 make it visible during file name completion in the minibuffer,
1063 Tramp flushes its cache and rereads the directory contents when
1064 more than `tramp-completion-reread-directory-timeout' seconds
1065 have been gone since last remote command execution. A value of `t'
1066 would require an immediate reread during filename completion, `nil'
1067 means to use always cached values for the directory contents."
1069 :type
'(choice (const nil
) (const t
) integer
))
1071 ;;; Internal Variables:
1073 (defvar tramp-current-method nil
1074 "Connection method for this *tramp* buffer.")
1076 (defvar tramp-current-user nil
1077 "Remote login name for this *tramp* buffer.")
1079 (defvar tramp-current-host nil
1080 "Remote host for this *tramp* buffer.")
1082 (defvar tramp-current-connection nil
1083 "Last connection timestamp.")
1086 (defconst tramp-completion-file-name-handler-alist
1087 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions
)
1088 (file-name-completion . tramp-completion-handle-file-name-completion
))
1089 "Alist of completion handler functions.
1090 Used for file names matching `tramp-file-name-regexp'. Operations
1091 not mentioned here will be handled by Tramp's file name handler
1092 functions, or the normal Emacs functions.")
1094 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1095 ;;;###tramp-autoload
1096 (defvar tramp-foreign-file-name-handler-alist nil
1097 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1098 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1101 ;;; Internal functions which must come first:
1103 (defsubst tramp-user-error
(vec-or-proc format
&rest args
)
1104 "Signal a pilot error."
1106 'tramp-error vec-or-proc
1107 (if (fboundp 'user-error
) 'user-error
'error
) format args
))
1109 ;; Conversion functions between external representation and
1110 ;; internal data structure. Convenience functions for internal
1113 (defun tramp-get-method-parameter (method param
)
1114 "Return the method parameter PARAM.
1115 If the `tramp-methods' entry does not exist, return nil."
1116 (let ((entry (assoc param
(assoc method tramp-methods
))))
1117 (when entry
(cadr entry
))))
1119 (defun tramp-file-name-p (vec)
1120 "Check, whether VEC is a Tramp object."
1121 (and (vectorp vec
) (= 5 (length vec
))))
1123 (defun tramp-file-name-method (vec)
1124 "Return method component of VEC."
1125 (and (tramp-file-name-p vec
) (aref vec
0)))
1127 (defun tramp-file-name-user (vec)
1128 "Return user component of VEC."
1129 (and (tramp-file-name-p vec
) (aref vec
1)))
1131 (defun tramp-file-name-host (vec)
1132 "Return host component of VEC."
1133 (and (tramp-file-name-p vec
) (aref vec
2)))
1135 (defun tramp-file-name-localname (vec)
1136 "Return localname component of VEC."
1137 (and (tramp-file-name-p vec
) (aref vec
3)))
1139 (defun tramp-file-name-hop (vec)
1140 "Return hop component of VEC."
1141 (and (tramp-file-name-p vec
) (aref vec
4)))
1143 ;; The user part of a Tramp file name vector can be of kind
1144 ;; "user%domain". Sometimes, we must extract these parts.
1145 (defun tramp-file-name-real-user (vec)
1146 "Return the user name of VEC without domain."
1148 (let ((user (tramp-file-name-user vec
)))
1149 (if (and (stringp user
)
1150 (string-match tramp-user-with-domain-regexp user
))
1151 (match-string 1 user
)
1154 (defun tramp-file-name-domain (vec)
1155 "Return the domain name of VEC."
1157 (let ((user (tramp-file-name-user vec
)))
1159 (string-match tramp-user-with-domain-regexp user
)
1160 (match-string 2 user
)))))
1162 ;; The host part of a Tramp file name vector can be of kind
1163 ;; "host#port". Sometimes, we must extract these parts.
1164 (defun tramp-file-name-real-host (vec)
1165 "Return the host name of VEC without port."
1167 (let ((host (tramp-file-name-host vec
)))
1168 (if (and (stringp host
)
1169 (string-match tramp-host-with-port-regexp host
))
1170 (match-string 1 host
)
1173 (defun tramp-file-name-port (vec)
1174 "Return the port number of VEC."
1176 (let ((method (tramp-file-name-method vec
))
1177 (host (tramp-file-name-host vec
)))
1178 (or (and (stringp host
)
1179 (string-match tramp-host-with-port-regexp host
)
1180 (string-to-number (match-string 2 host
)))
1181 (tramp-get-method-parameter method
'tramp-default-port
)))))
1183 ;;;###tramp-autoload
1184 (defun tramp-tramp-file-p (name)
1185 "Return t if NAME is a string with Tramp file name syntax."
1188 (string-match tramp-file-name-regexp name
))))
1190 ;; Obsoleted with Tramp 2.2.7.
1191 (defconst tramp-obsolete-methods
1192 '("ssh1" "ssh2" "scp1" "scp2" "scpc" "rsyncc" "plink1")
1193 "Obsolete methods.")
1195 (defvar tramp-warned-obsolete-methods nil
1196 "Which methods the user has been warned to be obsolete.")
1198 (defun tramp-find-method (method user host
)
1199 "Return the right method string to use.
1200 This is METHOD, if non-nil. Otherwise, do a lookup in
1201 `tramp-default-method-alist'. It maps also obsolete methods to
1205 (let ((choices tramp-default-method-alist
)
1208 (setq item
(pop choices
))
1209 (when (and (string-match (or (nth 0 item
) "") (or host
""))
1210 (string-match (or (nth 1 item
) "") (or user
"")))
1211 (setq lmethod
(nth 2 item
))
1212 (setq choices nil
)))
1214 tramp-default-method
)))
1215 ;; This is needed for a transition period only.
1216 (when (member result tramp-obsolete-methods
)
1217 (unless (member result tramp-warned-obsolete-methods
)
1219 (warn "Method %s is obsolete, using %s"
1220 result
(substring result
0 -
1))
1221 (unless (y-or-n-p (format "Method \"%s\" is obsolete, use \"%s\"? "
1222 result
(substring result
0 -
1)))
1223 (tramp-user-error nil
"Method \"%s\" not supported" result
)))
1224 (add-to-list 'tramp-warned-obsolete-methods result
))
1225 ;; This works with the current set of `tramp-obsolete-methods'.
1226 ;; Must be improved, if their are more sophisticated replacements.
1227 (setq result
(substring result
0 -
1)))
1228 ;; We must mark, whether a default value has been used. Not
1229 ;; applicable for XEmacs.
1230 (if (or method
(null result
) (null (functionp 'propertize
)))
1232 (tramp-compat-funcall 'propertize result
'tramp-default t
))))
1234 (defun tramp-find-user (method user host
)
1235 "Return the right user string to use.
1236 This is USER, if non-nil. Otherwise, do a lookup in
1237 `tramp-default-user-alist'."
1240 (let ((choices tramp-default-user-alist
)
1243 (setq item
(pop choices
))
1244 (when (and (string-match (or (nth 0 item
) "") (or method
""))
1245 (string-match (or (nth 1 item
) "") (or host
"")))
1246 (setq luser
(nth 2 item
))
1247 (setq choices nil
)))
1249 tramp-default-user
)))
1250 ;; We must mark, whether a default value has been used. Not
1251 ;; applicable for XEmacs.
1252 (if (or user
(null result
) (null (functionp 'propertize
)))
1254 (tramp-compat-funcall 'propertize result
'tramp-default t
))))
1256 (defun tramp-find-host (method user host
)
1257 "Return the right host string to use.
1258 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1259 (or (and (> (length host
) 0) host
)
1260 (let ((choices tramp-default-host-alist
)
1263 (setq item
(pop choices
))
1264 (when (and (string-match (or (nth 0 item
) "") (or method
""))
1265 (string-match (or (nth 1 item
) "") (or user
"")))
1266 (setq lhost
(nth 2 item
))
1267 (setq choices nil
)))
1269 tramp-default-host
))
1271 (defun tramp-check-proper-method-and-host (vec)
1272 "Check method and host name of VEC."
1273 (let ((method (tramp-file-name-method vec
))
1274 (user (tramp-file-name-user vec
))
1275 (host (tramp-file-name-host vec
))
1276 (methods (mapcar 'car tramp-methods
)))
1277 (when (and method
(not (member method methods
)))
1278 (tramp-cleanup-connection vec
)
1279 (tramp-user-error vec
"Unknown method \"%s\"" method
))
1280 (when (and (equal tramp-syntax
'ftp
) host
1281 (or (null method
) (get-text-property 0 'tramp-default method
))
1282 (or (null user
) (get-text-property 0 'tramp-default user
))
1283 (member host methods
))
1284 (tramp-cleanup-connection vec
)
1285 (tramp-user-error vec
"Host name must not match method \"%s\"" host
))))
1287 (defun tramp-dissect-file-name (name &optional nodefault
)
1288 "Return a `tramp-file-name' structure.
1289 The structure consists of remote method, remote user, remote host
1290 and localname (file name on remote host). If NODEFAULT is
1291 non-nil, the file name parts are not expanded to their default
1294 (let ((match (string-match (nth 0 tramp-file-name-structure
) name
)))
1295 (unless match
(tramp-user-error nil
"Not a Tramp file name: \"%s\"" name
))
1296 (let ((method (match-string (nth 1 tramp-file-name-structure
) name
))
1297 (user (match-string (nth 2 tramp-file-name-structure
) name
))
1298 (host (match-string (nth 3 tramp-file-name-structure
) name
))
1299 (localname (match-string (nth 4 tramp-file-name-structure
) name
))
1300 (hop (match-string (nth 5 tramp-file-name-structure
) name
)))
1302 (when (string-match tramp-prefix-ipv6-regexp host
)
1303 (setq host
(replace-match "" nil t host
)))
1304 (when (string-match tramp-postfix-ipv6-regexp host
)
1305 (setq host
(replace-match "" nil t host
))))
1307 (vector method user host localname hop
)
1309 (tramp-find-method method user host
)
1310 (tramp-find-user method user host
)
1311 (tramp-find-host method user host
)
1314 (defun tramp-buffer-name (vec)
1315 "A name for the connection buffer VEC."
1316 ;; We must use `tramp-file-name-real-host', because for gateway
1317 ;; methods the default port will be expanded later on, which would
1319 (let ((method (tramp-file-name-method vec
))
1320 (user (tramp-file-name-user vec
))
1321 (host (tramp-file-name-real-host vec
)))
1322 (if (not (zerop (length user
)))
1323 (format "*tramp/%s %s@%s*" method user host
)
1324 (format "*tramp/%s %s*" method host
))))
1326 (defun tramp-make-tramp-file-name (method user host localname
&optional hop
)
1327 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1328 When not nil, an optional HOP is prepended."
1329 (concat tramp-prefix-format hop
1330 (when (not (zerop (length method
)))
1331 (concat method tramp-postfix-method-format
))
1332 (when (not (zerop (length user
)))
1333 (concat user tramp-postfix-user-format
))
1335 (if (string-match tramp-ipv6-regexp host
)
1336 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format
)
1338 tramp-postfix-host-format
1339 (when localname localname
)))
1341 (defun tramp-completion-make-tramp-file-name (method user host localname
)
1342 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1343 It must not be a complete Tramp file name, but as long as there are
1344 necessary only. This function will be used in file name completion."
1345 (concat tramp-prefix-format
1346 (when (not (zerop (length method
)))
1347 (concat method tramp-postfix-method-format
))
1348 (when (not (zerop (length user
)))
1349 (concat user tramp-postfix-user-format
))
1350 (when (not (zerop (length host
)))
1352 (if (string-match tramp-ipv6-regexp host
)
1354 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format
)
1356 tramp-postfix-host-format
))
1357 (when localname localname
)))
1359 (defun tramp-get-buffer (vec)
1360 "Get the connection buffer to be used for VEC."
1361 (or (get-buffer (tramp-buffer-name vec
))
1362 (with-current-buffer (get-buffer-create (tramp-buffer-name vec
))
1363 (setq buffer-undo-list t
)
1364 (setq default-directory
1365 (tramp-make-tramp-file-name
1366 (tramp-file-name-method vec
)
1367 (tramp-file-name-user vec
)
1368 (tramp-file-name-host vec
)
1372 (defun tramp-get-connection-buffer (vec)
1373 "Get the connection buffer to be used for VEC.
1374 In case a second asynchronous communication has been started, it is different
1375 from `tramp-get-buffer'."
1376 (or (tramp-get-connection-property vec
"process-buffer" nil
)
1377 (tramp-get-buffer vec
)))
1379 (defun tramp-get-connection-name (vec)
1380 "Get the connection name to be used for VEC.
1381 In case a second asynchronous communication has been started, it is different
1382 from the default one."
1383 (or (tramp-get-connection-property vec
"process-name" nil
)
1384 (tramp-buffer-name vec
)))
1386 (defun tramp-get-connection-process (vec)
1387 "Get the connection process to be used for VEC.
1388 In case a second asynchronous communication has been started, it is different
1389 from the default one."
1390 (get-process (tramp-get-connection-name vec
)))
1392 (defun tramp-debug-buffer-name (vec)
1393 "A name for the debug buffer for VEC."
1394 ;; We must use `tramp-file-name-real-host', because for gateway
1395 ;; methods the default port will be expanded later on, which would
1397 (let ((method (tramp-file-name-method vec
))
1398 (user (tramp-file-name-user vec
))
1399 (host (tramp-file-name-real-host vec
)))
1400 (if (not (zerop (length user
)))
1401 (format "*debug tramp/%s %s@%s*" method user host
)
1402 (format "*debug tramp/%s %s*" method host
))))
1404 (defconst tramp-debug-outline-regexp
1405 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1406 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1408 (defun tramp-debug-outline-level ()
1409 "Return the depth to which a statement is nested in the outline.
1410 Point must be at the beginning of a header line.
1412 The outline level is equal to the verbosity of the Tramp message."
1413 (1+ (string-to-number (match-string 1))))
1415 (defun tramp-get-debug-buffer (vec)
1416 "Get the debug buffer for VEC."
1417 (with-current-buffer
1418 (get-buffer-create (tramp-debug-buffer-name vec
))
1420 (setq buffer-undo-list t
)
1421 ;; So it does not get loaded while `outline-regexp' is let-bound.
1423 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1424 ;; `outline-mode-hook'. We must prevent that local processes
1425 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1426 ;; Furthermore, `outline-regexp' must have the correct value
1427 ;; already, because it is used by `font-lock-compile-keywords'.
1428 (let ((default-directory (tramp-compat-temporary-file-directory))
1429 (outline-regexp tramp-debug-outline-regexp
))
1431 (set (make-local-variable 'outline-regexp
) tramp-debug-outline-regexp
)
1432 (set (make-local-variable 'outline-level
) 'tramp-debug-outline-level
))
1435 (defsubst tramp-debug-message
(vec fmt-string
&rest arguments
)
1436 "Append message to debug buffer.
1437 Message is formatted with FMT-STRING as control string and the remaining
1438 ARGUMENTS to actually emit the message (if applicable)."
1439 (with-current-buffer (tramp-get-debug-buffer vec
)
1440 (goto-char (point-max))
1445 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1446 (if (featurep 'sxemacs
) "SX" (if (featurep 'xemacs
) "X" "GNU "))
1447 emacs-version tramp-version
)))
1451 (let ((now (current-time)))
1452 (insert (format-time-string "%T." now
))
1453 (insert (format "%06d " (nth 2 now
))))
1454 ;; Calling Tramp function. We suppress compat and trace functions
1455 ;; from being displayed.
1456 (let ((btn 1) btf fn
)
1458 (setq btf
(nth 1 (backtrace-frame btn
)))
1462 (setq fn
(symbol-name btf
))
1465 (string-match "^tramp" fn
)
1472 "tramp-compat-condition-case-unless-debug"
1473 "tramp-compat-funcall"
1474 "tramp-compat-with-temp-message"
1475 "tramp-condition-case-unless-debug"
1476 "tramp-debug-message"
1478 "tramp-error-with-buffer"
1485 (setq btn
(1+ btn
))))
1486 ;; The following code inserts filename and line number. Should
1487 ;; be inactive by default, because it is time consuming.
1488 ; (let ((ffn (find-function-noselect (intern fn))))
1492 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1493 ; (with-current-buffer (car ffn)
1494 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1495 (insert (format "%s " fn
)))
1497 (insert (apply 'format fmt-string arguments
))))
1499 (defvar tramp-message-show-message t
1500 "Show Tramp message in the minibuffer.
1501 This variable is used to disable messages from `tramp-error'.
1502 The messages are visible anyway, because an error is raised.")
1504 (defsubst tramp-message
(vec-or-proc level fmt-string
&rest arguments
)
1505 "Emit a message depending on verbosity level.
1506 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1507 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1508 less than LEVEL. The message is emitted only if `tramp-verbose' is
1509 greater than or equal to LEVEL.
1511 The message is also logged into the debug buffer when `tramp-verbose'
1512 is greater than or equal 4.
1514 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1515 control string and the remaining ARGUMENTS to actually emit the message (if
1518 (when (<= level tramp-verbose
)
1519 ;; Match data must be preserved!
1521 ;; Display only when there is a minimum level.
1522 (when (and tramp-message-show-message
(<= level
3))
1528 ((= level
2) "Warning: ")
1532 ;; Log only when there is a minimum level.
1533 (when (>= tramp-verbose
4)
1534 ;; Translate proc to vec.
1535 (when (processp vec-or-proc
)
1536 (let ((tramp-verbose 0))
1538 (tramp-get-connection-property vec-or-proc
"vector" nil
))))
1540 (when (vectorp vec-or-proc
)
1541 (apply 'tramp-debug-message
1543 (concat (format "(%d) # " level
) fmt-string
)
1546 (defsubst tramp-backtrace
(&optional vec-or-proc
)
1547 "Dump a backtrace into the debug buffer.
1548 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1549 function is meant for debugging purposes."
1551 (tramp-message vec-or-proc
10 "\n%s" (with-output-to-string (backtrace)))
1552 (if (>= tramp-verbose
10)
1553 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1555 (defsubst tramp-error
(vec-or-proc signal fmt-string
&rest arguments
)
1557 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1558 signal identifier to be raised, remaining arguments passed to
1559 `tramp-message'. Finally, signal SIGNAL is raised."
1560 (let (tramp-message-show-message)
1561 (tramp-backtrace vec-or-proc
)
1564 (error-message-string
1566 (get signal
'error-message
)
1567 (apply 'format fmt-string arguments
))))
1568 (signal signal
(list (apply 'format fmt-string arguments
)))))
1570 (defsubst tramp-error-with-buffer
1571 (buf vec-or-proc signal fmt-string
&rest arguments
)
1572 "Emit an error, and show BUF.
1573 If BUF is nil, show the connection buf. Wait for 30\", or until
1574 an input event arrives. The other arguments are passed to `tramp-error'."
1575 (save-window-excursion
1576 (let* ((buf (or (and (bufferp buf
) buf
)
1577 (and (processp vec-or-proc
) (process-buffer vec-or-proc
))
1578 (and (vectorp vec-or-proc
)
1579 (tramp-get-connection-buffer vec-or-proc
))))
1580 (vec (or (and (vectorp vec-or-proc
) vec-or-proc
)
1581 (and buf
(with-current-buffer buf
1582 (tramp-dissect-file-name default-directory
))))))
1584 (apply 'tramp-error vec-or-proc signal fmt-string arguments
)
1587 tramp-message-show-message
1588 (not (zerop tramp-verbose
))
1589 (not (tramp-completion-mode-p)))
1590 (let ((enable-recursive-minibuffers t
))
1591 ;; `tramp-error' does not show messages. So we must do it
1593 (message fmt-string arguments
)
1598 ;; Reset timestamp. It would be wrong after waiting for a while.
1599 (when (equal (butlast (append vec nil
) 2)
1600 (car tramp-current-connection
))
1601 (setcdr tramp-current-connection
(current-time)))))))
1603 (defmacro with-parsed-tramp-file-name
(filename var
&rest body
)
1604 "Parse a Tramp filename and make components available in the body.
1606 First arg FILENAME is evaluated and dissected into its components.
1607 Second arg VAR is a symbol. It is used as a variable name to hold
1608 the filename structure. It is also used as a prefix for the variables
1609 holding the components. For example, if VAR is the symbol `foo', then
1610 `foo' will be bound to the whole structure, `foo-method' will be bound to
1611 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1614 Remaining args are Lisp expressions to be evaluated (inside an implicit
1617 If VAR is nil, then we bind `v' to the structure and `method', `user',
1618 `host', `localname', `hop' to the components."
1620 (mapcar (lambda (elem)
1621 `(,(if var
(intern (format "%s-%s" var elem
)) elem
)
1622 (,(intern (format "tramp-file-name-%s" elem
))
1624 '(method user host localname hop
))))
1625 `(let* ((,(or var
'v
) (tramp-dissect-file-name ,filename
))
1627 ;; We don't know which of those vars will be used, so we bind them all,
1628 ;; and then add here a dummy use of all those variables, so we don't get
1629 ;; flooded by warnings about those vars `body' didn't use.
1630 (ignore ,@(mapcar #'car bindings
))
1633 (put 'with-parsed-tramp-file-name
'lisp-indent-function
2)
1634 (put 'with-parsed-tramp-file-name
'edebug-form-spec
'(form symbolp body
))
1635 (tramp-compat-font-lock-add-keywords
1636 'emacs-lisp-mode
'("\\<with-parsed-tramp-file-name\\>"))
1638 (defun tramp-progress-reporter-update (reporter &optional value
)
1639 (let* ((parameters (cdr reporter
))
1640 (message (aref parameters
3)))
1641 (when (string-match message
(or (current-message) ""))
1642 (tramp-compat-funcall 'progress-reporter-update reporter value
))))
1644 (defmacro with-tramp-progress-reporter
(vec level message
&rest body
)
1645 "Executes BODY, spinning a progress reporter with MESSAGE.
1646 If LEVEL does not fit for visible messages, there are only traces
1647 without a visible progress reporter."
1648 (declare (indent 3) (debug t
))
1650 (tramp-message ,vec
,level
"%s..." ,message
)
1651 (let ((cookie "failed")
1653 ;; We start a pulsing progress reporter after 3 seconds. Feature
1654 ;; introduced in Emacs 24.1.
1655 (when (and tramp-message-show-message
1656 ;; Display only when there is a minimum level.
1657 (<= ,level
(min tramp-verbose
3)))
1659 (let ((pr (tramp-compat-funcall
1660 #'make-progress-reporter
,message
)))
1663 #'tramp-progress-reporter-update pr
)))))))
1665 ;; Execute the body.
1666 (prog1 (progn ,@body
) (setq cookie
"done"))
1667 ;; Stop progress reporter.
1668 (if tm
(tramp-compat-funcall 'cancel-timer tm
))
1669 (tramp-message ,vec
,level
"%s...%s" ,message cookie
)))))
1671 (tramp-compat-font-lock-add-keywords
1672 'emacs-lisp-mode
'("\\<with-tramp-progress-reporter\\>"))
1674 (defmacro with-tramp-file-property
(vec file property
&rest body
)
1675 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1676 FILE must be a local file name on a connection identified via VEC."
1677 `(if (file-name-absolute-p ,file
)
1678 (let ((value (tramp-get-file-property ,vec
,file
,property
'undef
)))
1679 (when (eq value
'undef
)
1680 ;; We cannot pass @body as parameter to
1681 ;; `tramp-set-file-property' because it mangles our
1683 (setq value
(progn ,@body
))
1684 (tramp-set-file-property ,vec
,file
,property value
))
1688 (put 'with-tramp-file-property
'lisp-indent-function
3)
1689 (put 'with-tramp-file-property
'edebug-form-spec t
)
1690 (tramp-compat-font-lock-add-keywords
1691 'emacs-lisp-mode
'("\\<with-tramp-file-property\\>"))
1693 (defmacro with-tramp-connection-property
(key property
&rest body
)
1694 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1695 `(let ((value (tramp-get-connection-property ,key
,property
'undef
)))
1696 (when (eq value
'undef
)
1697 ;; We cannot pass ,@body as parameter to
1698 ;; `tramp-set-connection-property' because it mangles our debug
1700 (setq value
(progn ,@body
))
1701 (tramp-set-connection-property ,key
,property value
))
1704 (put 'with-tramp-connection-property
'lisp-indent-function
2)
1705 (put 'with-tramp-connection-property
'edebug-form-spec t
)
1706 (tramp-compat-font-lock-add-keywords
1707 'emacs-lisp-mode
'("\\<with-tramp-connection-property\\>"))
1709 (defun tramp-drop-volume-letter (name)
1710 "Cut off unnecessary drive letter from file NAME.
1711 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1712 locally on a remote file name. When the local system is a W32 system
1713 but the remote system is Unix, this introduces a superfluous drive
1714 letter into the file name. This function removes it."
1716 (if (string-match "\\`[a-zA-Z]:/" name
)
1717 (replace-match "/" nil t name
)
1720 ;;; Config Manipulation Functions:
1722 ;;;###tramp-autoload
1723 (defun tramp-set-completion-function (method function-list
)
1724 "Sets the list of completion functions for METHOD.
1725 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1726 The FUNCTION is intended to parse FILE according its syntax.
1727 It might be a predefined FUNCTION, or a user defined FUNCTION.
1728 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1732 (tramp-set-completion-function
1734 '((tramp-parse-sconfig \"/etc/ssh_config\")
1735 (tramp-parse-sconfig \"~/.ssh/config\")))"
1737 (let ((r function-list
)
1739 (setq tramp-completion-function-alist
1740 (delete (assoc method tramp-completion-function-alist
)
1741 tramp-completion-function-alist
))
1744 ;; Remove double entries.
1745 (when (member (car v
) (cdr v
))
1746 (setcdr v
(delete (car v
) (cdr v
))))
1747 ;; Check for function and file or registry key.
1748 (unless (and (functionp (nth 0 (car v
)))
1749 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v
)))
1750 ;; Windows registry.
1751 (and (memq system-type
'(cygwin windows-nt
))
1754 "reg" nil nil nil
"query" (nth 1 (car v
)))))
1755 ;; Configuration file.
1756 (file-exists-p (nth 1 (car v
)))))
1757 (setq r
(delete (car v
) r
)))
1761 (add-to-list 'tramp-completion-function-alist
1764 (defun tramp-get-completion-function (method)
1765 "Returns a list of completion functions for METHOD.
1766 For definition of that list see `tramp-set-completion-function'."
1768 ;; Hosts visited once shall be remembered.
1769 `(tramp-parse-connection-properties ,method
)
1770 ;; The method related defaults.
1771 (cdr (assoc method tramp-completion-function-alist
))))
1774 ;;; Fontification of `read-file-name':
1776 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
1777 (defvar tramp-rfn-eshadow-overlay
)
1778 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay
)
1780 (defun tramp-rfn-eshadow-setup-minibuffer ()
1781 "Set up a minibuffer for `file-name-shadow-mode'.
1782 Adds another overlay hiding filename parts according to Tramp's
1783 special handling of `substitute-in-file-name'."
1784 (when (symbol-value 'minibuffer-completing-file-name
)
1785 (setq tramp-rfn-eshadow-overlay
1786 (tramp-compat-funcall
1788 (tramp-compat-funcall 'minibuffer-prompt-end
)
1789 (tramp-compat-funcall 'minibuffer-prompt-end
)))
1790 ;; Copy rfn-eshadow-overlay properties.
1791 (let ((props (tramp-compat-funcall
1792 'overlay-properties
(symbol-value 'rfn-eshadow-overlay
))))
1794 ;; The `field' property prevents correct minibuffer
1795 ;; completion; we exclude it.
1796 (if (not (eq (car props
) 'field
))
1797 (tramp-compat-funcall
1798 'overlay-put tramp-rfn-eshadow-overlay
(pop props
) (pop props
))
1799 (pop props
) (pop props
))))))
1801 (when (boundp 'rfn-eshadow-setup-minibuffer-hook
)
1802 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1803 'tramp-rfn-eshadow-setup-minibuffer
)
1804 (add-hook 'tramp-unload-hook
1806 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1807 'tramp-rfn-eshadow-setup-minibuffer
))))
1809 (defconst tramp-rfn-eshadow-update-overlay-regexp
1810 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format
))
1812 (defun tramp-rfn-eshadow-update-overlay ()
1813 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1814 This is intended to be used as a minibuffer `post-command-hook' for
1815 `file-name-shadow-mode'; the minibuffer should have already
1816 been set up by `rfn-eshadow-setup-minibuffer'."
1817 ;; In remote files name, there is a shadowing just for the local part.
1819 (let ((end (or (tramp-compat-funcall
1820 'overlay-end
(symbol-value 'rfn-eshadow-overlay
))
1821 (tramp-compat-funcall 'minibuffer-prompt-end
)))
1822 ;; We do not want to send any remote command.
1826 (tramp-compat-funcall
1827 'buffer-substring-no-properties end
(point-max)))
1831 (1+ (or (string-match
1832 tramp-rfn-eshadow-update-overlay-regexp
1833 (buffer-string) end
)
1836 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay
)
1837 (rfn-eshadow-update-overlay-hook nil
)
1838 file-name-handler-alist
)
1839 (tramp-compat-funcall
1840 'move-overlay rfn-eshadow-overlay
(point-max) (point-max))
1841 (tramp-compat-funcall 'rfn-eshadow-update-overlay
))))))))
1843 (when (boundp 'rfn-eshadow-update-overlay-hook
)
1844 (add-hook 'rfn-eshadow-update-overlay-hook
1845 'tramp-rfn-eshadow-update-overlay
)
1846 (add-hook 'tramp-unload-hook
1848 (remove-hook 'rfn-eshadow-update-overlay-hook
1849 'tramp-rfn-eshadow-update-overlay
))))
1851 ;; Inodes don't exist for some file systems. Therefore we must
1852 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1853 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1854 ;; performance isn't the major issue given that file transfer will
1856 (defvar tramp-inodes
0
1857 "Keeps virtual inodes numbers.")
1859 ;; Devices must distinguish physical file systems. The device numbers
1860 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1861 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1862 ;; EFS use device number "-1". In order to be different, we use device number
1863 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1864 (defvar tramp-devices
0
1865 "Keeps virtual device numbers.")
1867 (defun tramp-default-file-modes (filename)
1868 "Return file modes of FILENAME as integer.
1869 If the file modes of FILENAME cannot be determined, return the
1870 value of `default-file-modes', without execute permissions."
1871 (or (file-modes filename
)
1872 (logand (default-file-modes) (tramp-compat-octal-to-decimal "0666"))))
1874 (defun tramp-replace-environment-variables (filename)
1875 "Replace environment variables in FILENAME.
1876 Return the string with the replaced variables."
1878 (tramp-compat-funcall 'substitute-env-vars filename
'only-defined
))
1879 ;; We need an own implementation.
1881 (let ((idx (string-match "$\\(\\w+\\)" filename
)))
1882 ;; `$' is coded as `$$'.
1884 (or (zerop idx
) (not (eq ?$
(aref filename
(1- idx
)))))
1885 (getenv (match-string 1 filename
)))
1888 (substitute-in-file-name (match-string 0 filename
))
1892 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
1893 ;; which calls corresponding functions (see minibuf.el).
1894 (when (fboundp 'minibuffer-electric-separator
)
1899 (around ,(intern (format "tramp-advice-%s" x
)) activate
)
1900 "Invoke `substitute-in-file-name' for Tramp files."
1901 (if (and (symbol-value 'minibuffer-electric-file-name-behavior
)
1902 (tramp-tramp-file-p (buffer-substring)))
1903 ;; We don't need to handle `last-input-event', because
1904 ;; due to the key map we know it must be ?/ or ?~.
1905 (let ((s (concat (buffer-substring (point-min) (point))
1906 (string last-command-char
))))
1907 (delete-region (point-min) (point))
1908 (insert (substitute-in-file-name s
))
1909 (setq ad-return-value last-command-char
))
1915 (ad-remove-advice ',x
'around
',(intern (format "tramp-advice-%s" x
)))
1916 (ad-activate ',x
)))))
1918 '(minibuffer-electric-separator
1919 minibuffer-electric-tilde
)))
1921 (defun tramp-find-file-name-coding-system-alist (filename tmpname
)
1922 "Like `find-operation-coding-system' for Tramp filenames.
1923 Tramp's `insert-file-contents' and `write-region' work over
1924 temporary file names. If `file-coding-system-alist' contains an
1925 expression, which matches more than the file name suffix, the
1926 coding system might not be determined. This function repairs it."
1928 (dolist (elt file-coding-system-alist result
)
1929 (when (and (consp elt
) (string-match (car elt
) filename
))
1930 ;; We found a matching entry in `file-coding-system-alist'.
1931 ;; So we add a similar entry, but with the temporary file name
1934 'result
(cons (regexp-quote tmpname
) (cdr elt
)) 'append
)))))
1937 (progn (defun tramp-run-real-handler (operation args
)
1938 "Invoke normal file name handler for OPERATION.
1939 First arg specifies the OPERATION, second arg is a list of arguments to
1940 pass to the OPERATION."
1941 (let* ((inhibit-file-name-handlers
1942 `(tramp-file-name-handler
1943 tramp-vc-file-name-handler
1944 tramp-completion-file-name-handler
1945 cygwin-mount-name-hook-function
1946 cygwin-mount-map-drive-hook-function
1948 ,(and (eq inhibit-file-name-operation operation
)
1949 inhibit-file-name-handlers
)))
1950 (inhibit-file-name-operation operation
))
1951 (apply operation args
))))
1954 (progn (defun tramp-completion-run-real-handler (operation args
)
1955 "Invoke `tramp-file-name-handler' for OPERATION.
1956 First arg specifies the OPERATION, second arg is a list of arguments to
1957 pass to the OPERATION."
1958 (let* ((inhibit-file-name-handlers
1959 `(tramp-completion-file-name-handler
1960 cygwin-mount-name-hook-function
1961 cygwin-mount-map-drive-hook-function
1963 ,(and (eq inhibit-file-name-operation operation
)
1964 inhibit-file-name-handlers
)))
1965 (inhibit-file-name-operation operation
))
1966 (apply operation args
))))
1968 ;; We handle here all file primitives. Most of them have the file
1969 ;; name as first parameter; nevertheless we check for them explicitly
1970 ;; in order to be signaled if a new primitive appears. This
1971 ;; scenario is needed because there isn't a way to decide by
1972 ;; syntactical means whether a foreign method must be called. It would
1973 ;; ease the life if `file-name-handler-alist' would support a decision
1974 ;; function as well but regexp only.
1975 (defun tramp-file-name-for-operation (operation &rest args
)
1976 "Return file name related to OPERATION file primitive.
1977 ARGS are the arguments OPERATION has been called with."
1979 ;; FILE resp DIRECTORY.
1981 (list 'access-file
'byte-compiler-base-file-name
'delete-directory
1982 'delete-file
'diff-latest-backup-file
'directory-file-name
1983 'directory-files
'directory-files-and-attributes
1984 'dired-compress-file
'dired-uncache
1985 'file-accessible-directory-p
'file-attributes
1986 'file-directory-p
'file-executable-p
'file-exists-p
1987 'file-local-copy
'file-modes
1988 'file-name-as-directory
'file-name-directory
1989 'file-name-nondirectory
'file-name-sans-versions
1990 'file-ownership-preserved-p
'file-readable-p
1991 'file-regular-p
'file-remote-p
'file-symlink-p
'file-truename
1992 'file-writable-p
'find-backup-file-name
'find-file-noselect
1993 'get-file-buffer
'insert-directory
'insert-file-contents
1994 'load
'make-directory
'make-directory-internal
1995 'set-file-modes
'substitute-in-file-name
1996 'unhandled-file-name-directory
'vc-registered
2000 'file-acl
'file-notify-add-watch
2001 'file-selinux-context
'set-file-acl
'set-file-selinux-context
2003 'abbreviate-file-name
'create-file-buffer
2004 'dired-file-modtime
'dired-make-compressed-filename
2005 'dired-recursive-delete-directory
'dired-set-file-modtime
2006 'dired-shell-unhandle-file-name
'dired-uucode-file
2007 'insert-file-contents-literally
'make-temp-name
'recover-file
2008 'vm-imap-check-mail
'vm-pop-check-mail
'vm-spool-check-mail
))
2009 (if (file-name-absolute-p (nth 0 args
))
2011 (expand-file-name (nth 0 args
))))
2012 ;; FILE DIRECTORY resp FILE1 FILE2.
2014 (list 'add-name-to-file
'copy-file
'expand-file-name
2015 'file-name-all-completions
'file-name-completion
2016 'file-newer-than-file-p
'make-symbolic-link
'rename-file
2020 'file-equal-p
'file-in-directory-p
2022 'dired-make-relative-symlink
2023 'vm-imap-move-mail
'vm-pop-move-mail
'vm-spool-move-mail
))
2026 ((tramp-tramp-file-p (nth 0 args
)) (nth 0 args
))
2027 ((tramp-tramp-file-p (nth 1 args
)) (nth 1 args
))
2028 (t (buffer-file-name (current-buffer))))))
2030 ((eq operation
'write-region
)
2034 (list 'set-visited-file-modtime
'verify-visited-file-modtime
2036 'make-auto-save-file-name
2040 (if (bufferp (nth 0 args
)) (nth 0 args
) (current-buffer))))
2043 (list ;; not in Emacs 23+.
2052 'dired-print-file
'dired-shell-call-process
))
2055 ((eq operation
'file-notify-rm-watch
)
2056 (when (processp (nth 0 args
))
2057 (with-current-buffer (process-buffer (nth 0 args
))
2058 default-directory
)))
2059 ;; Unknown file primitive.
2060 (t (error "unknown file I/O primitive: %s" operation
))))
2062 (defun tramp-find-foreign-file-name-handler (filename)
2063 "Return foreign file name handler if exists."
2064 (when (tramp-tramp-file-p filename
)
2065 (let ((v (tramp-dissect-file-name filename t
))
2066 (handler tramp-foreign-file-name-handler-alist
)
2068 ;; When we are not fully sure that filename completion is safe,
2069 ;; we should not return a handler.
2070 (when (or (tramp-file-name-method v
) (tramp-file-name-user v
)
2071 (and (tramp-file-name-host v
)
2072 (not (member (tramp-file-name-host v
)
2073 (mapcar 'car tramp-methods
))))
2074 (not (tramp-completion-mode-p)))
2076 (setq elt
(car handler
)
2077 handler
(cdr handler
))
2078 (when (funcall (car elt
) filename
)
2083 (defvar tramp-debug-on-error nil
2084 "Like `debug-on-error' but used Tramp internal.")
2086 (defmacro tramp-condition-case-unless-debug
2087 (var bodyform
&rest handlers
)
2088 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
2089 `(let ((debug-on-error tramp-debug-on-error
))
2090 (tramp-compat-condition-case-unless-debug ,var
,bodyform
,@handlers
)))
2094 (defun tramp-file-name-handler (operation &rest args
)
2095 "Invoke Tramp file name handler.
2096 Falls back to normal file name handler if no Tramp file name handler exists."
2100 (tramp-replace-environment-variables
2101 (apply 'tramp-file-name-for-operation operation args
)))
2102 (completion (tramp-completion-mode-p))
2103 (foreign (tramp-find-foreign-file-name-handler filename
)))
2104 (with-parsed-tramp-file-name filename nil
2105 ;; Call the backend function.
2107 (tramp-condition-case-unless-debug err
2108 (let ((sf (symbol-function foreign
))
2110 ;; Some packages set the default directory to a
2111 ;; remote path, before respective Tramp packages
2112 ;; are already loaded. This results in
2113 ;; recursive loading. Therefore, we load the
2114 ;; Tramp packages locally.
2115 (when (and (listp sf
) (eq (car sf
) 'autoload
))
2116 (let ((default-directory
2117 (tramp-compat-temporary-file-directory)))
2118 (load (cadr sf
) 'noerror
'nomessage
)))
2119 ;; If `non-essential' is non-nil, Tramp shall
2120 ;; not open a new connection.
2121 ;; If Tramp detects that it shouldn't continue
2122 ;; to work, it throws the `suppress' event.
2123 ;; This could happen for example, when Tramp
2124 ;; tries to open the same connection twice in a
2125 ;; short time frame.
2126 ;; In both cases, we try the default handler then.
2128 (catch 'non-essential
2130 (apply foreign operation args
))))
2132 ((eq result
'non-essential
)
2134 v
5 "Non-essential received in operation %s"
2135 (append (list operation
) args
))
2136 (tramp-run-real-handler operation args
))
2137 ((eq result
'suppress
)
2138 (let (tramp-message-show-message)
2140 v
1 "Suppress received in operation %s"
2141 (append (list operation
) args
))
2142 (tramp-cleanup-connection v t
)
2143 (tramp-run-real-handler operation args
)))
2146 ;; Trace that somebody has interrupted the operation.
2148 (let (tramp-message-show-message)
2150 v
1 "Interrupt received in operation %s"
2151 (append (list operation
) args
)))
2152 ;; Propagate the quit signal.
2153 (signal (car err
) (cdr err
)))
2155 ;; When we are in completion mode, some failed
2156 ;; operations shall return at least a default value
2157 ;; in order to give the user a chance to correct the
2158 ;; file name in the minibuffer.
2159 ;; In order to get a full backtrace, one could apply
2160 ;; (setq tramp-debug-on-error t)
2163 ((and completion
(zerop (length localname
))
2164 (memq operation
'(file-exists-p file-directory-p
)))
2166 ((and completion
(zerop (length localname
))
2168 '(expand-file-name file-name-as-directory
)))
2170 ;; Propagate the error.
2171 (t (signal (car err
) (cdr err
))))))
2173 ;; Nothing to do for us.
2174 (tramp-run-real-handler operation args
)))))
2176 ;; When `tramp-mode' is not enabled, we don't do anything.
2177 (tramp-run-real-handler operation args
)))
2179 ;; In Emacs, there is some concurrency due to timers. If a timer
2180 ;; interrupts Tramp and wishes to use the same connection buffer as
2181 ;; the "main" Emacs, then garbage might occur in the connection
2182 ;; buffer. Therefore, we need to make sure that a timer does not use
2183 ;; the same connection buffer as the "main" Emacs. We implement a
2184 ;; cheap global lock, instead of locking each connection buffer
2185 ;; separately. The global lock is based on two variables,
2186 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2187 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2188 ;; processing of a single file operation, so we need to allow
2189 ;; recursive calls. That's where the `tramp-locker' variable comes in
2190 ;; -- it is let-bound to t during the execution of the current
2191 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2192 ;; then we should just proceed because we have been called
2193 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2194 ;; interrupting the "main" Emacs, and then we signal an error.
2196 (defvar tramp-locked nil
2197 "If non-nil, then Tramp is currently busy.
2198 Together with `tramp-locker', this implements a locking mechanism
2199 preventing reentrant calls of Tramp.")
2201 (defvar tramp-locker nil
2202 "If non-nil, then a caller has locked Tramp.
2203 Together with `tramp-locked', this implements a locking mechanism
2204 preventing reentrant calls of Tramp.")
2207 (progn (defun tramp-completion-file-name-handler (operation &rest args
)
2208 "Invoke Tramp file name completion handler.
2209 Falls back to normal file name handler if no Tramp file name handler exists."
2210 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
2211 ;; would otherwise use backslash.
2212 (let ((directory-sep-char ?
/)
2213 (fn (assoc operation tramp-completion-file-name-handler-alist
)))
2215 ;; When `tramp-mode' is not enabled, we don't do anything.
2217 ;; For other syntaxes than `sep', the regexp matches many common
2218 ;; situations where the user doesn't actually want to use Tramp.
2219 ;; So to avoid autoloading Tramp after typing just "/s", we
2220 ;; disable this part of the completion, unless the user implicitly
2221 ;; indicated his interest in using a fancier completion system.
2222 (or (eq tramp-syntax
'sep
)
2223 (featurep 'tramp
) ;; If it's loaded, we may as well use it.
2224 ;; `partial-completion-mode' does not exist in XEmacs.
2225 ;; It is obsoleted with Emacs 24.1.
2226 (and (boundp 'partial-completion-mode
)
2227 (symbol-value 'partial-completion-mode
))
2228 ;; FIXME: These may have been loaded even if the user never
2229 ;; intended to use them.
2231 (featurep 'icicles
)))
2232 (save-match-data (apply (cdr fn
) args
))
2233 (tramp-completion-run-real-handler operation args
)))))
2236 (progn (defun tramp-register-file-name-handlers ()
2237 "Add Tramp file name handlers to `file-name-handler-alist'."
2238 ;; Remove autoloaded handlers from file name handler alist. Useful,
2239 ;; if `tramp-syntax' has been changed.
2240 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist
)))
2241 (setq file-name-handler-alist
(delq a1 file-name-handler-alist
)))
2243 'tramp-completion-file-name-handler file-name-handler-alist
)))
2244 (setq file-name-handler-alist
(delq a1 file-name-handler-alist
)))
2245 ;; Add the handlers.
2246 (add-to-list 'file-name-handler-alist
2247 (cons tramp-file-name-regexp
'tramp-file-name-handler
))
2248 (put 'tramp-file-name-handler
'safe-magic t
)
2249 (add-to-list 'file-name-handler-alist
2250 (cons tramp-completion-file-name-regexp
2251 'tramp-completion-file-name-handler
))
2252 (put 'tramp-completion-file-name-handler
'safe-magic t
)
2253 ;; If jka-compr or epa-file are already loaded, move them to the
2254 ;; front of `file-name-handler-alist'.
2255 (dolist (fnh '(epa-file-handler jka-compr-handler
))
2256 (let ((entry (rassoc fnh file-name-handler-alist
)))
2258 (setq file-name-handler-alist
2259 (cons entry
(delete entry file-name-handler-alist
))))))))
2261 ;; `tramp-file-name-handler' must be registered before evaluation of
2262 ;; site-start and init files, because there might exist remote files
2263 ;; already, f.e. files kept via recentf-mode.
2265 (tramp-register-file-name-handlers)
2267 (defun tramp-exists-file-name-handler (operation &rest args
)
2268 "Check, whether OPERATION runs a file name handler."
2269 ;; The file name handler is determined on base of either an
2270 ;; argument, `buffer-file-name', or `default-directory'.
2272 (let* ((buffer-file-name "/")
2273 (default-directory "/")
2274 (fnha file-name-handler-alist
)
2275 (check-file-name-operation operation
)
2276 (file-name-handler-alist
2279 (lambda (operation &rest args
)
2280 "Returns OPERATION if it is the one to be checked."
2281 (if (equal check-file-name-operation operation
)
2283 (let ((file-name-handler-alist fnha
))
2284 (apply operation args
))))))))
2285 (equal (apply operation args
) operation
))))
2288 (defun tramp-unload-file-name-handlers ()
2289 (setq file-name-handler-alist
2290 (delete (rassoc 'tramp-file-name-handler
2291 file-name-handler-alist
)
2292 (delete (rassoc 'tramp-completion-file-name-handler
2293 file-name-handler-alist
)
2294 file-name-handler-alist
))))
2296 (add-hook 'tramp-unload-hook
'tramp-unload-file-name-handlers
)
2298 ;;; File name handler functions for completion mode:
2300 (defvar tramp-completion-mode nil
2301 "If non-nil, external packages signal that they are in file name completion.
2303 This is necessary, because Tramp uses a heuristic depending on last
2304 input event. This fails when external packages use other characters
2305 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2306 should never be set globally, the intention is to let-bind it.")
2308 ;; Necessary because `tramp-file-name-regexp-unified' and
2309 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2310 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2311 ;; to `tramp-file-name-handler'). Otherwise, it takes
2312 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2313 ;; risky, because completing a file might require loading other files,
2314 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2315 ;; variable. On the other hand, those files shouldn't have partial
2316 ;; Tramp file name syntax. Maybe another variable should be introduced
2317 ;; overwriting this check in such cases. Or we change Tramp file name
2318 ;; syntax in order to avoid ambiguities, like in XEmacs ...
2319 ;;;###tramp-autoload
2320 (defun tramp-completion-mode-p ()
2321 "Check, whether method / user name / host name completion is active."
2323 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2324 (and (boundp 'non-essential
) (symbol-value 'non-essential
))
2325 tramp-completion-mode
2327 (equal last-input-event
'tab
)
2328 (and (natnump last-input-event
)
2330 ;; ?\t has event-modifier 'control.
2331 (equal last-input-event ?
\t)
2332 (and (not (event-modifiers last-input-event
))
2333 (or (equal last-input-event ?
\?)
2334 (equal last-input-event ?\
)))))
2336 (and (featurep 'xemacs
)
2337 ;; `last-input-event' might be nil.
2338 (not (null last-input-event
))
2339 ;; `last-input-event' may have no character approximation.
2340 (tramp-compat-funcall 'event-to-character last-input-event
)
2342 ;; ?\t has event-modifier 'control.
2344 (tramp-compat-funcall 'event-to-character last-input-event
) ?
\t)
2345 (and (not (event-modifiers last-input-event
))
2347 (tramp-compat-funcall 'event-to-character last-input-event
)
2350 (tramp-compat-funcall 'event-to-character last-input-event
)
2353 (defun tramp-connectable-p (filename)
2354 "Check, whether it is possible to connect the remote host w/o side-effects.
2355 This is true, if either the remote host is already connected, or if we are
2356 not in completion mode."
2357 (and (tramp-tramp-file-p filename
)
2358 (with-parsed-tramp-file-name filename nil
2359 (or (not (tramp-completion-mode-p))
2360 (let* ((tramp-verbose 0)
2361 (p (tramp-get-connection-process v
)))
2362 (and p
(processp p
) (memq (process-status p
) '(run open
))))))))
2364 ;; Method, host name and user name completion.
2365 ;; `tramp-completion-dissect-file-name' returns a list of
2366 ;; tramp-file-name structures. For all of them we return possible completions.
2368 (defun tramp-completion-handle-file-name-all-completions (filename directory
)
2369 "Like `file-name-all-completions' for partial Tramp files."
2372 (tramp-drop-volume-letter (expand-file-name filename directory
)))
2375 ;; Suppress hop from completion.
2379 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2380 tramp-postfix-hop-regexp
2383 (setq hop
(match-string 1 fullname
)
2384 fullname
(replace-match "" nil nil fullname
1)))
2386 ;; Possible completion structures.
2387 (dolist (elt (tramp-completion-dissect-file-name fullname
))
2388 (let* ((method (tramp-file-name-method elt
))
2389 (user (tramp-file-name-user elt
))
2390 (host (tramp-file-name-host elt
))
2391 (localname (tramp-file-name-localname elt
))
2392 (m (tramp-find-method method user host
))
2393 (tramp-current-user user
) ; see `tramp-parse-passwd'
2396 (unless localname
;; Nothing to complete.
2400 ;; Method dependent user / host combinations.
2404 (setq all-user-hosts
2405 (append all-user-hosts
2406 (funcall (nth 0 x
) (nth 1 x
)))))
2407 (tramp-get-completion-function m
))
2413 (tramp-get-completion-user-host
2414 method user host
(nth 0 x
) (nth 1 x
)))
2415 (delq nil all-user-hosts
)))))
2417 ;; Possible methods.
2419 (append result
(tramp-get-completion-methods m
)))))))
2421 ;; Unify list, add hop, remove nil elements.
2422 (dolist (elt result
)
2424 (string-match tramp-prefix-regexp elt
)
2425 (setq elt
(replace-match (concat tramp-prefix-format hop
) nil nil elt
))
2428 (substring elt
(length (tramp-drop-volume-letter directory
))))))
2430 ;; Complete local parts.
2434 (apply (if (tramp-connectable-p fullname
)
2435 'tramp-completion-run-real-handler
2436 'tramp-run-real-handler
)
2437 'file-name-all-completions
(list (list filename directory
)))))))
2439 ;; Method, host name and user name completion for a file.
2441 (defun tramp-completion-handle-file-name-completion
2442 (filename directory
&optional predicate
)
2443 "Like `file-name-completion' for Tramp files."
2446 (mapcar 'list
(file-name-all-completions filename directory
))
2447 (when (and predicate
2448 (tramp-connectable-p (expand-file-name filename directory
)))
2449 (lambda (x) (funcall predicate
(expand-file-name (car x
) directory
))))))
2451 ;; I misuse a little bit the tramp-file-name structure in order to handle
2452 ;; completion possibilities for partial methods / user names / host names.
2453 ;; Return value is a list of tramp-file-name structures according to possible
2454 ;; completions. If "localname" is non-nil it means there
2455 ;; shouldn't be a completion anymore.
2457 ;; Expected results:
2459 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2460 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2461 ;; [nil "x" nil nil]
2462 ;; ["x" nil nil nil]
2464 ;; "/x:" "/x:y" "/x:y:"
2465 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2467 ;; ["x" nil "" nil] ["x" nil "y" nil]
2468 ;; ["x" "" nil nil] ["x" "y" nil nil]
2470 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2471 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2472 ;; "/[x/y@" "/[x/y@z"
2473 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2474 (defun tramp-completion-dissect-file-name (name)
2475 "Returns a list of `tramp-file-name' structures.
2476 They are collected by `tramp-completion-dissect-file-name1'."
2480 (tramp-completion-ipv6-regexp
2483 (if (zerop (length tramp-postfix-ipv6-format
))
2484 tramp-postfix-host-format
2485 tramp-postfix-ipv6-format
)))
2486 ;; "/method" "/[method"
2487 (tramp-completion-file-name-structure1
2488 (list (concat tramp-prefix-regexp
"\\(" tramp-method-regexp x-nil
"\\)$")
2491 (tramp-completion-file-name-structure2
2492 (list (concat tramp-prefix-regexp
"\\(" tramp-user-regexp x-nil
"\\)$")
2495 (tramp-completion-file-name-structure3
2496 (list (concat tramp-prefix-regexp
"\\(" tramp-host-regexp x-nil
"\\)$")
2498 ;; "/[ipv6" "/[ipv6"
2499 (tramp-completion-file-name-structure4
2500 (list (concat tramp-prefix-regexp
2501 tramp-prefix-ipv6-regexp
2502 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2504 ;; "/user@host" "/[user@host"
2505 (tramp-completion-file-name-structure5
2506 (list (concat tramp-prefix-regexp
2507 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2508 "\\(" tramp-host-regexp x-nil
"\\)$")
2510 ;; "/user@[ipv6" "/[user@ipv6"
2511 (tramp-completion-file-name-structure6
2512 (list (concat tramp-prefix-regexp
2513 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2514 tramp-prefix-ipv6-regexp
2515 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2517 ;; "/method:user" "/[method/user"
2518 (tramp-completion-file-name-structure7
2519 (list (concat tramp-prefix-regexp
2520 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2521 "\\(" tramp-user-regexp x-nil
"\\)$")
2523 ;; "/method:host" "/[method/host"
2524 (tramp-completion-file-name-structure8
2525 (list (concat tramp-prefix-regexp
2526 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2527 "\\(" tramp-host-regexp x-nil
"\\)$")
2529 ;; "/method:[ipv6" "/[method/ipv6"
2530 (tramp-completion-file-name-structure9
2531 (list (concat tramp-prefix-regexp
2532 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2533 tramp-prefix-ipv6-regexp
2534 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2536 ;; "/method:user@host" "/[method/user@host"
2537 (tramp-completion-file-name-structure10
2538 (list (concat tramp-prefix-regexp
2539 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2540 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2541 "\\(" tramp-host-regexp x-nil
"\\)$")
2543 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2544 (tramp-completion-file-name-structure11
2545 (list (concat tramp-prefix-regexp
2546 "\\(" tramp-method-regexp
"\\)" tramp-postfix-method-regexp
2547 "\\(" tramp-user-regexp
"\\)" tramp-postfix-user-regexp
2548 tramp-prefix-ipv6-regexp
2549 "\\(" tramp-completion-ipv6-regexp x-nil
"\\)$")
2552 (mapc (lambda (structure)
2553 (add-to-list 'result
2554 (tramp-completion-dissect-file-name1 structure name
)))
2556 tramp-completion-file-name-structure1
2557 tramp-completion-file-name-structure2
2558 tramp-completion-file-name-structure3
2559 tramp-completion-file-name-structure4
2560 tramp-completion-file-name-structure5
2561 tramp-completion-file-name-structure6
2562 tramp-completion-file-name-structure7
2563 tramp-completion-file-name-structure8
2564 tramp-completion-file-name-structure9
2565 tramp-completion-file-name-structure10
2566 tramp-completion-file-name-structure11
2567 tramp-file-name-structure
))
2571 (defun tramp-completion-dissect-file-name1 (structure name
)
2572 "Returns a `tramp-file-name' structure matching STRUCTURE.
2573 The structure consists of remote method, remote user,
2574 remote host and localname (filename on remote host)."
2577 (when (string-match (nth 0 structure
) name
)
2578 (let ((method (and (nth 1 structure
)
2579 (match-string (nth 1 structure
) name
)))
2580 (user (and (nth 2 structure
)
2581 (match-string (nth 2 structure
) name
)))
2582 (host (and (nth 3 structure
)
2583 (match-string (nth 3 structure
) name
)))
2584 (localname (and (nth 4 structure
)
2585 (match-string (nth 4 structure
) name
))))
2586 (vector method user host localname nil
)))))
2588 ;; This function returns all possible method completions, adding the
2589 ;; trailing method delimiter.
2590 (defun tramp-get-completion-methods (partial-method)
2591 "Returns all method completions for PARTIAL-METHOD."
2595 (string-match (concat "^" (regexp-quote partial-method
)) method
)
2596 (tramp-completion-make-tramp-file-name method nil nil nil
)))
2597 (mapcar 'car tramp-methods
)))
2599 ;; Compares partial user and host names with possible completions.
2600 (defun tramp-get-completion-user-host
2601 (method partial-user partial-host user host
)
2602 "Returns the most expanded string for user and host name completion.
2603 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2606 ((and partial-user partial-host
)
2608 (string-match (concat "^" (regexp-quote partial-host
)) host
)
2609 (string-equal partial-user
(or user partial-user
)))
2610 (setq user partial-user
)
2617 (and user
(string-match (concat "^" (regexp-quote partial-user
)) user
))
2623 (and host
(string-match (concat "^" (regexp-quote partial-host
)) host
))
2629 (unless (zerop (+ (length user
) (length host
)))
2630 (tramp-completion-make-tramp-file-name method user host nil
)))
2632 ;; Generic function.
2633 (defun tramp-parse-group (regexp match-level skip-regexp
)
2634 "Return a (user host) tuple allowed to access.
2635 User is always nil."
2637 (when (re-search-forward regexp
(point-at-eol) t
)
2638 (setq result
(list nil
(match-string match-level
))))
2640 (> (skip-chars-forward skip-regexp
) 0)
2644 ;; Generic function.
2645 (defun tramp-parse-file (filename function
)
2646 "Return a list of (user host) tuples allowed to access.
2647 User is always nil."
2648 ;; On Windows, there are problems in completion when
2649 ;; `default-directory' is remote.
2650 (let ((default-directory (tramp-compat-temporary-file-directory)))
2651 (when (file-readable-p filename
)
2653 (insert-file-contents filename
)
2654 (goto-char (point-min))
2655 (loop while
(not (eobp)) collect
(funcall function
))))))
2657 ;;;###tramp-autoload
2658 (defun tramp-parse-rhosts (filename)
2659 "Return a list of (user host) tuples allowed to access.
2660 Either user or host may be nil."
2661 (tramp-parse-file filename
'tramp-parse-rhosts-group
))
2663 (defun tramp-parse-rhosts-group ()
2664 "Return a (user host) tuple allowed to access.
2665 Either user or host may be nil."
2669 "^\\(" tramp-host-regexp
"\\)"
2670 "\\([ \t]+" "\\(" tramp-user-regexp
"\\)" "\\)?")))
2671 (when (re-search-forward regexp
(point-at-eol) t
)
2672 (setq result
(append (list (match-string 3) (match-string 1)))))
2676 ;;;###tramp-autoload
2677 (defun tramp-parse-shosts (filename)
2678 "Return a list of (user host) tuples allowed to access.
2679 User is always nil."
2680 (tramp-parse-file filename
'tramp-parse-shosts-group
))
2682 (defun tramp-parse-shosts-group ()
2683 "Return a (user host) tuple allowed to access.
2684 User is always nil."
2685 (tramp-parse-group (concat "^\\(" tramp-host-regexp
"\\)") 1 ","))
2687 ;;;###tramp-autoload
2688 (defun tramp-parse-sconfig (filename)
2689 "Return a list of (user host) tuples allowed to access.
2690 User is always nil."
2691 (tramp-parse-file filename
'tramp-parse-sconfig-group
))
2693 (defun tramp-parse-sconfig-group ()
2694 "Return a (user host) tuple allowed to access.
2695 User is always nil."
2697 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp
"\\)") 1 ","))
2699 ;; Generic function.
2700 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp
)
2701 "Return a list of (user host) tuples allowed to access.
2702 User is always nil."
2703 ;; On Windows, there are problems in completion when
2704 ;; `default-directory' is remote.
2705 (let* ((default-directory (tramp-compat-temporary-file-directory))
2706 (files (and (file-directory-p dirname
) (directory-files dirname
))))
2707 (loop for f in files
2708 when
(and (not (string-match "^\\.\\.?$" f
)) (string-match regexp f
))
2709 collect
(list nil
(match-string 1 f
)))))
2711 ;;;###tramp-autoload
2712 (defun tramp-parse-shostkeys (dirname)
2713 "Return a list of (user host) tuples allowed to access.
2714 User is always nil."
2715 (tramp-parse-shostkeys-sknownhosts
2716 dirname
(concat "^key_[0-9]+_\\(" tramp-host-regexp
"\\)\\.pub$")))
2718 ;;;###tramp-autoload
2719 (defun tramp-parse-sknownhosts (dirname)
2720 "Return a list of (user host) tuples allowed to access.
2721 User is always nil."
2722 (tramp-parse-shostkeys-sknownhosts
2724 (concat "^\\(" tramp-host-regexp
"\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2726 ;;;###tramp-autoload
2727 (defun tramp-parse-hosts (filename)
2728 "Return a list of (user host) tuples allowed to access.
2729 User is always nil."
2730 (tramp-parse-file filename
'tramp-parse-hosts-group
))
2732 (defun tramp-parse-hosts-group ()
2733 "Return a (user host) tuple allowed to access.
2734 User is always nil."
2736 (concat "^\\(" tramp-ipv6-regexp
"\\|" tramp-host-regexp
"\\)") 1 " \t"))
2738 ;; For su-alike methods it would be desirable to return "root@localhost"
2739 ;; as default. Unfortunately, we have no information whether any user name
2740 ;; has been typed already. So we use `tramp-current-user' as indication,
2741 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
2742 ;;;###tramp-autoload
2743 (defun tramp-parse-passwd (filename)
2744 "Return a list of (user host) tuples allowed to access.
2745 Host is always \"localhost\"."
2746 (if (zerop (length tramp-current-user
))
2748 (tramp-parse-file filename
'tramp-parse-passwd-group
)))
2750 (defun tramp-parse-passwd-group ()
2751 "Return a (user host) tuple allowed to access.
2752 Host is always \"localhost\"."
2754 (regexp (concat "^\\(" tramp-user-regexp
"\\):")))
2755 (when (re-search-forward regexp
(point-at-eol) t
)
2756 (setq result
(list (match-string 1) "localhost")))
2760 ;;;###tramp-autoload
2761 (defun tramp-parse-netrc (filename)
2762 "Return a list of (user host) tuples allowed to access.
2764 (tramp-parse-file filename
'tramp-parse-netrc-group
))
2766 (defun tramp-parse-netrc-group ()
2767 "Return a (user host) tuple allowed to access.
2772 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp
"\\)"
2773 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp
"\\)" "\\)?")))
2774 (when (re-search-forward regexp
(point-at-eol) t
)
2775 (setq result
(list (match-string 3) (match-string 1))))
2779 ;;;###tramp-autoload
2780 (defun tramp-parse-putty (registry-or-dirname)
2781 "Return a list of (user host) tuples allowed to access.
2782 User is always nil."
2783 (if (memq system-type
'(windows-nt))
2785 (when (zerop (tramp-call-process
2786 "reg" nil t nil
"query" registry-or-dirname
))
2787 (goto-char (point-min))
2788 (loop while
(not (eobp)) collect
2789 (tramp-parse-putty-group registry-or-dirname
))))
2791 (tramp-parse-shostkeys-sknownhosts
2792 registry-or-dirname
(concat "^\\(" tramp-host-regexp
"\\)$"))))
2794 (defun tramp-parse-putty-group (registry)
2795 "Return a (user host) tuple allowed to access.
2796 User is always nil."
2798 (regexp (concat (regexp-quote registry
) "\\\\\\(.+\\)")))
2799 (when (re-search-forward regexp
(point-at-eol) t
)
2800 (setq result
(list nil
(match-string 1))))
2804 ;;; Common file name handler functions for different backends:
2806 (defvar tramp-handle-file-local-copy-hook nil
2807 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2809 (defvar tramp-handle-write-region-hook nil
2810 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2812 (defun tramp-handle-directory-file-name (directory)
2813 "Like `directory-file-name' for Tramp files."
2814 ;; If localname component of filename is "/", leave it unchanged.
2815 ;; Otherwise, remove any trailing slash from localname component.
2816 ;; Method, host, etc, are unchanged. Does it make sense to try
2817 ;; to avoid parsing the filename?
2818 (with-parsed-tramp-file-name directory nil
2819 (if (and (not (zerop (length localname
)))
2820 (eq (aref localname
(1- (length localname
))) ?
/)
2821 (not (string= localname
"/")))
2822 (substring directory
0 -
1)
2825 (defun tramp-handle-directory-files
2826 (directory &optional full match nosort files-only
)
2827 "Like `directory-files' for Tramp files."
2828 ;; FILES-ONLY is valid for XEmacs only.
2829 (when (file-directory-p directory
)
2830 (setq directory
(file-name-as-directory (expand-file-name directory
)))
2831 (let ((temp (nreverse (file-name-all-completions "" directory
)))
2835 (setq item
(directory-file-name (pop temp
)))
2836 (when (and (or (null match
) (string-match match item
))
2837 (or (null files-only
)
2839 (and (equal files-only t
) (file-regular-p item
))
2840 ;; Directories only.
2841 (file-directory-p item
)))
2842 (push (if full
(concat directory item
) item
)
2844 (if nosort result
(sort result
'string
<)))))
2846 (defun tramp-handle-directory-files-and-attributes
2847 (directory &optional full match nosort id-format
)
2848 "Like `directory-files-and-attributes' for Tramp files."
2851 (cons x
(tramp-compat-file-attributes
2852 (if full x
(expand-file-name x directory
)) id-format
)))
2853 (directory-files directory full match nosort
)))
2855 (defun tramp-handle-dired-uncache (dir &optional dir-p
)
2856 "Like `dired-uncache' for Tramp files."
2857 ;; DIR-P is valid for XEmacs only.
2858 (with-parsed-tramp-file-name
2859 (if (or dir-p
(file-directory-p dir
)) dir
(file-name-directory dir
)) nil
2860 (tramp-flush-directory-property v localname
)))
2862 (defun tramp-handle-file-accessible-directory-p (filename)
2863 "Like `file-accessible-directory-p' for Tramp files."
2864 (and (file-directory-p filename
)
2865 (file-executable-p filename
)))
2867 (defun tramp-handle-file-exists-p (filename)
2868 "Like `file-exists-p' for Tramp files."
2869 (not (null (file-attributes filename
))))
2871 (defun tramp-handle-file-modes (filename)
2872 "Like `file-modes' for Tramp files."
2873 (let ((truename (or (file-truename filename
) filename
)))
2874 (when (file-exists-p truename
)
2875 (tramp-mode-string-to-int (nth 8 (file-attributes truename
))))))
2877 ;; Localname manipulation functions that grok Tramp localnames...
2878 (defun tramp-handle-file-name-as-directory (file)
2879 "Like `file-name-as-directory' but aware of Tramp files."
2880 ;; `file-name-as-directory' would be sufficient except localname is
2881 ;; the empty string.
2882 (let ((v (tramp-dissect-file-name file t
)))
2883 ;; Run the command on the localname portion only.
2884 (tramp-make-tramp-file-name
2885 (tramp-file-name-method v
)
2886 (tramp-file-name-user v
)
2887 (tramp-file-name-host v
)
2888 (tramp-run-real-handler
2889 'file-name-as-directory
(list (or (tramp-file-name-localname v
) ""))))))
2891 (defun tramp-handle-file-name-completion
2892 (filename directory
&optional predicate
)
2893 "Like `file-name-completion' for Tramp files."
2894 (unless (tramp-tramp-file-p directory
)
2896 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2900 (mapcar 'list
(file-name-all-completions filename directory
))
2902 (lambda (x) (funcall predicate
(expand-file-name (car x
) directory
))))))
2904 (defun tramp-handle-file-name-directory (file)
2905 "Like `file-name-directory' but aware of Tramp files."
2906 ;; Everything except the last filename thing is the directory. We
2907 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2908 ;; the remote file name parts. This is a problem when we are in
2909 ;; file name completion.
2910 (let ((v (tramp-dissect-file-name file t
)))
2911 ;; Run the command on the localname portion only.
2912 (tramp-make-tramp-file-name
2913 (tramp-file-name-method v
)
2914 (tramp-file-name-user v
)
2915 (tramp-file-name-host v
)
2916 (tramp-run-real-handler
2917 'file-name-directory
(list (or (tramp-file-name-localname v
) ""))))))
2919 (defun tramp-handle-file-name-nondirectory (file)
2920 "Like `file-name-nondirectory' but aware of Tramp files."
2921 (with-parsed-tramp-file-name file nil
2922 (tramp-run-real-handler 'file-name-nondirectory
(list localname
))))
2924 (defun tramp-handle-file-newer-than-file-p (file1 file2
)
2925 "Like `file-newer-than-file-p' for Tramp files."
2927 ((not (file-exists-p file1
)) nil
)
2928 ((not (file-exists-p file2
)) t
)
2929 (t (tramp-time-less-p (nth 5 (file-attributes file2
))
2930 (nth 5 (file-attributes file1
))))))
2932 (defun tramp-handle-file-regular-p (filename)
2933 "Like `file-regular-p' for Tramp files."
2934 (and (file-exists-p filename
)
2935 (eq ?-
(aref (nth 8 (file-attributes filename
)) 0))))
2937 (defun tramp-handle-file-remote-p (filename &optional identification connected
)
2938 "Like `file-remote-p' for Tramp files."
2939 ;; We do not want traces in the debug buffer.
2940 (let ((tramp-verbose (min tramp-verbose
3)))
2941 (when (tramp-tramp-file-p filename
)
2942 (let* ((v (tramp-dissect-file-name filename
))
2943 (p (tramp-get-connection-process v
))
2944 (c (and p
(processp p
) (memq (process-status p
) '(run open
)))))
2945 ;; We expand the file name only, if there is already a connection.
2946 (with-parsed-tramp-file-name
2947 (if c
(expand-file-name filename
) filename
) nil
2948 (and (or (not connected
) c
)
2950 ((eq identification
'method
) method
)
2951 ((eq identification
'user
) user
)
2952 ((eq identification
'host
) host
)
2953 ((eq identification
'localname
) localname
)
2954 (t (tramp-make-tramp-file-name method user host
"")))))))))
2956 (defun tramp-handle-file-symlink-p (filename)
2957 "Like `file-symlink-p' for Tramp files."
2958 (with-parsed-tramp-file-name filename nil
2959 (let ((x (car (file-attributes filename
))))
2961 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2962 ;; might do weird things.
2963 (if (file-name-absolute-p x
)
2964 (tramp-make-tramp-file-name method user host x
)
2967 (defun tramp-handle-find-backup-file-name (filename)
2968 "Like `find-backup-file-name' for Tramp files."
2969 (with-parsed-tramp-file-name filename nil
2970 ;; We set both variables. It doesn't matter whether it is
2972 (let ((backup-directory-alist
2974 (when (boundp 'backup-directory-alist
)
2975 (if (symbol-value 'tramp-backup-directory-alist
)
2980 (if (and (stringp (cdr x
))
2981 (file-name-absolute-p (cdr x
))
2982 (not (tramp-file-name-p (cdr x
))))
2983 (tramp-make-tramp-file-name method user host
(cdr x
))
2985 (symbol-value 'tramp-backup-directory-alist
))
2986 (symbol-value 'backup-directory-alist
))))
2988 (bkup-backup-directory-info
2990 (when (boundp 'bkup-backup-directory-info
)
2991 (if (symbol-value 'tramp-bkup-backup-directory-info
)
2997 (if (and (stringp (car (cdr x
)))
2998 (file-name-absolute-p (car (cdr x
)))
2999 (not (tramp-file-name-p (car (cdr x
)))))
3000 (tramp-make-tramp-file-name
3001 method user host
(car (cdr x
)))
3004 (symbol-value 'tramp-bkup-backup-directory-info
))
3005 (symbol-value 'bkup-backup-directory-info
)))))
3007 (tramp-run-real-handler 'find-backup-file-name
(list filename
)))))
3009 (defun tramp-handle-insert-file-contents
3010 (filename &optional visit beg end replace
)
3011 "Like `insert-file-contents' for Tramp files."
3012 (barf-if-buffer-read-only)
3013 (setq filename
(expand-file-name filename
))
3014 (let (result local-copy remote-copy
)
3015 (with-parsed-tramp-file-name filename nil
3016 (with-tramp-progress-reporter
3017 v
3 (format "Inserting `%s'" filename
)
3019 (if (not (file-exists-p filename
))
3020 ;; We don't raise a Tramp error, because it might be
3021 ;; suppressed, like in `find-file-noselect-1'.
3023 (list "File not found on remote host" filename
))
3025 (if (and (tramp-local-host-p v
)
3026 (let (file-name-handler-alist)
3027 (file-readable-p localname
)))
3028 ;; Short track: if we are on the local host, we can
3031 (tramp-run-real-handler
3032 'insert-file-contents
3033 (list localname visit beg end replace
)))
3035 ;; When we shall insert only a part of the file, we
3036 ;; copy this part. This works only for the shell file
3038 (when (and (or beg end
)
3039 (tramp-get-method-parameter
3040 (tramp-file-name-method v
) 'tramp-login-program
))
3041 (setq remote-copy
(tramp-make-tramp-temp-file v
))
3042 ;; This is defined in tramp-sh.el. Let's assume
3043 ;; this is loaded already.
3044 (tramp-compat-funcall
3049 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
3050 beg
(tramp-shell-quote-argument localname
)
3051 (- end beg
) remote-copy
))
3053 (format "dd bs=1 skip=%d if=%s of=%s"
3054 beg
(tramp-shell-quote-argument localname
)
3057 (format "dd bs=1 count=%d if=%s of=%s"
3058 end
(tramp-shell-quote-argument localname
)
3060 (setq tramp-temp-buffer-file-name nil beg nil end nil
))
3062 ;; `insert-file-contents-literally' takes care to
3063 ;; avoid calling jka-compr. By let-binding
3064 ;; `inhibit-file-name-operation', we propagate that
3065 ;; care to the `file-local-copy' operation.
3067 (let ((inhibit-file-name-operation
3068 (when (eq inhibit-file-name-operation
3069 'insert-file-contents
)
3072 ((stringp remote-copy
)
3074 (tramp-make-tramp-file-name
3075 method user host remote-copy
)))
3076 ((stringp tramp-temp-buffer-file-name
)
3077 (copy-file filename tramp-temp-buffer-file-name
'ok
)
3078 tramp-temp-buffer-file-name
)
3079 (t (file-local-copy filename
)))))
3081 ;; When the file is not readable for the owner, it
3082 ;; cannot be inserted, even if it is readable for the
3083 ;; group or for everybody.
3085 local-copy
(tramp-compat-octal-to-decimal "0600"))
3087 (when (and (null remote-copy
)
3088 (tramp-get-method-parameter
3089 method
'tramp-copy-keep-tmpfile
))
3090 ;; We keep the local file for performance reasons,
3091 ;; useful for "rsync".
3092 (setq tramp-temp-buffer-file-name local-copy
))
3094 ;; We must ensure that `file-coding-system-alist'
3095 ;; matches `local-copy'. We must also use `visit',
3096 ;; otherwise there might be an error in the
3097 ;; `revert-buffer' function under XEmacs.
3098 (let ((file-coding-system-alist
3099 (tramp-find-file-name-coding-system-alist
3100 filename local-copy
)))
3102 (insert-file-contents
3103 local-copy visit beg end replace
)))))
3108 (setq buffer-file-name filename
)
3109 (setq buffer-read-only
(not (file-writable-p filename
)))
3110 (set-visited-file-modtime)
3111 (set-buffer-modified-p nil
))
3112 (when (and (stringp local-copy
)
3113 (or remote-copy
(null tramp-temp-buffer-file-name
)))
3114 (delete-file local-copy
))
3115 (when (stringp remote-copy
)
3117 (tramp-make-tramp-file-name method user host remote-copy
)))))))
3120 (list (expand-file-name filename
)
3123 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix
)
3124 "Like `load' for Tramp files."
3125 (with-parsed-tramp-file-name (expand-file-name file
) nil
3127 (cond ((file-exists-p (concat file
".elc"))
3128 (setq file
(concat file
".elc")))
3129 ((file-exists-p (concat file
".el"))
3130 (setq file
(concat file
".el")))))
3132 ;; The first condition is always true for absolute file names.
3133 ;; Included for safety's sake.
3134 (unless (or (file-name-directory file
)
3135 (string-match "\\.elc?\\'" file
))
3138 "File `%s' does not include a `.el' or `.elc' suffix" file
)))
3140 (when (not (file-exists-p file
))
3141 (tramp-error v
'file-error
"Cannot load nonexistent file `%s'" file
)))
3142 (if (not (file-exists-p file
))
3144 (let ((tramp-message-show-message (not nomessage
)))
3145 (with-tramp-progress-reporter v
0 (format "Loading %s" file
)
3146 (let ((local-copy (file-local-copy file
)))
3148 (tramp-compat-load local-copy noerror t nosuffix must-suffix
)
3149 (delete-file local-copy
)))))
3152 (defun tramp-handle-shell-command
3153 (command &optional output-buffer error-buffer
)
3154 "Like `shell-command' for Tramp files."
3155 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command
))
3156 ;; We cannot use `shell-file-name' and `shell-command-switch',
3157 ;; they are variables of the local host.
3160 (tramp-get-method-parameter
3161 (tramp-file-name-method
3162 (tramp-dissect-file-name default-directory
))
3163 'tramp-remote-shell
)
3164 (tramp-get-method-parameter
3165 (tramp-file-name-method
3166 (tramp-dissect-file-name default-directory
))
3167 'tramp-remote-shell-args
))
3168 (list (substring command
0 asynchronous
))))
3172 ((bufferp output-buffer
) output-buffer
)
3173 ((stringp output-buffer
) (get-buffer-create output-buffer
))
3175 (setq current-buffer-p t
)
3177 (t (get-buffer-create
3179 "*Async Shell Command*"
3180 "*Shell Command Output*")))))
3183 ((bufferp error-buffer
) error-buffer
)
3184 ((stringp error-buffer
) (get-buffer-create error-buffer
))))
3186 (if (and (not asynchronous
) error-buffer
)
3187 (with-parsed-tramp-file-name default-directory nil
3188 (list output-buffer
(tramp-make-tramp-temp-file v
)))
3190 (p (get-buffer-process output-buffer
)))
3192 ;; Check whether there is another process running. Tramp does not
3193 ;; support 2 (asynchronous) processes in parallel.
3195 (if (yes-or-no-p "A command is running. Kill it? ")
3196 (ignore-errors (kill-process p
))
3197 (tramp-user-error p
"Shell command in progress")))
3199 (if current-buffer-p
3201 (barf-if-buffer-read-only)
3203 (with-current-buffer output-buffer
3204 (setq buffer-read-only nil
)
3207 (if (and (not current-buffer-p
) (integerp asynchronous
))
3210 (setq p
(apply 'start-file-process
"*Async Shell*" buffer args
))
3212 (pop-to-buffer output-buffer
)
3213 (setq mode-line-process
'(":%s"))
3215 (set-process-sentinel p
'shell-command-sentinel
)
3216 (set-process-filter p
'comint-output-filter
))
3220 (apply 'process-file
(car args
) nil buffer nil
(cdr args
))
3221 ;; Insert error messages if they were separated.
3222 (when (listp buffer
)
3223 (with-current-buffer error-buffer
3224 (insert-file-contents (cadr buffer
)))
3225 (delete-file (cadr buffer
)))
3226 (if current-buffer-p
3227 ;; This is like exchange-point-and-mark, but doesn't
3228 ;; activate the mark. It is cleaner to avoid activation,
3229 ;; even though the command loop would deactivate the mark
3230 ;; because we inserted text.
3231 (goto-char (prog1 (mark t
)
3232 (set-marker (mark-marker) (point)
3234 ;; There's some output, display it.
3235 (when (with-current-buffer output-buffer
(> (point-max) (point-min)))
3236 (if (functionp 'display-message-or-buffer
)
3237 (tramp-compat-funcall 'display-message-or-buffer output-buffer
)
3238 (pop-to-buffer output-buffer
))))))))
3240 (defun tramp-handle-substitute-in-file-name (filename)
3241 "Like `substitute-in-file-name' for Tramp files.
3242 \"//\" and \"/~\" substitute only in the local filename part."
3243 ;; First, we must replace environment variables.
3244 (setq filename
(tramp-replace-environment-variables filename
))
3245 (with-parsed-tramp-file-name filename nil
3246 ;; Ignore in LOCALNAME everything before "//" or "/~".
3247 (when (and (stringp localname
) (string-match ".+?/\\(/\\|~\\)" localname
))
3249 (concat (file-remote-p filename
)
3250 (replace-match "\\1" nil nil localname
)))
3251 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3252 (when (string-match "~$" filename
)
3253 (setq filename
(concat filename
"/"))))
3254 ;; We do not want to replace environment variables, again.
3255 (let (process-environment)
3256 (tramp-run-real-handler 'substitute-in-file-name
(list filename
)))))
3258 (defun tramp-handle-unhandled-file-name-directory (_filename)
3259 "Like `unhandled-file-name-directory' for Tramp files."
3260 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3261 ;; for backward compatibility.
3262 (expand-file-name "~/"))
3264 (defun tramp-handle-set-visited-file-modtime (&optional time-list
)
3265 "Like `set-visited-file-modtime' for Tramp files."
3266 (unless (buffer-file-name)
3267 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3270 (let ((remote-file-name-inhibit-cache t
))
3271 ;; '(-1 65535) means file doesn't exists yet.
3273 (or (nth 5 (file-attributes (buffer-file-name))) '(-1 65535)))))
3274 ;; We use '(0 0) as a don't-know value.
3275 (unless (equal time-list
'(0 0))
3276 (tramp-run-real-handler 'set-visited-file-modtime
(list time-list
))))
3278 (defun tramp-handle-verify-visited-file-modtime (&optional buf
)
3279 "Like `verify-visited-file-modtime' for Tramp files.
3280 At the time `verify-visited-file-modtime' calls this function, we
3281 already know that the buffer is visiting a file and that
3282 `visited-file-modtime' does not return 0. Do not call this
3283 function directly, unless those two cases are already taken care
3285 (with-current-buffer (or buf
(current-buffer))
3286 (let ((f (buffer-file-name)))
3287 ;; There is no file visiting the buffer, or the buffer has no
3288 ;; recorded last modification time, or there is no established
3291 (eq (visited-file-modtime) 0)
3292 (not (tramp-file-name-handler 'file-remote-p f nil
'connected
)))
3294 (with-parsed-tramp-file-name f nil
3295 (let* ((remote-file-name-inhibit-cache t
)
3296 (attr (file-attributes f
))
3297 (modtime (nth 5 attr
))
3298 (mt (visited-file-modtime)))
3301 ;; File exists, and has a known modtime.
3302 ((and attr
(not (equal modtime
'(0 0))))
3303 (< (abs (tramp-time-diff
3305 ;; For compatibility, deal with both the old
3306 ;; (HIGH . LOW) and the new (HIGH LOW) return
3307 ;; values of `visited-file-modtime'.
3309 (list (car mt
) (cdr mt
))
3312 ;; Modtime has the don't know value.
3314 ;; If file does not exist, say it is not modified if and
3315 ;; only if that agrees with the buffer's record.
3316 (t (equal mt
'(-1 65535))))))))))
3318 (defun tramp-handle-file-notify-add-watch (filename _flags _callback
)
3319 "Like `file-notify-add-watch' for Tramp files."
3320 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3322 (setq filename
(expand-file-name filename
))
3323 (with-parsed-tramp-file-name filename nil
3325 v
'file-notify-error
"File notification not supported for `%s'" filename
)))
3327 (defun tramp-handle-file-notify-rm-watch (proc)
3328 "Like `file-notify-rm-watch' for Tramp files."
3329 ;; The descriptor must be a process object.
3330 (unless (and (processp proc
) (gethash proc file-notify-descriptors
))
3331 (tramp-error proc
'file-notify-error
"Not a valid descriptor %S" proc
))
3332 (tramp-message proc
6 "Kill %S" proc
)
3333 (kill-process proc
))
3335 ;;; Functions for establishing connection:
3337 ;; The following functions are actions to be taken when seeing certain
3338 ;; prompts from the remote host. See the variable
3339 ;; `tramp-actions-before-shell' for usage of these functions.
3341 (defun tramp-action-login (_proc vec
)
3342 "Send the login name."
3343 (when (not (stringp tramp-current-user
))
3344 (setq tramp-current-user
3345 (with-tramp-connection-property vec
"login-as"
3346 (save-window-excursion
3347 (let ((enable-recursive-minibuffers t
))
3348 (pop-to-buffer (tramp-get-connection-buffer vec
))
3349 (read-string (match-string 0)))))))
3350 (with-current-buffer (tramp-get-connection-buffer vec
)
3351 (tramp-message vec
6 "\n%s" (buffer-string)))
3352 (tramp-message vec
3 "Sending login name `%s'" tramp-current-user
)
3353 (tramp-send-string vec
(concat tramp-current-user tramp-local-end-of-line
)))
3355 (defun tramp-action-password (proc vec
)
3356 "Query the user for a password."
3357 (with-current-buffer (process-buffer proc
)
3358 (let ((enable-recursive-minibuffers t
)
3359 (case-fold-search t
))
3360 (tramp-check-for-regexp proc tramp-password-prompt-regexp
)
3361 (tramp-message vec
3 "Sending %s" (match-string 1))
3362 ;; We don't call `tramp-send-string' in order to hide the
3363 ;; password from the debug buffer.
3364 (process-send-string
3365 proc
(concat (tramp-read-passwd proc
) tramp-local-end-of-line
))
3366 ;; Hide password prompt.
3367 (narrow-to-region (point-max) (point-max)))))
3369 (defun tramp-action-succeed (_proc _vec
)
3370 "Signal success in finding shell prompt."
3371 (throw 'tramp-action
'ok
))
3373 (defun tramp-action-permission-denied (proc _vec
)
3374 "Signal permission denied."
3376 (throw 'tramp-action
'permission-denied
))
3378 (defun tramp-action-yesno (proc vec
)
3379 "Ask the user for confirmation using `yes-or-no-p'.
3380 Send \"yes\" to remote process on confirmation, abort otherwise.
3381 See also `tramp-action-yn'."
3382 (save-window-excursion
3383 (let ((enable-recursive-minibuffers t
))
3384 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec
)))
3385 (unless (yes-or-no-p (match-string 0))
3387 (throw 'tramp-action
'permission-denied
))
3388 (with-current-buffer (tramp-get-connection-buffer vec
)
3389 (tramp-message vec
6 "\n%s" (buffer-string)))
3390 (tramp-send-string vec
(concat "yes" tramp-local-end-of-line
)))))
3392 (defun tramp-action-yn (proc vec
)
3393 "Ask the user for confirmation using `y-or-n-p'.
3394 Send \"y\" to remote process on confirmation, abort otherwise.
3395 See also `tramp-action-yesno'."
3396 (save-window-excursion
3397 (let ((enable-recursive-minibuffers t
))
3398 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec
)))
3399 (unless (y-or-n-p (match-string 0))
3401 (throw 'tramp-action
'permission-denied
))
3402 (with-current-buffer (tramp-get-connection-buffer vec
)
3403 (tramp-message vec
6 "\n%s" (buffer-string)))
3404 (tramp-send-string vec
(concat "y" tramp-local-end-of-line
)))))
3406 (defun tramp-action-terminal (_proc vec
)
3407 "Tell the remote host which terminal type to use.
3408 The terminal type can be configured with `tramp-terminal-type'."
3409 (tramp-message vec
5 "Setting `%s' as terminal type." tramp-terminal-type
)
3410 (with-current-buffer (tramp-get-connection-buffer vec
)
3411 (tramp-message vec
6 "\n%s" (buffer-string)))
3412 (tramp-send-string vec
(concat tramp-terminal-type tramp-local-end-of-line
)))
3414 (defun tramp-action-process-alive (proc _vec
)
3415 "Check, whether a process has finished."
3416 (unless (memq (process-status proc
) '(run open
))
3417 (throw 'tramp-action
'process-died
)))
3419 (defun tramp-action-out-of-band (proc vec
)
3420 "Check, whether an out-of-band copy has finished."
3421 (cond ((and (memq (process-status proc
) '(stop exit
))
3422 (zerop (process-exit-status proc
)))
3423 (tramp-message vec
3 "Process has finished.")
3424 (throw 'tramp-action
'ok
))
3425 ((or (and (memq (process-status proc
) '(stop exit
))
3426 (not (zerop (process-exit-status proc
))))
3427 (memq (process-status proc
) '(signal)))
3428 ;; `scp' could have copied correctly, but set modes could have failed.
3429 ;; This can be ignored.
3430 (with-current-buffer (process-buffer proc
)
3431 (goto-char (point-min))
3432 (if (re-search-forward tramp-operation-not-permitted-regexp nil t
)
3434 (tramp-message vec
5 "'set mode' error ignored.")
3435 (tramp-message vec
3 "Process has finished.")
3436 (throw 'tramp-action
'ok
))
3437 (tramp-message vec
3 "Process has died.")
3438 (throw 'tramp-action
'process-died
))))
3441 ;;; Functions for processing the actions:
3443 (defun tramp-process-one-action (proc vec actions
)
3444 "Wait for output from the shell and perform one action."
3445 (let ((case-fold-search t
)
3446 found todo item pattern action
)
3448 ;; Reread output once all actions have been performed.
3449 ;; Obviously, the output was not complete.
3450 (tramp-accept-process-output proc
1)
3453 (setq item
(pop todo
))
3454 (setq pattern
(format "\\(%s\\)\\'" (symbol-value (nth 0 item
))))
3455 (setq action
(nth 1 item
))
3457 vec
5 "Looking for regexp \"%s\" from remote shell" pattern
)
3458 (when (tramp-check-for-regexp proc pattern
)
3459 (tramp-message vec
5 "Call `%s'" (symbol-name action
))
3460 (setq found
(funcall action proc vec
)))))
3463 (defun tramp-process-actions (proc vec pos actions
&optional timeout
)
3464 "Perform ACTIONS until success or TIMEOUT.
3465 PROC and VEC indicate the remote connection to be used. POS, if
3466 set, is the starting point of the region to be deleted in the
3468 ;; Enable `auth-source' and `password-cache'. We must use
3469 ;; tramp-current-* variables in case we have several hops.
3470 (tramp-set-connection-property
3471 (tramp-dissect-file-name
3472 (tramp-make-tramp-file-name
3473 tramp-current-method tramp-current-user tramp-current-host
""))
3474 "first-password-request" t
)
3476 (with-tramp-progress-reporter
3477 proc
3 "Waiting for prompts from remote shell"
3480 (with-timeout (timeout (setq exit
'timeout
))
3483 (catch 'tramp-action
3484 (tramp-process-one-action proc vec actions
)))))
3487 (catch 'tramp-action
3488 (tramp-process-one-action proc vec actions
)))))
3489 (with-current-buffer (tramp-get-connection-buffer vec
)
3491 (tramp-message vec
6 "\n%s" (buffer-string)))
3492 (unless (eq exit
'ok
)
3493 (tramp-clear-passwd vec
)
3494 (delete-process proc
)
3495 (tramp-error-with-buffer
3496 (tramp-get-connection-buffer vec
) vec
'file-error
3498 ((eq exit
'permission-denied
) "Permission denied")
3499 ((eq exit
'process-died
)
3501 "Tramp failed to connect. If this happens repeatedly, try\n"
3502 " `M-x tramp-cleanup-this-connection'"))
3505 "Timeout reached, see buffer `%s' for details"
3506 (tramp-get-connection-buffer vec
)))
3507 (t "Login failed")))))
3509 (with-current-buffer (tramp-get-connection-buffer vec
)
3510 (let (buffer-read-only) (delete-region pos
(point))))))))
3512 :;; Utility functions:
3514 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs
)
3515 "Like `accept-process-output' for Tramp processes.
3516 This is needed in order to hide `last-coding-system-used', which is set
3517 for process communication also."
3518 (with-current-buffer (process-buffer proc
)
3519 (tramp-message proc
10 "%s %s" proc
(process-status proc
))
3520 (let (buffer-read-only last-coding-system-used
)
3521 ;; Under Windows XP, accept-process-output doesn't return
3522 ;; sometimes. So we add an additional timeout.
3523 (with-timeout ((or timeout
1))
3524 (if (featurep 'xemacs
)
3525 (accept-process-output proc timeout timeout-msecs
)
3526 (accept-process-output proc timeout timeout-msecs
(and proc t
)))))
3527 (tramp-message proc
10 "\n%s" (buffer-string))))
3529 (defun tramp-check-for-regexp (proc regexp
)
3530 "Check, whether REGEXP is contained in process buffer of PROC.
3531 Erase echoed commands if exists."
3532 (with-current-buffer (process-buffer proc
)
3533 (goto-char (point-min))
3535 ;; Check whether we need to remove echo output.
3536 (when (and (tramp-get-connection-property proc
"check-remote-echo" nil
)
3537 (re-search-forward tramp-echoed-echo-mark-regexp nil t
))
3538 (let ((begin (match-beginning 0)))
3539 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t
)
3540 ;; Discard echo from remote output.
3541 (tramp-set-connection-property proc
"check-remote-echo" nil
)
3542 (tramp-message proc
5 "echo-mark found")
3544 (delete-region begin
(point))
3545 (goto-char (point-min)))))
3547 (when (or (not (tramp-get-connection-property proc
"check-remote-echo" nil
))
3548 ;; Sometimes, the echo string is suppressed on the remote side.
3550 (tramp-compat-funcall
3551 'substring-no-properties tramp-echo-mark-marker
3552 0 (min tramp-echo-mark-marker-length
(1- (point-max))))
3553 (tramp-compat-funcall
3554 'buffer-substring-no-properties
3556 (min (+ (point-min) tramp-echo-mark-marker-length
)
3558 ;; No echo to be handled, now we can look for the regexp.
3559 ;; Sometimes, lines are much to long, and we run into a "Stack
3560 ;; overflow in regexp matcher". For example, //DIRED// lines of
3561 ;; directory listings with some thousand files. Therefore, we
3562 ;; look from the end.
3563 (goto-char (point-max))
3564 (ignore-errors (re-search-backward regexp nil t
)))))
3566 (defun tramp-wait-for-regexp (proc timeout regexp
)
3567 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3568 Expects the output of PROC to be sent to the current buffer. Returns
3569 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3571 (with-current-buffer (process-buffer proc
)
3572 (let ((found (tramp-check-for-regexp proc regexp
))
3573 (start-time (current-time)))
3575 ;; Work around a bug in XEmacs 21, where the timeout
3576 ;; expires faster than it should. This degenerates
3577 ;; to polling for buggy XEmacsen, but oh, well.
3578 (while (and (not found
)
3579 (< (tramp-time-diff (current-time) start-time
)
3581 (with-timeout (timeout)
3583 (tramp-accept-process-output proc
1)
3584 (unless (memq (process-status proc
) '(run open
))
3585 (tramp-error-with-buffer
3586 nil proc
'file-error
"Process has died"))
3587 (setq found
(tramp-check-for-regexp proc regexp
))))))
3590 (tramp-accept-process-output proc
1)
3591 (unless (memq (process-status proc
) '(run open
))
3592 (tramp-error-with-buffer
3593 nil proc
'file-error
"Process has died"))
3594 (setq found
(tramp-check-for-regexp proc regexp
)))))
3595 (tramp-message proc
6 "\n%s" (buffer-string))
3599 proc
'file-error
"[[Regexp `%s' not found in %d secs]]"
3601 (tramp-error proc
'file-error
"[[Regexp `%s' not found]]" regexp
)))
3604 ;; It seems that Tru64 Unix does not like it if long strings are sent
3605 ;; to it in one go. (This happens when sending the Perl
3606 ;; `file-attributes' implementation, for instance.) Therefore, we
3607 ;; have this function which sends the string in chunks.
3608 (defun tramp-send-string (vec string
)
3609 "Send the STRING via connection VEC.
3611 The STRING is expected to use Unix line-endings, but the lines sent to
3612 the remote host use line-endings as defined in the variable
3613 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3614 (let* ((p (tramp-get-connection-process vec
))
3615 (chunksize (tramp-get-connection-property p
"chunksize" nil
)))
3618 vec
'file-error
"Can't send string to remote host -- not logged in"))
3619 (tramp-set-connection-property p
"last-cmd-time" (current-time))
3620 (tramp-message vec
10 "%s" string
)
3621 (with-current-buffer (tramp-get-connection-buffer vec
)
3622 ;; Clean up the buffer. We cannot call `erase-buffer' because
3623 ;; narrowing might be in effect.
3624 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3625 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3627 (mapconcat 'identity
3628 (tramp-compat-split-string string
"\n")
3629 tramp-rsh-end-of-line
))
3630 (unless (or (string= string
"")
3631 (string-equal (substring string -
1) tramp-rsh-end-of-line
))
3632 (setq string
(concat string tramp-rsh-end-of-line
)))
3634 (if (and chunksize
(not (zerop chunksize
)))
3636 (end (length string
)))
3639 vec
10 "Sending chunk from %s to %s"
3640 pos
(min (+ pos chunksize
) end
))
3641 (process-send-string
3642 p
(substring string pos
(min (+ pos chunksize
) end
)))
3643 (setq pos
(+ pos chunksize
))))
3644 (process-send-string p string
)))))
3646 (defun tramp-get-inode (vec)
3647 "Returns the virtual inode number.
3648 If it doesn't exist, generate a new one."
3649 (with-tramp-file-property vec
(tramp-file-name-localname vec
) "inode"
3650 (setq tramp-inodes
(1+ tramp-inodes
))))
3652 (defun tramp-get-device (vec)
3653 "Returns the virtual device number.
3654 If it doesn't exist, generate a new one."
3655 (with-tramp-connection-property (tramp-get-connection-process vec
) "device"
3656 (cons -
1 (setq tramp-devices
(1+ tramp-devices
)))))
3658 (defun tramp-equal-remote (file1 file2
)
3659 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3660 The check depends on method, user and host name of the files. If
3661 one of the components is missing, the default values are used.
3662 The local file name parts of FILE1 and FILE2 are not taken into
3667 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3669 would yield `t'. On the other hand, the following check results in nil:
3671 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3672 (and (tramp-tramp-file-p file1
)
3673 (tramp-tramp-file-p file2
)
3674 (string-equal (file-remote-p file1
) (file-remote-p file2
))))
3676 ;;;###tramp-autoload
3677 (defun tramp-mode-string-to-int (mode-string)
3678 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3679 (let* (case-fold-search
3680 (mode-chars (string-to-vector mode-string
))
3681 (owner-read (aref mode-chars
1))
3682 (owner-write (aref mode-chars
2))
3683 (owner-execute-or-setid (aref mode-chars
3))
3684 (group-read (aref mode-chars
4))
3685 (group-write (aref mode-chars
5))
3686 (group-execute-or-setid (aref mode-chars
6))
3687 (other-read (aref mode-chars
7))
3688 (other-write (aref mode-chars
8))
3689 (other-execute-or-sticky (aref mode-chars
9)))
3693 ((char-equal owner-read ?r
) (tramp-compat-octal-to-decimal "00400"))
3694 ((char-equal owner-read ?-
) 0)
3695 (t (error "Second char `%c' must be one of `r-'" owner-read
)))
3697 ((char-equal owner-write ?w
) (tramp-compat-octal-to-decimal "00200"))
3698 ((char-equal owner-write ?-
) 0)
3699 (t (error "Third char `%c' must be one of `w-'" owner-write
)))
3701 ((char-equal owner-execute-or-setid ?x
)
3702 (tramp-compat-octal-to-decimal "00100"))
3703 ((char-equal owner-execute-or-setid ?S
)
3704 (tramp-compat-octal-to-decimal "04000"))
3705 ((char-equal owner-execute-or-setid ?s
)
3706 (tramp-compat-octal-to-decimal "04100"))
3707 ((char-equal owner-execute-or-setid ?-
) 0)
3708 (t (error "Fourth char `%c' must be one of `xsS-'"
3709 owner-execute-or-setid
)))
3711 ((char-equal group-read ?r
) (tramp-compat-octal-to-decimal "00040"))
3712 ((char-equal group-read ?-
) 0)
3713 (t (error "Fifth char `%c' must be one of `r-'" group-read
)))
3715 ((char-equal group-write ?w
) (tramp-compat-octal-to-decimal "00020"))
3716 ((char-equal group-write ?-
) 0)
3717 (t (error "Sixth char `%c' must be one of `w-'" group-write
)))
3719 ((char-equal group-execute-or-setid ?x
)
3720 (tramp-compat-octal-to-decimal "00010"))
3721 ((char-equal group-execute-or-setid ?S
)
3722 (tramp-compat-octal-to-decimal "02000"))
3723 ((char-equal group-execute-or-setid ?s
)
3724 (tramp-compat-octal-to-decimal "02010"))
3725 ((char-equal group-execute-or-setid ?-
) 0)
3726 (t (error "Seventh char `%c' must be one of `xsS-'"
3727 group-execute-or-setid
)))
3729 ((char-equal other-read ?r
)
3730 (tramp-compat-octal-to-decimal "00004"))
3731 ((char-equal other-read ?-
) 0)
3732 (t (error "Eighth char `%c' must be one of `r-'" other-read
)))
3734 ((char-equal other-write ?w
) (tramp-compat-octal-to-decimal "00002"))
3735 ((char-equal other-write ?-
) 0)
3736 (t (error "Ninth char `%c' must be one of `w-'" other-write
)))
3738 ((char-equal other-execute-or-sticky ?x
)
3739 (tramp-compat-octal-to-decimal "00001"))
3740 ((char-equal other-execute-or-sticky ?T
)
3741 (tramp-compat-octal-to-decimal "01000"))
3742 ((char-equal other-execute-or-sticky ?t
)
3743 (tramp-compat-octal-to-decimal "01001"))
3744 ((char-equal other-execute-or-sticky ?-
) 0)
3745 (t (error "Tenth char `%c' must be one of `xtT-'"
3746 other-execute-or-sticky
)))))))
3748 (defconst tramp-file-mode-type-map
3749 '((0 .
"-") ; Normal file (SVID-v2 and XPG2)
3751 (2 .
"c") ; character device
3752 (3 .
"m") ; multiplexed character device (v7)
3753 (4 .
"d") ; directory
3754 (5 .
"?") ; Named special file (XENIX)
3755 (6 .
"b") ; block device
3756 (7 .
"?") ; multiplexed block device (v7)
3757 (8 .
"-") ; regular file
3758 (9 .
"n") ; network special file (HP-UX)
3759 (10 .
"l") ; symlink
3760 (11 .
"?") ; ACL shadow inode (Solaris, not userspace)
3762 (13 .
"D") ; door special (Solaris)
3763 (14 .
"w")) ; whiteout (BSD)
3764 "A list of file types returned from the `stat' system call.
3765 This is used to map a mode number to a permission string.")
3767 ;;;###tramp-autoload
3768 (defun tramp-file-mode-from-int (mode)
3769 "Turn an integer representing a file mode into an ls(1)-like string."
3771 (assoc (logand (lsh mode -
12) 15) tramp-file-mode-type-map
)))
3772 (user (logand (lsh mode -
6) 7))
3773 (group (logand (lsh mode -
3) 7))
3774 (other (logand (lsh mode -
0) 7))
3775 (suid (> (logand (lsh mode -
9) 4) 0))
3776 (sgid (> (logand (lsh mode -
9) 2) 0))
3777 (sticky (> (logand (lsh mode -
9) 1) 0)))
3778 (setq user
(tramp-file-mode-permissions user suid
"s"))
3779 (setq group
(tramp-file-mode-permissions group sgid
"s"))
3780 (setq other
(tramp-file-mode-permissions other sticky
"t"))
3781 (concat type user group other
)))
3783 (defun tramp-file-mode-permissions (perm suid suid-text
)
3784 "Convert a permission bitset into a string.
3785 This is used internally by `tramp-file-mode-from-int'."
3786 (let ((r (> (logand perm
4) 0))
3787 (w (> (logand perm
2) 0))
3788 (x (> (logand perm
1) 0)))
3789 (concat (or (and r
"r") "-")
3790 (or (and w
"w") "-")
3791 (or (and suid x suid-text
) ; suid, execute
3792 (and suid
(upcase suid-text
)) ; suid, !execute
3793 (and x
"x") "-")))) ; !suid
3795 ;;;###tramp-autoload
3796 (defun tramp-get-local-uid (id-format)
3797 (if (equal id-format
'integer
) (user-uid) (user-login-name)))
3799 ;;;###tramp-autoload
3800 (defun tramp-get-local-gid (id-format)
3801 (if (and (fboundp 'group-gid
) (equal id-format
'integer
))
3802 (tramp-compat-funcall 'group-gid
)
3803 (nth 3 (tramp-compat-file-attributes "~/" id-format
))))
3805 ;;;###tramp-autoload
3806 (defun tramp-check-cached-permissions (vec access
)
3807 "Check `file-attributes' caches for VEC.
3808 Return t if according to the cache access type ACCESS is known to
3814 ((eq ?x access
) 3))))
3815 (dolist (suffix '("string" "integer") result
)
3821 (tramp-get-file-property
3822 vec
(tramp-file-name-localname vec
)
3823 (concat "file-attributes-" suffix
) nil
))
3825 (tramp-get-connection-property
3826 vec
(concat "uid-" suffix
) nil
))
3828 (tramp-get-connection-property
3829 vec
(concat "gid-" suffix
) nil
)))
3834 (eq t
(car file-attr
))
3835 (null (car file-attr
)))
3837 ;; World accessible.
3838 (eq access
(aref (nth 8 file-attr
) (+ offset
6)))
3839 ;; User accessible and owned by user.
3841 (eq access
(aref (nth 8 file-attr
) offset
))
3842 (equal remote-uid
(nth 2 file-attr
)))
3843 ;; Group accessible and owned by user's
3846 (eq access
(aref (nth 8 file-attr
) (+ offset
3)))
3847 (equal remote-gid
(nth 3 file-attr
)))))))))))
3849 ;;;###tramp-autoload
3850 (defun tramp-local-host-p (vec)
3851 "Return t if this points to the local host, nil otherwise."
3852 ;; We cannot use `tramp-file-name-real-host'. A port is an
3853 ;; indication for an ssh tunnel or alike.
3854 (let ((host (tramp-file-name-host vec
)))
3857 (string-match tramp-local-host-regexp host
)
3858 ;; The method shall be applied to one of the shell file name
3859 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3860 ;; alike, where it must fail.
3861 (tramp-get-method-parameter
3862 (tramp-file-name-method vec
) 'tramp-login-program
)
3863 ;; The local temp directory must be writable for the other user.
3865 (tramp-make-tramp-file-name
3866 (tramp-file-name-method vec
)
3867 (tramp-file-name-user vec
)
3869 (tramp-compat-temporary-file-directory)))
3870 ;; On some systems, chown runs only for root.
3871 (or (zerop (user-uid))
3872 ;; This is defined in tramp-sh.el. Let's assume this is
3874 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec
'integer
))))))
3876 (defun tramp-get-remote-tmpdir (vec)
3877 "Return directory for temporary files on the remote host identified by VEC."
3878 (with-tramp-connection-property vec
"tmpdir"
3879 (let ((dir (tramp-make-tramp-file-name
3880 (tramp-file-name-method vec
)
3881 (tramp-file-name-user vec
)
3882 (tramp-file-name-host vec
)
3884 (tramp-get-method-parameter
3885 (tramp-file-name-method vec
) 'tramp-tmpdir
)
3887 (if (and (file-directory-p dir
) (file-writable-p dir
))
3889 (tramp-error vec
'file-error
"Directory %s not accessible" dir
)))))
3891 ;;;###tramp-autoload
3892 (defun tramp-make-tramp-temp-file (vec)
3893 "Create a temporary file on the remote host identified by VEC.
3894 Return the local name of the temporary file."
3895 (let ((prefix (expand-file-name
3896 tramp-temp-name-prefix
(tramp-get-remote-tmpdir vec
)))
3899 ;; `make-temp-file' would be the natural choice for
3900 ;; implementation. But it calls `write-region' internally,
3901 ;; which also needs a temporary file - we would end in an
3903 (setq result
(make-temp-name prefix
))
3904 (if (file-exists-p result
)
3906 ;; This creates the file by side effect.
3907 (set-file-times result
)
3908 (set-file-modes result
(tramp-compat-octal-to-decimal "0700"))))
3910 ;; Return the local part.
3911 (with-parsed-tramp-file-name result nil localname
)))
3913 (defun tramp-delete-temp-file-function ()
3914 "Remove temporary files related to current buffer."
3915 (when (stringp tramp-temp-buffer-file-name
)
3916 (ignore-errors (delete-file tramp-temp-buffer-file-name
))))
3918 (add-hook 'kill-buffer-hook
'tramp-delete-temp-file-function
)
3919 (add-hook 'tramp-unload-hook
3921 (remove-hook 'kill-buffer-hook
3922 'tramp-delete-temp-file-function
)))
3924 ;;; Auto saving to a special directory:
3926 (defun tramp-handle-make-auto-save-file-name ()
3927 "Like `make-auto-save-file-name' for Tramp files.
3928 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3929 (let ((tramp-auto-save-directory tramp-auto-save-directory
)
3931 (tramp-subst-strs-in-string
3938 (buffer-file-name))))
3939 ;; File name must be unique. This is ensured with Emacs 22 (see
3940 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3941 ;; all other cases we must do it ourselves.
3942 (when (boundp 'auto-save-file-name-transforms
)
3945 (when (and (string-match (car x
) buffer-file-name
)
3946 (not (car (cddr x
))))
3947 (setq tramp-auto-save-directory
3948 (or tramp-auto-save-directory
3949 (tramp-compat-temporary-file-directory)))))
3950 (symbol-value 'auto-save-file-name-transforms
)))
3951 ;; Create directory.
3952 (when tramp-auto-save-directory
3953 (setq buffer-file-name
3954 (expand-file-name buffer-file-name tramp-auto-save-directory
))
3955 (unless (file-exists-p tramp-auto-save-directory
)
3956 (make-directory tramp-auto-save-directory t
)))
3957 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3958 ;; it is not a magic file name operation (since Emacs 22).
3959 ;; We must deactivate it temporarily.
3960 (if (not (ad-is-active 'make-auto-save-file-name
))
3961 (tramp-run-real-handler 'make-auto-save-file-name nil
)
3963 (ad-deactivate 'make-auto-save-file-name
)
3965 (tramp-run-real-handler 'make-auto-save-file-name nil
)
3966 (ad-activate 'make-auto-save-file-name
)))))
3968 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name
)
3969 (defadvice make-auto-save-file-name
3970 (around tramp-advice-make-auto-save-file-name
() activate
)
3971 "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files."
3972 (if (tramp-tramp-file-p (buffer-file-name))
3973 ;; We cannot call `tramp-handle-make-auto-save-file-name'
3974 ;; directly, because this would bypass the locking mechanism.
3975 (setq ad-return-value
3976 (tramp-file-name-handler 'make-auto-save-file-name
))
3982 'make-auto-save-file-name
3983 'around
'tramp-advice-make-auto-save-file-name
)
3984 (ad-activate 'make-auto-save-file-name
))))
3986 ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus
3987 ;; umask. This is a security threat.
3989 (defun tramp-set-auto-save-file-modes ()
3990 "Set permissions of autosaved remote files to the original permissions."
3991 (let ((bfn (buffer-file-name)))
3992 (when (and (tramp-tramp-file-p bfn
)
3994 (stringp buffer-auto-save-file-name
)
3995 (not (equal bfn buffer-auto-save-file-name
)))
3996 (unless (file-exists-p buffer-auto-save-file-name
)
3997 (write-region "" nil buffer-auto-save-file-name
))
3998 ;; Permissions should be set always, because there might be an old
3999 ;; auto-saved file belonging to another original file. This could
4000 ;; be a security threat.
4002 buffer-auto-save-file-name
4003 (or (file-modes bfn
) (tramp-compat-octal-to-decimal "0600"))))))
4005 (unless (and (featurep 'xemacs
)
4006 (= emacs-major-version
21)
4007 (> emacs-minor-version
4))
4008 (add-hook 'auto-save-hook
'tramp-set-auto-save-file-modes
)
4009 (add-hook 'tramp-unload-hook
4011 (remove-hook 'auto-save-hook
'tramp-set-auto-save-file-modes
))))
4013 (defun tramp-subst-strs-in-string (alist string
)
4014 "Replace all occurrences of the string FROM with TO in STRING.
4015 ALIST is of the form ((FROM . TO) ...)."
4018 (let* ((pr (car alist
))
4021 (while (string-match (regexp-quote from
) string
)
4022 (setq string
(replace-match to t t string
)))
4023 (setq alist
(cdr alist
))))
4026 ;;; Compatibility functions section:
4028 (defun tramp-call-process
4029 (program &optional infile destination display
&rest args
)
4030 "Calls `call-process' on the local host.
4031 This is needed because for some Emacs flavors Tramp has
4032 defadvised `call-process' to behave like `process-file'. The
4033 Lisp error raised when PROGRAM is nil is trapped also, returning 1.
4034 Furthermore, traces are written with verbosity of 6."
4036 (vector tramp-current-method tramp-current-user tramp-current-host nil nil
)
4037 6 "%s %s %s" program infile args
)
4038 (if (executable-find program
)
4039 (apply 'call-process program infile destination display args
)
4042 ;;;###tramp-autoload
4043 (defun tramp-read-passwd (proc &optional prompt
)
4044 "Read a password from user (compat function).
4045 Consults the auth-source package.
4046 Invokes `password-read' if available, `read-passwd' else."
4047 (let* ((case-fold-search t
)
4048 (key (tramp-make-tramp-file-name
4049 tramp-current-method tramp-current-user
4050 tramp-current-host
""))
4053 (with-current-buffer (process-buffer proc
)
4054 (tramp-check-for-regexp proc tramp-password-prompt-regexp
)
4055 (format "%s for %s " (capitalize (match-string 1)) key
))))
4056 auth-info auth-passwd
)
4057 (with-parsed-tramp-file-name key nil
4060 ;; See if auth-sources contains something useful, if it's
4061 ;; bound. `auth-source-user-or-password' is an obsoleted
4062 ;; function, it has been replaced by `auth-source-search'.
4063 (and (boundp 'auth-sources
)
4064 (tramp-get-connection-property v
"first-password-request" nil
)
4065 ;; Try with Tramp's current method.
4066 (if (fboundp 'auth-source-search
)
4068 (tramp-compat-funcall
4071 :user
(or tramp-current-user t
)
4072 :host tramp-current-host
4073 :port tramp-current-method
)
4074 auth-passwd
(plist-get (nth 0 auth-info
) :secret
)
4075 auth-passwd
(if (functionp auth-passwd
)
4076 (funcall auth-passwd
)
4078 (tramp-compat-funcall
4079 'auth-source-user-or-password
4080 "password" tramp-current-host tramp-current-method
)))
4081 ;; Try the password cache.
4082 (when (functionp 'password-read
)
4083 (unless (tramp-get-connection-property
4084 v
"first-password-request" nil
)
4085 (tramp-compat-funcall 'password-cache-remove key
))
4087 (tramp-compat-funcall 'password-read pw-prompt key
)))
4088 (tramp-compat-funcall 'password-cache-add key password
)
4090 ;; Else, get the password interactively.
4091 (read-passwd pw-prompt
))
4092 (tramp-set-connection-property v
"first-password-request" nil
)))))
4094 ;;;###tramp-autoload
4095 (defun tramp-clear-passwd (vec)
4096 "Clear password cache for connection related to VEC."
4097 (tramp-compat-funcall
4098 'password-cache-remove
4099 (tramp-make-tramp-file-name
4100 (tramp-file-name-method vec
)
4101 (tramp-file-name-user vec
)
4102 (tramp-file-name-host vec
)
4105 ;; Snarfed code from time-date.el and parse-time.el
4107 (defconst tramp-half-a-year
'(241 17024)
4108 "Evaluated by \"(days-to-time 183)\".")
4110 (defconst tramp-parse-time-months
4111 '(("jan" .
1) ("feb" .
2) ("mar" .
3)
4112 ("apr" .
4) ("may" .
5) ("jun" .
6)
4113 ("jul" .
7) ("aug" .
8) ("sep" .
9)
4114 ("oct" .
10) ("nov" .
11) ("dec" .
12))
4115 "Alist mapping month names to integers.")
4117 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
4118 ;;;###tramp-autoload
4119 (defun tramp-time-less-p (t1 t2
)
4120 "Say whether time value T1 is less than time value T2."
4121 (unless t1
(setq t1
'(0 0)))
4122 (unless t2
(setq t2
'(0 0)))
4123 (or (< (car t1
) (car t2
))
4124 (and (= (car t1
) (car t2
))
4125 (< (nth 1 t1
) (nth 1 t2
)))))
4127 ;; FIXME: Shouldn't this also look at any subseconds parts of T1 and T2?
4128 (defun tramp-time-subtract (t1 t2
)
4129 "Subtract two time values.
4130 Return the difference in the format of a time value."
4131 (unless t1
(setq t1
'(0 0)))
4132 (unless t2
(setq t2
'(0 0)))
4133 (let ((borrow (< (cadr t1
) (cadr t2
))))
4134 (list (- (car t1
) (car t2
) (if borrow
1 0))
4135 (- (+ (if borrow
65536 0) (cadr t1
)) (cadr t2
)))))
4137 ;;;###tramp-autoload
4138 (defun tramp-time-diff (t1 t2
)
4139 "Return the difference between the two times, in seconds.
4140 T1 and T2 are time values (as returned by `current-time' for example)."
4141 (cond ((and (fboundp 'subtract-time
)
4142 (fboundp 'float-time
))
4143 (tramp-compat-funcall
4144 'float-time
(tramp-compat-funcall 'subtract-time t1 t2
)))
4145 ((and (fboundp 'subtract-time
)
4146 (fboundp 'time-to-seconds
))
4147 (tramp-compat-funcall
4148 'time-to-seconds
(tramp-compat-funcall 'subtract-time t1 t2
)))
4149 ((fboundp 'itimer-time-difference
)
4150 (tramp-compat-funcall
4151 'itimer-time-difference
4152 (if (< (length t1
) 3) (append t1
'(0)) t1
)
4153 (if (< (length t2
) 3) (append t2
'(0)) t2
)))
4155 (let ((time (tramp-time-subtract t1 t2
)))
4156 (+ (* (car time
) 65536.0)
4158 (/ (or (nth 2 time
) 0) 1000000.0))))))
4160 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4161 ;; does not deal well with newline characters. Newline is replaced by
4162 ;; backslash newline. But if, say, the string `a backslash newline b'
4163 ;; is passed to a shell, the shell will expand this into "ab",
4164 ;; completely omitting the newline. This is not what was intended.
4165 ;; It does not appear to be possible to make the function
4166 ;; `shell-quote-argument' work with newlines without making it
4167 ;; dependent on the shell used. But within this package, we know that
4168 ;; we will always use a Bourne-like shell, so we use an approach which
4171 ;; The approach is simple: we call `shell-quote-argument', then
4172 ;; massage the newline part of the result.
4174 ;; This function should produce a string which is grokked by a Unix
4175 ;; shell, even if the Emacs is running on Windows. Since this is the
4176 ;; kludges section, we bind `system-type' in such a way that
4177 ;; `shell-quote-arguments' behaves as if on Unix.
4179 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4180 ;; function to work with Bourne-like shells.
4182 ;; CCC: This function should be rewritten so that
4183 ;; `shell-quote-argument' is not used. This way, we are safe from
4184 ;; changes in `shell-quote-argument'.
4185 ;;;###tramp-autoload
4186 (defun tramp-shell-quote-argument (s)
4187 "Similar to `shell-quote-argument', but groks newlines.
4188 Only works for Bourne-like shells."
4189 (let ((system-type 'not-windows
))
4191 (let ((result (shell-quote-argument s
))
4192 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line
))))
4193 (when (and (>= (length result
) 2)
4194 (string= (substring result
0 2) "\\~"))
4195 (setq result
(substring result
1)))
4196 (while (string-match nl result
)
4197 (setq result
(replace-match (format "'%s'" tramp-rsh-end-of-line
)
4201 ;;; Integration of eshell.el:
4203 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4204 ;; when `default-directory' points to another host.
4205 (defun tramp-eshell-directory-change ()
4206 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4207 (setq eshell-path-env
4208 (if (tramp-tramp-file-p default-directory
)
4209 (with-parsed-tramp-file-name default-directory nil
4213 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4214 ;; the remote path is only set in the session cache.
4215 (tramp-get-connection-property
4216 (tramp-get-connection-process v
) "remote-path" nil
)
4217 (tramp-get-connection-property v
"remote-path" nil
))
4221 (eval-after-load "esh-util"
4223 (tramp-eshell-directory-change)
4224 (add-hook 'eshell-directory-change-hook
4225 'tramp-eshell-directory-change
)
4226 (add-hook 'tramp-unload-hook
4228 (remove-hook 'eshell-directory-change-hook
4229 'tramp-eshell-directory-change
)))))
4231 ;; Checklist for `tramp-unload-hook'
4232 ;; - Unload all `tramp-*' packages
4233 ;; - Reset `file-name-handler-alist'
4234 ;; - Cleanup hooks where Tramp functions are in
4235 ;; - Cleanup advised functions
4236 ;; - Cleanup autoloads
4238 (defun tramp-unload-tramp ()
4239 "Discard Tramp from loading remote files."
4241 ;; ange-ftp settings must be enabled.
4242 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp
)
4243 ;; Maybe it's not loaded yet.
4244 (ignore-errors (unload-feature 'tramp
'force
)))
4250 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
4251 ;; `shell-quote-argument'.
4252 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4253 ;; by the files in that directory. Add this here.
4254 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4255 ;; * abbreviate-file-name
4256 ;; * Better error checking. At least whenever we see something
4257 ;; strange when doing zerop, we should kill the process and start
4258 ;; again. (Greg Stark)
4259 ;; * Username and hostname completion.
4260 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
4261 ;; * Make `tramp-default-user' obsolete.
4262 ;; * Implement a general server-local-variable mechanism, as there are
4263 ;; probably other variables that need different values for different
4264 ;; servers too. The user could then configure a variable (such as
4265 ;; tramp-server-local-variable-alist) to define any such variables
4266 ;; that they need to, which would then be let bound as appropriate
4267 ;; in tramp functions. (Jason Rumney)
4268 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4269 ;; * I was wondering if it would be possible to use tramp even if I'm
4270 ;; actually using sshfs. But when I launch a command I would like
4271 ;; to get it executed on the remote machine where the files really
4272 ;; are. (Andrea Crotti)
4273 ;; * Run emerge on two remote files. Bug is described here:
4274 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4276 ;; * Use also port to distinguish connections. This is needed for
4277 ;; different hosts sitting behind a single router (distinguished by
4278 ;; different port numbers). (Tzvi Edelman)
4280 ;;; tramp.el ends here