1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; (copyright statements below in code to be updated with the above notice)
8 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
9 ;; Michael Albinus <michael.albinus@gmx.de>
10 ;; Keywords: comm, processes
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; This package provides remote file editing, similar to ange-ftp.
30 ;; The difference is that ange-ftp uses FTP to transfer files between
31 ;; the local and the remote host, whereas tramp.el uses a combination
32 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
34 ;; For more detailed instructions, please see the info file.
39 ;; This package only works for Emacs 21.1 and higher, and for XEmacs 21.4
40 ;; and higher. For XEmacs 21, you need the package `fsf-compat' for
41 ;; the `with-timeout' macro.)
43 ;; This version might not work with pre-Emacs 21 VC unless VC is
44 ;; loaded before tramp.el. Could you please test this and tell me about
45 ;; the result? Thanks.
47 ;; Also see the todo list at the bottom of this file.
49 ;; The current version of Tramp can be retrieved from the following URL:
50 ;; http://ftp.gnu.org/gnu/tramp/
52 ;; There's a mailing list for this, as well. Its name is:
53 ;; tramp-devel@gnu.org
54 ;; You can use the Web to subscribe, under the following URL:
55 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
57 ;; For the adventurous, the current development sources are available
58 ;; via CVS. You can find instructions about this at the following URL:
59 ;; http://savannah.gnu.org/projects/tramp/
60 ;; Click on "CVS" in the navigation bar near the top.
62 ;; Don't forget to put on your asbestos longjohns, first!
66 ;; The Tramp version number and bug report address, as prepared by configure.
68 (add-hook 'tramp-unload-hook
70 (when (featurep 'trampver)
71 (unload-feature 'trampver 'force))))
73 (require 'tramp-compat)
74 (add-hook 'tramp-unload-hook
76 (when (featurep 'tramp-compat)
77 (unload-feature 'tramp-compat 'force))))
79 (require 'format-spec) ; from Gnus 5.8, also in tar ball
80 ;; As long as password.el is not part of (X)Emacs, it shouldn't
82 (if (featurep 'xemacs)
83 (load "password" 'noerror)
84 (or (require 'password-cache nil 'noerror)
85 (require 'password nil 'noerror))) ; from No Gnus, also in tar ball
91 (if (featurep 'xemacs)
92 (load "auth-source" 'noerror)
93 (require 'auth-source nil 'noerror)))
95 ;; Requiring 'tramp-cache results in an endless loop.
96 (autoload 'tramp-get-file-property "tramp-cache")
97 (autoload 'tramp-set-file-property "tramp-cache")
98 (autoload 'tramp-flush-file-property "tramp-cache")
99 (autoload 'tramp-flush-directory-property "tramp-cache")
100 (autoload 'tramp-get-connection-property "tramp-cache")
101 (autoload 'tramp-set-connection-property "tramp-cache")
102 (autoload 'tramp-flush-connection-property "tramp-cache")
103 (autoload 'tramp-parse-connection-properties "tramp-cache")
104 (add-hook 'tramp-unload-hook
106 (when (featurep 'tramp-cache)
107 (unload-feature 'tramp-cache 'force))))
109 (autoload 'tramp-uuencode-region "tramp-uu"
110 "Implementation of `uuencode' in Lisp.")
111 (add-hook 'tramp-unload-hook
113 (when (featurep 'tramp-uu)
114 (unload-feature 'tramp-uu 'force))))
116 (autoload 'uudecode-decode-region "uudecode")
118 ;; The following Tramp packages must be loaded after tramp.el, because
119 ;; they require it as well.
120 (eval-after-load "tramp"
125 ;; Tramp interactive commands.
128 ;; Load foreign FTP method.
129 (if (featurep 'xemacs) 'tramp-efs 'tramp-ftp)
131 ;; tramp-smb uses "smbclient" from Samba. Not available
132 ;; under Cygwin and Windows, because they don't offer
133 ;; "smbclient". And even not necessary there, because Emacs
134 ;; supports UNC file names like "//host/share/localname".
135 (unless (memq system-type '(cygwin windows-nt)) 'tramp-smb)
137 ;; Load foreign FISH method.
140 ;; Load gateways. It needs `make-network-process' from Emacs 22.
141 (when (functionp 'make-network-process) 'tramp-gw)))
145 (add-hook 'tramp-unload-hook
147 (when (featurep ,feature)
148 (unload-feature ,feature 'force)))))))
150 ;;; User Customizable Internal Variables:
153 "Edit remote files with a combination of rsh and rcp or similar programs."
157 ;; Maybe we need once a real Tramp mode, with key bindings etc.
159 (defcustom tramp-mode t
160 "*Whether Tramp is enabled.
161 If it is set to nil, all remote file names are used literally."
165 (defcustom tramp-verbose 3
166 "*Verbosity level for Tramp.
167 Any level x includes messages for all levels 1 .. x-1. The levels are
169 0 silent (no tramp messages at all)
172 3 connection to remote hosts (default level)
175 6 sent and received strings
177 8 connection properties
184 (when (boundp 'backup-directory-alist)
185 (defcustom tramp-backup-directory-alist nil
186 "Alist of filename patterns and backup directory names.
187 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
188 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
189 is a local file name, the backup directory is prepended with Tramp file
190 name prefix \(method, user, host\) of file.
192 \(setq tramp-backup-directory-alist backup-directory-alist\)
194 gives the same backup policy for Tramp files on their hosts like the
195 policy for local files."
197 :type '(repeat (cons (regexp :tag "Regexp matching filename")
198 (directory :tag "Backup directory name"))))))
200 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
201 ;; the package "backup-dir" might not be loaded yet.
203 (when (featurep 'xemacs)
204 (defcustom tramp-bkup-backup-directory-info nil
205 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
206 It has the same meaning like `bkup-backup-directory-info' from package
207 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
208 file name, the backup directory is prepended with Tramp file name prefix
209 \(method, user, host\) of file.
211 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
213 gives the same backup policy for Tramp files on their hosts like the
214 policy for local files."
216 (list (regexp :tag "File regexp")
217 (string :tag "Backup Dir")
222 (const search-upward))))
225 (defcustom tramp-auto-save-directory nil
226 "*Put auto-save files in this directory, if set.
227 The idea is to use a local directory so that auto-saving is faster."
229 :type '(choice (const nil) string))
231 (defcustom tramp-encoding-shell
232 (if (memq system-type '(windows-nt))
235 "*Use this program for encoding and decoding commands on the local host.
236 This shell is used to execute the encoding and decoding command on the
237 local host, so if you want to use `~' in those commands, you should
238 choose a shell here which groks tilde expansion. `/bin/sh' normally
239 does not understand tilde expansion.
241 For encoding and deocding, commands like the following are executed:
243 /bin/sh -c COMMAND < INPUT > OUTPUT
245 This variable can be used to change the \"/bin/sh\" part. See the
246 variable `tramp-encoding-command-switch' for the \"-c\" part.
248 Note that this variable is not used for remote commands. There are
249 mechanisms in tramp.el which automatically determine the right shell to
250 use for the remote host."
252 :type '(file :must-match t))
254 (defcustom tramp-encoding-command-switch
255 (if (string-match "cmd\\.exe" tramp-encoding-shell)
258 "*Use this switch together with `tramp-encoding-shell' for local commands.
259 See the variable `tramp-encoding-shell' for more information."
263 (defcustom tramp-copy-size-limit 10240
264 "*The maximum file size where inline copying is preferred over an out-of-the-band copy."
268 (defcustom tramp-terminal-type "dumb"
269 "*Value of TERM environment variable for logging in to remote host.
270 Because Tramp wants to parse the output of the remote shell, it is easily
271 confused by ANSI color escape sequences and suchlike. Often, shell init
272 files conditionalize this setup based on the TERM environment variable."
276 (defvar tramp-methods
277 `(("rcp" (tramp-login-program "rsh")
278 (tramp-login-args (("%h") ("-l" "%u")))
279 (tramp-remote-sh "/bin/sh")
280 (tramp-copy-program "rcp")
281 (tramp-copy-args (("-p" "%k")))
282 (tramp-copy-keep-date t)
283 (tramp-password-end-of-line nil))
284 ("scp" (tramp-login-program "ssh")
285 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
287 (tramp-remote-sh "/bin/sh")
288 (tramp-copy-program "scp")
289 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q")))
290 (tramp-copy-keep-date t)
291 (tramp-password-end-of-line nil)
292 (tramp-gw-args (("-o"
293 "GlobalKnownHostsFile=/dev/null")
294 ("-o" "UserKnownHostsFile=/dev/null")
295 ("-o" "StrictHostKeyChecking=no")))
296 (tramp-default-port 22))
297 ("scp1" (tramp-login-program "ssh")
298 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
300 (tramp-remote-sh "/bin/sh")
301 (tramp-copy-program "scp")
302 (tramp-copy-args (("-1") ("-P" "%p") ("-p" "%k")
304 (tramp-copy-keep-date t)
305 (tramp-password-end-of-line nil)
306 (tramp-gw-args (("-o"
307 "GlobalKnownHostsFile=/dev/null")
308 ("-o" "UserKnownHostsFile=/dev/null")
309 ("-o" "StrictHostKeyChecking=no")))
310 (tramp-default-port 22))
311 ("scp2" (tramp-login-program "ssh")
312 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
314 (tramp-remote-sh "/bin/sh")
315 (tramp-copy-program "scp")
316 (tramp-copy-args (("-2") ("-P" "%p") ("-p" "%k")
318 (tramp-copy-keep-date t)
319 (tramp-password-end-of-line nil)
320 (tramp-gw-args (("-o"
321 "GlobalKnownHostsFile=/dev/null")
322 ("-o" "UserKnownHostsFile=/dev/null")
323 ("-o" "StrictHostKeyChecking=no")))
324 (tramp-default-port 22))
326 (tramp-login-program "ssh1")
327 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
329 (tramp-remote-sh "/bin/sh")
330 (tramp-copy-program "scp1")
331 (tramp-copy-args (("-p" "%k")))
332 (tramp-copy-keep-date t)
333 (tramp-password-end-of-line nil))
335 (tramp-login-program "ssh2")
336 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
338 (tramp-remote-sh "/bin/sh")
339 (tramp-copy-program "scp2")
340 (tramp-copy-args (("-p" "%k")))
341 (tramp-copy-keep-date t)
342 (tramp-password-end-of-line nil))
343 ("sftp" (tramp-login-program "ssh")
344 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
346 (tramp-remote-sh "/bin/sh")
347 (tramp-copy-program "sftp")
348 (tramp-copy-args nil)
349 (tramp-copy-keep-date nil)
350 (tramp-password-end-of-line nil))
351 ("rsync" (tramp-login-program "ssh")
352 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
354 (tramp-remote-sh "/bin/sh")
355 (tramp-copy-program "rsync")
356 (tramp-copy-args (("-e" "ssh") ("-t" "%k")))
357 (tramp-copy-keep-date t)
358 (tramp-password-end-of-line nil))
359 ("remcp" (tramp-login-program "remsh")
360 (tramp-login-args (("%h") ("-l" "%u")))
361 (tramp-remote-sh "/bin/sh")
362 (tramp-copy-program "rcp")
363 (tramp-copy-args (("-p" "%k")))
364 (tramp-copy-keep-date t)
365 (tramp-password-end-of-line nil))
366 ("rsh" (tramp-login-program "rsh")
367 (tramp-login-args (("%h") ("-l" "%u")))
368 (tramp-remote-sh "/bin/sh")
369 (tramp-copy-program nil)
370 (tramp-copy-args nil)
371 (tramp-copy-keep-date nil)
372 (tramp-password-end-of-line nil))
373 ("ssh" (tramp-login-program "ssh")
374 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
376 (tramp-remote-sh "/bin/sh")
377 (tramp-copy-program nil)
378 (tramp-copy-args nil)
379 (tramp-copy-keep-date nil)
380 (tramp-password-end-of-line nil)
381 (tramp-gw-args (("-o"
382 "GlobalKnownHostsFile=/dev/null")
383 ("-o" "UserKnownHostsFile=/dev/null")
384 ("-o" "StrictHostKeyChecking=no")))
385 (tramp-default-port 22))
386 ("ssh1" (tramp-login-program "ssh")
387 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
389 (tramp-remote-sh "/bin/sh")
390 (tramp-copy-program nil)
391 (tramp-copy-args nil)
392 (tramp-copy-keep-date nil)
393 (tramp-password-end-of-line nil)
394 (tramp-gw-args (("-o"
395 "GlobalKnownHostsFile=/dev/null")
396 ("-o" "UserKnownHostsFile=/dev/null")
397 ("-o" "StrictHostKeyChecking=no")))
398 (tramp-default-port 22))
399 ("ssh2" (tramp-login-program "ssh")
400 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
402 (tramp-remote-sh "/bin/sh")
403 (tramp-copy-program nil)
404 (tramp-copy-args nil)
405 (tramp-copy-keep-date nil)
406 (tramp-password-end-of-line nil)
407 (tramp-gw-args (("-o"
408 "GlobalKnownHostsFile=/dev/null")
409 ("-o" "UserKnownHostsFile=/dev/null")
410 ("-o" "StrictHostKeyChecking=no")))
411 (tramp-default-port 22))
413 (tramp-login-program "ssh1")
414 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
416 (tramp-remote-sh "/bin/sh")
417 (tramp-copy-program nil)
418 (tramp-copy-args nil)
419 (tramp-copy-keep-date nil)
420 (tramp-password-end-of-line nil))
422 (tramp-login-program "ssh2")
423 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
425 (tramp-remote-sh "/bin/sh")
426 (tramp-copy-program nil)
427 (tramp-copy-args nil)
428 (tramp-copy-keep-date nil)
429 (tramp-password-end-of-line nil))
430 ("remsh" (tramp-login-program "remsh")
431 (tramp-login-args (("%h") ("-l" "%u")))
432 (tramp-remote-sh "/bin/sh")
433 (tramp-copy-program nil)
434 (tramp-copy-args nil)
435 (tramp-copy-keep-date nil)
436 (tramp-password-end-of-line nil))
438 (tramp-login-program "telnet")
439 (tramp-login-args (("%h") ("%p")))
440 (tramp-remote-sh "/bin/sh")
441 (tramp-copy-program nil)
442 (tramp-copy-args nil)
443 (tramp-copy-keep-date nil)
444 (tramp-password-end-of-line nil)
445 (tramp-default-port 23))
446 ("su" (tramp-login-program "su")
447 (tramp-login-args (("-") ("%u")))
448 (tramp-remote-sh "/bin/sh")
449 (tramp-copy-program nil)
450 (tramp-copy-args nil)
451 (tramp-copy-keep-date nil)
452 (tramp-password-end-of-line nil))
453 ("sudo" (tramp-login-program "sudo")
454 (tramp-login-args (("-u" "%u")
455 ("-s") ("-H") ("-p" "Password:")))
456 (tramp-remote-sh "/bin/sh")
457 (tramp-copy-program nil)
458 (tramp-copy-args nil)
459 (tramp-copy-keep-date nil)
460 (tramp-password-end-of-line nil))
461 ("scpc" (tramp-login-program "ssh")
462 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
463 ("-o" "ControlPath=%t.%%r@%%h:%%p")
464 ("-o" "ControlMaster=yes")
466 (tramp-remote-sh "/bin/sh")
467 (tramp-copy-program "scp")
468 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q")
469 ("-o" "ControlPath=%t.%%r@%%h:%%p")
470 ("-o" "ControlMaster=auto")))
471 (tramp-copy-keep-date t)
472 (tramp-password-end-of-line nil)
473 (tramp-gw-args (("-o"
474 "GlobalKnownHostsFile=/dev/null")
475 ("-o" "UserKnownHostsFile=/dev/null")
476 ("-o" "StrictHostKeyChecking=no")))
477 (tramp-default-port 22))
478 ("scpx" (tramp-login-program "ssh")
479 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
480 ("-e" "none" "-t" "-t" "/bin/sh")))
481 (tramp-remote-sh "/bin/sh")
482 (tramp-copy-program "scp")
483 (tramp-copy-args (("-p" "%k")))
484 (tramp-copy-keep-date t)
485 (tramp-password-end-of-line nil)
486 (tramp-gw-args (("-o"
487 "GlobalKnownHostsFile=/dev/null")
488 ("-o" "UserKnownHostsFile=/dev/null")
489 ("-o" "StrictHostKeyChecking=no")))
490 (tramp-default-port 22))
491 ("sshx" (tramp-login-program "ssh")
492 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
493 ("-e" "none" "-t" "-t" "/bin/sh")))
494 (tramp-remote-sh "/bin/sh")
495 (tramp-copy-program nil)
496 (tramp-copy-args nil)
497 (tramp-copy-keep-date nil)
498 (tramp-password-end-of-line nil)
499 (tramp-gw-args (("-o"
500 "GlobalKnownHostsFile=/dev/null")
501 ("-o" "UserKnownHostsFile=/dev/null")
502 ("-o" "StrictHostKeyChecking=no")))
503 (tramp-default-port 22))
505 (tramp-login-program "krlogin")
506 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
507 (tramp-remote-sh "/bin/sh")
508 (tramp-copy-program nil)
509 (tramp-copy-args nil)
510 (tramp-copy-keep-date nil)
511 (tramp-password-end-of-line nil))
512 ("plink" (tramp-login-program "plink")
513 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
515 (tramp-remote-sh "/bin/sh")
516 (tramp-copy-program nil)
517 (tramp-copy-args nil)
518 (tramp-copy-keep-date nil)
519 (tramp-password-end-of-line "xy") ;see docstring for "xy"
520 (tramp-default-port 22))
522 (tramp-login-program "plink")
523 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
525 (tramp-remote-sh "/bin/sh")
526 (tramp-copy-program nil)
527 (tramp-copy-args nil)
528 (tramp-copy-keep-date nil)
529 (tramp-password-end-of-line "xy") ;see docstring for "xy"
530 (tramp-default-port 22))
532 (tramp-login-program "plink")
533 ;; ("%h") must be a single element, see
534 ;; `tramp-compute-multi-hops'.
535 (tramp-login-args (("-load") ("%h") ("-t")
537 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=$ '"
538 tramp-terminal-type))
540 (tramp-remote-sh "/bin/sh")
541 (tramp-copy-program nil)
542 (tramp-copy-args nil)
543 (tramp-copy-keep-date nil)
544 (tramp-password-end-of-line nil))
545 ("pscp" (tramp-login-program "plink")
546 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
548 (tramp-remote-sh "/bin/sh")
549 (tramp-copy-program "pscp")
550 (tramp-copy-args (("-P" "%p") ("-scp") ("-p" "%k")))
551 (tramp-copy-keep-date t)
552 (tramp-password-end-of-line "xy") ;see docstring for "xy"
553 (tramp-default-port 22))
554 ("psftp" (tramp-login-program "plink")
555 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
557 (tramp-remote-sh "/bin/sh")
558 (tramp-copy-program "pscp")
559 (tramp-copy-args (("-P" "%p") ("-sftp") ("-p" "%k")))
560 (tramp-copy-keep-date t)
561 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
562 ("fcp" (tramp-login-program "fsh")
563 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
564 (tramp-remote-sh "/bin/sh -i")
565 (tramp-copy-program "fcp")
566 (tramp-copy-args (("-p" "%k")))
567 (tramp-copy-keep-date t)
568 (tramp-password-end-of-line nil)))
569 "*Alist of methods for remote files.
570 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
571 Each NAME stands for a remote access method. Each PARAM is a
572 pair of the form (KEY VALUE). The following KEYs are defined:
574 This specifies the Bourne shell to use on the remote host. This
575 MUST be a Bourne-like shell. It is normally not necessary to set
576 this to any value other than \"/bin/sh\": Tramp wants to use a shell
577 which groks tilde expansion, but it can search for it. Also note
578 that \"/bin/sh\" exists on all Unixen, this might not be true for
579 the value that you decide to use. You Have Been Warned.
580 * `tramp-login-program'
581 This specifies the name of the program to use for logging in to the
582 remote host. This may be the name of rsh or a workalike program,
583 or the name of telnet or a workalike, or the name of su or a workalike.
585 This specifies the list of arguments to pass to the above
586 mentioned program. Please note that this is a list of list of arguments,
587 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
588 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
589 There are some patterns: \"%h\" in this list is replaced by the host
590 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
591 port number, and \"%%\" can be used to obtain a literal percent character.
592 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
593 expansion (i.e. no host or no user specified), this list is not used as
594 argument. By this, arguments like (\"-l\" \"%u\") are optional.
595 \"%t\" is replaced by the temporary file name produced with
596 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
597 parameter of a program, if exists.
598 * `tramp-copy-program'
599 This specifies the name of the program to use for remotely copying
600 the file; this might be the absolute filename of rcp or the name of
603 This specifies the list of parameters to pass to the above mentioned
604 program, the hints for `tramp-login-args' also apply here.
605 * `tramp-copy-keep-date'
606 This specifies whether the copying program when the preserves the
607 timestamp of the original file.
608 * `tramp-default-port'
609 The default port of a method is needed in case of gateway connections.
610 Additionally, it is used as indication which method is prepared for
613 As the attribute name says, additional arguments are specified here
614 when a method is applied via a gateway.
615 * `tramp-password-end-of-line'
616 This specifies the string to use for terminating the line after
617 submitting the password. If this method parameter is nil, then the
618 value of the normal variable `tramp-default-password-end-of-line'
619 is used. This parameter is necessary because the \"plink\" program
620 requires any two characters after sending the password. These do
621 not have to be newline or carriage return characters. Other login
622 programs are happy with just one character, the newline character.
623 We use \"xy\" as the value for methods using \"plink\".
625 What does all this mean? Well, you should specify `tramp-login-program'
626 for all methods; this program is used to log in to the remote site. Then,
627 there are two ways to actually transfer the files between the local and the
628 remote side. One way is using an additional rcp-like program. If you want
629 to do this, set `tramp-copy-program' in the method.
631 Another possibility for file transfer is inline transfer, i.e. the
632 file is passed through the same buffer used by `tramp-login-program'. In
633 this case, the file contents need to be protected since the
634 `tramp-login-program' might use escape codes or the connection might not
635 be eight-bit clean. Therefore, file contents are encoded for transit.
636 See the variables `tramp-local-coding-commands' and
637 `tramp-remote-coding-commands' for details.
639 So, to summarize: if the method is an out-of-band method, then you
640 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
641 inline method, then these two parameters should be nil. Methods which
642 are fit for gateways must have `tramp-default-port' at least.
646 When using `su' or `sudo' the phrase `open connection to a remote
647 host' sounds strange, but it is used nevertheless, for consistency.
648 No connection is opened to a remote host, but `su' or `sudo' is
649 started on the local host. You should specify a remote host
650 `localhost' or the name of the local host. Another host name is
651 useful only in combination with `tramp-default-proxies-alist'.")
653 (defcustom tramp-default-method
654 ;; An external copy method seems to be preferred, because it is much
655 ;; more performant for large files, and it hasn't too serious delays
656 ;; for small files. But it must be ensured that there aren't
657 ;; permanent password queries. Either a password agent like
658 ;; "ssh-agent" or "Pageant" shall run, or the optional password.el
659 ;; package shall be active for password caching. "scpc" would be
660 ;; another good choice because of the "ControlMaster" option, but
661 ;; this is a more modern alternative in OpenSSH 4, which cannot be
664 ;; PuTTY is installed.
665 ((executable-find "pscp")
666 (if (or (fboundp 'password-read)
667 ;; Pageant is running.
668 (and (fboundp 'w32-window-exists-p)
669 (funcall (symbol-function 'w32-window-exists-p)
670 "Pageant" "Pageant")))
673 ;; There is an ssh installation.
674 ((executable-find "scp")
675 (if (or (fboundp 'password-read)
676 ;; ssh-agent is running.
677 (getenv "SSH_AUTH_SOCK")
678 (getenv "SSH_AGENT_PID"))
683 "*Default method to use for transferring files.
684 See `tramp-methods' for possibilities.
685 Also see `tramp-default-method-alist'."
689 (defcustom tramp-default-method-alist
690 '(("\\`localhost\\'" "\\`root\\'" "su"))
691 "*Default method to use for specific host/user pairs.
692 This is an alist of items (HOST USER METHOD). The first matching item
693 specifies the method to use for a file name which does not specify a
694 method. HOST and USER are regular expressions or nil, which is
695 interpreted as a regular expression which always matches. If no entry
696 matches, the variable `tramp-default-method' takes effect.
698 If the file name does not specify the user, lookup is done using the
699 empty string for the user name.
701 See `tramp-methods' for a list of possibilities for METHOD."
703 :type '(repeat (list (regexp :tag "Host regexp")
704 (regexp :tag "User regexp")
705 (string :tag "Method"))))
707 (defcustom tramp-default-user
709 "*Default user to use for transferring files.
710 It is nil by default; otherwise settings in configuration files like
711 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
713 This variable is regarded as obsolete, and will be removed soon."
715 :type '(choice (const nil) string))
717 (defcustom tramp-default-user-alist
718 `(("\\`su\\(do\\)?\\'" nil "root")
719 ("\\`r\\(em\\)?\\(cp\\|sh\\)\\|telnet\\|plink1?\\'"
720 nil ,(user-login-name)))
721 "*Default user to use for specific method/host pairs.
722 This is an alist of items (METHOD HOST USER). The first matching item
723 specifies the user to use for a file name which does not specify a
724 user. METHOD and USER are regular expressions or nil, which is
725 interpreted as a regular expression which always matches. If no entry
726 matches, the variable `tramp-default-user' takes effect.
728 If the file name does not specify the method, lookup is done using the
729 empty string for the method name."
731 :type '(repeat (list (regexp :tag "Method regexp")
732 (regexp :tag "Host regexp")
733 (string :tag "User"))))
735 (defcustom tramp-default-host
737 "*Default host to use for transferring files.
738 Useful for su and sudo methods mostly."
742 (defcustom tramp-default-proxies-alist nil
743 "*Route to be followed for specific host/user pairs.
744 This is an alist of items (HOST USER PROXY). The first matching
745 item specifies the proxy to be passed for a file name located on
746 a remote target matching USER@HOST. HOST and USER are regular
747 expressions or nil, which is interpreted as a regular expression
748 which always matches. PROXY must be a Tramp filename without a
749 localname part. Method and user name on PROXY are optional,
750 which is interpreted with the default values. PROXY can contain
751 the patterns %h and %u, which are replaced by the strings
752 matching HOST or USER, respectively."
754 :type '(repeat (list (regexp :tag "Host regexp")
755 (regexp :tag "User regexp")
756 (string :tag "Proxy remote name"))))
758 (defconst tramp-completion-function-alist-rsh
759 '((tramp-parse-rhosts "/etc/hosts.equiv")
760 (tramp-parse-rhosts "~/.rhosts"))
761 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
763 (defconst tramp-completion-function-alist-ssh
764 '((tramp-parse-rhosts "/etc/hosts.equiv")
765 (tramp-parse-rhosts "/etc/shosts.equiv")
766 (tramp-parse-shosts "/etc/ssh_known_hosts")
767 (tramp-parse-sconfig "/etc/ssh_config")
768 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
769 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
770 (tramp-parse-rhosts "~/.rhosts")
771 (tramp-parse-rhosts "~/.shosts")
772 (tramp-parse-shosts "~/.ssh/known_hosts")
773 (tramp-parse-sconfig "~/.ssh/config")
774 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
775 (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
776 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
778 (defconst tramp-completion-function-alist-telnet
779 '((tramp-parse-hosts "/etc/hosts"))
780 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
782 (defconst tramp-completion-function-alist-su
783 '((tramp-parse-passwd "/etc/passwd"))
784 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
786 (defconst tramp-completion-function-alist-putty
788 "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"))
789 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty methods.")
791 (defvar tramp-completion-function-alist nil
792 "*Alist of methods for remote files.
793 This is a list of entries of the form (NAME PAIR1 PAIR2 ...).
794 Each NAME stands for a remote access method. Each PAIR is of the form
795 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
796 names from FILE for completion. The following predefined FUNCTIONs exists:
798 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
799 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
800 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
801 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
802 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
803 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
804 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
805 * `tramp-parse-netrc' for \"~/.netrc\" like files.
806 * `tramp-parse-putty' for PuTTY registry keys.
808 FUNCTION can also be a customer defined function. For more details see
811 (eval-after-load "tramp"
813 (tramp-set-completion-function
814 "rcp" tramp-completion-function-alist-rsh)
815 (tramp-set-completion-function
816 "scp" tramp-completion-function-alist-ssh)
817 (tramp-set-completion-function
818 "scp1" tramp-completion-function-alist-ssh)
819 (tramp-set-completion-function
820 "scp2" tramp-completion-function-alist-ssh)
821 (tramp-set-completion-function
822 "scp1_old" tramp-completion-function-alist-ssh)
823 (tramp-set-completion-function
824 "scp2_old" tramp-completion-function-alist-ssh)
825 (tramp-set-completion-function
826 "rsync" tramp-completion-function-alist-rsh)
827 (tramp-set-completion-function
828 "remcp" tramp-completion-function-alist-rsh)
829 (tramp-set-completion-function
830 "rsh" tramp-completion-function-alist-rsh)
831 (tramp-set-completion-function
832 "ssh" tramp-completion-function-alist-ssh)
833 (tramp-set-completion-function
834 "ssh1" tramp-completion-function-alist-ssh)
835 (tramp-set-completion-function
836 "ssh2" tramp-completion-function-alist-ssh)
837 (tramp-set-completion-function
838 "ssh1_old" tramp-completion-function-alist-ssh)
839 (tramp-set-completion-function
840 "ssh2_old" tramp-completion-function-alist-ssh)
841 (tramp-set-completion-function
842 "remsh" tramp-completion-function-alist-rsh)
843 (tramp-set-completion-function
844 "telnet" tramp-completion-function-alist-telnet)
845 (tramp-set-completion-function
846 "su" tramp-completion-function-alist-su)
847 (tramp-set-completion-function
848 "sudo" tramp-completion-function-alist-su)
849 (tramp-set-completion-function
850 "scpx" tramp-completion-function-alist-ssh)
851 (tramp-set-completion-function
852 "sshx" tramp-completion-function-alist-ssh)
853 (tramp-set-completion-function
854 "krlogin" tramp-completion-function-alist-rsh)
855 (tramp-set-completion-function
856 "plink" tramp-completion-function-alist-ssh)
857 (tramp-set-completion-function
858 "plink1" tramp-completion-function-alist-ssh)
859 (tramp-set-completion-function
860 "plinkx" tramp-completion-function-alist-putty)
861 (tramp-set-completion-function
862 "pscp" tramp-completion-function-alist-ssh)
863 (tramp-set-completion-function
864 "fcp" tramp-completion-function-alist-ssh)))
866 (defconst tramp-echo-mark-marker "_echo"
867 "String marker to surround echoed commands.")
869 (defconst tramp-echo-mark "_echo\b\b\b\b\b"
870 "String mark to be transmitted around shell commands.
871 Used to separate their echo from the output they produce. This
872 will only be used if we cannot disable remote echo via stty.
873 This string must have no effect on the remote shell except for
874 producing some echo which can later be detected by
875 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
876 followed by an equal number of backspaces to erase them will
879 (defconst tramp-echoed-echo-mark-regexp "_echo\\(\b\\( \b\\)?\\)\\{5\\}"
880 "Regexp which matches `tramp-echo-mark' as it gets echoed by
883 (defcustom tramp-rsh-end-of-line "\n"
884 "*String used for end of line in rsh connections.
885 I don't think this ever needs to be changed, so please tell me about it
886 if you need to change this.
887 Also see the method parameter `tramp-password-end-of-line' and the normal
888 variable `tramp-default-password-end-of-line'."
892 (defcustom tramp-default-password-end-of-line
893 tramp-rsh-end-of-line
894 "*String used for end of line after sending a password.
895 This variable provides the default value for the method parameter
896 `tramp-password-end-of-line', see `tramp-methods' for more details.
898 It seems that people using plink under Windows need to send
899 \"\\r\\n\" (carriage-return, then newline) after a password, but just
900 \"\\n\" after all other lines. This variable can be used for the
901 password, see `tramp-rsh-end-of-line' for the other cases.
903 The default value is to use the same value as `tramp-rsh-end-of-line'."
907 ;; "getconf PATH" yields:
908 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
909 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
910 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
911 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
912 (defcustom tramp-remote-path
913 '(tramp-default-remote-path "/usr/sbin" "/usr/local/bin"
914 "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
915 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin")
916 "*List of directories to search for executables on remote host.
917 For every remote host, this variable will be set buffer local,
918 keeping the list of existing directories on that host.
920 You can use `~' in this list, but when searching for a shell which groks
921 tilde expansion, all directory names starting with `~' will be ignored.
923 `Default Directories' represent the list of directories given by
924 the command \"getconf PATH\". It is recommended to use this
925 entry on top of this list, because these are the default
926 directories for POSIX compatible commands."
928 :type '(repeat (choice
929 (const :tag "Default Directories" tramp-default-remote-path)
930 (string :tag "Directory"))))
932 (defcustom tramp-remote-process-environment
933 `("HISTFILE=$HOME/.tramp_history" "HISTSIZE=1" "LC_ALL=C"
934 ,(concat "TERM=" tramp-terminal-type)
935 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH="
936 "autocorrect=" "correct=")
938 "*List of environment variables to be set on the remote host.
940 Each element should be a string of the form ENVVARNAME=VALUE. An
941 entry ENVVARNAME= diables the corresponding environment variable,
942 which might have been set in the init files like ~/.profile.
944 Special handling is applied to the PATH environment, which should
945 not be set here. Instead of, it should be set via `tramp-remote-path'."
947 :type '(repeat string))
949 (defcustom tramp-login-prompt-regexp
950 ".*ogin\\( .*\\)?: *"
951 "*Regexp matching login-like prompts.
952 The regexp should match at end of buffer.
954 Sometimes the prompt is reported to look like \"login as:\"."
958 (defcustom tramp-shell-prompt-pattern
959 "^[^#$%>\n]*[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*"
960 "Regexp to match prompts from remote shell.
961 Normally, Tramp expects you to configure `shell-prompt-pattern'
962 correctly, but sometimes it happens that you are connecting to a
963 remote host which sends a different kind of shell prompt. Therefore,
964 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
965 and also things matched by this variable. The default value of this
966 variable is similar to the default value of `shell-prompt-pattern',
967 which should work well in many cases."
971 (defcustom tramp-password-prompt-regexp
972 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
973 "*Regexp matching password-like prompts.
974 The regexp should match at end of buffer.
976 The `sudo' program appears to insert a `^@' character into the prompt."
980 (defcustom tramp-wrong-passwd-regexp
982 ;; These strings should be on the last line
983 (regexp-opt '("Permission denied"
989 "Name or service not known"
990 "Host key verification failed."
991 "No supported authentication methods left to try!"
992 "Tramp connection closed") t)
996 ;; Here comes a list of regexes, separated by \\|
997 "Received signal [0-9]+"
999 "*Regexp matching a `login failed' message.
1000 The regexp should match at end of buffer."
1004 (defcustom tramp-yesno-prompt-regexp
1006 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
1008 "Regular expression matching all yes/no queries which need to be confirmed.
1009 The confirmation should be done with yes or no.
1010 The regexp should match at end of buffer.
1011 See also `tramp-yn-prompt-regexp'."
1015 (defcustom tramp-yn-prompt-regexp
1017 (regexp-opt '("Store key in cache? (y/n)"
1018 "Update cached key? (y/n, Return cancels connection)") t)
1020 "Regular expression matching all y/n queries which need to be confirmed.
1021 The confirmation should be done with y or n.
1022 The regexp should match at end of buffer.
1023 See also `tramp-yesno-prompt-regexp'."
1027 (defcustom tramp-terminal-prompt-regexp
1031 "Terminal type\\? \\[.*\\]"
1033 "Regular expression matching all terminal setting prompts.
1034 The regexp should match at end of buffer.
1035 The answer will be provided by `tramp-action-terminal', which see."
1039 (defcustom tramp-operation-not-permitted-regexp
1040 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
1041 (regexp-opt '("Operation not permitted") t))
1042 "Regular expression matching keep-date problems in (s)cp operations.
1043 Copying has been performed successfully already, so this message can
1048 (defcustom tramp-copy-failed-regexp
1050 (regexp-opt '("Permission denied"
1051 "not a regular file"
1053 "No such file or directory") t)
1055 "Regular expression matching copy problems in (s)cp operations."
1059 (defcustom tramp-process-alive-regexp
1061 "Regular expression indicating a process has finished.
1062 In fact this expression is empty by intention, it will be used only to
1063 check regularly the status of the associated process.
1064 The answer will be provided by `tramp-action-process-alive',
1065 `tramp-action-out-of-band', which see."
1069 (defcustom tramp-temp-name-prefix "tramp."
1070 "*Prefix to use for temporary files.
1071 If this is a relative file name (such as \"tramp.\"), it is considered
1072 relative to the directory name returned by the function
1073 `tramp-compat-temporary-file-directory' (which see). It may also be an
1074 absolute file name; don't forget to include a prefix for the filename
1079 (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
1080 "*Alist specifying extra arguments to pass to the remote shell.
1081 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
1082 matching the shell file name and ARGS is a string specifying the
1085 This variable is only used when Tramp needs to start up another shell
1086 for tilde expansion. The extra arguments should typically prevent the
1087 shell from reading its init file."
1089 ;; This might be the wrong way to test whether the widget type
1090 ;; `alist' is available. Who knows the right way to test it?
1091 :type (if (get 'alist 'widget-type)
1092 '(alist :key-type string :value-type string)
1093 '(repeat (cons string string))))
1095 ;; XEmacs is distributed with few Lisp packages. Further packages are
1096 ;; installed using EFS. If we use a unified filename format, then
1097 ;; Tramp is required in addition to EFS. (But why can't Tramp just
1098 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
1099 ;; just like before.) Another reason for using a separate filename
1100 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
1101 ;; Tramp only knows how to deal with `file-name-handler-alist', not
1102 ;; the other places.
1104 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
1106 (defcustom tramp-syntax
1107 (if (featurep 'xemacs) 'sep 'ftp)
1108 "Tramp filename syntax to be used.
1110 It can have the following values:
1112 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
1113 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
1114 'url -- URL-like syntax."
1116 :type (if (featurep 'xemacs)
1117 '(choice (const :tag "EFS" ftp)
1118 (const :tag "XEmacs" sep)
1119 (const :tag "URL" url))
1120 '(choice (const :tag "Ange-FTP" ftp)
1121 (const :tag "URL" url))))
1123 (defconst tramp-prefix-format
1124 (cond ((equal tramp-syntax 'ftp) "/")
1125 ((equal tramp-syntax 'sep) "/[")
1126 ((equal tramp-syntax 'url) "/")
1127 (t (error "Wrong `tramp-syntax' defined")))
1128 "*String matching the very beginning of Tramp file names.
1129 Used in `tramp-make-tramp-file-name'.")
1131 (defconst tramp-prefix-regexp
1132 (concat "^" (regexp-quote tramp-prefix-format))
1133 "*Regexp matching the very beginning of Tramp file names.
1134 Should always start with \"^\". Derived from `tramp-prefix-format'.")
1136 (defconst tramp-method-regexp
1138 "*Regexp matching methods identifiers.")
1140 (defconst tramp-postfix-method-format
1141 (cond ((equal tramp-syntax 'ftp) ":")
1142 ((equal tramp-syntax 'sep) "/")
1143 ((equal tramp-syntax 'url) "://")
1144 (t (error "Wrong `tramp-syntax' defined")))
1145 "*String matching delimeter between method and user or host names.
1146 Used in `tramp-make-tramp-file-name'.")
1148 (defconst tramp-postfix-method-regexp
1149 (regexp-quote tramp-postfix-method-format)
1150 "*Regexp matching delimeter between method and user or host names.
1151 Derived from `tramp-postfix-method-format'.")
1153 (defconst tramp-user-regexp
1155 "*Regexp matching user names.")
1157 (defconst tramp-postfix-user-format
1159 "*String matching delimeter between user and host names.
1160 Used in `tramp-make-tramp-file-name'.")
1162 (defconst tramp-postfix-user-regexp
1163 (regexp-quote tramp-postfix-user-format)
1164 "*Regexp matching delimeter between user and host names.
1165 Derived from `tramp-postfix-user-format'.")
1167 (defconst tramp-host-regexp
1169 "*Regexp matching host names.")
1171 (defconst tramp-prefix-port-format
1172 (cond ((equal tramp-syntax 'ftp) "#")
1173 ((equal tramp-syntax 'sep) "#")
1174 ((equal tramp-syntax 'url) ":")
1175 (t (error "Wrong `tramp-syntax' defined")))
1176 "*String matching delimeter between host names and port numbers.")
1178 (defconst tramp-prefix-port-regexp
1179 (regexp-quote tramp-prefix-port-format)
1180 "*Regexp matching delimeter between host names and port numbers.
1181 Derived from `tramp-prefix-port-format'.")
1183 (defconst tramp-port-regexp
1185 "*Regexp matching port numbers.")
1187 (defconst tramp-host-with-port-regexp
1188 (concat "\\(" tramp-host-regexp "\\)"
1189 tramp-prefix-port-regexp
1190 "\\(" tramp-port-regexp "\\)")
1191 "*Regexp matching host names with port numbers.")
1193 (defconst tramp-postfix-host-format
1194 (cond ((equal tramp-syntax 'ftp) ":")
1195 ((equal tramp-syntax 'sep) "]")
1196 ((equal tramp-syntax 'url) "")
1197 (t (error "Wrong `tramp-syntax' defined")))
1198 "*String matching delimeter between host names and localnames.
1199 Used in `tramp-make-tramp-file-name'.")
1201 (defconst tramp-postfix-host-regexp
1202 (regexp-quote tramp-postfix-host-format)
1203 "*Regexp matching delimeter between host names and localnames.
1204 Derived from `tramp-postfix-host-format'.")
1206 (defconst tramp-localname-regexp
1208 "*Regexp matching localnames.")
1210 ;; File name format.
1212 (defconst tramp-file-name-structure
1216 "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
1217 "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
1218 "\\(" tramp-host-regexp
1219 "\\(" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?"
1220 tramp-postfix-host-regexp
1221 "\\(" tramp-localname-regexp "\\)")
1224 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
1225 the Tramp file name structure.
1227 The first element REGEXP is a regular expression matching a Tramp file
1228 name. The regex should contain parentheses around the method name,
1229 the user name, the host name, and the file name parts.
1231 The second element METHOD is a number, saying which pair of
1232 parentheses matches the method name. The third element USER is
1233 similar, but for the user name. The fourth element HOST is similar,
1234 but for the host name. The fifth element FILE is for the file name.
1235 These numbers are passed directly to `match-string', which see. That
1236 means the opening parentheses are counted to identify the pair.
1238 See also `tramp-file-name-regexp'.")
1241 (defconst tramp-file-name-regexp-unified
1243 "Value for `tramp-file-name-regexp' for unified remoting.
1244 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1245 Tramp. See `tramp-file-name-structure' for more explanations.")
1248 (defconst tramp-file-name-regexp-separate
1250 "Value for `tramp-file-name-regexp' for separate remoting.
1251 XEmacs uses a separate filename syntax for Tramp and EFS.
1252 See `tramp-file-name-structure' for more explanations.")
1255 (defconst tramp-file-name-regexp-url
1257 "Value for `tramp-file-name-regexp' for URL-like remoting.
1258 See `tramp-file-name-structure' for more explanations.")
1261 (defconst tramp-file-name-regexp
1262 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
1263 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
1264 ((equal tramp-syntax 'url) tramp-file-name-regexp-url)
1265 (t (error "Wrong `tramp-syntax' defined")))
1266 "*Regular expression matching file names handled by Tramp.
1267 This regexp should match Tramp file names but no other file names.
1268 \(When tramp.el is loaded, this regular expression is prepended to
1269 `file-name-handler-alist', and that is searched sequentially. Thus,
1270 if the Tramp entry appears rather early in the `file-name-handler-alist'
1271 and is a bit too general, then some files might be considered Tramp
1272 files which are not really Tramp files.
1274 Please note that the entry in `file-name-handler-alist' is made when
1275 this file (tramp.el) is loaded. This means that this variable must be set
1276 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1277 updated after changing this variable.
1279 Also see `tramp-file-name-structure'.")
1282 (defconst tramp-root-regexp
1283 (if (memq system-type '(cygwin windows-nt))
1284 "^\\([a-zA-Z]:\\)?/"
1286 "Beginning of an incomplete Tramp file name.
1287 Usually, it is just \"^/\". On W32 systems, there might be a
1288 volume letter, which will be removed by `tramp-drop-volume-letter'.")
1291 (defconst tramp-completion-file-name-regexp-unified
1292 (concat tramp-root-regexp "[^/]*$")
1293 "Value for `tramp-completion-file-name-regexp' for unified remoting.
1294 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
1295 See `tramp-file-name-structure' for more explanations.")
1298 (defconst tramp-completion-file-name-regexp-separate
1299 (concat tramp-root-regexp "\\([[][^]]*\\)?$")
1300 "Value for `tramp-completion-file-name-regexp' for separate remoting.
1301 XEmacs uses a separate filename syntax for Tramp and EFS.
1302 See `tramp-file-name-structure' for more explanations.")
1305 (defconst tramp-completion-file-name-regexp-url
1306 (concat tramp-root-regexp "[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?$")
1307 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
1308 See `tramp-file-name-structure' for more explanations.")
1311 (defconst tramp-completion-file-name-regexp
1312 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
1313 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
1314 ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url)
1315 (t (error "Wrong `tramp-syntax' defined")))
1316 "*Regular expression matching file names handled by Tramp completion.
1317 This regexp should match partial Tramp file names only.
1319 Please note that the entry in `file-name-handler-alist' is made when
1320 this file (tramp.el) is loaded. This means that this variable must be set
1321 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1322 updated after changing this variable.
1324 Also see `tramp-file-name-structure'.")
1326 (defconst tramp-actions-before-shell
1327 '((tramp-login-prompt-regexp tramp-action-login)
1328 (tramp-password-prompt-regexp tramp-action-password)
1329 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1330 (shell-prompt-pattern tramp-action-succeed)
1331 (tramp-shell-prompt-pattern tramp-action-succeed)
1332 (tramp-yesno-prompt-regexp tramp-action-yesno)
1333 (tramp-yn-prompt-regexp tramp-action-yn)
1334 (tramp-terminal-prompt-regexp tramp-action-terminal)
1335 (tramp-process-alive-regexp tramp-action-process-alive))
1336 "List of pattern/action pairs.
1337 Whenever a pattern matches, the corresponding action is performed.
1338 Each item looks like (PATTERN ACTION).
1340 The PATTERN should be a symbol, a variable. The value of this
1341 variable gives the regular expression to search for. Note that the
1342 regexp must match at the end of the buffer, \"\\'\" is implicitly
1345 The ACTION should also be a symbol, but a function. When the
1346 corresponding PATTERN matches, the ACTION function is called.")
1348 (defconst tramp-actions-copy-out-of-band
1349 '((tramp-password-prompt-regexp tramp-action-password)
1350 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1351 (tramp-copy-failed-regexp tramp-action-permission-denied)
1352 (tramp-process-alive-regexp tramp-action-out-of-band))
1353 "List of pattern/action pairs.
1354 This list is used for copying/renaming with out-of-band methods.
1356 See `tramp-actions-before-shell' for more info.")
1358 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
1359 ;; known to have a bug in `process-send-string'; some ssh connections appear
1360 ;; to drop bytes when data is sent too quickly. There is also a connection
1361 ;; buffer local variable, which is computed depending on remote host properties
1362 ;; when `tramp-chunksize' is zero or nil.
1363 (defcustom tramp-chunksize
1364 (when (and (not (featurep 'xemacs))
1365 (memq system-type '(hpux)))
1367 ;; Parentheses in docstring starting at beginning of line are escaped.
1368 ;; Fontification is messed up when
1369 ;; `open-paren-in-column-0-is-defun-start' set to t.
1370 "*If non-nil, chunksize for sending input to local process.
1371 It is necessary only on systems which have a buggy `process-send-string'
1372 implementation. The necessity, whether this variable must be set, can be
1373 checked via the following code:
1376 (let* ((user \"xxx\") (host \"yyy\")
1378 (sent init) (received init))
1379 (while (= sent received)
1380 (setq sent (+ sent step))
1382 (let ((proc (start-process (buffer-name) (current-buffer)
1383 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
1384 (when (memq (process-status proc) '(run open))
1385 (process-send-string proc (make-string sent ?\\ ))
1386 (process-send-eof proc)
1387 (process-send-eof proc))
1388 (while (not (progn (goto-char (point-min))
1389 (re-search-forward \"\\\\w+\" (point-max) t)))
1390 (accept-process-output proc 1))
1391 (when (memq (process-status proc) '(run open))
1392 (setq received (string-to-number (match-string 0)))
1393 (delete-process proc)
1394 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1396 (if (> sent (+ init step))
1397 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1399 (message \"Test does not work\")
1400 (display-buffer (current-buffer))
1403 In the Emacs normally running Tramp, evaluate the above code
1404 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1405 respectively). You can do this, for example, by pasting it into
1406 the `*scratch*' buffer and then hitting C-j with the cursor after the
1407 last closing parenthesis. Note that it works only if you have configured
1408 \"ssh\" to run without password query, see ssh-agent(1).
1410 You will see the number of bytes sent successfully to the remote host.
1411 If that number exceeds 1000, you can stop the execution by hitting
1412 C-g, because your Emacs is likely clean.
1414 When it is necessary to set `tramp-chunksize', you might consider to
1415 use an out-of-the-band method (like \"scp\") instead of an internal one
1416 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
1419 If your Emacs is buggy, the code stops and gives you an indication
1420 about the value `tramp-chunksize' should be set. Maybe you could just
1421 experiment a bit, e.g. changing the values of `init' and `step'
1422 in the third line of the code.
1424 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1425 this variable to be set as well."
1427 :type '(choice (const nil) integer))
1429 ;; Logging in to a remote host normally requires obtaining a pty. But
1430 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1431 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1432 ;; for an override of the system default.
1433 (defcustom tramp-process-connection-type t
1434 "Overrides `process-connection-type' for connections from Tramp.
1435 Tramp binds process-connection-type to the value given here before
1436 opening a connection to a remote host."
1438 :type '(choice (const nil) (const t) (const pty)))
1440 (defcustom tramp-completion-reread-directory-timeout 10
1441 "Defines seconds since last remote command before rereading a directory.
1442 A remote directory might have changed its contents. In order to
1443 make it visible during file name completion in the minibuffer,
1444 Tramp flushes its cache and rereads the directory contents when
1445 more than `tramp-completion-reread-directory-timeout' seconds
1446 have been gone since last remote command execution. A value of 0
1447 would require an immediate reread during filename completion, nil
1448 means to use always cached values for the directory contents."
1450 :type '(choice (const nil) integer))
1452 ;;; Internal Variables:
1454 (defvar tramp-end-of-output
1457 tramp-rsh-end-of-line
1458 (md5 (concat (prin1-to-string process-environment) (current-time-string)))
1459 tramp-rsh-end-of-line)
1460 "String used to recognize end of output.")
1462 (defvar tramp-current-method nil
1463 "Connection method for this *tramp* buffer.")
1465 (defvar tramp-current-user nil
1466 "Remote login name for this *tramp* buffer.")
1468 (defvar tramp-current-host nil
1469 "Remote host for this *tramp* buffer.")
1471 (defconst tramp-uudecode
1472 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
1474 rm -f /tmp/tramp.$$"
1475 "Shell function to implement `uudecode' to standard output.
1476 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
1477 for this or `uudecode -p', but some systems don't, and for them
1478 we have this shell function.")
1480 ;; Perl script to implement `file-attributes' in a Lisp `read'able
1481 ;; output. If you are hacking on this, note that you get *no* output
1482 ;; unless this spits out a complete line, including the '\n' at the
1484 ;; The device number is returned as "-1", because there will be a virtual
1485 ;; device number set in `tramp-handle-file-attributes'
1486 (defconst tramp-perl-file-attributes
1488 @stat = lstat($ARGV[0]);
1489 if (($stat[2] & 0170000) == 0120000)
1491 $type = readlink($ARGV[0]);
1492 $type = \"\\\"$type\\\"\";
1494 elsif (($stat[2] & 0170000) == 040000)
1502 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1503 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1505 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
1510 $stat[8] >> 16 & 0xffff,
1512 $stat[9] >> 16 & 0xffff,
1514 $stat[10] >> 16 & 0xffff,
1518 $stat[1] >> 16 & 0xffff,
1520 );' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1521 "Perl script to produce output suitable for use with `file-attributes'
1522 on the remote file system.
1523 Escape sequence %s is replaced with name of Perl binary.
1524 This string is passed to `format', so percent characters need to be doubled.")
1526 (defconst tramp-perl-directory-files-and-attributes
1528 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
1529 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
1530 @list = readdir(DIR);
1534 for($i = 0; $i < $n; $i++)
1536 $filename = $list[$i];
1537 @stat = lstat($filename);
1538 if (($stat[2] & 0170000) == 0120000)
1540 $type = readlink($filename);
1541 $type = \"\\\"$type\\\"\";
1543 elsif (($stat[2] & 0170000) == 040000)
1551 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1552 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1554 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u %%u))\\n\",
1560 $stat[8] >> 16 & 0xffff,
1562 $stat[9] >> 16 & 0xffff,
1564 $stat[10] >> 16 & 0xffff,
1568 $stat[1] >> 16 & 0xffff,
1570 $stat[0] >> 16 & 0xffff,
1573 printf(\")\\n\");' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1574 "Perl script implementing `directory-files-attributes' as Lisp `read'able
1576 Escape sequence %s is replaced with name of Perl binary.
1577 This string is passed to `format', so percent characters need to be doubled.")
1579 ;; ;; These two use uu encoding.
1580 ;; (defvar tramp-perl-encode "%s -e'\
1581 ;; print qq(begin 644 xxx\n);
1584 ;; while (read(STDIN, $s, 45)) {
1585 ;; print pack(q(u), $s);
1590 ;; "Perl program to use for encoding a file.
1591 ;; Escape sequence %s is replaced with name of Perl binary.")
1593 ;; (defvar tramp-perl-decode "%s -ne '
1594 ;; print unpack q(u), $_;
1596 ;; "Perl program to use for decoding a file.
1597 ;; Escape sequence %s is replaced with name of Perl binary.")
1599 ;; These two use base64 encoding.
1600 (defconst tramp-perl-encode-with-module
1601 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
1602 "Perl program to use for encoding a file.
1603 Escape sequence %s is replaced with name of Perl binary.
1604 This string is passed to `format', so percent characters need to be doubled.
1605 This implementation requires the MIME::Base64 Perl module to be installed
1606 on the remote host.")
1608 (defconst tramp-perl-decode-with-module
1609 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
1610 "Perl program to use for decoding a file.
1611 Escape sequence %s is replaced with name of Perl binary.
1612 This string is passed to `format', so percent characters need to be doubled.
1613 This implementation requires the MIME::Base64 Perl module to be installed
1614 on the remote host.")
1616 (defconst tramp-perl-encode
1618 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1619 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
1620 # Free Software Foundation, Inc.
1625 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
1626 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
1631 # We read in chunks of 54 bytes, to generate output lines
1632 # of 72 chars (plus end of line)
1635 while (my $data = <STDIN>) {
1638 # Only for the last chunk, and only if did not fill the last three-byte packet
1640 my $mod = length($data) %% 3;
1641 $pad = q(=) x (3 - $mod) if $mod;
1644 # Not the fastest method, but it is simple: unpack to binary string, split
1645 # by groups of 6 bits and convert back from binary to byte; then map into
1646 # the translation table
1650 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
1654 "Perl program to use for encoding a file.
1655 Escape sequence %s is replaced with name of Perl binary.
1656 This string is passed to `format', so percent characters need to be doubled.")
1658 (defconst tramp-perl-decode
1660 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1661 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
1662 # Free Software Foundation, Inc.
1667 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
1668 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
1671 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
1675 # We are going to accumulate into $pending to accept any line length
1676 # (we do not check they are <= 76 chars as the RFC says)
1679 while (my $data = <STDIN>) {
1682 # If we find one or two =, we have reached the end and
1683 # any following data is to be discarded
1684 my $finished = $data =~ s/(==?).*/$1/;
1687 my $len = length($pending);
1688 my $chunk = substr($pending, 0, $len & ~3);
1689 $pending = substr($pending, $len & ~3 + 1);
1691 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
1692 # split in 8-bit chunks and convert back to char.
1695 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
1699 "Perl program to use for decoding a file.
1700 Escape sequence %s is replaced with name of Perl binary.
1701 This string is passed to `format', so percent characters need to be doubled.")
1703 (defconst tramp-file-mode-type-map
1704 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
1706 (2 . "c") ; character device
1707 (3 . "m") ; multiplexed character device (v7)
1708 (4 . "d") ; directory
1709 (5 . "?") ; Named special file (XENIX)
1710 (6 . "b") ; block device
1711 (7 . "?") ; multiplexed block device (v7)
1712 (8 . "-") ; regular file
1713 (9 . "n") ; network special file (HP-UX)
1714 (10 . "l") ; symlink
1715 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
1717 (13 . "D") ; door special (Solaris)
1718 (14 . "w")) ; whiteout (BSD)
1719 "A list of file types returned from the `stat' system call.
1720 This is used to map a mode number to a permission string.")
1722 ;; New handlers should be added here. The following operations can be
1723 ;; handled using the normal primitives: file-name-as-directory,
1724 ;; file-name-sans-versions, get-file-buffer.
1725 (defconst tramp-file-name-handler-alist
1726 '((load . tramp-handle-load)
1727 (make-symbolic-link . tramp-handle-make-symbolic-link)
1728 (file-name-directory . tramp-handle-file-name-directory)
1729 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
1730 (file-truename . tramp-handle-file-truename)
1731 (file-exists-p . tramp-handle-file-exists-p)
1732 (file-directory-p . tramp-handle-file-directory-p)
1733 (file-executable-p . tramp-handle-file-executable-p)
1734 (file-readable-p . tramp-handle-file-readable-p)
1735 (file-regular-p . tramp-handle-file-regular-p)
1736 (file-symlink-p . tramp-handle-file-symlink-p)
1737 (file-writable-p . tramp-handle-file-writable-p)
1738 (file-ownership-preserved-p . tramp-handle-file-ownership-preserved-p)
1739 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
1740 (file-attributes . tramp-handle-file-attributes)
1741 (file-modes . tramp-handle-file-modes)
1742 (directory-files . tramp-handle-directory-files)
1743 (directory-files-and-attributes . tramp-handle-directory-files-and-attributes)
1744 (file-name-all-completions . tramp-handle-file-name-all-completions)
1745 (file-name-completion . tramp-handle-file-name-completion)
1746 (add-name-to-file . tramp-handle-add-name-to-file)
1747 (copy-file . tramp-handle-copy-file)
1748 (rename-file . tramp-handle-rename-file)
1749 (set-file-modes . tramp-handle-set-file-modes)
1750 (set-file-times . tramp-handle-set-file-times)
1751 (make-directory . tramp-handle-make-directory)
1752 (delete-directory . tramp-handle-delete-directory)
1753 (delete-file . tramp-handle-delete-file)
1754 (directory-file-name . tramp-handle-directory-file-name)
1755 ;; `executable-find' is not official yet.
1756 (executable-find . tramp-handle-executable-find)
1757 (start-file-process . tramp-handle-start-file-process)
1758 (process-file . tramp-handle-process-file)
1759 (shell-command . tramp-handle-shell-command)
1760 (insert-directory . tramp-handle-insert-directory)
1761 (expand-file-name . tramp-handle-expand-file-name)
1762 (substitute-in-file-name . tramp-handle-substitute-in-file-name)
1763 (file-local-copy . tramp-handle-file-local-copy)
1764 (file-remote-p . tramp-handle-file-remote-p)
1765 (insert-file-contents . tramp-handle-insert-file-contents)
1766 (insert-file-contents-literally
1767 . tramp-handle-insert-file-contents-literally)
1768 (write-region . tramp-handle-write-region)
1769 (find-backup-file-name . tramp-handle-find-backup-file-name)
1770 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
1771 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
1772 (dired-compress-file . tramp-handle-dired-compress-file)
1773 (dired-recursive-delete-directory
1774 . tramp-handle-dired-recursive-delete-directory)
1775 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
1776 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime))
1777 "Alist of handler functions.
1778 Operations not mentioned here will be handled by the normal Emacs functions.")
1780 ;; Handlers for partial Tramp file names. For Emacs just
1781 ;; `file-name-all-completions' is needed.
1783 (defconst tramp-completion-file-name-handler-alist
1784 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1785 (file-name-completion . tramp-completion-handle-file-name-completion))
1786 "Alist of completion handler functions.
1787 Used for file names matching `tramp-file-name-regexp'. Operations not
1788 mentioned here will be handled by `tramp-file-name-handler-alist' or the
1789 normal Emacs functions.")
1791 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1792 (defvar tramp-foreign-file-name-handler-alist
1793 ;; (identity . tramp-sh-file-name-handler) should always be the last
1794 ;; entry, since `identity' always matches.
1795 '((identity . tramp-sh-file-name-handler))
1796 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1797 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1800 ;;; Internal functions which must come first:
1802 (defsubst tramp-debug-message (vec fmt-string &rest args)
1803 "Append message to debug buffer.
1804 Message is formatted with FMT-STRING as control string and the remaining
1805 ARGS to actually emit the message (if applicable)."
1806 (when (get-buffer (tramp-buffer-name vec))
1807 (with-current-buffer (tramp-get-debug-buffer vec)
1808 (goto-char (point-max))
1812 (insert (format-time-string "%T "))
1814 (let ((btn 1) btf fn)
1816 (setq btf (nth 1 (backtrace-frame btn)))
1820 (setq fn (symbol-name btf))
1821 (unless (and (string-match "^tramp" fn)
1823 "^tramp\\(-debug\\)?\\(-message\\|-error\\)$"
1826 (setq btn (1+ btn))))
1827 ;; The following code inserts filename and line number.
1828 ;; Should be deactivated by default, because it is time
1830 ; (let ((ffn (find-function-noselect (intern fn))))
1834 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1835 ; (with-current-buffer (car ffn)
1836 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1837 (insert (format "%s " fn)))
1839 (insert (apply 'format fmt-string args)))))
1841 (defsubst tramp-message (vec-or-proc level fmt-string &rest args)
1842 "Emit a message depending on verbosity level.
1843 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1844 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1845 less than LEVEL. The message is emitted only if `tramp-verbose' is
1846 greater than or equal to LEVEL.
1848 The message is also logged into the debug buffer when `tramp-verbose'
1849 is greater than or equal 4.
1851 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1852 control string and the remaining ARGS to actually emit the message (if
1855 (when (<= level tramp-verbose)
1856 ;; Match data must be preserved!
1858 ;; Display only when there is a minimum level.
1865 ((= level 2) "Warning: ")
1869 ;; Log only when there is a minimum level.
1870 (when (>= tramp-verbose 4)
1871 (when (and vec-or-proc
1872 (processp vec-or-proc)
1873 (buffer-name (process-buffer vec-or-proc)))
1874 (with-current-buffer (process-buffer vec-or-proc)
1875 ;; Translate proc to vec.
1876 (setq vec-or-proc (tramp-dissect-file-name default-directory))))
1877 (when (and vec-or-proc (vectorp vec-or-proc))
1878 (apply 'tramp-debug-message
1880 (concat (format "(%d) # " level) fmt-string)
1882 ;; Suppress all errors.
1885 (defsubst tramp-error (vec-or-proc signal fmt-string &rest args)
1887 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1888 signal identifier to be raised, remaining args passed to
1889 `tramp-message'. Finally, signal SIGNAL is raised."
1892 (error-message-string
1893 (list signal (get signal 'error-message) (apply 'format fmt-string args))))
1894 (signal signal (list (apply 'format fmt-string args))))
1896 (defsubst tramp-error-with-buffer
1897 (buffer vec-or-proc signal fmt-string &rest args)
1898 "Emit an error, and show BUFFER.
1899 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
1900 an input event arrives. The other arguments are passed to `tramp-error'."
1901 (save-window-excursion
1903 (apply 'tramp-error vec-or-proc signal fmt-string args)
1904 (when (and vec-or-proc (not (zerop tramp-verbose)))
1905 (let ((enable-recursive-minibuffers t))
1907 (or (and (bufferp buffer) buffer)
1908 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1909 (tramp-get-buffer vec-or-proc)))
1912 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1913 "Parse a Tramp filename and make components available in the body.
1915 First arg FILENAME is evaluated and dissected into its components.
1916 Second arg VAR is a symbol. It is used as a variable name to hold
1917 the filename structure. It is also used as a prefix for the variables
1918 holding the components. For example, if VAR is the symbol `foo', then
1919 `foo' will be bound to the whole structure, `foo-method' will be bound to
1920 the method component, and so on for `foo-user', `foo-host', `foo-localname'.
1922 Remaining args are Lisp expressions to be evaluated (inside an implicit
1925 If VAR is nil, then we bind `v' to the structure and `method', `user',
1926 `host', `localname' to the components."
1927 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1928 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
1929 (tramp-file-name-method ,(or var 'v)))
1930 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
1931 (tramp-file-name-user ,(or var 'v)))
1932 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
1933 (tramp-file-name-host ,(or var 'v)))
1934 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
1935 (tramp-file-name-localname ,(or var 'v))))
1938 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
1939 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
1940 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
1942 (defmacro with-file-property (vec file property &rest body)
1943 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
1944 FILE must be a local file name on a connection identified via VEC."
1945 `(if (file-name-absolute-p ,file)
1946 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
1947 (when (eq value 'undef)
1948 ;; We cannot pass @body as parameter to
1949 ;; `tramp-set-file-property' because it mangles our
1951 (setq value (progn ,@body))
1952 (tramp-set-file-property ,vec ,file ,property value))
1956 (put 'with-file-property 'lisp-indent-function 3)
1957 (put 'with-file-property 'edebug-form-spec t)
1958 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-file-property\\>"))
1960 (defmacro with-connection-property (key property &rest body)
1961 "Checks in Tramp for property PROPERTY, otherwise executes BODY and set."
1962 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
1963 (when (eq value 'undef)
1964 ;; We cannot pass ,@body as parameter to
1965 ;; `tramp-set-connection-property' because it mangles our debug
1967 (setq value (progn ,@body))
1968 (tramp-set-connection-property ,key ,property value))
1971 (put 'with-connection-property 'lisp-indent-function 2)
1972 (put 'with-connection-property 'edebug-form-spec t)
1973 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-connection-property\\>"))
1975 (eval-and-compile ; silence compiler
1976 (if (memq system-type '(cygwin windows-nt))
1977 (defun tramp-drop-volume-letter (name)
1978 "Cut off unnecessary drive letter from file NAME.
1979 The function `tramp-handle-expand-file-name' calls `expand-file-name'
1980 locally on a remote file name. When the local system is a W32 system
1981 but the remote system is Unix, this introduces a superfluous drive
1982 letter into the file name. This function removes it."
1984 (if (string-match tramp-root-regexp name)
1985 (replace-match "/" nil t name)
1988 (defalias 'tramp-drop-volume-letter 'identity)))
1990 (defsubst tramp-make-tramp-temp-file (vec)
1991 "Create a temporary file on the remote host identified by VEC.
1992 Return the local name of the temporary file."
1994 (tramp-make-tramp-file-name
1995 (tramp-file-name-method vec)
1996 (tramp-file-name-user vec)
1997 (tramp-file-name-host vec)
1998 (tramp-drop-volume-letter
2000 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))))
2003 ;; `make-temp-file' would be the natural choice for
2004 ;; implementation. But it calls `write-region' internally,
2005 ;; which also needs a temporary file - we would end in an
2007 (setq result (make-temp-name prefix))
2008 (if (file-exists-p result)
2010 ;; This creates the file by side effect.
2011 (set-file-times result)
2012 (set-file-modes result (tramp-octal-to-decimal "0700"))))
2014 ;; Return the local part.
2015 (with-parsed-tramp-file-name result nil localname)))
2018 ;;; Config Manipulation Functions:
2020 (defun tramp-set-completion-function (method function-list)
2021 "Sets the list of completion functions for METHOD.
2022 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
2023 The FUNCTION is intended to parse FILE according its syntax.
2024 It might be a predefined FUNCTION, or a user defined FUNCTION.
2025 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
2026 `tramp-parse-sconfig',`tramp-parse-hosts', `tramp-parse-passwd',
2027 and `tramp-parse-netrc'.
2031 (tramp-set-completion-function
2033 '((tramp-parse-sconfig \"/etc/ssh_config\")
2034 (tramp-parse-sconfig \"~/.ssh/config\")))"
2036 (let ((r function-list)
2038 (setq tramp-completion-function-alist
2039 (delete (assoc method tramp-completion-function-alist)
2040 tramp-completion-function-alist))
2043 ;; Remove double entries.
2044 (when (member (car v) (cdr v))
2045 (setcdr v (delete (car v) (cdr v))))
2046 ;; Check for function and file or registry key.
2047 (unless (and (functionp (nth 0 (car v)))
2048 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
2049 ;; Windows registry.
2050 (and (memq system-type '(cygwin windows-nt))
2052 (tramp-local-call-process
2053 "reg" nil nil nil "query" (nth 1 (car v)))))
2054 ;; Configuration file.
2055 (file-exists-p (nth 1 (car v)))))
2056 (setq r (delete (car v) r)))
2060 (add-to-list 'tramp-completion-function-alist
2063 (defun tramp-get-completion-function (method)
2064 "Returns a list of completion functions for METHOD.
2065 For definition of that list see `tramp-set-completion-function'."
2067 ;; Hosts visited once shall be remembered.
2068 `(tramp-parse-connection-properties ,method)
2069 ;; The method related defaults.
2070 (cdr (assoc method tramp-completion-function-alist))))
2073 ;;; Fontification of `read-file-name':
2075 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
2076 (defvar tramp-rfn-eshadow-overlay)
2077 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
2079 (defun tramp-rfn-eshadow-setup-minibuffer ()
2080 "Set up a minibuffer for `file-name-shadow-mode'.
2081 Adds another overlay hiding filename parts according to Tramp's
2082 special handling of `substitute-in-file-name'."
2083 (when (symbol-value 'minibuffer-completing-file-name)
2084 (setq tramp-rfn-eshadow-overlay
2085 (funcall (symbol-function 'make-overlay)
2086 (funcall (symbol-function 'minibuffer-prompt-end))
2087 (funcall (symbol-function 'minibuffer-prompt-end))))
2088 ;; Copy rfn-eshadow-overlay properties.
2089 (let ((props (funcall (symbol-function 'overlay-properties)
2090 (symbol-value 'rfn-eshadow-overlay))))
2092 (funcall (symbol-function 'overlay-put)
2093 tramp-rfn-eshadow-overlay (pop props) (pop props))))))
2095 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
2096 (add-hook 'rfn-eshadow-setup-minibuffer-hook
2097 'tramp-rfn-eshadow-setup-minibuffer))
2099 (defun tramp-rfn-eshadow-update-overlay ()
2100 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
2101 This is intended to be used as a minibuffer `post-command-hook' for
2102 `file-name-shadow-mode'; the minibuffer should have already
2103 been set up by `rfn-eshadow-setup-minibuffer'."
2104 ;; In remote files name, there is a shadowing just for the local part.
2105 (let ((end (or (funcall (symbol-function 'overlay-end)
2106 (symbol-value 'rfn-eshadow-overlay))
2107 (funcall (symbol-function 'minibuffer-prompt-end)))))
2108 (when (file-remote-p (buffer-substring-no-properties end (point-max)))
2112 (1+ (or (string-match "/" (buffer-string) end) end)) (point-max))
2113 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
2114 (rfn-eshadow-update-overlay-hook nil))
2115 (funcall (symbol-function 'rfn-eshadow-update-overlay))))))))
2117 (when (boundp 'rfn-eshadow-update-overlay-hook)
2118 (add-hook 'rfn-eshadow-update-overlay-hook
2119 'tramp-rfn-eshadow-update-overlay))
2122 ;;; File Name Handler Functions:
2124 (defun tramp-handle-make-symbolic-link
2125 (filename linkname &optional ok-if-already-exists)
2126 "Like `make-symbolic-link' for Tramp files.
2127 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
2128 the symlink. If LINKNAME is a Tramp file, only the localname component is
2129 used as the target of the symlink.
2131 If LINKNAME is a Tramp file and the localname component is relative, then
2132 it is expanded first, before the localname component is taken. Note that
2133 this can give surprising results if the user/host for the source and
2134 target of the symlink differ."
2135 (with-parsed-tramp-file-name linkname l
2136 (let ((ln (tramp-get-remote-ln l))
2137 (cwd (tramp-run-real-handler
2138 'file-name-directory (list l-localname))))
2142 "Making a symbolic link. ln(1) does not exist on the remote host."))
2144 ;; Do the 'confirm if exists' thing.
2145 (when (file-exists-p linkname)
2147 (if (or (null ok-if-already-exists) ; not allowed to exist
2148 (and (numberp ok-if-already-exists)
2151 "File %s already exists; make it a link anyway? "
2154 l 'file-already-exists "File %s already exists" l-localname)
2155 (delete-file linkname)))
2157 ;; If FILENAME is a Tramp name, use just the localname component.
2158 (when (tramp-tramp-file-p filename)
2160 (tramp-file-name-localname
2161 (tramp-dissect-file-name (expand-file-name filename)))))
2163 ;; Right, they are on the same host, regardless of user, method, etc.
2164 ;; We now make the link on the remote machine. This will occur as the user
2165 ;; that FILENAME belongs to.
2167 (tramp-send-command-and-check
2168 l (format "cd %s && %s -sf %s %s" cwd ln filename l-localname) t)))))
2170 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
2171 "Like `load' for Tramp files."
2172 (with-parsed-tramp-file-name (expand-file-name file) nil
2174 (cond ((file-exists-p (concat file ".elc"))
2175 (setq file (concat file ".elc")))
2176 ((file-exists-p (concat file ".el"))
2177 (setq file (concat file ".el")))))
2179 ;; The first condition is always true for absolute file names.
2180 ;; Included for safety's sake.
2181 (unless (or (file-name-directory file)
2182 (string-match "\\.elc?\\'" file))
2185 "File `%s' does not include a `.el' or `.elc' suffix" file)))
2187 (when (not (file-exists-p file))
2188 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
2189 (if (not (file-exists-p file))
2191 (unless nomessage (tramp-message v 0 "Loading %s..." file))
2192 (let ((local-copy (file-local-copy file)))
2193 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2194 (load local-copy noerror t t)
2195 (delete-file local-copy))
2196 (unless nomessage (tramp-message v 0 "Loading %s...done" file))
2199 ;; Localname manipulation functions that grok Tramp localnames...
2200 (defun tramp-handle-file-name-directory (file)
2201 "Like `file-name-directory' but aware of Tramp files."
2202 ;; Everything except the last filename thing is the directory. We
2203 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2204 ;; the remote file name parts. This is a problem when we are in
2205 ;; file name completion.
2206 (let ((v (tramp-dissect-file-name file t)))
2207 ;; Run the command on the localname portion only.
2208 (tramp-make-tramp-file-name
2209 (tramp-file-name-method v)
2210 (tramp-file-name-user v)
2211 (tramp-file-name-host v)
2212 (tramp-run-real-handler
2213 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2215 (defun tramp-handle-file-name-nondirectory (file)
2216 "Like `file-name-nondirectory' but aware of Tramp files."
2217 (with-parsed-tramp-file-name file nil
2218 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2220 (defun tramp-handle-file-truename (filename &optional counter prev-dirs)
2221 "Like `file-truename' for Tramp files."
2222 (with-parsed-tramp-file-name (expand-file-name filename) nil
2223 (with-file-property v localname "file-truename"
2224 (let* ((directory-sep-char ?/) ; for XEmacs
2225 (steps (tramp-split-string localname "/"))
2226 (localnamedir (tramp-run-real-handler
2227 'file-name-as-directory (list localname)))
2228 (is-dir (string= localname localnamedir))
2231 ;; Don't make the following value larger than necessary.
2232 ;; People expect an error message in a timely fashion when
2233 ;; something is wrong; otherwise they might think that Emacs
2234 ;; is hung. Of course, correctness has to come first.
2236 (result nil) ;result steps in reverse order
2238 (tramp-message v 4 "Finding true name for `%s'" filename)
2239 (while (and steps (< numchase numchase-limit))
2240 (setq thisstep (pop steps))
2243 (mapconcat 'identity
2244 (append '("") (reverse result) (list thisstep))
2246 (setq symlink-target
2247 (nth 0 (file-attributes
2248 (tramp-make-tramp-file-name
2250 (mapconcat 'identity
2255 (cond ((string= "." thisstep)
2256 (tramp-message v 5 "Ignoring step `.'"))
2257 ((string= ".." thisstep)
2258 (tramp-message v 5 "Processing step `..'")
2260 ((stringp symlink-target)
2261 ;; It's a symlink, follow it.
2262 (tramp-message v 5 "Follow symlink to %s" symlink-target)
2263 (setq numchase (1+ numchase))
2264 (when (file-name-absolute-p symlink-target)
2266 ;; If the symlink was absolute, we'll get a string like
2267 ;; "/user@host:/some/target"; extract the
2268 ;; "/some/target" part from it.
2269 (when (tramp-tramp-file-p symlink-target)
2270 (unless (tramp-equal-remote filename symlink-target)
2273 "Symlink target `%s' on wrong host" symlink-target))
2274 (setq symlink-target localname))
2276 (append (tramp-split-string symlink-target "/")
2280 (setq result (cons thisstep result)))))
2281 (when (>= numchase numchase-limit)
2284 "Maximum number (%d) of symlinks exceeded" numchase-limit))
2285 (setq result (reverse result))
2286 ;; Combine list to form string.
2289 (mapconcat 'identity (cons "" result) "/")
2291 (when (and is-dir (or (string= "" result)
2292 (not (string= (substring result -1) "/"))))
2293 (setq result (concat result "/")))
2294 (tramp-message v 4 "True name of `%s' is `%s'" filename result)
2295 (tramp-make-tramp-file-name method user host result)))))
2299 (defun tramp-handle-file-exists-p (filename)
2300 "Like `file-exists-p' for Tramp files."
2301 (with-parsed-tramp-file-name filename nil
2302 (with-file-property v localname "file-exists-p"
2303 (zerop (tramp-send-command-and-check
2307 (tramp-get-file-exists-command v)
2308 (tramp-shell-quote-argument localname)))))))
2310 ;; Inodes don't exist for some file systems. Therefore we must
2311 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
2312 ;; applied might be not so efficient (Ange-FTP uses hashes). But
2313 ;; performance isn't the major issue given that file transfer will
2315 (defvar tramp-inodes nil
2316 "Keeps virtual inodes numbers.")
2318 ;; Devices must distinguish physical file systems. The device numbers
2319 ;; provided by "lstat" aren't unique, because we operate on different hosts.
2320 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
2321 ;; EFS use device number "-1". In order to be different, we use device number
2322 ;; (-1 x), whereby "x" is unique for a given (method user host).
2323 (defvar tramp-devices nil
2324 "Keeps virtual device numbers.")
2326 ;; CCC: This should check for an error condition and signal failure
2327 ;; when something goes wrong.
2328 ;; Daniel Pittman <daniel@danann.net>
2329 (defun tramp-handle-file-attributes (filename &optional id-format)
2330 "Like `file-attributes' for Tramp files."
2331 (unless id-format (setq id-format 'integer))
2332 (with-parsed-tramp-file-name (expand-file-name filename) nil
2333 (with-file-property v localname (format "file-attributes-%s" id-format)
2334 (when (file-exists-p filename)
2335 ;; file exists, find out stuff
2337 (tramp-convert-file-attributes
2339 (if (tramp-get-remote-stat v)
2340 (tramp-handle-file-attributes-with-stat v localname id-format)
2341 (if (tramp-get-remote-perl v)
2342 (tramp-handle-file-attributes-with-perl v localname id-format)
2343 (tramp-handle-file-attributes-with-ls
2344 v localname id-format)))))))))
2346 (defun tramp-handle-file-attributes-with-ls (vec localname &optional id-format)
2347 "Implement `file-attributes' for Tramp files using the ls(1) command."
2349 res-inode res-filemodes res-numlinks
2350 res-uid res-gid res-size res-symlink-target)
2351 (tramp-message vec 5 "file attributes with ls: %s" localname)
2355 (tramp-get-ls-command vec)
2356 (if (eq id-format 'integer) "-ildn" "-ild")
2357 (tramp-shell-quote-argument localname)))
2358 ;; parse `ls -l' output ...
2359 (with-current-buffer (tramp-get-buffer vec)
2360 (goto-char (point-min))
2364 (read (current-buffer))
2365 (invalid-read-syntax
2366 (when (and (equal (cadr err)
2367 "Integer constant overflow in reader")
2369 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
2371 (let* ((big (read (substring (car (cddr err)) 0
2372 (match-beginning 1))))
2373 (small (read (match-string 1 (car (cddr err)))))
2374 (twiddle (/ small 65536)))
2375 (cons (+ big twiddle)
2376 (- small (* twiddle 65536))))))))
2377 ;; ... file mode flags
2378 (setq res-filemodes (symbol-name (read (current-buffer))))
2380 (setq res-numlinks (read (current-buffer)))
2382 (setq res-uid (read (current-buffer)))
2383 (setq res-gid (read (current-buffer)))
2384 (if (eq id-format 'integer)
2386 (unless (numberp res-uid) (setq res-uid -1))
2387 (unless (numberp res-gid) (setq res-gid -1)))
2389 (unless (stringp res-uid) (setq res-uid (symbol-name res-uid)))
2390 (unless (stringp res-gid) (setq res-gid (symbol-name res-gid)))))
2392 (setq res-size (read (current-buffer)))
2393 ;; From the file modes, figure out other stuff.
2394 (setq symlinkp (eq ?l (aref res-filemodes 0)))
2395 (setq dirp (eq ?d (aref res-filemodes 0)))
2396 ;; if symlink, find out file name pointed to
2398 (search-forward "-> ")
2399 (setq res-symlink-target
2400 (buffer-substring (point) (tramp-compat-line-end-position))))
2401 ;; return data gathered
2403 ;; 0. t for directory, string (name linked to) for symbolic
2405 (or dirp res-symlink-target)
2406 ;; 1. Number of links to file.
2412 ;; 4. Last access time, as a list of two integers. First
2413 ;; integer has high-order 16 bits of time, second has low 16
2415 ;; 5. Last modification time, likewise.
2416 ;; 6. Last status change time, likewise.
2417 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
2418 ;; 7. Size in bytes (-1, if number is out of range).
2420 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
2422 ;; 9. t if file's gid would change if file were deleted and
2423 ;; recreated. Will be set in `tramp-convert-file-attributes'
2425 ;; 10. inode number.
2427 ;; 11. Device number. Will be replaced by a virtual device number.
2431 (defun tramp-handle-file-attributes-with-perl
2432 (vec localname &optional id-format)
2433 "Implement `file-attributes' for Tramp files using a Perl script."
2434 (tramp-message vec 5 "file attributes with perl: %s" localname)
2435 (tramp-maybe-send-script
2436 vec tramp-perl-file-attributes "tramp_perl_file_attributes")
2437 (tramp-send-command-and-read
2439 (format "tramp_perl_file_attributes %s %s"
2440 (tramp-shell-quote-argument localname) id-format)))
2442 (defun tramp-handle-file-attributes-with-stat
2443 (vec localname &optional id-format)
2444 "Implement `file-attributes' for Tramp files using stat(1) command."
2445 (tramp-message vec 5 "file attributes with stat: %s" localname)
2446 (tramp-send-command-and-read
2449 "%s -c '((\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)' %s"
2450 (tramp-get-remote-stat vec)
2451 (if (eq id-format 'integer) "%u" "\"%U\"")
2452 (if (eq id-format 'integer) "%g" "\"%G\"")
2453 (tramp-shell-quote-argument localname))))
2455 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
2456 "Like `set-visited-file-modtime' for Tramp files."
2457 (unless (buffer-file-name)
2458 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
2461 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
2462 (let ((f (buffer-file-name))
2464 (with-parsed-tramp-file-name f nil
2465 (let* ((attr (file-attributes f))
2466 ;; '(-1 65535) means file doesn't exists yet.
2467 (modtime (or (nth 5 attr) '(-1 65535))))
2468 (when (boundp 'last-coding-system-used)
2469 (setq coding-system-used (symbol-value 'last-coding-system-used)))
2470 ;; We use '(0 0) as a don't-know value. See also
2471 ;; `tramp-handle-file-attributes-with-ls'.
2472 (if (not (equal modtime '(0 0)))
2473 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
2477 (format "%s -ild %s"
2478 (tramp-get-ls-command v)
2479 (tramp-shell-quote-argument localname)))
2480 (setq attr (buffer-substring (point)
2481 (progn (end-of-line) (point)))))
2482 (tramp-set-file-property
2483 v localname "visited-file-modtime-ild" attr))
2484 (when (boundp 'last-coding-system-used)
2485 (set 'last-coding-system-used coding-system-used))
2488 ;; CCC continue here
2490 ;; This function makes the same assumption as
2491 ;; `tramp-handle-set-visited-file-modtime'.
2492 (defun tramp-handle-verify-visited-file-modtime (buf)
2493 "Like `verify-visited-file-modtime' for Tramp files.
2494 At the time `verify-visited-file-modtime' calls this function, we
2495 already know that the buffer is visiting a file and that
2496 `visited-file-modtime' does not return 0. Do not call this
2497 function directly, unless those two cases are already taken care
2499 (with-current-buffer buf
2500 ;; There is no file visiting the buffer, or the buffer has no
2501 ;; recorded last modification time.
2502 (if (or (not (buffer-file-name))
2503 (eq (visited-file-modtime) 0))
2505 (let ((f (buffer-file-name)))
2506 (with-parsed-tramp-file-name f nil
2507 (tramp-flush-file-property v localname)
2508 (let* ((attr (file-attributes f))
2509 (modtime (nth 5 attr))
2510 (mt (visited-file-modtime)))
2513 ;; file exists, and has a known modtime.
2514 ((and attr (not (equal modtime '(0 0))))
2515 (< (abs (tramp-time-diff
2517 ;; For compatibility, deal with both the old
2518 ;; (HIGH . LOW) and the new (HIGH LOW)
2519 ;; return values of `visited-file-modtime'.
2521 (list (car mt) (cdr mt))
2524 ;; modtime has the don't know value.
2528 (format "%s -ild %s"
2529 (tramp-get-ls-command v)
2530 (tramp-shell-quote-argument localname)))
2531 (with-current-buffer (tramp-get-buffer v)
2532 (setq attr (buffer-substring
2533 (point) (progn (end-of-line) (point)))))
2536 (tramp-get-file-property
2537 v localname "visited-file-modtime-ild" "")))
2538 ;; If file does not exist, say it is not modified
2539 ;; if and only if that agrees with the buffer's record.
2540 (t (equal mt '(-1 65535))))))))))
2542 (defun tramp-handle-set-file-modes (filename mode)
2543 "Like `set-file-modes' for Tramp files."
2544 (with-parsed-tramp-file-name filename nil
2545 (tramp-flush-file-property v localname)
2546 (unless (zerop (tramp-send-command-and-check
2548 (format "chmod %s %s"
2549 (tramp-decimal-to-octal mode)
2550 (tramp-shell-quote-argument localname))))
2551 ;; FIXME: extract the proper text from chmod's stderr.
2553 v 'file-error "Error while changing file's mode %s" filename))))
2555 (defun tramp-handle-set-file-times (filename &optional time)
2556 "Like `set-file-times' for Tramp files."
2558 (if (file-remote-p filename)
2559 (with-parsed-tramp-file-name filename nil
2560 (tramp-flush-file-property v localname)
2561 (let ((time (if (or (null time) (equal time '(0 0)))
2565 ;; With GNU Emacs, `format-time-string' has an
2566 ;; optional parameter UNIVERSAL. This is preferred,
2567 ;; because we could handle the case when the remote
2568 ;; host is located in a different time zone as the
2570 (and (functionp 'subr-arity)
2571 (subrp (symbol-function 'format-time-string))
2572 (= 3 (cdr (funcall (symbol-function 'subr-arity)
2574 'format-time-string)))))))
2575 (tramp-send-command-and-check
2576 v (format "%s touch -t %s %s"
2577 (if utc "TZ=UTC; export TZ;" "")
2579 (format-time-string "%Y%m%d%H%M.%S" time t)
2580 (format-time-string "%Y%m%d%H%M.%S" time))
2581 (tramp-shell-quote-argument localname)))))
2583 ;; We handle also the local part, because in older Emacsen,
2584 ;; without `set-file-times', this function is an alias for this.
2585 ;; We are local, so we don't need the UTC settings.
2586 (tramp-local-call-process
2587 "touch" nil nil nil "-t"
2588 (format-time-string "%Y%m%d%H%M.%S" time)
2589 (tramp-shell-quote-argument filename)))))
2591 (defun tramp-set-file-uid-gid (filename &optional uid gid)
2592 "Set the ownership for FILENAME.
2593 If UID and GID are provided, these values are used; otherwise uid
2594 and gid of the corresponding user is taken. Both parameters must be integers."
2595 ;; CCC: Modern Unices allow chown only for root. So we might need
2596 ;; another implementation, see `dired-do-chown'. OTOH, it is
2597 ;; mostly working with su(do)? when it is needed, so it shall
2598 ;; succeed in the majority of cases.
2599 (if (file-remote-p filename)
2600 (with-parsed-tramp-file-name filename nil
2601 (let ((uid (or (and (integerp uid) uid)
2602 (tramp-get-remote-uid v 'integer)))
2603 (gid (or (and (integerp gid) gid)
2604 (tramp-get-remote-gid v 'integer))))
2607 "chown %d:%d %s" uid gid
2608 (tramp-shell-quote-argument localname)))))
2610 ;; We handle also the local part, because there doesn't exist
2611 ;; `set-file-uid-gid'. On Win32 "chown" might not work.
2612 (let ((uid (or (and (integerp uid) uid) (tramp-get-local-uid 'integer)))
2613 (gid (or (and (integerp gid) gid) (tramp-get-local-gid 'integer))))
2614 (tramp-local-call-process
2616 (format "%d:%d" uid gid) (tramp-shell-quote-argument filename)))))
2618 ;; Simple functions using the `test' command.
2620 (defun tramp-handle-file-executable-p (filename)
2621 "Like `file-executable-p' for Tramp files."
2622 (with-parsed-tramp-file-name filename nil
2623 (with-file-property v localname "file-executable-p"
2624 (zerop (tramp-run-test "-x" filename)))))
2626 (defun tramp-handle-file-readable-p (filename)
2627 "Like `file-readable-p' for Tramp files."
2628 (with-parsed-tramp-file-name filename nil
2629 (with-file-property v localname "file-readable-p"
2630 (zerop (tramp-run-test "-r" filename)))))
2632 ;; When the remote shell is started, it looks for a shell which groks
2633 ;; tilde expansion. Here, we assume that all shells which grok tilde
2634 ;; expansion will also provide a `test' command which groks `-nt' (for
2635 ;; newer than). If this breaks, tell me about it and I'll try to do
2636 ;; something smarter about it.
2637 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2638 "Like `file-newer-than-file-p' for Tramp files."
2639 (cond ((not (file-exists-p file1))
2641 ((not (file-exists-p file2))
2643 ;; We are sure both files exist at this point.
2646 ;; We try to get the mtime of both files. If they are not
2647 ;; equal to the "dont-know" value, then we subtract the times
2648 ;; and obtain the result.
2649 (let ((fa1 (file-attributes file1))
2650 (fa2 (file-attributes file2)))
2651 (if (and (not (equal (nth 5 fa1) '(0 0)))
2652 (not (equal (nth 5 fa2) '(0 0))))
2653 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
2654 ;; If one of them is the dont-know value, then we can
2655 ;; still try to run a shell command on the remote host.
2656 ;; However, this only works if both files are Tramp
2657 ;; files and both have the same method, same user, same
2659 (unless (tramp-equal-remote file1 file2)
2660 (with-parsed-tramp-file-name
2661 (if (tramp-tramp-file-p file1) file1 file2) nil
2664 "Files %s and %s must have same method, user, host"
2666 (with-parsed-tramp-file-name file1 nil
2667 (zerop (tramp-run-test2
2668 (tramp-get-test-nt-command v) file1 file2)))))))))
2670 ;; Functions implemented using the basic functions above.
2672 (defun tramp-handle-file-modes (filename)
2673 "Like `file-modes' for Tramp files."
2674 (when (file-exists-p filename)
2675 (tramp-mode-string-to-int
2676 (nth 8 (file-attributes filename)))))
2678 (defun tramp-handle-file-directory-p (filename)
2679 "Like `file-directory-p' for Tramp files."
2680 ;; Care must be taken that this function returns `t' for symlinks
2681 ;; pointing to directories. Surely the most obvious implementation
2682 ;; would be `test -d', but that returns false for such symlinks.
2683 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
2684 ;; I now think he's right. So we could be using `test -d', couldn't
2687 ;; Alternatives: `cd %s', `test -d %s'
2688 (with-parsed-tramp-file-name filename nil
2689 (with-file-property v localname "file-directory-p"
2690 (zerop (tramp-run-test "-d" filename)))))
2692 (defun tramp-handle-file-regular-p (filename)
2693 "Like `file-regular-p' for Tramp files."
2694 (and (file-exists-p filename)
2695 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2697 (defun tramp-handle-file-symlink-p (filename)
2698 "Like `file-symlink-p' for Tramp files."
2699 (with-parsed-tramp-file-name filename nil
2700 (let ((x (car (file-attributes filename))))
2702 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2703 ;; might do weird things.
2704 (if (file-name-absolute-p x)
2705 (tramp-make-tramp-file-name method user host x)
2708 (defun tramp-handle-file-writable-p (filename)
2709 "Like `file-writable-p' for Tramp files."
2710 (with-parsed-tramp-file-name filename nil
2711 (with-file-property v localname "file-writable-p"
2712 (if (file-exists-p filename)
2713 ;; Existing files must be writable.
2714 (zerop (tramp-run-test "-w" filename))
2715 ;; If file doesn't exist, check if directory is writable.
2716 (and (zerop (tramp-run-test
2717 "-d" (file-name-directory filename)))
2718 (zerop (tramp-run-test
2719 "-w" (file-name-directory filename))))))))
2721 (defun tramp-handle-file-ownership-preserved-p (filename)
2722 "Like `file-ownership-preserved-p' for Tramp files."
2723 (with-parsed-tramp-file-name filename nil
2724 (with-file-property v localname "file-ownership-preserved-p"
2725 (let ((attributes (file-attributes filename)))
2726 ;; Return t if the file doesn't exist, since it's true that no
2727 ;; information would be lost by an (attempted) delete and create.
2728 (or (null attributes)
2729 (= (nth 2 attributes) (tramp-get-remote-uid v 'integer)))))))
2731 ;; Other file name ops.
2733 (defun tramp-handle-directory-file-name (directory)
2734 "Like `directory-file-name' for Tramp files."
2735 ;; If localname component of filename is "/", leave it unchanged.
2736 ;; Otherwise, remove any trailing slash from localname component.
2737 ;; Method, host, etc, are unchanged. Does it make sense to try
2738 ;; to avoid parsing the filename?
2739 (with-parsed-tramp-file-name directory nil
2740 (if (and (not (zerop (length localname)))
2741 (eq (aref localname (1- (length localname))) ?/)
2742 (not (string= localname "/")))
2743 (substring directory 0 -1)
2746 ;; Directory listings.
2748 (defun tramp-handle-directory-files
2749 (directory &optional full match nosort files-only)
2750 "Like `directory-files' for Tramp files."
2751 ;; FILES-ONLY is valid for XEmacs only.
2752 (when (file-directory-p directory)
2753 (setq directory (expand-file-name directory))
2754 (let ((temp (nreverse (file-name-all-completions "" directory)))
2758 (setq item (directory-file-name (pop temp)))
2759 (when (and (or (null match) (string-match match item))
2760 (or (null files-only)
2762 (and (equal files-only t) (file-regular-p item))
2764 (file-directory-p item)))
2765 (push (if full (expand-file-name item directory) item)
2769 (defun tramp-handle-directory-files-and-attributes
2770 (directory &optional full match nosort id-format)
2771 "Like `directory-files-and-attributes' for Tramp files."
2772 (unless id-format (setq id-format 'integer))
2773 (when (file-directory-p directory)
2774 (setq directory (expand-file-name directory))
2776 (tramp-compat-copy-tree
2777 (with-parsed-tramp-file-name directory nil
2780 (format "directory-files-and-attributes-%s" id-format)
2785 (tramp-convert-file-attributes v (cdr x))))
2786 (if (tramp-get-remote-stat v)
2787 (tramp-handle-directory-files-and-attributes-with-stat
2788 v localname id-format)
2789 (if (tramp-get-remote-perl v)
2790 (tramp-handle-directory-files-and-attributes-with-perl
2791 v localname id-format)))))))))
2795 (setq item (pop temp))
2796 (when (or (null match) (string-match match (car item)))
2798 (setcar item (expand-file-name (car item) directory)))
2799 (push item result)))
2803 (sort result (lambda (x y) (string< (car x) (car y))))))))
2805 (defun tramp-handle-directory-files-and-attributes-with-perl
2806 (vec localname &optional id-format)
2807 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
2808 (tramp-message vec 5 "directory-files-and-attributes with perl: %s" localname)
2809 (tramp-maybe-send-script
2810 vec tramp-perl-directory-files-and-attributes
2811 "tramp_perl_directory_files_and_attributes")
2813 (tramp-send-command-and-read
2815 (format "tramp_perl_directory_files_and_attributes %s %s"
2816 (tramp-shell-quote-argument localname) id-format))))
2817 (when (stringp object) (tramp-error vec 'file-error object))
2820 (defun tramp-handle-directory-files-and-attributes-with-stat
2821 (vec localname &optional id-format)
2822 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
2823 (tramp-message vec 5 "directory-files-and-attributes with stat: %s" localname)
2824 (tramp-send-command-and-read
2828 "cd %s; echo \"(\"; (%s -ab | xargs "
2829 "%s -c '(\"%%n\" (\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)'); "
2831 (tramp-shell-quote-argument localname)
2832 (tramp-get-ls-command vec)
2833 (tramp-get-remote-stat vec)
2834 (if (eq id-format 'integer) "%u" "\"%U\"")
2835 (if (eq id-format 'integer) "%g" "\"%G\""))))
2837 ;; This function should return "foo/" for directories and "bar" for
2839 (defun tramp-handle-file-name-all-completions (filename directory)
2840 "Like `file-name-all-completions' for Tramp files."
2841 (unless (save-match-data (string-match "/" filename))
2842 (with-parsed-tramp-file-name (expand-file-name directory) nil
2843 ;; Flush the directory cache. There could be changed directory
2845 (when (and (integerp tramp-completion-reread-directory-timeout)
2848 (tramp-get-file-property
2849 v localname "last-completion" '(0 0 0)))
2850 tramp-completion-reread-directory-timeout))
2851 (tramp-flush-file-property v localname))
2857 (with-file-property v localname "file-name-all-completions"
2859 (tramp-barf-unless-okay
2861 (format "cd %s" (tramp-shell-quote-argument localname))
2862 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
2863 (tramp-shell-quote-argument localname))
2865 ;; Get a list of directories and files, including reliably
2866 ;; tagging the directories with a trailing '/'. Because I
2867 ;; rock. --daniel@danann.net
2870 (format (concat "%s -ab 2>/dev/null | while read f; do "
2871 "if %s -d \"$f\" 2>/dev/null; "
2872 "then echo \"$f/\"; else echo \"$f\"; fi; done")
2873 (tramp-get-ls-command v)
2874 (tramp-get-test-command v)))
2876 ;; Now grab the output.
2877 (with-current-buffer (tramp-get-buffer v)
2878 (goto-char (point-max))
2879 (while (zerop (forward-line -1))
2880 (push (buffer-substring
2881 (point) (tramp-compat-line-end-position))
2884 (tramp-set-file-property
2885 v localname "last-completion" (current-time))
2888 ;; The following isn't needed for Emacs 20 but for 19.34?
2889 (defun tramp-handle-file-name-completion
2890 (filename directory &optional predicate)
2891 "Like `file-name-completion' for Tramp files."
2892 (unless (tramp-tramp-file-p directory)
2894 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2898 (mapcar 'list (file-name-all-completions filename directory))
2900 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2904 (defun tramp-handle-add-name-to-file
2905 (filename newname &optional ok-if-already-exists)
2906 "Like `add-name-to-file' for Tramp files."
2907 (unless (tramp-equal-remote filename newname)
2908 (with-parsed-tramp-file-name
2909 (if (tramp-tramp-file-p filename) filename newname) nil
2912 "add-name-to-file: %s"
2913 "only implemented for same method, same user, same host")))
2914 (with-parsed-tramp-file-name filename v1
2915 (with-parsed-tramp-file-name newname v2
2916 (let ((ln (when v1 (tramp-get-remote-ln v1))))
2917 (when (and (not ok-if-already-exists)
2918 (file-exists-p newname)
2919 (not (numberp ok-if-already-exists))
2922 "File %s already exists; make it a new name anyway? "
2926 "add-name-to-file: file %s already exists" newname))
2927 (tramp-flush-file-property v2 v2-localname)
2928 (tramp-barf-unless-okay
2930 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
2931 (tramp-shell-quote-argument v2-localname))
2932 "error with add-name-to-file, see buffer `%s' for details"
2935 (defun tramp-handle-copy-file
2936 (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
2937 "Like `copy-file' for Tramp files."
2938 ;; Check if both files are local -- invoke normal copy-file.
2939 ;; Otherwise, use Tramp from local system.
2940 (setq filename (expand-file-name filename))
2941 (setq newname (expand-file-name newname))
2943 ;; At least one file a Tramp file?
2944 ((or (tramp-tramp-file-p filename)
2945 (tramp-tramp-file-p newname))
2946 (tramp-do-copy-or-rename-file
2947 'copy filename newname ok-if-already-exists keep-date preserve-uid-gid))
2950 (tramp-run-real-handler
2952 (list filename newname ok-if-already-exists keep-date preserve-uid-gid)))
2954 (tramp-run-real-handler
2955 'copy-file (list filename newname ok-if-already-exists keep-date)))))
2957 (defun tramp-handle-rename-file
2958 (filename newname &optional ok-if-already-exists)
2959 "Like `rename-file' for Tramp files."
2960 ;; Check if both files are local -- invoke normal rename-file.
2961 ;; Otherwise, use Tramp from local system.
2962 (setq filename (expand-file-name filename))
2963 (setq newname (expand-file-name newname))
2964 ;; At least one file a Tramp file?
2965 (if (or (tramp-tramp-file-p filename)
2966 (tramp-tramp-file-p newname))
2967 (tramp-do-copy-or-rename-file
2968 'rename filename newname ok-if-already-exists t t)
2969 (tramp-run-real-handler
2970 'rename-file (list filename newname ok-if-already-exists))))
2972 (defun tramp-do-copy-or-rename-file
2973 (op filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
2974 "Copy or rename a remote file.
2975 OP must be `copy' or `rename' and indicates the operation to perform.
2976 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2977 the new file (for copy) or the new name of the file (for rename).
2978 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2979 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2980 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2981 the uid and gid if both files are on the same host.
2983 This function is invoked by `tramp-handle-copy-file' and
2984 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
2985 and `rename'. FILENAME and NEWNAME must be absolute file names."
2986 (unless (memq op '(copy rename))
2987 (error "Unknown operation `%s', must be `copy' or `rename'" op))
2988 (let ((t1 (tramp-tramp-file-p filename))
2989 (t2 (tramp-tramp-file-p newname)))
2991 (when (and (not ok-if-already-exists) (file-exists-p newname))
2992 (with-parsed-tramp-file-name (if t1 filename newname) nil
2994 v 'file-already-exists "File %s already exists" newname)))
2998 ;; Both are Tramp files.
3000 (with-parsed-tramp-file-name filename v1
3001 (with-parsed-tramp-file-name newname v2
3003 ;; Shortcut: if method, host, user are the same for both
3004 ;; files, we invoke `cp' or `mv' on the remote host
3006 ((tramp-equal-remote filename newname)
3007 (tramp-do-copy-or-rename-file-directly
3009 ok-if-already-exists keep-date preserve-uid-gid))
3011 ;; If both source and target are Tramp files,
3012 ;; both are using the same copy-program, then we
3013 ;; can invoke rcp directly. Note that
3014 ;; default-directory should point to a local
3015 ;; directory if we want to invoke rcp.
3016 ((and (equal v1-method v2-method)
3017 (tramp-method-out-of-band-p v1)
3018 (> (nth 7 (file-attributes filename))
3019 tramp-copy-size-limit))
3020 (tramp-do-copy-or-rename-file-out-of-band
3021 op filename newname keep-date))
3023 ;; No shortcut was possible. So we copy the
3024 ;; file first. If the operation was `rename', we go
3025 ;; back and delete the original file (if the copy was
3026 ;; successful). The approach is simple-minded: we
3027 ;; create a new buffer, insert the contents of the
3028 ;; source file into it, then write out the buffer to
3029 ;; the target file. The advantage is that it doesn't
3030 ;; matter which filename handlers are used for the
3031 ;; source and target file.
3033 (tramp-do-copy-or-rename-file-via-buffer
3034 op filename newname keep-date))))))
3036 ;; One file is a Tramp file, the other one is local.
3038 (with-parsed-tramp-file-name (if t1 filename newname) nil
3040 ;; Fast track on local machine.
3041 ((tramp-local-host-p v)
3042 (tramp-do-copy-or-rename-file-directly
3044 ok-if-already-exists keep-date preserve-uid-gid))
3046 ;; If the Tramp file has an out-of-band method, the corresponding
3047 ;; copy-program can be invoked.
3048 ((and (tramp-method-out-of-band-p v)
3049 (> (nth 7 (file-attributes filename))
3050 tramp-copy-size-limit))
3051 (tramp-do-copy-or-rename-file-out-of-band
3052 op filename newname keep-date))
3054 ;; Use the inline method via a Tramp buffer.
3055 (t (tramp-do-copy-or-rename-file-via-buffer
3056 op filename newname keep-date)))))
3059 ;; One of them must be a Tramp file.
3060 (error "Tramp implementation says this cannot happen")))
3062 ;; In case of `rename', we must flush the cache of the source file.
3063 (when (and t1 (eq op 'rename))
3064 (with-parsed-tramp-file-name filename nil
3065 (tramp-flush-file-property v localname)))
3067 ;; When newname did exist, we have wrong cached values.
3069 (with-parsed-tramp-file-name newname nil
3070 (tramp-flush-file-property v localname))))))
3072 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
3073 "Use an Emacs buffer to copy or rename a file.
3074 First arg OP is either `copy' or `rename' and indicates the operation.
3075 FILENAME is the source file, NEWNAME the target file.
3076 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
3078 ;; We must disable multibyte, because binary data shall not be
3080 (set-buffer-multibyte nil)
3081 (let ((coding-system-for-read 'binary)
3082 (jka-compr-inhibit t))
3083 (insert-file-contents-literally filename))
3084 ;; We don't want the target file to be compressed, so we let-bind
3085 ;; `jka-compr-inhibit' to t.
3086 (let ((coding-system-for-write 'binary)
3087 (jka-compr-inhibit t))
3088 (write-region (point-min) (point-max) newname)))
3089 ;; KEEP-DATE handling.
3090 (when keep-date (set-file-times newname (nth 5 (file-attributes filename))))
3092 (set-file-modes newname (file-modes filename))
3093 ;; If the operation was `rename', delete the original file.
3094 (unless (eq op 'copy) (delete-file filename)))
3096 (defun tramp-do-copy-or-rename-file-directly
3097 (op filename newname ok-if-already-exists keep-date preserve-uid-gid)
3098 "Invokes `cp' or `mv' on the remote system.
3099 OP must be one of `copy' or `rename', indicating `cp' or `mv',
3100 respectively. FILENAME specifies the file to copy or rename,
3101 NEWNAME is the name of the new file (for copy) or the new name of
3102 the file (for rename). Both files must reside on the same host.
3103 KEEP-DATE means to make sure that NEWNAME has the same timestamp
3104 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
3105 the uid and gid from FILENAME."
3106 (let ((t1 (tramp-tramp-file-p filename))
3107 (t2 (tramp-tramp-file-p newname)))
3108 (with-parsed-tramp-file-name (if t1 filename newname) nil
3109 (let* ((cmd (cond ((and (eq op 'copy) preserve-uid-gid) "cp -f -p")
3110 ((eq op 'copy) "cp -f")
3111 ((eq op 'rename) "mv -f")
3114 "Unknown operation `%s', must be `copy' or `rename'"
3117 (if t1 (tramp-handle-file-remote-p filename 'localname) filename))
3119 (if t2 (tramp-handle-file-remote-p newname 'localname) newname))
3120 (prefix (file-remote-p (if t1 filename newname))))
3123 ;; Both files are on a remote host, with same user.
3127 (format "%s %s %s" cmd
3128 (tramp-shell-quote-argument localname1)
3129 (tramp-shell-quote-argument localname2)))
3130 (with-current-buffer (tramp-get-buffer v)
3131 (goto-char (point-min))
3135 ;; Mask cp -f error.
3137 tramp-operation-not-permitted-regexp nil t))
3138 (zerop (tramp-send-command-and-check v nil)))
3139 (tramp-error-with-buffer
3141 "Copying directly failed, see buffer `%s' for details."
3144 ;; We are on the local host.
3147 ;; We can do it directly.
3148 ((let (file-name-handler-alist)
3149 (and (file-readable-p localname1)
3150 (file-writable-p (file-name-directory localname2))
3151 (or (file-directory-p localname2)
3152 (file-writable-p localname2))))
3154 (tramp-compat-copy-file
3155 localname1 localname2 ok-if-already-exists
3156 keep-date preserve-uid-gid)
3157 (tramp-run-real-handler
3158 'rename-file (list localname1 localname2 ok-if-already-exists))))
3160 ;; We can do it directly with `tramp-send-command'
3161 ((let (file-name-handler-alist)
3162 (and (file-readable-p (concat prefix localname1))
3164 (file-name-directory (concat prefix localname2)))))
3165 (tramp-do-copy-or-rename-file-directly
3166 op (concat prefix localname1) (concat prefix localname2)
3167 ok-if-already-exists keep-date t)
3168 ;; We must change the ownership to the local user.
3169 (tramp-set-file-uid-gid
3170 (concat prefix localname2)
3171 (tramp-get-local-uid 'integer)
3172 (tramp-get-local-gid 'integer)))
3174 ;; We need a temporary file in between.
3176 ;; Create the temporary file.
3177 (let ((tmpfile (tramp-compat-make-temp-file localname1)))
3183 (tramp-shell-quote-argument localname1)
3184 (tramp-shell-quote-argument tmpfile)))
3185 ;; We must change the ownership as remote user.
3186 (tramp-set-file-uid-gid
3187 (concat prefix tmpfile)
3188 (tramp-get-local-uid 'integer)
3189 (tramp-get-local-gid 'integer)))
3192 (tramp-compat-copy-file
3193 localname1 tmpfile ok-if-already-exists
3194 keep-date preserve-uid-gid)
3195 (tramp-run-real-handler
3196 'rename-file (list localname1 tmpfile ok-if-already-exists)))
3197 ;; We must change the ownership as local user.
3198 (tramp-set-file-uid-gid
3200 (tramp-get-remote-uid v 'integer)
3201 (tramp-get-remote-gid v 'integer))))
3203 ;; Move the temporary file to its destination.
3209 (tramp-shell-quote-argument tmpfile)
3210 (tramp-shell-quote-argument localname2))))
3212 (tramp-run-real-handler
3214 (list tmpfile localname2 ok-if-already-exists))))))))))
3216 ;; Set the time and mode. Mask possible errors.
3217 ;; Won't be applied for 'rename.
3219 (when (and keep-date (not preserve-uid-gid))
3220 (set-file-times newname (nth 5 (file-attributes filename)))
3221 (set-file-modes newname (file-modes filename)))
3224 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
3225 "Invoke rcp program to copy.
3226 One of FILENAME and NEWNAME must be a Tramp name, the other must
3227 be a local filename. The method used must be an out-of-band method."
3228 (let ((t1 (tramp-tramp-file-p filename))
3229 (t2 (tramp-tramp-file-p newname))
3230 copy-program copy-args copy-keep-date port spec
3233 (with-parsed-tramp-file-name (if t1 filename newname) nil
3235 ;; Expand hops. Might be necessary for gateway methods.
3236 (setq v (car (tramp-compute-multi-hops v)))
3237 (aset v 3 localname)
3239 ;; Check which ones of source and target are Tramp files.
3240 (setq source (if t1 (tramp-make-copy-program-file-name v) filename)
3241 target (if t2 (tramp-make-copy-program-file-name v) newname))
3243 ;; Check for port number. Until now, there's no need for handling
3244 ;; like method, user, host.
3245 (setq host (tramp-file-name-real-host v)
3246 port (tramp-file-name-port v)
3247 port (or (and port (number-to-string port)) ""))
3249 ;; Compose copy command.
3250 (setq spec `((?h . ,host) (?u . ,user) (?p . ,port)
3251 (?t . ,(tramp-get-connection-property
3252 (tramp-get-connection-process v) "temp-file" ""))
3253 (?k . ,(if keep-date " " "")))
3254 copy-program (tramp-get-method-parameter
3255 method 'tramp-copy-program)
3256 copy-keep-date (tramp-get-method-parameter
3257 method 'tramp-copy-keep-date)
3264 ;; " " is indication for keep-date argument.
3265 x (delete " " (mapcar '(lambda (y) (format-spec y spec)) x)))
3266 (unless (member "" x) (mapconcat 'identity x " ")))
3267 (tramp-get-method-parameter method 'tramp-copy-args))))
3269 ;; Check for program.
3270 (when (and (fboundp 'executable-find)
3271 (not (let ((default-directory
3272 (tramp-compat-temporary-file-directory)))
3273 (executable-find copy-program))))
3275 v 'file-error "Cannot find copy program: %s" copy-program))
3277 (tramp-message v 0 "Transferring %s to %s..." filename newname)
3281 ;; The default directory must be remote.
3282 (let ((default-directory
3283 (file-name-directory (if t1 filename newname))))
3284 ;; Set the transfer process properties.
3285 (tramp-set-connection-property
3286 v "process-name" (buffer-name (current-buffer)))
3287 (tramp-set-connection-property
3288 v "process-buffer" (current-buffer))
3290 ;; Use an asynchronous process. By this, password can
3291 ;; be handled. The default directory must be local, in
3292 ;; order to apply the correct `copy-program'. We don't
3293 ;; set a timeout, because the copying of large files can
3294 ;; last longer than 60 secs.
3295 (let ((p (let ((default-directory
3296 (tramp-compat-temporary-file-directory)))
3297 (apply 'start-process
3298 (tramp-get-connection-property
3299 v "process-name" nil)
3300 (tramp-get-connection-property
3301 v "process-buffer" nil)
3303 (append copy-args (list source target))))))
3305 v 6 "%s" (mapconcat 'identity (process-command p) " "))
3306 (set-process-sentinel p 'tramp-process-sentinel)
3307 (tramp-set-process-query-on-exit-flag p nil)
3308 (tramp-process-actions p v tramp-actions-copy-out-of-band))))
3310 ;; Reset the transfer process properties.
3311 (tramp-set-connection-property v "process-name" nil)
3312 (tramp-set-connection-property v "process-buffer" nil))
3314 (tramp-message v 0 "Transferring %s to %s...done" filename newname)
3316 ;; Handle KEEP-DATE argument.
3317 (when (and keep-date (not copy-keep-date))
3318 (set-file-times newname (nth 5 (file-attributes filename))))
3321 (unless (and keep-date copy-keep-date)
3322 (set-file-modes newname (file-modes filename))))
3324 ;; If the operation was `rename', delete the original file.
3325 (unless (eq op 'copy)
3326 (delete-file filename))))
3328 (defun tramp-handle-make-directory (dir &optional parents)
3329 "Like `make-directory' for Tramp files."
3330 (setq dir (expand-file-name dir))
3331 (with-parsed-tramp-file-name dir nil
3333 (tramp-barf-unless-okay
3336 (if parents "mkdir -p" "mkdir")
3337 (tramp-shell-quote-argument localname))
3338 "Couldn't make directory %s" dir))))
3340 (defun tramp-handle-delete-directory (directory)
3341 "Like `delete-directory' for Tramp files."
3342 (setq directory (expand-file-name directory))
3343 (with-parsed-tramp-file-name directory nil
3344 (tramp-flush-directory-property v localname)
3345 (unless (zerop (tramp-send-command-and-check
3347 (format "rmdir %s" (tramp-shell-quote-argument localname))))
3348 (tramp-error v 'file-error "Couldn't delete %s" directory))))
3350 (defun tramp-handle-delete-file (filename)
3351 "Like `delete-file' for Tramp files."
3352 (setq filename (expand-file-name filename))
3353 (with-parsed-tramp-file-name filename nil
3354 (tramp-flush-file-property v localname)
3355 (unless (zerop (tramp-send-command-and-check
3358 (tramp-shell-quote-argument localname))))
3359 (tramp-error v 'file-error "Couldn't delete %s" filename))))
3363 ;; CCC: This does not seem to be enough. Something dies when
3364 ;; we try and delete two directories under Tramp :/
3365 (defun tramp-handle-dired-recursive-delete-directory (filename)
3366 "Recursively delete the directory given.
3367 This is like `dired-recursive-delete-directory' for Tramp files."
3368 (with-parsed-tramp-file-name filename nil
3369 (tramp-flush-directory-property v filename)
3370 ;; Run a shell command 'rm -r <localname>'
3371 ;; Code shamelessly stolen for the dired implementation and, um, hacked :)
3372 (unless (file-exists-p filename)
3373 (tramp-error v 'file-error "No such directory: %s" filename))
3374 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
3377 (format "rm -rf %s" (tramp-shell-quote-argument localname))
3378 ;; Don't read the output, do it explicitely.
3380 ;; Wait for the remote system to return to us...
3381 ;; This might take a while, allow it plenty of time.
3382 (tramp-wait-for-output (tramp-get-connection-process v) 120)
3383 ;; Make sure that it worked...
3384 (and (file-exists-p filename)
3386 v 'file-error "Failed to recursively delete %s" filename))))
3388 (defun tramp-handle-dired-compress-file (file &rest ok-flag)
3389 "Like `dired-compress-file' for Tramp files."
3390 ;; OK-FLAG is valid for XEmacs only, but not implemented.
3391 ;; Code stolen mainly from dired-aux.el.
3392 (with-parsed-tramp-file-name file nil
3393 (tramp-flush-file-property v localname)
3396 (if (not (featurep 'xemacs))
3398 (symbol-value 'dired-compress-file-suffixes)
3399 ;; XEmacs has `dired-compression-method-alist', which is
3400 ;; transformed into `dired-compress-file-suffixes' structure.
3403 (list (concat (regexp-quote (nth 1 x)) "\\'")
3405 (mapconcat 'identity (nth 3 x) " ")))
3406 (symbol-value 'dired-compression-method-alist))))
3408 ;; See if any suffix rule matches this file name.
3410 (let (case-fold-search)
3411 (if (string-match (car (car suffixes)) localname)
3412 (setq suffix (car suffixes) suffixes nil))
3413 (setq suffixes (cdr suffixes))))
3415 (cond ((file-symlink-p file)
3417 ((and suffix (nth 2 suffix))
3418 ;; We found an uncompression rule.
3419 (tramp-message v 0 "Uncompressing %s..." file)
3420 (when (zerop (tramp-send-command-and-check
3421 v (concat (nth 2 suffix) " " localname)))
3422 (tramp-message v 0 "Uncompressing %s...done" file)
3423 ;; `dired-remove-file' is not defined in XEmacs
3424 (funcall (symbol-function 'dired-remove-file) file)
3425 (string-match (car suffix) file)
3426 (concat (substring file 0 (match-beginning 0)))))
3428 ;; We don't recognize the file as compressed, so compress it.
3430 (tramp-message v 0 "Compressing %s..." file)
3431 (when (zerop (tramp-send-command-and-check
3432 v (concat "gzip -f " localname)))
3433 (tramp-message v 0 "Compressing %s...done" file)
3434 ;; `dired-remove-file' is not defined in XEmacs
3435 (funcall (symbol-function 'dired-remove-file) file)
3436 (cond ((file-exists-p (concat file ".gz"))
3437 (concat file ".gz"))
3438 ((file-exists-p (concat file ".z"))
3442 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
3443 ;; not sure at all that this is the right way to do it, but let's hope
3444 ;; it works for now, and wait for a guru to point out the Right Way to
3446 ;;(eval-when-compile
3447 ;; (unless (fboundp 'dired-insert-set-properties)
3448 ;; (fset 'dired-insert-set-properties 'ignore)))
3449 ;; Gerd suggests this:
3450 (eval-when-compile (require 'dired))
3451 ;; Note that dired is required at run-time, too, when it is needed.
3452 ;; It is only needed on XEmacs for the function
3453 ;; `dired-insert-set-properties'.
3455 (defun tramp-handle-insert-directory
3456 (filename switches &optional wildcard full-directory-p)
3457 "Like `insert-directory' for Tramp files."
3458 (setq filename (expand-file-name filename))
3459 (with-parsed-tramp-file-name filename nil
3460 (tramp-flush-file-property v localname)
3461 (if (and (featurep 'ls-lisp)
3462 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
3463 (tramp-run-real-handler
3464 'insert-directory (list filename switches wildcard full-directory-p))
3465 ;; For the moment, we assume that the remote "ls" program does not
3466 ;; grok "--dired". In the future, we should detect this on
3467 ;; connection setup.
3468 (when (string-match "^--dired\\s-+" switches)
3469 (setq switches (replace-match "" nil t switches)))
3471 v 4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
3472 switches filename (if wildcard "yes" "no")
3473 (if full-directory-p "yes" "no"))
3475 (setq wildcard (tramp-run-real-handler
3476 'file-name-nondirectory (list localname)))
3477 (setq localname (tramp-run-real-handler
3478 'file-name-directory (list localname))))
3479 (when (listp switches)
3480 (setq switches (mapconcat 'identity switches " ")))
3481 (unless full-directory-p
3482 (setq switches (concat "-d " switches)))
3484 (setq switches (concat switches " " wildcard)))
3485 ;; If `full-directory-p', we just say `ls -l FILENAME'.
3486 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
3487 (if full-directory-p
3491 (tramp-get-ls-command v)
3495 (tramp-shell-quote-argument (concat localname ".")))))
3496 (tramp-barf-unless-okay
3498 (format "cd %s" (tramp-shell-quote-argument
3499 (tramp-run-real-handler
3500 'file-name-directory (list localname))))
3502 (tramp-shell-quote-argument
3503 (tramp-run-real-handler 'file-name-directory (list localname))))
3507 (tramp-get-ls-command v)
3511 (tramp-run-real-handler
3512 'file-name-nondirectory (list localname)))))
3514 (tramp-shell-quote-argument
3515 (tramp-run-real-handler
3516 'file-name-nondirectory (list localname)))))))
3517 ;; We cannot use `insert-buffer-substring' because the Tramp buffer
3518 ;; changes its contents before insertion due to calling
3519 ;; `expand-file' and alike.
3521 (with-current-buffer (tramp-get-buffer v)
3522 (buffer-string))))))
3524 (defun tramp-handle-unhandled-file-name-directory (filename)
3525 "Like `unhandled-file-name-directory' for Tramp files."
3526 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3527 ;; for backward compatibility.
3528 (expand-file-name "~/"))
3530 ;; Canonicalization of file names.
3532 (defun tramp-handle-expand-file-name (name &optional dir)
3533 "Like `expand-file-name' for Tramp files.
3534 If the localname part of the given filename starts with \"/../\" then
3535 the result will be a local, non-Tramp, filename."
3536 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
3537 (setq dir (or dir default-directory "/"))
3538 ;; Unless NAME is absolute, concat DIR and NAME.
3539 (unless (file-name-absolute-p name)
3540 (setq name (concat (file-name-as-directory dir) name)))
3541 ;; If NAME is not a Tramp file, run the real handler.
3542 (if (not (tramp-tramp-file-p name))
3543 (tramp-run-real-handler 'expand-file-name (list name nil))
3545 (with-parsed-tramp-file-name name nil
3546 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
3547 (setq localname (concat "~/" localname)))
3548 ;; Tilde expansion if necessary. This needs a shell which
3549 ;; groks tilde expansion! The function `tramp-find-shell' is
3550 ;; supposed to find such a shell on the remote host. Please
3551 ;; tell me about it when this doesn't work on your system.
3552 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
3553 (let ((uname (match-string 1 localname))
3554 (fname (match-string 2 localname)))
3555 ;; We cannot simply apply "~/", because under sudo "~/" is
3556 ;; expanded to the local user home directory but to the
3557 ;; root home directory. On the other hand, using always
3558 ;; the default user name for tilde expansion is not
3559 ;; appropriate either, because ssh and companions might
3560 ;; use a user name from the config file.
3561 (when (and (string-equal uname "~")
3562 (string-match "\\`su\\(do\\)?\\'" method))
3563 (setq uname (concat uname user)))
3565 (with-connection-property v uname
3566 (tramp-send-command v (format "cd %s; pwd" uname))
3567 (with-current-buffer (tramp-get-buffer v)
3568 (goto-char (point-min))
3569 (buffer-substring (point) (tramp-compat-line-end-position)))))
3570 (setq localname (concat uname fname))))
3571 ;; There might be a double slash, for example when "~/"
3572 ;; expands to "/". Remove this.
3573 (while (string-match "//" localname)
3574 (setq localname (replace-match "/" t t localname)))
3575 ;; No tilde characters in file name, do normal
3576 ;; expand-file-name (this does "/./" and "/../"). We bind
3577 ;; `directory-sep-char' here for XEmacs on Windows, which
3578 ;; would otherwise use backslash. `default-directory' is
3579 ;; bound, because on Windows there would be problems with UNC
3580 ;; shares or Cygwin mounts.
3581 (let ((directory-sep-char ?/)
3582 (default-directory (tramp-compat-temporary-file-directory)))
3583 (tramp-make-tramp-file-name
3585 (tramp-drop-volume-letter
3586 (tramp-run-real-handler
3587 'expand-file-name (list localname))))))))
3589 (defun tramp-replace-environment-variables (filename)
3590 "Replace environment variables in FILENAME.
3591 Return the string with the replaced variables."
3593 (let ((idx (string-match "$\\w+" filename)))
3594 ;; `$' is coded as `$$'.
3595 (when (and idx (or (zerop idx) (not (eq ?$ (aref filename (1- idx))))))
3598 (substitute-in-file-name (match-string 0 filename))
3602 (defun tramp-handle-substitute-in-file-name (filename)
3603 "Like `substitute-in-file-name' for Tramp files.
3604 \"//\" and \"/~\" substitute only in the local filename part.
3605 If the URL Tramp syntax is chosen, \"//\" as method delimeter and \"/~\" at
3606 beginning of local filename are not substituted."
3607 ;; First, we must replace environment variables.
3608 (setq filename (tramp-replace-environment-variables filename))
3609 (with-parsed-tramp-file-name filename nil
3610 (if (equal tramp-syntax 'url)
3611 ;; We need to check localname only. The other parts cannot contain
3613 (if (and (> (length localname) 1)
3614 (or (string-match "//" localname)
3615 (string-match "/~" localname 1)))
3616 (tramp-run-real-handler 'substitute-in-file-name (list filename))
3617 (tramp-make-tramp-file-name
3618 (when method (substitute-in-file-name method))
3619 (when user (substitute-in-file-name user))
3620 (when host (substitute-in-file-name host))
3622 (tramp-run-real-handler
3623 'substitute-in-file-name (list localname)))))
3624 ;; Ignore in LOCALNAME everything before "//" or "/~".
3625 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3627 (concat (file-remote-p filename)
3628 (replace-match "\\1" nil nil localname)))
3629 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3630 (when (string-match "~$" filename)
3631 (setq filename (concat filename "/"))))
3632 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3634 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
3635 ;; which calls corresponding functions (see minibuf.el).
3636 (when (fboundp 'minibuffer-electric-separator)
3641 (around ,(intern (format "tramp-advice-%s" x)) activate)
3642 "Invoke `substitute-in-file-name' for Tramp files."
3643 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
3644 (tramp-tramp-file-p (buffer-substring)))
3645 ;; We don't need to handle `last-input-event', because
3646 ;; due to the key map we know it must be ?/ or ?~.
3647 (let ((s (concat (buffer-substring (point-min) (point))
3648 (string last-command-char))))
3649 (delete-region (point-min) (point))
3650 (insert (substitute-in-file-name s))
3651 (setq ad-return-value last-command-char))
3654 '(minibuffer-electric-separator
3655 minibuffer-electric-tilde)))
3658 ;;; Remote commands:
3660 (defun tramp-handle-executable-find (command)
3661 "Like `executable-find' for Tramp files."
3662 (with-parsed-tramp-file-name default-directory nil
3663 (tramp-find-executable v command (tramp-get-remote-path v) t)))
3665 ;; We use BUFFER also as connection buffer during setup. Because of
3666 ;; this, its original contents must be saved, and restored once
3667 ;; connection has been setup.
3668 (defun tramp-handle-start-file-process (name buffer program &rest args)
3669 "Like `start-file-process' for Tramp files."
3670 (with-parsed-tramp-file-name default-directory nil
3673 ;; Set the new process properties.
3674 (tramp-set-connection-property v "process-name" name)
3675 (tramp-set-connection-property
3677 ;; BUFFER can be nil.
3678 (get-buffer-create (or buffer (current-buffer))))
3679 ;; Activate narrowing in order to save BUFFER contents.
3680 (with-current-buffer (tramp-get-connection-buffer v)
3681 (narrow-to-region (point-max) (point-max)))
3682 ;; Goto working directory. `tramp-send-command' opens a new
3685 v (format "cd %s" (tramp-shell-quote-argument localname)))
3686 ;; Send the command.
3689 (format "%s; echo %s; exit"
3690 (mapconcat 'tramp-shell-quote-argument
3691 (cons program args) " ")
3692 (tramp-shell-quote-argument tramp-end-of-output))
3695 (tramp-get-connection-process v))
3697 (with-current-buffer (tramp-get-connection-buffer v)
3699 (goto-char (point-max)))
3700 (tramp-set-connection-property v "process-name" nil)
3701 (tramp-set-connection-property v "process-buffer" nil))))
3703 (defun tramp-handle-process-file
3704 (program &optional infile destination display &rest args)
3705 "Like `process-file' for Tramp files."
3706 ;; The implementation is not complete yet.
3707 (when (and (numberp destination) (zerop destination))
3708 (error "Implementation does not handle immediate return"))
3710 (with-parsed-tramp-file-name default-directory nil
3711 (let (command input tmpinput stderr tmpstderr outbuf ret)
3713 (setq command (mapconcat 'tramp-shell-quote-argument
3714 (cons program args) " "))
3717 (setq input "/dev/null")
3718 (setq infile (expand-file-name infile))
3719 (if (tramp-equal-remote default-directory infile)
3720 ;; INFILE is on the same remote host.
3721 (setq input (with-parsed-tramp-file-name infile nil localname))
3722 ;; INFILE must be copied to remote host.
3723 (setq input (tramp-make-tramp-temp-file v)
3724 tmpinput (tramp-make-tramp-file-name method user host input))
3725 (copy-file infile tmpinput t)))
3726 (when input (setq command (format "%s <%s" command input)))
3728 ;; Determine output.
3731 ((bufferp destination)
3732 (setq outbuf destination))
3734 ((stringp destination)
3735 (setq outbuf (get-buffer-create destination)))
3736 ;; (REAL-DESTINATION ERROR-DESTINATION)
3737 ((consp destination)
3740 ((bufferp (car destination))
3741 (setq outbuf (car destination)))
3742 ((stringp (car destination))
3743 (setq outbuf (get-buffer-create (car destination))))
3745 (setq outbuf (current-buffer))))
3748 ((stringp (cadr destination))
3749 (setcar (cdr destination) (expand-file-name (cadr destination)))
3750 (if (tramp-equal-remote default-directory (cadr destination))
3751 ;; stderr is on the same remote host.
3752 (setq stderr (with-parsed-tramp-file-name
3753 (cadr destination) nil localname))
3754 ;; stderr must be copied to remote host. The temporary
3755 ;; file must be deleted after execution.
3756 (setq stderr (tramp-make-tramp-temp-file v)
3757 tmpstderr (tramp-make-tramp-file-name
3758 method user host stderr))))
3759 ;; stderr to be discarded
3760 ((null (cadr destination))
3761 (setq stderr "/dev/null"))))
3764 (setq outbuf (current-buffer))))
3765 (when stderr (setq command (format "%s 2>%s" command stderr)))
3767 ;; Goto working directory.
3769 v (format "cd %s" (tramp-shell-quote-argument localname)))
3770 ;; Send the command. It might not return in time, so we protect it.
3773 (tramp-send-command v command)
3774 ;; We should show the output anyway.
3776 (let ((output-string
3777 (with-current-buffer (tramp-get-connection-buffer v)
3778 (buffer-substring (point-min) (point-max)))))
3779 (with-current-buffer outbuf
3780 (insert output-string)))
3781 (when display (display-buffer outbuf))))
3782 ;; When the user did interrupt, we should do it also.
3784 (kill-buffer (tramp-get-connection-buffer v))
3787 ;; Check return code.
3788 (unless ret (setq ret (tramp-send-command-and-check v nil)))
3789 ;; Provide error file.
3790 (when tmpstderr (rename-file tmpstderr (cadr destination) t))
3792 (when tmpinput (delete-file tmpinput))
3793 ;; Return exit status.
3796 (defun tramp-local-call-process
3797 (program &optional infile destination display &rest args)
3798 "Calls `call-process' on the local host.
3799 This is needed because for some Emacs flavors Tramp has
3800 defadviced `call-process' to behave like `process-file'. The
3801 Lisp error raised when PROGRAM is nil is trapped also, returning 1."
3802 (let ((default-directory
3803 (if (file-remote-p default-directory)
3804 (tramp-compat-temporary-file-directory)
3805 default-directory)))
3806 (if (executable-find program)
3807 (apply 'call-process program infile destination display args)
3810 (defun tramp-handle-call-process-region
3811 (start end program &optional delete buffer display &rest args)
3812 "Like `call-process-region' for Tramp files."
3813 (let ((tmpfile (tramp-compat-make-temp-file "")))
3814 (write-region start end tmpfile)
3815 (when delete (delete-region start end))
3817 (apply 'call-process program tmpfile buffer display args)
3818 (delete-file tmpfile))))
3820 (defun tramp-handle-shell-command
3821 (command &optional output-buffer error-buffer)
3822 "Like `shell-command' for Tramp files."
3823 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3824 ;; We cannot use `shell-file-name' and `shell-command-switch',
3825 ;; they are variables of the local host.
3826 (args (list "/bin/sh" "-c" (substring command 0 asynchronous)))
3829 ((bufferp output-buffer) output-buffer)
3830 ((stringp output-buffer) (get-buffer-create output-buffer))
3831 (output-buffer (current-buffer))
3832 (t (get-buffer-create
3834 "*Async Shell Command*"
3835 "*Shell Command Output*")))))
3838 ((bufferp error-buffer) error-buffer)
3839 ((stringp error-buffer) (get-buffer-create error-buffer))))
3841 (if (and (not asynchronous) error-buffer)
3842 (with-parsed-tramp-file-name default-directory nil
3843 (list output-buffer (tramp-make-tramp-temp-file v)))
3845 (p (get-buffer-process output-buffer)))
3847 ;; Check whether there is another process running. Tramp does not
3848 ;; support 2 (asynchronous) processes in parallel.
3850 (if (yes-or-no-p "A command is running. Kill it? ")
3854 (error "Shell command in progress")))
3856 (with-current-buffer output-buffer
3857 (setq buffer-read-only nil
3861 (if (integerp asynchronous)
3864 (apply 'start-file-process "*Async Shell*" buffer args)
3866 (pop-to-buffer output-buffer)
3867 (setq mode-line-process '(":%s"))
3868 (require 'shell) (shell-mode))
3872 (apply 'process-file (car args) nil buffer nil (cdr args))
3873 ;; Insert error messages if they were separated.
3874 (when (listp buffer)
3875 (with-current-buffer error-buffer
3876 (insert-file-contents (cadr buffer)))
3877 (delete-file (cadr buffer)))
3878 ;; There's some output, display it.
3879 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
3880 (if (functionp 'display-message-or-buffer)
3881 (funcall (symbol-function 'display-message-or-buffer)
3883 (pop-to-buffer output-buffer)))))))
3887 (defvar tramp-handle-file-local-copy-hook nil
3888 "Normal hook to be run at the end of `tramp-handle-file-local-copy'.")
3890 (defun tramp-handle-file-local-copy (filename)
3891 "Like `file-local-copy' for Tramp files."
3893 (with-parsed-tramp-file-name filename nil
3894 (let ((rem-enc (tramp-get-remote-coding v "remote-encoding"))
3895 (loc-dec (tramp-get-local-coding v "local-decoding"))
3896 (tmpfile (tramp-compat-make-temp-file filename)))
3897 (unless (file-exists-p filename)
3900 "Cannot make local copy of non-existing file `%s'" filename))
3903 ;; `copy-file' handles direct copy and out-of-band methods.
3904 ((or (tramp-local-host-p v)
3905 (and (tramp-method-out-of-band-p v)
3906 (> (nth 7 (file-attributes filename)) tramp-copy-size-limit)))
3907 (copy-file filename tmpfile t t))
3909 ;; Use inline encoding for file transfer.
3912 (tramp-message v 5 "Encoding remote file %s..." filename)
3913 (tramp-barf-unless-okay
3914 v (format "%s < %s" rem-enc (tramp-shell-quote-argument localname))
3915 "Encoding remote file failed")
3916 (tramp-message v 5 "Encoding remote file %s...done" filename)
3918 (tramp-message v 5 "Decoding remote file %s..." filename)
3919 (if (and (symbolp loc-dec) (fboundp loc-dec))
3920 ;; If local decoding is a function, we call it. We must
3921 ;; disable multibyte, because `uudecode-decode-region'
3922 ;; doesn't handle it correctly.
3925 (set-buffer-multibyte nil)
3926 (insert-buffer-substring (tramp-get-buffer v))
3928 v 5 "Decoding remote file %s with function %s..."
3930 (funcall loc-dec (point-min) (point-max))
3931 (let ((coding-system-for-write 'binary))
3932 (write-region (point-min) (point-max) tmpfile))))
3933 ;; If tramp-decoding-function is not defined for this
3934 ;; method, we invoke tramp-decoding-command instead.
3935 (let ((tmpfile2 (tramp-compat-make-temp-file filename)))
3936 (let ((coding-system-for-write 'binary))
3937 (write-region (point-min) (point-max) tmpfile2))
3939 v 5 "Decoding remote file %s with command %s..."
3941 (tramp-call-local-coding-command loc-dec tmpfile2 tmpfile)
3942 (delete-file tmpfile2)))
3943 (tramp-message v 5 "Decoding remote file %s...done" filename)
3944 ;; Set proper permissions.
3945 (set-file-modes tmpfile (file-modes filename))
3946 ;; Set local user ownership.
3947 (tramp-set-file-uid-gid tmpfile)))
3949 ;; Oops, I don't know what to do.
3951 v 'file-error "Wrong method specification for `%s'" method)))
3953 (run-hooks 'tramp-handle-file-local-copy-hook)
3956 (defun tramp-handle-file-remote-p (filename &optional identification connected)
3957 "Like `file-remote-p' for Tramp files."
3958 (when (tramp-tramp-file-p filename)
3959 (with-parsed-tramp-file-name filename nil
3960 (and (or (not connected)
3961 (let ((p (tramp-get-connection-process v)))
3962 (and p (processp p) (memq (process-status p) '(run open)))))
3964 ((eq identification 'method) method)
3965 ((eq identification 'user) user)
3966 ((eq identification 'host) host)
3967 ((eq identification 'localname) localname)
3968 (t (tramp-make-tramp-file-name method user host "")))))))
3970 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
3971 "Like `find-operation-coding-system' for Tramp filenames.
3972 Tramp's `insert-file-contents' and `write-region' work over
3973 temporary file names. If `file-coding-system-alist' contains an
3974 expression, which matches more than the file name suffix, the
3975 coding system might not be determined. This function repairs it."
3977 (dolist (elt file-coding-system-alist result)
3978 (when (and (consp elt) (string-match (car elt) filename))
3979 ;; We found a matching entry in `file-coding-system-alist'.
3980 ;; So we add a similar entry, but with the temporary file name
3983 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
3985 (defun tramp-handle-insert-file-contents
3986 (filename &optional visit beg end replace)
3987 "Like `insert-file-contents' for Tramp files."
3988 (barf-if-buffer-read-only)
3989 (setq filename (expand-file-name filename))
3990 (let (coding-system-used result)
3991 (with-parsed-tramp-file-name filename nil
3993 (if (not (file-exists-p filename))
3996 (setq buffer-file-name filename)
3997 (set-visited-file-modtime)
3998 (set-buffer-modified-p nil))
3999 ;; We don't raise a Tramp error, because it might be
4000 ;; suppressed, like in `find-file-noselect-1'.
4001 (signal 'file-error (list "File not found on remote host" filename))
4002 (list (expand-file-name filename) 0))
4004 (if (and (tramp-local-host-p v)
4005 (let (file-name-handler-alist) (file-readable-p localname)))
4006 ;; Short track: if we are on the local host, we can run directly.
4008 (tramp-run-real-handler
4009 'insert-file-contents
4010 (list localname visit beg end replace)))
4012 ;; `insert-file-contents-literally' takes care to avoid calling
4013 ;; jka-compr. By let-binding inhibit-file-name-operation, we
4014 ;; propagate that care to the file-local-copy operation.
4016 (let ((inhibit-file-name-operation
4017 (when (eq inhibit-file-name-operation
4018 'insert-file-contents)
4020 (file-local-copy filename))))
4021 (tramp-message v 4 "Inserting local temp file `%s'..." local-copy)
4022 ;; We must ensure that `file-coding-system-alist' matches
4024 (let ((file-coding-system-alist
4025 (tramp-find-file-name-coding-system-alist
4026 filename local-copy)))
4028 (insert-file-contents local-copy nil beg end replace))
4029 ;; Now `last-coding-system-used' has right value. Remember it.
4030 (when (boundp 'last-coding-system-used)
4031 (setq coding-system-used
4032 (symbol-value 'last-coding-system-used))))
4034 v 4 "Inserting local temp file `%s'...done" local-copy)
4035 (delete-file local-copy)
4036 (when (boundp 'last-coding-system-used)
4037 (set 'last-coding-system-used coding-system-used))))
4040 (setq buffer-read-only (file-writable-p filename))
4041 (setq buffer-file-name filename)
4042 (set-visited-file-modtime)
4043 (set-buffer-modified-p nil))
4044 (list (expand-file-name filename)
4047 ;; This is needed for XEmacs only. Code stolen from files.el.
4048 (defun tramp-handle-insert-file-contents-literally
4049 (filename &optional visit beg end replace)
4050 "Like `insert-file-contents-literally' for Tramp files."
4051 (let ((format-alist nil)
4052 (after-insert-file-functions nil)
4053 (coding-system-for-read 'no-conversion)
4054 (coding-system-for-write 'no-conversion)
4055 (find-buffer-file-type-function
4056 (if (fboundp 'find-buffer-file-type)
4057 (symbol-function 'find-buffer-file-type)
4059 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
4060 (inhibit-file-name-operation 'insert-file-contents))
4063 (fset 'find-buffer-file-type (lambda (filename) t))
4064 (insert-file-contents filename visit beg end replace))
4065 (if find-buffer-file-type-function
4066 (fset 'find-buffer-file-type find-buffer-file-type-function)
4067 (fmakunbound 'find-buffer-file-type)))))
4069 (defun tramp-handle-find-backup-file-name (filename)
4070 "Like `find-backup-file-name' for Tramp files."
4071 (with-parsed-tramp-file-name filename nil
4072 ;; We set both variables. It doesn't matter whether it is
4074 (let ((backup-directory-alist
4076 (when (boundp 'backup-directory-alist)
4077 (if (boundp 'tramp-backup-directory-alist)
4082 (if (and (stringp (cdr x))
4083 (file-name-absolute-p (cdr x))
4084 (not (tramp-file-name-p (cdr x))))
4085 (tramp-make-tramp-file-name method user host (cdr x))
4087 (symbol-value 'tramp-backup-directory-alist))
4088 (symbol-value 'backup-directory-alist))))
4090 (bkup-backup-directory-info
4092 (when (boundp 'bkup-backup-directory-info)
4093 (if (boundp 'tramp-bkup-backup-directory-info)
4099 (if (and (stringp (car (cdr x)))
4100 (file-name-absolute-p (car (cdr x)))
4101 (not (tramp-file-name-p (car (cdr x)))))
4102 (tramp-make-tramp-file-name
4103 method user host (car (cdr x)))
4106 (symbol-value 'tramp-bkup-backup-directory-info))
4107 (symbol-value 'bkup-backup-directory-info)))))
4109 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
4111 (defun tramp-handle-make-auto-save-file-name ()
4112 "Like `make-auto-save-file-name' for Tramp files.
4113 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
4114 (let ((tramp-auto-save-directory tramp-auto-save-directory)
4116 (tramp-subst-strs-in-string
4123 (buffer-file-name))))
4124 ;; File name must be unique. This is ensured with Emacs 22 (see
4125 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
4126 ;; all other cases we must do it ourselves.
4127 (when (boundp 'auto-save-file-name-transforms)
4130 (when (and (string-match (car x) buffer-file-name)
4131 (not (car (cddr x))))
4132 (setq tramp-auto-save-directory
4133 (or tramp-auto-save-directory
4134 (tramp-compat-temporary-file-directory)))))
4135 (symbol-value 'auto-save-file-name-transforms)))
4136 ;; Create directory.
4137 (when tramp-auto-save-directory
4138 (setq buffer-file-name
4139 (expand-file-name buffer-file-name tramp-auto-save-directory))
4140 (unless (file-exists-p tramp-auto-save-directory)
4141 (make-directory tramp-auto-save-directory t)))
4142 ;; Run plain `make-auto-save-file-name'. There might be an advice when
4143 ;; it is not a magic file name operation (since Emacs 22).
4144 ;; We must deactivate it temporarily.
4145 (if (not (ad-is-active 'make-auto-save-file-name))
4146 (tramp-run-real-handler 'make-auto-save-file-name nil)
4148 (ad-deactivate 'make-auto-save-file-name)
4150 (tramp-run-real-handler 'make-auto-save-file-name nil)
4151 (ad-activate 'make-auto-save-file-name)))))
4153 (defvar tramp-handle-write-region-hook nil
4154 "Normal hook to be run at the end of `tramp-handle-write-region'.")
4156 ;; CCC grok APPEND, LOCKNAME
4157 (defun tramp-handle-write-region
4158 (start end filename &optional append visit lockname confirm)
4159 "Like `write-region' for Tramp files."
4160 (setq filename (expand-file-name filename))
4161 (with-parsed-tramp-file-name filename nil
4162 (unless (null append)
4164 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
4165 ;; Following part commented out because we don't know what to do about
4166 ;; file locking, and it does not appear to be a problem to ignore it.
4167 ;; Ange-ftp ignores it, too.
4168 ;; (when (and lockname (stringp lockname))
4169 ;; (setq lockname (expand-file-name lockname)))
4170 ;; (unless (or (eq lockname nil)
4171 ;; (string= lockname filename))
4173 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
4175 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
4176 (when (and (not (featurep 'xemacs)) confirm (file-exists-p filename))
4177 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename))
4178 (tramp-error v 'file-error "File not overwritten")))
4180 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename 'integer))
4181 (tramp-get-remote-uid v 'integer)))
4182 (gid (or (nth 3 (tramp-compat-file-attributes filename 'integer))
4183 (tramp-get-remote-gid v 'integer))))
4185 (if (and (tramp-local-host-p v)
4186 ;; `file-writable-p' calls 'file-expand-file-name'. We
4187 ;; cannot use `tramp-run-real-handler' therefore.
4188 (let (file-name-handler-alist)
4190 (file-writable-p (file-name-directory localname))
4191 (or (file-directory-p localname)
4192 (file-writable-p localname)))))
4193 ;; Short track: if we are on the local host, we can run directly.
4194 (tramp-run-real-handler
4196 (list start end localname append 'no-message lockname confirm))
4198 (let ((rem-dec (tramp-get-remote-coding v "remote-decoding"))
4199 (loc-enc (tramp-get-local-coding v "local-encoding"))
4200 (modes (save-excursion (file-modes filename)))
4201 ;; We use this to save the value of
4202 ;; `last-coding-system-used' after writing the tmp file.
4203 ;; At the end of the function, we set
4204 ;; `last-coding-system-used' to this saved value. This
4205 ;; way, any intermediary coding systems used while
4206 ;; talking to the remote shell or suchlike won't hose
4207 ;; this variable. This approach was snarfed from
4210 ;; Write region into a tmp file. This isn't really
4211 ;; needed if we use an encoding function, but currently
4212 ;; we use it always because this makes the logic
4214 (tmpfile (tramp-compat-make-temp-file filename)))
4216 ;; We say `no-message' here because we don't want the
4217 ;; visited file modtime data to be clobbered from the temp
4218 ;; file. We call `set-visited-file-modtime' ourselves later
4219 ;; on. We must ensure that `file-coding-system-alist'
4220 ;; matches `tmpfile'.
4221 (let ((file-coding-system-alist
4222 (tramp-find-file-name-coding-system-alist filename tmpfile)))
4223 (tramp-run-real-handler
4225 (list start end tmpfile append 'no-message lockname confirm))
4226 ;; Now, `last-coding-system-used' has the right value. Remember it.
4227 (when (boundp 'last-coding-system-used)
4228 (setq coding-system-used
4229 (symbol-value 'last-coding-system-used))))
4231 ;; The permissions of the temporary file should be set. If
4232 ;; filename does not exist (eq modes nil) it has been
4233 ;; renamed to the backup file. This case `save-buffer'
4234 ;; handles permissions.
4235 (when modes (set-file-modes tmpfile modes))
4237 ;; This is a bit lengthy due to the different methods
4238 ;; possible for file transfer. First, we check whether the
4239 ;; method uses an rcp program. If so, we call it.
4240 ;; Otherwise, both encoding and decoding command must be
4241 ;; specified. However, if the method _also_ specifies an
4242 ;; encoding function, then that is used for encoding the
4243 ;; contents of the tmp file.
4245 ;; `rename-file' handles direct copy and out-of-band methods.
4246 ((or (tramp-local-host-p v)
4247 (and (tramp-method-out-of-band-p v)
4249 (> (- end start) tramp-copy-size-limit)))
4250 (rename-file tmpfile filename t))
4252 ;; Use inline file transfer
4255 (tramp-message v 5 "Encoding region...")
4258 ;; Use encoding function or command.
4259 (if (and (symbolp loc-enc) (fboundp loc-enc))
4262 v 5 "Encoding region using function `%s'..."
4263 (symbol-name loc-enc))
4264 (let ((coding-system-for-read 'binary))
4265 (insert-file-contents-literally tmpfile))
4266 ;; CCC. The following `let' is a workaround
4267 ;; for the base64.el that comes with
4268 ;; pgnus-0.84. If both of the following
4269 ;; conditions are satisfied, it tries to write
4270 ;; to a local file in default-directory, but
4271 ;; at this point, default-directory is remote.
4272 ;; (`call-process-region' can't write to remote
4273 ;; files, it seems.) The file in question is
4274 ;; a tmp file anyway.
4275 (let ((default-directory
4276 (tramp-compat-temporary-file-directory)))
4277 (funcall loc-enc (point-min) (point-max))))
4280 v 5 "Encoding region using command `%s'..." loc-enc)
4281 (unless (equal 0 (tramp-call-local-coding-command
4285 "Cannot write to `%s', local encoding command `%s' failed"
4288 ;; Send buffer into remote decoding command which
4289 ;; writes to remote file. Because this happens on
4290 ;; the remote host, we cannot use the function.
4291 (goto-char (point-max))
4292 (unless (bolp) (newline))
4294 v 5 "Decoding region into remote file %s..." filename)
4298 "%s >%s <<'EOF'\n%sEOF"
4300 (tramp-shell-quote-argument localname)
4302 (tramp-barf-unless-okay
4304 "Couldn't write region to `%s', decode using `%s' failed"
4306 ;; When `file-precious-flag' is set, the region is
4307 ;; written to a temporary file. Check that the
4308 ;; checksum is equal to that from the local tmpfile.
4309 (when file-precious-flag
4312 ;; cksum runs locally, if possible.
4313 (zerop (tramp-local-call-process "cksum" tmpfile t))
4314 ;; cksum runs remotely.
4316 (tramp-send-command-and-check
4319 "cksum <%s" (tramp-shell-quote-argument localname))))
4320 ;; ... they are different.
4324 (with-current-buffer (tramp-get-buffer v)
4328 (concat "Couldn't write region to `%s',"
4329 " decode using `%s' failed")
4332 v 5 "Decoding region into remote file %s...done" filename)
4333 (tramp-flush-file-property v localname))
4336 (delete-file tmpfile)))
4338 ;; That's not expected.
4342 (concat "Method `%s' should specify both encoding and "
4343 "decoding command or an rcp program")
4346 ;; Make `last-coding-system-used' have the right value.
4347 (when coding-system-used
4348 (set 'last-coding-system-used coding-system-used))))
4350 ;; We must protect `last-coding-system-used', now we have set it
4351 ;; to its correct value.
4352 (let (last-coding-system-used)
4353 ;; Set file modification time.
4354 (when (or (eq visit t) (stringp visit))
4355 (set-visited-file-modtime
4356 ;; We must pass modtime explicitely, because filename can
4357 ;; be different from (buffer-file-name), f.e. if
4358 ;; `file-precious-flag' is set.
4359 (nth 5 (file-attributes filename))))
4361 ;; Set the ownership.
4362 (tramp-set-file-uid-gid filename uid gid)
4363 (when (or (eq visit t) (null visit) (stringp visit))
4364 (tramp-message v 0 "Wrote %s" filename))
4365 (run-hooks 'tramp-handle-write-region-hook)))))
4368 (progn (defun tramp-run-real-handler (operation args)
4369 "Invoke normal file name handler for OPERATION.
4370 First arg specifies the OPERATION, second arg is a list of arguments to
4371 pass to the OPERATION."
4372 (let* ((inhibit-file-name-handlers
4373 `(tramp-file-name-handler
4374 tramp-completion-file-name-handler
4375 cygwin-mount-name-hook-function
4376 cygwin-mount-map-drive-hook-function
4378 ,(and (eq inhibit-file-name-operation operation)
4379 inhibit-file-name-handlers)))
4380 (inhibit-file-name-operation operation))
4381 (apply operation args))))
4384 (progn (defun tramp-completion-run-real-handler (operation args)
4385 "Invoke `tramp-file-name-handler' for OPERATION.
4386 First arg specifies the OPERATION, second arg is a list of arguments to
4387 pass to the OPERATION."
4388 (let* ((inhibit-file-name-handlers
4389 `(tramp-completion-file-name-handler
4390 cygwin-mount-name-hook-function
4391 cygwin-mount-map-drive-hook-function
4393 ,(and (eq inhibit-file-name-operation operation)
4394 inhibit-file-name-handlers)))
4395 (inhibit-file-name-operation operation))
4396 (apply operation args))))
4398 ;; We handle here all file primitives. Most of them have the file
4399 ;; name as first parameter; nevertheless we check for them explicitly
4400 ;; in order to be signalled if a new primitive appears. This
4401 ;; scenario is needed because there isn't a way to decide by
4402 ;; syntactical means whether a foreign method must be called. It would
4403 ;; ease the life if `file-name-handler-alist' would support a decision
4404 ;; function as well but regexp only.
4405 (defun tramp-file-name-for-operation (operation &rest args)
4406 "Return file name related to OPERATION file primitive.
4407 ARGS are the arguments OPERATION has been called with."
4409 ; FILE resp DIRECTORY
4411 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
4412 'delete-file 'diff-latest-backup-file 'directory-file-name
4413 'directory-files 'directory-files-and-attributes
4414 'dired-compress-file 'dired-uncache
4415 'file-accessible-directory-p 'file-attributes
4416 'file-directory-p 'file-executable-p 'file-exists-p
4417 'file-local-copy 'file-remote-p 'file-modes
4418 'file-name-as-directory 'file-name-directory
4419 'file-name-nondirectory 'file-name-sans-versions
4420 'file-ownership-preserved-p 'file-readable-p
4421 'file-regular-p 'file-symlink-p 'file-truename
4422 'file-writable-p 'find-backup-file-name 'find-file-noselect
4423 'get-file-buffer 'insert-directory 'insert-file-contents
4424 'load 'make-directory 'make-directory-internal
4425 'set-file-modes 'substitute-in-file-name
4426 'unhandled-file-name-directory 'vc-registered
4430 'abbreviate-file-name 'create-file-buffer
4431 'dired-file-modtime 'dired-make-compressed-filename
4432 'dired-recursive-delete-directory 'dired-set-file-modtime
4433 'dired-shell-unhandle-file-name 'dired-uucode-file
4434 'insert-file-contents-literally 'make-temp-name 'recover-file
4435 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
4436 (if (file-name-absolute-p (nth 0 args))
4438 (expand-file-name (nth 0 args))))
4439 ; FILE DIRECTORY resp FILE1 FILE2
4441 (list 'add-name-to-file 'copy-file 'expand-file-name
4442 'file-name-all-completions 'file-name-completion
4443 'file-newer-than-file-p 'make-symbolic-link 'rename-file
4445 'dired-make-relative-symlink
4446 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
4449 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
4450 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
4451 (t (buffer-file-name (current-buffer))))))
4453 ((eq operation 'write-region)
4457 (list 'set-visited-file-modtime 'verify-visited-file-modtime
4458 ; since Emacs 22 only
4459 'make-auto-save-file-name
4463 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
4466 (list ; not in Emacs 23
4470 ; since Emacs 22 only
4472 ; since Emacs 23 only
4475 'dired-print-file 'dired-shell-call-process
4477 'executable-find 'start-process 'call-process))
4479 ; unknown file primitive
4480 (t (error "unknown file I/O primitive: %s" operation))))
4482 (defun tramp-find-foreign-file-name-handler (filename)
4483 "Return foreign file name handler if exists."
4484 (when (and (stringp filename) (tramp-tramp-file-p filename))
4485 (let ((v (tramp-dissect-file-name filename t))
4486 (handler tramp-foreign-file-name-handler-alist)
4488 ;; When we are not fully sure that filename completion is safe,
4489 ;; we should not return a handler.
4490 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
4491 (and (tramp-file-name-host v)
4492 (not (member (tramp-file-name-host v)
4493 (mapcar 'car tramp-methods))))
4494 (not (tramp-completion-mode-p)))
4496 (setq elt (car handler)
4497 handler (cdr handler))
4498 (when (funcall (car elt) filename)
4505 (defun tramp-file-name-handler (operation &rest args)
4506 "Invoke Tramp file name handler.
4507 Falls back to normal file name handler if no Tramp file name handler exists."
4511 (tramp-replace-environment-variables
4512 (apply 'tramp-file-name-for-operation operation args)))
4513 (completion (tramp-completion-mode-p))
4514 (foreign (tramp-find-foreign-file-name-handler filename)))
4515 (with-parsed-tramp-file-name filename nil
4517 ;; When we are in completion mode, some operations
4518 ;; shouldn't be handled by backend.
4519 ((and completion (zerop (length localname))
4520 (memq operation '(file-exists-p file-directory-p)))
4522 ((and completion (zerop (length localname))
4523 (memq operation '(file-name-as-directory)))
4525 ;; Call the backend function.
4526 (foreign (apply foreign operation args))
4527 ;; Nothing to do for us.
4528 (t (tramp-run-real-handler operation args))))))
4529 ;; When `tramp-mode' is not enabled, we don't do anything.
4530 (tramp-run-real-handler operation args)))
4532 ;; In Emacs, there is some concurrency due to timers. If a timer
4533 ;; interrupts Tramp and wishes to use the same connection buffer as
4534 ;; the "main" Emacs, then garbage might occur in the connection
4535 ;; buffer. Therefore, we need to make sure that a timer does not use
4536 ;; the same connection buffer as the "main" Emacs. We implement a
4537 ;; cheap global lock, instead of locking each connection buffer
4538 ;; separately. The global lock is based on two variables,
4539 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
4540 ;; (with setq) to indicate a lock. But Tramp also calls itself during
4541 ;; processing of a single file operation, so we need to allow
4542 ;; recursive calls. That's where the `tramp-locker' variable comes in
4543 ;; -- it is let-bound to t during the execution of the current
4544 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
4545 ;; then we should just proceed because we have been called
4546 ;; recursively. But if `tramp-locker' is nil, then we are a timer
4547 ;; interrupting the "main" Emacs, and then we signal an error.
4549 (defvar tramp-locked nil
4550 "If non-nil, then Tramp is currently busy.
4551 Together with `tramp-locker', this implements a locking mechanism
4552 preventing reentrant calls of Tramp.")
4554 (defvar tramp-locker nil
4555 "If non-nil, then a caller has locked Tramp.
4556 Together with `tramp-locked', this implements a locking mechanism
4557 preventing reentrant calls of Tramp.")
4559 (defun tramp-sh-file-name-handler (operation &rest args)
4560 "Invoke remote-shell Tramp file name handler.
4561 Fall back to normal file name handler if no Tramp handler exists."
4562 (when (and tramp-locked (not tramp-locker))
4563 (signal 'file-error (list "Forbidden reentrant call of Tramp")))
4564 (let ((tl tramp-locked))
4567 (setq tramp-locked t)
4568 (let ((tramp-locker t))
4570 (let ((fn (assoc operation tramp-file-name-handler-alist)))
4572 (apply (cdr fn) args)
4573 (tramp-run-real-handler operation args))))))
4574 (setq tramp-locked tl))))
4577 (progn (defun tramp-completion-file-name-handler (operation &rest args)
4578 "Invoke Tramp file name completion handler.
4579 Falls back to normal file name handler if no Tramp file name handler exists."
4580 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
4581 ;; would otherwise use backslash.
4582 (let ((directory-sep-char ?/)
4583 (fn (assoc operation tramp-completion-file-name-handler-alist)))
4584 ;; When `tramp-mode' is not enabled, we don't do anything.
4585 (if (and fn tramp-mode)
4586 (save-match-data (apply (cdr fn) args))
4587 (tramp-completion-run-real-handler operation args)))))
4590 (defsubst tramp-register-file-name-handler ()
4591 "Add Tramp file name handler to `file-name-handler-alist'."
4592 ;; Remove autoloaded handler from file name handler alist. Useful,
4593 ;; if `tramp-syntax' has been changed.
4594 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
4595 (setq file-name-handler-alist (delete a1 file-name-handler-alist)))
4597 (add-to-list 'file-name-handler-alist
4598 (cons tramp-file-name-regexp 'tramp-file-name-handler))
4599 ;; If jka-compr is already loaded, move it to the front of
4600 ;; `file-name-handler-alist'.
4601 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4603 (setq file-name-handler-alist
4604 (cons jka (delete jka file-name-handler-alist))))))
4606 ;; `tramp-file-name-handler' must be registered before evaluation of
4607 ;; site-start and init files, because there might exist remote files
4608 ;; already, f.e. files kept via recentf-mode.
4609 ;;;###autoload(tramp-register-file-name-handler)
4610 (tramp-register-file-name-handler)
4613 (defsubst tramp-register-completion-file-name-handler ()
4614 "Add Tramp completion file name handler to `file-name-handler-alist'."
4615 ;; Remove autoloaded handler from file name handler alist. Useful,
4616 ;; if `tramp-syntax' has been changed.
4618 'tramp-completion-file-name-handler file-name-handler-alist)))
4619 (setq file-name-handler-alist (delete a1 file-name-handler-alist)))
4620 ;; `partial-completion-mode' is unknown in XEmacs. So we should
4621 ;; load it unconditionally there. In the GNU Emacs case, method/
4622 ;; user/host name completion shall be bound to `partial-completion-mode'.
4623 ;; `ido-mode' and `icy-mode' are other packages which extend file
4625 (when (or (not (boundp 'partial-completion-mode))
4626 (symbol-value 'partial-completion-mode)
4628 (featurep 'icicles))
4629 (add-to-list 'file-name-handler-alist
4630 (cons tramp-completion-file-name-regexp
4631 'tramp-completion-file-name-handler))
4632 (put 'tramp-completion-file-name-handler 'safe-magic t))
4633 ;; If jka-compr is already loaded, move it to the front of
4634 ;; `file-name-handler-alist'.
4635 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4637 (setq file-name-handler-alist
4638 (cons jka (delete jka file-name-handler-alist))))))
4640 ;; During autoload, it shall be checked whether
4641 ;; `partial-completion-mode' is active. Therefore registering of
4642 ;; `tramp-completion-file-name-handler' will be delayed.
4643 ;;;###autoload(add-hook
4644 ;;;###autoload 'after-init-hook
4645 ;;;###autoload 'tramp-register-completion-file-name-handler)
4646 (tramp-register-completion-file-name-handler)
4649 (defun tramp-unload-file-name-handlers ()
4650 (setq file-name-handler-alist
4651 (delete (rassoc 'tramp-file-name-handler
4652 file-name-handler-alist)
4653 (delete (rassoc 'tramp-completion-file-name-handler
4654 file-name-handler-alist)
4655 file-name-handler-alist))))
4657 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
4659 ;;; File name handler functions for completion mode:
4661 (defvar tramp-completion-mode nil
4662 "If non-nil, external packages signal that they are in file name completion.
4664 This is necessary, because Tramp uses a heuristic depending on last
4665 input event. This fails when external packages use other characters
4666 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
4667 should never be set globally, the intention is to let-bind it.")
4669 ;; Necessary because `tramp-file-name-regexp-unified' and
4670 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
4671 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
4672 ;; to `tramp-file-name-handler'). Otherwise, it takes
4673 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
4674 ;; risky, because completing a file might require loading other files,
4675 ;; like "~/.netrc", and for them it shouldn't be decided based on that
4676 ;; variable. On the other hand, those files shouldn't have partial
4677 ;; Tramp file name syntax. Maybe another variable should be introduced
4678 ;; overwriting this check in such cases. Or we change Tramp file name
4679 ;; syntax in order to avoid ambiguities, like in XEmacs ...
4680 (defun tramp-completion-mode-p ()
4681 "Checks whether method / user name / host name completion is active."
4683 ;; Signal from outside.
4684 tramp-completion-mode
4686 (equal last-input-event 'tab)
4687 (and (natnump last-input-event)
4689 ;; ?\t has event-modifier 'control.
4690 (equal last-input-event ?\t)
4691 (and (not (event-modifiers last-input-event))
4692 (or (equal last-input-event ?\?)
4693 (equal last-input-event ?\ )))))
4695 (and (featurep 'xemacs)
4696 ;; `last-input-event' might be nil.
4697 (not (null last-input-event))
4698 ;; `last-input-event' may have no character approximation.
4699 (funcall (symbol-function 'event-to-character) last-input-event)
4701 ;; ?\t has event-modifier 'control.
4703 (funcall (symbol-function 'event-to-character)
4704 last-input-event) ?\t)
4705 (and (not (event-modifiers last-input-event))
4707 (funcall (symbol-function 'event-to-character)
4708 last-input-event) ?\?)
4710 (funcall (symbol-function 'event-to-character)
4711 last-input-event) ?\ )))))))
4713 ;; Method, host name and user name completion.
4714 ;; `tramp-completion-dissect-file-name' returns a list of
4715 ;; tramp-file-name structures. For all of them we return possible completions.
4717 (defun tramp-completion-handle-file-name-all-completions (filename directory)
4718 "Like `file-name-all-completions' for partial Tramp files."
4720 (let* ((fullname (tramp-drop-volume-letter
4721 (expand-file-name filename directory)))
4722 ;; Possible completion structures.
4723 (v (tramp-completion-dissect-file-name fullname))
4727 (let* ((car (car v))
4728 (method (tramp-file-name-method car))
4729 (user (tramp-file-name-user car))
4730 (host (tramp-file-name-host car))
4731 (localname (tramp-file-name-localname car))
4732 (m (tramp-find-method method user host))
4733 (tramp-current-user user) ; see `tramp-parse-passwd'
4736 (unless localname ;; Nothing to complete.
4740 ;; Method dependent user / host combinations.
4744 (setq all-user-hosts
4745 (append all-user-hosts
4746 (funcall (nth 0 x) (nth 1 x)))))
4747 (tramp-get-completion-function m))
4753 (tramp-get-completion-user-host
4754 method user host (nth 0 x) (nth 1 x)))
4755 (delq nil all-user-hosts)))))
4757 ;; Possible methods.
4759 (append result (tramp-get-completion-methods m)))))
4763 ;; Unify list, remove nil elements.
4765 (let ((car (car result)))
4769 (substring car (length (tramp-drop-volume-letter directory)))))
4770 (setq result (cdr result))))
4772 ;; Complete local parts.
4776 (tramp-completion-run-real-handler
4777 'file-name-all-completions (list filename directory))
4780 ;; Method, host name and user name completion for a file.
4782 (defun tramp-completion-handle-file-name-completion
4783 (filename directory &optional predicate)
4784 "Like `file-name-completion' for Tramp files."
4787 (mapcar 'list (file-name-all-completions filename directory))
4789 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
4791 ;; I misuse a little bit the tramp-file-name structure in order to handle
4792 ;; completion possibilities for partial methods / user names / host names.
4793 ;; Return value is a list of tramp-file-name structures according to possible
4794 ;; completions. If "localname" is non-nil it means there
4795 ;; shouldn't be a completion anymore.
4797 ;; Expected results:
4799 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
4800 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
4801 ;; [nil "x" nil nil]
4802 ;; ["x" nil nil nil]
4804 ;; "/x:" "/x:y" "/x:y:"
4805 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
4807 ;; ["x" nil "" nil] ["x" nil "y" nil]
4808 ;; ["x" "" nil nil] ["x" "y" nil nil]
4810 ;; "/x:y@" "/x:y@z" "/x:y@z:"
4811 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
4812 ;; "/[x/y@" "/[x/y@z"
4813 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
4814 (defun tramp-completion-dissect-file-name (name)
4815 "Returns a list of `tramp-file-name' structures.
4816 They are collected by `tramp-completion-dissect-file-name1'."
4820 ;; "/method" "/[method"
4821 (tramp-completion-file-name-structure1
4822 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
4825 (tramp-completion-file-name-structure2
4826 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
4829 (tramp-completion-file-name-structure3
4830 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
4832 ;; "/user@host" "/[user@host"
4833 (tramp-completion-file-name-structure4
4834 (list (concat tramp-prefix-regexp
4835 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4836 "\\(" tramp-host-regexp x-nil "\\)$")
4838 ;; "/method:user" "/[method/user" "/method://user"
4839 (tramp-completion-file-name-structure5
4840 (list (concat tramp-prefix-regexp
4841 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
4842 "\\(" tramp-user-regexp x-nil "\\)$")
4844 ;; "/method:host" "/[method/host" "/method://host"
4845 (tramp-completion-file-name-structure6
4846 (list (concat tramp-prefix-regexp
4847 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
4848 "\\(" tramp-host-regexp x-nil "\\)$")
4850 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
4851 (tramp-completion-file-name-structure7
4852 (list (concat tramp-prefix-regexp
4853 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
4854 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4855 "\\(" tramp-host-regexp x-nil "\\)$")
4857 ;; "/method: "/method:/"
4858 (tramp-completion-file-name-structure8
4860 (if (equal tramp-syntax 'url)
4861 (concat tramp-prefix-regexp
4862 "\\(" tramp-method-regexp "\\)"
4863 "\\(" (substring tramp-postfix-method-regexp 0 1)
4864 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
4866 ;; Should not match if not URL syntax.
4867 (concat tramp-prefix-regexp "/$"))
4869 ;; "/method: "/method:/"
4870 (tramp-completion-file-name-structure9
4872 (if (equal tramp-syntax 'url)
4873 (concat tramp-prefix-regexp
4874 "\\(" tramp-method-regexp "\\)"
4875 "\\(" (substring tramp-postfix-method-regexp 0 1)
4876 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
4878 ;; Should not match if not URL syntax.
4879 (concat tramp-prefix-regexp "/$"))
4882 (mapc (lambda (regexp)
4883 (add-to-list 'result
4884 (tramp-completion-dissect-file-name1 regexp name)))
4886 tramp-completion-file-name-structure1
4887 tramp-completion-file-name-structure2
4888 tramp-completion-file-name-structure3
4889 tramp-completion-file-name-structure4
4890 tramp-completion-file-name-structure5
4891 tramp-completion-file-name-structure6
4892 tramp-completion-file-name-structure7
4893 tramp-completion-file-name-structure8
4894 tramp-completion-file-name-structure9
4895 tramp-file-name-structure))
4899 (defun tramp-completion-dissect-file-name1 (structure name)
4900 "Returns a `tramp-file-name' structure matching STRUCTURE.
4901 The structure consists of remote method, remote user,
4902 remote host and localname (filename on remote host)."
4905 (when (string-match (nth 0 structure) name)
4906 (let ((method (and (nth 1 structure)
4907 (match-string (nth 1 structure) name)))
4908 (user (and (nth 2 structure)
4909 (match-string (nth 2 structure) name)))
4910 (host (and (nth 3 structure)
4911 (match-string (nth 3 structure) name)))
4912 (localname (and (nth 4 structure)
4913 (match-string (nth 4 structure) name))))
4914 (vector method user host localname)))))
4916 ;; This function returns all possible method completions, adding the
4917 ;; trailing method delimeter.
4918 (defun tramp-get-completion-methods (partial-method)
4919 "Returns all method completions for PARTIAL-METHOD."
4923 (string-match (concat "^" (regexp-quote partial-method)) method)
4924 (tramp-completion-make-tramp-file-name method nil nil nil)))
4925 (mapcar 'car tramp-methods)))
4927 ;; Compares partial user and host names with possible completions.
4928 (defun tramp-get-completion-user-host (method partial-user partial-host user host)
4929 "Returns the most expanded string for user and host name completion.
4930 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
4933 ((and partial-user partial-host)
4935 (string-match (concat "^" (regexp-quote partial-host)) host)
4936 (string-equal partial-user (or user partial-user)))
4937 (setq user partial-user)
4944 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
4950 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
4956 (unless (zerop (+ (length user) (length host)))
4957 (tramp-completion-make-tramp-file-name method user host nil)))
4959 (defun tramp-parse-rhosts (filename)
4960 "Return a list of (user host) tuples allowed to access.
4961 Either user or host may be nil."
4962 ;; On Windows, there are problems in completion when
4963 ;; `default-directory' is remote.
4964 (let ((default-directory (tramp-compat-temporary-file-directory))
4966 (when (file-readable-p filename)
4968 (insert-file-contents filename)
4969 (goto-char (point-min))
4971 (push (tramp-parse-rhosts-group) res))))
4974 (defun tramp-parse-rhosts-group ()
4975 "Return a (user host) tuple allowed to access.
4976 Either user or host may be nil."
4980 "^\\(" tramp-host-regexp "\\)"
4981 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
4982 (narrow-to-region (point) (tramp-compat-line-end-position))
4983 (when (re-search-forward regexp nil t)
4984 (setq result (append (list (match-string 3) (match-string 1)))))
4989 (defun tramp-parse-shosts (filename)
4990 "Return a list of (user host) tuples allowed to access.
4991 User is always nil."
4992 ;; On Windows, there are problems in completion when
4993 ;; `default-directory' is remote.
4994 (let ((default-directory (tramp-compat-temporary-file-directory))
4996 (when (file-readable-p filename)
4998 (insert-file-contents filename)
4999 (goto-char (point-min))
5001 (push (tramp-parse-shosts-group) res))))
5004 (defun tramp-parse-shosts-group ()
5005 "Return a (user host) tuple allowed to access.
5006 User is always nil."
5008 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
5009 (narrow-to-region (point) (tramp-compat-line-end-position))
5010 (when (re-search-forward regexp nil t)
5011 (setq result (list nil (match-string 1))))
5014 (> (skip-chars-forward ",") 0)
5018 (defun tramp-parse-sconfig (filename)
5019 "Return a list of (user host) tuples allowed to access.
5020 User is always nil."
5021 ;; On Windows, there are problems in completion when
5022 ;; `default-directory' is remote.
5023 (let ((default-directory (tramp-compat-temporary-file-directory))
5025 (when (file-readable-p filename)
5027 (insert-file-contents filename)
5028 (goto-char (point-min))
5030 (push (tramp-parse-sconfig-group) res))))
5033 (defun tramp-parse-sconfig-group ()
5034 "Return a (user host) tuple allowed to access.
5035 User is always nil."
5037 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)")))
5038 (narrow-to-region (point) (tramp-compat-line-end-position))
5039 (when (re-search-forward regexp nil t)
5040 (setq result (list nil (match-string 1))))
5043 (> (skip-chars-forward ",") 0)
5047 (defun tramp-parse-shostkeys (dirname)
5048 "Return a list of (user host) tuples allowed to access.
5049 User is always nil."
5050 ;; On Windows, there are problems in completion when
5051 ;; `default-directory' is remote.
5052 (let* ((default-directory (tramp-compat-temporary-file-directory))
5053 (regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$"))
5054 (files (when (file-directory-p dirname) (directory-files dirname)))
5057 (when (string-match regexp (car files))
5058 (push (list nil (match-string 1 (car files))) result))
5059 (setq files (cdr files)))
5062 (defun tramp-parse-sknownhosts (dirname)
5063 "Return a list of (user host) tuples allowed to access.
5064 User is always nil."
5065 ;; On Windows, there are problems in completion when
5066 ;; `default-directory' is remote.
5067 (let* ((default-directory (tramp-compat-temporary-file-directory))
5068 (regexp (concat "^\\(" tramp-host-regexp
5069 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
5070 (files (when (file-directory-p dirname) (directory-files dirname)))
5073 (when (string-match regexp (car files))
5074 (push (list nil (match-string 1 (car files))) result))
5075 (setq files (cdr files)))
5078 (defun tramp-parse-hosts (filename)
5079 "Return a list of (user host) tuples allowed to access.
5080 User is always nil."
5081 ;; On Windows, there are problems in completion when
5082 ;; `default-directory' is remote.
5083 (let ((default-directory (tramp-compat-temporary-file-directory))
5085 (when (file-readable-p filename)
5087 (insert-file-contents filename)
5088 (goto-char (point-min))
5090 (push (tramp-parse-hosts-group) res))))
5093 (defun tramp-parse-hosts-group ()
5094 "Return a (user host) tuple allowed to access.
5095 User is always nil."
5097 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
5098 (narrow-to-region (point) (tramp-compat-line-end-position))
5099 (when (re-search-forward regexp nil t)
5100 (unless (char-equal (or (char-after) ?\n) ?:) ; no IPv6
5101 (setq result (list nil (match-string 1)))))
5104 (> (skip-chars-forward " \t") 0)
5108 ;; For su-alike methods it would be desirable to return "root@localhost"
5109 ;; as default. Unfortunately, we have no information whether any user name
5110 ;; has been typed already. So we use `tramp-current-user' as indication,
5111 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
5112 (defun tramp-parse-passwd (filename)
5113 "Return a list of (user host) tuples allowed to access.
5114 Host is always \"localhost\"."
5115 ;; On Windows, there are problems in completion when
5116 ;; `default-directory' is remote.
5117 (let ((default-directory (tramp-compat-temporary-file-directory))
5119 (if (zerop (length tramp-current-user))
5121 (when (file-readable-p filename)
5123 (insert-file-contents filename)
5124 (goto-char (point-min))
5126 (push (tramp-parse-passwd-group) res))))
5129 (defun tramp-parse-passwd-group ()
5130 "Return a (user host) tuple allowed to access.
5131 Host is always \"localhost\"."
5133 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
5134 (narrow-to-region (point) (tramp-compat-line-end-position))
5135 (when (re-search-forward regexp nil t)
5136 (setq result (list (match-string 1) "localhost")))
5141 (defun tramp-parse-netrc (filename)
5142 "Return a list of (user host) tuples allowed to access.
5144 ;; On Windows, there are problems in completion when
5145 ;; `default-directory' is remote.
5146 (let ((default-directory (tramp-compat-temporary-file-directory))
5148 (when (file-readable-p filename)
5150 (insert-file-contents filename)
5151 (goto-char (point-min))
5153 (push (tramp-parse-netrc-group) res))))
5156 (defun tramp-parse-netrc-group ()
5157 "Return a (user host) tuple allowed to access.
5162 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
5163 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
5164 (narrow-to-region (point) (tramp-compat-line-end-position))
5165 (when (re-search-forward regexp nil t)
5166 (setq result (list (match-string 3) (match-string 1))))
5171 (defun tramp-parse-putty (registry)
5172 "Return a list of (user host) tuples allowed to access.
5173 User is always nil."
5174 ;; On Windows, there are problems in completion when
5175 ;; `default-directory' is remote.
5176 (let ((default-directory (tramp-compat-temporary-file-directory))
5179 (when (zerop (tramp-local-call-process "reg" nil t nil "query" registry))
5180 (goto-char (point-min))
5182 (push (tramp-parse-putty-group registry) res))))
5185 (defun tramp-parse-putty-group (registry)
5186 "Return a (user host) tuple allowed to access.
5187 User is always nil."
5189 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
5190 (narrow-to-region (point) (tramp-compat-line-end-position))
5191 (when (re-search-forward regexp nil t)
5192 (setq result (list nil (match-string 1))))
5197 ;;; Internal Functions:
5199 (defun tramp-maybe-send-script (vec script name)
5200 "Define in remote shell function NAME implemented as SCRIPT.
5201 Only send the definition if it has not already been done."
5202 (let* ((p (tramp-get-connection-process vec))
5203 (scripts (tramp-get-connection-property p "scripts" nil)))
5204 (unless (member name scripts)
5205 (tramp-message vec 5 "Sending script `%s'..." name)
5206 ;; The script could contain a call of Perl. This is masked with `%s'.
5207 (tramp-send-command-and-check
5209 (format "%s () {\n%s\n}" name
5210 (format script (tramp-get-remote-perl vec))))
5211 (tramp-set-connection-property p "scripts" (cons name scripts))
5212 (tramp-message vec 5 "Sending script `%s'...done." name))))
5214 (defun tramp-set-auto-save ()
5215 (when (and ;; ange-ftp has its own auto-save mechanism
5216 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
5217 'tramp-sh-file-name-handler)
5219 (auto-save-mode 1)))
5220 (add-hook 'find-file-hooks 'tramp-set-auto-save t)
5221 (add-hook 'tramp-unload-hook
5223 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
5225 (defun tramp-run-test (switch filename)
5226 "Run `test' on the remote system, given a SWITCH and a FILENAME.
5227 Returns the exit code of the `test' program."
5228 (with-parsed-tramp-file-name filename nil
5229 (tramp-send-command-and-check
5233 (tramp-get-test-command v)
5235 (tramp-shell-quote-argument localname)))))
5237 (defun tramp-run-test2 (format-string file1 file2)
5238 "Run `test'-like program on the remote system, given FILE1, FILE2.
5239 FORMAT-STRING contains the program name, switches, and place holders.
5240 Returns the exit code of the `test' program. Barfs if the methods,
5241 hosts, or files, disagree."
5242 (unless (tramp-equal-remote file1 file2)
5243 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1) file1 file2) nil
5246 "tramp-run-test2 only implemented for same method, user, host")))
5247 (with-parsed-tramp-file-name file1 v1
5248 (with-parsed-tramp-file-name file1 v2
5249 (tramp-send-command-and-check
5251 (format format-string
5252 (tramp-shell-quote-argument v1-localname)
5253 (tramp-shell-quote-argument v2-localname))))))
5255 (defun tramp-buffer-name (vec)
5256 "A name for the connection buffer VEC."
5257 ;; We must use `tramp-file-name-real-host', because for gateway
5258 ;; methods the default port will be expanded later on, which would
5260 (let ((method (tramp-file-name-method vec))
5261 (user (tramp-file-name-user vec))
5262 (host (tramp-file-name-real-host vec)))
5263 (if (not (zerop (length user)))
5264 (format "*tramp/%s %s@%s*" method user host)
5265 (format "*tramp/%s %s*" method host))))
5267 (defun tramp-get-buffer (vec)
5268 "Get the connection buffer to be used for VEC."
5269 (or (get-buffer (tramp-buffer-name vec))
5270 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
5271 (setq buffer-undo-list t)
5272 (setq default-directory
5273 (tramp-make-tramp-file-name
5274 (tramp-file-name-method vec)
5275 (tramp-file-name-user vec)
5276 (tramp-file-name-host vec)
5280 (defun tramp-get-connection-buffer (vec)
5281 "Get the connection buffer to be used for VEC.
5282 In case a second asynchronous communication has been started, it is different
5283 from `tramp-get-buffer'."
5284 (or (tramp-get-connection-property vec "process-buffer" nil)
5285 (tramp-get-buffer vec)))
5287 (defun tramp-get-connection-process (vec)
5288 "Get the connection process to be used for VEC.
5289 In case a second asynchronous communication has been started, it is different
5290 from the default one."
5292 (or (tramp-get-connection-property vec "process-name" nil)
5293 (tramp-buffer-name vec))))
5295 (defun tramp-debug-buffer-name (vec)
5296 "A name for the debug buffer for VEC."
5297 ;; We must use `tramp-file-name-real-host', because for gateway
5298 ;; methods the default port will be expanded later on, which would
5300 (let ((method (tramp-file-name-method vec))
5301 (user (tramp-file-name-user vec))
5302 (host (tramp-file-name-real-host vec)))
5303 (if (not (zerop (length user)))
5304 (format "*debug tramp/%s %s@%s*" method user host)
5305 (format "*debug tramp/%s %s*" method host))))
5307 (defun tramp-get-debug-buffer (vec)
5308 "Get the debug buffer for VEC."
5309 (with-current-buffer
5310 (get-buffer-create (tramp-debug-buffer-name vec))
5312 (setq buffer-undo-list t)
5313 ;; Activate outline-mode. This runs `text-mode-hook' and
5314 ;; `outline-mode-hook'. We must prevent that local processes
5315 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell"
5317 (let ((default-directory (tramp-compat-temporary-file-directory)))
5319 (set (make-local-variable 'outline-regexp)
5320 "[0-9]+:[0-9]+:[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #")
5321 ; (set (make-local-variable 'outline-regexp)
5322 ; "[a-z.-]+:[0-9]+: [a-z0-9-]+ (\\([0-9]+\\)) #")
5323 (set (make-local-variable 'outline-level) 'tramp-outline-level))
5326 (defun tramp-outline-level ()
5327 "Return the depth to which a statement is nested in the outline.
5328 Point must be at the beginning of a header line.
5330 The outline level is equal to the verbosity of the Tramp message."
5331 (1+ (string-to-number (match-string 1))))
5333 (defun tramp-find-executable
5334 (vec progname dirlist &optional ignore-tilde ignore-path)
5335 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
5336 First arg VEC specifies the connection, PROGNAME is the program
5337 to search for, and DIRLIST gives the list of directories to
5338 search. If IGNORE-TILDE is non-nil, directory names starting
5339 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
5342 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
5344 This function expects to be in the right *tramp* buffer."
5345 (with-current-buffer (tramp-get-buffer vec)
5347 ;; Check whether the executable is in $PATH. "which(1)" does not
5348 ;; report always a correct error code; therefore we check the
5349 ;; number of words it returns.
5351 (tramp-send-command vec (format "which \\%s | wc -w" progname))
5352 (goto-char (point-min))
5353 (if (looking-at "^1$")
5354 (setq result (concat "\\" progname))))
5357 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
5358 ;; `remove' is in CL, and we want to avoid CL dependencies.
5361 (setq d (car dirlist))
5362 (setq dirlist (cdr dirlist))
5363 (unless (char-equal ?~ (aref d 0))
5364 (setq newdl (cons d newdl))))
5365 (setq dirlist (nreverse newdl))))
5368 (format (concat "while read d; "
5369 "do if test -x $d/%s -a -f $d/%s; "
5370 "then echo tramp_executable $d/%s; "
5371 "break; fi; done <<'EOF'\n"
5373 progname progname progname (mapconcat 'identity dirlist "\n")))
5374 (goto-char (point-max))
5375 (when (search-backward "tramp_executable " nil t)
5376 (skip-chars-forward "^ ")
5377 (skip-chars-forward " ")
5378 (setq result (buffer-substring
5379 (point) (tramp-compat-line-end-position)))))
5382 (defun tramp-set-remote-path (vec)
5383 "Sets the remote environment PATH to existing directories.
5384 I.e., for each directory in `tramp-remote-path', it is tested
5385 whether it exists and if so, it is added to the environment
5387 (tramp-message vec 5 (format "Setting $PATH environment variable"))
5389 vec (format "PATH=%s; export PATH"
5390 (mapconcat 'identity (tramp-get-remote-path vec) ":"))))
5392 ;; ------------------------------------------------------------
5393 ;; -- Communication with external shell --
5394 ;; ------------------------------------------------------------
5396 (defun tramp-find-file-exists-command (vec)
5397 "Find a command on the remote host for checking if a file exists.
5398 Here, we are looking for a command which has zero exit status if the
5399 file exists and nonzero exit status otherwise."
5400 (let ((existing "/")
5402 (tramp-shell-quote-argument "/ this file does not exist "))
5404 ;; The algorithm is as follows: we try a list of several commands.
5405 ;; For each command, we first run `$cmd /' -- this should return
5406 ;; true, as the root directory always exists. And then we run
5407 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
5408 ;; does not exist. This should return false. We use the first
5409 ;; command we find that seems to work.
5410 ;; The list of commands to try is as follows:
5411 ;; `ls -d' This works on most systems, but NetBSD 1.4
5412 ;; has a bug: `ls' always returns zero exit
5413 ;; status, even for files which don't exist.
5414 ;; `test -e' Some Bourne shells have a `test' builtin
5415 ;; which does not know the `-e' option.
5416 ;; `/bin/test -e' For those, the `test' binary on disk normally
5417 ;; provides the option. Alas, the binary
5418 ;; is sometimes `/bin/test' and sometimes it's
5420 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
5422 (and (setq result (format "%s -e" (tramp-get-test-command vec)))
5423 (zerop (tramp-send-command-and-check
5424 vec (format "%s %s" result existing)))
5425 (not (zerop (tramp-send-command-and-check
5426 vec (format "%s %s" result nonexisting)))))
5427 (and (setq result "/bin/test -e")
5428 (zerop (tramp-send-command-and-check
5429 vec (format "%s %s" result existing)))
5430 (not (zerop (tramp-send-command-and-check
5431 vec (format "%s %s" result nonexisting)))))
5432 (and (setq result "/usr/bin/test -e")
5433 (zerop (tramp-send-command-and-check
5434 vec (format "%s %s" result existing)))
5435 (not (zerop (tramp-send-command-and-check
5436 vec (format "%s %s" result nonexisting)))))
5437 (and (setq result (format "%s -d" (tramp-get-ls-command vec)))
5438 (zerop (tramp-send-command-and-check
5439 vec (format "%s %s" result existing)))
5440 (not (zerop (tramp-send-command-and-check
5441 vec (format "%s %s" result nonexisting))))))
5443 vec 'file-error "Couldn't find command to check if file exists"))
5446 ;; CCC test ksh or bash found for tilde expansion?
5447 (defun tramp-find-shell (vec)
5448 "Opens a shell on the remote host which groks tilde expansion."
5449 (unless (tramp-get-connection-property vec "remote-shell" nil)
5451 (with-current-buffer (tramp-get-buffer vec)
5452 (tramp-send-command vec "echo ~root" t)
5454 ((string-match "^~root$" (buffer-string))
5456 (or (tramp-find-executable
5457 vec "bash" (tramp-get-remote-path vec) t)
5458 (tramp-find-executable
5459 vec "ksh" (tramp-get-remote-path vec) t)))
5463 "Couldn't find a shell which groks tilde expansion"))
5464 ;; Find arguments for this shell.
5465 (let ((alist tramp-sh-extra-args)
5467 (while (and alist (null extra-args))
5468 (setq item (pop alist))
5469 (when (string-match (car item) shell)
5470 (setq extra-args (cdr item))))
5471 (when extra-args (setq shell (concat shell " " extra-args))))
5473 vec 5 "Starting remote shell `%s' for tilde expansion..." shell)
5474 (let ((tramp-end-of-output "$ "))
5477 (format "PROMPT_COMMAND='' PS1='$ ' PS2='' PS3='' exec %s" shell)
5480 (tramp-message vec 5 "Setting remote shell prompt...")
5481 (tramp-send-command vec (format "PS1='%s'" tramp-end-of-output) t)
5482 (tramp-send-command vec "PS2=''" t)
5483 (tramp-send-command vec "PS3=''" t)
5484 (tramp-send-command vec "PROMPT_COMMAND=''" t)
5485 (tramp-message vec 5 "Setting remote shell prompt...done"))
5488 vec 5 "Remote `%s' groks tilde expansion, good"
5489 (tramp-get-method-parameter
5490 (tramp-file-name-method vec) 'tramp-remote-sh))
5491 (tramp-set-connection-property
5493 (tramp-get-method-parameter
5494 (tramp-file-name-method vec) 'tramp-remote-sh))))))))
5496 ;; ------------------------------------------------------------
5497 ;; -- Functions for establishing connection --
5498 ;; ------------------------------------------------------------
5500 ;; The following functions are actions to be taken when seeing certain
5501 ;; prompts from the remote host. See the variable
5502 ;; `tramp-actions-before-shell' for usage of these functions.
5504 (defun tramp-action-login (proc vec)
5505 "Send the login name."
5506 (when (not (stringp tramp-current-user))
5507 (save-window-excursion
5508 (let ((enable-recursive-minibuffers t))
5509 (pop-to-buffer (tramp-get-connection-buffer vec))
5510 (setq tramp-current-user (read-string (match-string 0))))))
5511 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
5512 (with-current-buffer (tramp-get-connection-buffer vec)
5513 (tramp-message vec 6 "\n%s" (buffer-string)))
5514 (tramp-send-string vec tramp-current-user))
5516 (defun tramp-action-password (proc vec)
5517 "Query the user for a password."
5518 (tramp-message vec 3 "Sending password")
5519 (tramp-enter-password proc))
5521 (defun tramp-action-succeed (proc vec)
5522 "Signal success in finding shell prompt."
5523 (throw 'tramp-action 'ok))
5525 (defun tramp-action-permission-denied (proc vec)
5526 "Signal permission denied."
5528 (throw 'tramp-action 'permission-denied))
5530 (defun tramp-action-yesno (proc vec)
5531 "Ask the user for confirmation using `yes-or-no-p'.
5532 Send \"yes\" to remote process on confirmation, abort otherwise.
5533 See also `tramp-action-yn'."
5534 (save-window-excursion
5535 (let ((enable-recursive-minibuffers t))
5536 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
5537 (unless (yes-or-no-p (match-string 0))
5539 (throw 'tramp-action 'permission-denied))
5540 (with-current-buffer (tramp-get-connection-buffer vec)
5541 (tramp-message vec 6 "\n%s" (buffer-string)))
5542 (tramp-send-string vec "yes"))))
5544 (defun tramp-action-yn (proc vec)
5545 "Ask the user for confirmation using `y-or-n-p'.
5546 Send \"y\" to remote process on confirmation, abort otherwise.
5547 See also `tramp-action-yesno'."
5548 (save-window-excursion
5549 (let ((enable-recursive-minibuffers t))
5550 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
5551 (unless (y-or-n-p (match-string 0))
5553 (throw 'tramp-action 'permission-denied))
5554 (with-current-buffer (tramp-get-connection-buffer vec)
5555 (tramp-message vec 6 "\n%s" (buffer-string)))
5556 (tramp-send-string vec "y"))))
5558 (defun tramp-action-terminal (proc vec)
5559 "Tell the remote host which terminal type to use.
5560 The terminal type can be configured with `tramp-terminal-type'."
5561 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
5562 (with-current-buffer (tramp-get-connection-buffer vec)
5563 (tramp-message vec 6 "\n%s" (buffer-string)))
5564 (tramp-send-string vec tramp-terminal-type))
5566 (defun tramp-action-process-alive (proc vec)
5567 "Check whether a process has finished."
5568 (unless (memq (process-status proc) '(run open))
5569 (throw 'tramp-action 'process-died)))
5571 (defun tramp-action-out-of-band (proc vec)
5572 "Check whether an out-of-band copy has finished."
5573 (cond ((and (memq (process-status proc) '(stop exit))
5574 (zerop (process-exit-status proc)))
5575 (tramp-message vec 3 "Process has finished.")
5576 (throw 'tramp-action 'ok))
5577 ((or (and (memq (process-status proc) '(stop exit))
5578 (not (zerop (process-exit-status proc))))
5579 (memq (process-status proc) '(signal)))
5580 ;; `scp' could have copied correctly, but set modes could have failed.
5581 ;; This can be ignored.
5582 (with-current-buffer (process-buffer proc)
5583 (goto-char (point-min))
5584 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
5586 (tramp-message vec 5 "'set mode' error ignored.")
5587 (tramp-message vec 3 "Process has finished.")
5588 (throw 'tramp-action 'ok))
5589 (tramp-message vec 3 "Process has died.")
5590 (throw 'tramp-action 'process-died))))
5593 ;; Functions for processing the actions.
5595 (defun tramp-process-one-action (proc vec actions)
5596 "Wait for output from the shell and perform one action."
5597 (let (found todo item pattern action)
5599 ;; Reread output once all actions have been performed.
5600 ;; Obviously, the output was not complete.
5601 (tramp-accept-process-output proc 1)
5604 (setq item (pop todo))
5605 (setq pattern (concat (symbol-value (nth 0 item)) "\\'"))
5606 (setq action (nth 1 item))
5608 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
5609 (when (tramp-check-for-regexp proc pattern)
5610 (tramp-message vec 5 "Call `%s'" (symbol-name action))
5611 (setq found (funcall action proc vec)))))
5614 (defun tramp-process-actions (proc vec actions &optional timeout)
5615 "Perform actions until success or TIMEOUT."
5618 (tramp-message proc 3 "Waiting for prompts from remote shell")
5620 (catch 'tramp-action
5622 (with-timeout (timeout)
5623 (tramp-process-one-action proc vec actions))
5624 (tramp-process-one-action proc vec actions)))))
5625 (with-current-buffer (tramp-get-connection-buffer vec)
5626 (tramp-message vec 6 "\n%s" (buffer-string)))
5627 (unless (eq exit 'ok)
5628 (tramp-clear-passwd vec)
5629 (tramp-error-with-buffer
5632 ((eq exit 'permission-denied) "Permission denied")
5633 ((eq exit 'process-died) "Process died")
5634 (t "Login failed"))))))
5636 ;; Utility functions.
5638 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
5639 "Like `accept-process-output' for Tramp processes.
5640 This is needed in order to hide `last-coding-system-used', which is set
5641 for process communication also."
5642 (with-current-buffer (process-buffer proc)
5643 (tramp-message proc 10 "%s %s" proc (process-status proc))
5644 (let (buffer-read-only last-coding-system-used)
5645 ;; Under Windows XP, accept-process-output doesn't return
5646 ;; sometimes. So we add an additional timeout.
5647 (with-timeout ((or timeout 1))
5648 (accept-process-output proc timeout timeout-msecs)))
5649 (tramp-message proc 10 "\n%s" (buffer-string))))
5651 (defun tramp-check-for-regexp (proc regexp)
5652 "Check whether REGEXP is contained in process buffer of PROC.
5653 Erase echoed commands if exists."
5654 (with-current-buffer (process-buffer proc)
5655 (goto-char (point-min))
5657 ;; Check whether we need to remove echo output.
5658 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
5659 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
5660 (let ((begin (match-beginning 0)))
5661 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
5662 ;; Discard echo from remote output.
5663 (tramp-set-connection-property proc "check-remote-echo" nil)
5664 (tramp-message proc 5 "echo-mark found")
5666 (delete-region begin (point))
5667 (goto-char (point-min)))))
5670 ;; No echo to be handled, now we can look for the regexp.
5671 (not (tramp-get-connection-property proc "check-remote-echo" nil))
5672 ;; Sometimes the echo is invisible.
5673 (not (re-search-forward tramp-echo-mark-marker nil t)))
5674 (goto-char (point-min))
5675 (re-search-forward regexp nil t))))
5677 (defun tramp-wait-for-regexp (proc timeout regexp)
5678 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
5679 Expects the output of PROC to be sent to the current buffer. Returns
5680 the string that matched, or nil. Waits indefinitely if TIMEOUT is
5682 (with-current-buffer (process-buffer proc)
5683 (let ((found (tramp-check-for-regexp proc regexp))
5684 (start-time (current-time)))
5686 ;; Work around a bug in XEmacs 21, where the timeout
5687 ;; expires faster than it should. This degenerates
5688 ;; to polling for buggy XEmacsen, but oh, well.
5689 (while (and (not found)
5690 (< (tramp-time-diff (current-time) start-time)
5692 (with-timeout (timeout)
5694 (tramp-accept-process-output proc 1)
5695 (unless (memq (process-status proc) '(run open))
5696 (tramp-error-with-buffer
5697 nil proc 'file-error "Process has died"))
5698 (setq found (tramp-check-for-regexp proc regexp))))))
5701 (tramp-accept-process-output proc 1)
5702 (unless (memq (process-status proc) '(run open))
5703 (tramp-error-with-buffer
5704 nil proc 'file-error "Process has died"))
5705 (setq found (tramp-check-for-regexp proc regexp)))))
5706 (tramp-message proc 6 "\n%s" (buffer-string))
5710 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
5712 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
5715 (defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
5716 "Wait for shell prompt and barf if none appears.
5717 Looks at process PROC to see if a shell prompt appears in TIMEOUT
5718 seconds. If not, it produces an error message with the given ERROR-ARGS."
5720 (tramp-wait-for-regexp
5723 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern))
5724 (apply 'tramp-error-with-buffer nil proc 'file-error error-args)))
5726 ;; We don't call `tramp-send-string' in order to hide the password
5727 ;; from the debug buffer, and because end-of-line handling of the
5729 (defun tramp-enter-password (proc)
5730 "Prompt for a password and send it to the remote end."
5731 (process-send-string
5732 proc (concat (tramp-read-passwd proc)
5733 (or (tramp-get-method-parameter
5734 tramp-current-method
5735 'tramp-password-end-of-line)
5736 tramp-default-password-end-of-line))))
5738 (defun tramp-process-sentinel (proc event)
5739 "Process sentinel for Tramp processes."
5740 (when (memq (process-status proc) '(stop exit signal))
5741 (tramp-flush-connection-property proc)
5742 ;; The "Connection closed" and "exit" messages disturb the output
5743 ;; for asynchronous processes. That's why we have echoed the
5744 ;; Tramp prompt at the end. Trailing messages can be removed.
5745 (let ((buf (process-buffer proc)))
5746 (when (buffer-live-p buf)
5747 (with-current-buffer buf
5748 (goto-char (point-max))
5750 (mapconcat 'identity (split-string tramp-end-of-output "\n")
5752 (line-beginning-position -8) t)
5753 (delete-region (point) (point-max)))))))
5755 (defun tramp-open-connection-setup-interactive-shell (proc vec)
5756 "Set up an interactive shell.
5757 Mainly sets the prompt and the echo correctly. PROC is the shell
5758 process to set up. VEC specifies the connection."
5759 (let ((tramp-end-of-output "$ "))
5760 ;; It is useful to set the prompt in the following command because
5761 ;; some people have a setting for $PS1 which /bin/sh doesn't know
5762 ;; about and thus /bin/sh will display a strange prompt. For
5763 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
5764 ;; display the current working directory but /bin/sh will display
5765 ;; a dollar sign. The following command line sets $PS1 to a sane
5766 ;; value, and works under Bourne-ish shells as well as csh-like
5767 ;; shells. Daniel Pittman reports that the unusual positioning of
5768 ;; the single quotes makes it work under `rc', too. We also unset
5769 ;; the variable $ENV because that is read by some sh
5770 ;; implementations (eg, bash when called as sh) on startup; this
5771 ;; way, we avoid the startup file clobbering $PS1. $PROMP_COMMAND
5772 ;; is another way to set the prompt in /bin/bash, it must be
5773 ;; discarded as well.
5777 "exec env ENV='' PROMPT_COMMAND='' PS1='$ ' PS2='' PS3='' %s"
5778 (tramp-get-method-parameter
5779 (tramp-file-name-method vec) 'tramp-remote-sh))
5783 (tramp-message vec 5 "Setting up remote shell environment")
5784 (tramp-send-command vec "stty -inlcr -echo kill '^U' erase '^H'" t)
5785 ;; Check whether the echo has really been disabled. Some
5786 ;; implementations, like busybox of embedded GNU/Linux, don't
5787 ;; support disabling.
5788 (tramp-send-command vec "echo foo" t)
5789 (with-current-buffer (process-buffer proc)
5790 (goto-char (point-min))
5791 (when (looking-at "echo foo")
5792 (tramp-set-connection-property proc "remote-echo" t)
5793 (tramp-message vec 5 "Remote echo still on. Ok.")
5794 ;; Make sure backspaces and their echo are enabled and no line
5795 ;; width magic interferes with them.
5796 (tramp-send-command vec "stty icanon erase ^H cols 32767" t))))
5798 (tramp-message vec 5 "Setting shell prompt")
5799 ;; We can set $PS1 to `tramp-end-of-output' only when the echo has
5800 ;; been disabled. Otherwise, the echo of the command would be
5801 ;; regarded as prompt already.
5802 (tramp-send-command vec (format "PS1='%s'" tramp-end-of-output) t)
5803 (tramp-send-command vec "PS2=''" t)
5804 (tramp-send-command vec "PS3=''" t)
5805 (tramp-send-command vec "PROMPT_COMMAND=''" t)
5807 ;; Try to set up the coding system correctly.
5808 ;; CCC this can't be the right way to do it. Hm.
5809 (tramp-message vec 5 "Determining coding system")
5810 (tramp-send-command vec "echo foo ; echo bar" t)
5811 (with-current-buffer (process-buffer proc)
5812 (goto-char (point-min))
5813 (if (featurep 'mule)
5814 ;; Use MULE to select the right EOL convention for communicating
5815 ;; with the process.
5816 (let* ((cs (or (funcall (symbol-function 'process-coding-system) proc)
5817 (cons 'undecided 'undecided)))
5818 cs-decode cs-encode)
5819 (when (symbolp cs) (setq cs (cons cs cs)))
5820 (setq cs-decode (car cs))
5821 (setq cs-encode (cdr cs))
5822 (unless cs-decode (setq cs-decode 'undecided))
5823 (unless cs-encode (setq cs-encode 'undecided))
5824 (setq cs-encode (tramp-coding-system-change-eol-conversion
5826 (when (search-forward "\r" nil t)
5827 (setq cs-decode (tramp-coding-system-change-eol-conversion
5829 (funcall (symbol-function 'set-buffer-process-coding-system)
5830 cs-decode cs-encode))
5831 ;; Look for ^M and do something useful if found.
5832 (when (search-forward "\r" nil t)
5833 ;; We have found a ^M but cannot frob the process coding system
5834 ;; because we're running on a non-MULE Emacs. Let's try
5836 (tramp-send-command vec "stty -onlcr" t))))
5837 (tramp-send-command vec "set +o vi +o emacs" t)
5839 ;; Check whether the output of "uname -sr" has been changed. If
5840 ;; yes, this is a strong indication that we must expire all
5841 ;; connection properties.
5842 (tramp-message vec 5 "Checking system information")
5843 (let ((old-uname (tramp-get-connection-property vec "uname" nil))
5845 (tramp-set-connection-property
5847 (tramp-send-command-and-read vec "echo \\\"`uname -sr`\\\""))))
5848 (when (and (stringp old-uname) (not (string-equal old-uname new-uname)))
5849 (funcall (symbol-function 'tramp-cleanup-connection) vec)
5853 "Connection reset, because remote host changed from `%s' to `%s'"
5854 old-uname new-uname)))))
5856 ;; Check whether the remote host suffers from buggy
5857 ;; `send-process-string'. This is known for FreeBSD (see comment in
5858 ;; `send_process', file process.c). I've tested sending 624 bytes
5859 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
5860 ;; this host type is detected locally. It cannot handle remote
5862 (with-connection-property proc "chunksize"
5864 ((and (integerp tramp-chunksize) (> tramp-chunksize 0))
5868 vec 5 "Checking remote host type for `send-process-string' bug")
5870 "^FreeBSD" (tramp-get-connection-property vec "uname" ""))
5873 ;; Set remote PATH variable.
5874 (tramp-set-remote-path vec)
5876 ;; Search for a good shell before searching for a command which
5877 ;; checks if a file exists. This is done because Tramp wants to use
5878 ;; "test foo; echo $?" to check if various conditions hold, and
5879 ;; there are buggy /bin/sh implementations which don't execute the
5880 ;; "echo $?" part if the "test" part has an error. In particular,
5881 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
5882 ;; with buggy /bin/sh implementations will have a working bash or
5884 (tramp-find-shell vec)
5886 ;; Disable unexpected output.
5887 (tramp-send-command vec "mesg n; biff n" t)
5889 ;; Set the environment.
5890 (tramp-message vec 5 "Setting default environment")
5891 (let ((env (copy-sequence tramp-remote-process-environment))
5894 (setq item (split-string (car env) "="))
5895 (if (and (stringp (cadr item)) (not (string-equal (cadr item) "")))
5897 vec (format "%s=%s; export %s" (car item) (cadr item) (car item)) t)
5898 (push (car item) unset))
5899 (setq env (cdr env)))
5902 vec (format "unset %s" (mapconcat 'identity unset " "))))) t)
5904 ;; CCC: We should either implement a Perl version of base64 encoding
5905 ;; and decoding. Then we just use that in the last item. The other
5906 ;; alternative is to use the Perl version of UU encoding. But then
5907 ;; we need a Lisp version of uuencode.
5909 ;; Old text from documentation of tramp-methods:
5910 ;; Using a uuencode/uudecode inline method is discouraged, please use one
5911 ;; of the base64 methods instead since base64 encoding is much more
5912 ;; reliable and the commands are more standardized between the different
5913 ;; Unix versions. But if you can't use base64 for some reason, please
5914 ;; note that the default uudecode command does not work well for some
5915 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
5916 ;; the following command for uudecode:
5918 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
5920 ;; For Irix, no solution is known yet.
5922 (defconst tramp-local-coding-commands
5923 '((b64 base64-encode-region base64-decode-region)
5924 (uu tramp-uuencode-region uudecode-decode-region)
5926 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
5927 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
5928 "List of local coding commands for inline transfer.
5929 Each item is a list that looks like this:
5931 \(FORMAT ENCODING DECODING)
5933 FORMAT is symbol describing the encoding/decoding format. It can be
5934 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
5936 ENCODING and DECODING can be strings, giving commands, or symbols,
5937 giving functions. If they are strings, then they can contain
5938 the \"%s\" format specifier. If that specifier is present, the input
5939 filename will be put into the command line at that spot. If the
5940 specifier is not present, the input should be read from standard
5943 If they are functions, they will be called with two arguments, start
5944 and end of region, and are expected to replace the region contents
5945 with the encoded or decoded results, respectively.")
5947 (defconst tramp-remote-coding-commands
5948 '((b64 "mimencode -b" "mimencode -u -b")
5949 (b64 "mmencode -b" "mmencode -u -b")
5950 (b64 "recode data..base64" "recode base64..data")
5951 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module)
5952 (b64 tramp-perl-encode tramp-perl-decode)
5953 (uu "uuencode xxx" "uudecode -o /dev/stdout")
5954 (uu "uuencode xxx" "uudecode -o -")
5955 (uu "uuencode xxx" "uudecode -p")
5956 (uu "uuencode xxx" tramp-uudecode)
5958 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
5959 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
5960 "List of remote coding commands for inline transfer.
5961 Each item is a list that looks like this:
5963 \(FORMAT ENCODING DECODING)
5965 FORMAT is symbol describing the encoding/decoding format. It can be
5966 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
5968 ENCODING and DECODING can be strings, giving commands, or symbols,
5969 giving variables. If they are strings, then they can contain
5970 the \"%s\" format specifier. If that specifier is present, the input
5971 filename will be put into the command line at that spot. If the
5972 specifier is not present, the input should be read from standard
5975 If they are variables, this variable is a string containing a Perl
5976 implementation for this functionality. This Perl program will be transferred
5977 to the remote host, and it is avalible as shell function with the same name.")
5979 (defun tramp-find-inline-encoding (vec)
5980 "Find an inline transfer encoding that works.
5981 Goes through the list `tramp-local-coding-commands' and
5982 `tramp-remote-coding-commands'."
5984 (let ((local-commands tramp-local-coding-commands)
5986 loc-enc loc-dec rem-enc rem-dec litem ritem found)
5987 (while (and local-commands (not found))
5988 (setq litem (pop local-commands))
5989 (catch 'wont-work-local
5990 (let ((format (nth 0 litem))
5991 (remote-commands tramp-remote-coding-commands))
5992 (setq loc-enc (nth 1 litem))
5993 (setq loc-dec (nth 2 litem))
5994 ;; If the local encoder or decoder is a string, the
5995 ;; corresponding command has to work locally.
5996 (if (not (stringp loc-enc))
5998 vec 5 "Checking local encoding function `%s'" loc-enc)
6000 vec 5 "Checking local encoding command `%s' for sanity" loc-enc)
6001 (unless (zerop (tramp-call-local-coding-command
6003 (throw 'wont-work-local nil)))
6004 (if (not (stringp loc-dec))
6006 vec 5 "Checking local decoding function `%s'" loc-dec)
6008 vec 5 "Checking local decoding command `%s' for sanity" loc-dec)
6009 (unless (zerop (tramp-call-local-coding-command
6011 (throw 'wont-work-local nil)))
6012 ;; Search for remote coding commands with the same format
6013 (while (and remote-commands (not found))
6014 (setq ritem (pop remote-commands))
6015 (catch 'wont-work-remote
6016 (when (equal format (nth 0 ritem))
6017 (setq rem-enc (nth 1 ritem))
6018 (setq rem-dec (nth 2 ritem))
6019 ;; Check if remote encoding and decoding commands can be
6020 ;; called remotely with null input and output. This makes
6021 ;; sure there are no syntax errors and the command is really
6022 ;; found. Note that we do not redirect stdout to /dev/null,
6023 ;; for two reasons: when checking the decoding command, we
6024 ;; actually check the output it gives. And also, when
6025 ;; redirecting "mimencode" output to /dev/null, then as root
6026 ;; it might change the permissions of /dev/null!
6027 (when (not (stringp rem-enc))
6028 (let ((name (symbol-name rem-enc)))
6029 (while (string-match (regexp-quote "-") name)
6030 (setq name (replace-match "_" nil t name)))
6031 (tramp-maybe-send-script vec (symbol-value rem-enc) name)
6032 (setq rem-enc name)))
6035 "Checking remote encoding command `%s' for sanity" rem-enc)
6036 (unless (zerop (tramp-send-command-and-check
6037 vec (format "%s </dev/null" rem-enc) t))
6038 (throw 'wont-work-remote nil))
6040 (when (not (stringp rem-dec))
6041 (let ((name (symbol-name rem-dec)))
6042 (while (string-match (regexp-quote "-") name)
6043 (setq name (replace-match "_" nil t name)))
6044 (tramp-maybe-send-script vec (symbol-value rem-dec) name)
6045 (setq rem-dec name)))
6048 "Checking remote decoding command `%s' for sanity" rem-dec)
6049 (unless (zerop (tramp-send-command-and-check
6051 (format "echo %s | %s | %s"
6052 magic rem-enc rem-dec) t))
6053 (throw 'wont-work-remote nil))
6055 (with-current-buffer (tramp-get-buffer vec)
6056 (goto-char (point-min))
6057 (unless (looking-at (regexp-quote magic))
6058 (throw 'wont-work-remote nil)))
6060 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
6061 (setq rem-enc (nth 1 ritem))
6062 (setq rem-dec (nth 2 ritem))
6063 (setq found t)))))))
6065 ;; Did we find something? If not, issue an error.
6067 (kill-process (tramp-get-connection-process vec))
6069 vec 'file-error "Couldn't find an inline transfer encoding"))
6071 ;; Set connection properties.
6072 (tramp-message vec 5 "Using local encoding `%s'" loc-enc)
6073 (tramp-set-connection-property vec "local-encoding" loc-enc)
6074 (tramp-message vec 5 "Using local decoding `%s'" loc-dec)
6075 (tramp-set-connection-property vec "local-decoding" loc-dec)
6076 (tramp-message vec 5 "Using remote encoding `%s'" rem-enc)
6077 (tramp-set-connection-property vec "remote-encoding" rem-enc)
6078 (tramp-message vec 5 "Using remote decoding `%s'" rem-dec)
6079 (tramp-set-connection-property vec "remote-decoding" rem-dec))))
6081 (defun tramp-call-local-coding-command (cmd input output)
6082 "Call the local encoding or decoding command.
6083 If CMD contains \"%s\", provide input file INPUT there in command.
6084 Otherwise, INPUT is passed via standard input.
6085 INPUT can also be nil which means `/dev/null'.
6086 OUTPUT can be a string (which specifies a filename), or t (which
6087 means standard output and thus the current buffer), or nil (which
6089 (tramp-local-call-process
6090 tramp-encoding-shell
6091 (when (and input (not (string-match "%s" cmd))) input)
6092 (if (eq output t) t nil)
6094 tramp-encoding-command-switch
6096 (if (string-match "%s" cmd) (format cmd input) cmd)
6097 (if (stringp output) (concat "> " output) ""))))
6099 (defun tramp-compute-multi-hops (vec)
6100 "Expands VEC according to `tramp-default-proxies-alist'.
6101 Gateway hops are already opened."
6102 (let ((target-alist `(,vec))
6103 (choices tramp-default-proxies-alist)
6106 ;; Look for proxy hosts to be passed.
6108 (setq item (pop choices)
6112 (string-match (or (nth 0 item) "")
6113 (or (tramp-file-name-host (car target-alist)) ""))
6115 (string-match (or (nth 1 item) "")
6116 (or (tramp-file-name-user (car target-alist)) "")))
6118 ;; No more hops needed.
6120 ;; Replace placeholders.
6124 `((?u . ,(or (tramp-file-name-user (car target-alist)) ""))
6125 (?h . ,(or (tramp-file-name-host (car target-alist)) "")))))
6126 (with-parsed-tramp-file-name proxy l
6128 (add-to-list 'target-alist l)
6129 ;; Start next search.
6130 (setq choices tramp-default-proxies-alist)))))
6133 (when (and (boundp 'tramp-gw-tunnel-method)
6134 (string-match (format
6136 (symbol-value 'tramp-gw-tunnel-method)
6137 (symbol-value 'tramp-gw-socks-method))
6138 (tramp-file-name-method (car target-alist))))
6139 (let ((gw (pop target-alist))
6140 (hop (pop target-alist)))
6141 ;; Is the method prepared for gateways?
6142 (unless (tramp-get-method-parameter
6143 (tramp-file-name-method hop) 'tramp-default-port)
6146 "Method `%s' is not supported for gateway access."
6147 (tramp-file-name-method hop)))
6148 ;; Add default port if needed.
6151 tramp-host-with-port-regexp (tramp-file-name-host hop))
6154 (tramp-file-name-host hop) tramp-prefix-port-format
6156 (tramp-get-method-parameter
6157 (tramp-file-name-method hop) 'tramp-default-port)))))
6158 ;; Open the gateway connection.
6162 (tramp-file-name-method hop) (tramp-file-name-user hop)
6163 (funcall (symbol-function 'tramp-gw-open-connection) vec gw hop) nil))
6164 ;; For the password prompt, we need the correct values.
6165 ;; Therefore, we must remember the gateway vector. But we
6166 ;; cannot do it as connection property, because it shouldn't
6167 ;; be persistent. And we have no started process yet either.
6168 (tramp-set-file-property (car target-alist) "" "gateway" hop)))
6170 ;; Foreign and out-of-band methods are not supported for multi-hops.
6171 (when (cdr target-alist)
6172 (setq choices target-alist)
6174 (setq item (pop choices))
6178 (tramp-get-method-parameter
6179 (tramp-file-name-method item) 'tramp-login-program))
6180 (tramp-get-method-parameter
6181 (tramp-file-name-method item) 'tramp-copy-program))
6184 "Method `%s' is not supported for multi-hops."
6185 (tramp-file-name-method item)))))
6187 ;; In case the host name is not used for the remote shell
6188 ;; command, the user could be misguided by applying a random
6190 (let* ((v (car target-alist))
6191 (method (tramp-file-name-method v))
6192 (host (tramp-file-name-host v)))
6195 ;; There are multi-hops.
6197 ;; The host name is used for the remote shell command.
6199 '("%h") (tramp-get-method-parameter method 'tramp-login-args))
6200 ;; The host is local. We cannot use `tramp-local-host-p'
6201 ;; here, because it opens a connection as well.
6203 (concat "^" (regexp-opt (list "localhost" (system-name)) t) "$")
6207 "Host `%s' looks like a remote host, `%s' can only use the local host"
6213 (defun tramp-maybe-open-connection (vec)
6214 "Maybe open a connection VEC.
6215 Does not do anything if a connection is already open, but re-opens the
6216 connection if a previous connection has died for some reason."
6217 (let ((p (tramp-get-connection-process vec))
6218 (process-environment (copy-sequence process-environment)))
6220 ;; If too much time has passed since last command was sent, look
6221 ;; whether process is still alive. If it isn't, kill it. When
6222 ;; using ssh, it can sometimes happen that the remote end has hung
6223 ;; up but the local ssh client doesn't recognize this until it
6224 ;; tries to send some data to the remote end. So that's why we
6225 ;; try to send a command from time to time, then look again
6226 ;; whether the process is really alive.
6228 (when (and (> (tramp-time-diff
6230 (tramp-get-connection-property
6231 p "last-cmd-time" '(0 0 0)))
6233 p (processp p) (memq (process-status p) '(run open)))
6234 (tramp-send-command vec "echo are you awake" t t)
6235 (unless (and (memq (process-status p) '(run open))
6236 (tramp-wait-for-output p 10))
6237 ;; The error will be catched locally.
6238 (tramp-error vec 'file-error "Awake did fail")))
6240 (tramp-flush-connection-property vec)
6241 (tramp-flush-connection-property p)
6245 ;; New connection must be opened.
6246 (unless (and p (processp p) (memq (process-status p) '(run open)))
6248 ;; We call `tramp-get-buffer' in order to get a debug buffer for
6249 ;; messages from the beginning.
6250 (tramp-get-buffer vec)
6251 (if (zerop (length (tramp-file-name-user vec)))
6253 vec 3 "Opening connection for %s using %s..."
6254 (tramp-file-name-host vec)
6255 (tramp-file-name-method vec))
6257 vec 3 "Opening connection for %s@%s using %s..."
6258 (tramp-file-name-user vec)
6259 (tramp-file-name-host vec)
6260 (tramp-file-name-method vec)))
6262 ;; Start new process.
6263 (when (and p (processp p))
6265 (setenv "TERM" tramp-terminal-type)
6266 (setenv "LC_ALL" "C")
6267 (setenv "PROMPT_COMMAND")
6269 (let* ((target-alist (tramp-compute-multi-hops vec))
6270 (process-connection-type tramp-process-connection-type)
6271 (process-adaptive-read-buffering nil)
6272 (coding-system-for-read nil)
6273 ;; This must be done in order to avoid our file name handler.
6274 (p (let ((default-directory
6275 (tramp-compat-temporary-file-directory)))
6277 (or (tramp-get-connection-property vec "process-name" nil)
6278 (tramp-buffer-name vec))
6279 (tramp-get-connection-buffer vec)
6280 tramp-encoding-shell)))
6284 vec 6 "%s" (mapconcat 'identity (process-command p) " "))
6286 ;; Check whether process is alive.
6287 (set-process-sentinel p 'tramp-process-sentinel)
6288 (tramp-set-process-query-on-exit-flag p nil)
6289 (tramp-message vec 3 "Waiting 60s for local shell to come up...")
6290 (tramp-barf-if-no-shell-prompt
6291 p 60 "Couldn't find local shell prompt %s" tramp-encoding-shell)
6293 ;; Now do all the connections as specified.
6295 (let* ((hop (car target-alist))
6296 (l-method (tramp-file-name-method hop))
6297 (l-user (tramp-file-name-user hop))
6298 (l-host (tramp-file-name-host hop))
6301 (tramp-get-method-parameter l-method 'tramp-login-program))
6303 (tramp-get-method-parameter l-method 'tramp-login-args))
6305 (tramp-get-method-parameter l-method 'tramp-gw-args))
6306 (gw (tramp-get-file-property hop "" "gateway" nil))
6307 (g-method (and gw (tramp-file-name-method gw)))
6308 (g-user (and gw (tramp-file-name-user gw)))
6309 (g-host (and gw (tramp-file-name-host gw)))
6310 (command login-program)
6311 ;; We don't create the temporary file. In fact, it
6312 ;; is just a prefix for the ControlPath option of
6313 ;; ssh; the real temporary file has another name, and
6314 ;; it is created and protected by ssh. It is also
6315 ;; removed by ssh, when the connection is closed.
6317 (tramp-set-connection-property
6321 tramp-temp-name-prefix
6322 (tramp-compat-temporary-file-directory)))))
6325 ;; Add gateway arguments if necessary.
6326 (when (and gw gw-args)
6327 (setq login-args (append login-args gw-args)))
6329 ;; Check for port number. Until now, there's no need for handling
6330 ;; like method, user, host.
6331 (when (string-match tramp-host-with-port-regexp l-host)
6332 (setq l-port (match-string 2 l-host)
6333 l-host (match-string 1 l-host)))
6335 ;; Set variables for computing the prompt for reading password.
6336 ;; They can also be derived from a gatewy.
6337 (setq tramp-current-method (or g-method l-method)
6338 tramp-current-user (or g-user l-user)
6339 tramp-current-host (or g-host l-host))
6341 ;; Replace login-args place holders.
6343 l-host (or l-host "")
6344 l-user (or l-user "")
6345 l-port (or l-port "")
6346 spec `((?h . ,l-host) (?u . ,l-user) (?p . ,l-port)
6353 (setq x (mapcar '(lambda (y) (format-spec y spec)) x))
6354 (unless (member "" x) (mapconcat 'identity x " ")))
6356 ;; String to detect failed connection. Every single word must
6357 ;; be enclosed with '\"'; otherwise it is detected
6358 ;; during connection setup.
6359 ;; Local shell could be a Windows COMSPEC. It doesn't know
6360 ;; the ";" syntax, but we must exit always for `start-process'.
6361 ;; "exec" does not work either.
6364 "; echo \"Tramp\" \"connection\" \"closed\"; sleep 1"))
6365 ;; We don't reach a Windows shell. Could be initial only.
6368 ;; Send the command.
6369 (tramp-message vec 3 "Sending command `%s'" command)
6370 (tramp-send-command vec command t t)
6371 (tramp-process-actions p vec tramp-actions-before-shell 60)
6372 (tramp-message vec 3 "Found remote shell prompt on `%s'" l-host))
6374 (setq target-alist (cdr target-alist)))
6376 ;; Make initial shell settings.
6377 (tramp-open-connection-setup-interactive-shell p vec)))))
6379 (defun tramp-send-command (vec command &optional neveropen nooutput)
6380 "Send the COMMAND to connection VEC.
6381 Erases temporary buffer before sending the command. If optional
6382 arg NEVEROPEN is non-nil, never try to open the connection. This
6383 is meant to be used from `tramp-maybe-open-connection' only. The
6384 function waits for output unless NOOUTPUT is set."
6385 (unless neveropen (tramp-maybe-open-connection vec))
6386 (let ((p (tramp-get-connection-process vec)))
6387 (when (tramp-get-connection-property p "remote-echo" nil)
6388 ;; We mark the command string that it can be erased in the output buffer.
6389 (tramp-set-connection-property p "check-remote-echo" t)
6390 (setq command (format "%s%s%s" tramp-echo-mark command tramp-echo-mark)))
6391 (tramp-message vec 6 "%s" command)
6392 (tramp-send-string vec command)
6393 (unless nooutput (tramp-wait-for-output p))))
6395 (defun tramp-wait-for-output (proc &optional timeout)
6396 "Wait for output from remote rsh command."
6397 (with-current-buffer (process-buffer proc)
6398 ;; Initially, `tramp-end-of-output' is "$ ". There might be
6399 ;; leading escape sequences, which must be ignored.
6401 (if (string-match (regexp-quote "\n") tramp-end-of-output)
6403 'identity (split-string tramp-end-of-output "\n") "\r?\n")
6404 (format "^[^$\n]*%s\r?$" (regexp-quote tramp-end-of-output))))
6405 (found (tramp-wait-for-regexp proc timeout regexp)))
6407 (let (buffer-read-only)
6408 (goto-char (point-max))
6409 (re-search-backward regexp nil t)
6410 (delete-region (point) (point-max)))
6414 "[[Remote prompt `%s' not found in %d secs]]"
6415 tramp-end-of-output timeout)
6418 "[[Remote prompt `%s' not found]]" tramp-end-of-output)))
6419 ;; Return value is whether end-of-output sentinel was found.
6422 (defun tramp-send-command-and-check (vec command &optional subshell)
6423 "Run COMMAND and check its exit status.
6424 Sends `echo $?' along with the COMMAND for checking the exit status. If
6425 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
6427 If the optional argument SUBSHELL is non-nil, the command is executed in
6428 a subshell, ie surrounded by parentheses."
6431 (concat (if subshell "( " "")
6433 (if command " 2>/dev/null; " "")
6434 "echo tramp_exit_status $?"
6435 (if subshell " )" " ")))
6436 (with-current-buffer (tramp-get-connection-buffer vec)
6437 (goto-char (point-max))
6438 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t)
6440 vec 'file-error "Couldn't find exit status of `%s'" command))
6441 (skip-chars-forward "^ ")
6443 (read (current-buffer))
6444 (let (buffer-read-only) (delete-region (match-beginning 0) (point-max))))))
6446 (defun tramp-barf-unless-okay (vec command fmt &rest args)
6447 "Run COMMAND, check exit status, throw error if exit status not okay.
6448 Similar to `tramp-send-command-and-check' but accepts two more arguments
6449 FMT and ARGS which are passed to `error'."
6450 (unless (zerop (tramp-send-command-and-check vec command))
6451 (apply 'tramp-error vec 'file-error fmt args)))
6453 (defun tramp-send-command-and-read (vec command)
6454 "Run COMMAND and return the output, which must be a Lisp expression.
6455 In case there is no valid Lisp expression, it raises an error"
6456 (tramp-barf-unless-okay vec command "`%s' returns with error" command)
6457 (with-current-buffer (tramp-get-connection-buffer vec)
6458 ;; Read the expression.
6459 (goto-char (point-min))
6461 (prog1 (read (current-buffer))
6463 (when (re-search-forward "\\S-" (tramp-compat-line-end-position) t)
6467 "`%s' does not return a valid Lisp expression: `%s'"
6468 command (buffer-string))))))
6470 ;; It seems that Tru64 Unix does not like it if long strings are sent
6471 ;; to it in one go. (This happens when sending the Perl
6472 ;; `file-attributes' implementation, for instance.) Therefore, we
6473 ;; have this function which sends the string in chunks.
6474 (defun tramp-send-string (vec string)
6475 "Send the STRING via connection VEC.
6477 The STRING is expected to use Unix line-endings, but the lines sent to
6478 the remote host use line-endings as defined in the variable
6479 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
6480 (let* ((p (tramp-get-connection-process vec))
6481 (chunksize (tramp-get-connection-property p "chunksize" nil)))
6484 vec 'file-error "Can't send string to remote host -- not logged in"))
6485 (tramp-set-connection-property p "last-cmd-time" (current-time))
6486 (tramp-message vec 10 "%s" string)
6487 (with-current-buffer (tramp-get-connection-buffer vec)
6488 ;; Clean up the buffer. We cannot call `erase-buffer' because
6489 ;; narrowing might be in effect.
6490 (let (buffer-read-only) (delete-region (point-min) (point-max)))
6491 ;; Replace "\n" by `tramp-rsh-end-of-line'.
6493 (mapconcat 'identity
6494 (split-string string "\n")
6495 tramp-rsh-end-of-line))
6496 (unless (or (string= string "")
6497 (string-equal (substring string -1) tramp-rsh-end-of-line))
6498 (setq string (concat string tramp-rsh-end-of-line)))
6500 (if (and chunksize (not (zerop chunksize)))
6502 (end (length string)))
6505 vec 10 "Sending chunk from %s to %s"
6506 pos (min (+ pos chunksize) end))
6507 (process-send-string
6508 p (substring string pos (min (+ pos chunksize) end)))
6509 (setq pos (+ pos chunksize))))
6510 (process-send-string p string)))))
6512 (defun tramp-mode-string-to-int (mode-string)
6513 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
6514 (let* (case-fold-search
6515 (mode-chars (string-to-vector mode-string))
6516 (owner-read (aref mode-chars 1))
6517 (owner-write (aref mode-chars 2))
6518 (owner-execute-or-setid (aref mode-chars 3))
6519 (group-read (aref mode-chars 4))
6520 (group-write (aref mode-chars 5))
6521 (group-execute-or-setid (aref mode-chars 6))
6522 (other-read (aref mode-chars 7))
6523 (other-write (aref mode-chars 8))
6524 (other-execute-or-sticky (aref mode-chars 9)))
6528 ((char-equal owner-read ?r) (tramp-octal-to-decimal "00400"))
6529 ((char-equal owner-read ?-) 0)
6530 (t (error "Second char `%c' must be one of `r-'" owner-read)))
6532 ((char-equal owner-write ?w) (tramp-octal-to-decimal "00200"))
6533 ((char-equal owner-write ?-) 0)
6534 (t (error "Third char `%c' must be one of `w-'" owner-write)))
6536 ((char-equal owner-execute-or-setid ?x)
6537 (tramp-octal-to-decimal "00100"))
6538 ((char-equal owner-execute-or-setid ?S)
6539 (tramp-octal-to-decimal "04000"))
6540 ((char-equal owner-execute-or-setid ?s)
6541 (tramp-octal-to-decimal "04100"))
6542 ((char-equal owner-execute-or-setid ?-) 0)
6543 (t (error "Fourth char `%c' must be one of `xsS-'"
6544 owner-execute-or-setid)))
6546 ((char-equal group-read ?r) (tramp-octal-to-decimal "00040"))
6547 ((char-equal group-read ?-) 0)
6548 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
6550 ((char-equal group-write ?w) (tramp-octal-to-decimal "00020"))
6551 ((char-equal group-write ?-) 0)
6552 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
6554 ((char-equal group-execute-or-setid ?x)
6555 (tramp-octal-to-decimal "00010"))
6556 ((char-equal group-execute-or-setid ?S)
6557 (tramp-octal-to-decimal "02000"))
6558 ((char-equal group-execute-or-setid ?s)
6559 (tramp-octal-to-decimal "02010"))
6560 ((char-equal group-execute-or-setid ?-) 0)
6561 (t (error "Seventh char `%c' must be one of `xsS-'"
6562 group-execute-or-setid)))
6564 ((char-equal other-read ?r)
6565 (tramp-octal-to-decimal "00004"))
6566 ((char-equal other-read ?-) 0)
6567 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
6569 ((char-equal other-write ?w) (tramp-octal-to-decimal "00002"))
6570 ((char-equal other-write ?-) 0)
6571 (t (error "Nineth char `%c' must be one of `w-'" other-write)))
6573 ((char-equal other-execute-or-sticky ?x)
6574 (tramp-octal-to-decimal "00001"))
6575 ((char-equal other-execute-or-sticky ?T)
6576 (tramp-octal-to-decimal "01000"))
6577 ((char-equal other-execute-or-sticky ?t)
6578 (tramp-octal-to-decimal "01001"))
6579 ((char-equal other-execute-or-sticky ?-) 0)
6580 (t (error "Tenth char `%c' must be one of `xtT-'"
6581 other-execute-or-sticky)))))))
6583 (defun tramp-convert-file-attributes (vec attr)
6584 "Convert file-attributes ATTR generated by perl script, stat or ls.
6585 Convert file mode bits to string and set virtual device number.
6587 ;; Convert last access time.
6588 (unless (listp (nth 4 attr))
6589 (setcar (nthcdr 4 attr)
6590 (list (floor (nth 4 attr) 65536)
6591 (floor (mod (nth 4 attr) 65536)))))
6592 ;; Convert last modification time.
6593 (unless (listp (nth 5 attr))
6594 (setcar (nthcdr 5 attr)
6595 (list (floor (nth 5 attr) 65536)
6596 (floor (mod (nth 5 attr) 65536)))))
6597 ;; Convert last status change time.
6598 (unless (listp (nth 6 attr))
6599 (setcar (nthcdr 6 attr)
6600 (list (floor (nth 6 attr) 65536)
6601 (floor (mod (nth 6 attr) 65536)))))
6602 ;; Convert file size.
6603 (when (< (nth 7 attr) 0)
6604 (setcar (nthcdr 7 attr) -1))
6605 (when (and (floatp (nth 7 attr))
6606 (<= (nth 7 attr) (tramp-compat-most-positive-fixnum)))
6607 (setcar (nthcdr 7 attr) (round (nth 7 attr))))
6608 ;; Convert file mode bits to string.
6609 (unless (stringp (nth 8 attr))
6610 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr))))
6611 ;; Convert directory indication bit.
6612 (if (string-match "^d" (nth 8 attr))
6614 (if (and (listp (car attr)) (stringp (caar attr))
6615 (string-match ".+ -> .\\(.+\\)." (caar attr)))
6616 (setcar attr (match-string 1 (caar attr)))
6618 ;; Set file's gid change bit.
6619 (setcar (nthcdr 9 attr)
6620 (if (numberp (nth 3 attr))
6621 (not (= (nth 3 attr)
6622 (tramp-get-remote-gid vec 'integer)))
6625 (tramp-get-remote-gid vec 'string)))))
6627 (unless (listp (nth 10 attr))
6628 (setcar (nthcdr 10 attr)
6630 (list (floor (nth 10 attr) 65536)
6631 (floor (mod (nth 10 attr) 65536)))
6632 ;; Inodes can be incredible huge. We must hide this.
6633 (error (tramp-get-inode vec)))))
6634 ;; Set virtual device number.
6635 (setcar (nthcdr 11 attr)
6636 (tramp-get-device vec))
6639 (defun tramp-get-inode (vec)
6640 "Returns the virtual inode number.
6641 If it doesn't exist, generate a new one."
6642 (let ((string (tramp-make-tramp-file-name
6643 (tramp-file-name-method vec)
6644 (tramp-file-name-user vec)
6645 (tramp-file-name-host vec)
6647 (unless (assoc string tramp-inodes)
6648 (add-to-list 'tramp-inodes
6649 (list string (length tramp-inodes))))
6650 (nth 1 (assoc string tramp-inodes))))
6652 (defun tramp-get-device (vec)
6653 "Returns the virtual device number.
6654 If it doesn't exist, generate a new one."
6655 (let ((string (tramp-make-tramp-file-name
6656 (tramp-file-name-method vec)
6657 (tramp-file-name-user vec)
6658 (tramp-file-name-host vec)
6660 (unless (assoc string tramp-devices)
6661 (add-to-list 'tramp-devices
6662 (list string (length tramp-devices))))
6663 (list -1 (nth 1 (assoc string tramp-devices)))))
6665 (defun tramp-file-mode-from-int (mode)
6666 "Turn an integer representing a file mode into an ls(1)-like string."
6667 (let ((type (cdr (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
6668 (user (logand (lsh mode -6) 7))
6669 (group (logand (lsh mode -3) 7))
6670 (other (logand (lsh mode -0) 7))
6671 (suid (> (logand (lsh mode -9) 4) 0))
6672 (sgid (> (logand (lsh mode -9) 2) 0))
6673 (sticky (> (logand (lsh mode -9) 1) 0)))
6674 (setq user (tramp-file-mode-permissions user suid "s"))
6675 (setq group (tramp-file-mode-permissions group sgid "s"))
6676 (setq other (tramp-file-mode-permissions other sticky "t"))
6677 (concat type user group other)))
6679 (defun tramp-file-mode-permissions (perm suid suid-text)
6680 "Convert a permission bitset into a string.
6681 This is used internally by `tramp-file-mode-from-int'."
6682 (let ((r (> (logand perm 4) 0))
6683 (w (> (logand perm 2) 0))
6684 (x (> (logand perm 1) 0)))
6685 (concat (or (and r "r") "-")
6686 (or (and w "w") "-")
6687 (or (and suid x suid-text) ; suid, execute
6688 (and suid (upcase suid-text)) ; suid, !execute
6689 (and x "x") "-")))) ; !suid
6691 (defun tramp-decimal-to-octal (i)
6692 "Return a string consisting of the octal digits of I.
6693 Not actually used. Use `(format \"%o\" i)' instead?"
6694 (cond ((< i 0) (error "Cannot convert negative number to octal"))
6695 ((not (integerp i)) (error "Cannot convert non-integer to octal"))
6697 (t (concat (tramp-decimal-to-octal (/ i 8))
6698 (number-to-string (% i 8))))))
6700 ;; Kudos to Gerd Moellmann for this suggestion.
6701 (defun tramp-octal-to-decimal (ostr)
6702 "Given a string of octal digits, return a decimal number."
6703 (let ((x (or ostr "")))
6704 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
6705 (unless (string-match "\\`[0-7]*\\'" x)
6706 (error "Non-octal junk in string `%s'" x))
6707 (string-to-number ostr 8)))
6709 (defun tramp-shell-case-fold (string)
6710 "Converts STRING to shell glob pattern which ignores case."
6713 (if (equal (downcase c) (upcase c))
6715 (format "[%c%c]" (downcase c) (upcase c))))
6720 ;; ------------------------------------------------------------
6721 ;; -- Tramp file names --
6722 ;; ------------------------------------------------------------
6723 ;; Conversion functions between external representation and
6724 ;; internal data structure. Convenience functions for internal
6727 (defun tramp-file-name-p (vec)
6728 "Check whether VEC is a Tramp object."
6729 (and (vectorp vec) (= 4 (length vec))))
6731 (defun tramp-file-name-method (vec)
6732 "Return method component of VEC."
6733 (and (tramp-file-name-p vec) (aref vec 0)))
6735 (defun tramp-file-name-user (vec)
6736 "Return user component of VEC."
6737 (and (tramp-file-name-p vec) (aref vec 1)))
6739 (defun tramp-file-name-host (vec)
6740 "Return host component of VEC."
6741 (and (tramp-file-name-p vec) (aref vec 2)))
6743 (defun tramp-file-name-localname (vec)
6744 "Return localname component of VEC."
6745 (and (tramp-file-name-p vec) (aref vec 3)))
6747 ;; The host part of a Tramp file name vector can be of kind
6748 ;; "host#port". Sometimes, we must extract these parts.
6749 (defun tramp-file-name-real-host (vec)
6750 "Return the host name of VEC without port."
6751 (let ((host (tramp-file-name-host vec)))
6752 (if (and (stringp host)
6753 (string-match tramp-host-with-port-regexp host))
6754 (match-string 1 host)
6757 (defun tramp-file-name-port (vec)
6758 "Return the port number of VEC."
6759 (let ((host (tramp-file-name-host vec)))
6761 (string-match tramp-host-with-port-regexp host)
6762 (string-to-number (match-string 2 host)))))
6764 (defun tramp-tramp-file-p (name)
6765 "Return t if NAME is a Tramp file."
6767 (string-match tramp-file-name-regexp name)))
6769 (defun tramp-find-method (method user host)
6770 "Return the right method string to use.
6771 This is METHOD, if non-nil. Otherwise, do a lookup in
6772 `tramp-default-method-alist'."
6774 (let ((choices tramp-default-method-alist)
6777 (setq item (pop choices))
6778 (when (and (string-match (or (nth 0 item) "") (or host ""))
6779 (string-match (or (nth 1 item) "") (or user "")))
6780 (setq lmethod (nth 2 item))
6781 (setq choices nil)))
6783 tramp-default-method))
6785 (defun tramp-find-user (method user host)
6786 "Return the right user string to use.
6787 This is USER, if non-nil. Otherwise, do a lookup in
6788 `tramp-default-user-alist'."
6790 (let ((choices tramp-default-user-alist)
6793 (setq item (pop choices))
6794 (when (and (string-match (or (nth 0 item) "") (or method ""))
6795 (string-match (or (nth 1 item) "") (or host "")))
6796 (setq luser (nth 2 item))
6797 (setq choices nil)))
6799 tramp-default-user))
6801 (defun tramp-find-host (method user host)
6802 "Return the right host string to use.
6803 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
6804 (or (and (> (length host) 0) host)
6805 tramp-default-host))
6807 (defun tramp-dissect-file-name (name &optional nodefault)
6808 "Return a `tramp-file-name' structure.
6809 The structure consists of remote method, remote user, remote host
6810 and localname (file name on remote host). If NODEFAULT is
6811 non-nil, the file name parts are not expanded to their default
6814 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
6815 (unless match (error "Not a Tramp file name: %s" name))
6816 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
6817 (user (match-string (nth 2 tramp-file-name-structure) name))
6818 (host (match-string (nth 3 tramp-file-name-structure) name))
6819 (localname (match-string (nth 4 tramp-file-name-structure) name)))
6820 (when (member method '("multi" "multiu"))
6822 "`%s' method is no longer supported, see (info \"(tramp)Multi-hops\")"
6825 (vector method user host localname)
6827 (tramp-find-method method user host)
6828 (tramp-find-user method user host)
6829 (tramp-find-host method user host)
6832 (defun tramp-equal-remote (file1 file2)
6833 "Checks, whether the remote parts of FILE1 and FILE2 are identical.
6834 The check depends on method, user and host name of the files. If
6835 one of the components is missing, the default values are used.
6836 The local file name parts of FILE1 and FILE2 are not taken into
6841 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
6843 would yield `t'. On the other hand, the following check results in nil:
6845 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
6846 (and (stringp (file-remote-p file1))
6847 (stringp (file-remote-p file2))
6848 (string-equal (file-remote-p file1) (file-remote-p file2))))
6850 (defun tramp-make-tramp-file-name (method user host localname)
6851 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME."
6852 (concat tramp-prefix-format
6853 (when (not (zerop (length method)))
6854 (concat method tramp-postfix-method-format))
6855 (when (not (zerop (length user)))
6856 (concat user tramp-postfix-user-format))
6857 (when host host) tramp-postfix-host-format
6858 (when localname localname)))
6860 (defun tramp-completion-make-tramp-file-name (method user host localname)
6861 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
6862 It must not be a complete Tramp file name, but as long as there are
6863 necessary only. This function will be used in file name completion."
6864 (concat tramp-prefix-format
6865 (when (not (zerop (length method)))
6866 (concat method tramp-postfix-method-format))
6867 (when (not (zerop (length user)))
6868 (concat user tramp-postfix-user-format))
6869 (when (not (zerop (length host)))
6870 (concat host tramp-postfix-host-format))
6871 (when localname localname)))
6873 (defun tramp-make-copy-program-file-name (vec)
6874 "Create a file name suitable to be passed to `rcp' and workalikes."
6875 (let ((user (tramp-file-name-user vec))
6876 (host (tramp-file-name-real-host vec))
6877 (localname (tramp-shell-quote-argument
6878 (tramp-file-name-localname vec))))
6879 (if (not (zerop (length user)))
6880 (format "%s@%s:%s" user host localname)
6881 (format "%s:%s" host localname))))
6883 (defun tramp-method-out-of-band-p (vec)
6884 "Return t if this is an out-of-band method, nil otherwise."
6885 (tramp-get-method-parameter (tramp-file-name-method vec) 'tramp-copy-program))
6887 (defun tramp-local-host-p (vec)
6888 "Return t if this points to the local host, nil otherwise."
6889 ;; We cannot use `tramp-file-name-real-host'. A port is an
6890 ;; indication for an ssh tunnel or alike.
6891 (let ((host (tramp-file-name-host vec)))
6895 (concat "^" (regexp-opt (list "localhost" (system-name)) t) "$") host)
6896 ;; The local temp directory must be writable for the other user.
6898 (tramp-make-tramp-file-name
6899 (tramp-file-name-method vec)
6900 (tramp-file-name-user vec)
6902 (tramp-compat-temporary-file-directory))))))
6904 ;; Variables local to connection.
6906 (defun tramp-get-remote-path (vec)
6907 (with-connection-property vec "remote-path"
6908 (let* ((remote-path (tramp-compat-copy-tree tramp-remote-path))
6909 (elt (memq 'tramp-default-remote-path remote-path))
6910 (default-remote-path
6914 (tramp-send-command-and-read vec "getconf PATH"))
6915 ;; Default if "getconf" is not available.
6919 "`getconf PATH' not successful, using default value \"%s\"."
6921 "/bin:/usr/bin")))))
6923 ;; Replace place holder `tramp-default-remote-path'.
6926 (tramp-split-string default-remote-path ":")
6928 (setq remote-path (delq 'tramp-default-remote-path remote-path)))
6930 ;; Remove non-existing directories.
6936 (with-connection-property vec x
6938 (tramp-make-tramp-file-name
6939 (tramp-file-name-method vec)
6940 (tramp-file-name-user vec)
6941 (tramp-file-name-host vec)
6946 (defun tramp-get-remote-tmpdir (vec)
6947 (with-connection-property vec "tmp-directory"
6948 (let ((dir (tramp-shell-quote-argument "/tmp")))
6950 (tramp-send-command-and-check
6951 vec (format "%s -d %s" (tramp-get-test-command vec) dir)))
6953 (tramp-send-command-and-check
6954 vec (format "%s -w %s" (tramp-get-test-command vec) dir))))
6956 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
6958 (defun tramp-get-ls-command (vec)
6959 (with-connection-property vec "ls"
6960 (with-current-buffer (tramp-get-buffer vec)
6961 (tramp-message vec 5 "Finding a suitable `ls' command")
6964 (dolist (cmd '("ls" "gnuls" "gls"))
6965 (let ((dl (tramp-get-remote-path vec))
6971 (tramp-find-executable vec cmd dl t t)))
6973 (when (zerop (tramp-send-command-and-check
6974 vec (format "%s -lnd /" result)))
6975 (throw 'ls-found result))
6976 (setq dl (cdr dl))))))
6977 (tramp-error vec 'file-error "Couldn't find a proper `ls' command")))))
6979 (defun tramp-get-test-command (vec)
6980 (with-connection-property vec "test"
6981 (with-current-buffer (tramp-get-buffer vec)
6982 (tramp-message vec 5 "Finding a suitable `test' command")
6983 (if (zerop (tramp-send-command-and-check vec "test 0"))
6985 (tramp-find-executable vec "test" (tramp-get-remote-path vec))))))
6987 (defun tramp-get-test-nt-command (vec)
6988 ;; Does `test A -nt B' work? Use abominable `find' construct if it
6989 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
6990 ;; for otherwise the shell crashes.
6991 (with-connection-property vec "test-nt"
6995 vec (format "( %s / -nt / )" (tramp-get-test-command vec)))
6996 (with-current-buffer (tramp-get-buffer vec)
6997 (goto-char (point-min))
6998 (when (looking-at (regexp-quote tramp-end-of-output))
6999 (format "%s %%s -nt %%s" (tramp-get-test-command vec)))))
7004 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
7005 (tramp-get-test-command vec)))
7006 "tramp_test_nt %s %s"))))
7008 (defun tramp-get-file-exists-command (vec)
7009 (with-connection-property vec "file-exists"
7010 (with-current-buffer (tramp-get-buffer vec)
7011 (tramp-message vec 5 "Finding command to check if file exists")
7012 (tramp-find-file-exists-command vec))))
7014 (defun tramp-get-remote-ln (vec)
7015 (with-connection-property vec "ln"
7016 (with-current-buffer (tramp-get-buffer vec)
7017 (tramp-message vec 5 "Finding a suitable `ln' command")
7018 (tramp-find-executable vec "ln" (tramp-get-remote-path vec)))))
7020 (defun tramp-get-remote-perl (vec)
7021 (with-connection-property vec "perl"
7022 (with-current-buffer (tramp-get-buffer vec)
7023 (tramp-message vec 5 "Finding a suitable `perl' command")
7024 (or (tramp-find-executable vec "perl5" (tramp-get-remote-path vec))
7025 (tramp-find-executable vec "perl" (tramp-get-remote-path vec))))))
7027 (defun tramp-get-remote-stat (vec)
7028 (with-connection-property vec "stat"
7029 (with-current-buffer (tramp-get-buffer vec)
7030 (tramp-message vec 5 "Finding a suitable `stat' command")
7031 (let ((result (tramp-find-executable
7032 vec "stat" (tramp-get-remote-path vec)))
7034 ;; Check whether stat(1) returns usable syntax. %s does not
7035 ;; work on older AIX systems.
7038 ;; We don't want to display an error message.
7039 (with-temp-message (or (current-message) "")
7041 (tramp-send-command-and-read
7042 vec (format "%s -c '(\"%%N\" %%s)' /" result))
7044 (unless (and (listp tmp) (stringp (car tmp))
7045 (string-match "^./.$" (car tmp))
7046 (integerp (cadr tmp)))
7050 (defun tramp-get-remote-id (vec)
7051 (with-connection-property vec "id"
7052 (with-current-buffer (tramp-get-buffer vec)
7053 (tramp-message vec 5 "Finding POSIX `id' command")
7056 (let ((dl (tramp-get-remote-path vec))
7062 (tramp-find-executable vec "id" dl t t)))
7063 ;; Check POSIX parameter.
7064 (when (zerop (tramp-send-command-and-check
7065 vec (format "%s -u" result)))
7066 (throw 'id-found result))
7067 (setq dl (cdr dl)))))
7068 (tramp-error vec 'file-error "Couldn't find a POSIX `id' command")))))
7070 (defun tramp-get-remote-uid (vec id-format)
7071 (with-connection-property vec (format "uid-%s" id-format)
7072 (let ((res (tramp-send-command-and-read
7074 (format "%s -u%s %s"
7075 (tramp-get-remote-id vec)
7076 (if (equal id-format 'integer) "" "n")
7077 (if (equal id-format 'integer)
7078 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7079 ;; The command might not always return a number.
7080 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7082 (defun tramp-get-remote-gid (vec id-format)
7083 (with-connection-property vec (format "gid-%s" id-format)
7084 (let ((res (tramp-send-command-and-read
7086 (format "%s -g%s %s"
7087 (tramp-get-remote-id vec)
7088 (if (equal id-format 'integer) "" "n")
7089 (if (equal id-format 'integer)
7090 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7091 ;; The command might not always return a number.
7092 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7094 (defun tramp-get-local-uid (id-format)
7095 (if (equal id-format 'integer) (user-uid) (user-login-name)))
7097 (defun tramp-get-local-gid (id-format)
7098 (nth 3 (tramp-compat-file-attributes "~/" id-format)))
7100 ;; Some predefined connection properties.
7101 (defun tramp-get-remote-coding (vec prop)
7102 ;; Local coding handles properties like remote coding. So we could
7103 ;; call it without pain.
7104 (let ((ret (tramp-get-local-coding vec prop)))
7105 ;; The connection property might have been cached. So we must send
7106 ;; the script - maybe.
7107 (when (not (stringp ret))
7108 (let ((name (symbol-name ret)))
7109 (while (string-match (regexp-quote "-") name)
7110 (setq name (replace-match "_" nil t name)))
7111 (tramp-maybe-send-script vec (symbol-value ret) name)
7113 ;; Return the value.
7116 (defun tramp-get-local-coding (vec prop)
7118 (tramp-get-connection-property vec prop nil)
7120 (tramp-find-inline-encoding vec)
7121 (tramp-get-connection-property vec prop nil))))
7123 (defun tramp-get-method-parameter (method param)
7124 "Return the method parameter PARAM.
7125 If the `tramp-methods' entry does not exist, return NIL."
7126 (let ((entry (assoc param (assoc method tramp-methods))))
7127 (when entry (cadr entry))))
7129 ;; Auto saving to a special directory.
7131 (defun tramp-exists-file-name-handler (operation &rest args)
7132 "Checks whether OPERATION runs a file name handler."
7133 ;; The file name handler is determined on base of either an
7134 ;; argument, `buffer-file-name', or `default-directory'.
7136 (let* ((buffer-file-name "/")
7137 (default-directory "/")
7138 (fnha file-name-handler-alist)
7139 (check-file-name-operation operation)
7140 (file-name-handler-alist
7143 '(lambda (operation &rest args)
7144 "Returns OPERATION if it is the one to be checked."
7145 (if (equal check-file-name-operation operation)
7147 (let ((file-name-handler-alist fnha))
7148 (apply operation args))))))))
7149 (equal (apply operation args) operation))
7152 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
7153 (defadvice make-auto-save-file-name
7154 (around tramp-advice-make-auto-save-file-name () activate)
7155 "Invoke `tramp-handle-make-auto-save-file-name' for Tramp files."
7156 (if (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))
7157 (setq ad-return-value (tramp-handle-make-auto-save-file-name))
7159 (add-hook 'tramp-unload-hook
7160 '(lambda () (ad-unadvise 'make-auto-save-file-name))))
7162 ;; In Emacs < 22 and XEmacs < 21.5 autosaved remote files have
7163 ;; permission 0666 minus umask. This is a security threat.
7165 (defun tramp-set-auto-save-file-modes ()
7166 "Set permissions of autosaved remote files to the original permissions."
7167 (let ((bfn (buffer-file-name)))
7168 (when (and (stringp bfn)
7169 (tramp-tramp-file-p bfn)
7171 (stringp buffer-auto-save-file-name)
7172 (not (equal bfn buffer-auto-save-file-name)))
7173 (unless (file-exists-p buffer-auto-save-file-name)
7174 (write-region "" nil buffer-auto-save-file-name))
7175 ;; Permissions should be set always, because there might be an old
7176 ;; auto-saved file belonging to another original file. This could
7177 ;; be a security threat.
7178 (set-file-modes buffer-auto-save-file-name
7179 (or (file-modes bfn) (tramp-octal-to-decimal "0600"))))))
7181 (unless (or (> emacs-major-version 21)
7182 (and (featurep 'xemacs)
7183 (= emacs-major-version 21)
7184 (> emacs-minor-version 4)))
7185 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
7186 (add-hook 'tramp-unload-hook
7188 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
7190 (defun tramp-subst-strs-in-string (alist string)
7191 "Replace all occurrences of the string FROM with TO in STRING.
7192 ALIST is of the form ((FROM . TO) ...)."
7195 (let* ((pr (car alist))
7198 (while (string-match (regexp-quote from) string)
7199 (setq string (replace-match to t t string)))
7200 (setq alist (cdr alist))))
7203 ;; ------------------------------------------------------------
7204 ;; -- Compatibility functions section --
7205 ;; ------------------------------------------------------------
7207 (defun tramp-read-passwd (proc &optional prompt)
7208 "Read a password from user (compat function).
7209 Consults the auth-source package.
7210 Invokes `password-read' if available, `read-passwd' else."
7211 (let* ((key (tramp-make-tramp-file-name
7212 tramp-current-method tramp-current-user
7213 tramp-current-host ""))
7216 (with-current-buffer (process-buffer proc)
7217 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
7218 (format "%s for %s " (capitalize (match-string 1)) key)))))
7221 ;; see if auth-sources contains something useful, if it's bound
7222 (when (boundp 'auth-sources)
7224 ;; 1. try with Tramp's current method
7225 (auth-source-user-or-password
7226 "password" tramp-current-host tramp-current-method)
7227 ;; 2. hard-code the method to be "tramp"
7228 (auth-source-user-or-password
7229 "password" tramp-current-host "tramp")))
7230 ;; 3. else, get the password interactively
7231 (if (functionp 'password-read)
7232 (let ((password (funcall (symbol-function 'password-read)
7234 (funcall (symbol-function 'password-cache-add) key password)
7236 (read-passwd pw-prompt)))))
7238 (defun tramp-clear-passwd (vec)
7239 "Clear password cache for connection related to VEC."
7240 (when (functionp 'password-cache-remove)
7242 (symbol-function 'password-cache-remove)
7243 (tramp-make-tramp-file-name
7244 (tramp-file-name-method vec)
7245 (tramp-file-name-user vec)
7246 (tramp-file-name-host vec)
7249 ;; Snarfed code from time-date.el and parse-time.el
7251 (defconst tramp-half-a-year '(241 17024)
7252 "Evaluated by \"(days-to-time 183)\".")
7254 (defconst tramp-parse-time-months
7255 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
7256 ("apr" . 4) ("may" . 5) ("jun" . 6)
7257 ("jul" . 7) ("aug" . 8) ("sep" . 9)
7258 ("oct" . 10) ("nov" . 11) ("dec" . 12))
7259 "Alist mapping month names to integers.")
7261 (defun tramp-time-less-p (t1 t2)
7262 "Say whether time value T1 is less than time value T2."
7263 (unless t1 (setq t1 '(0 0)))
7264 (unless t2 (setq t2 '(0 0)))
7265 (or (< (car t1) (car t2))
7266 (and (= (car t1) (car t2))
7267 (< (nth 1 t1) (nth 1 t2)))))
7269 (defun tramp-time-subtract (t1 t2)
7270 "Subtract two time values.
7271 Return the difference in the format of a time value."
7272 (unless t1 (setq t1 '(0 0)))
7273 (unless t2 (setq t2 '(0 0)))
7274 (let ((borrow (< (cadr t1) (cadr t2))))
7275 (list (- (car t1) (car t2) (if borrow 1 0))
7276 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
7278 (defun tramp-time-diff (t1 t2)
7279 "Return the difference between the two times, in seconds.
7280 T1 and T2 are time values (as returned by `current-time' for example)."
7281 ;; Pacify byte-compiler with `symbol-function'.
7282 (cond ((and (fboundp 'subtract-time)
7283 (fboundp 'float-time))
7284 (funcall (symbol-function 'float-time)
7285 (funcall (symbol-function 'subtract-time) t1 t2)))
7286 ((and (fboundp 'subtract-time)
7287 (fboundp 'time-to-seconds))
7288 (funcall (symbol-function 'time-to-seconds)
7289 (funcall (symbol-function 'subtract-time) t1 t2)))
7290 ((fboundp 'itimer-time-difference)
7291 (funcall (symbol-function 'itimer-time-difference)
7292 (if (< (length t1) 3) (append t1 '(0)) t1)
7293 (if (< (length t2) 3) (append t2 '(0)) t2)))
7295 (let ((time (tramp-time-subtract t1 t2)))
7296 (+ (* (car time) 65536.0)
7298 (/ (or (nth 2 time) 0) 1000000.0))))))
7300 (defun tramp-coding-system-change-eol-conversion (coding-system eol-type)
7301 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
7302 EOL-TYPE can be one of `dos', `unix', or `mac'."
7303 (cond ((fboundp 'coding-system-change-eol-conversion)
7304 (funcall (symbol-function 'coding-system-change-eol-conversion)
7305 coding-system eol-type))
7306 ((fboundp 'subsidiary-coding-system)
7307 (funcall (symbol-function 'subsidiary-coding-system)
7309 (cond ((eq eol-type 'dos) 'crlf)
7310 ((eq eol-type 'unix) 'lf)
7311 ((eq eol-type 'mac) 'cr)
7313 (error "Unknown EOL-TYPE `%s', must be %s"
7315 "`dos', `unix', or `mac'")))))
7316 (t (error "Can't change EOL conversion -- is MULE missing?"))))
7318 (defun tramp-split-string (string pattern)
7319 "Like `split-string' but omit empty strings.
7320 In Emacs, (split-string \"/foo/bar\" \"/\") returns (\"foo\" \"bar\").
7321 This is, the first, empty, element is omitted. In XEmacs, the first
7322 element is not omitted.
7324 Note: this function has been written for `tramp-handle-file-truename'.
7325 If you want to use it for something else, you'll have to check whether
7326 it does the right thing."
7327 (delete "" (split-string string pattern)))
7329 (defun tramp-set-process-query-on-exit-flag (process flag)
7330 "Specify if query is needed for process when Emacs is exited.
7331 If the second argument flag is non-nil, Emacs will query the user before
7332 exiting if process is running."
7333 (if (fboundp 'set-process-query-on-exit-flag)
7334 (funcall (symbol-function 'set-process-query-on-exit-flag) process flag)
7335 (funcall (symbol-function 'process-kill-without-query) process flag)))
7338 ;; ------------------------------------------------------------
7339 ;; -- Kludges section --
7340 ;; ------------------------------------------------------------
7342 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
7343 ;; does not deal well with newline characters. Newline is replaced by
7344 ;; backslash newline. But if, say, the string `a backslash newline b'
7345 ;; is passed to a shell, the shell will expand this into "ab",
7346 ;; completely omitting the newline. This is not what was intended.
7347 ;; It does not appear to be possible to make the function
7348 ;; `shell-quote-argument' work with newlines without making it
7349 ;; dependent on the shell used. But within this package, we know that
7350 ;; we will always use a Bourne-like shell, so we use an approach which
7353 ;; The approach is simple: we call `shell-quote-argument', then
7354 ;; massage the newline part of the result.
7356 ;; This function should produce a string which is grokked by a Unix
7357 ;; shell, even if the Emacs is running on Windows. Since this is the
7358 ;; kludges section, we bind `system-type' in such a way that
7359 ;; `shell-quote-arguments' behaves as if on Unix.
7361 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
7362 ;; function to work with Bourne-like shells.
7364 ;; CCC: This function should be rewritten so that
7365 ;; `shell-quote-argument' is not used. This way, we are safe from
7366 ;; changes in `shell-quote-argument'.
7367 (defun tramp-shell-quote-argument (s)
7368 "Similar to `shell-quote-argument', but groks newlines.
7369 Only works for Bourne-like shells."
7370 (let ((system-type 'not-windows))
7372 (let ((result (shell-quote-argument s))
7373 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
7374 (when (and (>= (length result) 2)
7375 (string= (substring result 0 2) "\\~"))
7376 (setq result (substring result 1)))
7377 (while (string-match nl result)
7378 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
7382 ;; We currently (sometimes) use "[" and "]" in the filename format.
7383 ;; This means that Emacs wants to expand wildcards if
7384 ;; `find-file-wildcards' is non-nil, and then barfs because no
7385 ;; expansion could be found. We detect this situation and do
7386 ;; something really awful: we have `file-expand-wildcards' return the
7387 ;; original filename if it can't expand anything. Let's just hope
7388 ;; that this doesn't break anything else.
7389 ;; CCC: This check is now also really awful; we should search all
7390 ;; of the filename format, not just the prefix.
7391 (when (string-match "\\[" tramp-prefix-format)
7392 (defadvice file-expand-wildcards
7393 (around tramp-advice-file-expand-wildcards activate)
7394 (let ((name (ad-get-arg 0)))
7395 (if (tramp-tramp-file-p name)
7396 ;; If it's a Tramp file, dissect it and look if wildcards
7397 ;; need to be expanded at all.
7400 (tramp-file-name-localname (tramp-dissect-file-name name)))
7401 (setq ad-return-value (or ad-do-it (list name)))
7402 (setq ad-return-value (list name)))
7403 ;; If it is not a Tramp file, just run the original function.
7404 (setq ad-return-value (or ad-do-it (list name))))))
7405 (add-hook 'tramp-unload-hook
7406 '(lambda () (ad-unadvise 'file-expand-wildcards))))
7408 ;; Checklist for `tramp-unload-hook'
7409 ;; - Unload all `tramp-*' packages
7410 ;; - Reset `file-name-handler-alist'
7411 ;; - Cleanup hooks where Tramp functions are in
7412 ;; - Cleanup advised functions
7413 ;; - Cleanup autoloads
7415 (defun tramp-unload-tramp ()
7416 "Discard Tramp from loading remote files."
7418 ;; When Tramp is not loaded yet, its autoloads are still active.
7419 (tramp-unload-file-name-handlers)
7420 ;; ange-ftp settings must be enabled.
7421 (when (functionp 'tramp-ftp-enable-ange-ftp)
7422 (funcall (symbol-function 'tramp-ftp-enable-ange-ftp)))
7423 ;; Maybe its not loaded yet.
7425 (unload-feature 'tramp 'force)
7432 ;; * Allow putting passwords in the filename.
7433 ;; This should be implemented via a general mechanism to add
7434 ;; parameters in filenames. There is currently a kludge for
7435 ;; putting the port number into the filename for ssh and ftp
7436 ;; files. This could be subsumed by the new mechanism as well.
7437 ;; Another approach is to read a netrc file like ~/.authinfo
7439 ;; * Handle nonlocal exits such as C-g.
7440 ;; * But it would probably be better to use with-local-quit at the
7441 ;; place where it's actually needed: around any potentially
7442 ;; indefinitely blocking piece of code. In this case it would be
7443 ;; within Tramp around one of its calls to accept-process-output (or
7444 ;; around one of the loops that calls accept-process-output)
7445 ;; (Stefan Monnier).
7446 ;; * Autodetect if remote `ls' groks the "--dired" switch.
7447 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
7448 ;; `shell-quote-argument'.
7449 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
7450 ;; by the files in that directory. Add this here.
7451 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
7452 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
7453 ;; * When logging in, keep looking for questions according to an alist
7454 ;; and then invoke the right function.
7455 ;; * Case-insensitive filename completion. (Norbert Goevert.)
7456 ;; * Don't use globbing for directories with many files, as this is
7457 ;; likely to produce long command lines, and some shells choke on
7458 ;; long command lines.
7459 ;; * `vc-directory' does not work. It never displays any files, even
7460 ;; if it does show files when run locally.
7461 ;; * Allow correction of passwords, if the remote end allows this.
7462 ;; (Mark Hershberger)
7463 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
7464 ;; * Grok `append' parameter for `write-region'.
7465 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
7466 ;; * abbreviate-file-name
7467 ;; * better error checking. At least whenever we see something
7468 ;; strange when doing zerop, we should kill the process and start
7469 ;; again. (Greg Stark)
7470 ;; * Provide a local cache of old versions of remote files for the rsync
7471 ;; transfer method to use. (Greg Stark)
7472 ;; * Remove unneeded parameters from methods.
7473 ;; * Invoke rsync once for copying a whole directory hierarchy.
7474 ;; (Francesco Potortì)
7475 ;; * Make it work for different encodings, and for different file name
7476 ;; encodings, too. (Daniel Pittman)
7477 ;; * Progress reports while copying files. (Michael Kifer)
7478 ;; * Don't search for perl5 and perl. Instead, only search for perl and
7479 ;; then look if it's the right version (with `perl -v').
7480 ;; * When editing a remote CVS controlled file as a different user, VC
7481 ;; gets confused about the file locking status. Try to find out why
7482 ;; the workaround doesn't work.
7483 ;; * Username and hostname completion.
7484 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
7485 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
7486 ;; Code is nearly identical.
7487 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
7488 ;; until the last but one hop via `start-file-process'. Apply it
7489 ;; also for ftp and smb.
7490 ;; * WIBNI if we had a command "trampclient"? If I was editing in
7491 ;; some shell with root priviledges, it would be nice if I could
7493 ;; trampclient filename.c
7494 ;; as an editor, and the _current_ shell would connect to an Emacs
7495 ;; server and would be used in an existing non-priviledged Emacs
7496 ;; session for doing the editing in question.
7497 ;; That way, I need not tell Emacs my password again and be afraid
7498 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
7499 ;; once display a just typed password in the context of a keyboard
7500 ;; sequence prompt for a question immediately following in a shell
7501 ;; script run within Emacs -- nasty).
7502 ;; And if I have some ssh session running to a different computer,
7503 ;; having the possibility of passing a local file there to a local
7504 ;; Emacs session (in case I can arrange for a connection back) would
7506 ;; Likely the corresponding Tramp server should not allow the
7507 ;; equivalent of the emacsclient -eval option in order to make this
7508 ;; reasonably unproblematic. And maybe trampclient should have some
7509 ;; way of passing credentials, like by using an SSL socket or
7510 ;; something. (David Kastrup)
7511 ;; * Could Tramp reasonably look for a prompt after ^M rather than
7512 ;; only after ^J ? (Stefan Monnier)
7513 ;; * Reconnect directly to a compliant shell without first going
7514 ;; through the user's default shell. (Pete Forman)
7515 ;; * Make `tramp-default-user' obsolete.
7516 ;; * Tramp shall reconnect automatically to its ssh connection when it
7517 ;; detects that the process "has died". (David Reitter)
7519 ;; Functions for file-name-handler-alist:
7520 ;; diff-latest-backup-file -- in diff.el
7521 ;; dired-uncache -- this will be needed when we do insert-directory caching
7522 ;; file-name-as-directory -- use primitive?
7523 ;; file-name-sans-versions -- use primitive?
7524 ;; get-file-buffer -- use primitive
7527 ;; arch-tag: 3a21a994-182b-48fa-b0cd-c1d9fede424a
7528 ;;; tramp.el ends here