Rework fixing Bug#24432
[emacs.git] / lisp / net / tramp.el
blob0dade732c4699f55c403859516a31fdc1c82a36a
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 (defconst 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 names.
876 When tramp.el is loaded, this regular expression is prepended to
877 `file-name-handler-alist', and that is searched sequentially. Thus,
878 if the Tramp entry appears rather early in the `file-name-handler-alist'
879 and is a bit too general, then some files might be considered Tramp
880 files which are not really Tramp files.
882 Please note that the entry in `file-name-handler-alist' is made when
883 this file \(tramp.el) is loaded. This means that this variable must be set
884 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
885 updated after changing this variable.
887 Also see `tramp-file-name-structure'.")
889 ;;;###autoload
890 (defconst tramp-completion-file-name-regexp-unified
891 (if (memq system-type '(cygwin windows-nt))
892 "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'")
893 "Value for `tramp-completion-file-name-regexp' for unified remoting.
894 See `tramp-file-name-structure' for more explanations.
896 On W32 systems, the volume letter must be ignored.")
898 ;;;###autoload
899 (defconst tramp-completion-file-name-regexp-separate
900 "\\`/\\([[][^]]*\\)?\\'"
901 "Value for `tramp-completion-file-name-regexp' for separate remoting.
902 See `tramp-file-name-structure' for more explanations.")
904 ;;;###autoload
905 (defconst tramp-completion-file-name-regexp
906 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
907 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
908 (t (error "Wrong `tramp-syntax' defined")))
909 "Regular expression matching file names handled by Tramp completion.
910 This regexp should match partial Tramp file names only.
912 Please note that the entry in `file-name-handler-alist' is made when
913 this file \(tramp.el) is loaded. This means that this variable must be set
914 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
915 updated after changing this variable.
917 Also see `tramp-file-name-structure'.")
919 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
920 ;; known to have a bug in `process-send-string'; some ssh connections appear
921 ;; to drop bytes when data is sent too quickly. There is also a connection
922 ;; buffer local variable, which is computed depending on remote host properties
923 ;; when `tramp-chunksize' is zero or nil.
924 (defcustom tramp-chunksize (when (memq system-type '(hpux)) 500)
925 ;; Parentheses in docstring starting at beginning of line are escaped.
926 ;; Fontification is messed up when
927 ;; `open-paren-in-column-0-is-defun-start' set to t.
928 "If non-nil, chunksize for sending input to local process.
929 It is necessary only on systems which have a buggy `process-send-string'
930 implementation. The necessity, whether this variable must be set, can be
931 checked via the following code:
933 (with-temp-buffer
934 (let* ((user \"xxx\") (host \"yyy\")
935 (init 0) (step 50)
936 (sent init) (received init))
937 (while (= sent received)
938 (setq sent (+ sent step))
939 (erase-buffer)
940 (let ((proc (start-process (buffer-name) (current-buffer)
941 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
942 (when (process-live-p proc)
943 (process-send-string proc (make-string sent ?\\ ))
944 (process-send-eof proc)
945 (process-send-eof proc))
946 (while (not (progn (goto-char (point-min))
947 (re-search-forward \"\\\\w+\" (point-max) t)))
948 (accept-process-output proc 1))
949 (when (process-live-p proc)
950 (setq received (string-to-number (match-string 0)))
951 (delete-process proc)
952 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
953 (sit-for 0))))
954 (if (> sent (+ init step))
955 (message \"You should set `tramp-chunksize' to a maximum of %s\"
956 (- sent step))
957 (message \"Test does not work\")
958 (display-buffer (current-buffer))
959 (sit-for 30))))
961 In the Emacs normally running Tramp, evaluate the above code
962 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
963 respectively). You can do this, for example, by pasting it into
964 the `*scratch*' buffer and then hitting C-j with the cursor after the
965 last closing parenthesis. Note that it works only if you have configured
966 \"ssh\" to run without password query, see ssh-agent(1).
968 You will see the number of bytes sent successfully to the remote host.
969 If that number exceeds 1000, you can stop the execution by hitting
970 C-g, because your Emacs is likely clean.
972 When it is necessary to set `tramp-chunksize', you might consider to
973 use an out-of-the-band method \(like \"scp\") instead of an internal one
974 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
975 performance.
977 If your Emacs is buggy, the code stops and gives you an indication
978 about the value `tramp-chunksize' should be set. Maybe you could just
979 experiment a bit, e.g. changing the values of `init' and `step'
980 in the third line of the code.
982 Please raise a bug report via \"M-x tramp-bug\" if your system needs
983 this variable to be set as well."
984 :group 'tramp
985 :type '(choice (const nil) integer)
986 :require 'tramp)
988 ;; Logging in to a remote host normally requires obtaining a pty. But
989 ;; Emacs on MacOS X has process-connection-type set to nil by default,
990 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
991 ;; for an override of the system default.
992 (defcustom tramp-process-connection-type t
993 "Overrides `process-connection-type' for connections from Tramp.
994 Tramp binds `process-connection-type' to the value given here before
995 opening a connection to a remote host."
996 :group 'tramp
997 :type '(choice (const nil) (const t) (const pty))
998 :require 'tramp)
1000 (defcustom tramp-connection-timeout 60
1001 "Defines the max time to wait for establishing a connection (in seconds).
1002 This can be overwritten for different connection types in `tramp-methods'.
1004 The timeout does not include the time reading a password."
1005 :group 'tramp
1006 :version "24.4"
1007 :type 'integer
1008 :require 'tramp)
1010 (defcustom tramp-connection-min-time-diff 5
1011 "Defines seconds between two consecutive connection attempts.
1012 This is necessary as self defense mechanism, in order to avoid
1013 yo-yo connection attempts when the remote host is unavailable.
1015 A value of 0 or nil suppresses this check. This might be
1016 necessary, when several out-of-order copy operations are
1017 performed, or when several asynchronous processes will be started
1018 in a short time frame. In those cases it is recommended to
1019 let-bind this variable."
1020 :group 'tramp
1021 :version "24.4"
1022 :type '(choice (const nil) integer)
1023 :require 'tramp)
1025 (defcustom tramp-completion-reread-directory-timeout 10
1026 "Defines seconds since last remote command before rereading a directory.
1027 A remote directory might have changed its contents. In order to
1028 make it visible during file name completion in the minibuffer,
1029 Tramp flushes its cache and rereads the directory contents when
1030 more than `tramp-completion-reread-directory-timeout' seconds
1031 have been gone since last remote command execution. A value of t
1032 would require an immediate reread during filename completion, nil
1033 means to use always cached values for the directory contents."
1034 :group 'tramp
1035 :type '(choice (const nil) (const t) integer)
1036 :require 'tramp)
1038 ;;; Internal Variables:
1040 (defvar tramp-current-method nil
1041 "Connection method for this *tramp* buffer.")
1043 (defvar tramp-current-user nil
1044 "Remote login name for this *tramp* buffer.")
1046 (defvar tramp-current-host nil
1047 "Remote host for this *tramp* buffer.")
1049 (defvar tramp-current-connection nil
1050 "Last connection timestamp.")
1052 (defconst tramp-completion-file-name-handler-alist
1053 '((expand-file-name . tramp-completion-handle-expand-file-name)
1054 (file-name-all-completions
1055 . tramp-completion-handle-file-name-all-completions)
1056 (file-name-completion . tramp-completion-handle-file-name-completion))
1057 "Alist of completion handler functions.
1058 Used for file names matching `tramp-file-name-regexp'. Operations
1059 not mentioned here will be handled by Tramp's file name handler
1060 functions, or the normal Emacs functions.")
1062 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1063 ;;;###tramp-autoload
1064 (defvar tramp-foreign-file-name-handler-alist nil
1065 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1066 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1067 calling HANDLER.")
1069 ;;; Internal functions which must come first:
1071 ;; `user-error' has appeared in Emacs 24.3.
1072 (defsubst tramp-user-error (vec-or-proc format &rest args)
1073 "Signal a pilot error."
1074 (apply
1075 'tramp-error vec-or-proc
1076 (if (fboundp 'user-error) 'user-error 'error) format args))
1078 ;; Conversion functions between external representation and
1079 ;; internal data structure. Convenience functions for internal
1080 ;; data structure.
1082 (defun tramp-get-method-parameter (vec param)
1083 "Return the method parameter PARAM.
1084 If VEC is a vector, check first in connection properties.
1085 Afterwards, check in `tramp-methods'. If the `tramp-methods'
1086 entry does not exist, return nil."
1087 (let ((hash-entry
1088 (replace-regexp-in-string "^tramp-" "" (symbol-name param))))
1089 (if (tramp-connection-property-p vec hash-entry)
1090 ;; We use the cached property.
1091 (tramp-get-connection-property vec hash-entry nil)
1092 ;; Use the static value from `tramp-methods'.
1093 (let ((methods-entry
1094 (assoc param (assoc (tramp-file-name-method vec) tramp-methods))))
1095 (when methods-entry (cadr methods-entry))))))
1097 (defun tramp-file-name-p (vec)
1098 "Check, whether VEC is a Tramp object."
1099 (and (vectorp vec) (= 5 (length vec))))
1101 (defun tramp-file-name-method (vec)
1102 "Return method component of VEC."
1103 (and (tramp-file-name-p vec) (aref vec 0)))
1105 (defun tramp-file-name-user (vec)
1106 "Return user component of VEC."
1107 (and (tramp-file-name-p vec) (aref vec 1)))
1109 (defun tramp-file-name-host (vec)
1110 "Return host component of VEC."
1111 (and (tramp-file-name-p vec) (aref vec 2)))
1113 (defun tramp-file-name-localname (vec)
1114 "Return localname component of VEC."
1115 (and (tramp-file-name-p vec) (aref vec 3)))
1117 (defun tramp-file-name-hop (vec)
1118 "Return hop component of VEC."
1119 (and (tramp-file-name-p vec) (aref vec 4)))
1121 ;; The user part of a Tramp file name vector can be of kind
1122 ;; "user%domain". Sometimes, we must extract these parts.
1123 (defun tramp-file-name-real-user (vec)
1124 "Return the user name of VEC without domain."
1125 (save-match-data
1126 (let ((user (tramp-file-name-user vec)))
1127 (if (and (stringp user)
1128 (string-match tramp-user-with-domain-regexp user))
1129 (match-string 1 user)
1130 user))))
1132 (defun tramp-file-name-domain (vec)
1133 "Return the domain name of VEC."
1134 (save-match-data
1135 (let ((user (tramp-file-name-user vec)))
1136 (and (stringp user)
1137 (string-match tramp-user-with-domain-regexp user)
1138 (match-string 2 user)))))
1140 ;; The host part of a Tramp file name vector can be of kind
1141 ;; "host#port". Sometimes, we must extract these parts.
1142 (defun tramp-file-name-real-host (vec)
1143 "Return the host name of VEC without port."
1144 (save-match-data
1145 (let ((host (tramp-file-name-host vec)))
1146 (if (and (stringp host)
1147 (string-match tramp-host-with-port-regexp host))
1148 (match-string 1 host)
1149 host))))
1151 (defun tramp-file-name-port (vec)
1152 "Return the port number of VEC."
1153 (save-match-data
1154 (let ((method (tramp-file-name-method vec))
1155 (host (tramp-file-name-host vec)))
1156 (or (and (stringp host)
1157 (string-match tramp-host-with-port-regexp host)
1158 (string-to-number (match-string 2 host)))
1159 (tramp-get-method-parameter vec 'tramp-default-port)))))
1161 ;;;###tramp-autoload
1162 (defun tramp-tramp-file-p (name)
1163 "Return t if NAME is a string with Tramp file name syntax."
1164 (save-match-data
1165 (and (stringp name)
1166 (string-match tramp-file-name-regexp name))))
1168 (defun tramp-find-method (method user host)
1169 "Return the right method string to use.
1170 This is METHOD, if non-nil. Otherwise, do a lookup in
1171 `tramp-default-method-alist'."
1172 (let ((result
1173 (or method
1174 (let ((choices tramp-default-method-alist)
1175 lmethod item)
1176 (while choices
1177 (setq item (pop choices))
1178 (when (and (string-match (or (nth 0 item) "") (or host ""))
1179 (string-match (or (nth 1 item) "") (or user "")))
1180 (setq lmethod (nth 2 item))
1181 (setq choices nil)))
1182 lmethod)
1183 tramp-default-method)))
1184 ;; We must mark, whether a default value has been used.
1185 (if (or method (null result))
1186 result
1187 (propertize result 'tramp-default t))))
1189 (defun tramp-find-user (method user host)
1190 "Return the right user string to use.
1191 This is USER, if non-nil. Otherwise, do a lookup in
1192 `tramp-default-user-alist'."
1193 (let ((result
1194 (or user
1195 (let ((choices tramp-default-user-alist)
1196 luser item)
1197 (while choices
1198 (setq item (pop choices))
1199 (when (and (string-match (or (nth 0 item) "") (or method ""))
1200 (string-match (or (nth 1 item) "") (or host "")))
1201 (setq luser (nth 2 item))
1202 (setq choices nil)))
1203 luser)
1204 tramp-default-user)))
1205 ;; We must mark, whether a default value has been used.
1206 (if (or user (null result))
1207 result
1208 (propertize result 'tramp-default t))))
1210 (defun tramp-find-host (method user host)
1211 "Return the right host string to use.
1212 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
1213 (or (and (> (length host) 0) host)
1214 (let ((choices tramp-default-host-alist)
1215 lhost item)
1216 (while choices
1217 (setq item (pop choices))
1218 (when (and (string-match (or (nth 0 item) "") (or method ""))
1219 (string-match (or (nth 1 item) "") (or user "")))
1220 (setq lhost (nth 2 item))
1221 (setq choices nil)))
1222 lhost)
1223 tramp-default-host))
1225 (defun tramp-check-proper-method-and-host (vec)
1226 "Check method and host name of VEC."
1227 (let ((method (tramp-file-name-method vec))
1228 (user (tramp-file-name-user vec))
1229 (host (tramp-file-name-host vec))
1230 (methods (mapcar 'car tramp-methods)))
1231 (when (and method (not (member method methods)))
1232 (tramp-cleanup-connection vec)
1233 (tramp-user-error vec "Unknown method \"%s\"" method))
1234 (when (and (equal tramp-syntax 'ftp) host
1235 (or (null method) (get-text-property 0 'tramp-default method))
1236 (or (null user) (get-text-property 0 'tramp-default user))
1237 (member host methods))
1238 (tramp-cleanup-connection vec)
1239 (tramp-user-error vec "Host name must not match method \"%s\"" host))))
1241 (defun tramp-dissect-file-name (name &optional nodefault)
1242 "Return a `tramp-file-name' structure.
1243 The structure consists of remote method, remote user, remote host,
1244 localname (file name on remote host) and hop. If NODEFAULT is
1245 non-nil, the file name parts are not expanded to their default
1246 values."
1247 (save-match-data
1248 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
1249 (unless match (tramp-user-error nil "Not a Tramp file name: \"%s\"" name))
1250 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
1251 (user (match-string (nth 2 tramp-file-name-structure) name))
1252 (host (match-string (nth 3 tramp-file-name-structure) name))
1253 (localname (match-string (nth 4 tramp-file-name-structure) name))
1254 (hop (match-string (nth 5 tramp-file-name-structure) name)))
1255 (when host
1256 (when (string-match tramp-prefix-ipv6-regexp host)
1257 (setq host (replace-match "" nil t host)))
1258 (when (string-match tramp-postfix-ipv6-regexp host)
1259 (setq host (replace-match "" nil t host))))
1260 (if nodefault
1261 (vector method user host localname hop)
1262 (vector
1263 (tramp-find-method method user host)
1264 (tramp-find-user method user host)
1265 (tramp-find-host method user host)
1266 localname hop))))))
1268 (defun tramp-buffer-name (vec)
1269 "A name for the connection buffer VEC."
1270 ;; We must use `tramp-file-name-real-host', because for gateway
1271 ;; methods the default port will be expanded later on, which would
1272 ;; tamper the name.
1273 (let ((method (tramp-file-name-method vec))
1274 (user (tramp-file-name-user vec))
1275 (host (tramp-file-name-real-host vec)))
1276 (if (not (zerop (length user)))
1277 (format "*tramp/%s %s@%s*" method user host)
1278 (format "*tramp/%s %s*" method host))))
1280 (defun tramp-make-tramp-file-name (method user host localname &optional hop)
1281 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1282 When not nil, an optional HOP is prepended."
1283 (concat tramp-prefix-format hop
1284 (when (not (zerop (length method)))
1285 (concat method tramp-postfix-method-format))
1286 (when (not (zerop (length user)))
1287 (concat user tramp-postfix-user-format))
1288 (when host
1289 (if (string-match tramp-ipv6-regexp host)
1290 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1291 host))
1292 tramp-postfix-host-format
1293 (when localname localname)))
1295 (defun tramp-completion-make-tramp-file-name (method user host localname)
1296 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
1297 It must not be a complete Tramp file name, but as long as there are
1298 necessary only. This function will be used in file name completion."
1299 (concat tramp-prefix-format
1300 (when (not (zerop (length method)))
1301 (concat method tramp-postfix-method-format))
1302 (when (not (zerop (length user)))
1303 (concat user tramp-postfix-user-format))
1304 (when (not (zerop (length host)))
1305 (concat
1306 (if (string-match tramp-ipv6-regexp host)
1307 (concat
1308 tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
1309 host)
1310 tramp-postfix-host-format))
1311 (when localname localname)))
1313 (defun tramp-get-buffer (vec)
1314 "Get the connection buffer to be used for VEC."
1315 (or (get-buffer (tramp-buffer-name vec))
1316 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
1317 (tramp-set-connection-property vec "process-buffer" nil)
1318 (setq buffer-undo-list t)
1319 (setq default-directory
1320 (tramp-make-tramp-file-name
1321 (tramp-file-name-method vec)
1322 (tramp-file-name-user vec)
1323 (tramp-file-name-host vec)
1324 "/"))
1325 (current-buffer))))
1327 (defun tramp-get-connection-buffer (vec)
1328 "Get the connection buffer to be used for VEC.
1329 In case a second asynchronous communication has been started, it is different
1330 from `tramp-get-buffer'."
1331 (or (tramp-get-connection-property vec "process-buffer" nil)
1332 (tramp-get-buffer vec)))
1334 (defun tramp-get-connection-name (vec)
1335 "Get the connection name to be used for VEC.
1336 In case a second asynchronous communication has been started, it is different
1337 from the default one."
1338 (or (tramp-get-connection-property vec "process-name" nil)
1339 (tramp-buffer-name vec)))
1341 (defun tramp-get-connection-process (vec)
1342 "Get the connection process to be used for VEC.
1343 In case a second asynchronous communication has been started, it is different
1344 from the default one."
1345 (get-process (tramp-get-connection-name vec)))
1347 (defun tramp-debug-buffer-name (vec)
1348 "A name for the debug buffer for VEC."
1349 ;; We must use `tramp-file-name-real-host', because for gateway
1350 ;; methods the default port will be expanded later on, which would
1351 ;; tamper the name.
1352 (let ((method (tramp-file-name-method vec))
1353 (user (tramp-file-name-user vec))
1354 (host (tramp-file-name-real-host vec)))
1355 (if (not (zerop (length user)))
1356 (format "*debug tramp/%s %s@%s*" method user host)
1357 (format "*debug tramp/%s %s*" method host))))
1359 (defconst tramp-debug-outline-regexp
1360 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #"
1361 "Used for highlighting Tramp debug buffers in `outline-mode'.")
1363 (defun tramp-debug-outline-level ()
1364 "Return the depth to which a statement is nested in the outline.
1365 Point must be at the beginning of a header line.
1367 The outline level is equal to the verbosity of the Tramp message."
1368 (1+ (string-to-number (match-string 1))))
1370 (defun tramp-get-debug-buffer (vec)
1371 "Get the debug buffer for VEC."
1372 (with-current-buffer
1373 (get-buffer-create (tramp-debug-buffer-name vec))
1374 (when (bobp)
1375 (setq buffer-undo-list t)
1376 ;; So it does not get loaded while `outline-regexp' is let-bound.
1377 (require 'outline)
1378 ;; Activate `outline-mode'. This runs `text-mode-hook' and
1379 ;; `outline-mode-hook'. We must prevent that local processes
1380 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell".
1381 ;; Furthermore, `outline-regexp' must have the correct value
1382 ;; already, because it is used by `font-lock-compile-keywords'.
1383 (let ((default-directory (tramp-compat-temporary-file-directory))
1384 (outline-regexp tramp-debug-outline-regexp))
1385 (outline-mode))
1386 (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp)
1387 (set (make-local-variable 'outline-level) 'tramp-debug-outline-level))
1388 (current-buffer)))
1390 (defsubst tramp-debug-message (vec fmt-string &rest arguments)
1391 "Append message to debug buffer.
1392 Message is formatted with FMT-STRING as control string and the remaining
1393 ARGUMENTS to actually emit the message (if applicable)."
1394 (with-current-buffer (tramp-get-debug-buffer vec)
1395 (goto-char (point-max))
1396 ;; Headline.
1397 (when (bobp)
1398 (insert
1399 (format
1400 ";; Emacs: %s Tramp: %s -*- mode: outline; -*-"
1401 emacs-version tramp-version))
1402 (when (>= tramp-verbose 10)
1403 (insert
1404 (format
1405 "\n;; Location: %s Git: %s"
1406 (locate-library "tramp") (tramp-repository-get-version)))))
1407 (unless (bolp)
1408 (insert "\n"))
1409 ;; Timestamp.
1410 (let ((now (current-time)))
1411 (insert (format-time-string "%T." now))
1412 (insert (format "%06d " (nth 2 now))))
1413 ;; Calling Tramp function. We suppress compat and trace functions
1414 ;; from being displayed.
1415 (let ((btn 1) btf fn)
1416 (while (not fn)
1417 (setq btf (nth 1 (backtrace-frame btn)))
1418 (if (not btf)
1419 (setq fn "")
1420 (when (symbolp btf)
1421 (setq fn (symbol-name btf))
1422 (unless
1423 (and
1424 (string-match "^tramp" fn)
1425 (not
1426 (string-match
1427 (concat
1429 (regexp-opt
1430 '("tramp-backtrace"
1431 "tramp-compat-condition-case-unless-debug"
1432 "tramp-compat-funcall"
1433 "tramp-condition-case-unless-debug"
1434 "tramp-debug-message"
1435 "tramp-error"
1436 "tramp-error-with-buffer"
1437 "tramp-message"
1438 "tramp-user-error")
1440 "$")
1441 fn)))
1442 (setq fn nil)))
1443 (setq btn (1+ btn))))
1444 ;; The following code inserts filename and line number. Should
1445 ;; be inactive by default, because it is time consuming.
1446 ; (let ((ffn (find-function-noselect (intern fn))))
1447 ; (insert
1448 ; (format
1449 ; "%s:%d: "
1450 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1451 ; (with-current-buffer (car ffn)
1452 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1453 (insert (format "%s " fn)))
1454 ;; The message.
1455 (insert (apply #'format-message fmt-string arguments))))
1457 (defvar tramp-message-show-message t
1458 "Show Tramp message in the minibuffer.
1459 This variable is used to disable messages from `tramp-error'.
1460 The messages are visible anyway, because an error is raised.")
1462 (defsubst tramp-message (vec-or-proc level fmt-string &rest arguments)
1463 "Emit a message depending on verbosity level.
1464 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1465 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1466 less than LEVEL. The message is emitted only if `tramp-verbose' is
1467 greater than or equal to LEVEL.
1469 The message is also logged into the debug buffer when `tramp-verbose'
1470 is greater than or equal 4.
1472 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1473 control string and the remaining ARGUMENTS to actually emit the message (if
1474 applicable)."
1475 (ignore-errors
1476 (when (<= level tramp-verbose)
1477 ;; Match data must be preserved!
1478 (save-match-data
1479 ;; Display only when there is a minimum level.
1480 (when (and tramp-message-show-message (<= level 3))
1481 (apply 'message
1482 (concat
1483 (cond
1484 ((= level 0) "")
1485 ((= level 1) "")
1486 ((= level 2) "Warning: ")
1487 (t "Tramp: "))
1488 fmt-string)
1489 arguments))
1490 ;; Log only when there is a minimum level.
1491 (when (>= tramp-verbose 4)
1492 ;; Translate proc to vec.
1493 (when (processp vec-or-proc)
1494 (let ((tramp-verbose 0))
1495 (setq vec-or-proc
1496 (tramp-get-connection-property vec-or-proc "vector" nil))))
1497 ;; Append connection buffer for error messages.
1498 (when (= level 1)
1499 (let ((tramp-verbose 0))
1500 (with-current-buffer (tramp-get-connection-buffer vec-or-proc)
1501 (setq fmt-string (concat fmt-string "\n%s")
1502 arguments (append arguments (list (buffer-string)))))))
1503 ;; Do it.
1504 (when (vectorp vec-or-proc)
1505 (apply 'tramp-debug-message
1506 vec-or-proc
1507 (concat (format "(%d) # " level) fmt-string)
1508 arguments)))))))
1510 (defsubst tramp-backtrace (&optional vec-or-proc)
1511 "Dump a backtrace into the debug buffer.
1512 If VEC-OR-PROC is nil, the buffer *debug tramp* is used. This
1513 function is meant for debugging purposes."
1514 (if vec-or-proc
1515 (tramp-message vec-or-proc 10 "\n%s" (with-output-to-string (backtrace)))
1516 (if (>= tramp-verbose 10)
1517 (with-output-to-temp-buffer "*debug tramp*" (backtrace)))))
1519 (defsubst tramp-error (vec-or-proc signal fmt-string &rest arguments)
1520 "Emit an error.
1521 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1522 signal identifier to be raised, remaining arguments passed to
1523 `tramp-message'. Finally, signal SIGNAL is raised."
1524 (let (tramp-message-show-message)
1525 (tramp-backtrace vec-or-proc)
1526 (when vec-or-proc
1527 (tramp-message
1528 vec-or-proc 1 "%s"
1529 (error-message-string
1530 (list signal
1531 (get signal 'error-message)
1532 (apply #'format-message fmt-string arguments)))))
1533 (signal signal (list (apply #'format-message fmt-string arguments)))))
1535 (defsubst tramp-error-with-buffer
1536 (buf vec-or-proc signal fmt-string &rest arguments)
1537 "Emit an error, and show BUF.
1538 If BUF is nil, show the connection buf. Wait for 30\", or until
1539 an input event arrives. The other arguments are passed to `tramp-error'."
1540 (save-window-excursion
1541 (let* ((buf (or (and (bufferp buf) buf)
1542 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1543 (and (vectorp vec-or-proc)
1544 (tramp-get-connection-buffer vec-or-proc))))
1545 (vec (or (and (vectorp vec-or-proc) vec-or-proc)
1546 (and buf (with-current-buffer buf
1547 (tramp-dissect-file-name default-directory))))))
1548 (unwind-protect
1549 (apply 'tramp-error vec-or-proc signal fmt-string arguments)
1550 ;; Save exit.
1551 (when (and buf
1552 tramp-message-show-message
1553 (not (zerop tramp-verbose))
1554 (not (tramp-completion-mode-p))
1555 ;; Show only when Emacs has started already.
1556 (current-message))
1557 (let ((enable-recursive-minibuffers t))
1558 ;; `tramp-error' does not show messages. So we must do it
1559 ;; ourselves.
1560 (apply 'message fmt-string arguments)
1561 ;; Show buffer.
1562 (pop-to-buffer buf)
1563 (discard-input)
1564 (sit-for 30)))
1565 ;; Reset timestamp. It would be wrong after waiting for a while.
1566 (when (equal (butlast (append vec nil) 2)
1567 (car tramp-current-connection))
1568 (setcdr tramp-current-connection (current-time)))))))
1570 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1571 "Parse a Tramp filename and make components available in the body.
1573 First arg FILENAME is evaluated and dissected into its components.
1574 Second arg VAR is a symbol. It is used as a variable name to hold
1575 the filename structure. It is also used as a prefix for the variables
1576 holding the components. For example, if VAR is the symbol `foo', then
1577 `foo' will be bound to the whole structure, `foo-method' will be bound to
1578 the method component, and so on for `foo-user', `foo-host', `foo-localname',
1579 `foo-hop'.
1581 Remaining args are Lisp expressions to be evaluated (inside an implicit
1582 `progn').
1584 If VAR is nil, then we bind `v' to the structure and `method', `user',
1585 `host', `localname', `hop' to the components."
1586 (let ((bindings
1587 (mapcar (lambda (elem)
1588 `(,(if var (intern (format "%s-%s" var elem)) elem)
1589 (,(intern (format "tramp-file-name-%s" elem))
1590 ,(or var 'v))))
1591 '(method user host localname hop))))
1592 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1593 ,@bindings)
1594 ;; We don't know which of those vars will be used, so we bind them all,
1595 ;; and then add here a dummy use of all those variables, so we don't get
1596 ;; flooded by warnings about those vars `body' didn't use.
1597 (ignore ,@(mapcar #'car bindings))
1598 ,@body)))
1600 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1601 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1602 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1604 (defun tramp-progress-reporter-update (reporter &optional value)
1605 "Report progress of an operation for Tramp."
1606 (let* ((parameters (cdr reporter))
1607 (message (aref parameters 3)))
1608 (when (string-match message (or (current-message) ""))
1609 (progress-reporter-update reporter value))))
1611 (defmacro with-tramp-progress-reporter (vec level message &rest body)
1612 "Executes BODY, spinning a progress reporter with MESSAGE.
1613 If LEVEL does not fit for visible messages, there are only traces
1614 without a visible progress reporter."
1615 (declare (indent 3) (debug t))
1616 `(progn
1617 (tramp-message ,vec ,level "%s..." ,message)
1618 (let ((cookie "failed")
1620 ;; We start a pulsing progress reporter after 3 seconds. Feature
1621 ;; introduced in Emacs 24.1.
1622 (when (and tramp-message-show-message
1623 ;; Display only when there is a minimum level.
1624 (<= ,level (min tramp-verbose 3)))
1625 (ignore-errors
1626 (let ((pr (make-progress-reporter ,message nil nil)))
1627 (when pr
1628 (run-at-time
1629 3 0.1 #'tramp-progress-reporter-update pr)))))))
1630 (unwind-protect
1631 ;; Execute the body.
1632 (prog1 (progn ,@body) (setq cookie "done"))
1633 ;; Stop progress reporter.
1634 (if tm (cancel-timer tm))
1635 (tramp-message ,vec ,level "%s...%s" ,message cookie)))))
1637 (font-lock-add-keywords
1638 'emacs-lisp-mode '("\\<with-tramp-progress-reporter\\>"))
1640 (defmacro with-tramp-file-property (vec file property &rest body)
1641 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1642 FILE must be a local file name on a connection identified via VEC."
1643 `(if (file-name-absolute-p ,file)
1644 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1645 (when (eq value 'undef)
1646 ;; We cannot pass @body as parameter to
1647 ;; `tramp-set-file-property' because it mangles our
1648 ;; debug messages.
1649 (setq value (progn ,@body))
1650 (tramp-set-file-property ,vec ,file ,property value))
1651 value)
1652 ,@body))
1654 (put 'with-tramp-file-property 'lisp-indent-function 3)
1655 (put 'with-tramp-file-property 'edebug-form-spec t)
1656 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-tramp-file-property\\>"))
1658 (defmacro with-tramp-connection-property (key property &rest body)
1659 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
1660 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1661 (when (eq value 'undef)
1662 ;; We cannot pass ,@body as parameter to
1663 ;; `tramp-set-connection-property' because it mangles our debug
1664 ;; messages.
1665 (setq value (progn ,@body))
1666 (tramp-set-connection-property ,key ,property value))
1667 value))
1669 (put 'with-tramp-connection-property 'lisp-indent-function 2)
1670 (put 'with-tramp-connection-property 'edebug-form-spec t)
1671 (font-lock-add-keywords
1672 'emacs-lisp-mode '("\\<with-tramp-connection-property\\>"))
1674 (defun tramp-drop-volume-letter (name)
1675 "Cut off unnecessary drive letter from file NAME.
1676 The functions `tramp-*-handle-expand-file-name' call `expand-file-name'
1677 locally on a remote file name. When the local system is a W32 system
1678 but the remote system is Unix, this introduces a superfluous drive
1679 letter into the file name. This function removes it."
1680 (save-match-data
1681 (if (string-match "\\`[a-zA-Z]:/" name)
1682 (replace-match "/" nil t name)
1683 name)))
1685 ;;; Config Manipulation Functions:
1687 ;;;###tramp-autoload
1688 (defun tramp-set-completion-function (method function-list)
1689 "Sets the list of completion functions for METHOD.
1690 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
1691 The FUNCTION is intended to parse FILE according its syntax.
1692 It might be a predefined FUNCTION, or a user defined FUNCTION.
1693 For the list of predefined FUNCTIONs see `tramp-completion-function-alist'.
1695 Example:
1697 (tramp-set-completion-function
1698 \"ssh\"
1699 \\='((tramp-parse-sconfig \"/etc/ssh_config\")
1700 (tramp-parse-sconfig \"~/.ssh/config\")))"
1702 (let ((r function-list)
1703 (v function-list))
1704 (setq tramp-completion-function-alist
1705 (delete (assoc method tramp-completion-function-alist)
1706 tramp-completion-function-alist))
1708 (while v
1709 ;; Remove double entries.
1710 (when (member (car v) (cdr v))
1711 (setcdr v (delete (car v) (cdr v))))
1712 ;; Check for function and file or registry key.
1713 (unless (and (functionp (nth 0 (car v)))
1714 (cond
1715 ;; Windows registry.
1716 ((string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
1717 (and (memq system-type '(cygwin windows-nt))
1718 (zerop
1719 (tramp-call-process
1720 v "reg" nil nil nil "query" (nth 1 (car v))))))
1721 ;; Zeroconf service type.
1722 ((string-match
1723 "^_[[:alpha:]]+\\._[[:alpha:]]+$" (nth 1 (car v))))
1724 ;; Configuration file.
1725 (t (file-exists-p (nth 1 (car v))))))
1726 (setq r (delete (car v) r)))
1727 (setq v (cdr v)))
1729 (when r
1730 (add-to-list 'tramp-completion-function-alist
1731 (cons method r)))))
1733 (defun tramp-get-completion-function (method)
1734 "Returns a list of completion functions for METHOD.
1735 For definition of that list see `tramp-set-completion-function'."
1736 (append
1737 `(;; Default settings are taken into account.
1738 (tramp-parse-default-user-host ,method)
1739 ;; Hosts visited once shall be remembered.
1740 (tramp-parse-connection-properties ,method))
1741 ;; The method related defaults.
1742 (cdr (assoc method tramp-completion-function-alist))))
1745 ;;; Fontification of `read-file-name':
1747 (defvar tramp-rfn-eshadow-overlay)
1748 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
1750 (defun tramp-rfn-eshadow-setup-minibuffer ()
1751 "Set up a minibuffer for `file-name-shadow-mode'.
1752 Adds another overlay hiding filename parts according to Tramp's
1753 special handling of `substitute-in-file-name'."
1754 (when (symbol-value 'minibuffer-completing-file-name)
1755 (setq tramp-rfn-eshadow-overlay
1756 (make-overlay (minibuffer-prompt-end) (minibuffer-prompt-end)))
1757 ;; Copy rfn-eshadow-overlay properties.
1758 (let ((props (overlay-properties (symbol-value 'rfn-eshadow-overlay))))
1759 (while props
1760 ;; The `field' property prevents correct minibuffer
1761 ;; completion; we exclude it.
1762 (if (not (eq (car props) 'field))
1763 (overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props))
1764 (pop props) (pop props))))))
1766 (add-hook 'rfn-eshadow-setup-minibuffer-hook
1767 'tramp-rfn-eshadow-setup-minibuffer)
1768 (add-hook 'tramp-unload-hook
1769 (lambda ()
1770 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
1771 'tramp-rfn-eshadow-setup-minibuffer)))
1773 (defconst tramp-rfn-eshadow-update-overlay-regexp
1774 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
1776 (defun tramp-rfn-eshadow-update-overlay ()
1777 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
1778 This is intended to be used as a minibuffer `post-command-hook' for
1779 `file-name-shadow-mode'; the minibuffer should have already
1780 been set up by `rfn-eshadow-setup-minibuffer'."
1781 ;; In remote files name, there is a shadowing just for the local part.
1782 (ignore-errors
1783 (let ((end (or (overlay-end (symbol-value 'rfn-eshadow-overlay))
1784 (minibuffer-prompt-end)))
1785 ;; We do not want to send any remote command.
1786 (non-essential t))
1787 (when
1788 (tramp-tramp-file-p
1789 (buffer-substring-no-properties end (point-max)))
1790 (save-excursion
1791 (save-restriction
1792 (narrow-to-region
1793 (1+ (or (string-match
1794 tramp-rfn-eshadow-update-overlay-regexp
1795 (buffer-string) end)
1796 end))
1797 (point-max))
1798 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
1799 (rfn-eshadow-update-overlay-hook nil)
1800 file-name-handler-alist)
1801 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
1802 (rfn-eshadow-update-overlay))))))))
1804 (add-hook 'rfn-eshadow-update-overlay-hook
1805 'tramp-rfn-eshadow-update-overlay)
1806 (add-hook 'tramp-unload-hook
1807 (lambda ()
1808 (remove-hook 'rfn-eshadow-update-overlay-hook
1809 'tramp-rfn-eshadow-update-overlay)))
1811 ;; Inodes don't exist for some file systems. Therefore we must
1812 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
1813 ;; applied might be not so efficient (Ange-FTP uses hashes). But
1814 ;; performance isn't the major issue given that file transfer will
1815 ;; take time.
1816 (defvar tramp-inodes 0
1817 "Keeps virtual inodes numbers.")
1819 ;; Devices must distinguish physical file systems. The device numbers
1820 ;; provided by "lstat" aren't unique, because we operate on different hosts.
1821 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
1822 ;; EFS use device number "-1". In order to be different, we use device number
1823 ;; (-1 . x), whereby "x" is unique for a given (method user host).
1824 (defvar tramp-devices 0
1825 "Keeps virtual device numbers.")
1827 (defun tramp-default-file-modes (filename)
1828 "Return file modes of FILENAME as integer.
1829 If the file modes of FILENAME cannot be determined, return the
1830 value of `default-file-modes', without execute permissions."
1831 (or (file-modes filename)
1832 (logand (default-file-modes) (string-to-number "0666" 8))))
1834 (defun tramp-replace-environment-variables (filename)
1835 "Replace environment variables in FILENAME.
1836 Return the string with the replaced variables."
1837 (or (ignore-errors
1838 ;; Optional arg has been introduced with Emacs 24 (?).
1839 (tramp-compat-funcall 'substitute-env-vars filename 'only-defined))
1840 ;; We need an own implementation.
1841 (save-match-data
1842 (let ((idx (string-match "$\\(\\w+\\)" filename)))
1843 ;; `$' is coded as `$$'.
1844 (when (and idx
1845 (or (zerop idx) (not (eq ?$ (aref filename (1- idx)))))
1846 (getenv (match-string 1 filename)))
1847 (setq filename
1848 (replace-match
1849 (substitute-in-file-name (match-string 0 filename))
1850 t nil filename)))
1851 filename))))
1853 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
1854 "Like `find-operation-coding-system' for Tramp filenames.
1855 Tramp's `insert-file-contents' and `write-region' work over
1856 temporary file names. If `file-coding-system-alist' contains an
1857 expression, which matches more than the file name suffix, the
1858 coding system might not be determined. This function repairs it."
1859 (let (result)
1860 (dolist (elt file-coding-system-alist result)
1861 (when (and (consp elt) (string-match (car elt) filename))
1862 ;; We found a matching entry in `file-coding-system-alist'.
1863 ;; So we add a similar entry, but with the temporary file name
1864 ;; as regexp.
1865 (add-to-list
1866 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
1868 (defun tramp-run-real-handler (operation args)
1869 "Invoke normal file name handler for OPERATION.
1870 First arg specifies the OPERATION, second arg is a list of arguments to
1871 pass to the OPERATION."
1872 (let* ((inhibit-file-name-handlers
1873 `(tramp-file-name-handler
1874 tramp-vc-file-name-handler
1875 tramp-completion-file-name-handler
1876 cygwin-mount-name-hook-function
1877 cygwin-mount-map-drive-hook-function
1879 ,(and (eq inhibit-file-name-operation operation)
1880 inhibit-file-name-handlers)))
1881 (inhibit-file-name-operation operation))
1882 (apply operation args)))
1884 ;;;###autoload
1885 (progn (defun tramp-completion-run-real-handler (operation args)
1886 "Invoke `tramp-file-name-handler' for OPERATION.
1887 First arg specifies the OPERATION, second arg is a list of arguments to
1888 pass to the OPERATION."
1889 (let* ((inhibit-file-name-handlers
1890 `(tramp-completion-file-name-handler
1891 cygwin-mount-name-hook-function
1892 cygwin-mount-map-drive-hook-function
1894 ,(and (eq inhibit-file-name-operation operation)
1895 inhibit-file-name-handlers)))
1896 (inhibit-file-name-operation operation))
1897 (apply operation args))))
1899 ;; We handle here all file primitives. Most of them have the file
1900 ;; name as first parameter; nevertheless we check for them explicitly
1901 ;; in order to be signaled if a new primitive appears. This
1902 ;; scenario is needed because there isn't a way to decide by
1903 ;; syntactical means whether a foreign method must be called. It would
1904 ;; ease the life if `file-name-handler-alist' would support a decision
1905 ;; function as well but regexp only.
1906 (defun tramp-file-name-for-operation (operation &rest args)
1907 "Return file name related to OPERATION file primitive.
1908 ARGS are the arguments OPERATION has been called with."
1909 (cond
1910 ;; FILE resp DIRECTORY.
1911 ((member operation
1912 '(access-file byte-compiler-base-file-name delete-directory
1913 delete-file diff-latest-backup-file directory-file-name
1914 directory-files directory-files-and-attributes
1915 dired-compress-file dired-uncache
1916 file-accessible-directory-p file-attributes
1917 file-directory-p file-executable-p file-exists-p
1918 file-local-copy file-modes
1919 file-name-as-directory file-name-directory
1920 file-name-nondirectory file-name-sans-versions
1921 file-ownership-preserved-p file-readable-p
1922 file-regular-p file-remote-p file-symlink-p file-truename
1923 file-writable-p find-backup-file-name find-file-noselect
1924 get-file-buffer insert-directory insert-file-contents
1925 load make-directory make-directory-internal
1926 set-file-modes set-file-times substitute-in-file-name
1927 unhandled-file-name-directory vc-registered
1928 ;; Emacs 24+ only.
1929 file-acl file-notify-add-watch file-selinux-context
1930 set-file-acl set-file-selinux-context))
1931 (if (file-name-absolute-p (nth 0 args))
1932 (nth 0 args)
1933 (expand-file-name (nth 0 args))))
1934 ;; FILE DIRECTORY resp FILE1 FILE2.
1935 ((member operation
1936 '(add-name-to-file copy-directory copy-file expand-file-name
1937 file-name-all-completions file-name-completion
1938 file-newer-than-file-p make-symbolic-link rename-file
1939 ;; Emacs 24+ only.
1940 file-equal-p file-in-directory-p))
1941 (save-match-data
1942 (cond
1943 ((tramp-tramp-file-p (nth 0 args)) (nth 0 args))
1944 ((tramp-tramp-file-p (nth 1 args)) (nth 1 args))
1945 (t (buffer-file-name (current-buffer))))))
1946 ;; START END FILE.
1947 ((eq operation 'write-region)
1948 (nth 2 args))
1949 ;; BUFFER.
1950 ((member operation
1951 '(make-auto-save-file-name
1952 set-visited-file-modtime verify-visited-file-modtime))
1953 (buffer-file-name
1954 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
1955 ;; COMMAND.
1956 ((member operation
1957 '(process-file shell-command start-file-process
1958 ;; Emacs 25.2+ only.
1959 make-nearby-temp-file temporary-file-directory))
1960 default-directory)
1961 ;; PROC.
1962 ((member operation
1963 '(;; Emacs 24+ only.
1964 file-notify-rm-watch
1965 ;; Emacs 25+ only.
1966 file-notify-valid-p))
1967 (when (processp (nth 0 args))
1968 (with-current-buffer (process-buffer (nth 0 args))
1969 default-directory)))
1970 ;; Unknown file primitive.
1971 (t (error "unknown file I/O primitive: %s" operation))))
1973 (defun tramp-find-foreign-file-name-handler
1974 (filename &optional operation completion)
1975 "Return foreign file name handler if exists."
1976 (when (tramp-tramp-file-p filename)
1977 (let ((v (tramp-dissect-file-name filename t))
1978 (handler tramp-foreign-file-name-handler-alist)
1979 elt res)
1980 ;; When we are not fully sure that filename completion is safe,
1981 ;; we should not return a handler.
1982 (when (or (not completion)
1983 (tramp-file-name-method v) (tramp-file-name-user v)
1984 (and (tramp-file-name-host v)
1985 (not (member (tramp-file-name-host v)
1986 (mapcar 'car tramp-methods))))
1987 ;; Some operations are safe by default.
1988 (member
1989 operation
1990 '(file-name-as-directory
1991 file-name-directory
1992 file-name-nondirectory)))
1993 (while handler
1994 (setq elt (car handler)
1995 handler (cdr handler))
1996 (when (funcall (car elt) filename)
1997 (setq handler nil
1998 res (cdr elt))))
1999 res))))
2001 (defvar tramp-debug-on-error nil
2002 "Like `debug-on-error' but used Tramp internal.")
2004 (defmacro tramp-condition-case-unless-debug
2005 (var bodyform &rest handlers)
2006 "Like `condition-case-unless-debug' but `tramp-debug-on-error'."
2007 `(let ((debug-on-error tramp-debug-on-error))
2008 (tramp-compat-condition-case-unless-debug ,var ,bodyform ,@handlers)))
2010 ;; Main function.
2011 (defun tramp-file-name-handler (operation &rest args)
2012 "Invoke Tramp file name handler.
2013 Falls back to normal file name handler if no Tramp file name handler exists."
2014 (if tramp-mode
2015 (save-match-data
2016 (let* ((filename
2017 (tramp-replace-environment-variables
2018 (apply 'tramp-file-name-for-operation operation args)))
2019 (completion (tramp-completion-mode-p))
2020 (foreign
2021 (tramp-find-foreign-file-name-handler
2022 filename operation completion))
2023 result)
2024 (with-parsed-tramp-file-name filename nil
2025 ;; Call the backend function.
2026 (if foreign
2027 (tramp-condition-case-unless-debug err
2028 (let ((sf (symbol-function foreign)))
2029 ;; Some packages set the default directory to a
2030 ;; remote path, before respective Tramp packages
2031 ;; are already loaded. This results in
2032 ;; recursive loading. Therefore, we load the
2033 ;; Tramp packages locally.
2034 (when (and (listp sf) (eq (car sf) 'autoload))
2035 (let ((default-directory
2036 (tramp-compat-temporary-file-directory)))
2037 (load (cadr sf) 'noerror 'nomessage)))
2038 ;; If `non-essential' is non-nil, Tramp shall
2039 ;; not open a new connection.
2040 ;; If Tramp detects that it shouldn't continue
2041 ;; to work, it throws the `suppress' event.
2042 ;; This could happen for example, when Tramp
2043 ;; tries to open the same connection twice in a
2044 ;; short time frame.
2045 ;; In both cases, we try the default handler then.
2046 (setq result
2047 (catch 'non-essential
2048 (catch 'suppress
2049 (apply foreign operation args))))
2050 (cond
2051 ((eq result 'non-essential)
2052 (tramp-message
2053 v 5 "Non-essential received in operation %s"
2054 (cons operation args))
2055 (tramp-run-real-handler operation args))
2056 ((eq result 'suppress)
2057 (let (tramp-message-show-message)
2058 (tramp-message
2059 v 1 "Suppress received in operation %s"
2060 (cons operation args))
2061 (tramp-cleanup-connection v t)
2062 (tramp-run-real-handler operation args)))
2063 (t result)))
2065 ;; Trace that somebody has interrupted the operation.
2066 ((debug quit)
2067 (let (tramp-message-show-message)
2068 (tramp-message
2069 v 1 "Interrupt received in operation %s"
2070 (cons operation args)))
2071 ;; Propagate the quit signal.
2072 (signal (car err) (cdr err)))
2074 ;; When we are in completion mode, some failed
2075 ;; operations shall return at least a default value
2076 ;; in order to give the user a chance to correct the
2077 ;; file name in the minibuffer.
2078 ;; In order to get a full backtrace, one could apply
2079 ;; (setq tramp-debug-on-error t)
2080 (error
2081 (cond
2082 ((and completion (zerop (length localname))
2083 (memq operation '(file-exists-p file-directory-p)))
2085 ((and completion (zerop (length localname))
2086 (memq operation
2087 '(expand-file-name file-name-as-directory)))
2088 filename)
2089 ;; Propagate the error.
2090 (t (signal (car err) (cdr err))))))
2092 ;; Nothing to do for us. However, since we are in
2093 ;; `tramp-mode', we must suppress the volume letter on
2094 ;; MS Windows.
2095 (setq result (tramp-run-real-handler operation args))
2096 (if (stringp result)
2097 (tramp-drop-volume-letter result)
2098 result)))))
2100 ;; When `tramp-mode' is not enabled, we don't do anything.
2101 (tramp-run-real-handler operation args)))
2103 ;; In Emacs, there is some concurrency due to timers. If a timer
2104 ;; interrupts Tramp and wishes to use the same connection buffer as
2105 ;; the "main" Emacs, then garbage might occur in the connection
2106 ;; buffer. Therefore, we need to make sure that a timer does not use
2107 ;; the same connection buffer as the "main" Emacs. We implement a
2108 ;; cheap global lock, instead of locking each connection buffer
2109 ;; separately. The global lock is based on two variables,
2110 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
2111 ;; (with setq) to indicate a lock. But Tramp also calls itself during
2112 ;; processing of a single file operation, so we need to allow
2113 ;; recursive calls. That's where the `tramp-locker' variable comes in
2114 ;; -- it is let-bound to t during the execution of the current
2115 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
2116 ;; then we should just proceed because we have been called
2117 ;; recursively. But if `tramp-locker' is nil, then we are a timer
2118 ;; interrupting the "main" Emacs, and then we signal an error.
2120 (defvar tramp-locked nil
2121 "If non-nil, then Tramp is currently busy.
2122 Together with `tramp-locker', this implements a locking mechanism
2123 preventing reentrant calls of Tramp.")
2125 (defvar tramp-locker nil
2126 "If non-nil, then a caller has locked Tramp.
2127 Together with `tramp-locked', this implements a locking mechanism
2128 preventing reentrant calls of Tramp.")
2130 ;; Avoid recursive loading of tramp.el.
2131 ;;;###autoload(defun tramp-completion-file-name-handler (operation &rest args)
2132 ;;;###autoload (tramp-completion-run-real-handler operation args))
2134 (defun tramp-completion-file-name-handler (operation &rest args)
2135 "Invoke Tramp file name completion handler.
2136 Falls back to normal file name handler if no Tramp file name handler exists."
2137 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
2138 (if (and
2139 ;; When `tramp-mode' is not enabled, we don't do anything.
2140 fn tramp-mode (tramp-completion-mode-p)
2141 ;; For other syntaxes than `sep', the regexp matches many common
2142 ;; situations where the user doesn't actually want to use Tramp.
2143 ;; So to avoid autoloading Tramp after typing just "/s", we
2144 ;; disable this part of the completion, unless the user implicitly
2145 ;; indicated his interest in using a fancier completion system.
2146 (or (eq tramp-syntax 'sep)
2147 (featurep 'tramp) ;; If it's loaded, we may as well use it.
2148 ;; `partial-completion-mode' is obsoleted with Emacs 24.1.
2149 (and (boundp 'partial-completion-mode)
2150 (symbol-value 'partial-completion-mode))
2151 ;; FIXME: These may have been loaded even if the user never
2152 ;; intended to use them.
2153 (featurep 'ido)
2154 (featurep 'icicles)))
2155 (save-match-data (apply (cdr fn) args))
2156 (tramp-completion-run-real-handler operation args))))
2158 ;;;###autoload
2159 (progn (defun tramp-autoload-file-name-handler (operation &rest args)
2160 "Load Tramp file name handler, and perform OPERATION."
2161 ;; Avoid recursive loading of tramp.el.
2162 (let ((default-directory temporary-file-directory))
2163 (load "tramp" nil t))
2164 (apply operation args)))
2166 ;; `tramp-autoload-file-name-handler' must be registered before
2167 ;; evaluation of site-start and init files, because there might exist
2168 ;; remote files already, f.e. files kept via recentf-mode. We cannot
2169 ;; autoload `tramp-file-name-handler', because it would result in
2170 ;; recursive loading of tramp.el when `default-directory' is set to
2171 ;; remote.
2172 ;;;###autoload
2173 (progn (defun tramp-register-autoload-file-name-handlers ()
2174 "Add Tramp file name handlers to `file-name-handler-alist' during autoload."
2175 (add-to-list 'file-name-handler-alist
2176 (cons tramp-file-name-regexp
2177 'tramp-autoload-file-name-handler))
2178 (put 'tramp-autoload-file-name-handler 'safe-magic t)
2179 (add-to-list 'file-name-handler-alist
2180 (cons tramp-completion-file-name-regexp
2181 'tramp-completion-file-name-handler))
2182 (put 'tramp-completion-file-name-handler 'safe-magic t)))
2184 ;;;###autoload
2185 (tramp-register-autoload-file-name-handlers)
2187 (defun tramp-register-file-name-handlers ()
2188 "Add Tramp file name handlers to `file-name-handler-alist'."
2189 ;; Remove autoloaded handlers from file name handler alist. Useful,
2190 ;; if `tramp-syntax' has been changed.
2191 (dolist (fnh '(tramp-file-name-handler
2192 tramp-completion-file-name-handler
2193 tramp-autoload-file-name-handler))
2194 (let ((a1 (rassq fnh file-name-handler-alist)))
2195 (setq file-name-handler-alist (delq a1 file-name-handler-alist))))
2196 ;; Add the handlers.
2197 (add-to-list 'file-name-handler-alist
2198 (cons tramp-file-name-regexp 'tramp-file-name-handler))
2199 (put 'tramp-file-name-handler 'safe-magic t)
2200 (add-to-list 'file-name-handler-alist
2201 (cons tramp-completion-file-name-regexp
2202 'tramp-completion-file-name-handler))
2203 (put 'tramp-completion-file-name-handler 'safe-magic t)
2204 ;; If jka-compr or epa-file are already loaded, move them to the
2205 ;; front of `file-name-handler-alist'.
2206 (dolist (fnh '(epa-file-handler jka-compr-handler))
2207 (let ((entry (rassoc fnh file-name-handler-alist)))
2208 (when entry
2209 (setq file-name-handler-alist
2210 (cons entry (delete entry file-name-handler-alist)))))))
2212 (eval-after-load 'tramp (tramp-register-file-name-handlers))
2214 (defun tramp-exists-file-name-handler (operation &rest args)
2215 "Check, whether OPERATION runs a file name handler."
2216 ;; The file name handler is determined on base of either an
2217 ;; argument, `buffer-file-name', or `default-directory'.
2218 (ignore-errors
2219 (let* ((buffer-file-name "/")
2220 (default-directory "/")
2221 (fnha file-name-handler-alist)
2222 (check-file-name-operation operation)
2223 (file-name-handler-alist
2224 (list
2225 (cons "/"
2226 (lambda (operation &rest args)
2227 "Returns OPERATION if it is the one to be checked."
2228 (if (equal check-file-name-operation operation)
2229 operation
2230 (let ((file-name-handler-alist fnha))
2231 (apply operation args))))))))
2232 (equal (apply operation args) operation))))
2234 ;;;###autoload
2235 (defun tramp-unload-file-name-handlers ()
2236 "Unload Tramp file name handlers from `file-name-handler-alist'."
2237 (setq file-name-handler-alist
2238 (delete (rassoc 'tramp-file-name-handler
2239 file-name-handler-alist)
2240 (delete (rassoc 'tramp-completion-file-name-handler
2241 file-name-handler-alist)
2242 file-name-handler-alist))))
2244 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
2246 ;;; File name handler functions for completion mode:
2248 ;;;###autoload
2249 (defvar tramp-completion-mode nil
2250 "If non-nil, external packages signal that they are in file name completion.
2252 This is necessary, because Tramp uses a heuristic depending on last
2253 input event. This fails when external packages use other characters
2254 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
2255 should never be set globally, the intention is to let-bind it.")
2257 ;; Necessary because `tramp-file-name-regexp-unified' and
2258 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
2259 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
2260 ;; to `tramp-file-name-handler'). Otherwise, it takes
2261 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
2262 ;; risky, because completing a file might require loading other files,
2263 ;; like "~/.netrc", and for them it shouldn't be decided based on that
2264 ;; variable. On the other hand, those files shouldn't have partial
2265 ;; Tramp file name syntax. Maybe another variable should be introduced
2266 ;; overwriting this check in such cases. Or we change Tramp file name
2267 ;; syntax in order to avoid ambiguities.
2268 (defun tramp-completion-mode-p ()
2269 "Check, whether method / user name / host name completion is active."
2271 ;; Signal from outside. `non-essential' has been introduced in Emacs 24.
2272 (and (boundp 'non-essential) (symbol-value 'non-essential))
2273 tramp-completion-mode
2274 (equal last-input-event 'tab)
2275 (and (natnump last-input-event)
2277 ;; ?\t has event-modifier 'control.
2278 (equal last-input-event ?\t)
2279 (and (not (event-modifiers last-input-event))
2280 (or (equal last-input-event ?\?)
2281 (equal last-input-event ?\ )))))))
2283 (defun tramp-connectable-p (filename)
2284 "Check, whether it is possible to connect the remote host w/o side-effects.
2285 This is true, if either the remote host is already connected, or if we are
2286 not in completion mode."
2287 (and (tramp-tramp-file-p filename)
2288 (or (not (tramp-completion-mode-p))
2289 (tramp-compat-process-live-p
2290 (tramp-get-connection-process
2291 (tramp-dissect-file-name filename))))))
2293 (defun tramp-completion-handle-expand-file-name (name &optional dir)
2294 "Like `expand-file-name' for Tramp files."
2295 (if (tramp-completion-mode-p)
2296 (progn
2297 ;; If DIR is not given, use `default-directory' or "/".
2298 (setq dir (or dir default-directory "/"))
2299 ;; Unless NAME is absolute, concat DIR and NAME.
2300 (unless (file-name-absolute-p name)
2301 (setq name (concat (file-name-as-directory dir) name)))
2302 ;; Return NAME.
2303 name)
2305 (tramp-completion-run-real-handler
2306 'expand-file-name (list name dir))))
2308 ;; Method, host name and user name completion.
2309 ;; `tramp-completion-dissect-file-name' returns a list of
2310 ;; tramp-file-name structures. For all of them we return possible completions.
2311 (defun tramp-completion-handle-file-name-all-completions (filename directory)
2312 "Like `file-name-all-completions' for partial Tramp files."
2314 (let ((fullname
2315 (tramp-drop-volume-letter (expand-file-name filename directory)))
2316 hop result result1)
2318 ;; Suppress hop from completion.
2319 (when (string-match
2320 (concat
2321 tramp-prefix-regexp
2322 "\\(" "\\(" tramp-remote-file-name-spec-regexp
2323 tramp-postfix-hop-regexp
2324 "\\)+" "\\)")
2325 fullname)
2326 (setq hop (match-string 1 fullname)
2327 fullname (replace-match "" nil nil fullname 1)))
2329 ;; Possible completion structures.
2330 (dolist (elt (tramp-completion-dissect-file-name fullname))
2331 (let* ((method (tramp-file-name-method elt))
2332 (user (tramp-file-name-user elt))
2333 (host (tramp-file-name-host elt))
2334 (localname (tramp-file-name-localname elt))
2335 (m (tramp-find-method method user host))
2336 (tramp-current-user user) ; see `tramp-parse-passwd'
2337 all-user-hosts)
2339 (unless localname ;; Nothing to complete.
2341 (if (or user host)
2343 ;; Method dependent user / host combinations.
2344 (progn
2345 (mapc
2346 (lambda (x)
2347 (setq all-user-hosts
2348 (append all-user-hosts
2349 (funcall (nth 0 x) (nth 1 x)))))
2350 (tramp-get-completion-function m))
2352 (setq result
2353 (append result
2354 (mapcar
2355 (lambda (x)
2356 (tramp-get-completion-user-host
2357 method user host (nth 0 x) (nth 1 x)))
2358 (delq nil all-user-hosts)))))
2360 ;; Possible methods.
2361 (setq result
2362 (append result (tramp-get-completion-methods m)))))))
2364 ;; Unify list, add hop, remove nil elements.
2365 (dolist (elt result)
2366 (when elt
2367 (string-match tramp-prefix-regexp elt)
2368 (setq elt (replace-match (concat tramp-prefix-format hop) nil nil elt))
2369 (add-to-list
2370 'result1
2371 (substring elt (length (tramp-drop-volume-letter directory))))))
2373 ;; Complete local parts.
2374 (append
2375 result1
2376 (ignore-errors
2377 (apply (if (tramp-connectable-p fullname)
2378 'tramp-completion-run-real-handler
2379 'tramp-run-real-handler)
2380 'file-name-all-completions (list (list filename directory)))))))
2382 ;; Method, host name and user name completion for a file.
2383 (defun tramp-completion-handle-file-name-completion
2384 (filename directory &optional predicate)
2385 "Like `file-name-completion' for Tramp files."
2386 (try-completion
2387 filename
2388 (mapcar 'list (file-name-all-completions filename directory))
2389 (when (and predicate
2390 (tramp-connectable-p (expand-file-name filename directory)))
2391 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2393 ;; I misuse a little bit the tramp-file-name structure in order to handle
2394 ;; completion possibilities for partial methods / user names / host names.
2395 ;; Return value is a list of tramp-file-name structures according to possible
2396 ;; completions. If "localname" is non-nil it means there
2397 ;; shouldn't be a completion anymore.
2399 ;; Expected results:
2401 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
2402 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
2403 ;; [nil "x" nil nil]
2404 ;; ["x" nil nil nil]
2406 ;; "/x:" "/x:y" "/x:y:"
2407 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
2408 ;; "/[x/" "/[x/y"
2409 ;; ["x" nil "" nil] ["x" nil "y" nil]
2410 ;; ["x" "" nil nil] ["x" "y" nil nil]
2412 ;; "/x:y@" "/x:y@z" "/x:y@z:"
2413 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
2414 ;; "/[x/y@" "/[x/y@z"
2415 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
2416 (defun tramp-completion-dissect-file-name (name)
2417 "Returns a list of `tramp-file-name' structures.
2418 They are collected by `tramp-completion-dissect-file-name1'."
2420 (let* ((result)
2421 (x-nil "\\|\\(\\)")
2422 (tramp-completion-ipv6-regexp
2423 (format
2424 "[^%s]*"
2425 (if (zerop (length tramp-postfix-ipv6-format))
2426 tramp-postfix-host-format
2427 tramp-postfix-ipv6-format)))
2428 ;; "/method" "/[method"
2429 (tramp-completion-file-name-structure1
2430 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
2431 1 nil nil nil))
2432 ;; "/user" "/[user"
2433 (tramp-completion-file-name-structure2
2434 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
2435 nil 1 nil nil))
2436 ;; "/host" "/[host"
2437 (tramp-completion-file-name-structure3
2438 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
2439 nil nil 1 nil))
2440 ;; "/[ipv6" "/[ipv6"
2441 (tramp-completion-file-name-structure4
2442 (list (concat tramp-prefix-regexp
2443 tramp-prefix-ipv6-regexp
2444 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2445 nil nil 1 nil))
2446 ;; "/user@host" "/[user@host"
2447 (tramp-completion-file-name-structure5
2448 (list (concat tramp-prefix-regexp
2449 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2450 "\\(" tramp-host-regexp x-nil "\\)$")
2451 nil 1 2 nil))
2452 ;; "/user@[ipv6" "/[user@ipv6"
2453 (tramp-completion-file-name-structure6
2454 (list (concat tramp-prefix-regexp
2455 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2456 tramp-prefix-ipv6-regexp
2457 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2458 nil 1 2 nil))
2459 ;; "/method:user" "/[method/user"
2460 (tramp-completion-file-name-structure7
2461 (list (concat tramp-prefix-regexp
2462 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2463 "\\(" tramp-user-regexp x-nil "\\)$")
2464 1 2 nil nil))
2465 ;; "/method:host" "/[method/host"
2466 (tramp-completion-file-name-structure8
2467 (list (concat tramp-prefix-regexp
2468 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2469 "\\(" tramp-host-regexp x-nil "\\)$")
2470 1 nil 2 nil))
2471 ;; "/method:[ipv6" "/[method/ipv6"
2472 (tramp-completion-file-name-structure9
2473 (list (concat tramp-prefix-regexp
2474 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2475 tramp-prefix-ipv6-regexp
2476 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2477 1 nil 2 nil))
2478 ;; "/method:user@host" "/[method/user@host"
2479 (tramp-completion-file-name-structure10
2480 (list (concat tramp-prefix-regexp
2481 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2482 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2483 "\\(" tramp-host-regexp x-nil "\\)$")
2484 1 2 3 nil))
2485 ;; "/method:user@[ipv6" "/[method/user@ipv6"
2486 (tramp-completion-file-name-structure11
2487 (list (concat tramp-prefix-regexp
2488 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
2489 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
2490 tramp-prefix-ipv6-regexp
2491 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
2492 1 2 3 nil)))
2494 (mapc (lambda (structure)
2495 (add-to-list 'result
2496 (tramp-completion-dissect-file-name1 structure name)))
2497 (list
2498 tramp-completion-file-name-structure1
2499 tramp-completion-file-name-structure2
2500 tramp-completion-file-name-structure3
2501 tramp-completion-file-name-structure4
2502 tramp-completion-file-name-structure5
2503 tramp-completion-file-name-structure6
2504 tramp-completion-file-name-structure7
2505 tramp-completion-file-name-structure8
2506 tramp-completion-file-name-structure9
2507 tramp-completion-file-name-structure10
2508 tramp-completion-file-name-structure11
2509 tramp-file-name-structure))
2511 (delq nil result)))
2513 (defun tramp-completion-dissect-file-name1 (structure name)
2514 "Returns a `tramp-file-name' structure matching STRUCTURE.
2515 The structure consists of remote method, remote user,
2516 remote host and localname (filename on remote host)."
2518 (save-match-data
2519 (when (string-match (nth 0 structure) name)
2520 (let ((method (and (nth 1 structure)
2521 (match-string (nth 1 structure) name)))
2522 (user (and (nth 2 structure)
2523 (match-string (nth 2 structure) name)))
2524 (host (and (nth 3 structure)
2525 (match-string (nth 3 structure) name)))
2526 (localname (and (nth 4 structure)
2527 (match-string (nth 4 structure) name))))
2528 (vector method user host localname nil)))))
2530 ;; This function returns all possible method completions, adding the
2531 ;; trailing method delimiter.
2532 (defun tramp-get-completion-methods (partial-method)
2533 "Returns all method completions for PARTIAL-METHOD."
2534 (mapcar
2535 (lambda (method)
2536 (and method
2537 (string-match (concat "^" (regexp-quote partial-method)) method)
2538 (tramp-completion-make-tramp-file-name method nil nil nil)))
2539 (mapcar 'car tramp-methods)))
2541 ;; Compares partial user and host names with possible completions.
2542 (defun tramp-get-completion-user-host
2543 (method partial-user partial-host user host)
2544 "Returns the most expanded string for user and host name completion.
2545 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
2546 (cond
2548 ((and partial-user partial-host)
2549 (if (and host
2550 (string-match (concat "^" (regexp-quote partial-host)) host)
2551 (string-equal partial-user (or user partial-user)))
2552 (setq user partial-user)
2553 (setq user nil
2554 host nil)))
2556 (partial-user
2557 (setq host nil)
2558 (unless
2559 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
2560 (setq user nil)))
2562 (partial-host
2563 (setq user nil)
2564 (unless
2565 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
2566 (setq host nil)))
2568 (t (setq user nil
2569 host nil)))
2571 (unless (zerop (+ (length user) (length host)))
2572 (tramp-completion-make-tramp-file-name method user host nil)))
2574 (defun tramp-parse-default-user-host (method)
2575 "Return a list of (user host) tuples allowed to access for METHOD.
2576 This function is added always in `tramp-get-completion-function'
2577 for all methods. Resulting data are derived from default settings."
2578 `((,(tramp-find-user method nil nil) ,(tramp-find-host method nil nil))))
2580 ;; Generic function.
2581 (defun tramp-parse-group (regexp match-level skip-regexp)
2582 "Return a (user host) tuple allowed to access.
2583 User is always nil."
2584 (let (result)
2585 (when (re-search-forward regexp (point-at-eol) t)
2586 (setq result (list nil (match-string match-level))))
2588 (> (skip-chars-forward skip-regexp) 0)
2589 (forward-line 1))
2590 result))
2592 ;; Generic function.
2593 (defun tramp-parse-file (filename function)
2594 "Return a list of (user host) tuples allowed to access.
2595 User is always nil."
2596 ;; On Windows, there are problems in completion when
2597 ;; `default-directory' is remote.
2598 (let ((default-directory (tramp-compat-temporary-file-directory)))
2599 (when (file-readable-p filename)
2600 (with-temp-buffer
2601 (insert-file-contents filename)
2602 (goto-char (point-min))
2603 (loop while (not (eobp)) collect (funcall function))))))
2605 ;;;###tramp-autoload
2606 (defun tramp-parse-rhosts (filename)
2607 "Return a list of (user host) tuples allowed to access.
2608 Either user or host may be nil."
2609 (tramp-parse-file filename 'tramp-parse-rhosts-group))
2611 (defun tramp-parse-rhosts-group ()
2612 "Return a (user host) tuple allowed to access.
2613 Either user or host may be nil."
2614 (let ((result)
2615 (regexp
2616 (concat
2617 "^\\(" tramp-host-regexp "\\)"
2618 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2619 (when (re-search-forward regexp (point-at-eol) t)
2620 (setq result (append (list (match-string 3) (match-string 1)))))
2621 (forward-line 1)
2622 result))
2624 ;;;###tramp-autoload
2625 (defun tramp-parse-shosts (filename)
2626 "Return a list of (user host) tuples allowed to access.
2627 User is always nil."
2628 (tramp-parse-file filename 'tramp-parse-shosts-group))
2630 (defun tramp-parse-shosts-group ()
2631 "Return a (user host) tuple allowed to access.
2632 User is always nil."
2633 (tramp-parse-group (concat "^\\(" tramp-host-regexp "\\)") 1 ","))
2635 ;;;###tramp-autoload
2636 (defun tramp-parse-sconfig (filename)
2637 "Return a list of (user host) tuples allowed to access.
2638 User is always nil."
2639 (tramp-parse-file filename 'tramp-parse-sconfig-group))
2641 (defun tramp-parse-sconfig-group ()
2642 "Return a (user host) tuple allowed to access.
2643 User is always nil."
2644 (tramp-parse-group
2645 (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)") 1 ","))
2647 ;; Generic function.
2648 (defun tramp-parse-shostkeys-sknownhosts (dirname regexp)
2649 "Return a list of (user host) tuples allowed to access.
2650 User is always nil."
2651 ;; On Windows, there are problems in completion when
2652 ;; `default-directory' is remote.
2653 (let* ((default-directory (tramp-compat-temporary-file-directory))
2654 (files (and (file-directory-p dirname) (directory-files dirname))))
2655 (loop for f in files
2656 when (and (not (string-match "^\\.\\.?$" f)) (string-match regexp f))
2657 collect (list nil (match-string 1 f)))))
2659 ;;;###tramp-autoload
2660 (defun tramp-parse-shostkeys (dirname)
2661 "Return a list of (user host) tuples allowed to access.
2662 User is always nil."
2663 (tramp-parse-shostkeys-sknownhosts
2664 dirname (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")))
2666 ;;;###tramp-autoload
2667 (defun tramp-parse-sknownhosts (dirname)
2668 "Return a list of (user host) tuples allowed to access.
2669 User is always nil."
2670 (tramp-parse-shostkeys-sknownhosts
2671 dirname
2672 (concat "^\\(" tramp-host-regexp "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")))
2674 ;;;###tramp-autoload
2675 (defun tramp-parse-hosts (filename)
2676 "Return a list of (user host) tuples allowed to access.
2677 User is always nil."
2678 (tramp-parse-file filename 'tramp-parse-hosts-group))
2680 (defun tramp-parse-hosts-group ()
2681 "Return a (user host) tuple allowed to access.
2682 User is always nil."
2683 (tramp-parse-group
2684 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)") 1 " \t"))
2686 ;;;###tramp-autoload
2687 (defun tramp-parse-passwd (filename)
2688 "Return a list of (user host) tuples allowed to access.
2689 Host is always \"localhost\"."
2690 (with-tramp-connection-property nil "parse-passwd"
2691 (if (executable-find "getent")
2692 (with-temp-buffer
2693 (when (zerop (tramp-call-process nil "getent" nil t nil "passwd"))
2694 (goto-char (point-min))
2695 (loop while (not (eobp)) collect
2696 (tramp-parse-etc-group-group))))
2697 (tramp-parse-file filename 'tramp-parse-passwd-group))))
2699 (defun tramp-parse-passwd-group ()
2700 "Return a (user host) tuple allowed to access.
2701 Host is always \"localhost\"."
2702 (let ((result)
2703 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
2704 (when (re-search-forward regexp (point-at-eol) t)
2705 (setq result (list (match-string 1) "localhost")))
2706 (forward-line 1)
2707 result))
2709 ;;;###tramp-autoload
2710 (defun tramp-parse-etc-group (filename)
2711 "Return a list of (group host) tuples allowed to access.
2712 Host is always \"localhost\"."
2713 (with-tramp-connection-property nil "parse-group"
2714 (if (executable-find "getent")
2715 (with-temp-buffer
2716 (when (zerop (tramp-call-process nil "getent" nil t nil "group"))
2717 (goto-char (point-min))
2718 (loop while (not (eobp)) collect
2719 (tramp-parse-etc-group-group))))
2720 (tramp-parse-file filename 'tramp-parse-etc-group-group))))
2722 (defun tramp-parse-etc-group-group ()
2723 "Return a (group host) tuple allowed to access.
2724 Host is always \"localhost\"."
2725 (let ((result)
2726 (split (split-string (buffer-substring (point) (point-at-eol)) ":")))
2727 (when (member (user-login-name) (split-string (nth 3 split) "," 'omit))
2728 (setq result (list (nth 0 split) "localhost")))
2729 (forward-line 1)
2730 result))
2732 ;;;###tramp-autoload
2733 (defun tramp-parse-netrc (filename)
2734 "Return a list of (user host) tuples allowed to access.
2735 User may be nil."
2736 (tramp-parse-file filename 'tramp-parse-netrc-group))
2738 (defun tramp-parse-netrc-group ()
2739 "Return a (user host) tuple allowed to access.
2740 User may be nil."
2741 (let ((result)
2742 (regexp
2743 (concat
2744 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
2745 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
2746 (when (re-search-forward regexp (point-at-eol) t)
2747 (setq result (list (match-string 3) (match-string 1))))
2748 (forward-line 1)
2749 result))
2751 ;;;###tramp-autoload
2752 (defun tramp-parse-putty (registry-or-dirname)
2753 "Return a list of (user host) tuples allowed to access.
2754 User is always nil."
2755 (if (memq system-type '(windows-nt))
2756 (with-tramp-connection-property nil "parse-putty"
2757 (with-temp-buffer
2758 (when (zerop (tramp-call-process
2759 nil "reg" nil t nil "query" registry-or-dirname))
2760 (goto-char (point-min))
2761 (loop while (not (eobp)) collect
2762 (tramp-parse-putty-group registry-or-dirname)))))
2763 ;; UNIX case.
2764 (tramp-parse-shostkeys-sknownhosts
2765 registry-or-dirname (concat "^\\(" tramp-host-regexp "\\)$"))))
2767 (defun tramp-parse-putty-group (registry)
2768 "Return a (user host) tuple allowed to access.
2769 User is always nil."
2770 (let ((result)
2771 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
2772 (when (re-search-forward regexp (point-at-eol) t)
2773 (setq result (list nil (match-string 1))))
2774 (forward-line 1)
2775 result))
2777 ;;; Common file name handler functions for different backends:
2779 (defvar tramp-handle-file-local-copy-hook nil
2780 "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.")
2782 (defvar tramp-handle-write-region-hook nil
2783 "Normal hook to be run at the end of `tramp-*-handle-write-region'.")
2785 (defun tramp-handle-directory-file-name (directory)
2786 "Like `directory-file-name' for Tramp files."
2787 ;; If localname component of filename is "/", leave it unchanged.
2788 ;; Otherwise, remove any trailing slash from localname component.
2789 ;; Method, host, etc, are unchanged. Does it make sense to try
2790 ;; to avoid parsing the filename?
2791 (with-parsed-tramp-file-name directory nil
2792 (if (and (not (zerop (length localname)))
2793 (eq (aref localname (1- (length localname))) ?/)
2794 (not (string= localname "/")))
2795 (substring directory 0 -1)
2796 directory)))
2798 (defun tramp-handle-directory-files (directory &optional full match nosort)
2799 "Like `directory-files' for Tramp files."
2800 (when (file-directory-p directory)
2801 (setq directory (file-name-as-directory (expand-file-name directory)))
2802 (let ((temp (nreverse (file-name-all-completions "" directory)))
2803 result item)
2805 (while temp
2806 (setq item (directory-file-name (pop temp)))
2807 (when (or (null match) (string-match match item))
2808 (push (if full (concat directory item) item)
2809 result)))
2810 (if nosort result (sort result 'string<)))))
2812 (defun tramp-handle-directory-files-and-attributes
2813 (directory &optional full match nosort id-format)
2814 "Like `directory-files-and-attributes' for Tramp files."
2815 (mapcar
2816 (lambda (x)
2817 (cons x (file-attributes
2818 (if full x (expand-file-name x directory)) id-format)))
2819 (directory-files directory full match nosort)))
2821 (defun tramp-handle-dired-uncache (dir)
2822 "Like `dired-uncache' for Tramp files."
2823 (with-parsed-tramp-file-name
2824 (if (file-directory-p dir) dir (file-name-directory dir)) nil
2825 (tramp-flush-directory-property v localname)))
2827 (defun tramp-handle-file-accessible-directory-p (filename)
2828 "Like `file-accessible-directory-p' for Tramp files."
2829 (and (file-directory-p filename)
2830 (file-readable-p filename)))
2832 (defun tramp-handle-file-equal-p (filename1 filename2)
2833 "Like `file-equalp-p' for Tramp files."
2834 ;; Native `file-equalp-p' calls `file-truename', which requires a
2835 ;; remote connection. This can be avoided, if FILENAME1 and
2836 ;; FILENAME2 are not located on the same remote host.
2837 (when (string-equal
2838 (file-remote-p (expand-file-name filename1))
2839 (file-remote-p (expand-file-name filename2)))
2840 (tramp-run-real-handler 'file-equal-p (list filename1 filename2))))
2842 (defun tramp-handle-file-exists-p (filename)
2843 "Like `file-exists-p' for Tramp files."
2844 (not (null (file-attributes filename))))
2846 (defun tramp-handle-file-in-directory-p (filename directory)
2847 "Like `file-in-directory-p' for Tramp files."
2848 ;; Native `file-in-directory-p' calls `file-truename', which
2849 ;; requires a remote connection. This can be avoided, if FILENAME
2850 ;; and DIRECTORY are not located on the same remote host.
2851 (when (string-equal
2852 (file-remote-p (expand-file-name filename))
2853 (file-remote-p (expand-file-name directory)))
2854 (tramp-run-real-handler 'file-in-directory-p (list filename directory))))
2856 (defun tramp-handle-file-modes (filename)
2857 "Like `file-modes' for Tramp files."
2858 (let ((truename (or (file-truename filename) filename)))
2859 (when (file-exists-p truename)
2860 (tramp-mode-string-to-int
2861 (tramp-compat-file-attribute-modes (file-attributes truename))))))
2863 ;; Localname manipulation functions that grok Tramp localnames...
2864 (defun tramp-handle-file-name-as-directory (file)
2865 "Like `file-name-as-directory' but aware of Tramp files."
2866 ;; `file-name-as-directory' would be sufficient except localname is
2867 ;; the empty string.
2868 (let ((v (tramp-dissect-file-name file t)))
2869 ;; Run the command on the localname portion only unless we are in
2870 ;; completion mode.
2871 (tramp-make-tramp-file-name
2872 (tramp-file-name-method v)
2873 (tramp-file-name-user v)
2874 (tramp-file-name-host v)
2875 (if (and (tramp-completion-mode-p)
2876 (zerop (length (tramp-file-name-localname v))))
2878 (tramp-run-real-handler
2879 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))
2880 (tramp-file-name-hop v))))
2882 (defun tramp-handle-file-name-completion
2883 (filename directory &optional predicate)
2884 "Like `file-name-completion' for Tramp files."
2885 (unless (tramp-tramp-file-p directory)
2886 (error
2887 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2888 directory))
2889 (let (hits-ignored-extensions)
2891 (try-completion
2892 filename (file-name-all-completions filename directory)
2893 (lambda (x)
2894 (when (funcall (or predicate 'identity) (expand-file-name x directory))
2895 (not
2896 (and
2897 completion-ignored-extensions
2898 (string-match
2899 (concat (regexp-opt completion-ignored-extensions 'paren) "$") x)
2900 ;; We remember the hit.
2901 (push x hits-ignored-extensions))))))
2902 ;; No match. So we try again for ignored files.
2903 (try-completion filename hits-ignored-extensions))))
2905 (defun tramp-handle-file-name-directory (file)
2906 "Like `file-name-directory' but aware of Tramp files."
2907 ;; Everything except the last filename thing is the directory. We
2908 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2909 ;; the remote file name parts. This is a problem when we are in
2910 ;; file name completion.
2911 (let ((v (tramp-dissect-file-name file t)))
2912 ;; Run the command on the localname portion only.
2913 (tramp-make-tramp-file-name
2914 (tramp-file-name-method v)
2915 (tramp-file-name-user v)
2916 (tramp-file-name-host v)
2917 (tramp-run-real-handler
2918 'file-name-directory (list (or (tramp-file-name-localname v) "")))
2919 (tramp-file-name-hop v))))
2921 (defun tramp-handle-file-name-nondirectory (file)
2922 "Like `file-name-nondirectory' but aware of Tramp files."
2923 (with-parsed-tramp-file-name file nil
2924 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2926 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2927 "Like `file-newer-than-file-p' for Tramp files."
2928 (cond
2929 ((not (file-exists-p file1)) nil)
2930 ((not (file-exists-p file2)) t)
2931 (t (time-less-p (tramp-compat-file-attribute-modification-time
2932 (file-attributes file2))
2933 (tramp-compat-file-attribute-modification-time
2934 (file-attributes file1))))))
2936 (defun tramp-handle-file-regular-p (filename)
2937 "Like `file-regular-p' for Tramp files."
2938 (and (file-exists-p filename)
2939 (eq ?-
2940 (aref (tramp-compat-file-attribute-modes (file-attributes filename))
2941 0))))
2943 (defun tramp-handle-file-remote-p (filename &optional identification connected)
2944 "Like `file-remote-p' for Tramp files."
2945 ;; We do not want traces in the debug buffer.
2946 (let ((tramp-verbose (min tramp-verbose 3)))
2947 (when (tramp-tramp-file-p filename)
2948 (let* ((v (tramp-dissect-file-name filename))
2949 (p (tramp-get-connection-process v))
2950 (c (and (tramp-compat-process-live-p p)
2951 (tramp-get-connection-property p "connected" nil))))
2952 ;; We expand the file name only, if there is already a connection.
2953 (with-parsed-tramp-file-name
2954 (if c (expand-file-name filename) filename) nil
2955 (and (or (not connected) c)
2956 (cond
2957 ((eq identification 'method) method)
2958 ((eq identification 'user) user)
2959 ((eq identification 'host) host)
2960 ((eq identification 'localname) localname)
2961 ((eq identification 'hop) hop)
2962 (t (tramp-make-tramp-file-name method user host "" hop)))))))))
2964 (defun tramp-handle-file-symlink-p (filename)
2965 "Like `file-symlink-p' for Tramp files."
2966 (with-parsed-tramp-file-name filename nil
2967 (let ((x (tramp-compat-file-attribute-type (file-attributes filename))))
2968 (when (stringp x)
2969 (if (file-name-absolute-p x)
2970 (tramp-make-tramp-file-name method user host x)
2971 x)))))
2973 (defun tramp-handle-find-backup-file-name (filename)
2974 "Like `find-backup-file-name' for Tramp files."
2975 (with-parsed-tramp-file-name filename nil
2976 (let ((backup-directory-alist
2977 (if tramp-backup-directory-alist
2978 (mapcar
2979 (lambda (x)
2980 (cons
2981 (car x)
2982 (if (and (stringp (cdr x))
2983 (file-name-absolute-p (cdr x))
2984 (not (tramp-file-name-p (cdr x))))
2985 (tramp-make-tramp-file-name method user host (cdr x))
2986 (cdr x))))
2987 tramp-backup-directory-alist)
2988 backup-directory-alist)))
2989 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
2991 (defun tramp-handle-insert-directory
2992 (filename switches &optional wildcard full-directory-p)
2993 "Like `insert-directory' for Tramp files."
2994 (unless switches (setq switches ""))
2995 ;; Mark trailing "/".
2996 (when (and (zerop (length (file-name-nondirectory filename)))
2997 (not full-directory-p))
2998 (setq switches (concat switches "F")))
2999 (with-parsed-tramp-file-name (expand-file-name filename) nil
3000 (with-tramp-progress-reporter v 0 (format "Opening directory %s" filename)
3001 (require 'ls-lisp)
3002 (let (ls-lisp-use-insert-directory-program start)
3003 (tramp-run-real-handler
3004 'insert-directory
3005 (list filename switches wildcard full-directory-p))
3006 ;; `ls-lisp' always returns full listings. We must remove
3007 ;; superfluous parts.
3008 (unless (string-match "l" switches)
3009 (save-excursion
3010 (goto-char (point-min))
3011 (while (setq start
3012 (text-property-not-all
3013 (point) (point-at-eol) 'dired-filename t))
3014 (delete-region
3015 start
3016 (or (text-property-any start (point-at-eol) 'dired-filename t)
3017 (point-at-eol)))
3018 (if (= (point-at-bol) (point-at-eol))
3019 ;; Empty line.
3020 (delete-region (point) (progn (forward-line) (point)))
3021 (forward-line)))))))))
3023 (defun tramp-handle-insert-file-contents
3024 (filename &optional visit beg end replace)
3025 "Like `insert-file-contents' for Tramp files."
3026 (barf-if-buffer-read-only)
3027 (setq filename (expand-file-name filename))
3028 (let (result local-copy remote-copy)
3029 (with-parsed-tramp-file-name filename nil
3030 (unwind-protect
3031 (if (not (file-exists-p filename))
3032 (tramp-error
3033 v 'file-error "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 v 'file-error "Cannot load nonexistent file `%s'" file)))
3159 (if (not (file-exists-p file))
3161 (let ((tramp-message-show-message (not nomessage)))
3162 (with-tramp-progress-reporter v 0 (format "Loading %s" file)
3163 (let ((local-copy (file-local-copy file)))
3164 (unwind-protect
3165 (load local-copy noerror t nosuffix must-suffix)
3166 (delete-file local-copy)))))
3167 t)))
3169 (defun tramp-handle-make-symbolic-link
3170 (filename linkname &optional _ok-if-already-exists)
3171 "Like `make-symbolic-link' for Tramp files."
3172 (with-parsed-tramp-file-name
3173 (if (tramp-tramp-file-p filename) filename linkname) nil
3174 (tramp-error v 'file-error "make-symbolic-link not supported")))
3176 (defun tramp-handle-shell-command
3177 (command &optional output-buffer error-buffer)
3178 "Like `shell-command' for Tramp files."
3179 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3180 ;; We cannot use `shell-file-name' and `shell-command-switch',
3181 ;; they are variables of the local host.
3182 (args (append
3183 (cons
3184 (tramp-get-method-parameter
3185 (tramp-dissect-file-name default-directory)
3186 'tramp-remote-shell)
3187 (tramp-get-method-parameter
3188 (tramp-dissect-file-name default-directory)
3189 'tramp-remote-shell-args))
3190 (list (substring command 0 asynchronous))))
3191 current-buffer-p
3192 (output-buffer
3193 (cond
3194 ((bufferp output-buffer) output-buffer)
3195 ((stringp output-buffer) (get-buffer-create output-buffer))
3196 (output-buffer
3197 (setq current-buffer-p t)
3198 (current-buffer))
3199 (t (get-buffer-create
3200 (if asynchronous
3201 "*Async Shell Command*"
3202 "*Shell Command Output*")))))
3203 (error-buffer
3204 (cond
3205 ((bufferp error-buffer) error-buffer)
3206 ((stringp error-buffer) (get-buffer-create error-buffer))))
3207 (buffer
3208 (if (and (not asynchronous) error-buffer)
3209 (with-parsed-tramp-file-name default-directory nil
3210 (list output-buffer (tramp-make-tramp-temp-file v)))
3211 output-buffer))
3212 (p (get-buffer-process output-buffer)))
3214 ;; Check whether there is another process running. Tramp does not
3215 ;; support 2 (asynchronous) processes in parallel.
3216 (when p
3217 (if (yes-or-no-p "A command is running. Kill it? ")
3218 (ignore-errors (kill-process p))
3219 (tramp-user-error p "Shell command in progress")))
3221 (if current-buffer-p
3222 (progn
3223 (barf-if-buffer-read-only)
3224 (push-mark nil t))
3225 (with-current-buffer output-buffer
3226 (setq buffer-read-only nil)
3227 (erase-buffer)))
3229 (if (and (not current-buffer-p) (integerp asynchronous))
3230 (prog1
3231 ;; Run the process.
3232 (setq p (apply 'start-file-process "*Async Shell*" buffer args))
3233 ;; Display output.
3234 (with-current-buffer output-buffer
3235 (display-buffer output-buffer '(nil (allow-no-window . t)))
3236 (setq mode-line-process '(":%s"))
3237 (shell-mode)
3238 (set-process-sentinel p 'shell-command-sentinel)
3239 (set-process-filter p 'comint-output-filter)))
3241 (prog1
3242 ;; Run the process.
3243 (apply 'process-file (car args) nil buffer nil (cdr args))
3244 ;; Insert error messages if they were separated.
3245 (when (listp buffer)
3246 (with-current-buffer error-buffer
3247 (insert-file-contents (cadr buffer)))
3248 (delete-file (cadr buffer)))
3249 (if current-buffer-p
3250 ;; This is like exchange-point-and-mark, but doesn't
3251 ;; activate the mark. It is cleaner to avoid activation,
3252 ;; even though the command loop would deactivate the mark
3253 ;; because we inserted text.
3254 (goto-char (prog1 (mark t)
3255 (set-marker (mark-marker) (point)
3256 (current-buffer))))
3257 ;; There's some output, display it.
3258 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3259 (display-message-or-buffer output-buffer)))))))
3261 (defun tramp-handle-substitute-in-file-name (filename)
3262 "Like `substitute-in-file-name' for Tramp files.
3263 \"//\" and \"/~\" substitute only in the local filename part."
3264 ;; First, we must replace environment variables.
3265 (setq filename (tramp-replace-environment-variables filename))
3266 (with-parsed-tramp-file-name filename nil
3267 ;; Ignore in LOCALNAME everything before "//" or "/~".
3268 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3269 (setq filename
3270 (concat (file-remote-p filename)
3271 (replace-match "\\1" nil nil localname)))
3272 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3273 (when (string-match "~$" filename)
3274 (setq filename (concat filename "/"))))
3275 ;; We do not want to replace environment variables, again.
3276 (let (process-environment)
3277 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3279 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
3280 "Like `set-visited-file-modtime' for Tramp files."
3281 (unless (buffer-file-name)
3282 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
3283 (buffer-name)))
3284 (unless time-list
3285 (let ((remote-file-name-inhibit-cache t))
3286 ;; '(-1 65535) means file doesn't exists yet.
3287 (setq time-list
3288 (or (tramp-compat-file-attribute-modification-time
3289 (file-attributes (buffer-file-name)))
3290 '(-1 65535)))))
3291 ;; We use '(0 0) as a don't-know value.
3292 (unless (equal time-list '(0 0))
3293 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))))
3295 (defun tramp-handle-verify-visited-file-modtime (&optional buf)
3296 "Like `verify-visited-file-modtime' for Tramp files.
3297 At the time `verify-visited-file-modtime' calls this function, we
3298 already know that the buffer is visiting a file and that
3299 `visited-file-modtime' does not return 0. Do not call this
3300 function directly, unless those two cases are already taken care
3301 of."
3302 (with-current-buffer (or buf (current-buffer))
3303 (let ((f (buffer-file-name)))
3304 ;; There is no file visiting the buffer, or the buffer has no
3305 ;; recorded last modification time, or there is no established
3306 ;; connection.
3307 (if (or (not f)
3308 (eq (visited-file-modtime) 0)
3309 (not (file-remote-p f nil 'connected)))
3311 (with-parsed-tramp-file-name f nil
3312 (let* ((remote-file-name-inhibit-cache t)
3313 (attr (file-attributes f))
3314 (modtime (tramp-compat-file-attribute-modification-time attr))
3315 (mt (visited-file-modtime)))
3317 (cond
3318 ;; File exists, and has a known modtime.
3319 ((and attr (not (equal modtime '(0 0))))
3320 (< (abs (tramp-time-diff
3321 modtime
3322 ;; For compatibility, deal with both the old
3323 ;; (HIGH . LOW) and the new (HIGH LOW) return
3324 ;; values of `visited-file-modtime'.
3325 (if (atom (cdr mt))
3326 (list (car mt) (cdr mt))
3327 mt)))
3329 ;; Modtime has the don't know value.
3330 (attr t)
3331 ;; If file does not exist, say it is not modified if and
3332 ;; only if that agrees with the buffer's record.
3333 (t (equal mt '(-1 65535))))))))))
3335 (defun tramp-handle-file-notify-add-watch (filename _flags _callback)
3336 "Like `file-notify-add-watch' for Tramp files."
3337 ;; This is the default handler. tramp-gvfs.el and tramp-sh.el have
3338 ;; their own one.
3339 (setq filename (expand-file-name filename))
3340 (with-parsed-tramp-file-name filename nil
3341 (tramp-error
3342 v 'file-notify-error "File notification not supported for `%s'" filename)))
3344 (defun tramp-handle-file-notify-rm-watch (proc)
3345 "Like `file-notify-rm-watch' for Tramp files."
3346 ;; The descriptor must be a process object.
3347 (unless (processp proc)
3348 (tramp-error proc 'file-notify-error "Not a valid descriptor %S" proc))
3349 (tramp-message proc 6 "Kill %S" proc)
3350 (delete-process proc))
3352 (defun tramp-handle-file-notify-valid-p (proc)
3353 "Like `file-notify-valid-p' for Tramp files."
3354 (and (tramp-compat-process-live-p proc)
3355 ;; Sometimes, the process is still in status `run' when the
3356 ;; file or directory to be watched is deleted already.
3357 (with-current-buffer (process-buffer proc)
3358 (file-exists-p
3359 (concat (file-remote-p default-directory)
3360 (process-get proc 'watch-name))))))
3362 ;;; Functions for establishing connection:
3364 ;; The following functions are actions to be taken when seeing certain
3365 ;; prompts from the remote host. See the variable
3366 ;; `tramp-actions-before-shell' for usage of these functions.
3368 (defun tramp-action-login (_proc vec)
3369 "Send the login name."
3370 (when (not (stringp tramp-current-user))
3371 (setq tramp-current-user
3372 (with-tramp-connection-property vec "login-as"
3373 (save-window-excursion
3374 (let ((enable-recursive-minibuffers t))
3375 (pop-to-buffer (tramp-get-connection-buffer vec))
3376 (read-string (match-string 0)))))))
3377 (with-current-buffer (tramp-get-connection-buffer vec)
3378 (tramp-message vec 6 "\n%s" (buffer-string)))
3379 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
3380 (tramp-send-string vec (concat tramp-current-user tramp-local-end-of-line)))
3382 (defun tramp-action-password (proc vec)
3383 "Query the user for a password."
3384 (with-current-buffer (process-buffer proc)
3385 (let ((enable-recursive-minibuffers t)
3386 (case-fold-search t))
3387 ;; Let's check whether a wrong password has been sent already.
3388 ;; Sometimes, the process returns a new password request
3389 ;; immediately after rejecting the previous (wrong) one.
3390 (unless (tramp-get-connection-property vec "first-password-request" nil)
3391 (tramp-clear-passwd vec))
3392 (goto-char (point-min))
3393 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
3394 (tramp-message vec 3 "Sending %s" (match-string 1))
3395 ;; We don't call `tramp-send-string' in order to hide the
3396 ;; password from the debug buffer.
3397 (process-send-string
3398 proc (concat (tramp-read-passwd proc) tramp-local-end-of-line))
3399 ;; Hide password prompt.
3400 (narrow-to-region (point-max) (point-max)))))
3402 (defun tramp-action-succeed (_proc _vec)
3403 "Signal success in finding shell prompt."
3404 (throw 'tramp-action 'ok))
3406 (defun tramp-action-permission-denied (proc _vec)
3407 "Signal permission denied."
3408 (kill-process proc)
3409 (throw 'tramp-action 'permission-denied))
3411 (defun tramp-action-yesno (proc vec)
3412 "Ask the user for confirmation using `yes-or-no-p'.
3413 Send \"yes\" to remote process on confirmation, abort otherwise.
3414 See also `tramp-action-yn'."
3415 (save-window-excursion
3416 (let ((enable-recursive-minibuffers t))
3417 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3418 (unless (yes-or-no-p (match-string 0))
3419 (kill-process proc)
3420 (throw 'tramp-action 'permission-denied))
3421 (with-current-buffer (tramp-get-connection-buffer vec)
3422 (tramp-message vec 6 "\n%s" (buffer-string)))
3423 (tramp-send-string vec (concat "yes" tramp-local-end-of-line)))))
3425 (defun tramp-action-yn (proc vec)
3426 "Ask the user for confirmation using `y-or-n-p'.
3427 Send \"y\" to remote process on confirmation, abort otherwise.
3428 See also `tramp-action-yesno'."
3429 (save-window-excursion
3430 (let ((enable-recursive-minibuffers t))
3431 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
3432 (unless (y-or-n-p (match-string 0))
3433 (kill-process proc)
3434 (throw 'tramp-action 'permission-denied))
3435 (with-current-buffer (tramp-get-connection-buffer vec)
3436 (tramp-message vec 6 "\n%s" (buffer-string)))
3437 (tramp-send-string vec (concat "y" tramp-local-end-of-line)))))
3439 (defun tramp-action-terminal (_proc vec)
3440 "Tell the remote host which terminal type to use.
3441 The terminal type can be configured with `tramp-terminal-type'."
3442 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
3443 (with-current-buffer (tramp-get-connection-buffer vec)
3444 (tramp-message vec 6 "\n%s" (buffer-string)))
3445 (tramp-send-string vec (concat tramp-terminal-type tramp-local-end-of-line)))
3447 (defun tramp-action-process-alive (proc _vec)
3448 "Check, whether a process has finished."
3449 (unless (tramp-compat-process-live-p proc)
3450 (throw 'tramp-action 'process-died)))
3452 (defun tramp-action-out-of-band (proc vec)
3453 "Check, whether an out-of-band copy has finished."
3454 ;; There might be pending output for the exit status.
3455 (tramp-accept-process-output proc 0.1)
3456 (cond ((and (not (tramp-compat-process-live-p proc))
3457 (zerop (process-exit-status proc)))
3458 (tramp-message vec 3 "Process has finished.")
3459 (throw 'tramp-action 'ok))
3460 ((or (and (memq (process-status proc) '(stop exit))
3461 (not (zerop (process-exit-status proc))))
3462 (memq (process-status proc) '(signal)))
3463 ;; `scp' could have copied correctly, but set modes could have failed.
3464 ;; This can be ignored.
3465 (with-current-buffer (process-buffer proc)
3466 (goto-char (point-min))
3467 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
3468 (progn
3469 (tramp-message vec 5 "'set mode' error ignored.")
3470 (tramp-message vec 3 "Process has finished.")
3471 (throw 'tramp-action 'ok))
3472 (tramp-message vec 3 "Process has died.")
3473 (throw 'tramp-action 'out-of-band-failed))))
3474 (t nil)))
3476 ;;; Functions for processing the actions:
3478 (defun tramp-process-one-action (proc vec actions)
3479 "Wait for output from the shell and perform one action."
3480 (let ((case-fold-search t)
3481 found todo item pattern action)
3482 (while (not found)
3483 ;; Reread output once all actions have been performed.
3484 ;; Obviously, the output was not complete.
3485 (tramp-accept-process-output proc 1)
3486 (setq todo actions)
3487 (while todo
3488 (setq item (pop todo))
3489 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
3490 (setq action (nth 1 item))
3491 (tramp-message
3492 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
3493 (when (tramp-check-for-regexp proc pattern)
3494 (tramp-message vec 5 "Call `%s'" (symbol-name action))
3495 (setq found (funcall action proc vec)))))
3496 found))
3498 (defun tramp-process-actions (proc vec pos actions &optional timeout)
3499 "Perform ACTIONS until success or TIMEOUT.
3500 PROC and VEC indicate the remote connection to be used. POS, if
3501 set, is the starting point of the region to be deleted in the
3502 connection buffer."
3503 ;; Enable `auth-source'. We must use tramp-current-* variables in
3504 ;; case we have several hops.
3505 (tramp-set-connection-property
3506 (tramp-dissect-file-name
3507 (tramp-make-tramp-file-name
3508 tramp-current-method tramp-current-user tramp-current-host ""))
3509 "first-password-request" t)
3510 (save-restriction
3511 (with-tramp-progress-reporter
3512 proc 3 "Waiting for prompts from remote shell"
3513 (let (exit)
3514 (if timeout
3515 (with-timeout (timeout (setq exit 'timeout))
3516 (while (not exit)
3517 (setq exit
3518 (catch 'tramp-action
3519 (tramp-process-one-action proc vec actions)))))
3520 (while (not exit)
3521 (setq exit
3522 (catch 'tramp-action
3523 (tramp-process-one-action proc vec actions)))))
3524 (with-current-buffer (tramp-get-connection-buffer vec)
3525 (widen)
3526 (tramp-message vec 6 "\n%s" (buffer-string)))
3527 (unless (eq exit 'ok)
3528 (tramp-clear-passwd vec)
3529 (delete-process proc)
3530 (tramp-error-with-buffer
3531 (tramp-get-connection-buffer vec) vec 'file-error
3532 (cond
3533 ((eq exit 'permission-denied) "Permission denied")
3534 ((eq exit 'out-of-band-failed)
3535 (format-message
3536 "Copy failed, see buffer `%s' for details"
3537 (tramp-get-connection-buffer vec)))
3538 ((eq exit 'process-died)
3539 (substitute-command-keys
3540 (concat
3541 "Tramp failed to connect. If this happens repeatedly, try\n"
3542 " `\\[tramp-cleanup-this-connection]'")))
3543 ((eq exit 'timeout)
3544 (format-message
3545 "Timeout reached, see buffer `%s' for details"
3546 (tramp-get-connection-buffer vec)))
3547 (t "Login failed")))))
3548 (when (numberp pos)
3549 (with-current-buffer (tramp-get-connection-buffer vec)
3550 (let (buffer-read-only) (delete-region pos (point))))))))
3552 ;;; Utility functions:
3554 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
3555 "Like `accept-process-output' for Tramp processes.
3556 This is needed in order to hide `last-coding-system-used', which is set
3557 for process communication also."
3558 (with-current-buffer (process-buffer proc)
3559 ;; FIXME: If there is a gateway process, we need communication
3560 ;; between several processes. Too complicate to implement, so we
3561 ;; read output from all processes.
3562 (let ((p (if (tramp-get-connection-property proc "gateway" nil) nil proc))
3563 buffer-read-only last-coding-system-used)
3564 ;; Under Windows XP, accept-process-output doesn't return
3565 ;; sometimes. So we add an additional timeout.
3566 (with-timeout ((or timeout 1))
3567 (accept-process-output p timeout timeout-msecs (and proc t)))
3568 (tramp-message proc 10 "%s %s %s\n%s"
3569 proc (process-status proc) p (buffer-string)))))
3571 (defun tramp-check-for-regexp (proc regexp)
3572 "Check, whether REGEXP is contained in process buffer of PROC.
3573 Erase echoed commands if exists."
3574 (with-current-buffer (process-buffer proc)
3575 (goto-char (point-min))
3577 ;; Check whether we need to remove echo output.
3578 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
3579 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
3580 (let ((begin (match-beginning 0)))
3581 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
3582 ;; Discard echo from remote output.
3583 (tramp-set-connection-property proc "check-remote-echo" nil)
3584 (tramp-message proc 5 "echo-mark found")
3585 (forward-line 1)
3586 (delete-region begin (point))
3587 (goto-char (point-min)))))
3589 (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil))
3590 ;; Sometimes, the echo string is suppressed on the remote side.
3591 (not (string-equal
3592 (substring-no-properties
3593 tramp-echo-mark-marker
3594 0 (min tramp-echo-mark-marker-length (1- (point-max))))
3595 (buffer-substring-no-properties
3596 (point-min)
3597 (min (+ (point-min) tramp-echo-mark-marker-length)
3598 (point-max))))))
3599 ;; No echo to be handled, now we can look for the regexp.
3600 ;; Sometimes, lines are much to long, and we run into a "Stack
3601 ;; overflow in regexp matcher". For example, //DIRED// lines of
3602 ;; directory listings with some thousand files. Therefore, we
3603 ;; look from the end.
3604 (goto-char (point-max))
3605 (ignore-errors (re-search-backward regexp nil t)))))
3607 (defun tramp-wait-for-regexp (proc timeout regexp)
3608 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
3609 Expects the output of PROC to be sent to the current buffer. Returns
3610 the string that matched, or nil. Waits indefinitely if TIMEOUT is
3611 nil."
3612 (with-current-buffer (process-buffer proc)
3613 (let ((found (tramp-check-for-regexp proc regexp)))
3614 (cond (timeout
3615 (with-timeout (timeout)
3616 (while (not found)
3617 (tramp-accept-process-output proc 1)
3618 (unless (tramp-compat-process-live-p proc)
3619 (tramp-error-with-buffer
3620 nil proc 'file-error "Process has died"))
3621 (setq found (tramp-check-for-regexp proc regexp)))))
3623 (while (not found)
3624 (tramp-accept-process-output proc 1)
3625 (unless (tramp-compat-process-live-p proc)
3626 (tramp-error-with-buffer
3627 nil proc 'file-error "Process has died"))
3628 (setq found (tramp-check-for-regexp proc regexp)))))
3629 (tramp-message proc 6 "\n%s" (buffer-string))
3630 (when (not found)
3631 (if timeout
3632 (tramp-error
3633 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
3634 regexp timeout)
3635 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
3636 found)))
3638 ;; It seems that Tru64 Unix does not like it if long strings are sent
3639 ;; to it in one go. (This happens when sending the Perl
3640 ;; `file-attributes' implementation, for instance.) Therefore, we
3641 ;; have this function which sends the string in chunks.
3642 (defun tramp-send-string (vec string)
3643 "Send the STRING via connection VEC.
3645 The STRING is expected to use Unix line-endings, but the lines sent to
3646 the remote host use line-endings as defined in the variable
3647 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
3648 (let* ((p (tramp-get-connection-process vec))
3649 (chunksize (tramp-get-connection-property p "chunksize" nil)))
3650 (unless p
3651 (tramp-error
3652 vec 'file-error "Can't send string to remote host -- not logged in"))
3653 (tramp-set-connection-property p "last-cmd-time" (current-time))
3654 (tramp-message vec 10 "%s" string)
3655 (with-current-buffer (tramp-get-connection-buffer vec)
3656 ;; Clean up the buffer. We cannot call `erase-buffer' because
3657 ;; narrowing might be in effect.
3658 (let (buffer-read-only) (delete-region (point-min) (point-max)))
3659 ;; Replace "\n" by `tramp-rsh-end-of-line'.
3660 (setq string
3661 (mapconcat
3662 'identity (split-string string "\n") tramp-rsh-end-of-line))
3663 (unless (or (string= string "")
3664 (string-equal (substring string -1) tramp-rsh-end-of-line))
3665 (setq string (concat string tramp-rsh-end-of-line)))
3666 ;; Send the string.
3667 (if (and chunksize (not (zerop chunksize)))
3668 (let ((pos 0)
3669 (end (length string)))
3670 (while (< pos end)
3671 (tramp-message
3672 vec 10 "Sending chunk from %s to %s"
3673 pos (min (+ pos chunksize) end))
3674 (process-send-string
3675 p (substring string pos (min (+ pos chunksize) end)))
3676 (setq pos (+ pos chunksize))))
3677 (process-send-string p string)))))
3679 (defun tramp-get-inode (vec)
3680 "Returns the virtual inode number.
3681 If it doesn't exist, generate a new one."
3682 (with-tramp-file-property vec (tramp-file-name-localname vec) "inode"
3683 (setq tramp-inodes (1+ tramp-inodes))))
3685 (defun tramp-get-device (vec)
3686 "Returns the virtual device number.
3687 If it doesn't exist, generate a new one."
3688 (with-tramp-connection-property (tramp-get-connection-process vec) "device"
3689 (cons -1 (setq tramp-devices (1+ tramp-devices)))))
3691 (defun tramp-equal-remote (file1 file2)
3692 "Check, whether the remote parts of FILE1 and FILE2 are identical.
3693 The check depends on method, user and host name of the files. If
3694 one of the components is missing, the default values are used.
3695 The local file name parts of FILE1 and FILE2 are not taken into
3696 account.
3698 Example:
3700 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
3702 would yield t. On the other hand, the following check results in nil:
3704 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
3705 (and (tramp-tramp-file-p file1)
3706 (tramp-tramp-file-p file2)
3707 (string-equal (file-remote-p file1) (file-remote-p file2))))
3709 ;;;###tramp-autoload
3710 (defun tramp-mode-string-to-int (mode-string)
3711 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
3712 (let* (case-fold-search
3713 (mode-chars (string-to-vector mode-string))
3714 (owner-read (aref mode-chars 1))
3715 (owner-write (aref mode-chars 2))
3716 (owner-execute-or-setid (aref mode-chars 3))
3717 (group-read (aref mode-chars 4))
3718 (group-write (aref mode-chars 5))
3719 (group-execute-or-setid (aref mode-chars 6))
3720 (other-read (aref mode-chars 7))
3721 (other-write (aref mode-chars 8))
3722 (other-execute-or-sticky (aref mode-chars 9)))
3723 (save-match-data
3724 (logior
3725 (cond
3726 ((char-equal owner-read ?r) (string-to-number "00400" 8))
3727 ((char-equal owner-read ?-) 0)
3728 (t (error "Second char `%c' must be one of `r-'" owner-read)))
3729 (cond
3730 ((char-equal owner-write ?w) (string-to-number "00200" 8))
3731 ((char-equal owner-write ?-) 0)
3732 (t (error "Third char `%c' must be one of `w-'" owner-write)))
3733 (cond
3734 ((char-equal owner-execute-or-setid ?x) (string-to-number "00100" 8))
3735 ((char-equal owner-execute-or-setid ?S) (string-to-number "04000" 8))
3736 ((char-equal owner-execute-or-setid ?s) (string-to-number "04100" 8))
3737 ((char-equal owner-execute-or-setid ?-) 0)
3738 (t (error "Fourth char `%c' must be one of `xsS-'"
3739 owner-execute-or-setid)))
3740 (cond
3741 ((char-equal group-read ?r) (string-to-number "00040" 8))
3742 ((char-equal group-read ?-) 0)
3743 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
3744 (cond
3745 ((char-equal group-write ?w) (string-to-number "00020" 8))
3746 ((char-equal group-write ?-) 0)
3747 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
3748 (cond
3749 ((char-equal group-execute-or-setid ?x) (string-to-number "00010" 8))
3750 ((char-equal group-execute-or-setid ?S) (string-to-number "02000" 8))
3751 ((char-equal group-execute-or-setid ?s) (string-to-number "02010" 8))
3752 ((char-equal group-execute-or-setid ?-) 0)
3753 (t (error "Seventh char `%c' must be one of `xsS-'"
3754 group-execute-or-setid)))
3755 (cond
3756 ((char-equal other-read ?r) (string-to-number "00004" 8))
3757 ((char-equal other-read ?-) 0)
3758 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
3759 (cond
3760 ((char-equal other-write ?w) (string-to-number "00002" 8))
3761 ((char-equal other-write ?-) 0)
3762 (t (error "Ninth char `%c' must be one of `w-'" other-write)))
3763 (cond
3764 ((char-equal other-execute-or-sticky ?x) (string-to-number "00001" 8))
3765 ((char-equal other-execute-or-sticky ?T) (string-to-number "01000" 8))
3766 ((char-equal other-execute-or-sticky ?t) (string-to-number "01001" 8))
3767 ((char-equal other-execute-or-sticky ?-) 0)
3768 (t (error "Tenth char `%c' must be one of `xtT-'"
3769 other-execute-or-sticky)))))))
3771 (defconst tramp-file-mode-type-map
3772 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
3773 (1 . "p") ; fifo
3774 (2 . "c") ; character device
3775 (3 . "m") ; multiplexed character device (v7)
3776 (4 . "d") ; directory
3777 (5 . "?") ; Named special file (XENIX)
3778 (6 . "b") ; block device
3779 (7 . "?") ; multiplexed block device (v7)
3780 (8 . "-") ; regular file
3781 (9 . "n") ; network special file (HP-UX)
3782 (10 . "l") ; symlink
3783 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
3784 (12 . "s") ; socket
3785 (13 . "D") ; door special (Solaris)
3786 (14 . "w")) ; whiteout (BSD)
3787 "A list of file types returned from the `stat' system call.
3788 This is used to map a mode number to a permission string.")
3790 ;;;###tramp-autoload
3791 (defun tramp-file-mode-from-int (mode)
3792 "Turn an integer representing a file mode into an ls(1)-like string."
3793 (let ((type (cdr
3794 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
3795 (user (logand (lsh mode -6) 7))
3796 (group (logand (lsh mode -3) 7))
3797 (other (logand (lsh mode -0) 7))
3798 (suid (> (logand (lsh mode -9) 4) 0))
3799 (sgid (> (logand (lsh mode -9) 2) 0))
3800 (sticky (> (logand (lsh mode -9) 1) 0)))
3801 (setq user (tramp-file-mode-permissions user suid "s"))
3802 (setq group (tramp-file-mode-permissions group sgid "s"))
3803 (setq other (tramp-file-mode-permissions other sticky "t"))
3804 (concat type user group other)))
3806 (defun tramp-file-mode-permissions (perm suid suid-text)
3807 "Convert a permission bitset into a string.
3808 This is used internally by `tramp-file-mode-from-int'."
3809 (let ((r (> (logand perm 4) 0))
3810 (w (> (logand perm 2) 0))
3811 (x (> (logand perm 1) 0)))
3812 (concat (or (and r "r") "-")
3813 (or (and w "w") "-")
3814 (or (and suid x suid-text) ; suid, execute
3815 (and suid (upcase suid-text)) ; suid, !execute
3816 (and x "x") "-")))) ; !suid
3818 ;;;###tramp-autoload
3819 (defun tramp-get-local-uid (id-format)
3820 "The uid of the local user, in ID-FORMAT.
3821 ID-FORMAT valid values are `string' and `integer'."
3822 (if (equal id-format 'integer) (user-uid) (user-login-name)))
3824 ;;;###tramp-autoload
3825 (defun tramp-get-local-gid (id-format)
3826 "The gid of the local user, in ID-FORMAT.
3827 ID-FORMAT valid values are `string' and `integer'."
3828 ;; `group-gid' has been introduced with Emacs 24.4.
3829 (if (and (fboundp 'group-gid) (equal id-format 'integer))
3830 (tramp-compat-funcall 'group-gid)
3831 (tramp-compat-file-attribute-group-id (file-attributes "~/" id-format))))
3833 (defun tramp-get-local-locale (&optional vec)
3834 "Determine locale, supporting UTF8 if possible.
3835 VEC is used for tracing."
3836 ;; We use key nil for local connection properties.
3837 (with-tramp-connection-property nil "locale"
3838 (let ((candidates '("en_US.utf8" "C.utf8" "en_US.UTF-8"))
3839 locale)
3840 (with-temp-buffer
3841 (unless (or (memq system-type '(windows-nt))
3842 (not (zerop (tramp-call-process
3843 nil "locale" nil t nil "-a"))))
3844 (while candidates
3845 (goto-char (point-min))
3846 (if (string-match (format "^%s\r?$" (regexp-quote (car candidates)))
3847 (buffer-string))
3848 (setq locale (car candidates)
3849 candidates nil)
3850 (setq candidates (cdr candidates))))))
3851 ;; Return value.
3852 (when vec (tramp-message vec 7 "locale %s" (or locale "C")))
3853 (or locale "C"))))
3855 ;;;###tramp-autoload
3856 (defun tramp-check-cached-permissions (vec access)
3857 "Check `file-attributes' caches for VEC.
3858 Return t if according to the cache access type ACCESS is known to
3859 be granted."
3860 (let ((result nil)
3861 (offset (cond
3862 ((eq ?r access) 1)
3863 ((eq ?w access) 2)
3864 ((eq ?x access) 3))))
3865 (dolist (suffix '("string" "integer") result)
3866 (setq
3867 result
3869 result
3870 (let ((file-attr
3872 (tramp-get-file-property
3873 vec (tramp-file-name-localname vec)
3874 (concat "file-attributes-" suffix) nil)
3875 (file-attributes
3876 (tramp-make-tramp-file-name
3877 (tramp-file-name-method vec)
3878 (tramp-file-name-user vec)
3879 (tramp-file-name-host vec)
3880 (tramp-file-name-localname vec)
3881 (tramp-file-name-hop vec))
3882 (intern suffix))))
3883 (remote-uid
3884 (tramp-get-connection-property
3885 vec (concat "uid-" suffix) nil))
3886 (remote-gid
3887 (tramp-get-connection-property
3888 vec (concat "gid-" suffix) nil))
3889 (unknown-id
3890 (if (string-equal suffix "string")
3891 tramp-unknown-id-string tramp-unknown-id-integer)))
3892 (and
3893 file-attr
3895 ;; Not a symlink.
3896 (eq t (tramp-compat-file-attribute-type file-attr))
3897 (null (tramp-compat-file-attribute-type file-attr)))
3899 ;; World accessible.
3900 (eq access
3901 (aref (tramp-compat-file-attribute-modes file-attr)
3902 (+ offset 6)))
3903 ;; User accessible and owned by user.
3904 (and
3905 (eq access
3906 (aref (tramp-compat-file-attribute-modes file-attr) offset))
3907 (or (equal remote-uid
3908 (tramp-compat-file-attribute-user-id file-attr))
3909 (equal unknown-id
3910 (tramp-compat-file-attribute-user-id file-attr))))
3911 ;; Group accessible and owned by user's principal group.
3912 (and
3913 (eq access
3914 (aref (tramp-compat-file-attribute-modes file-attr)
3915 (+ offset 3)))
3916 (or (equal remote-gid
3917 (tramp-compat-file-attribute-group-id file-attr))
3918 (equal unknown-id
3919 (tramp-compat-file-attribute-group-id
3920 file-attr))))))))))))
3922 ;;;###tramp-autoload
3923 (defun tramp-local-host-p (vec)
3924 "Return t if this points to the local host, nil otherwise."
3925 ;; We cannot use `tramp-file-name-real-host'. A port is an
3926 ;; indication for an ssh tunnel or alike.
3927 (let ((host (tramp-file-name-host vec)))
3928 (and
3929 (stringp host)
3930 (string-match tramp-local-host-regexp host)
3931 ;; The method shall be applied to one of the shell file name
3932 ;; handlers. `tramp-local-host-p' is also called for "smb" and
3933 ;; alike, where it must fail.
3934 (tramp-get-method-parameter vec 'tramp-login-program)
3935 ;; The local temp directory must be writable for the other user.
3936 (file-writable-p
3937 (tramp-make-tramp-file-name
3938 (tramp-file-name-method vec)
3939 (tramp-file-name-user vec)
3940 host
3941 (tramp-compat-temporary-file-directory)))
3942 ;; On some systems, chown runs only for root.
3943 (or (zerop (user-uid))
3944 ;; This is defined in tramp-sh.el. Let's assume this is
3945 ;; loaded already.
3946 (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer))))))
3948 (defun tramp-get-remote-tmpdir (vec)
3949 "Return directory for temporary files on the remote host identified by VEC."
3950 (let ((dir (tramp-make-tramp-file-name
3951 (tramp-file-name-method vec)
3952 (tramp-file-name-user vec)
3953 (tramp-file-name-host vec)
3954 (or (tramp-get-method-parameter vec 'tramp-tmpdir) "/tmp"))))
3955 (with-tramp-connection-property vec "tmpdir"
3956 (or (and (file-directory-p dir) (file-writable-p dir)
3957 (file-remote-p dir 'localname))
3958 (tramp-error vec 'file-error "Directory %s not accessible" dir)))
3959 dir))
3961 ;;;###tramp-autoload
3962 (defun tramp-make-tramp-temp-file (vec)
3963 "Create a temporary file on the remote host identified by VEC.
3964 Return the local name of the temporary file."
3965 (let ((prefix (expand-file-name
3966 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))
3967 result)
3968 (while (not result)
3969 ;; `make-temp-file' would be the natural choice for
3970 ;; implementation. But it calls `write-region' internally,
3971 ;; which also needs a temporary file - we would end in an
3972 ;; infinite loop.
3973 (setq result (make-temp-name prefix))
3974 (if (file-exists-p result)
3975 (setq result nil)
3976 ;; This creates the file by side effect.
3977 (set-file-times result)
3978 (set-file-modes result (string-to-number "0700" 8))))
3980 ;; Return the local part.
3981 (with-parsed-tramp-file-name result nil localname)))
3983 (defun tramp-delete-temp-file-function ()
3984 "Remove temporary files related to current buffer."
3985 (when (stringp tramp-temp-buffer-file-name)
3986 (ignore-errors (delete-file tramp-temp-buffer-file-name))))
3988 (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function)
3989 (add-hook 'tramp-unload-hook
3990 (lambda ()
3991 (remove-hook 'kill-buffer-hook
3992 'tramp-delete-temp-file-function)))
3994 (defun tramp-handle-make-auto-save-file-name ()
3995 "Like `make-auto-save-file-name' for Tramp files.
3996 Returns a file name in `tramp-auto-save-directory' for autosaving
3997 this file, if that variable is non-nil."
3998 (when (stringp tramp-auto-save-directory)
3999 (setq tramp-auto-save-directory
4000 (expand-file-name tramp-auto-save-directory)))
4001 ;; Create directory.
4002 (unless (or (null tramp-auto-save-directory)
4003 (file-exists-p tramp-auto-save-directory))
4004 (make-directory tramp-auto-save-directory t))
4006 (let ((system-type 'not-windows)
4007 (auto-save-file-name-transforms
4008 (if (null tramp-auto-save-directory)
4009 auto-save-file-name-transforms))
4010 (buffer-file-name
4011 (if (null tramp-auto-save-directory)
4012 buffer-file-name
4013 (expand-file-name
4014 (tramp-subst-strs-in-string
4015 '(("_" . "|")
4016 ("/" . "_a")
4017 (":" . "_b")
4018 ("|" . "__")
4019 ("[" . "_l")
4020 ("]" . "_r"))
4021 (buffer-file-name))
4022 tramp-auto-save-directory))))
4023 ;; Run plain `make-auto-save-file-name'.
4024 (tramp-run-real-handler 'make-auto-save-file-name nil)))
4026 (defun tramp-subst-strs-in-string (alist string)
4027 "Replace all occurrences of the string FROM with TO in STRING.
4028 ALIST is of the form ((FROM . TO) ...)."
4029 (save-match-data
4030 (while alist
4031 (let* ((pr (car alist))
4032 (from (car pr))
4033 (to (cdr pr)))
4034 (while (string-match (regexp-quote from) string)
4035 (setq string (replace-match to t t string)))
4036 (setq alist (cdr alist))))
4037 string))
4039 (defun tramp-handle-temporary-file-directory ()
4040 "Like `temporary-file-directory' for Tramp files."
4041 (catch 'result
4042 (dolist (dir `(,(ignore-errors
4043 (tramp-get-remote-tmpdir
4044 (tramp-dissect-file-name default-directory)))
4045 ,default-directory))
4046 (when (and (stringp dir) (file-directory-p dir) (file-writable-p dir))
4047 (throw 'result (expand-file-name dir))))))
4049 (defun tramp-handle-make-nearby-temp-file (prefix &optional dir-flag suffix)
4050 "Like `make-nearby-temp-file' for Tramp files."
4051 (let ((temporary-file-directory
4052 (tramp-compat-temporary-file-directory-function)))
4053 (make-temp-file prefix dir-flag suffix)))
4055 ;;; Compatibility functions section:
4057 (defun tramp-call-process
4058 (vec program &optional infile destination display &rest args)
4059 "Calls `call-process' on the local host.
4060 It always returns a return code. The Lisp error raised when
4061 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
4062 are written with verbosity of 6."
4063 (let ((default-directory (tramp-compat-temporary-file-directory))
4064 (v (or vec
4065 (vector tramp-current-method tramp-current-user
4066 tramp-current-host nil nil)))
4067 (destination (if (eq destination t) (current-buffer) destination))
4068 output error result)
4069 (tramp-message
4070 v 6 "`%s %s' %s %s"
4071 program (mapconcat 'identity args " ") infile destination)
4072 (condition-case err
4073 (with-temp-buffer
4074 (setq result
4075 (apply
4076 'call-process program infile (or destination t) display args))
4077 ;; `result' could also be an error string.
4078 (when (stringp result)
4079 (setq error result
4080 result 1))
4081 (with-current-buffer
4082 (if (bufferp destination) destination (current-buffer))
4083 (setq output (buffer-string))))
4084 (error
4085 (setq error (error-message-string err)
4086 result 1)))
4087 (if (zerop (length error))
4088 (tramp-message v 6 "%d\n%s" result output)
4089 (tramp-message v 6 "%d\n%s\n%s" result output error))
4090 result))
4092 (defun tramp-call-process-region
4093 (vec start end program &optional delete buffer display &rest args)
4094 "Calls `call-process-region' on the local host.
4095 It always returns a return code. The Lisp error raised when
4096 PROGRAM is nil is trapped also, returning 1. Furthermore, traces
4097 are written with verbosity of 6."
4098 (let ((default-directory (tramp-compat-temporary-file-directory))
4099 (v (or vec
4100 (vector tramp-current-method tramp-current-user
4101 tramp-current-host nil nil)))
4102 (buffer (if (eq buffer t) (current-buffer) buffer))
4103 result)
4104 (tramp-message
4105 v 6 "`%s %s' %s %s %s %s"
4106 program (mapconcat 'identity args " ") start end delete buffer)
4107 (condition-case err
4108 (progn
4109 (setq result
4110 (apply
4111 'call-process-region
4112 start end program delete buffer display args))
4113 ;; `result' could also be an error string.
4114 (when (stringp result)
4115 (signal 'file-error (list result)))
4116 (with-current-buffer (if (bufferp buffer) buffer (current-buffer))
4117 (if (zerop result)
4118 (tramp-message v 6 "%d" result)
4119 (tramp-message v 6 "%d\n%s" result (buffer-string)))))
4120 (error
4121 (setq result 1)
4122 (tramp-message v 6 "%d\n%s" result (error-message-string err))))
4123 result))
4125 ;;;###tramp-autoload
4126 (defun tramp-read-passwd (proc &optional prompt)
4127 "Read a password from user (compat function).
4128 Consults the auth-source package.
4129 Invokes `password-read' if available, `read-passwd' else."
4130 (let* ((case-fold-search t)
4131 (key (tramp-make-tramp-file-name
4132 tramp-current-method tramp-current-user
4133 tramp-current-host ""))
4134 (pw-prompt
4135 (or prompt
4136 (with-current-buffer (process-buffer proc)
4137 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
4138 (format "%s for %s " (capitalize (match-string 1)) key))))
4139 ;; We suspend the timers while reading the password.
4140 (stimers (with-timeout-suspend))
4141 auth-info auth-passwd)
4143 (unwind-protect
4144 (with-parsed-tramp-file-name key nil
4145 (prog1
4147 ;; See if auth-sources contains something useful.
4148 ;; `auth-source-user-or-password' is an obsoleted
4149 ;; function since Emacs 24.1, it has been replaced by
4150 ;; `auth-source-search'.
4151 (ignore-errors
4152 (and (tramp-get-connection-property
4153 v "first-password-request" nil)
4154 ;; Try with Tramp's current method.
4155 (if (fboundp 'auth-source-search)
4156 (setq auth-info
4157 (auth-source-search
4158 :max 1
4159 :user (or tramp-current-user t)
4160 :host tramp-current-host
4161 :port tramp-current-method)
4162 auth-passwd (plist-get
4163 (nth 0 auth-info) :secret)
4164 auth-passwd (if (functionp auth-passwd)
4165 (funcall auth-passwd)
4166 auth-passwd))
4167 (tramp-compat-funcall 'auth-source-user-or-password
4168 "password" tramp-current-host tramp-current-method))))
4169 ;; Try the password cache.
4170 (let ((password (password-read pw-prompt key)))
4171 (password-cache-add key password)
4172 password)
4173 ;; Else, get the password interactively.
4174 (read-passwd pw-prompt))
4175 (tramp-set-connection-property v "first-password-request" nil)))
4176 ;; Reenable the timers.
4177 (with-timeout-unsuspend stimers))))
4179 ;;;###tramp-autoload
4180 (defun tramp-clear-passwd (vec)
4181 "Clear password cache for connection related to VEC."
4182 (let ((hop (tramp-file-name-hop vec)))
4183 (when hop
4184 ;; Clear also the passwords of the hops.
4185 (tramp-clear-passwd
4186 (tramp-dissect-file-name
4187 (concat
4188 tramp-prefix-format
4189 (replace-regexp-in-string
4190 (concat tramp-postfix-hop-regexp "$")
4191 tramp-postfix-host-format hop))))))
4192 (password-cache-remove
4193 (tramp-make-tramp-file-name
4194 (tramp-file-name-method vec)
4195 (tramp-file-name-user vec)
4196 (tramp-file-name-host vec)
4197 "")))
4199 ;; Snarfed code from time-date.el and parse-time.el
4201 (defconst tramp-half-a-year '(241 17024)
4202 "Evaluated by \"(days-to-time 183)\".")
4204 (defconst tramp-parse-time-months
4205 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
4206 ("apr" . 4) ("may" . 5) ("jun" . 6)
4207 ("jul" . 7) ("aug" . 8) ("sep" . 9)
4208 ("oct" . 10) ("nov" . 11) ("dec" . 12))
4209 "Alist mapping month names to integers.")
4211 ;;;###tramp-autoload
4212 (defun tramp-time-diff (t1 t2)
4213 "Return the difference between the two times, in seconds.
4214 T1 and T2 are time values (as returned by `current-time' for example)."
4215 ;; Starting with Emacs 25.1, we could change this to use `time-subtract'.
4216 (float-time (tramp-compat-funcall 'subtract-time t1 t2)))
4218 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
4219 ;; does not deal well with newline characters. Newline is replaced by
4220 ;; backslash newline. But if, say, the string `a backslash newline b'
4221 ;; is passed to a shell, the shell will expand this into "ab",
4222 ;; completely omitting the newline. This is not what was intended.
4223 ;; It does not appear to be possible to make the function
4224 ;; `shell-quote-argument' work with newlines without making it
4225 ;; dependent on the shell used. But within this package, we know that
4226 ;; we will always use a Bourne-like shell, so we use an approach which
4227 ;; groks newlines.
4229 ;; The approach is simple: we call `shell-quote-argument', then
4230 ;; massage the newline part of the result.
4232 ;; This function should produce a string which is grokked by a Unix
4233 ;; shell, even if the Emacs is running on Windows. Since this is the
4234 ;; kludges section, we bind `system-type' in such a way that
4235 ;; `shell-quote-argument' behaves as if on Unix.
4237 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
4238 ;; function to work with Bourne-like shells.
4240 ;; CCC: This function should be rewritten so that
4241 ;; `shell-quote-argument' is not used. This way, we are safe from
4242 ;; changes in `shell-quote-argument'.
4243 ;;;###tramp-autoload
4244 (defun tramp-shell-quote-argument (s)
4245 "Similar to `shell-quote-argument', but groks newlines.
4246 Only works for Bourne-like shells."
4247 (let ((system-type 'not-windows))
4248 (save-match-data
4249 (let ((result (shell-quote-argument s))
4250 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
4251 (when (and (>= (length result) 2)
4252 (string= (substring result 0 2) "\\~"))
4253 (setq result (substring result 1)))
4254 (while (string-match nl result)
4255 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
4256 t t result)))
4257 result))))
4259 ;;; Integration of eshell.el:
4261 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
4262 ;; when `default-directory' points to another host.
4263 (defun tramp-eshell-directory-change ()
4264 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
4265 (setq eshell-path-env
4266 (if (tramp-tramp-file-p default-directory)
4267 (with-parsed-tramp-file-name default-directory nil
4268 (mapconcat
4269 'identity
4271 ;; When `tramp-own-remote-path' is in `tramp-remote-path',
4272 ;; the remote path is only set in the session cache.
4273 (tramp-get-connection-property
4274 (tramp-get-connection-process v) "remote-path" nil)
4275 (tramp-get-connection-property v "remote-path" nil))
4276 ":"))
4277 (getenv "PATH"))))
4279 (eval-after-load "esh-util"
4280 '(progn
4281 (tramp-eshell-directory-change)
4282 (add-hook 'eshell-directory-change-hook
4283 'tramp-eshell-directory-change)
4284 (add-hook 'tramp-unload-hook
4285 (lambda ()
4286 (remove-hook 'eshell-directory-change-hook
4287 'tramp-eshell-directory-change)))))
4289 ;; Checklist for `tramp-unload-hook'
4290 ;; - Unload all `tramp-*' packages
4291 ;; - Reset `file-name-handler-alist'
4292 ;; - Cleanup hooks where Tramp functions are in
4293 ;; - Cleanup advised functions
4294 ;; - Cleanup autoloads
4295 ;;;###autoload
4296 (defun tramp-unload-tramp ()
4297 "Discard Tramp from loading remote files."
4298 (interactive)
4299 ;; ange-ftp settings must be enabled.
4300 (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp)
4301 ;; Maybe it's not loaded yet.
4302 (ignore-errors (unload-feature 'tramp 'force)))
4304 (provide 'tramp)
4306 ;;; TODO:
4308 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
4309 ;; by the files in that directory. Add this here.
4311 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
4313 ;; * Better error checking. At least whenever we see something
4314 ;; strange when doing zerop, we should kill the process and start
4315 ;; again. (Greg Stark)
4317 ;; * Implement a general server-local-variable mechanism, as there are
4318 ;; probably other variables that need different values for different
4319 ;; servers too. The user could then configure a variable (such as
4320 ;; tramp-server-local-variable-alist) to define any such variables
4321 ;; that they need to, which would then be let bound as appropriate
4322 ;; in tramp functions. (Jason Rumney)
4324 ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846)
4326 ;; * I was wondering if it would be possible to use tramp even if I'm
4327 ;; actually using sshfs. But when I launch a command I would like
4328 ;; to get it executed on the remote machine where the files really
4329 ;; are. (Andrea Crotti)
4331 ;; * Run emerge on two remote files. Bug is described here:
4332 ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>.
4333 ;; (Bug#6850)
4335 ;; * Use also port to distinguish connections. This is needed for
4336 ;; different hosts sitting behind a single router (distinguished by
4337 ;; different port numbers). (Tzvi Edelman)
4339 ;; * Refactor code from different handlers. Start with
4340 ;; *-process-file. One idea is to generalize `tramp-send-command'
4341 ;; and friends, for most of the handlers this is the major
4342 ;; difference between the different backends. Other handlers but
4343 ;; *-process-file would profit from this as well.
4345 ;;; tramp.el ends here
4347 ;; Local Variables:
4348 ;; mode: Emacs-Lisp
4349 ;; coding: utf-8
4350 ;; End: