Refine multi-hop specs in Tramp
[emacs.git] / lisp / net / tramp.el
blob00ecb375c59e0b42c353b776c443bff8db42c36d
1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998-2016 Free Software Foundation, Inc.
5 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
6 ;; Michael Albinus <michael.albinus@gmx.de>
7 ;; Keywords: comm, processes
8 ;; Package: tramp
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/>.
25 ;;; Commentary:
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.
34 ;; Notes:
35 ;; -----
37 ;; This package only works for Emacs 23.1 and higher.
39 ;; Also see the todo list at the bottom of this file.
41 ;; The current version of Tramp can be retrieved from the following URL:
42 ;; http://ftp.gnu.org/gnu/tramp/
44 ;; There's a mailing list for this, as well. Its name is:
45 ;; tramp-devel@gnu.org
46 ;; You can use the Web to subscribe, under the following URL:
47 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
49 ;; For the adventurous, the current development sources are available
50 ;; via Git. You can find instructions about this at the following URL:
51 ;; http://savannah.gnu.org/projects/tramp/
53 ;; Don't forget to put on your asbestos longjohns, first!
55 ;;; Code:
57 (require 'tramp-compat)
59 ;; Pacify byte-compiler.
60 (eval-when-compile
61 (require 'cl))
62 (defvar eshell-path-env)
64 ;;; User Customizable Internal Variables:
66 (defgroup tramp nil
67 "Edit remote files with a combination of ssh, scp, etc."
68 :group 'files
69 :group 'comm
70 :link '(custom-manual "(tramp)Top")
71 :version "22.1")
73 ;; Maybe we need once a real Tramp mode, with key bindings etc.
74 ;;;###autoload
75 (defcustom tramp-mode t
76 "Whether Tramp is enabled.
77 If it is set to nil, all remote file names are used literally."
78 :group 'tramp
79 :type 'boolean
80 :require 'tramp)
82 (defcustom tramp-verbose 3
83 "Verbosity level for Tramp messages.
84 Any level x includes messages for all levels 1 .. x-1. The levels are
86 0 silent (no tramp messages at all)
87 1 errors
88 2 warnings
89 3 connection to remote hosts (default level)
90 4 activities
91 5 internal
92 6 sent and received strings
93 7 file caching
94 8 connection properties
95 9 test commands
96 10 traces (huge)."
97 :group 'tramp
98 :type 'integer
99 :require 'tramp)
101 (defcustom tramp-backup-directory-alist nil
102 "Alist of filename patterns and backup directory names.
103 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
104 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
105 is a local file name, the backup directory is prepended with Tramp file
106 name prefix \(method, user, host) of file.
108 \(setq tramp-backup-directory-alist backup-directory-alist)
110 gives the same backup policy for Tramp files on their hosts like the
111 policy for local files."
112 :group 'tramp
113 :type '(repeat (cons (regexp :tag "Regexp matching filename")
114 (directory :tag "Backup directory name")))
115 :require 'tramp)
117 (defcustom tramp-auto-save-directory nil
118 "Put auto-save files in this directory, if set.
119 The idea is to use a local directory so that auto-saving is faster.
120 This setting has precedence over `auto-save-file-name-transforms'."
121 :group 'tramp
122 :type '(choice (const :tag "Use default" nil)
123 (directory :tag "Auto save directory name"))
124 :require 'tramp)
126 (defcustom tramp-encoding-shell
127 (or (tramp-compat-funcall 'w32-shell-name) "/bin/sh")
128 "Use this program for encoding and decoding commands on the local host.
129 This shell is used to execute the encoding and decoding command on the
130 local host, so if you want to use `~' in those commands, you should
131 choose a shell here which groks tilde expansion. `/bin/sh' normally
132 does not understand tilde expansion.
134 For encoding and decoding, commands like the following are executed:
136 /bin/sh -c COMMAND < INPUT > OUTPUT
138 This variable can be used to change the \"/bin/sh\" part. See the
139 variable `tramp-encoding-command-switch' for the \"-c\" part.
141 If the shell must be forced to be interactive, see
142 `tramp-encoding-command-interactive'.
144 Note that this variable is not used for remote commands. There are
145 mechanisms in tramp.el which automatically determine the right shell to
146 use for the remote host."
147 :group 'tramp
148 :type '(file :must-match t)
149 :require 'tramp)
151 (defcustom tramp-encoding-command-switch
152 (if (tramp-compat-funcall 'w32-shell-dos-semantics) "/c" "-c")
153 "Use this switch together with `tramp-encoding-shell' for local commands.
154 See the variable `tramp-encoding-shell' for more information."
155 :group 'tramp
156 :type 'string
157 :require 'tramp)
159 (defcustom tramp-encoding-command-interactive
160 (unless (tramp-compat-funcall 'w32-shell-dos-semantics) "-i")
161 "Use this switch together with `tramp-encoding-shell' for interactive shells.
162 See the variable `tramp-encoding-shell' for more information."
163 :version "24.1"
164 :group 'tramp
165 :type '(choice (const nil) string)
166 :require 'tramp)
168 ;;;###tramp-autoload
169 (defvar tramp-methods nil
170 "Alist of methods for remote files.
171 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
172 Each NAME stands for a remote access method. Each PARAM is a
173 pair of the form (KEY VALUE). The following KEYs are defined:
174 * `tramp-remote-shell'
175 This specifies the shell to use on the remote host. This
176 MUST be a Bourne-like shell. It is normally not necessary to
177 set this to any value other than \"/bin/sh\": Tramp wants to
178 use a shell which groks tilde expansion, but it can search
179 for it. Also note that \"/bin/sh\" exists on all Unixen,
180 this might not be true for the value that you decide to use.
181 You Have Been Warned.
182 * `tramp-remote-shell-login'
183 This specifies the arguments to let `tramp-remote-shell' run
184 as a login shell. It defaults to (\"-l\"), but some shells,
185 like ksh, require another argument. See
186 `tramp-connection-properties' for a way to overwrite the
187 default value.
188 * `tramp-remote-shell-args'
189 For implementation of `shell-command', this specifies the
190 arguments to let `tramp-remote-shell' run a single command.
191 * `tramp-login-program'
192 This specifies the name of the program to use for logging in to the
193 remote host. This may be the name of rsh or a workalike program,
194 or the name of telnet or a workalike, or the name of su or a workalike.
195 * `tramp-login-args'
196 This specifies the list of arguments to pass to the above
197 mentioned program. Please note that this is a list of list of arguments,
198 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
199 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
200 There are some patterns: \"%h\" in this list is replaced by the host
201 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
202 port number, and \"%%\" can be used to obtain a literal percent character.
203 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
204 expansion (i.e. no host or no user specified), this list is not used as
205 argument. By this, arguments like (\"-l\" \"%u\") are optional.
206 \"%t\" is replaced by the temporary file name produced with
207 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
208 parameter of a program, if exists. \"%c\" adds additional
209 `tramp-ssh-controlmaster-options' options for the first hop.
210 * `tramp-login-env'
211 A list of environment variables and their values, which will
212 be set when calling `tramp-login-program'.
213 * `tramp-async-args'
214 When an asynchronous process is started, we know already that
215 the connection works. Therefore, we can pass additional
216 parameters to suppress diagnostic messages, in order not to
217 tamper the process output.
218 * `tramp-copy-program'
219 This specifies the name of the program to use for remotely copying
220 the file; this might be the absolute filename of scp or the name of
221 a workalike program. It is always applied on the local host.
222 * `tramp-copy-args'
223 This specifies the list of parameters to pass to the above mentioned
224 program, the hints for `tramp-login-args' also apply here.
225 * `tramp-copy-env'
226 A list of environment variables and their values, which will
227 be set when calling `tramp-copy-program'.
228 * `tramp-remote-copy-program'
229 The listener program to be applied on remote side, if needed.
230 * `tramp-remote-copy-args'
231 The list of parameters to pass to the listener program, the hints
232 for `tramp-login-args' also apply here. Additionally, \"%r\" could
233 be used here and in `tramp-copy-args'. It denotes a randomly
234 chosen port for the remote listener.
235 * `tramp-copy-keep-date'
236 This specifies whether the copying program when the preserves the
237 timestamp of the original file.
238 * `tramp-copy-keep-tmpfile'
239 This specifies whether a temporary local file shall be kept
240 for optimization reasons (useful for \"rsync\" methods).
241 * `tramp-copy-recursive'
242 Whether the operation copies directories recursively.
243 * `tramp-default-port'
244 The default port of a method is needed in case of gateway connections.
245 Additionally, it is used as indication which method is prepared for
246 passing gateways.
247 * `tramp-gw-args'
248 As the attribute name says, additional arguments are specified here
249 when a method is applied via a gateway.
250 * `tramp-tmpdir'
251 A directory on the remote host for temporary files. If not
252 specified, \"/tmp\" is taken as default.
253 * `tramp-connection-timeout'
254 This is the maximum time to be spent for establishing a connection.
255 In general, the global default value shall be used, but for
256 some methods, like \"su\" or \"sudo\", a shorter timeout
257 might be desirable.
259 What does all this mean? Well, you should specify `tramp-login-program'
260 for all methods; this program is used to log in to the remote site. Then,
261 there are two ways to actually transfer the files between the local and the
262 remote side. One way is using an additional scp-like program. If you want
263 to do this, set `tramp-copy-program' in the method.
265 Another possibility for file transfer is inline transfer, i.e. the
266 file is passed through the same buffer used by `tramp-login-program'. In
267 this case, the file contents need to be protected since the
268 `tramp-login-program' might use escape codes or the connection might not
269 be eight-bit clean. Therefore, file contents are encoded for transit.
270 See the variables `tramp-local-coding-commands' and
271 `tramp-remote-coding-commands' for details.
273 So, to summarize: if the method is an out-of-band method, then you
274 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
275 inline method, then these two parameters should be nil. Methods which
276 are fit for gateways must have `tramp-default-port' at least.
278 Notes:
280 When using `su' or `sudo' the phrase \"open connection to a remote
281 host\" sounds strange, but it is used nevertheless, for consistency.
282 No connection is opened to a remote host, but `su' or `sudo' is
283 started on the local host. You should specify a remote host
284 `localhost' or the name of the local host. Another host name is
285 useful only in combination with `tramp-default-proxies-alist'.")
287 (defcustom tramp-default-method
288 ;; An external copy method seems to be preferred, because it performs
289 ;; much better for large files, and it hasn't too serious delays
290 ;; for small files. But it must be ensured that there aren't
291 ;; permanent password queries. Either a password agent like
292 ;; "ssh-agent" or "Pageant" shall run, or the optional
293 ;; password-cache.el or auth-sources.el packages shall be active for
294 ;; password caching. If we detect that the user is running OpenSSH
295 ;; 4.0 or newer, we could reuse the connection, which calls also for
296 ;; an external method.
297 (cond
298 ;; PuTTY is installed. We don't take it, if it is installed on a
299 ;; non-windows system, or pscp from the pssh (parallel ssh) package
300 ;; is found.
301 ((and (eq system-type 'windows-nt) (executable-find "pscp")) "pscp")
302 ;; There is an ssh installation.
303 ((executable-find "scp") "scp")
304 ;; Fallback.
305 (t "ftp"))
306 "Default method to use for transferring files.
307 See `tramp-methods' for possibilities.
308 Also see `tramp-default-method-alist'."
309 :group 'tramp
310 :type 'string
311 :require 'tramp)
313 ;;;###tramp-autoload
314 (defcustom tramp-default-method-alist nil
315 "Default method to use for specific host/user pairs.
316 This is an alist of items (HOST USER METHOD). The first matching item
317 specifies the method to use for a file name which does not specify a
318 method. HOST and USER are regular expressions or nil, which is
319 interpreted as a regular expression which always matches. If no entry
320 matches, the variable `tramp-default-method' takes effect.
322 If the file name does not specify the user, lookup is done using the
323 empty string for the user name.
325 See `tramp-methods' for a list of possibilities for METHOD."
326 :group 'tramp
327 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
328 (choice :tag "User regexp" regexp sexp)
329 (choice :tag "Method name" string (const nil))))
330 :require 'tramp)
332 (defcustom tramp-default-user nil
333 "Default user to use for transferring files.
334 It is nil by default; otherwise settings in configuration files like
335 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
337 This variable is regarded as obsolete, and will be removed soon."
338 :group 'tramp
339 :type '(choice (const nil) string)
340 :require 'tramp)
342 ;;;###tramp-autoload
343 (defcustom tramp-default-user-alist nil
344 "Default user to use for specific method/host pairs.
345 This is an alist of items (METHOD HOST USER). The first matching item
346 specifies the user to use for a file name which does not specify a
347 user. METHOD and USER are regular expressions or nil, which is
348 interpreted as a regular expression which always matches. If no entry
349 matches, the variable `tramp-default-user' takes effect.
351 If the file name does not specify the method, lookup is done using the
352 empty string for the method name."
353 :group 'tramp
354 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
355 (choice :tag " Host regexp" regexp sexp)
356 (choice :tag " User name" string (const nil))))
357 :require 'tramp)
359 (defcustom tramp-default-host (system-name)
360 "Default host to use for transferring files.
361 Useful for su and sudo methods mostly."
362 :group 'tramp
363 :type 'string
364 :require 'tramp)
366 ;;;###tramp-autoload
367 (defcustom tramp-default-host-alist nil
368 "Default host to use for specific method/user pairs.
369 This is an alist of items (METHOD USER HOST). The first matching item
370 specifies the host to use for a file name which does not specify a
371 host. METHOD and HOST are regular expressions or nil, which is
372 interpreted as a regular expression which always matches. If no entry
373 matches, the variable `tramp-default-host' takes effect.
375 If the file name does not specify the method, lookup is done using the
376 empty string for the method name."
377 :group 'tramp
378 :version "24.4"
379 :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
380 (choice :tag " User regexp" regexp sexp)
381 (choice :tag " Host name" string (const nil))))
382 :require 'tramp)
384 (defcustom tramp-default-proxies-alist nil
385 "Route to be followed for specific host/user pairs.
386 This is an alist of items (HOST USER PROXY). The first matching
387 item specifies the proxy to be passed for a file name located on
388 a remote target matching USER@HOST. HOST and USER are regular
389 expressions. PROXY must be a Tramp filename without a localname
390 part. Method and user name on PROXY are optional, which is
391 interpreted with the default values. PROXY can contain the
392 patterns %h and %u, which are replaced by the strings matching
393 HOST or USER, respectively.
395 HOST, USER or PROXY could also be Lisp forms, which will be
396 evaluated. The result must be a string or nil, which is
397 interpreted as a regular expression which always matches."
398 :group 'tramp
399 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
400 (choice :tag "User regexp" regexp sexp)
401 (choice :tag " Proxy name" string (const nil))))
402 :require 'tramp)
404 (defcustom tramp-save-ad-hoc-proxies nil
405 "Whether to save ad-hoc proxies persistently."
406 :group 'tramp
407 :version "24.3"
408 :type 'boolean
409 :require 'tramp)
411 (defcustom tramp-restricted-shell-hosts-alist
412 (when (memq system-type '(windows-nt))
413 (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
414 "List of hosts, which run a restricted shell.
415 This is a list of regular expressions, which denote hosts running
416 a registered shell like \"rbash\". Those hosts can be used as
417 proxies only, see `tramp-default-proxies-alist'. If the local
418 host runs a registered shell, it shall be added to this list, too."
419 :version "24.3"
420 :group 'tramp
421 :type '(repeat (regexp :tag "Host regexp"))
422 :require 'tramp)
424 ;;;###tramp-autoload
425 (defconst tramp-local-host-regexp
426 (concat
427 "\\`"
428 (regexp-opt
429 (list "localhost" "localhost6" (system-name) "127.0.0.1" "::1") t)
430 "\\'")
431 "Host names which are regarded as local host.")
433 (defvar tramp-completion-function-alist nil
434 "Alist of methods for remote files.
435 This is a list of entries of the form \(NAME PAIR1 PAIR2 ...).
436 Each NAME stands for a remote access method. Each PAIR is of the form
437 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
438 names from FILE for completion. The following predefined FUNCTIONs exists:
440 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
441 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
442 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
443 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
444 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
445 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
446 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
447 * `tramp-parse-etc-group' for \"/etc/group\" like files.
448 * `tramp-parse-netrc' for \"~/.netrc\" like files.
449 * `tramp-parse-putty' for PuTTY registered sessions.
451 FUNCTION can also be a user defined function. For more details see
452 the info pages.")
454 (defconst tramp-echo-mark-marker "_echo"
455 "String marker to surround echoed commands.")
457 (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
458 "String length of `tramp-echo-mark-marker'.")
460 (defconst tramp-echo-mark
461 (concat tramp-echo-mark-marker
462 (make-string tramp-echo-mark-marker-length ?\b))
463 "String mark to be transmitted around shell commands.
464 Used to separate their echo from the output they produce. This
465 will only be used if we cannot disable remote echo via stty.
466 This string must have no effect on the remote shell except for
467 producing some echo which can later be detected by
468 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
469 followed by an equal number of backspaces to erase them will
470 usually suffice.")
472 (defconst tramp-echoed-echo-mark-regexp
473 (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
474 tramp-echo-mark-marker tramp-echo-mark-marker-length)
475 "Regexp which matches `tramp-echo-mark' as it gets echoed by
476 the remote shell.")
478 (defcustom tramp-local-end-of-line
479 (if (memq system-type '(windows-nt)) "\r\n" "\n")
480 "String used for end of line in local processes."
481 :version "24.1"
482 :group 'tramp
483 :type 'string
484 :require 'tramp)
486 (defcustom tramp-rsh-end-of-line "\n"
487 "String used for end of line in rsh connections.
488 I don't think this ever needs to be changed, so please tell me about it
489 if you need to change this."
490 :group 'tramp
491 :type 'string
492 :require 'tramp)
494 (defcustom tramp-login-prompt-regexp
495 ".*\\(user\\|login\\)\\( .*\\)?: *"
496 "Regexp matching login-like prompts.
497 The regexp should match at end of buffer.
499 Sometimes the prompt is reported to look like \"login as:\"."
500 :group 'tramp
501 :type 'regexp
502 :require 'tramp)
504 (defcustom tramp-shell-prompt-pattern
505 ;; Allow a prompt to start right after a ^M since it indeed would be
506 ;; displayed at the beginning of the line (and Zsh uses it). This
507 ;; regexp works only for GNU Emacs.
508 ;; Allow also [] style prompts. They can appear only during
509 ;; connection initialization; Tramp redefines the prompt afterwards.
510 (concat "\\(?:^\\|\r\\)"
511 "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
512 "Regexp to match prompts from remote shell.
513 Normally, Tramp expects you to configure `shell-prompt-pattern'
514 correctly, but sometimes it happens that you are connecting to a
515 remote host which sends a different kind of shell prompt. Therefore,
516 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
517 and also things matched by this variable. The default value of this
518 variable is similar to the default value of `shell-prompt-pattern',
519 which should work well in many cases.
521 This regexp must match both `tramp-initial-end-of-output' and
522 `tramp-end-of-output'."
523 :group 'tramp
524 :type 'regexp
525 :require 'tramp)
527 (defcustom tramp-password-prompt-regexp
528 (format "^.*\\(%s\\).*:\^@? *"
529 ;; `password-word-equivalents' has been introduced with Emacs 24.4.
530 (if (boundp 'password-word-equivalents)
531 (regexp-opt (symbol-value 'password-word-equivalents))
532 "password\\|passphrase"))
533 "Regexp matching password-like prompts.
534 The regexp should match at end of buffer.
536 The `sudo' program appears to insert a `^@' character into the prompt."
537 :version "24.4"
538 :group 'tramp
539 :type 'regexp
540 :require 'tramp)
542 (defcustom tramp-wrong-passwd-regexp
543 (concat "^.*"
544 ;; These strings should be on the last line
545 (regexp-opt '("Permission denied"
546 "Login incorrect"
547 "Login Incorrect"
548 "Connection refused"
549 "Connection closed"
550 "Timeout, server not responding."
551 "Sorry, try again."
552 "Name or service not known"
553 "Host key verification failed."
554 "No supported authentication methods left to try!") t)
555 ".*"
556 "\\|"
557 "^.*\\("
558 ;; Here comes a list of regexes, separated by \\|
559 "Received signal [0-9]+"
560 "\\).*")
561 "Regexp matching a `login failed' message.
562 The regexp should match at end of buffer."
563 :group 'tramp
564 :type 'regexp
565 :require 'tramp)
567 (defcustom tramp-yesno-prompt-regexp
568 (concat
569 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
570 "\\s-*")
571 "Regular expression matching all yes/no queries which need to be confirmed.
572 The confirmation should be done with yes or no.
573 The regexp should match at end of buffer.
574 See also `tramp-yn-prompt-regexp'."
575 :group 'tramp
576 :type 'regexp
577 :require 'tramp)
579 (defcustom tramp-yn-prompt-regexp
580 (concat
581 (regexp-opt '("Store key in cache? (y/n)"
582 "Update cached key? (y/n, Return cancels connection)")
584 "\\s-*")
585 "Regular expression matching all y/n queries which need to be confirmed.
586 The confirmation should be done with y or n.
587 The regexp should match at end of buffer.
588 See also `tramp-yesno-prompt-regexp'."
589 :group 'tramp
590 :type 'regexp
591 :require 'tramp)
593 (defcustom tramp-terminal-prompt-regexp
594 (concat "\\("
595 "TERM = (.*)"
596 "\\|"
597 "Terminal type\\? \\[.*\\]"
598 "\\)\\s-*")
599 "Regular expression matching all terminal setting prompts.
600 The regexp should match at end of buffer.
601 The answer will be provided by `tramp-action-terminal', which see."
602 :group 'tramp
603 :type 'regexp
604 :require 'tramp)
606 (defcustom tramp-operation-not-permitted-regexp
607 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
608 (regexp-opt '("Operation not permitted") t))
609 "Regular expression matching keep-date problems in (s)cp operations.
610 Copying has been performed successfully already, so this message can
611 be ignored safely."
612 :group 'tramp
613 :type 'regexp
614 :require 'tramp)
616 (defcustom tramp-copy-failed-regexp
617 (concat "\\(.+: "
618 (regexp-opt '("Permission denied"
619 "not a regular file"
620 "is a directory"
621 "No such file or directory")
623 "\\)\\s-*")
624 "Regular expression matching copy problems in (s)cp operations."
625 :group 'tramp
626 :type 'regexp
627 :require 'tramp)
629 (defcustom tramp-process-alive-regexp
631 "Regular expression indicating a process has finished.
632 In fact this expression is empty by intention, it will be used only to
633 check regularly the status of the associated process.
634 The answer will be provided by `tramp-action-process-alive',
635 `tramp-action-out-of-band', which see."
636 :group 'tramp
637 :type 'regexp
638 :require 'tramp)
640 (defconst tramp-temp-name-prefix "tramp."
641 "Prefix to use for temporary files.
642 If this is a relative file name (such as \"tramp.\"), it is considered
643 relative to the directory name returned by the function
644 `tramp-compat-temporary-file-directory' (which see). It may also be an
645 absolute file name; don't forget to include a prefix for the filename
646 part, though.")
648 (defconst tramp-temp-buffer-name " *tramp temp*"
649 "Buffer name for a temporary buffer.
650 It shall be used in combination with `generate-new-buffer-name'.")
652 (defvar tramp-temp-buffer-file-name nil
653 "File name of a persistent local temporary file.
654 Useful for \"rsync\" like methods.")
655 (make-variable-buffer-local 'tramp-temp-buffer-file-name)
656 (put 'tramp-temp-buffer-file-name 'permanent-local t)
658 ;;;###autoload
659 (defcustom tramp-syntax 'ftp
660 "Tramp filename syntax to be used.
662 It can have the following values:
664 `ftp' -- Ange-FTP like syntax
665 `sep' -- Syntax as defined for XEmacs originally."
666 :group 'tramp
667 :version "24.4"
668 :type '(choice (const :tag "Ange-FTP" ftp)
669 (const :tag "XEmacs" sep))
670 :require 'tramp)
672 (defconst tramp-prefix-format
673 (cond ((equal tramp-syntax 'ftp) "/")
674 ((equal tramp-syntax 'sep) "/[")
675 (t (error "Wrong `tramp-syntax' defined")))
676 "String matching the very beginning of Tramp file names.
677 Used in `tramp-make-tramp-file-name'.")
679 (defconst tramp-prefix-regexp
680 (concat "^" (regexp-quote tramp-prefix-format))
681 "Regexp matching the very beginning of Tramp file names.
682 Should always start with \"^\". Derived from `tramp-prefix-format'.")
684 (defconst tramp-method-regexp
685 "[a-zA-Z_0-9-]+"
686 "Regexp matching methods identifiers.")
688 (defconst tramp-postfix-method-format
689 (cond ((equal tramp-syntax 'ftp) ":")
690 ((equal tramp-syntax 'sep) "/")
691 (t (error "Wrong `tramp-syntax' defined")))
692 "String matching delimiter between method and user or host names.
693 Used in `tramp-make-tramp-file-name'.")
695 (defconst tramp-postfix-method-regexp
696 (regexp-quote tramp-postfix-method-format)
697 "Regexp matching delimiter between method and user or host names.
698 Derived from `tramp-postfix-method-format'.")
700 (defconst tramp-user-regexp "[^/|: \t]+"
701 "Regexp matching user names.")
703 ;;;###tramp-autoload
704 (defconst tramp-prefix-domain-format "%"
705 "String matching delimiter between user and domain names.")
707 ;;;###tramp-autoload
708 (defconst tramp-prefix-domain-regexp
709 (regexp-quote tramp-prefix-domain-format)
710 "Regexp matching delimiter between user and domain names.
711 Derived from `tramp-prefix-domain-format'.")
713 (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
714 "Regexp matching domain names.")
716 (defconst tramp-user-with-domain-regexp
717 (concat "\\(" tramp-user-regexp "\\)"
718 tramp-prefix-domain-regexp
719 "\\(" tramp-domain-regexp "\\)")
720 "Regexp matching user names with domain names.")
722 (defconst tramp-postfix-user-format "@"
723 "String matching delimiter between user and host names.
724 Used in `tramp-make-tramp-file-name'.")
726 (defconst tramp-postfix-user-regexp
727 (regexp-quote tramp-postfix-user-format)
728 "Regexp matching delimiter between user and host names.
729 Derived from `tramp-postfix-user-format'.")
731 (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
732 "Regexp matching host names.")
734 (defconst tramp-prefix-ipv6-format
735 (cond ((equal tramp-syntax 'ftp) "[")
736 ((equal tramp-syntax 'sep) "")
737 (t (error "Wrong `tramp-syntax' defined")))
738 "String matching left hand side of IPv6 addresses.
739 Used in `tramp-make-tramp-file-name'.")
741 (defconst tramp-prefix-ipv6-regexp
742 (regexp-quote tramp-prefix-ipv6-format)
743 "Regexp matching left hand side of IPv6 addresses.
744 Derived from `tramp-prefix-ipv6-format'.")
746 ;; The following regexp is a bit sloppy. But it shall serve our
747 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
748 ;; "::ffff:192.168.0.1".
749 (defconst tramp-ipv6-regexp
750 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
751 "Regexp matching IPv6 addresses.")
753 (defconst tramp-postfix-ipv6-format
754 (cond ((equal tramp-syntax 'ftp) "]")
755 ((equal tramp-syntax 'sep) "")
756 (t (error "Wrong `tramp-syntax' defined")))
757 "String matching right hand side of IPv6 addresses.
758 Used in `tramp-make-tramp-file-name'.")
760 (defconst tramp-postfix-ipv6-regexp
761 (regexp-quote tramp-postfix-ipv6-format)
762 "Regexp matching right hand side of IPv6 addresses.
763 Derived from `tramp-postfix-ipv6-format'.")
765 (defconst tramp-prefix-port-format
766 (cond ((equal tramp-syntax 'ftp) "#")
767 ((equal tramp-syntax 'sep) "#")
768 (t (error "Wrong `tramp-syntax' defined")))
769 "String matching delimiter between host names and port numbers.")
771 (defconst tramp-prefix-port-regexp
772 (regexp-quote tramp-prefix-port-format)
773 "Regexp matching delimiter between host names and port numbers.
774 Derived from `tramp-prefix-port-format'.")
776 (defconst tramp-port-regexp "[0-9]+"
777 "Regexp matching port numbers.")
779 (defconst tramp-host-with-port-regexp
780 (concat "\\(" tramp-host-regexp "\\)"
781 tramp-prefix-port-regexp
782 "\\(" tramp-port-regexp "\\)")
783 "Regexp matching host names with port numbers.")
785 (defconst tramp-postfix-hop-format "|"
786 "String matching delimiter after ad-hoc hop definitions.")
788 (defconst tramp-postfix-hop-regexp
789 (regexp-quote tramp-postfix-hop-format)
790 "Regexp matching delimiter after ad-hoc hop definitions.
791 Derived from `tramp-postfix-hop-format'.")
793 (defconst tramp-postfix-host-format
794 (cond ((equal tramp-syntax 'ftp) ":")
795 ((equal tramp-syntax 'sep) "]")
796 (t (error "Wrong `tramp-syntax' defined")))
797 "String matching delimiter between host names and localnames.
798 Used in `tramp-make-tramp-file-name'.")
800 (defconst tramp-postfix-host-regexp
801 (regexp-quote tramp-postfix-host-format)
802 "Regexp matching delimiter between host names and localnames.
803 Derived from `tramp-postfix-host-format'.")
805 (defconst tramp-localname-regexp ".*$"
806 "Regexp matching localnames.")
808 (defconst tramp-unknown-id-string "UNKNOWN"
809 "String used to denote an unknown user or group")
811 (defconst tramp-unknown-id-integer -1
812 "Integer used to denote an unknown user or group")
814 ;;; File name format:
816 (defconst tramp-remote-file-name-spec-regexp
817 (concat
818 "\\(?:" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
819 "\\(?:" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
820 "\\(" "\\(?:" tramp-host-regexp "\\|"
821 tramp-prefix-ipv6-regexp "\\(?:" tramp-ipv6-regexp "\\)?"
822 tramp-postfix-ipv6-regexp "\\)"
823 "\\(?:" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?")
824 "Regular expression matching a Tramp file name between prefix and postfix.")
826 (defconst tramp-file-name-structure
827 (list
828 (concat
829 tramp-prefix-regexp
830 "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
831 tramp-postfix-hop-regexp "\\)+" "\\)?"
832 tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
833 "\\(" tramp-localname-regexp "\\)")
834 5 6 7 8 1)
835 "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
836 the Tramp file name structure.
838 The first element REGEXP is a regular expression matching a Tramp file
839 name. The regex should contain parentheses around the method name,
840 the user name, the host name, and the file name parts.
842 The second element METHOD is a number, saying which pair of
843 parentheses matches the method name. The third element USER is
844 similar, but for the user name. The fourth element HOST is similar,
845 but for the host name. The fifth element FILE is for the file name.
846 The last element HOP is the ad-hoc hop definition, which could be a
847 cascade of several hops.
849 These numbers are passed directly to `match-string', which see. That
850 means the opening parentheses are counted to identify the pair.
852 See also `tramp-file-name-regexp'.")
854 ;;;###autoload
855 (defconst tramp-file-name-regexp-unified
856 (if (memq system-type '(cygwin windows-nt))
857 "\\`/\\(\\[.*\\]\\|[^/|:]\\{2,\\}[^/|]*\\):"
858 "\\`/[^/|:][^/|]*:")
859 "Value for `tramp-file-name-regexp' for unified remoting.
860 See `tramp-file-name-structure' for more explanations.
862 On W32 systems, the volume letter must be ignored.")
864 ;;;###autoload
865 (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]"
866 "Value for `tramp-file-name-regexp' for separate remoting.
867 See `tramp-file-name-structure' for more explanations.")
869 ;;;###autoload
870 (defvar tramp-file-name-regexp
871 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
872 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
873 (t (error "Wrong `tramp-syntax' defined")))
874 "Regular expression matching file names handled by Tramp.
875 This regexp should match Tramp file names but no other file
876 names. When calling `tramp-register-file-name-handlers', the
877 initial value is overwritten by the car of `tramp-file-name-structure'.")
879 ;;;###autoload
880 (defconst tramp-completion-file-name-regexp-unified
881 (if (memq system-type '(cygwin windows-nt))
882 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
883 "Value for `tramp-completion-file-name-regexp' for unified remoting.
884 See `tramp-file-name-structure' for more explanations.
886 On W32 systems, the volume letter must be ignored.")
888 ;;;###autoload
889 (defconst tramp-completion-file-name-regexp-separate
890 "\\`/\\([[][^]]*\\)?\\'"
891 "Value for `tramp-completion-file-name-regexp' for separate remoting.
892 See `tramp-file-name-structure' for more explanations.")
894 ;;;###autoload
895 (defconst tramp-completion-file-name-regexp
896 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
897 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
898 (t (error "Wrong `tramp-syntax' defined")))
899 "Regular expression matching file names handled by Tramp completion.
900 This regexp should match partial Tramp file names only.
902 Please note that the entry in `file-name-handler-alist' is made when
903 this file \(tramp.el) is loaded. This means that this variable must be set
904 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
905 updated after changing this variable.
907 Also see `tramp-file-name-structure'.")
909 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
910 ;; known to have a bug in `process-send-string'; some ssh connections appear
911 ;; to drop bytes when data is sent too quickly. There is also a connection
912 ;; buffer local variable, which is computed depending on remote host properties
913 ;; when `tramp-chunksize' is zero or nil.
914 (defcustom tramp-chunksize (when (memq system-type '(hpux)) 500)
915 ;; Parentheses in docstring starting at beginning of line are escaped.
916 ;; Fontification is messed up when
917 ;; `open-paren-in-column-0-is-defun-start' set to t.
918 "If non-nil, chunksize for sending input to local process.
919 It is necessary only on systems which have a buggy `process-send-string'
920 implementation. The necessity, whether this variable must be set, can be
921 checked via the following code:
923 (with-temp-buffer
924 (let* ((user \"xxx\") (host \"yyy\")
925 (init 0) (step 50)
926 (sent init) (received init))
927 (while (= sent received)
928 (setq sent (+ sent step))
929 (erase-buffer)
930 (let ((proc (start-process (buffer-name) (current-buffer)
931 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
932 (when (process-live-p proc)
933 (process-send-string proc (make-string sent ?\\ ))
934 (process-send-eof proc)
935 (process-send-eof proc))
936 (while (not (progn (goto-char (point-min))
937 (re-search-forward \"\\\\w+\" (point-max) t)))
938 (accept-process-output proc 1))
939 (when (process-live-p proc)
940 (setq received (string-to-number (match-string 0)))
941 (delete-process proc)
942 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
943 (sit-for 0))))
944 (if (> sent (+ init step))
945 (message \"You should set `tramp-chunksize' to a maximum of %s\"
946 (- sent step))
947 (message \"Test does not work\")
948 (display-buffer (current-buffer))
949 (sit-for 30))))
951 In the Emacs normally running Tramp, evaluate the above code
952 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
953 respectively). You can do this, for example, by pasting it into
954 the `*scratch*' buffer and then hitting C-j with the cursor after the
955 last closing parenthesis. Note that it works only if you have configured
956 \"ssh\" to run without password query, see ssh-agent(1).
958 You will see the number of bytes sent successfully to the remote host.
959 If that number exceeds 1000, you can stop the execution by hitting
960 C-g, because your Emacs is likely clean.
962 When it is necessary to set `tramp-chunksize', you might consider to
963 use an out-of-the-band method \(like \"scp\") instead of an internal one
964 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
965 performance.
967 If your Emacs is buggy, the code stops and gives you an indication
968 about the value `tramp-chunksize' should be set. Maybe you could just
969 experiment a bit, e.g. changing the values of `init' and `step'
970 in the third line of the code.
972 Please raise a bug report via \"M-x tramp-bug\" if your system needs
973 this variable to be set as well."
974 :group 'tramp
975 :type '(choice (const nil) integer)
976 :require 'tramp)
978 ;; Logging in to a remote host normally requires obtaining a pty. But
979 ;; Emacs on MacOS X has process-connection-type set to nil by default,
980 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
981 ;; for an override of the system default.
982 (defcustom tramp-process-connection-type t
983 "Overrides `process-connection-type' for connections from Tramp.
984 Tramp binds `process-connection-type' to the value given here before
985 opening a connection to a remote host."
986 :group 'tramp
987 :type '(choice (const nil) (const t) (const pty))
988 :require 'tramp)
990 (defcustom tramp-connection-timeout 60
991 "Defines the max time to wait for establishing a connection (in seconds).
992 This can be overwritten for different connection types in `tramp-methods'.
994 The timeout does not include the time reading a password."
995 :group 'tramp
996 :version "24.4"
997 :type 'integer
998 :require 'tramp)
1000 (defcustom tramp-connection-min-time-diff 5
1001 "Defines seconds between two consecutive connection attempts.
1002 This is necessary as self defense mechanism, in order to avoid
1003 yo-yo connection attempts when the remote host is unavailable.
1005 A value of 0 or nil suppresses this check. This might be
1006 necessary, when several out-of-order copy operations are
1007 performed, or when several asynchronous processes will be started
1008 in a short time frame. In those cases it is recommended to
1009 let-bind this variable."
1010 :group 'tramp
1011 :version "24.4"
1012 :type '(choice (const nil) integer)
1013 :require 'tramp)
1015 (defcustom tramp-completion-reread-directory-timeout 10
1016 "Defines seconds since last remote command before rereading a directory.
1017 A remote directory might have changed its contents. In order to
1018 make it visible during file name completion in the minibuffer,
1019 Tramp flushes its cache and rereads the directory contents when
1020 more than `tramp-completion-reread-directory-timeout' seconds
1021 have been gone since last remote command execution. A value of t
1022 would require an immediate reread during filename completion, nil
1023 means to use always cached values for the directory contents."
1024 :group 'tramp
1025 :type '(choice (const nil) (const t) integer)
1026 :require 'tramp)
1028 ;;; Internal Variables:
1030 (defvar tramp-current-method nil
1031 "Connection method for this *tramp* buffer.")
1033 (defvar tramp-current-user nil
1034 "Remote login name for this *tramp* buffer.")
1036 (defvar tramp-current-host nil
1037 "Remote host for this *tramp* buffer.")
1039 (defvar tramp-current-connection nil
1040 "Last connection timestamp.")
1042 (defconst tramp-completion-file-name-handler-alist
1043 '((expand-file-name . tramp-completion-handle-expand-file-name)
1044 (file-name-all-completions
1045 . tramp-completion-handle-file-name-all-completions)
1046 (file-name-completion . tramp-completion-handle-file-name-completion))
1047 "Alist of completion handler functions.
1048 Used for file names matching `tramp-completion-file-name-regexp'.
1049 Operations not mentioned here will be handled by Tramp's file
1050 name handler functions, or the normal Emacs functions.")
1052 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1053 ;;;###tramp-autoload
1054 (defvar tramp-foreign-file-name-handler-alist nil
1055 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1056 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1057 calling HANDLER.")
1059 ;;; Internal functions which must come first:
1061 ;; Conversion functions between external representation and
1062 ;; internal data structure. Convenience functions for internal
1063 ;; data structure.
1065 (defun tramp-get-method-parameter (vec param)
1066 "Return the method parameter PARAM.
1067 If VEC is a vector, check first in connection properties.
1068 Afterwards, check in `tramp-methods'. If the `tramp-methods'
1069 entry does not exist, return nil."
1070 (let ((hash-entry
1071 (replace-regexp-in-string "^tramp-" "" (symbol-name param))))
1072 (if (tramp-connection-property-p vec hash-entry)
1073 ;; We use the cached property.
1074 (tramp-get-connection-property vec hash-entry nil)
1075 ;; Use the static value from `tramp-methods'.
1076 (let ((methods-entry
1077 (assoc param (assoc (tramp-file-name-method vec) tramp-methods))))
1078 (when methods-entry (cadr methods-entry))))))
1080 (defun tramp-file-name-p (vec)
1081 "Check, whether VEC is a Tramp object."
1082 (and (vectorp vec) (= 5 (length vec))))
1084 (defun tramp-file-name-method (vec)
1085 "Return method component of VEC."
1086 (and (tramp-file-name-p vec) (aref vec 0)))
1088 (defun tramp-file-name-user (vec)
1089 "Return user component of VEC."
1090 (and (tramp-file-name-p vec) (aref vec 1)))
1092 (defun tramp-file-name-host (vec)
1093 "Return host component of VEC."
1094 (and (tramp-file-name-p vec) (aref vec 2)))
1096 (defun tramp-file-name-localname (vec)
1097 "Return localname component of VEC."
1098 (and (tramp-file-name-p vec) (aref vec 3)))
1100 (defun tramp-file-name-hop (vec)
1101 "Return hop component of VEC."
1102 (and (tramp-file-name-p vec) (aref vec 4)))
1104 ;; The user part of a Tramp file name vector can be of kind
1105 ;; "user%domain". Sometimes, we must extract these parts.
1106 (defun tramp-file-name-real-user (vec)
1107 "Return the user name of VEC without domain."
1108 (save-match-data
1109 (let ((user (tramp-file-name-user vec)))
1110 (if (and (stringp user)
1111 (string-match tramp-user-with-domain-regexp user))
1112 (match-string 1 user)
1113 user))))
1115 (defun tramp-file-name-domain (vec)
1116 "Return the domain name of VEC."
1117 (save-match-data
1118 (let ((user (tramp-file-name-user vec)))
1119 (and (stringp user)
1120 (string-match tramp-user-with-domain-regexp user)
1121 (match-string 2 user)))))
1123 ;; The host part of a Tramp file name vector can be of kind
1124 ;; "host#port". Sometimes, we must extract these parts.
1125 (defun tramp-file-name-real-host (vec)
1126 "Return the host name of VEC without port."
1127 (save-match-data
1128 (let ((host (tramp-file-name-host vec)))
1129 (if (and (stringp host)
1130 (string-match tramp-host-with-port-regexp host))
1131 (match-string 1 host)
1132 host))))
1134 (defun tramp-file-name-port (vec)
1135 "Return the port number of VEC."
1136 (save-match-data
1137 (let ((method (tramp-file-name-method vec))
1138 (host (tramp-file-name-host vec)))
1139 (or (and (stringp host)
1140 (string-match tramp-host-with-port-regexp host)
1141 (string-to-number (match-string 2 host)))
1142 (tramp-get-method-parameter vec 'tramp-default-port)))))
1144 ;;;###tramp-autoload
1145 (defun tramp-tramp-file-p (name)
1146 "Return t if NAME is a string with Tramp file name syntax."
1147 (save-match-data
1148 (and (stringp name)
1149 ;; No "/:" and "/c:". This is not covered by `tramp-file-name-regexp'.
1150 (not (string-match
1151 (if (memq system-type '(cygwin windows-nt))
1152 "^/[[:alpha:]]?:" "^/:")
1153 name))
1154 (string-match tramp-file-name-regexp name))))
1156 (defun tramp-find-method (method user host)
1157 "Return the right method string to use.
1158 This is METHOD, if non-nil. Otherwise, do a lookup in
1159 `tramp-default-method-alist'."
1160 (let ((result
1161 (or method
1162 (let ((choices tramp-default-method-alist)
1163 lmethod item)
1164 (while choices
1165 (setq item (pop choices))
1166 (when (and (string-match (or (nth 0 item) "") (or host ""))
1167 (string-match (or (nth 1 item) "") (or user "")))
1168 (setq lmethod (nth 2 item))
1169 (setq choices nil)))
1170 lmethod)
1171 tramp-default-method)))
1172 ;; We must mark, whether a default value has been used.
1173 (if (or method (null result))
1174 result
1175 (propertize result 'tramp-default t))))
1177 (defun tramp-find-user (method user host)
1178 "Return the right user string to use.
1179 This is USER, if non-nil. Otherwise, do a lookup in
1180 `tramp-default-user-alist'."
1181 (let ((result
1182 (or user
1183 (let ((choices tramp-default-user-alist)
1184 luser item)
1185 (while choices
1186 (setq item (pop choices))
1187 (when (and (string-match (or (nth 0 item) "") (or method ""))
1188 (string-match (or (nth 1 item) "") (or host "")))
1189 (setq luser (nth 2 item))
1190 (setq choices nil)))
1191 luser)
1192 tramp-default-user)))
1193 ;; We must mark, whether a default value has been used.
1194 (if (or user (null result))
1195 result
1196 (propertize result 'tramp-default t))))
1198 (defun tramp-find-host (method user host)
1199 "Return the right host string to use.
1200 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1201 (or (and (> (length host) 0) host)
1202 (let ((choices tramp-default-host-alist)
1203 lhost item)
1204 (while choices
1205 (setq item (pop choices))
1206 (when (and (string-match (or (nth 0 item) "") (or method ""))
1207 (string-match (or (nth 1 item) "") (or user "")))
1208 (setq lhost (nth 2 item))
1209 (setq choices nil)))
1210 lhost)
1211 tramp-default-host))
1213 (defun tramp-check-proper-method-and-host (vec)
1214 "Check method and host name of VEC."
1215 (let ((method (tramp-file-name-method vec))
1216 (user (tramp-file-name-user vec))
1217 (host (tramp-file-name-host vec))
1218 (methods (mapcar 'car tramp-methods)))
1219 (when (and method (not (member method methods)))
1220 (tramp-cleanup-connection vec)
1221 (tramp-compat-user-error vec "Unknown method \"%s\"" method))
1222 (when (and (equal tramp-syntax 'ftp) host
1223 (or (null method) (get-text-property 0 'tramp-default method))
1224 (or (null user) (get-text-property 0 'tramp-default user))
1225 (member host methods))
1226 (tramp-cleanup-connection vec)
1227 (tramp-compat-user-error
1228 vec "Host name must not match method \"%s\"" host))))
1230 (defun tramp-dissect-file-name (name &optional nodefault)
1231 "Return a `tramp-file-name' structure.
1232 The structure consists of remote method, remote user, remote host,
1233 localname (file name on remote host) and hop. If NODEFAULT is
1234 non-nil, the file name parts are not expanded to their default
1235 values."
1236 (save-match-data
1237 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1238 (unless match
1239 (tramp-compat-user-error nil "Not a Tramp file name: \"%s\"" name))
1240 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1241 (user (match-string (nth 2 tramp-file-name-structure) name))
1242 (host (match-string (nth 3 tramp-file-name-structure) name))
1243 (localname (match-string (nth 4 tramp-file-name-structure) name))
1244 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1245 (when host
1246 (when (string-match tramp-prefix-ipv6-regexp host)
1247 (setq host (replace-match "" nil t host)))
1248 (when (string-match tramp-postfix-ipv6-regexp host)
1249 (setq host (replace-match "" nil t host))))
1250 (if nodefault
1251 (vector method user host localname hop)
1252 (vector
1253 (tramp-find-method method user host)
1254 (tramp-find-user method user host)
1255 (tramp-find-host method user host)
1256 localname hop))))))
1258 (defun tramp-buffer-name (vec)
1259 "A name for the connection buffer VEC."
1260 ;; We must use `tramp-file-name-real-host', because for gateway
1261 ;; methods the default port will be expanded later on, which would
1262 ;; tamper the name.
1263 (let ((method (tramp-file-name-method vec))
1264 (user (tramp-file-name-user vec))
1265 (host (tramp-file-name-real-host vec)))
1266 (if (not (zerop (length user)))
1267 (format "*tramp/%s %s@%s*" method user host)
1268 (format "*tramp/%s %s*" method host))))
1270 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1271 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1272 When not nil, an optional HOP is prepended."
1273 (concat tramp-prefix-format hop
1274 (when (not (zerop (length method)))
1275 (concat method tramp-postfix-method-format))
1276 (when (not (zerop (length user)))
1277 (concat user tramp-postfix-user-format))
1278 (when host
1279 (if (string-match tramp-ipv6-regexp host)
1280 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1281 host))
1282 tramp-postfix-host-format
1283 (when localname localname)))
1285 (defun tramp-completion-make-tramp-file-name (method user host localname)
1286 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1287 It must not be a complete Tramp file name, but as long as there are
1288 necessary only. This function will be used in file name completion."
1289 (concat tramp-prefix-format
1290 (when (not (zerop (length method)))
1291 (concat method tramp-postfix-method-format))
1292 (when (not (zerop (length user)))
1293 (concat user tramp-postfix-user-format))
1294 (when (not (zerop (length host)))
1295 (concat
1296 (if (string-match tramp-ipv6-regexp host)
1297 (concat
1298 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1299 host)
1300 tramp-postfix-host-format))
1301 (when localname localname)))
1303 (defun tramp-get-buffer (vec)
1304 "Get the connection buffer to be used for VEC."
1305 (or (get-buffer (tramp-buffer-name vec))
1306 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1307 ;; We use the existence of connection property "process-buffer"
1308 ;; as indication, whether a connection is active.
1309 (tramp-set-connection-property
1310 vec "process-buffer"
1311 (tramp-get-connection-property vec "process-buffer" nil))
1312 (setq buffer-undo-list t)
1313 (setq default-directory
1314 (tramp-make-tramp-file-name
1315 (tramp-file-name-method vec)
1316 (tramp-file-name-user vec)
1317 (tramp-file-name-host vec)
1318 "/"))
1319 (current-buffer))))
1321 (defun tramp-get-connection-buffer (vec)
1322 "Get the connection buffer to be used for VEC.
1323 In case a second asynchronous communication has been started, it is different
1324 from `tramp-get-buffer'."
1325 (or (tramp-get-connection-property vec "process-buffer" nil)
1326 (tramp-get-buffer vec)))
1328 (defun tramp-get-connection-name (vec)
1329 "Get the connection name to be used for VEC.
1330 In case a second asynchronous communication has been started, it is different
1331 from the default one."
1332 (or (tramp-get-connection-property vec "process-name" nil)
1333 (tramp-buffer-name vec)))
1335 (defun tramp-get-connection-process (vec)
1336 "Get the connection process to be used for VEC.
1337 In case a second asynchronous communication has been started, it is different
1338 from the default one."
1339 (get-process (tramp-get-connection-name vec)))
1341 (defun tramp-debug-buffer-name (vec)
1342 "A name for the debug buffer for VEC."
1343 ;; We must use `tramp-file-name-real-host', because for gateway
1344 ;; methods the default port will be expanded later on, which would
1345 ;; tamper the name.
1346 (let ((method (tramp-file-name-method vec))
1347 (user (tramp-file-name-user vec))
1348 (host (tramp-file-name-real-host vec)))
1349 (if (not (zerop (length user)))
1350 (format "*debug tramp/%s %s@%s*" method user host)
1351 (format "*debug tramp/%s %s*" method host))))
1353 (defconst tramp-debug-outline-regexp
1354 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1355 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1357 (defun tramp-debug-outline-level ()
1358 "Return the depth to which a statement is nested in the outline.
1359 Point must be at the beginning of a header line.
1361 The outline level is equal to the verbosity of the Tramp message."
1362 (1+ (string-to-number (match-string 1))))
1364 (defun tramp-get-debug-buffer (vec)
1365 "Get the debug buffer for VEC."
1366 (with-current-buffer
1367 (get-buffer-create (tramp-debug-buffer-name vec))
1368 (when (bobp)
1369 (setq buffer-undo-list t)
1370 ;; So it does not get loaded while `outline-regexp' is let-bound.
1371 (require 'outline)
1372 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1373 ;; `outline-mode-hook'. We must prevent that local processes
1374 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1375 ;; Furthermore, `outline-regexp' must have the correct value
1376 ;; already, because it is used by `font-lock-compile-keywords'.
1377 (let ((default-directory (tramp-compat-temporary-file-directory))
1378 (outline-regexp tramp-debug-outline-regexp))
1379 (outline-mode))
1380 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1381 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1382 (current-buffer)))
1384 (defsubst tramp-debug-message (vec fmt-string &rest arguments)
1385 "Append message to debug buffer.
1386 Message is formatted with FMT-STRING as control string and the remaining
1387 ARGUMENTS to actually emit the message (if applicable)."
1388 (with-current-buffer (tramp-get-debug-buffer vec)
1389 (goto-char (point-max))
1390 ;; Headline.
1391 (when (bobp)
1392 (insert
1393 (format
1394 ";; Emacs: %s Tramp: %s -*- mode: outline; -*-"
1395 emacs-version tramp-version))
1396 (when (>= tramp-verbose 10)
1397 (insert
1398 (format
1399 "\n;; Location: %s Git: %s"
1400 (locate-library "tramp") (tramp-repository-get-version)))))
1401 (unless (bolp)
1402 (insert "\n"))
1403 ;; Timestamp.
1404 (let ((now (current-time)))
1405 (insert (format-time-string "%T." now))
1406 (insert (format "%06d " (nth 2 now))))
1407 ;; Calling Tramp function. We suppress compat and trace functions
1408 ;; from being displayed.
1409 (let ((btn 1) btf fn)
1410 (while (not fn)
1411 (setq btf (nth 1 (backtrace-frame btn)))
1412 (if (not btf)
1413 (setq fn "")
1414 (when (symbolp btf)
1415 (setq fn (symbol-name btf))
1416 (unless
1417 (and
1418 (string-match "^tramp" fn)
1419 (not
1420 (string-match
1421 (concat
1423 (regexp-opt
1424 '("tramp-backtrace"
1425 "tramp-compat-condition-case-unless-debug"
1426 "tramp-compat-funcall"
1427 "tramp-compat-user-error"
1428 "tramp-condition-case-unless-debug"
1429 "tramp-debug-message"
1430 "tramp-error"
1431 "tramp-error-with-buffer"
1432 "tramp-message")
1434 "$")
1435 fn)))
1436 (setq fn nil)))
1437 (setq btn (1+ btn))))
1438 ;; The following code inserts filename and line number. Should
1439 ;; be inactive by default, because it is time consuming.
1440 ; (let ((ffn (find-function-noselect (intern fn))))
1441 ; (insert
1442 ; (format
1443 ; "%s:%d: "
1444 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1445 ; (with-current-buffer (car ffn)
1446 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1447 (insert (format "%s " fn)))
1448 ;; The message.
1449 (insert (apply #'format-message fmt-string arguments))))
1451 (defvar tramp-message-show-message t
1452 "Show Tramp message in the minibuffer.
1453 This variable is used to disable messages from `tramp-error'.
1454 The messages are visible anyway, because an error is raised.")
1456 (defsubst tramp-message (vec-or-proc level fmt-string &rest arguments)
1457 "Emit a message depending on verbosity level.
1458 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1459 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1460 less than LEVEL. The message is emitted only if `tramp-verbose' is
1461 greater than or equal to LEVEL.
1463 The message is also logged into the debug buffer when `tramp-verbose'
1464 is greater than or equal 4.
1466 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1467 control string and the remaining ARGUMENTS to actually emit the message (if
1468 applicable)."
1469 (ignore-errors
1470 (when (<= level tramp-verbose)
1471 ;; Match data must be preserved!
1472 (save-match-data
1473 ;; Display only when there is a minimum level.
1474 (when (and tramp-message-show-message (<= level 3))
1475 (apply 'message
1476 (concat
1477 (cond
1478 ((= level 0) "")
1479 ((= level 1) "")
1480 ((= level 2) "Warning: ")
1481 (t "Tramp: "))
1482 fmt-string)
1483 arguments))
1484 ;; Log only when there is a minimum level.
1485 (when (>= tramp-verbose 4)
1486 ;; Translate proc to vec.
1487 (when (processp vec-or-proc)
1488 (let ((tramp-verbose 0))
1489 (setq vec-or-proc
1490 (tramp-get-connection-property vec-or-proc "vector" nil))))
1491 ;; Append connection buffer for error messages.
1492 (when (= level 1)
1493 (let ((tramp-verbose 0))
1494 (with-current-buffer (tramp-get-connection-buffer vec-or-proc)
1495 (setq fmt-string (concat fmt-string "\n%s")
1496 arguments (append arguments (list (buffer-string)))))))
1497 ;; Do it.
1498 (when (vectorp vec-or-proc)
1499 (apply 'tramp-debug-message
1500 vec-or-proc
1501 (concat (format "(%d) # " level) fmt-string)
1502 arguments)))))))
1504 (defsubst tramp-backtrace (&optional vec-or-proc)
1505 "Dump a backtrace into the debug buffer.
1506 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1507 function is meant for debugging purposes."
1508 (if vec-or-proc
1509 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace)))
1510 (if (>= tramp-verbose 10)
1511 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1513 (defsubst tramp-error (vec-or-proc signal fmt-string &rest arguments)
1514 "Emit an error.
1515 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1516 signal identifier to be raised, remaining arguments passed to
1517 `tramp-message'. Finally, signal SIGNAL is raised."
1518 (let (tramp-message-show-message)
1519 (tramp-backtrace vec-or-proc)
1520 (when vec-or-proc
1521 (tramp-message
1522 vec-or-proc 1 "%s"
1523 (error-message-string
1524 (list signal
1525 (get signal 'error-message)
1526 (apply #'format-message fmt-string arguments)))))
1527 (signal signal (list (apply #'format-message fmt-string arguments)))))
1529 (defsubst tramp-error-with-buffer
1530 (buf vec-or-proc signal fmt-string &rest arguments)
1531 "Emit an error, and show BUF.
1532 If BUF is nil, show the connection buf. Wait for 30\", or until
1533 an input event arrives. The other arguments are passed to `tramp-error'."
1534 (save-window-excursion
1535 (let* ((buf (or (and (bufferp buf) buf)
1536 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1537 (and (vectorp vec-or-proc)
1538 (tramp-get-connection-buffer vec-or-proc))))
1539 (vec (or (and (vectorp vec-or-proc) vec-or-proc)
1540 (and buf (with-current-buffer buf
1541 (tramp-dissect-file-name default-directory))))))
1542 (unwind-protect
1543 (apply 'tramp-error vec-or-proc signal fmt-string arguments)
1544 ;; Save exit.
1545 (when (and buf
1546 tramp-message-show-message
1547 (not (zerop tramp-verbose))
1548 (not (tramp-completion-mode-p))
1549 ;; Show only when Emacs has started already.
1550 (current-message))
1551 (let ((enable-recursive-minibuffers t))
1552 ;; `tramp-error' does not show messages. So we must do it
1553 ;; ourselves.
1554 (apply 'message fmt-string arguments)
1555 ;; Show buffer.
1556 (pop-to-buffer buf)
1557 (discard-input)
1558 (sit-for 30)))
1559 ;; Reset timestamp. It would be wrong after waiting for a while.
1560 (when (equal (butlast (append vec nil) 2)
1561 (car tramp-current-connection))
1562 (setcdr tramp-current-connection (current-time)))))))
1564 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1565 "Parse a Tramp filename and make components available in the body.
1567 First arg FILENAME is evaluated and dissected into its components.
1568 Second arg VAR is a symbol. It is used as a variable name to hold
1569 the filename structure. It is also used as a prefix for the variables
1570 holding the components. For example, if VAR is the symbol `foo', then
1571 `foo' will be bound to the whole structure, `foo-method' will be bound to
1572 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1573 `foo-hop'.
1575 Remaining args are Lisp expressions to be evaluated (inside an implicit
1576 `progn').
1578 If VAR is nil, then we bind `v' to the structure and `method', `user',
1579 `host', `localname', `hop' to the components."
1580 (let ((bindings
1581 (mapcar (lambda (elem)
1582 `(,(if var (intern (format "%s-%s" var elem)) elem)
1583 (,(intern (format "tramp-file-name-%s" elem))
1584 ,(or var 'v))))
1585 '(method user host localname hop))))
1586 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1587 ,@bindings)
1588 ;; We don't know which of those vars will be used, so we bind them all,
1589 ;; and then add here a dummy use of all those variables, so we don't get
1590 ;; flooded by warnings about those vars `body' didn't use.
1591 (ignore ,@(mapcar #'car bindings))
1592 ,@body)))
1594 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1595 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1596 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1598 (defun tramp-progress-reporter-update (reporter &optional value)
1599 "Report progress of an operation for Tramp."
1600 (let* ((parameters (cdr reporter))
1601 (message (aref parameters 3)))
1602 (when (string-match message (or (current-message) ""))
1603 (progress-reporter-update reporter value))))
1605 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1606 "Executes BODY, spinning a progress reporter with MESSAGE.
1607 If LEVEL does not fit for visible messages, there are only traces
1608 without a visible progress reporter."
1609 (declare (indent 3) (debug t))
1610 `(progn
1611 (tramp-message ,vec ,level "%s..." ,message)
1612 (let ((cookie "failed")
1614 ;; We start a pulsing progress reporter after 3 seconds. Feature
1615 ;; introduced in Emacs 24.1.
1616 (when (and tramp-message-show-message
1617 ;; Display only when there is a minimum level.
1618 (<= ,level (min tramp-verbose 3)))
1619 (ignore-errors
1620 (let ((pr (make-progress-reporter ,message nil nil)))
1621 (when pr
1622 (run-at-time
1623 3 0.1 #'tramp-progress-reporter-update pr)))))))
1624 (unwind-protect
1625 ;; Execute the body.
1626 (prog1 (progn ,@body) (setq cookie "done"))
1627 ;; Stop progress reporter.
1628 (if tm (cancel-timer tm))
1629 (tramp-message ,vec ,level "%s...%s" ,message cookie)))))
1631 (font-lock-add-keywords
1632 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1634 (defmacro with-tramp-file-property (vec file property &rest body)
1635 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1636 FILE must be a local file name on a connection identified via VEC."
1637 `(if (file-name-absolute-p ,file)
1638 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1639 (when (eq value 'undef)
1640 ;; We cannot pass @body as parameter to
1641 ;; `tramp-set-file-property' because it mangles our
1642 ;; debug messages.
1643 (setq value (progn ,@body))
1644 (tramp-set-file-property ,vec ,file ,property value))
1645 value)
1646 ,@body))
1648 (put 'with-tramp-file-property 'lisp-indent-function 3)
1649 (put 'with-tramp-file-property 'edebug-form-spec t)
1650 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1652 (defmacro with-tramp-connection-property (key property &rest body)
1653 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1654 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1655 (when (eq value 'undef)
1656 ;; We cannot pass ,@body as parameter to
1657 ;; `tramp-set-connection-property' because it mangles our debug
1658 ;; messages.
1659 (setq value (progn ,@body))
1660 (tramp-set-connection-property ,key ,property value))
1661 value))
1663 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1664 (put 'with-tramp-connection-property 'edebug-form-spec t)
1665 (font-lock-add-keywords
1666 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1668 (defun tramp-drop-volume-letter (name)
1669 "Cut off unnecessary drive letter from file NAME.
1670 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1671 locally on a remote file name. When the local system is a W32 system
1672 but the remote system is Unix, this introduces a superfluous drive
1673 letter into the file name. This function removes it."
1674 (save-match-data
1675 (if (string-match "\\`[a-zA-Z]:/" name)
1676 (replace-match "/" nil t name)
1677 name)))
1679 ;;; Config Manipulation Functions:
1681 ;;;###tramp-autoload
1682 (defun tramp-set-completion-function (method function-list)
1683 "Sets the list of completion functions for METHOD.
1684 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1685 The FUNCTION is intended to parse FILE according its syntax.
1686 It might be a predefined FUNCTION, or a user defined FUNCTION.
1687 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1689 Example:
1691 (tramp-set-completion-function
1692 \"ssh\"
1693 \\='((tramp-parse-sconfig \"/etc/ssh_config\")
1694 (tramp-parse-sconfig \"~/.ssh/config\")))"
1696 (let ((r function-list)
1697 (v function-list))
1698 (setq tramp-completion-function-alist
1699 (delete (assoc method tramp-completion-function-alist)
1700 tramp-completion-function-alist))
1702 (while v
1703 ;; Remove double entries.
1704 (when (member (car v) (cdr v))
1705 (setcdr v (delete (car v) (cdr v))))
1706 ;; Check for function and file or registry key.
1707 (unless (and (functionp (nth 0 (car v)))
1708 (cond
1709 ;; Windows registry.
1710 ((string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1711 (and (memq system-type '(cygwin windows-nt))
1712 (zerop
1713 (tramp-call-process
1714 v "reg" nil nil nil "query" (nth 1 (car v))))))
1715 ;; Zeroconf service type.
1716 ((string-match
1717 "^_[[:alpha:]]+\\._[[:alpha:]]+$" (nth 1 (car v))))
1718 ;; Configuration file.
1719 (t (file-exists-p (nth 1 (car v))))))
1720 (setq r (delete (car v) r)))
1721 (setq v (cdr v)))
1723 (when r
1724 (add-to-list 'tramp-completion-function-alist
1725 (cons method r)))))
1727 (defun tramp-get-completion-function (method)
1728 "Returns a list of completion functions for METHOD.
1729 For definition of that list see `tramp-set-completion-function'."
1730 (append
1731 `(;; Default settings are taken into account.
1732 (tramp-parse-default-user-host ,method)
1733 ;; Hosts visited once shall be remembered.
1734 (tramp-parse-connection-properties ,method))
1735 ;; The method related defaults.
1736 (cdr (assoc method tramp-completion-function-alist))))
1739 ;;; Fontification of `read-file-name':
1741 (defvar tramp-rfn-eshadow-overlay)
1742 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1744 (defun tramp-rfn-eshadow-setup-minibuffer ()
1745 "Set up a minibuffer for `file-name-shadow-mode'.
1746 Adds another overlay hiding filename parts according to Tramp's
1747 special handling of `substitute-in-file-name'."
1748 (when (symbol-value 'minibuffer-completing-file-name)
1749 (setq tramp-rfn-eshadow-overlay
1750 (make-overlay (minibuffer-prompt-end) (minibuffer-prompt-end)))
1751 ;; Copy rfn-eshadow-overlay properties.
1752 (let ((props (overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1753 (while props
1754 ;; The `field' property prevents correct minibuffer
1755 ;; completion; we exclude it.
1756 (if (not (eq (car props) 'field))
1757 (overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1758 (pop props) (pop props))))))
1760 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1761 'tramp-rfn-eshadow-setup-minibuffer)
1762 (add-hook 'tramp-unload-hook
1763 (lambda ()
1764 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1765 'tramp-rfn-eshadow-setup-minibuffer)))
1767 (defconst tramp-rfn-eshadow-update-overlay-regexp
1768 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1770 (defun tramp-rfn-eshadow-update-overlay ()
1771 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1772 This is intended to be used as a minibuffer `post-command-hook' for
1773 `file-name-shadow-mode'; the minibuffer should have already
1774 been set up by `rfn-eshadow-setup-minibuffer'."
1775 ;; In remote files name, there is a shadowing just for the local part.
1776 (ignore-errors
1777 (let ((end (or (overlay-end (symbol-value 'rfn-eshadow-overlay))
1778 (minibuffer-prompt-end)))
1779 ;; We do not want to send any remote command.
1780 (non-essential t))
1781 (when
1782 (tramp-tramp-file-p
1783 (buffer-substring-no-properties end (point-max)))
1784 (save-excursion
1785 (save-restriction
1786 (narrow-to-region
1787 (1+ (or (string-match
1788 tramp-rfn-eshadow-update-overlay-regexp
1789 (buffer-string) end)
1790 end))
1791 (point-max))
1792 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1793 (rfn-eshadow-update-overlay-hook nil)
1794 file-name-handler-alist)
1795 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
1796 (rfn-eshadow-update-overlay))))))))
1798 (add-hook 'rfn-eshadow-update-overlay-hook
1799 'tramp-rfn-eshadow-update-overlay)
1800 (add-hook 'tramp-unload-hook
1801 (lambda ()
1802 (remove-hook 'rfn-eshadow-update-overlay-hook
1803 'tramp-rfn-eshadow-update-overlay)))
1805 ;; Inodes don't exist for some file systems. Therefore we must
1806 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1807 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1808 ;; performance isn't the major issue given that file transfer will
1809 ;; take time.
1810 (defvar tramp-inodes 0
1811 "Keeps virtual inodes numbers.")
1813 ;; Devices must distinguish physical file systems. The device numbers
1814 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1815 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1816 ;; EFS use device number "-1". In order to be different, we use device number
1817 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1818 (defvar tramp-devices 0
1819 "Keeps virtual device numbers.")
1821 (defun tramp-default-file-modes (filename)
1822 "Return file modes of FILENAME as integer.
1823 If the file modes of FILENAME cannot be determined, return the
1824 value of `default-file-modes', without execute permissions."
1825 (or (file-modes filename)
1826 (logand (default-file-modes) (string-to-number "0666" 8))))
1828 (defun tramp-replace-environment-variables (filename)
1829 "Replace environment variables in FILENAME.
1830 Return the string with the replaced variables."
1831 (or (ignore-errors
1832 ;; Optional arg has been introduced with Emacs 24 (?).
1833 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1834 ;; We need an own implementation.
1835 (save-match-data
1836 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1837 ;; `$' is coded as `$$'.
1838 (when (and idx
1839 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1840 (getenv (match-string 1 filename)))
1841 (setq filename
1842 (replace-match
1843 (substitute-in-file-name (match-string 0 filename))
1844 t nil filename)))
1845 filename))))
1847 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1848 "Like `find-operation-coding-system' for Tramp filenames.
1849 Tramp's `insert-file-contents' and `write-region' work over
1850 temporary file names. If `file-coding-system-alist' contains an
1851 expression, which matches more than the file name suffix, the
1852 coding system might not be determined. This function repairs it."
1853 (let (result)
1854 (dolist (elt file-coding-system-alist result)
1855 (when (and (consp elt) (string-match (car elt) filename))
1856 ;; We found a matching entry in `file-coding-system-alist'.
1857 ;; So we add a similar entry, but with the temporary file name
1858 ;; as regexp.
1859 (add-to-list
1860 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1862 (defun tramp-run-real-handler (operation args)
1863 "Invoke normal file name handler for OPERATION.
1864 First arg specifies the OPERATION, second arg is a list of arguments to
1865 pass to the OPERATION."
1866 (let* ((inhibit-file-name-handlers
1867 `(tramp-file-name-handler
1868 tramp-vc-file-name-handler
1869 tramp-completion-file-name-handler
1870 cygwin-mount-name-hook-function
1871 cygwin-mount-map-drive-hook-function
1873 ,(and (eq inhibit-file-name-operation operation)
1874 inhibit-file-name-handlers)))
1875 (inhibit-file-name-operation operation))
1876 (apply operation args)))
1878 ;;;###autoload
1879 (progn (defun tramp-completion-run-real-handler (operation args)
1880 "Invoke `tramp-file-name-handler' for OPERATION.
1881 First arg specifies the OPERATION, second arg is a list of arguments to
1882 pass to the OPERATION."
1883 (let* ((inhibit-file-name-handlers
1884 `(tramp-completion-file-name-handler
1885 cygwin-mount-name-hook-function
1886 cygwin-mount-map-drive-hook-function
1888 ,(and (eq inhibit-file-name-operation operation)
1889 inhibit-file-name-handlers)))
1890 (inhibit-file-name-operation operation))
1891 (apply operation args))))
1893 ;; We handle here all file primitives. Most of them have the file
1894 ;; name as first parameter; nevertheless we check for them explicitly
1895 ;; in order to be signaled if a new primitive appears. This
1896 ;; scenario is needed because there isn't a way to decide by
1897 ;; syntactical means whether a foreign method must be called. It would
1898 ;; ease the life if `file-name-handler-alist' would support a decision
1899 ;; function as well but regexp only.
1900 (defun tramp-file-name-for-operation (operation &rest args)
1901 "Return file name related to OPERATION file primitive.
1902 ARGS are the arguments OPERATION has been called with."
1903 (cond
1904 ;; FILE resp DIRECTORY.
1905 ((member operation
1906 '(access-file byte-compiler-base-file-name delete-directory
1907 delete-file diff-latest-backup-file directory-file-name
1908 directory-files directory-files-and-attributes
1909 dired-compress-file dired-uncache
1910 file-accessible-directory-p file-attributes
1911 file-directory-p file-executable-p file-exists-p
1912 file-local-copy file-modes
1913 file-name-as-directory file-name-directory
1914 file-name-nondirectory file-name-sans-versions
1915 file-ownership-preserved-p file-readable-p
1916 file-regular-p file-remote-p file-symlink-p file-truename
1917 file-writable-p find-backup-file-name find-file-noselect
1918 get-file-buffer insert-directory insert-file-contents
1919 load make-directory make-directory-internal
1920 set-file-modes set-file-times substitute-in-file-name
1921 unhandled-file-name-directory vc-registered
1922 ;; Emacs 24+ only.
1923 file-acl file-notify-add-watch file-selinux-context
1924 set-file-acl set-file-selinux-context))
1925 (if (file-name-absolute-p (nth 0 args))
1926 (nth 0 args)
1927 (expand-file-name (nth 0 args))))
1928 ;; FILE DIRECTORY resp FILE1 FILE2.
1929 ((member operation
1930 '(add-name-to-file copy-directory copy-file expand-file-name
1931 file-name-all-completions file-name-completion
1932 file-newer-than-file-p make-symbolic-link rename-file
1933 ;; Emacs 24+ only.
1934 file-equal-p file-in-directory-p))
1935 (save-match-data
1936 (cond
1937 ((tramp-tramp-file-p (nth 0 args)) (nth 0 args))
1938 ((tramp-tramp-file-p (nth 1 args)) (nth 1 args))
1939 (t (buffer-file-name (current-buffer))))))
1940 ;; START END FILE.
1941 ((eq operation 'write-region)
1942 (nth 2 args))
1943 ;; BUFFER.
1944 ((member operation
1945 '(make-auto-save-file-name
1946 set-visited-file-modtime verify-visited-file-modtime))
1947 (buffer-file-name
1948 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1949 ;; COMMAND.
1950 ((member operation
1951 '(process-file shell-command start-file-process
1952 ;; Emacs 26+ only.
1953 make-nearby-temp-file temporary-file-directory))
1954 default-directory)
1955 ;; PROC.
1956 ((member operation
1957 '(;; Emacs 24+ only.
1958 file-notify-rm-watch
1959 ;; Emacs 25+ only.
1960 file-notify-valid-p))
1961 (when (processp (nth 0 args))
1962 (with-current-buffer (process-buffer (nth 0 args))
1963 default-directory)))
1964 ;; Unknown file primitive.
1965 (t (error "unknown file I/O primitive: %s" operation))))
1967 (defun tramp-find-foreign-file-name-handler
1968 (filename &optional operation completion)
1969 "Return foreign file name handler if exists."
1970 (when (tramp-tramp-file-p filename)
1971 (let ((v (tramp-dissect-file-name filename t))
1972 (handler tramp-foreign-file-name-handler-alist)
1973 elt res)
1974 ;; When we are not fully sure that filename completion is safe,
1975 ;; we should not return a handler.
1976 (when (or (not completion)
1977 (tramp-file-name-method v) (tramp-file-name-user v)
1978 (and (tramp-file-name-host v)
1979 (not (member (tramp-file-name-host v)
1980 (mapcar 'car tramp-methods))))
1981 ;; Some operations are safe by default.
1982 (member
1983 operation
1984 '(file-name-as-directory
1985 file-name-directory
1986 file-name-nondirectory)))
1987 (while handler
1988 (setq elt (car handler)
1989 handler (cdr handler))
1990 (when (funcall (car elt) filename)
1991 (setq handler nil
1992 res (cdr elt))))
1993 res))))
1995 (defvar tramp-debug-on-error nil
1996 "Like `debug-on-error' but used Tramp internal.")
1998 (defmacro tramp-condition-case-unless-debug
1999 (var bodyform &rest handlers)
2000 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
2001 `(let ((debug-on-error tramp-debug-on-error))
2002 (tramp-compat-condition-case-unless-debug ,var ,bodyform ,@handlers)))
2004 ;; Main function.
2005 (defun tramp-file-name-handler (operation &rest args)
2006 "Invoke Tramp file name handler.
2007 Falls back to normal file name handler if no Tramp file name handler exists."
2008 (if tramp-mode
2009 (save-match-data
2010 (let* ((filename
2011 (tramp-replace-environment-variables
2012 (apply 'tramp-file-name-for-operation operation args)))
2013 (completion (tramp-completion-mode-p))
2014 (foreign
2015 (tramp-find-foreign-file-name-handler
2016 filename operation completion))
2017 result)
2018 (with-parsed-tramp-file-name filename nil
2019 ;; Call the backend function.
2020 (if foreign
2021 (tramp-condition-case-unless-debug err
2022 (let ((sf (symbol-function foreign)))
2023 ;; Some packages set the default directory to a
2024 ;; remote path, before respective Tramp packages
2025 ;; are already loaded. This results in
2026 ;; recursive loading. Therefore, we load the
2027 ;; Tramp packages locally.
2028 (when (and (listp sf) (eq (car sf) 'autoload))
2029 (let ((default-directory
2030 (tramp-compat-temporary-file-directory)))
2031 (load (cadr sf) 'noerror 'nomessage)))
2032 ;; If `non-essential' is non-nil, Tramp shall
2033 ;; not open a new connection.
2034 ;; If Tramp detects that it shouldn't continue
2035 ;; to work, it throws the `suppress' event.
2036 ;; This could happen for example, when Tramp
2037 ;; tries to open the same connection twice in a
2038 ;; short time frame.
2039 ;; In both cases, we try the default handler then.
2040 (setq result
2041 (catch 'non-essential
2042 (catch 'suppress
2043 (apply foreign operation args))))
2044 (cond
2045 ((eq result 'non-essential)
2046 (tramp-message
2047 v 5 "Non-essential received in operation %s"
2048 (cons operation args))
2049 (tramp-run-real-handler operation args))
2050 ((eq result 'suppress)
2051 (let (tramp-message-show-message)
2052 (tramp-message
2053 v 1 "Suppress received in operation %s"
2054 (cons operation args))
2055 (tramp-cleanup-connection v t)
2056 (tramp-run-real-handler operation args)))
2057 (t result)))
2059 ;; Trace that somebody has interrupted the operation.
2060 ((debug quit)
2061 (let (tramp-message-show-message)
2062 (tramp-message
2063 v 1 "Interrupt received in operation %s"
2064 (cons operation args)))
2065 ;; Propagate the quit signal.
2066 (signal (car err) (cdr err)))
2068 ;; When we are in completion mode, some failed
2069 ;; operations shall return at least a default value
2070 ;; in order to give the user a chance to correct the
2071 ;; file name in the minibuffer.
2072 ;; In order to get a full backtrace, one could apply
2073 ;; (setq tramp-debug-on-error t)
2074 (error
2075 (cond
2076 ((and completion (zerop (length localname))
2077 (memq operation '(file-exists-p file-directory-p)))
2079 ((and completion (zerop (length localname))
2080 (memq operation
2081 '(expand-file-name file-name-as-directory)))
2082 filename)
2083 ;; Propagate the error.
2084 (t (signal (car err) (cdr err))))))
2086 ;; Nothing to do for us. However, since we are in
2087 ;; `tramp-mode', we must suppress the volume letter on
2088 ;; MS Windows.
2089 (setq result (tramp-run-real-handler operation args))
2090 (if (stringp result)
2091 (tramp-drop-volume-letter result)
2092 result)))))
2094 ;; When `tramp-mode' is not enabled, we don't do anything.
2095 (tramp-run-real-handler operation args)))
2097 ;; In Emacs, there is some concurrency due to timers. If a timer
2098 ;; interrupts Tramp and wishes to use the same connection buffer as
2099 ;; the "main" Emacs, then garbage might occur in the connection
2100 ;; buffer. Therefore, we need to make sure that a timer does not use
2101 ;; the same connection buffer as the "main" Emacs. We implement a
2102 ;; cheap global lock, instead of locking each connection buffer
2103 ;; separately. The global lock is based on two variables,
2104 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2105 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2106 ;; processing of a single file operation, so we need to allow
2107 ;; recursive calls. That's where the `tramp-locker' variable comes in
2108 ;; -- it is let-bound to t during the execution of the current
2109 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2110 ;; then we should just proceed because we have been called
2111 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2112 ;; interrupting the "main" Emacs, and then we signal an error.
2114 (defvar tramp-locked nil
2115 "If non-nil, then Tramp is currently busy.
2116 Together with `tramp-locker', this implements a locking mechanism
2117 preventing reentrant calls of Tramp.")
2119 (defvar tramp-locker nil
2120 "If non-nil, then a caller has locked Tramp.
2121 Together with `tramp-locked', this implements a locking mechanism
2122 preventing reentrant calls of Tramp.")
2124 ;; Avoid recursive loading of tramp.el.
2125 ;;;###autoload(defun tramp-completion-file-name-handler (operation &rest args)
2126 ;;;###autoload (tramp-completion-run-real-handler operation args))
2128 (defun tramp-completion-file-name-handler (operation &rest args)
2129 "Invoke Tramp file name completion handler.
2130 Falls back to normal file name handler if no Tramp file name handler exists."
2131 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
2132 (if (and
2133 ;; When `tramp-mode' is not enabled, we don't do anything.
2134 fn tramp-mode (tramp-completion-mode-p)
2135 ;; For other syntaxes than `sep', the regexp matches many common
2136 ;; situations where the user doesn't actually want to use Tramp.
2137 ;; So to avoid autoloading Tramp after typing just "/s", we
2138 ;; disable this part of the completion, unless the user implicitly
2139 ;; indicated his interest in using a fancier completion system.
2140 (or (eq tramp-syntax 'sep)
2141 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2142 ;; `partial-completion-mode' is obsoleted with Emacs 24.1.
2143 (and (boundp 'partial-completion-mode)
2144 (symbol-value 'partial-completion-mode))
2145 ;; FIXME: These may have been loaded even if the user never
2146 ;; intended to use them.
2147 (featurep 'ido)
2148 (featurep 'icicles)))
2149 (save-match-data (apply (cdr fn) args))
2150 (tramp-completion-run-real-handler operation args))))
2152 ;;;###autoload
2153 (progn (defun tramp-autoload-file-name-handler (operation &rest args)
2154 "Load Tramp file name handler, and perform OPERATION."
2155 ;; Avoid recursive loading of tramp.el.
2156 (let ((default-directory temporary-file-directory))
2157 (load "tramp" nil t))
2158 (apply operation args)))
2160 ;; `tramp-autoload-file-name-handler' must be registered before
2161 ;; evaluation of site-start and init files, because there might exist
2162 ;; remote files already, f.e. files kept via recentf-mode. We cannot
2163 ;; autoload `tramp-file-name-handler', because it would result in
2164 ;; recursive loading of tramp.el when `default-directory' is set to
2165 ;; remote.
2166 ;;;###autoload
2167 (progn (defun tramp-register-autoload-file-name-handlers ()
2168 "Add Tramp file name handlers to `file-name-handler-alist' during autoload."
2169 (add-to-list 'file-name-handler-alist
2170 (cons tramp-file-name-regexp
2171 'tramp-autoload-file-name-handler))
2172 (put 'tramp-autoload-file-name-handler 'safe-magic t)
2173 (add-to-list 'file-name-handler-alist
2174 (cons tramp-completion-file-name-regexp
2175 'tramp-completion-file-name-handler))
2176 (put 'tramp-completion-file-name-handler 'safe-magic t)))
2178 ;;;###autoload
2179 (tramp-register-autoload-file-name-handlers)
2181 (defun tramp-register-file-name-handlers ()
2182 "Add Tramp file name handlers to `file-name-handler-alist'."
2183 ;; Remove autoloaded handlers from file name handler alist. Useful,
2184 ;; if `tramp-syntax' has been changed.
2185 (dolist (fnh '(tramp-file-name-handler
2186 tramp-completion-file-name-handler
2187 tramp-autoload-file-name-handler))
2188 (let ((a1 (rassq fnh file-name-handler-alist)))
2189 (setq file-name-handler-alist (delq a1 file-name-handler-alist))))
2190 ;; The initial value of `tramp-file-name-regexp' is too simple
2191 ;; minded, but we cannot give it the real value in the autoload
2192 ;; pattern. See Bug#24889.
2193 (setq tramp-file-name-regexp (car tramp-file-name-structure))
2194 ;; Add the handlers.
2195 (add-to-list 'file-name-handler-alist
2196 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2197 (put 'tramp-file-name-handler 'safe-magic t)
2198 (add-to-list 'file-name-handler-alist
2199 (cons tramp-completion-file-name-regexp
2200 'tramp-completion-file-name-handler))
2201 (put 'tramp-completion-file-name-handler 'safe-magic t)
2202 ;; If jka-compr or epa-file are already loaded, move them to the
2203 ;; front of `file-name-handler-alist'.
2204 (dolist (fnh '(epa-file-handler jka-compr-handler))
2205 (let ((entry (rassoc fnh file-name-handler-alist)))
2206 (when entry
2207 (setq file-name-handler-alist
2208 (cons entry (delete entry file-name-handler-alist)))))))
2210 (eval-after-load 'tramp (tramp-register-file-name-handlers))
2212 (defun tramp-exists-file-name-handler (operation &rest args)
2213 "Check, whether OPERATION runs a file name handler."
2214 ;; The file name handler is determined on base of either an
2215 ;; argument, `buffer-file-name', or `default-directory'.
2216 (ignore-errors
2217 (let* ((buffer-file-name "/")
2218 (default-directory "/")
2219 (fnha file-name-handler-alist)
2220 (check-file-name-operation operation)
2221 (file-name-handler-alist
2222 (list
2223 (cons "/"
2224 (lambda (operation &rest args)
2225 "Returns OPERATION if it is the one to be checked."
2226 (if (equal check-file-name-operation operation)
2227 operation
2228 (let ((file-name-handler-alist fnha))
2229 (apply operation args))))))))
2230 (equal (apply operation args) operation))))
2232 ;;;###autoload
2233 (defun tramp-unload-file-name-handlers ()
2234 "Unload Tramp file name handlers from `file-name-handler-alist'."
2235 (setq file-name-handler-alist
2236 (delete (rassoc 'tramp-file-name-handler
2237 file-name-handler-alist)
2238 (delete (rassoc 'tramp-completion-file-name-handler
2239 file-name-handler-alist)
2240 file-name-handler-alist))))
2242 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2244 ;;; File name handler functions for completion mode:
2246 ;;;###autoload
2247 (defvar tramp-completion-mode nil
2248 "If non-nil, external packages signal that they are in file name completion.
2250 This is necessary, because Tramp uses a heuristic depending on last
2251 input event. This fails when external packages use other characters
2252 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2253 should never be set globally, the intention is to let-bind it.")
2255 ;; Necessary because `tramp-file-name-regexp-unified' and
2256 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2257 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2258 ;; to `tramp-file-name-handler'). Otherwise, it takes
2259 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2260 ;; risky, because completing a file might require loading other files,
2261 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2262 ;; variable. On the other hand, those files shouldn't have partial
2263 ;; Tramp file name syntax. Maybe another variable should be introduced
2264 ;; overwriting this check in such cases. Or we change Tramp file name
2265 ;; syntax in order to avoid ambiguities.
2266 (defun tramp-completion-mode-p ()
2267 "Check, whether method / user name / host name completion is active."
2269 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2270 (and (boundp 'non-essential) (symbol-value 'non-essential))
2271 tramp-completion-mode
2272 (equal last-input-event 'tab)
2273 (and (natnump last-input-event)
2275 ;; ?\t has event-modifier 'control.
2276 (equal last-input-event ?\t)
2277 (and (not (event-modifiers last-input-event))
2278 (or (equal last-input-event ?\?)
2279 (equal last-input-event ?\ )))))))
2281 (defun tramp-connectable-p (filename)
2282 "Check, whether it is possible to connect the remote host w/o side-effects.
2283 This is true, if either the remote host is already connected, or if we are
2284 not in completion mode."
2285 (let (tramp-verbose)
2286 (and (tramp-tramp-file-p filename)
2287 (or (not (tramp-completion-mode-p))
2288 (tramp-compat-process-live-p
2289 (tramp-get-connection-process
2290 (tramp-dissect-file-name filename)))))))
2292 (defun tramp-completion-handle-expand-file-name (name &optional dir)
2293 "Like `expand-file-name' for Tramp files."
2294 (if (tramp-completion-mode-p)
2295 (progn
2296 ;; If DIR is not given, use `default-directory' or "/".
2297 (setq dir (or dir default-directory "/"))
2298 ;; Unless NAME is absolute, concat DIR and NAME.
2299 (unless (file-name-absolute-p name)
2300 (setq name (concat (file-name-as-directory dir) name)))
2301 ;; Return NAME.
2302 name)
2304 (tramp-completion-run-real-handler
2305 'expand-file-name (list name dir))))
2307 ;; Method, host name and user name completion.
2308 ;; `tramp-completion-dissect-file-name' returns a list of
2309 ;; tramp-file-name structures. For all of them we return possible completions.
2310 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2311 "Like `file-name-all-completions' for partial Tramp files."
2313 (let ((fullname
2314 (tramp-drop-volume-letter (expand-file-name filename directory)))
2315 hop result result1)
2317 ;; Suppress hop from completion.
2318 (when (string-match
2319 (concat
2320 tramp-prefix-regexp
2321 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2322 tramp-postfix-hop-regexp
2323 "\\)+" "\\)")
2324 fullname)
2325 (setq hop (match-string 1 fullname)
2326 fullname (replace-match "" nil nil fullname 1)))
2328 ;; Possible completion structures.
2329 (dolist (elt (tramp-completion-dissect-file-name fullname))
2330 (let* ((method (tramp-file-name-method elt))
2331 (user (tramp-file-name-user elt))
2332 (host (tramp-file-name-host elt))
2333 (localname (tramp-file-name-localname elt))
2334 (m (tramp-find-method method user host))
2335 (tramp-current-user user) ; see `tramp-parse-passwd'
2336 all-user-hosts)
2338 (unless localname ;; Nothing to complete.
2340 (if (or user host)
2342 ;; Method dependent user / host combinations.
2343 (progn
2344 (mapc
2345 (lambda (x)
2346 (setq all-user-hosts
2347 (append all-user-hosts
2348 (funcall (nth 0 x) (nth 1 x)))))
2349 (tramp-get-completion-function m))
2351 (setq result
2352 (append result
2353 (mapcar
2354 (lambda (x)
2355 (tramp-get-completion-user-host
2356 method user host (nth 0 x) (nth 1 x)))
2357 (delq nil all-user-hosts)))))
2359 ;; Possible methods.
2360 (setq result
2361 (append result (tramp-get-completion-methods m)))))))
2363 ;; Unify list, add hop, remove nil elements.
2364 (dolist (elt result)
2365 (when elt
2366 (string-match tramp-prefix-regexp elt)
2367 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2368 (add-to-list
2369 'result1
2370 (substring elt (length (tramp-drop-volume-letter directory))))))
2372 ;; Complete local parts.
2373 (append
2374 result1
2375 (ignore-errors
2376 (apply (if (tramp-connectable-p fullname)
2377 'tramp-completion-run-real-handler
2378 'tramp-run-real-handler)
2379 'file-name-all-completions (list (list filename directory)))))))
2381 ;; Method, host name and user name completion for a file.
2382 (defun tramp-completion-handle-file-name-completion
2383 (filename directory &optional predicate)
2384 "Like `file-name-completion' for Tramp files."
2385 (try-completion
2386 filename
2387 (mapcar 'list (file-name-all-completions filename directory))
2388 (when (and predicate
2389 (tramp-connectable-p (expand-file-name filename directory)))
2390 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2392 ;; I misuse a little bit the tramp-file-name structure in order to handle
2393 ;; completion possibilities for partial methods / user names / host names.
2394 ;; Return value is a list of tramp-file-name structures according to possible
2395 ;; completions. If "localname" is non-nil it means there
2396 ;; shouldn't be a completion anymore.
2398 ;; Expected results:
2400 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2401 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2402 ;; [nil "x" nil nil]
2403 ;; ["x" nil nil nil]
2405 ;; "/x:" "/x:y" "/x:y:"
2406 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2407 ;; "/[x/" "/[x/y"
2408 ;; ["x" nil "" nil] ["x" nil "y" nil]
2409 ;; ["x" "" nil nil] ["x" "y" nil nil]
2411 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2412 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2413 ;; "/[x/y@" "/[x/y@z"
2414 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2415 (defun tramp-completion-dissect-file-name (name)
2416 "Returns a list of `tramp-file-name' structures.
2417 They are collected by `tramp-completion-dissect-file-name1'."
2419 (let* ((result)
2420 (x-nil "\\|\\(\\)")
2421 (tramp-completion-ipv6-regexp
2422 (format
2423 "[^%s]*"
2424 (if (zerop (length tramp-postfix-ipv6-format))
2425 tramp-postfix-host-format
2426 tramp-postfix-ipv6-format)))
2427 ;; "/method" "/[method"
2428 (tramp-completion-file-name-structure1
2429 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2430 1 nil nil nil))
2431 ;; "/user" "/[user"
2432 (tramp-completion-file-name-structure2
2433 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2434 nil 1 nil nil))
2435 ;; "/host" "/[host"
2436 (tramp-completion-file-name-structure3
2437 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2438 nil nil 1 nil))
2439 ;; "/[ipv6" "/[ipv6"
2440 (tramp-completion-file-name-structure4
2441 (list (concat tramp-prefix-regexp
2442 tramp-prefix-ipv6-regexp
2443 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2444 nil nil 1 nil))
2445 ;; "/user@host" "/[user@host"
2446 (tramp-completion-file-name-structure5
2447 (list (concat tramp-prefix-regexp
2448 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2449 "\\(" tramp-host-regexp x-nil "\\)$")
2450 nil 1 2 nil))
2451 ;; "/user@[ipv6" "/[user@ipv6"
2452 (tramp-completion-file-name-structure6
2453 (list (concat tramp-prefix-regexp
2454 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2455 tramp-prefix-ipv6-regexp
2456 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2457 nil 1 2 nil))
2458 ;; "/method:user" "/[method/user"
2459 (tramp-completion-file-name-structure7
2460 (list (concat tramp-prefix-regexp
2461 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2462 "\\(" tramp-user-regexp x-nil "\\)$")
2463 1 2 nil nil))
2464 ;; "/method:host" "/[method/host"
2465 (tramp-completion-file-name-structure8
2466 (list (concat tramp-prefix-regexp
2467 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2468 "\\(" tramp-host-regexp x-nil "\\)$")
2469 1 nil 2 nil))
2470 ;; "/method:[ipv6" "/[method/ipv6"
2471 (tramp-completion-file-name-structure9
2472 (list (concat tramp-prefix-regexp
2473 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2474 tramp-prefix-ipv6-regexp
2475 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2476 1 nil 2 nil))
2477 ;; "/method:user@host" "/[method/user@host"
2478 (tramp-completion-file-name-structure10
2479 (list (concat tramp-prefix-regexp
2480 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2481 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2482 "\\(" tramp-host-regexp x-nil "\\)$")
2483 1 2 3 nil))
2484 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2485 (tramp-completion-file-name-structure11
2486 (list (concat tramp-prefix-regexp
2487 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2488 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2489 tramp-prefix-ipv6-regexp
2490 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2491 1 2 3 nil)))
2493 (mapc (lambda (structure)
2494 (add-to-list 'result
2495 (tramp-completion-dissect-file-name1 structure name)))
2496 (list
2497 tramp-completion-file-name-structure1
2498 tramp-completion-file-name-structure2
2499 tramp-completion-file-name-structure3
2500 tramp-completion-file-name-structure4
2501 tramp-completion-file-name-structure5
2502 tramp-completion-file-name-structure6
2503 tramp-completion-file-name-structure7
2504 tramp-completion-file-name-structure8
2505 tramp-completion-file-name-structure9
2506 tramp-completion-file-name-structure10
2507 tramp-completion-file-name-structure11
2508 tramp-file-name-structure))
2510 (delq nil result)))
2512 (defun tramp-completion-dissect-file-name1 (structure name)
2513 "Returns a `tramp-file-name' structure matching STRUCTURE.
2514 The structure consists of remote method, remote user,
2515 remote host and localname (filename on remote host)."
2517 (save-match-data
2518 (when (string-match (nth 0 structure) name)
2519 (let ((method (and (nth 1 structure)
2520 (match-string (nth 1 structure) name)))
2521 (user (and (nth 2 structure)
2522 (match-string (nth 2 structure) name)))
2523 (host (and (nth 3 structure)
2524 (match-string (nth 3 structure) name)))
2525 (localname (and (nth 4 structure)
2526 (match-string (nth 4 structure) name))))
2527 (vector method user host localname nil)))))
2529 ;; This function returns all possible method completions, adding the
2530 ;; trailing method delimiter.
2531 (defun tramp-get-completion-methods (partial-method)
2532 "Returns all method completions for PARTIAL-METHOD."
2533 (mapcar
2534 (lambda (method)
2535 (and method
2536 (string-match (concat "^" (regexp-quote partial-method)) method)
2537 (tramp-completion-make-tramp-file-name method nil nil nil)))
2538 (mapcar 'car tramp-methods)))
2540 ;; Compares partial user and host names with possible completions.
2541 (defun tramp-get-completion-user-host
2542 (method partial-user partial-host user host)
2543 "Returns the most expanded string for user and host name completion.
2544 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2545 (cond
2547 ((and partial-user partial-host)
2548 (if (and host
2549 (string-match (concat "^" (regexp-quote partial-host)) host)
2550 (string-equal partial-user (or user partial-user)))
2551 (setq user partial-user)
2552 (setq user nil
2553 host nil)))
2555 (partial-user
2556 (setq host nil)
2557 (unless
2558 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2559 (setq user nil)))
2561 (partial-host
2562 (setq user nil)
2563 (unless
2564 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2565 (setq host nil)))
2567 (t (setq user nil
2568 host nil)))
2570 (unless (zerop (+ (length user) (length host)))
2571 (tramp-completion-make-tramp-file-name method user host nil)))
2573 (defun tramp-parse-default-user-host (method)
2574 "Return a list of (user host) tuples allowed to access for METHOD.
2575 This function is added always in `tramp-get-completion-function'
2576 for all methods. Resulting data are derived from default settings."
2577 `((,(tramp-find-user method nil nil) ,(tramp-find-host method nil nil))))
2579 ;; Generic function.
2580 (defun tramp-parse-group (regexp match-level skip-regexp)
2581 "Return a (user host) tuple allowed to access.
2582 User is always nil."
2583 (let (result)
2584 (when (re-search-forward regexp (point-at-eol) t)
2585 (setq result (list nil (match-string match-level))))
2587 (> (skip-chars-forward skip-regexp) 0)
2588 (forward-line 1))
2589 result))
2591 ;; Generic function.
2592 (defun tramp-parse-file (filename function)
2593 "Return a list of (user host) tuples allowed to access.
2594 User is always nil."
2595 ;; On Windows, there are problems in completion when
2596 ;; `default-directory' is remote.
2597 (let ((default-directory (tramp-compat-temporary-file-directory)))
2598 (when (file-readable-p filename)
2599 (with-temp-buffer
2600 (insert-file-contents filename)
2601 (goto-char (point-min))
2602 (loop while (not (eobp)) collect (funcall function))))))
2604 ;;;###tramp-autoload
2605 (defun tramp-parse-rhosts (filename)
2606 "Return a list of (user host) tuples allowed to access.
2607 Either user or host may be nil."
2608 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2610 (defun tramp-parse-rhosts-group ()
2611 "Return a (user host) tuple allowed to access.
2612 Either user or host may be nil."
2613 (let ((result)
2614 (regexp
2615 (concat
2616 "^\\(" tramp-host-regexp "\\)"
2617 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2618 (when (re-search-forward regexp (point-at-eol) t)
2619 (setq result (append (list (match-string 3) (match-string 1)))))
2620 (forward-line 1)
2621 result))
2623 ;;;###tramp-autoload
2624 (defun tramp-parse-shosts (filename)
2625 "Return a list of (user host) tuples allowed to access.
2626 User is always nil."
2627 (tramp-parse-file filename 'tramp-parse-shosts-group))
2629 (defun tramp-parse-shosts-group ()
2630 "Return a (user host) tuple allowed to access.
2631 User is always nil."
2632 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2634 ;;;###tramp-autoload
2635 (defun tramp-parse-sconfig (filename)
2636 "Return a list of (user host) tuples allowed to access.
2637 User is always nil."
2638 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2640 (defun tramp-parse-sconfig-group ()
2641 "Return a (user host) tuple allowed to access.
2642 User is always nil."
2643 (tramp-parse-group
2644 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2646 ;; Generic function.
2647 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2648 "Return a list of (user host) tuples allowed to access.
2649 User is always nil."
2650 ;; On Windows, there are problems in completion when
2651 ;; `default-directory' is remote.
2652 (let* ((default-directory (tramp-compat-temporary-file-directory))
2653 (files (and (file-directory-p dirname) (directory-files dirname))))
2654 (loop for f in files
2655 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2656 collect (list nil (match-string 1 f)))))
2658 ;;;###tramp-autoload
2659 (defun tramp-parse-shostkeys (dirname)
2660 "Return a list of (user host) tuples allowed to access.
2661 User is always nil."
2662 (tramp-parse-shostkeys-sknownhosts
2663 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2665 ;;;###tramp-autoload
2666 (defun tramp-parse-sknownhosts (dirname)
2667 "Return a list of (user host) tuples allowed to access.
2668 User is always nil."
2669 (tramp-parse-shostkeys-sknownhosts
2670 dirname
2671 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2673 ;;;###tramp-autoload
2674 (defun tramp-parse-hosts (filename)
2675 "Return a list of (user host) tuples allowed to access.
2676 User is always nil."
2677 (tramp-parse-file filename 'tramp-parse-hosts-group))
2679 (defun tramp-parse-hosts-group ()
2680 "Return a (user host) tuple allowed to access.
2681 User is always nil."
2682 (tramp-parse-group
2683 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2685 ;;;###tramp-autoload
2686 (defun tramp-parse-passwd (filename)
2687 "Return a list of (user host) tuples allowed to access.
2688 Host is always \"localhost\"."
2689 (with-tramp-connection-property nil "parse-passwd"
2690 (if (executable-find "getent")
2691 (with-temp-buffer
2692 (when (zerop (tramp-call-process nil "getent" nil t nil "passwd"))
2693 (goto-char (point-min))
2694 (loop while (not (eobp)) collect
2695 (tramp-parse-etc-group-group))))
2696 (tramp-parse-file filename 'tramp-parse-passwd-group))))
2698 (defun tramp-parse-passwd-group ()
2699 "Return a (user host) tuple allowed to access.
2700 Host is always \"localhost\"."
2701 (let ((result)
2702 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2703 (when (re-search-forward regexp (point-at-eol) t)
2704 (setq result (list (match-string 1) "localhost")))
2705 (forward-line 1)
2706 result))
2708 ;;;###tramp-autoload
2709 (defun tramp-parse-etc-group (filename)
2710 "Return a list of (group host) tuples allowed to access.
2711 Host is always \"localhost\"."
2712 (with-tramp-connection-property nil "parse-group"
2713 (if (executable-find "getent")
2714 (with-temp-buffer
2715 (when (zerop (tramp-call-process nil "getent" nil t nil "group"))
2716 (goto-char (point-min))
2717 (loop while (not (eobp)) collect
2718 (tramp-parse-etc-group-group))))
2719 (tramp-parse-file filename 'tramp-parse-etc-group-group))))
2721 (defun tramp-parse-etc-group-group ()
2722 "Return a (group host) tuple allowed to access.
2723 Host is always \"localhost\"."
2724 (let ((result)
2725 (split (split-string (buffer-substring (point) (point-at-eol)) ":")))
2726 (when (member (user-login-name) (split-string (nth 3 split) "," 'omit))
2727 (setq result (list (nth 0 split) "localhost")))
2728 (forward-line 1)
2729 result))
2731 ;;;###tramp-autoload
2732 (defun tramp-parse-netrc (filename)
2733 "Return a list of (user host) tuples allowed to access.
2734 User may be nil."
2735 (tramp-parse-file filename 'tramp-parse-netrc-group))
2737 (defun tramp-parse-netrc-group ()
2738 "Return a (user host) tuple allowed to access.
2739 User may be nil."
2740 (let ((result)
2741 (regexp
2742 (concat
2743 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2744 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2745 (when (re-search-forward regexp (point-at-eol) t)
2746 (setq result (list (match-string 3) (match-string 1))))
2747 (forward-line 1)
2748 result))
2750 ;;;###tramp-autoload
2751 (defun tramp-parse-putty (registry-or-dirname)
2752 "Return a list of (user host) tuples allowed to access.
2753 User is always nil."
2754 (if (memq system-type '(windows-nt))
2755 (with-tramp-connection-property nil "parse-putty"
2756 (with-temp-buffer
2757 (when (zerop (tramp-call-process
2758 nil "reg" nil t nil "query" registry-or-dirname))
2759 (goto-char (point-min))
2760 (loop while (not (eobp)) collect
2761 (tramp-parse-putty-group registry-or-dirname)))))
2762 ;; UNIX case.
2763 (tramp-parse-shostkeys-sknownhosts
2764 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2766 (defun tramp-parse-putty-group (registry)
2767 "Return a (user host) tuple allowed to access.
2768 User is always nil."
2769 (let ((result)
2770 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2771 (when (re-search-forward regexp (point-at-eol) t)
2772 (setq result (list nil (match-string 1))))
2773 (forward-line 1)
2774 result))
2776 ;;; Common file name handler functions for different backends:
2778 (defvar tramp-handle-file-local-copy-hook nil
2779 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2781 (defvar tramp-handle-write-region-hook nil
2782 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2784 (defun tramp-handle-directory-file-name (directory)
2785 "Like `directory-file-name' for Tramp files."
2786 ;; If localname component of filename is "/", leave it unchanged.
2787 ;; Otherwise, remove any trailing slash from localname component.
2788 ;; Method, host, etc, are unchanged. Does it make sense to try
2789 ;; to avoid parsing the filename?
2790 (with-parsed-tramp-file-name directory nil
2791 (if (and (not (zerop (length localname)))
2792 (eq (aref localname (1- (length localname))) ?/)
2793 (not (string= localname "/")))
2794 (substring directory 0 -1)
2795 directory)))
2797 (defun tramp-handle-directory-files (directory &optional full match nosort)
2798 "Like `directory-files' for Tramp files."
2799 (when (file-directory-p directory)
2800 (setq directory (file-name-as-directory (expand-file-name directory)))
2801 (let ((temp (nreverse (file-name-all-completions "" directory)))
2802 result item)
2804 (while temp
2805 (setq item (directory-file-name (pop temp)))
2806 (when (or (null match) (string-match match item))
2807 (push (if full (concat directory item) item)
2808 result)))
2809 (if nosort result (sort result 'string<)))))
2811 (defun tramp-handle-directory-files-and-attributes
2812 (directory &optional full match nosort id-format)
2813 "Like `directory-files-and-attributes' for Tramp files."
2814 (mapcar
2815 (lambda (x)
2816 (cons x (file-attributes
2817 (if full x (expand-file-name x directory)) id-format)))
2818 (directory-files directory full match nosort)))
2820 (defun tramp-handle-dired-uncache (dir)
2821 "Like `dired-uncache' for Tramp files."
2822 (with-parsed-tramp-file-name
2823 (if (file-directory-p dir) dir (file-name-directory dir)) nil
2824 (tramp-flush-directory-property v localname)))
2826 (defun tramp-handle-file-accessible-directory-p (filename)
2827 "Like `file-accessible-directory-p' for Tramp files."
2828 (and (file-directory-p filename)
2829 (file-readable-p filename)))
2831 (defun tramp-handle-file-equal-p (filename1 filename2)
2832 "Like `file-equalp-p' for Tramp files."
2833 ;; Native `file-equalp-p' calls `file-truename', which requires a
2834 ;; remote connection. This can be avoided, if FILENAME1 and
2835 ;; FILENAME2 are not located on the same remote host.
2836 (when (string-equal
2837 (file-remote-p (expand-file-name filename1))
2838 (file-remote-p (expand-file-name filename2)))
2839 (tramp-run-real-handler 'file-equal-p (list filename1 filename2))))
2841 (defun tramp-handle-file-exists-p (filename)
2842 "Like `file-exists-p' for Tramp files."
2843 (not (null (file-attributes filename))))
2845 (defun tramp-handle-file-in-directory-p (filename directory)
2846 "Like `file-in-directory-p' for Tramp files."
2847 ;; Native `file-in-directory-p' calls `file-truename', which
2848 ;; requires a remote connection. This can be avoided, if FILENAME
2849 ;; and DIRECTORY are not located on the same remote host.
2850 (when (string-equal
2851 (file-remote-p (expand-file-name filename))
2852 (file-remote-p (expand-file-name directory)))
2853 (tramp-run-real-handler 'file-in-directory-p (list filename directory))))
2855 (defun tramp-handle-file-modes (filename)
2856 "Like `file-modes' for Tramp files."
2857 (let ((truename (or (file-truename filename) filename)))
2858 (when (file-exists-p truename)
2859 (tramp-mode-string-to-int
2860 (tramp-compat-file-attribute-modes (file-attributes truename))))))
2862 ;; Localname manipulation functions that grok Tramp localnames...
2863 (defun tramp-handle-file-name-as-directory (file)
2864 "Like `file-name-as-directory' but aware of Tramp files."
2865 ;; `file-name-as-directory' would be sufficient except localname is
2866 ;; the empty string.
2867 (let ((v (tramp-dissect-file-name file t)))
2868 ;; Run the command on the localname portion only unless we are in
2869 ;; completion mode.
2870 (tramp-make-tramp-file-name
2871 (tramp-file-name-method v)
2872 (tramp-file-name-user v)
2873 (tramp-file-name-host v)
2874 (if (and (tramp-completion-mode-p)
2875 (zerop (length (tramp-file-name-localname v))))
2877 (tramp-run-real-handler
2878 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))
2879 (tramp-file-name-hop v))))
2881 (defun tramp-handle-file-name-completion
2882 (filename directory &optional predicate)
2883 "Like `file-name-completion' for Tramp files."
2884 (unless (tramp-tramp-file-p directory)
2885 (error
2886 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2887 directory))
2888 (let (hits-ignored-extensions)
2890 (try-completion
2891 filename (file-name-all-completions filename directory)
2892 (lambda (x)
2893 (when (funcall (or predicate 'identity) (expand-file-name x directory))
2894 (not
2895 (and
2896 completion-ignored-extensions
2897 (string-match
2898 (concat (regexp-opt completion-ignored-extensions 'paren) "$") x)
2899 ;; We remember the hit.
2900 (push x hits-ignored-extensions))))))
2901 ;; No match. So we try again for ignored files.
2902 (try-completion filename hits-ignored-extensions))))
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) "")))
2918 (tramp-file-name-hop v))))
2920 (defun tramp-handle-file-name-nondirectory (file)
2921 "Like `file-name-nondirectory' but aware of Tramp files."
2922 (with-parsed-tramp-file-name file nil
2923 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2925 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2926 "Like `file-newer-than-file-p' for Tramp files."
2927 (cond
2928 ((not (file-exists-p file1)) nil)
2929 ((not (file-exists-p file2)) t)
2930 (t (time-less-p (tramp-compat-file-attribute-modification-time
2931 (file-attributes file2))
2932 (tramp-compat-file-attribute-modification-time
2933 (file-attributes file1))))))
2935 (defun tramp-handle-file-regular-p (filename)
2936 "Like `file-regular-p' for Tramp files."
2937 (and (file-exists-p filename)
2938 (eq ?-
2939 (aref (tramp-compat-file-attribute-modes (file-attributes filename))
2940 0))))
2942 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2943 "Like `file-remote-p' for Tramp files."
2944 ;; We do not want traces in the debug buffer.
2945 (let ((tramp-verbose (min tramp-verbose 3)))
2946 (when (tramp-tramp-file-p filename)
2947 (let* ((v (tramp-dissect-file-name filename))
2948 (p (tramp-get-connection-process v))
2949 (c (and (tramp-compat-process-live-p p)
2950 (tramp-get-connection-property p "connected" nil))))
2951 ;; We expand the file name only, if there is already a connection.
2952 (with-parsed-tramp-file-name
2953 (if c (expand-file-name filename) filename) nil
2954 (and (or (not connected) c)
2955 (cond
2956 ((eq identification 'method) method)
2957 ((eq identification 'user) user)
2958 ((eq identification 'host) host)
2959 ((eq identification 'localname) localname)
2960 ((eq identification 'hop) hop)
2961 (t (tramp-make-tramp-file-name method user host "" hop)))))))))
2963 (defun tramp-handle-file-symlink-p (filename)
2964 "Like `file-symlink-p' for Tramp files."
2965 (with-parsed-tramp-file-name filename nil
2966 (let ((x (tramp-compat-file-attribute-type (file-attributes filename))))
2967 (when (stringp x)
2968 (if (file-name-absolute-p x)
2969 (tramp-make-tramp-file-name method user host x)
2970 x)))))
2972 (defun tramp-handle-find-backup-file-name (filename)
2973 "Like `find-backup-file-name' for Tramp files."
2974 (with-parsed-tramp-file-name filename nil
2975 (let ((backup-directory-alist
2976 (if tramp-backup-directory-alist
2977 (mapcar
2978 (lambda (x)
2979 (cons
2980 (car x)
2981 (if (and (stringp (cdr x))
2982 (file-name-absolute-p (cdr x))
2983 (not (tramp-file-name-p (cdr x))))
2984 (tramp-make-tramp-file-name method user host (cdr x))
2985 (cdr x))))
2986 tramp-backup-directory-alist)
2987 backup-directory-alist)))
2988 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2990 (defun tramp-handle-insert-directory
2991 (filename switches &optional wildcard full-directory-p)
2992 "Like `insert-directory' for Tramp files."
2993 (unless switches (setq switches ""))
2994 ;; Mark trailing "/".
2995 (when (and (zerop (length (file-name-nondirectory filename)))
2996 (not full-directory-p))
2997 (setq switches (concat switches "F")))
2998 (with-parsed-tramp-file-name (expand-file-name filename) nil
2999 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
3000 (require 'ls-lisp)
3001 (let (ls-lisp-use-insert-directory-program start)
3002 (tramp-run-real-handler
3003 'insert-directory
3004 (list filename switches wildcard full-directory-p))
3005 ;; `ls-lisp' always returns full listings. We must remove
3006 ;; superfluous parts.
3007 (unless (string-match "l" switches)
3008 (save-excursion
3009 (goto-char (point-min))
3010 (while (setq start
3011 (text-property-not-all
3012 (point) (point-at-eol) 'dired-filename t))
3013 (delete-region
3014 start
3015 (or (text-property-any start (point-at-eol) 'dired-filename t)
3016 (point-at-eol)))
3017 (if (= (point-at-bol) (point-at-eol))
3018 ;; Empty line.
3019 (delete-region (point) (progn (forward-line) (point)))
3020 (forward-line)))))))))
3022 (defun tramp-handle-insert-file-contents
3023 (filename &optional visit beg end replace)
3024 "Like `insert-file-contents' for Tramp files."
3025 (barf-if-buffer-read-only)
3026 (setq filename (expand-file-name filename))
3027 (let (result local-copy remote-copy)
3028 (with-parsed-tramp-file-name filename nil
3029 (unwind-protect
3030 (if (not (file-exists-p filename))
3031 (tramp-error
3032 v tramp-file-missing
3033 "File `%s' not found on remote host" filename)
3035 (with-tramp-progress-reporter
3036 v 3 (format-message "Inserting `%s'" filename)
3037 (condition-case err
3038 (if (and (tramp-local-host-p v)
3039 (let (file-name-handler-alist)
3040 (file-readable-p localname)))
3041 ;; Short track: if we are on the local host, we can
3042 ;; run directly.
3043 (setq result
3044 (tramp-run-real-handler
3045 'insert-file-contents
3046 (list localname visit beg end replace)))
3048 ;; When we shall insert only a part of the file, we
3049 ;; copy this part. This works only for the shell file
3050 ;; name handlers.
3051 (when (and (or beg end)
3052 (tramp-get-method-parameter
3053 v 'tramp-login-program))
3054 (setq remote-copy (tramp-make-tramp-temp-file v))
3055 ;; This is defined in tramp-sh.el. Let's assume
3056 ;; this is loaded already.
3057 (tramp-compat-funcall
3058 'tramp-send-command
3060 (cond
3061 ((and beg end)
3062 (format "dd bs=1 skip=%d if=%s count=%d of=%s"
3063 beg (tramp-shell-quote-argument localname)
3064 (- end beg) remote-copy))
3065 (beg
3066 (format "dd bs=1 skip=%d if=%s of=%s"
3067 beg (tramp-shell-quote-argument localname)
3068 remote-copy))
3069 (end
3070 (format "dd bs=1 count=%d if=%s of=%s"
3071 end (tramp-shell-quote-argument localname)
3072 remote-copy))))
3073 (setq tramp-temp-buffer-file-name nil beg nil end nil))
3075 ;; `insert-file-contents-literally' takes care to
3076 ;; avoid calling jka-compr.el and epa.el. By
3077 ;; let-binding `inhibit-file-name-operation', we
3078 ;; propagate that care to the `file-local-copy'
3079 ;; operation.
3080 (setq local-copy
3081 (let ((inhibit-file-name-operation
3082 (when (eq inhibit-file-name-operation
3083 'insert-file-contents)
3084 'file-local-copy)))
3085 (cond
3086 ((stringp remote-copy)
3087 (file-local-copy
3088 (tramp-make-tramp-file-name
3089 method user host remote-copy)))
3090 ((stringp tramp-temp-buffer-file-name)
3091 (copy-file
3092 filename tramp-temp-buffer-file-name 'ok)
3093 tramp-temp-buffer-file-name)
3094 (t (file-local-copy filename)))))
3096 ;; When the file is not readable for the owner, it
3097 ;; cannot be inserted, even if it is readable for the
3098 ;; group or for everybody.
3099 (set-file-modes local-copy (string-to-number "0600" 8))
3101 (when (and (null remote-copy)
3102 (tramp-get-method-parameter
3103 v 'tramp-copy-keep-tmpfile))
3104 ;; We keep the local file for performance reasons,
3105 ;; useful for "rsync".
3106 (setq tramp-temp-buffer-file-name local-copy))
3108 ;; We must ensure that `file-coding-system-alist'
3109 ;; matches `local-copy'.
3110 (let ((file-coding-system-alist
3111 (tramp-find-file-name-coding-system-alist
3112 filename local-copy)))
3113 (setq result
3114 (insert-file-contents
3115 local-copy visit beg end replace))))
3116 (error
3117 (add-hook 'find-file-not-found-functions
3118 `(lambda () (signal ',(car err) ',(cdr err)))
3119 nil t)
3120 (signal (car err) (cdr err))))))
3122 ;; Save exit.
3123 (progn
3124 (when visit
3125 (setq buffer-file-name filename)
3126 (setq buffer-read-only (not (file-writable-p filename)))
3127 (set-visited-file-modtime)
3128 (set-buffer-modified-p nil))
3129 (when (and (stringp local-copy)
3130 (or remote-copy (null tramp-temp-buffer-file-name)))
3131 (delete-file local-copy))
3132 (when (stringp remote-copy)
3133 (delete-file
3134 (tramp-make-tramp-file-name method user host remote-copy)))))
3136 ;; Result.
3137 (list (expand-file-name filename)
3138 (cadr result)))))
3140 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
3141 "Like `load' for Tramp files."
3142 (with-parsed-tramp-file-name (expand-file-name file) nil
3143 (unless nosuffix
3144 (cond ((file-exists-p (concat file ".elc"))
3145 (setq file (concat file ".elc")))
3146 ((file-exists-p (concat file ".el"))
3147 (setq file (concat file ".el")))))
3148 (when must-suffix
3149 ;; The first condition is always true for absolute file names.
3150 ;; Included for safety's sake.
3151 (unless (or (file-name-directory file)
3152 (string-match "\\.elc?\\'" file))
3153 (tramp-error
3154 v 'file-error
3155 "File `%s' does not include a `.el' or `.elc' suffix" file)))
3156 (unless noerror
3157 (when (not (file-exists-p file))
3158 (tramp-error
3159 v tramp-file-missing "Cannot load nonexistent file `%s'" file)))
3160 (if (not (file-exists-p file))
3162 (let ((tramp-message-show-message (not nomessage)))
3163 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3164 (let ((local-copy (file-local-copy file)))
3165 (unwind-protect
3166 (load local-copy noerror t nosuffix must-suffix)
3167 (delete-file local-copy)))))
3168 t)))
3170 (defun tramp-handle-make-symbolic-link
3171 (filename linkname &optional _ok-if-already-exists)
3172 "Like `make-symbolic-link' for Tramp files."
3173 (with-parsed-tramp-file-name
3174 (if (tramp-tramp-file-p filename) filename linkname) nil
3175 (tramp-error v 'file-error "make-symbolic-link not supported")))
3177 (defun tramp-handle-shell-command
3178 (command &optional output-buffer error-buffer)
3179 "Like `shell-command' for Tramp files."
3180 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3181 ;; We cannot use `shell-file-name' and `shell-command-switch',
3182 ;; they are variables of the local host.
3183 (args (append
3184 (cons
3185 (tramp-get-method-parameter
3186 (tramp-dissect-file-name default-directory)
3187 'tramp-remote-shell)
3188 (tramp-get-method-parameter
3189 (tramp-dissect-file-name default-directory)
3190 'tramp-remote-shell-args))
3191 (list (substring command 0 asynchronous))))
3192 current-buffer-p
3193 (output-buffer
3194 (cond
3195 ((bufferp output-buffer) output-buffer)
3196 ((stringp output-buffer) (get-buffer-create output-buffer))
3197 (output-buffer
3198 (setq current-buffer-p t)
3199 (current-buffer))
3200 (t (get-buffer-create
3201 (if asynchronous
3202 "*Async Shell Command*"
3203 "*Shell Command Output*")))))
3204 (error-buffer
3205 (cond
3206 ((bufferp error-buffer) error-buffer)
3207 ((stringp error-buffer) (get-buffer-create error-buffer))))
3208 (buffer
3209 (if (and (not asynchronous) error-buffer)
3210 (with-parsed-tramp-file-name default-directory nil
3211 (list output-buffer (tramp-make-tramp-temp-file v)))
3212 output-buffer))
3213 (p (get-buffer-process output-buffer)))
3215 ;; Check whether there is another process running. Tramp does not
3216 ;; support 2 (asynchronous) processes in parallel.
3217 (when p
3218 (if (yes-or-no-p "A command is running. Kill it? ")
3219 (ignore-errors (kill-process p))
3220 (tramp-compat-user-error p "Shell command in progress")))
3222 (if current-buffer-p
3223 (progn
3224 (barf-if-buffer-read-only)
3225 (push-mark nil t))
3226 (with-current-buffer output-buffer
3227 (setq buffer-read-only nil)
3228 (erase-buffer)))
3230 (if (and (not current-buffer-p) (integerp asynchronous))
3231 (prog1
3232 ;; Run the process.
3233 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3234 ;; Display output.
3235 (with-current-buffer output-buffer
3236 (display-buffer output-buffer '(nil (allow-no-window . t)))
3237 (setq mode-line-process '(":%s"))
3238 (shell-mode)
3239 (set-process-sentinel p 'shell-command-sentinel)
3240 (set-process-filter p 'comint-output-filter)))
3242 (prog1
3243 ;; Run the process.
3244 (apply 'process-file (car args) nil buffer nil (cdr args))
3245 ;; Insert error messages if they were separated.
3246 (when (listp buffer)
3247 (with-current-buffer error-buffer
3248 (insert-file-contents (cadr buffer)))
3249 (delete-file (cadr buffer)))
3250 (if current-buffer-p
3251 ;; This is like exchange-point-and-mark, but doesn't
3252 ;; activate the mark. It is cleaner to avoid activation,
3253 ;; even though the command loop would deactivate the mark
3254 ;; because we inserted text.
3255 (goto-char (prog1 (mark t)
3256 (set-marker (mark-marker) (point)
3257 (current-buffer))))
3258 ;; There's some output, display it.
3259 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3260 (display-message-or-buffer output-buffer)))))))
3262 (defun tramp-handle-substitute-in-file-name (filename)
3263 "Like `substitute-in-file-name' for Tramp files.
3264 \"//\" and \"/~\" substitute only in the local filename part."
3265 ;; First, we must replace environment variables.
3266 (setq filename (tramp-replace-environment-variables filename))
3267 (with-parsed-tramp-file-name filename nil
3268 ;; Ignore in LOCALNAME everything before "//" or "/~".
3269 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3270 (setq filename
3271 (concat (file-remote-p filename)
3272 (replace-match "\\1" nil nil localname)))
3273 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3274 (when (string-match "~$" filename)
3275 (setq filename (concat filename "/"))))
3276 ;; We do not want to replace environment variables, again.
3277 (let (process-environment)
3278 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3280 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
3281 "Like `set-visited-file-modtime' for Tramp files."
3282 (unless (buffer-file-name)
3283 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3284 (buffer-name)))
3285 (unless time-list
3286 (let ((remote-file-name-inhibit-cache t))
3287 ;; '(-1 65535) means file doesn't exists yet.
3288 (setq time-list
3289 (or (tramp-compat-file-attribute-modification-time
3290 (file-attributes (buffer-file-name)))
3291 '(-1 65535)))))
3292 ;; We use '(0 0) as a don't-know value.
3293 (unless (equal time-list '(0 0))
3294 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))))
3296 (defun tramp-handle-verify-visited-file-modtime (&optional buf)
3297 "Like `verify-visited-file-modtime' for Tramp files.
3298 At the time `verify-visited-file-modtime' calls this function, we
3299 already know that the buffer is visiting a file and that
3300 `visited-file-modtime' does not return 0. Do not call this
3301 function directly, unless those two cases are already taken care
3302 of."
3303 (with-current-buffer (or buf (current-buffer))
3304 (let ((f (buffer-file-name)))
3305 ;; There is no file visiting the buffer, or the buffer has no
3306 ;; recorded last modification time, or there is no established
3307 ;; connection.
3308 (if (or (not f)
3309 (eq (visited-file-modtime) 0)
3310 (not (file-remote-p f nil 'connected)))
3312 (with-parsed-tramp-file-name f nil
3313 (let* ((remote-file-name-inhibit-cache t)
3314 (attr (file-attributes f))
3315 (modtime (tramp-compat-file-attribute-modification-time attr))
3316 (mt (visited-file-modtime)))
3318 (cond
3319 ;; File exists, and has a known modtime.
3320 ((and attr (not (equal modtime '(0 0))))
3321 (< (abs (tramp-time-diff
3322 modtime
3323 ;; For compatibility, deal with both the old
3324 ;; (HIGH . LOW) and the new (HIGH LOW) return
3325 ;; values of `visited-file-modtime'.
3326 (if (atom (cdr mt))
3327 (list (car mt) (cdr mt))
3328 mt)))
3330 ;; Modtime has the don't know value.
3331 (attr t)
3332 ;; If file does not exist, say it is not modified if and
3333 ;; only if that agrees with the buffer's record.
3334 (t (equal mt '(-1 65535))))))))))
3336 (defun tramp-handle-file-notify-add-watch (filename _flags _callback)
3337 "Like `file-notify-add-watch' for Tramp files."
3338 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3339 ;; their own one.
3340 (setq filename (expand-file-name filename))
3341 (with-parsed-tramp-file-name filename nil
3342 (tramp-error
3343 v 'file-notify-error "File notification not supported for `%s'" filename)))
3345 (defun tramp-handle-file-notify-rm-watch (proc)
3346 "Like `file-notify-rm-watch' for Tramp files."
3347 ;; The descriptor must be a process object.
3348 (unless (processp proc)
3349 (tramp-error proc 'file-notify-error "Not a valid descriptor %S" proc))
3350 (tramp-message proc 6 "Kill %S" proc)
3351 (delete-process proc))
3353 (defun tramp-handle-file-notify-valid-p (proc)
3354 "Like `file-notify-valid-p' for Tramp files."
3355 (and (tramp-compat-process-live-p proc)
3356 ;; Sometimes, the process is still in status `run' when the
3357 ;; file or directory to be watched is deleted already.
3358 (with-current-buffer (process-buffer proc)
3359 (file-exists-p
3360 (concat (file-remote-p default-directory)
3361 (process-get proc 'watch-name))))))
3363 ;;; Functions for establishing connection:
3365 ;; The following functions are actions to be taken when seeing certain
3366 ;; prompts from the remote host. See the variable
3367 ;; `tramp-actions-before-shell' for usage of these functions.
3369 (defun tramp-action-login (_proc vec)
3370 "Send the login name."
3371 (when (not (stringp tramp-current-user))
3372 (setq tramp-current-user
3373 (with-tramp-connection-property vec "login-as"
3374 (save-window-excursion
3375 (let ((enable-recursive-minibuffers t))
3376 (pop-to-buffer (tramp-get-connection-buffer vec))
3377 (read-string (match-string 0)))))))
3378 (with-current-buffer (tramp-get-connection-buffer vec)
3379 (tramp-message vec 6 "\n%s" (buffer-string)))
3380 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3381 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3383 (defun tramp-action-password (proc vec)
3384 "Query the user for a password."
3385 (with-current-buffer (process-buffer proc)
3386 (let ((enable-recursive-minibuffers t)
3387 (case-fold-search t))
3388 ;; Let's check whether a wrong password has been sent already.
3389 ;; Sometimes, the process returns a new password request
3390 ;; immediately after rejecting the previous (wrong) one.
3391 (unless (tramp-get-connection-property vec "first-password-request" nil)
3392 (tramp-clear-passwd vec))
3393 (goto-char (point-min))
3394 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3395 (tramp-message vec 3 "Sending %s" (match-string 1))
3396 ;; We don't call `tramp-send-string' in order to hide the
3397 ;; password from the debug buffer.
3398 (process-send-string
3399 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3400 ;; Hide password prompt.
3401 (narrow-to-region (point-max) (point-max)))))
3403 (defun tramp-action-succeed (_proc _vec)
3404 "Signal success in finding shell prompt."
3405 (throw 'tramp-action 'ok))
3407 (defun tramp-action-permission-denied (proc _vec)
3408 "Signal permission denied."
3409 (kill-process proc)
3410 (throw 'tramp-action 'permission-denied))
3412 (defun tramp-action-yesno (proc vec)
3413 "Ask the user for confirmation using `yes-or-no-p'.
3414 Send \"yes\" to remote process on confirmation, abort otherwise.
3415 See also `tramp-action-yn'."
3416 (save-window-excursion
3417 (let ((enable-recursive-minibuffers t))
3418 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3419 (unless (yes-or-no-p (match-string 0))
3420 (kill-process proc)
3421 (throw 'tramp-action 'permission-denied))
3422 (with-current-buffer (tramp-get-connection-buffer vec)
3423 (tramp-message vec 6 "\n%s" (buffer-string)))
3424 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3426 (defun tramp-action-yn (proc vec)
3427 "Ask the user for confirmation using `y-or-n-p'.
3428 Send \"y\" to remote process on confirmation, abort otherwise.
3429 See also `tramp-action-yesno'."
3430 (save-window-excursion
3431 (let ((enable-recursive-minibuffers t))
3432 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3433 (unless (y-or-n-p (match-string 0))
3434 (kill-process proc)
3435 (throw 'tramp-action 'permission-denied))
3436 (with-current-buffer (tramp-get-connection-buffer vec)
3437 (tramp-message vec 6 "\n%s" (buffer-string)))
3438 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3440 (defun tramp-action-terminal (_proc vec)
3441 "Tell the remote host which terminal type to use.
3442 The terminal type can be configured with `tramp-terminal-type'."
3443 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3444 (with-current-buffer (tramp-get-connection-buffer vec)
3445 (tramp-message vec 6 "\n%s" (buffer-string)))
3446 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3448 (defun tramp-action-process-alive (proc _vec)
3449 "Check, whether a process has finished."
3450 (unless (tramp-compat-process-live-p proc)
3451 (throw 'tramp-action 'process-died)))
3453 (defun tramp-action-out-of-band (proc vec)
3454 "Check, whether an out-of-band copy has finished."
3455 ;; There might be pending output for the exit status.
3456 (tramp-accept-process-output proc 0.1)
3457 (cond ((and (not (tramp-compat-process-live-p proc))
3458 (zerop (process-exit-status proc)))
3459 (tramp-message vec 3 "Process has finished.")
3460 (throw 'tramp-action 'ok))
3461 ((or (and (memq (process-status proc) '(stop exit))
3462 (not (zerop (process-exit-status proc))))
3463 (memq (process-status proc) '(signal)))
3464 ;; `scp' could have copied correctly, but set modes could have failed.
3465 ;; This can be ignored.
3466 (with-current-buffer (process-buffer proc)
3467 (goto-char (point-min))
3468 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3469 (progn
3470 (tramp-message vec 5 "'set mode' error ignored.")
3471 (tramp-message vec 3 "Process has finished.")
3472 (throw 'tramp-action 'ok))
3473 (tramp-message vec 3 "Process has died.")
3474 (throw 'tramp-action 'out-of-band-failed))))
3475 (t nil)))
3477 ;;; Functions for processing the actions:
3479 (defun tramp-process-one-action (proc vec actions)
3480 "Wait for output from the shell and perform one action."
3481 (let ((case-fold-search t)
3482 found todo item pattern action)
3483 (while (not found)
3484 ;; Reread output once all actions have been performed.
3485 ;; Obviously, the output was not complete.
3486 (tramp-accept-process-output proc 1)
3487 (setq todo actions)
3488 (while todo
3489 (setq item (pop todo))
3490 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3491 (setq action (nth 1 item))
3492 (tramp-message
3493 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3494 (when (tramp-check-for-regexp proc pattern)
3495 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3496 (setq found (funcall action proc vec)))))
3497 found))
3499 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3500 "Perform ACTIONS until success or TIMEOUT.
3501 PROC and VEC indicate the remote connection to be used. POS, if
3502 set, is the starting point of the region to be deleted in the
3503 connection buffer."
3504 ;; Enable `auth-source'. We must use tramp-current-* variables in
3505 ;; case we have several hops.
3506 (tramp-set-connection-property
3507 (tramp-dissect-file-name
3508 (tramp-make-tramp-file-name
3509 tramp-current-method tramp-current-user tramp-current-host ""))
3510 "first-password-request" t)
3511 (save-restriction
3512 (with-tramp-progress-reporter
3513 proc 3 "Waiting for prompts from remote shell"
3514 (let (exit)
3515 (if timeout
3516 (with-timeout (timeout (setq exit 'timeout))
3517 (while (not exit)
3518 (setq exit
3519 (catch 'tramp-action
3520 (tramp-process-one-action proc vec actions)))))
3521 (while (not exit)
3522 (setq exit
3523 (catch 'tramp-action
3524 (tramp-process-one-action proc vec actions)))))
3525 (with-current-buffer (tramp-get-connection-buffer vec)
3526 (widen)
3527 (tramp-message vec 6 "\n%s" (buffer-string)))
3528 (unless (eq exit 'ok)
3529 (tramp-clear-passwd vec)
3530 (delete-process proc)
3531 (tramp-error-with-buffer
3532 (tramp-get-connection-buffer vec) vec 'file-error
3533 (cond
3534 ((eq exit 'permission-denied) "Permission denied")
3535 ((eq exit 'out-of-band-failed)
3536 (format-message
3537 "Copy failed, see buffer `%s' for details"
3538 (tramp-get-connection-buffer vec)))
3539 ((eq exit 'process-died)
3540 (substitute-command-keys
3541 (concat
3542 "Tramp failed to connect. If this happens repeatedly, try\n"
3543 " `\\[tramp-cleanup-this-connection]'")))
3544 ((eq exit 'timeout)
3545 (format-message
3546 "Timeout reached, see buffer `%s' for details"
3547 (tramp-get-connection-buffer vec)))
3548 (t "Login failed")))))
3549 (when (numberp pos)
3550 (with-current-buffer (tramp-get-connection-buffer vec)
3551 (let (buffer-read-only) (delete-region pos (point))))))))
3553 ;;; Utility functions:
3555 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3556 "Like `accept-process-output' for Tramp processes.
3557 This is needed in order to hide `last-coding-system-used', which is set
3558 for process communication also."
3559 (with-current-buffer (process-buffer proc)
3560 ;; FIXME: If there is a gateway process, we need communication
3561 ;; between several processes. Too complicate to implement, so we
3562 ;; read output from all processes.
3563 (let ((p (if (tramp-get-connection-property proc "gateway" nil) nil proc))
3564 buffer-read-only last-coding-system-used)
3565 ;; Under Windows XP, accept-process-output doesn't return
3566 ;; sometimes. So we add an additional timeout.
3567 (with-timeout ((or timeout 1))
3568 (accept-process-output p timeout timeout-msecs (and proc t)))
3569 (tramp-message proc 10 "%s %s %s\n%s"
3570 proc (process-status proc) p (buffer-string)))))
3572 (defun tramp-check-for-regexp (proc regexp)
3573 "Check, whether REGEXP is contained in process buffer of PROC.
3574 Erase echoed commands if exists."
3575 (with-current-buffer (process-buffer proc)
3576 (goto-char (point-min))
3578 ;; Check whether we need to remove echo output.
3579 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3580 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3581 (let ((begin (match-beginning 0)))
3582 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3583 ;; Discard echo from remote output.
3584 (tramp-set-connection-property proc "check-remote-echo" nil)
3585 (tramp-message proc 5 "echo-mark found")
3586 (forward-line 1)
3587 (delete-region begin (point))
3588 (goto-char (point-min)))))
3590 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3591 ;; Sometimes, the echo string is suppressed on the remote side.
3592 (not (string-equal
3593 (substring-no-properties
3594 tramp-echo-mark-marker
3595 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3596 (buffer-substring-no-properties
3597 (point-min)
3598 (min (+ (point-min) tramp-echo-mark-marker-length)
3599 (point-max))))))
3600 ;; No echo to be handled, now we can look for the regexp.
3601 ;; Sometimes, lines are much to long, and we run into a "Stack
3602 ;; overflow in regexp matcher". For example, //DIRED// lines of
3603 ;; directory listings with some thousand files. Therefore, we
3604 ;; look from the end.
3605 (goto-char (point-max))
3606 (ignore-errors (re-search-backward regexp nil t)))))
3608 (defun tramp-wait-for-regexp (proc timeout regexp)
3609 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3610 Expects the output of PROC to be sent to the current buffer. Returns
3611 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3612 nil."
3613 (with-current-buffer (process-buffer proc)
3614 (let ((found (tramp-check-for-regexp proc regexp)))
3615 (cond (timeout
3616 (with-timeout (timeout)
3617 (while (not found)
3618 (tramp-accept-process-output proc 1)
3619 (unless (tramp-compat-process-live-p proc)
3620 (tramp-error-with-buffer
3621 nil proc 'file-error "Process has died"))
3622 (setq found (tramp-check-for-regexp proc regexp)))))
3624 (while (not found)
3625 (tramp-accept-process-output proc 1)
3626 (unless (tramp-compat-process-live-p proc)
3627 (tramp-error-with-buffer
3628 nil proc 'file-error "Process has died"))
3629 (setq found (tramp-check-for-regexp proc regexp)))))
3630 (tramp-message proc 6 "\n%s" (buffer-string))
3631 (when (not found)
3632 (if timeout
3633 (tramp-error
3634 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3635 regexp timeout)
3636 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3637 found)))
3639 ;; It seems that Tru64 Unix does not like it if long strings are sent
3640 ;; to it in one go. (This happens when sending the Perl
3641 ;; `file-attributes' implementation, for instance.) Therefore, we
3642 ;; have this function which sends the string in chunks.
3643 (defun tramp-send-string (vec string)
3644 "Send the STRING via connection VEC.
3646 The STRING is expected to use Unix line-endings, but the lines sent to
3647 the remote host use line-endings as defined in the variable
3648 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3649 (let* ((p (tramp-get-connection-process vec))
3650 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3651 (unless p
3652 (tramp-error
3653 vec 'file-error "Can't send string to remote host -- not logged in"))
3654 (tramp-set-connection-property p "last-cmd-time" (current-time))
3655 (tramp-message vec 10 "%s" string)
3656 (with-current-buffer (tramp-get-connection-buffer vec)
3657 ;; Clean up the buffer. We cannot call `erase-buffer' because
3658 ;; narrowing might be in effect.
3659 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3660 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3661 (setq string
3662 (mapconcat
3663 'identity (split-string string "\n") tramp-rsh-end-of-line))
3664 (unless (or (string= string "")
3665 (string-equal (substring string -1) tramp-rsh-end-of-line))
3666 (setq string (concat string tramp-rsh-end-of-line)))
3667 ;; Send the string.
3668 (if (and chunksize (not (zerop chunksize)))
3669 (let ((pos 0)
3670 (end (length string)))
3671 (while (< pos end)
3672 (tramp-message
3673 vec 10 "Sending chunk from %s to %s"
3674 pos (min (+ pos chunksize) end))
3675 (process-send-string
3676 p (substring string pos (min (+ pos chunksize) end)))
3677 (setq pos (+ pos chunksize))))
3678 (process-send-string p string)))))
3680 (defun tramp-get-inode (vec)
3681 "Returns the virtual inode number.
3682 If it doesn't exist, generate a new one."
3683 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3684 (setq tramp-inodes (1+ tramp-inodes))))
3686 (defun tramp-get-device (vec)
3687 "Returns the virtual device number.
3688 If it doesn't exist, generate a new one."
3689 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3690 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3692 (defun tramp-equal-remote (file1 file2)
3693 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3694 The check depends on method, user and host name of the files. If
3695 one of the components is missing, the default values are used.
3696 The local file name parts of FILE1 and FILE2 are not taken into
3697 account.
3699 Example:
3701 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3703 would yield t. On the other hand, the following check results in nil:
3705 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3706 (and (tramp-tramp-file-p file1)
3707 (tramp-tramp-file-p file2)
3708 (string-equal (file-remote-p file1) (file-remote-p file2))))
3710 ;;;###tramp-autoload
3711 (defun tramp-mode-string-to-int (mode-string)
3712 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3713 (let* (case-fold-search
3714 (mode-chars (string-to-vector mode-string))
3715 (owner-read (aref mode-chars 1))
3716 (owner-write (aref mode-chars 2))
3717 (owner-execute-or-setid (aref mode-chars 3))
3718 (group-read (aref mode-chars 4))
3719 (group-write (aref mode-chars 5))
3720 (group-execute-or-setid (aref mode-chars 6))
3721 (other-read (aref mode-chars 7))
3722 (other-write (aref mode-chars 8))
3723 (other-execute-or-sticky (aref mode-chars 9)))
3724 (save-match-data
3725 (logior
3726 (cond
3727 ((char-equal owner-read ?r) (string-to-number "00400" 8))
3728 ((char-equal owner-read ?-) 0)
3729 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3730 (cond
3731 ((char-equal owner-write ?w) (string-to-number "00200" 8))
3732 ((char-equal owner-write ?-) 0)
3733 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3734 (cond
3735 ((char-equal owner-execute-or-setid ?x) (string-to-number "00100" 8))
3736 ((char-equal owner-execute-or-setid ?S) (string-to-number "04000" 8))
3737 ((char-equal owner-execute-or-setid ?s) (string-to-number "04100" 8))
3738 ((char-equal owner-execute-or-setid ?-) 0)
3739 (t (error "Fourth char `%c' must be one of `xsS-'"
3740 owner-execute-or-setid)))
3741 (cond
3742 ((char-equal group-read ?r) (string-to-number "00040" 8))
3743 ((char-equal group-read ?-) 0)
3744 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3745 (cond
3746 ((char-equal group-write ?w) (string-to-number "00020" 8))
3747 ((char-equal group-write ?-) 0)
3748 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3749 (cond
3750 ((char-equal group-execute-or-setid ?x) (string-to-number "00010" 8))
3751 ((char-equal group-execute-or-setid ?S) (string-to-number "02000" 8))
3752 ((char-equal group-execute-or-setid ?s) (string-to-number "02010" 8))
3753 ((char-equal group-execute-or-setid ?-) 0)
3754 (t (error "Seventh char `%c' must be one of `xsS-'"
3755 group-execute-or-setid)))
3756 (cond
3757 ((char-equal other-read ?r) (string-to-number "00004" 8))
3758 ((char-equal other-read ?-) 0)
3759 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3760 (cond
3761 ((char-equal other-write ?w) (string-to-number "00002" 8))
3762 ((char-equal other-write ?-) 0)
3763 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3764 (cond
3765 ((char-equal other-execute-or-sticky ?x) (string-to-number "00001" 8))
3766 ((char-equal other-execute-or-sticky ?T) (string-to-number "01000" 8))
3767 ((char-equal other-execute-or-sticky ?t) (string-to-number "01001" 8))
3768 ((char-equal other-execute-or-sticky ?-) 0)
3769 (t (error "Tenth char `%c' must be one of `xtT-'"
3770 other-execute-or-sticky)))))))
3772 (defconst tramp-file-mode-type-map
3773 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
3774 (1 . "p") ; fifo
3775 (2 . "c") ; character device
3776 (3 . "m") ; multiplexed character device (v7)
3777 (4 . "d") ; directory
3778 (5 . "?") ; Named special file (XENIX)
3779 (6 . "b") ; block device
3780 (7 . "?") ; multiplexed block device (v7)
3781 (8 . "-") ; regular file
3782 (9 . "n") ; network special file (HP-UX)
3783 (10 . "l") ; symlink
3784 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
3785 (12 . "s") ; socket
3786 (13 . "D") ; door special (Solaris)
3787 (14 . "w")) ; whiteout (BSD)
3788 "A list of file types returned from the `stat' system call.
3789 This is used to map a mode number to a permission string.")
3791 ;;;###tramp-autoload
3792 (defun tramp-file-mode-from-int (mode)
3793 "Turn an integer representing a file mode into an ls(1)-like string."
3794 (let ((type (cdr
3795 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
3796 (user (logand (lsh mode -6) 7))
3797 (group (logand (lsh mode -3) 7))
3798 (other (logand (lsh mode -0) 7))
3799 (suid (> (logand (lsh mode -9) 4) 0))
3800 (sgid (> (logand (lsh mode -9) 2) 0))
3801 (sticky (> (logand (lsh mode -9) 1) 0)))
3802 (setq user (tramp-file-mode-permissions user suid "s"))
3803 (setq group (tramp-file-mode-permissions group sgid "s"))
3804 (setq other (tramp-file-mode-permissions other sticky "t"))
3805 (concat type user group other)))
3807 (defun tramp-file-mode-permissions (perm suid suid-text)
3808 "Convert a permission bitset into a string.
3809 This is used internally by `tramp-file-mode-from-int'."
3810 (let ((r (> (logand perm 4) 0))
3811 (w (> (logand perm 2) 0))
3812 (x (> (logand perm 1) 0)))
3813 (concat (or (and r "r") "-")
3814 (or (and w "w") "-")
3815 (or (and suid x suid-text) ; suid, execute
3816 (and suid (upcase suid-text)) ; suid, !execute
3817 (and x "x") "-")))) ; !suid
3819 ;;;###tramp-autoload
3820 (defun tramp-get-local-uid (id-format)
3821 "The uid of the local user, in ID-FORMAT.
3822 ID-FORMAT valid values are `string' and `integer'."
3823 (if (equal id-format 'integer) (user-uid) (user-login-name)))
3825 ;;;###tramp-autoload
3826 (defun tramp-get-local-gid (id-format)
3827 "The gid of the local user, in ID-FORMAT.
3828 ID-FORMAT valid values are `string' and `integer'."
3829 ;; `group-gid' has been introduced with Emacs 24.4.
3830 (if (and (fboundp 'group-gid) (equal id-format 'integer))
3831 (tramp-compat-funcall 'group-gid)
3832 (tramp-compat-file-attribute-group-id (file-attributes "~/" id-format))))
3834 (defun tramp-get-local-locale (&optional vec)
3835 "Determine locale, supporting UTF8 if possible.
3836 VEC is used for tracing."
3837 ;; We use key nil for local connection properties.
3838 (with-tramp-connection-property nil "locale"
3839 (let ((candidates '("en_US.utf8" "C.utf8" "en_US.UTF-8"))
3840 locale)
3841 (with-temp-buffer
3842 (unless (or (memq system-type '(windows-nt))
3843 (not (zerop (tramp-call-process
3844 nil "locale" nil t nil "-a"))))
3845 (while candidates
3846 (goto-char (point-min))
3847 (if (string-match (format "^%s\r?$" (regexp-quote (car candidates)))
3848 (buffer-string))
3849 (setq locale (car candidates)
3850 candidates nil)
3851 (setq candidates (cdr candidates))))))
3852 ;; Return value.
3853 (when vec (tramp-message vec 7 "locale %s" (or locale "C")))
3854 (or locale "C"))))
3856 ;;;###tramp-autoload
3857 (defun tramp-check-cached-permissions (vec access)
3858 "Check `file-attributes' caches for VEC.
3859 Return t if according to the cache access type ACCESS is known to
3860 be granted."
3861 (let ((result nil)
3862 (offset (cond
3863 ((eq ?r access) 1)
3864 ((eq ?w access) 2)
3865 ((eq ?x access) 3))))
3866 (dolist (suffix '("string" "integer") result)
3867 (setq
3868 result
3870 result
3871 (let ((file-attr
3873 (tramp-get-file-property
3874 vec (tramp-file-name-localname vec)
3875 (concat "file-attributes-" suffix) nil)
3876 (file-attributes
3877 (tramp-make-tramp-file-name
3878 (tramp-file-name-method vec)
3879 (tramp-file-name-user vec)
3880 (tramp-file-name-host vec)
3881 (tramp-file-name-localname vec)
3882 (tramp-file-name-hop vec))
3883 (intern suffix))))
3884 (remote-uid
3885 (tramp-get-connection-property
3886 vec (concat "uid-" suffix) nil))
3887 (remote-gid
3888 (tramp-get-connection-property
3889 vec (concat "gid-" suffix) nil))
3890 (unknown-id
3891 (if (string-equal suffix "string")
3892 tramp-unknown-id-string tramp-unknown-id-integer)))
3893 (and
3894 file-attr
3896 ;; Not a symlink.
3897 (eq t (tramp-compat-file-attribute-type file-attr))
3898 (null (tramp-compat-file-attribute-type file-attr)))
3900 ;; World accessible.
3901 (eq access
3902 (aref (tramp-compat-file-attribute-modes file-attr)
3903 (+ offset 6)))
3904 ;; User accessible and owned by user.
3905 (and
3906 (eq access
3907 (aref (tramp-compat-file-attribute-modes file-attr) offset))
3908 (or (equal remote-uid
3909 (tramp-compat-file-attribute-user-id file-attr))
3910 (equal unknown-id
3911 (tramp-compat-file-attribute-user-id file-attr))))
3912 ;; Group accessible and owned by user's principal group.
3913 (and
3914 (eq access
3915 (aref (tramp-compat-file-attribute-modes file-attr)
3916 (+ offset 3)))
3917 (or (equal remote-gid
3918 (tramp-compat-file-attribute-group-id file-attr))
3919 (equal unknown-id
3920 (tramp-compat-file-attribute-group-id
3921 file-attr))))))))))))
3923 ;;;###tramp-autoload
3924 (defun tramp-local-host-p (vec)
3925 "Return t if this points to the local host, nil otherwise."
3926 ;; We cannot use `tramp-file-name-real-host'. A port is an
3927 ;; indication for an ssh tunnel or alike.
3928 (let ((host (tramp-file-name-host vec)))
3929 (and
3930 (stringp host)
3931 (string-match tramp-local-host-regexp host)
3932 ;; The method shall be applied to one of the shell file name
3933 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3934 ;; alike, where it must fail.
3935 (tramp-get-method-parameter vec 'tramp-login-program)
3936 ;; The local temp directory must be writable for the other user.
3937 (file-writable-p
3938 (tramp-make-tramp-file-name
3939 (tramp-file-name-method vec)
3940 (tramp-file-name-user vec)
3941 host
3942 (tramp-compat-temporary-file-directory)))
3943 ;; On some systems, chown runs only for root.
3944 (or (zerop (user-uid))
3945 ;; This is defined in tramp-sh.el. Let's assume this is
3946 ;; loaded already.
3947 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3949 (defun tramp-get-remote-tmpdir (vec)
3950 "Return directory for temporary files on the remote host identified by VEC."
3951 (let ((dir (tramp-make-tramp-file-name
3952 (tramp-file-name-method vec)
3953 (tramp-file-name-user vec)
3954 (tramp-file-name-host vec)
3955 (or (tramp-get-method-parameter vec 'tramp-tmpdir) "/tmp"))))
3956 (with-tramp-connection-property vec "tmpdir"
3957 (or (and (file-directory-p dir) (file-writable-p dir)
3958 (file-remote-p dir 'localname))
3959 (tramp-error vec 'file-error "Directory %s not accessible" dir)))
3960 dir))
3962 ;;;###tramp-autoload
3963 (defun tramp-make-tramp-temp-file (vec)
3964 "Create a temporary file on the remote host identified by VEC.
3965 Return the local name of the temporary file."
3966 (let ((prefix (expand-file-name
3967 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3968 result)
3969 (while (not result)
3970 ;; `make-temp-file' would be the natural choice for
3971 ;; implementation. But it calls `write-region' internally,
3972 ;; which also needs a temporary file - we would end in an
3973 ;; infinite loop.
3974 (setq result (make-temp-name prefix))
3975 (if (file-exists-p result)
3976 (setq result nil)
3977 ;; This creates the file by side effect.
3978 (set-file-times result)
3979 (set-file-modes result (string-to-number "0700" 8))))
3981 ;; Return the local part.
3982 (with-parsed-tramp-file-name result nil localname)))
3984 (defun tramp-delete-temp-file-function ()
3985 "Remove temporary files related to current buffer."
3986 (when (stringp tramp-temp-buffer-file-name)
3987 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3989 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3990 (add-hook 'tramp-unload-hook
3991 (lambda ()
3992 (remove-hook 'kill-buffer-hook
3993 'tramp-delete-temp-file-function)))
3995 (defun tramp-handle-make-auto-save-file-name ()
3996 "Like `make-auto-save-file-name' for Tramp files.
3997 Returns a file name in `tramp-auto-save-directory' for autosaving
3998 this file, if that variable is non-nil."
3999 (when (stringp tramp-auto-save-directory)
4000 (setq tramp-auto-save-directory
4001 (expand-file-name tramp-auto-save-directory)))
4002 ;; Create directory.
4003 (unless (or (null tramp-auto-save-directory)
4004 (file-exists-p tramp-auto-save-directory))
4005 (make-directory tramp-auto-save-directory t))
4007 (let ((system-type 'not-windows)
4008 (auto-save-file-name-transforms
4009 (if (null tramp-auto-save-directory)
4010 auto-save-file-name-transforms))
4011 (buffer-file-name
4012 (if (null tramp-auto-save-directory)
4013 buffer-file-name
4014 (expand-file-name
4015 (tramp-subst-strs-in-string
4016 '(("_" . "|")
4017 ("/" . "_a")
4018 (":" . "_b")
4019 ("|" . "__")
4020 ("[" . "_l")
4021 ("]" . "_r"))
4022 (buffer-file-name))
4023 tramp-auto-save-directory))))
4024 ;; Run plain `make-auto-save-file-name'.
4025 (tramp-run-real-handler 'make-auto-save-file-name nil)))
4027 (defun tramp-subst-strs-in-string (alist string)
4028 "Replace all occurrences of the string FROM with TO in STRING.
4029 ALIST is of the form ((FROM . TO) ...)."
4030 (save-match-data
4031 (while alist
4032 (let* ((pr (car alist))
4033 (from (car pr))
4034 (to (cdr pr)))
4035 (while (string-match (regexp-quote from) string)
4036 (setq string (replace-match to t t string)))
4037 (setq alist (cdr alist))))
4038 string))
4040 (defun tramp-handle-temporary-file-directory ()
4041 "Like `temporary-file-directory' for Tramp files."
4042 (catch 'result
4043 (dolist (dir `(,(ignore-errors
4044 (tramp-get-remote-tmpdir
4045 (tramp-dissect-file-name default-directory)))
4046 ,default-directory))
4047 (when (and (stringp dir) (file-directory-p dir) (file-writable-p dir))
4048 (throw 'result (expand-file-name dir))))))
4050 (defun tramp-handle-make-nearby-temp-file (prefix &optional dir-flag suffix)
4051 "Like `make-nearby-temp-file' for Tramp files."
4052 (let ((temporary-file-directory
4053 (tramp-compat-temporary-file-directory-function)))
4054 (make-temp-file prefix dir-flag suffix)))
4056 ;;; Compatibility functions section:
4058 (defun tramp-call-process
4059 (vec program &optional infile destination display &rest args)
4060 "Calls `call-process' on the local host.
4061 It always returns a return code. The Lisp error raised when
4062 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
4063 are written with verbosity of 6."
4064 (let ((default-directory (tramp-compat-temporary-file-directory))
4065 (v (or vec
4066 (vector tramp-current-method tramp-current-user
4067 tramp-current-host nil nil)))
4068 (destination (if (eq destination t) (current-buffer) destination))
4069 output error result)
4070 (tramp-message
4071 v 6 "`%s %s' %s %s"
4072 program (mapconcat 'identity args " ") infile destination)
4073 (condition-case err
4074 (with-temp-buffer
4075 (setq result
4076 (apply
4077 'call-process program infile (or destination t) display args))
4078 ;; `result' could also be an error string.
4079 (when (stringp result)
4080 (setq error result
4081 result 1))
4082 (with-current-buffer
4083 (if (bufferp destination) destination (current-buffer))
4084 (setq output (buffer-string))))
4085 (error
4086 (setq error (error-message-string err)
4087 result 1)))
4088 (if (zerop (length error))
4089 (tramp-message v 6 "%d\n%s" result output)
4090 (tramp-message v 6 "%d\n%s\n%s" result output error))
4091 result))
4093 (defun tramp-call-process-region
4094 (vec start end program &optional delete buffer display &rest args)
4095 "Calls `call-process-region' on the local host.
4096 It always returns a return code. The Lisp error raised when
4097 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
4098 are written with verbosity of 6."
4099 (let ((default-directory (tramp-compat-temporary-file-directory))
4100 (v (or vec
4101 (vector tramp-current-method tramp-current-user
4102 tramp-current-host nil nil)))
4103 (buffer (if (eq buffer t) (current-buffer) buffer))
4104 result)
4105 (tramp-message
4106 v 6 "`%s %s' %s %s %s %s"
4107 program (mapconcat 'identity args " ") start end delete buffer)
4108 (condition-case err
4109 (progn
4110 (setq result
4111 (apply
4112 'call-process-region
4113 start end program delete buffer display args))
4114 ;; `result' could also be an error string.
4115 (when (stringp result)
4116 (signal 'file-error (list result)))
4117 (with-current-buffer (if (bufferp buffer) buffer (current-buffer))
4118 (if (zerop result)
4119 (tramp-message v 6 "%d" result)
4120 (tramp-message v 6 "%d\n%s" result (buffer-string)))))
4121 (error
4122 (setq result 1)
4123 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
4124 result))
4126 ;;;###tramp-autoload
4127 (defun tramp-read-passwd (proc &optional prompt)
4128 "Read a password from user (compat function).
4129 Consults the auth-source package.
4130 Invokes `password-read' if available, `read-passwd' else."
4131 (let* ((case-fold-search t)
4132 (key (tramp-make-tramp-file-name
4133 tramp-current-method tramp-current-user
4134 tramp-current-host ""))
4135 (pw-prompt
4136 (or prompt
4137 (with-current-buffer (process-buffer proc)
4138 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
4139 (format "%s for %s " (capitalize (match-string 1)) key))))
4140 ;; We suspend the timers while reading the password.
4141 (stimers (with-timeout-suspend))
4142 auth-info auth-passwd)
4144 (unwind-protect
4145 (with-parsed-tramp-file-name key nil
4146 (prog1
4148 ;; See if auth-sources contains something useful.
4149 ;; `auth-source-user-or-password' is an obsoleted
4150 ;; function since Emacs 24.1, it has been replaced by
4151 ;; `auth-source-search'.
4152 (ignore-errors
4153 (and (tramp-get-connection-property
4154 v "first-password-request" nil)
4155 ;; Try with Tramp's current method.
4156 (if (fboundp 'auth-source-search)
4157 (setq auth-info
4158 (auth-source-search
4159 :max 1
4160 :user (or tramp-current-user t)
4161 :host tramp-current-host
4162 :port tramp-current-method
4163 :require
4164 (cons
4165 :secret (and tramp-current-user '(:user))))
4166 auth-passwd (plist-get
4167 (nth 0 auth-info) :secret)
4168 auth-passwd (if (functionp auth-passwd)
4169 (funcall auth-passwd)
4170 auth-passwd))
4171 (tramp-compat-funcall
4172 'auth-source-user-or-password
4173 "password" tramp-current-host tramp-current-method))))
4174 ;; Try the password cache.
4175 (let ((password (password-read pw-prompt key)))
4176 (password-cache-add key password)
4177 password)
4178 ;; Else, get the password interactively.
4179 (read-passwd pw-prompt))
4180 (tramp-set-connection-property v "first-password-request" nil)))
4181 ;; Reenable the timers.
4182 (with-timeout-unsuspend stimers))))
4184 ;;;###tramp-autoload
4185 (defun tramp-clear-passwd (vec)
4186 "Clear password cache for connection related to VEC."
4187 (let ((method (tramp-file-name-method vec))
4188 (user (tramp-file-name-user vec))
4189 (host (tramp-file-name-host vec))
4190 (hop (tramp-file-name-hop vec)))
4191 (when hop
4192 ;; Clear also the passwords of the hops.
4193 (tramp-clear-passwd
4194 (tramp-dissect-file-name
4195 (concat
4196 tramp-prefix-format
4197 (replace-regexp-in-string
4198 (concat tramp-postfix-hop-regexp "$")
4199 tramp-postfix-host-format hop)))))
4200 ;; `auth-source-forget-user-or-password' is an obsoleted function
4201 ;; since Emacs 24.1, it has been replaced by `auth-source-forget'.
4202 (if (fboundp 'auth-source-forget)
4203 (auth-source-forget
4204 `(:max 1 :user ,(or user t) :host ,host :port ,method))
4205 (tramp-compat-funcall
4206 'auth-source-forget-user-or-password "password" host method))
4207 (password-cache-remove (tramp-make-tramp-file-name method user host ""))))
4209 ;; Snarfed code from time-date.el and parse-time.el
4211 (defconst tramp-half-a-year '(241 17024)
4212 "Evaluated by \"(days-to-time 183)\".")
4214 (defconst tramp-parse-time-months
4215 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
4216 ("apr" . 4) ("may" . 5) ("jun" . 6)
4217 ("jul" . 7) ("aug" . 8) ("sep" . 9)
4218 ("oct" . 10) ("nov" . 11) ("dec" . 12))
4219 "Alist mapping month names to integers.")
4221 ;;;###tramp-autoload
4222 (defun tramp-time-diff (t1 t2)
4223 "Return the difference between the two times, in seconds.
4224 T1 and T2 are time values (as returned by `current-time' for example)."
4225 ;; Starting with Emacs 25.1, we could change this to use `time-subtract'.
4226 (float-time (tramp-compat-funcall 'subtract-time t1 t2)))
4228 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4229 ;; does not deal well with newline characters. Newline is replaced by
4230 ;; backslash newline. But if, say, the string `a backslash newline b'
4231 ;; is passed to a shell, the shell will expand this into "ab",
4232 ;; completely omitting the newline. This is not what was intended.
4233 ;; It does not appear to be possible to make the function
4234 ;; `shell-quote-argument' work with newlines without making it
4235 ;; dependent on the shell used. But within this package, we know that
4236 ;; we will always use a Bourne-like shell, so we use an approach which
4237 ;; groks newlines.
4239 ;; The approach is simple: we call `shell-quote-argument', then
4240 ;; massage the newline part of the result.
4242 ;; This function should produce a string which is grokked by a Unix
4243 ;; shell, even if the Emacs is running on Windows. Since this is the
4244 ;; kludges section, we bind `system-type' in such a way that
4245 ;; `shell-quote-argument' behaves as if on Unix.
4247 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4248 ;; function to work with Bourne-like shells.
4250 ;; CCC: This function should be rewritten so that
4251 ;; `shell-quote-argument' is not used. This way, we are safe from
4252 ;; changes in `shell-quote-argument'.
4253 ;;;###tramp-autoload
4254 (defun tramp-shell-quote-argument (s)
4255 "Similar to `shell-quote-argument', but groks newlines.
4256 Only works for Bourne-like shells."
4257 (let ((system-type 'not-windows))
4258 (save-match-data
4259 (let ((result (shell-quote-argument s))
4260 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
4261 (when (and (>= (length result) 2)
4262 (string= (substring result 0 2) "\\~"))
4263 (setq result (substring result 1)))
4264 (while (string-match nl result)
4265 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
4266 t t result)))
4267 result))))
4269 ;;; Integration of eshell.el:
4271 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4272 ;; when `default-directory' points to another host.
4273 (defun tramp-eshell-directory-change ()
4274 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4275 (setq eshell-path-env
4276 (if (tramp-tramp-file-p default-directory)
4277 (with-parsed-tramp-file-name default-directory nil
4278 (mapconcat
4279 'identity
4281 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4282 ;; the remote path is only set in the session cache.
4283 (tramp-get-connection-property
4284 (tramp-get-connection-process v) "remote-path" nil)
4285 (tramp-get-connection-property v "remote-path" nil))
4286 ":"))
4287 (getenv "PATH"))))
4289 (eval-after-load "esh-util"
4290 '(progn
4291 (tramp-eshell-directory-change)
4292 (add-hook 'eshell-directory-change-hook
4293 'tramp-eshell-directory-change)
4294 (add-hook 'tramp-unload-hook
4295 (lambda ()
4296 (remove-hook 'eshell-directory-change-hook
4297 'tramp-eshell-directory-change)))))
4299 ;; Checklist for `tramp-unload-hook'
4300 ;; - Unload all `tramp-*' packages
4301 ;; - Reset `file-name-handler-alist'
4302 ;; - Cleanup hooks where Tramp functions are in
4303 ;; - Cleanup advised functions
4304 ;; - Cleanup autoloads
4305 ;;;###autoload
4306 (defun tramp-unload-tramp ()
4307 "Discard Tramp from loading remote files."
4308 (interactive)
4309 ;; ange-ftp settings must be enabled.
4310 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
4311 ;; Maybe it's not loaded yet.
4312 (ignore-errors (unload-feature 'tramp 'force)))
4314 (provide 'tramp)
4316 ;;; TODO:
4318 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4319 ;; by the files in that directory. Add this here.
4321 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4323 ;; * Better error checking. At least whenever we see something
4324 ;; strange when doing zerop, we should kill the process and start
4325 ;; again. (Greg Stark)
4327 ;; * Implement a general server-local-variable mechanism, as there are
4328 ;; probably other variables that need different values for different
4329 ;; servers too. The user could then configure a variable (such as
4330 ;; tramp-server-local-variable-alist) to define any such variables
4331 ;; that they need to, which would then be let bound as appropriate
4332 ;; in tramp functions. (Jason Rumney)
4334 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4336 ;; * I was wondering if it would be possible to use tramp even if I'm
4337 ;; actually using sshfs. But when I launch a command I would like
4338 ;; to get it executed on the remote machine where the files really
4339 ;; are. (Andrea Crotti)
4341 ;; * Run emerge on two remote files. Bug is described here:
4342 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4343 ;; (Bug#6850)
4345 ;; * Use also port to distinguish connections. This is needed for
4346 ;; different hosts sitting behind a single router (distinguished by
4347 ;; different port numbers). (Tzvi Edelman)
4349 ;; * Refactor code from different handlers. Start with
4350 ;; *-process-file. One idea is to generalize `tramp-send-command'
4351 ;; and friends, for most of the handlers this is the major
4352 ;; difference between the different backends. Other handlers but
4353 ;; *-process-file would profit from this as well.
4355 ;;; tramp.el ends here
4357 ;; Local Variables:
4358 ;; mode: Emacs-Lisp
4359 ;; coding: utf-8
4360 ;; End: