1 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 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 ;; Also see the todo list at the bottom of this file.
45 ;; The current version of Tramp can be retrieved from the following URL:
46 ;; http://ftp.gnu.org/gnu/tramp/
48 ;; There's a mailing list for this, as well. Its name is:
49 ;; tramp-devel@gnu.org
50 ;; You can use the Web to subscribe, under the following URL:
51 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
53 ;; For the adventurous, the current development sources are available
54 ;; via CVS. You can find instructions about this at the following URL:
55 ;; http://savannah.gnu.org/projects/tramp/
56 ;; Click on "CVS" in the navigation bar near the top.
58 ;; Don't forget to put on your asbestos longjohns, first!
62 ;; Since Emacs 23.1, loading messages have been disabled during
63 ;; autoload. However, loading Tramp takes a while, and it could
64 ;; happen while typing a filename in the minibuffer. Therefore, Tramp
65 ;; shall inform about.
66 (when (and load-in-progress (null (current-message)))
67 (message "Loading tramp..."))
69 ;; The Tramp version number and bug report address, as prepared by configure.
71 (add-hook 'tramp-unload-hook
73 (when (featurep 'trampver)
74 (unload-feature 'trampver 'force))))
76 (require 'tramp-compat)
77 (add-hook 'tramp-unload-hook
79 (when (featurep 'tramp-compat)
80 (unload-feature 'tramp-compat 'force))))
82 (require 'format-spec) ; from Gnus 5.8, also in tar ball
83 ;; As long as password.el is not part of (X)Emacs, it shouldn't
85 (if (featurep 'xemacs)
86 (load "password" 'noerror)
87 (or (require 'password-cache nil 'noerror)
88 (require 'password nil 'noerror))) ; from No Gnus, also in tar ball
94 (if (featurep 'xemacs)
95 (load "auth-source" 'noerror)
96 (require 'auth-source nil 'noerror)))
98 ;; Requiring 'tramp-cache results in an endless loop.
99 (autoload 'tramp-get-file-property "tramp-cache")
100 (autoload 'tramp-set-file-property "tramp-cache")
101 (autoload 'tramp-flush-file-property "tramp-cache")
102 (autoload 'tramp-flush-directory-property "tramp-cache")
103 (autoload 'tramp-get-connection-property "tramp-cache")
104 (autoload 'tramp-set-connection-property "tramp-cache")
105 (autoload 'tramp-flush-connection-property "tramp-cache")
106 (autoload 'tramp-parse-connection-properties "tramp-cache")
107 (add-hook 'tramp-unload-hook
109 (when (featurep 'tramp-cache)
110 (unload-feature 'tramp-cache 'force))))
112 (autoload 'tramp-uuencode-region "tramp-uu"
113 "Implementation of `uuencode' in Lisp.")
114 (add-hook 'tramp-unload-hook
116 (when (featurep 'tramp-uu)
117 (unload-feature 'tramp-uu 'force))))
119 (autoload 'uudecode-decode-region "uudecode")
121 ;; The following Tramp packages must be loaded after tramp.el, because
122 ;; they require it as well.
123 (eval-after-load "tramp"
128 ;; Tramp interactive commands.
131 ;; Load foreign FTP method.
132 (if (featurep 'xemacs) 'tramp-efs 'tramp-ftp)
134 ;; tramp-smb uses "smbclient" from Samba. Not available
135 ;; under Cygwin and Windows, because they don't offer
136 ;; "smbclient". And even not necessary there, because Emacs
137 ;; supports UNC file names like "//host/share/localname".
138 (unless (memq system-type '(cygwin windows-nt)) 'tramp-smb)
140 ;; Load foreign FISH method.
143 ;; Load gateways. It needs `make-network-process' from Emacs 22.
144 (when (functionp 'make-network-process) 'tramp-gw)))
148 (add-hook 'tramp-unload-hook
150 (when (featurep (quote ,feature))
151 (unload-feature (quote ,feature) 'force)))))))
153 ;;; User Customizable Internal Variables:
156 "Edit remote files with a combination of rsh and rcp or similar programs."
160 ;; Maybe we need once a real Tramp mode, with key bindings etc.
162 (defcustom tramp-mode t
163 "*Whether Tramp is enabled.
164 If it is set to nil, all remote file names are used literally."
168 (defcustom tramp-verbose 3
169 "*Verbosity level for Tramp.
170 Any level x includes messages for all levels 1 .. x-1. The levels are
172 0 silent (no tramp messages at all)
175 3 connection to remote hosts (default level)
178 6 sent and received strings
180 8 connection properties
187 (when (boundp 'backup-directory-alist)
188 (defcustom tramp-backup-directory-alist nil
189 "Alist of filename patterns and backup directory names.
190 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
191 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
192 is a local file name, the backup directory is prepended with Tramp file
193 name prefix \(method, user, host\) of file.
195 \(setq tramp-backup-directory-alist backup-directory-alist\)
197 gives the same backup policy for Tramp files on their hosts like the
198 policy for local files."
200 :type '(repeat (cons (regexp :tag "Regexp matching filename")
201 (directory :tag "Backup directory name"))))))
203 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
204 ;; the package "backup-dir" might not be loaded yet.
206 (when (featurep 'xemacs)
207 (defcustom tramp-bkup-backup-directory-info nil
208 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
209 It has the same meaning like `bkup-backup-directory-info' from package
210 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
211 file name, the backup directory is prepended with Tramp file name prefix
212 \(method, user, host\) of file.
214 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
216 gives the same backup policy for Tramp files on their hosts like the
217 policy for local files."
219 (list (regexp :tag "File regexp")
220 (string :tag "Backup Dir")
225 (const search-upward))))
228 (defcustom tramp-auto-save-directory nil
229 "*Put auto-save files in this directory, if set.
230 The idea is to use a local directory so that auto-saving is faster."
232 :type '(choice (const nil) string))
234 (defcustom tramp-encoding-shell
235 (if (memq system-type '(windows-nt))
238 "*Use this program for encoding and decoding commands on the local host.
239 This shell is used to execute the encoding and decoding command on the
240 local host, so if you want to use `~' in those commands, you should
241 choose a shell here which groks tilde expansion. `/bin/sh' normally
242 does not understand tilde expansion.
244 For encoding and deocding, commands like the following are executed:
246 /bin/sh -c COMMAND < INPUT > OUTPUT
248 This variable can be used to change the \"/bin/sh\" part. See the
249 variable `tramp-encoding-command-switch' for the \"-c\" part.
251 Note that this variable is not used for remote commands. There are
252 mechanisms in tramp.el which automatically determine the right shell to
253 use for the remote host."
255 :type '(file :must-match t))
257 (defcustom tramp-encoding-command-switch
258 (if (string-match "cmd\\.exe" tramp-encoding-shell)
261 "*Use this switch together with `tramp-encoding-shell' for local commands.
262 See the variable `tramp-encoding-shell' for more information."
266 (defcustom tramp-copy-size-limit 10240
267 "*The maximum file size where inline copying is preferred over an out-of-the-band copy."
271 (defcustom tramp-terminal-type "dumb"
272 "*Value of TERM environment variable for logging in to remote host.
273 Because Tramp wants to parse the output of the remote shell, it is easily
274 confused by ANSI color escape sequences and suchlike. Often, shell init
275 files conditionalize this setup based on the TERM environment variable."
279 (defvar tramp-methods
280 `(("rcp" (tramp-login-program "rsh")
281 (tramp-login-args (("%h") ("-l" "%u")))
282 (tramp-remote-sh "/bin/sh")
283 (tramp-copy-program "rcp")
284 (tramp-copy-args (("-p" "%k")))
285 (tramp-copy-keep-date t)
286 (tramp-password-end-of-line nil))
287 ("scp" (tramp-login-program "ssh")
288 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
290 (tramp-remote-sh "/bin/sh")
291 (tramp-copy-program "scp")
292 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q")))
293 (tramp-copy-keep-date t)
294 (tramp-password-end-of-line nil)
295 (tramp-gw-args (("-o"
296 "GlobalKnownHostsFile=/dev/null")
297 ("-o" "UserKnownHostsFile=/dev/null")
298 ("-o" "StrictHostKeyChecking=no")))
299 (tramp-default-port 22))
300 ("scp1" (tramp-login-program "ssh")
301 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
303 (tramp-remote-sh "/bin/sh")
304 (tramp-copy-program "scp")
305 (tramp-copy-args (("-1") ("-P" "%p") ("-p" "%k")
307 (tramp-copy-keep-date t)
308 (tramp-password-end-of-line nil)
309 (tramp-gw-args (("-o"
310 "GlobalKnownHostsFile=/dev/null")
311 ("-o" "UserKnownHostsFile=/dev/null")
312 ("-o" "StrictHostKeyChecking=no")))
313 (tramp-default-port 22))
314 ("scp2" (tramp-login-program "ssh")
315 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
317 (tramp-remote-sh "/bin/sh")
318 (tramp-copy-program "scp")
319 (tramp-copy-args (("-2") ("-P" "%p") ("-p" "%k")
321 (tramp-copy-keep-date t)
322 (tramp-password-end-of-line nil)
323 (tramp-gw-args (("-o"
324 "GlobalKnownHostsFile=/dev/null")
325 ("-o" "UserKnownHostsFile=/dev/null")
326 ("-o" "StrictHostKeyChecking=no")))
327 (tramp-default-port 22))
329 (tramp-login-program "ssh1")
330 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
332 (tramp-remote-sh "/bin/sh")
333 (tramp-copy-program "scp1")
334 (tramp-copy-args (("-p" "%k")))
335 (tramp-copy-keep-date t)
336 (tramp-password-end-of-line nil))
338 (tramp-login-program "ssh2")
339 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
341 (tramp-remote-sh "/bin/sh")
342 (tramp-copy-program "scp2")
343 (tramp-copy-args (("-p" "%k")))
344 (tramp-copy-keep-date t)
345 (tramp-password-end-of-line nil))
346 ("sftp" (tramp-login-program "ssh")
347 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
349 (tramp-remote-sh "/bin/sh")
350 (tramp-copy-program "sftp")
351 (tramp-copy-args nil)
352 (tramp-copy-keep-date nil)
353 (tramp-password-end-of-line nil))
354 ("rsync" (tramp-login-program "ssh")
355 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
357 (tramp-remote-sh "/bin/sh")
358 (tramp-copy-program "rsync")
359 (tramp-copy-args (("-e" "ssh") ("-t" "%k")))
360 (tramp-copy-keep-date t)
361 (tramp-password-end-of-line nil))
362 ("remcp" (tramp-login-program "remsh")
363 (tramp-login-args (("%h") ("-l" "%u")))
364 (tramp-remote-sh "/bin/sh")
365 (tramp-copy-program "rcp")
366 (tramp-copy-args (("-p" "%k")))
367 (tramp-copy-keep-date t)
368 (tramp-password-end-of-line nil))
369 ("rsh" (tramp-login-program "rsh")
370 (tramp-login-args (("%h") ("-l" "%u")))
371 (tramp-remote-sh "/bin/sh")
372 (tramp-copy-program nil)
373 (tramp-copy-args nil)
374 (tramp-copy-keep-date nil)
375 (tramp-password-end-of-line nil))
376 ("ssh" (tramp-login-program "ssh")
377 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
379 (tramp-remote-sh "/bin/sh")
380 (tramp-copy-program nil)
381 (tramp-copy-args nil)
382 (tramp-copy-keep-date nil)
383 (tramp-password-end-of-line nil)
384 (tramp-gw-args (("-o"
385 "GlobalKnownHostsFile=/dev/null")
386 ("-o" "UserKnownHostsFile=/dev/null")
387 ("-o" "StrictHostKeyChecking=no")))
388 (tramp-default-port 22))
389 ("ssh1" (tramp-login-program "ssh")
390 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
392 (tramp-remote-sh "/bin/sh")
393 (tramp-copy-program nil)
394 (tramp-copy-args nil)
395 (tramp-copy-keep-date nil)
396 (tramp-password-end-of-line nil)
397 (tramp-gw-args (("-o"
398 "GlobalKnownHostsFile=/dev/null")
399 ("-o" "UserKnownHostsFile=/dev/null")
400 ("-o" "StrictHostKeyChecking=no")))
401 (tramp-default-port 22))
402 ("ssh2" (tramp-login-program "ssh")
403 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
405 (tramp-remote-sh "/bin/sh")
406 (tramp-copy-program nil)
407 (tramp-copy-args nil)
408 (tramp-copy-keep-date nil)
409 (tramp-password-end-of-line nil)
410 (tramp-gw-args (("-o"
411 "GlobalKnownHostsFile=/dev/null")
412 ("-o" "UserKnownHostsFile=/dev/null")
413 ("-o" "StrictHostKeyChecking=no")))
414 (tramp-default-port 22))
416 (tramp-login-program "ssh1")
417 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
419 (tramp-remote-sh "/bin/sh")
420 (tramp-copy-program nil)
421 (tramp-copy-args nil)
422 (tramp-copy-keep-date nil)
423 (tramp-password-end-of-line nil))
425 (tramp-login-program "ssh2")
426 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
428 (tramp-remote-sh "/bin/sh")
429 (tramp-copy-program nil)
430 (tramp-copy-args nil)
431 (tramp-copy-keep-date nil)
432 (tramp-password-end-of-line nil))
433 ("remsh" (tramp-login-program "remsh")
434 (tramp-login-args (("%h") ("-l" "%u")))
435 (tramp-remote-sh "/bin/sh")
436 (tramp-copy-program nil)
437 (tramp-copy-args nil)
438 (tramp-copy-keep-date nil)
439 (tramp-password-end-of-line nil))
441 (tramp-login-program "telnet")
442 (tramp-login-args (("%h") ("%p")))
443 (tramp-remote-sh "/bin/sh")
444 (tramp-copy-program nil)
445 (tramp-copy-args nil)
446 (tramp-copy-keep-date nil)
447 (tramp-password-end-of-line nil)
448 (tramp-default-port 23))
449 ("su" (tramp-login-program "su")
450 (tramp-login-args (("-") ("%u")))
451 (tramp-remote-sh "/bin/sh")
452 (tramp-copy-program nil)
453 (tramp-copy-args nil)
454 (tramp-copy-keep-date nil)
455 (tramp-password-end-of-line nil))
456 ("sudo" (tramp-login-program "sudo")
457 (tramp-login-args (("-u" "%u")
458 ("-s") ("-H") ("-p" "Password:")))
459 (tramp-remote-sh "/bin/sh")
460 (tramp-copy-program nil)
461 (tramp-copy-args nil)
462 (tramp-copy-keep-date nil)
463 (tramp-password-end-of-line nil))
464 ("scpc" (tramp-login-program "ssh")
465 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
466 ("-o" "ControlPath=%t.%%r@%%h:%%p")
467 ("-o" "ControlMaster=yes")
469 (tramp-remote-sh "/bin/sh")
470 (tramp-copy-program "scp")
471 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q")
472 ("-o" "ControlPath=%t.%%r@%%h:%%p")
473 ("-o" "ControlMaster=auto")))
474 (tramp-copy-keep-date t)
475 (tramp-password-end-of-line nil)
476 (tramp-gw-args (("-o"
477 "GlobalKnownHostsFile=/dev/null")
478 ("-o" "UserKnownHostsFile=/dev/null")
479 ("-o" "StrictHostKeyChecking=no")))
480 (tramp-default-port 22))
481 ("scpx" (tramp-login-program "ssh")
482 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
483 ("-e" "none" "-t" "-t" "/bin/sh")))
484 (tramp-remote-sh "/bin/sh")
485 (tramp-copy-program "scp")
486 (tramp-copy-args (("-p" "%k")))
487 (tramp-copy-keep-date t)
488 (tramp-password-end-of-line nil)
489 (tramp-gw-args (("-o"
490 "GlobalKnownHostsFile=/dev/null")
491 ("-o" "UserKnownHostsFile=/dev/null")
492 ("-o" "StrictHostKeyChecking=no")))
493 (tramp-default-port 22))
494 ("sshx" (tramp-login-program "ssh")
495 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
496 ("-e" "none" "-t" "-t" "/bin/sh")))
497 (tramp-remote-sh "/bin/sh")
498 (tramp-copy-program nil)
499 (tramp-copy-args nil)
500 (tramp-copy-keep-date nil)
501 (tramp-password-end-of-line nil)
502 (tramp-gw-args (("-o"
503 "GlobalKnownHostsFile=/dev/null")
504 ("-o" "UserKnownHostsFile=/dev/null")
505 ("-o" "StrictHostKeyChecking=no")))
506 (tramp-default-port 22))
508 (tramp-login-program "krlogin")
509 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
510 (tramp-remote-sh "/bin/sh")
511 (tramp-copy-program nil)
512 (tramp-copy-args nil)
513 (tramp-copy-keep-date nil)
514 (tramp-password-end-of-line nil))
515 ("plink" (tramp-login-program "plink")
516 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
518 (tramp-remote-sh "/bin/sh")
519 (tramp-copy-program nil)
520 (tramp-copy-args nil)
521 (tramp-copy-keep-date nil)
522 (tramp-password-end-of-line "xy") ;see docstring for "xy"
523 (tramp-default-port 22))
525 (tramp-login-program "plink")
526 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
528 (tramp-remote-sh "/bin/sh")
529 (tramp-copy-program nil)
530 (tramp-copy-args nil)
531 (tramp-copy-keep-date nil)
532 (tramp-password-end-of-line "xy") ;see docstring for "xy"
533 (tramp-default-port 22))
535 (tramp-login-program "plink")
536 ;; ("%h") must be a single element, see
537 ;; `tramp-compute-multi-hops'.
538 (tramp-login-args (("-load") ("%h") ("-t")
540 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=$ '"
541 tramp-terminal-type))
543 (tramp-remote-sh "/bin/sh")
544 (tramp-copy-program nil)
545 (tramp-copy-args nil)
546 (tramp-copy-keep-date nil)
547 (tramp-password-end-of-line nil))
548 ("pscp" (tramp-login-program "plink")
549 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
551 (tramp-remote-sh "/bin/sh")
552 (tramp-copy-program "pscp")
553 (tramp-copy-args (("-P" "%p") ("-scp") ("-p" "%k")))
554 (tramp-copy-keep-date t)
555 (tramp-password-end-of-line "xy") ;see docstring for "xy"
556 (tramp-default-port 22))
557 ("psftp" (tramp-login-program "plink")
558 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
560 (tramp-remote-sh "/bin/sh")
561 (tramp-copy-program "pscp")
562 (tramp-copy-args (("-P" "%p") ("-sftp") ("-p" "%k")))
563 (tramp-copy-keep-date t)
564 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
565 ("fcp" (tramp-login-program "fsh")
566 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
567 (tramp-remote-sh "/bin/sh -i")
568 (tramp-copy-program "fcp")
569 (tramp-copy-args (("-p" "%k")))
570 (tramp-copy-keep-date t)
571 (tramp-password-end-of-line nil)))
572 "*Alist of methods for remote files.
573 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
574 Each NAME stands for a remote access method. Each PARAM is a
575 pair of the form (KEY VALUE). The following KEYs are defined:
577 This specifies the Bourne shell to use on the remote host. This
578 MUST be a Bourne-like shell. It is normally not necessary to set
579 this to any value other than \"/bin/sh\": Tramp wants to use a shell
580 which groks tilde expansion, but it can search for it. Also note
581 that \"/bin/sh\" exists on all Unixen, this might not be true for
582 the value that you decide to use. You Have Been Warned.
583 * `tramp-login-program'
584 This specifies the name of the program to use for logging in to the
585 remote host. This may be the name of rsh or a workalike program,
586 or the name of telnet or a workalike, or the name of su or a workalike.
588 This specifies the list of arguments to pass to the above
589 mentioned program. Please note that this is a list of list of arguments,
590 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
591 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
592 There are some patterns: \"%h\" in this list is replaced by the host
593 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
594 port number, and \"%%\" can be used to obtain a literal percent character.
595 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
596 expansion (i.e. no host or no user specified), this list is not used as
597 argument. By this, arguments like (\"-l\" \"%u\") are optional.
598 \"%t\" is replaced by the temporary file name produced with
599 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
600 parameter of a program, if exists.
601 * `tramp-copy-program'
602 This specifies the name of the program to use for remotely copying
603 the file; this might be the absolute filename of rcp or the name of
606 This specifies the list of parameters to pass to the above mentioned
607 program, the hints for `tramp-login-args' also apply here.
608 * `tramp-copy-keep-date'
609 This specifies whether the copying program when the preserves the
610 timestamp of the original file.
611 * `tramp-default-port'
612 The default port of a method is needed in case of gateway connections.
613 Additionally, it is used as indication which method is prepared for
616 As the attribute name says, additional arguments are specified here
617 when a method is applied via a gateway.
618 * `tramp-password-end-of-line'
619 This specifies the string to use for terminating the line after
620 submitting the password. If this method parameter is nil, then the
621 value of the normal variable `tramp-default-password-end-of-line'
622 is used. This parameter is necessary because the \"plink\" program
623 requires any two characters after sending the password. These do
624 not have to be newline or carriage return characters. Other login
625 programs are happy with just one character, the newline character.
626 We use \"xy\" as the value for methods using \"plink\".
628 What does all this mean? Well, you should specify `tramp-login-program'
629 for all methods; this program is used to log in to the remote site. Then,
630 there are two ways to actually transfer the files between the local and the
631 remote side. One way is using an additional rcp-like program. If you want
632 to do this, set `tramp-copy-program' in the method.
634 Another possibility for file transfer is inline transfer, i.e. the
635 file is passed through the same buffer used by `tramp-login-program'. In
636 this case, the file contents need to be protected since the
637 `tramp-login-program' might use escape codes or the connection might not
638 be eight-bit clean. Therefore, file contents are encoded for transit.
639 See the variables `tramp-local-coding-commands' and
640 `tramp-remote-coding-commands' for details.
642 So, to summarize: if the method is an out-of-band method, then you
643 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
644 inline method, then these two parameters should be nil. Methods which
645 are fit for gateways must have `tramp-default-port' at least.
649 When using `su' or `sudo' the phrase `open connection to a remote
650 host' sounds strange, but it is used nevertheless, for consistency.
651 No connection is opened to a remote host, but `su' or `sudo' is
652 started on the local host. You should specify a remote host
653 `localhost' or the name of the local host. Another host name is
654 useful only in combination with `tramp-default-proxies-alist'.")
656 (defcustom tramp-default-method
657 ;; An external copy method seems to be preferred, because it is much
658 ;; more performant for large files, and it hasn't too serious delays
659 ;; for small files. But it must be ensured that there aren't
660 ;; permanent password queries. Either a password agent like
661 ;; "ssh-agent" or "Pageant" shall run, or the optional password.el
662 ;; package shall be active for password caching. "scpc" would be
663 ;; another good choice because of the "ControlMaster" option, but
664 ;; this is a more modern alternative in OpenSSH 4, which cannot be
667 ;; PuTTY is installed.
668 ((executable-find "pscp")
669 (if (or (fboundp 'password-read)
670 ;; Pageant is running.
671 (and (fboundp 'w32-window-exists-p)
672 (funcall (symbol-function 'w32-window-exists-p)
673 "Pageant" "Pageant")))
676 ;; There is an ssh installation.
677 ((executable-find "scp")
678 (if (or (fboundp 'password-read)
679 ;; ssh-agent is running.
680 (getenv "SSH_AUTH_SOCK")
681 (getenv "SSH_AGENT_PID"))
686 "*Default method to use for transferring files.
687 See `tramp-methods' for possibilities.
688 Also see `tramp-default-method-alist'."
692 (defcustom tramp-default-method-alist
693 '(("\\`localhost\\'" "\\`root\\'" "su"))
694 "*Default method to use for specific host/user pairs.
695 This is an alist of items (HOST USER METHOD). The first matching item
696 specifies the method to use for a file name which does not specify a
697 method. HOST and USER are regular expressions or nil, which is
698 interpreted as a regular expression which always matches. If no entry
699 matches, the variable `tramp-default-method' takes effect.
701 If the file name does not specify the user, lookup is done using the
702 empty string for the user name.
704 See `tramp-methods' for a list of possibilities for METHOD."
706 :type '(repeat (list (regexp :tag "Host regexp")
707 (regexp :tag "User regexp")
708 (string :tag "Method"))))
710 (defcustom tramp-default-user
712 "*Default user to use for transferring files.
713 It is nil by default; otherwise settings in configuration files like
714 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
716 This variable is regarded as obsolete, and will be removed soon."
718 :type '(choice (const nil) string))
720 (defcustom tramp-default-user-alist
721 `(("\\`su\\(do\\)?\\'" nil "root")
722 ("\\`r\\(em\\)?\\(cp\\|sh\\)\\|telnet\\|plink1?\\'"
723 nil ,(user-login-name)))
724 "*Default user to use for specific method/host pairs.
725 This is an alist of items (METHOD HOST USER). The first matching item
726 specifies the user to use for a file name which does not specify a
727 user. METHOD and USER are regular expressions or nil, which is
728 interpreted as a regular expression which always matches. If no entry
729 matches, the variable `tramp-default-user' takes effect.
731 If the file name does not specify the method, lookup is done using the
732 empty string for the method name."
734 :type '(repeat (list (regexp :tag "Method regexp")
735 (regexp :tag "Host regexp")
736 (string :tag "User"))))
738 (defcustom tramp-default-host
740 "*Default host to use for transferring files.
741 Useful for su and sudo methods mostly."
745 (defcustom tramp-default-proxies-alist nil
746 "*Route to be followed for specific host/user pairs.
747 This is an alist of items (HOST USER PROXY). The first matching
748 item specifies the proxy to be passed for a file name located on
749 a remote target matching USER@HOST. HOST and USER are regular
750 expressions or nil, which is interpreted as a regular expression
751 which always matches. PROXY must be a Tramp filename without a
752 localname part. Method and user name on PROXY are optional,
753 which is interpreted with the default values. PROXY can contain
754 the patterns %h and %u, which are replaced by the strings
755 matching HOST or USER, respectively."
757 :type '(repeat (list (regexp :tag "Host regexp")
758 (regexp :tag "User regexp")
759 (string :tag "Proxy remote name"))))
761 (defconst tramp-local-host-regexp
763 "^" (regexp-opt (list "localhost" (system-name) "127\.0\.0\.1" "::1") t) "$")
764 "*Host names which are regarded as local host.")
766 (defconst tramp-completion-function-alist-rsh
767 '((tramp-parse-rhosts "/etc/hosts.equiv")
768 (tramp-parse-rhosts "~/.rhosts"))
769 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
771 (defconst tramp-completion-function-alist-ssh
772 '((tramp-parse-rhosts "/etc/hosts.equiv")
773 (tramp-parse-rhosts "/etc/shosts.equiv")
774 (tramp-parse-shosts "/etc/ssh_known_hosts")
775 (tramp-parse-sconfig "/etc/ssh_config")
776 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
777 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
778 (tramp-parse-rhosts "~/.rhosts")
779 (tramp-parse-rhosts "~/.shosts")
780 (tramp-parse-shosts "~/.ssh/known_hosts")
781 (tramp-parse-sconfig "~/.ssh/config")
782 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
783 (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
784 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
786 (defconst tramp-completion-function-alist-telnet
787 '((tramp-parse-hosts "/etc/hosts"))
788 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
790 (defconst tramp-completion-function-alist-su
791 '((tramp-parse-passwd "/etc/passwd"))
792 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
794 (defconst tramp-completion-function-alist-putty
796 "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"))
797 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty methods.")
799 (defvar tramp-completion-function-alist nil
800 "*Alist of methods for remote files.
801 This is a list of entries of the form (NAME PAIR1 PAIR2 ...).
802 Each NAME stands for a remote access method. Each PAIR is of the form
803 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
804 names from FILE for completion. The following predefined FUNCTIONs exists:
806 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
807 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
808 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
809 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
810 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
811 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
812 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
813 * `tramp-parse-netrc' for \"~/.netrc\" like files.
814 * `tramp-parse-putty' for PuTTY registry keys.
816 FUNCTION can also be a customer defined function. For more details see
819 (eval-after-load "tramp"
821 (tramp-set-completion-function
822 "rcp" tramp-completion-function-alist-rsh)
823 (tramp-set-completion-function
824 "scp" tramp-completion-function-alist-ssh)
825 (tramp-set-completion-function
826 "scp1" tramp-completion-function-alist-ssh)
827 (tramp-set-completion-function
828 "scp2" tramp-completion-function-alist-ssh)
829 (tramp-set-completion-function
830 "scp1_old" tramp-completion-function-alist-ssh)
831 (tramp-set-completion-function
832 "scp2_old" tramp-completion-function-alist-ssh)
833 (tramp-set-completion-function
834 "rsync" tramp-completion-function-alist-rsh)
835 (tramp-set-completion-function
836 "remcp" tramp-completion-function-alist-rsh)
837 (tramp-set-completion-function
838 "rsh" tramp-completion-function-alist-rsh)
839 (tramp-set-completion-function
840 "ssh" tramp-completion-function-alist-ssh)
841 (tramp-set-completion-function
842 "ssh1" tramp-completion-function-alist-ssh)
843 (tramp-set-completion-function
844 "ssh2" tramp-completion-function-alist-ssh)
845 (tramp-set-completion-function
846 "ssh1_old" tramp-completion-function-alist-ssh)
847 (tramp-set-completion-function
848 "ssh2_old" tramp-completion-function-alist-ssh)
849 (tramp-set-completion-function
850 "remsh" tramp-completion-function-alist-rsh)
851 (tramp-set-completion-function
852 "telnet" tramp-completion-function-alist-telnet)
853 (tramp-set-completion-function
854 "su" tramp-completion-function-alist-su)
855 (tramp-set-completion-function
856 "sudo" tramp-completion-function-alist-su)
857 (tramp-set-completion-function
858 "scpx" tramp-completion-function-alist-ssh)
859 (tramp-set-completion-function
860 "sshx" tramp-completion-function-alist-ssh)
861 (tramp-set-completion-function
862 "krlogin" tramp-completion-function-alist-rsh)
863 (tramp-set-completion-function
864 "plink" tramp-completion-function-alist-ssh)
865 (tramp-set-completion-function
866 "plink1" tramp-completion-function-alist-ssh)
867 (tramp-set-completion-function
868 "plinkx" tramp-completion-function-alist-putty)
869 (tramp-set-completion-function
870 "pscp" tramp-completion-function-alist-ssh)
871 (tramp-set-completion-function
872 "fcp" tramp-completion-function-alist-ssh)))
874 (defconst tramp-echo-mark-marker "_echo"
875 "String marker to surround echoed commands.")
877 (defconst tramp-echo-mark "_echo\b\b\b\b\b"
878 "String mark to be transmitted around shell commands.
879 Used to separate their echo from the output they produce. This
880 will only be used if we cannot disable remote echo via stty.
881 This string must have no effect on the remote shell except for
882 producing some echo which can later be detected by
883 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
884 followed by an equal number of backspaces to erase them will
887 (defconst tramp-echoed-echo-mark-regexp "_echo\\(\b\\( \b\\)?\\)\\{5\\}"
888 "Regexp which matches `tramp-echo-mark' as it gets echoed by
891 (defcustom tramp-rsh-end-of-line "\n"
892 "*String used for end of line in rsh connections.
893 I don't think this ever needs to be changed, so please tell me about it
894 if you need to change this.
895 Also see the method parameter `tramp-password-end-of-line' and the normal
896 variable `tramp-default-password-end-of-line'."
900 (defcustom tramp-default-password-end-of-line
901 tramp-rsh-end-of-line
902 "*String used for end of line after sending a password.
903 This variable provides the default value for the method parameter
904 `tramp-password-end-of-line', see `tramp-methods' for more details.
906 It seems that people using plink under Windows need to send
907 \"\\r\\n\" (carriage-return, then newline) after a password, but just
908 \"\\n\" after all other lines. This variable can be used for the
909 password, see `tramp-rsh-end-of-line' for the other cases.
911 The default value is to use the same value as `tramp-rsh-end-of-line'."
915 ;; "getconf PATH" yields:
916 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
917 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
918 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
919 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
920 (defcustom tramp-remote-path
921 '(tramp-default-remote-path "/usr/sbin" "/usr/local/bin"
922 "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
923 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin")
924 "*List of directories to search for executables on remote host.
925 For every remote host, this variable will be set buffer local,
926 keeping the list of existing directories on that host.
928 You can use `~' in this list, but when searching for a shell which groks
929 tilde expansion, all directory names starting with `~' will be ignored.
931 `Default Directories' represent the list of directories given by
932 the command \"getconf PATH\". It is recommended to use this
933 entry on top of this list, because these are the default
934 directories for POSIX compatible commands."
936 :type '(repeat (choice
937 (const :tag "Default Directories" tramp-default-remote-path)
938 (string :tag "Directory"))))
940 (defcustom tramp-remote-process-environment
941 `("HISTFILE=$HOME/.tramp_history" "HISTSIZE=1" "LC_ALL=C"
942 ,(concat "TERM=" tramp-terminal-type)
943 "EMACS=t" ;; Deprecated.
944 ,(format "INSIDE_EMACS=%s,tramp:%s" emacs-version tramp-version)
945 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH="
946 "autocorrect=" "correct=")
948 "*List of environment variables to be set on the remote host.
950 Each element should be a string of the form ENVVARNAME=VALUE. An
951 entry ENVVARNAME= diables the corresponding environment variable,
952 which might have been set in the init files like ~/.profile.
954 Special handling is applied to the PATH environment, which should
955 not be set here. Instead of, it should be set via `tramp-remote-path'."
957 :type '(repeat string))
959 (defcustom tramp-login-prompt-regexp
960 ".*ogin\\( .*\\)?: *"
961 "*Regexp matching login-like prompts.
962 The regexp should match at end of buffer.
964 Sometimes the prompt is reported to look like \"login as:\"."
968 (defcustom tramp-shell-prompt-pattern
969 "^[^#$%>\n]*[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*"
970 "Regexp to match prompts from remote shell.
971 Normally, Tramp expects you to configure `shell-prompt-pattern'
972 correctly, but sometimes it happens that you are connecting to a
973 remote host which sends a different kind of shell prompt. Therefore,
974 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
975 and also things matched by this variable. The default value of this
976 variable is similar to the default value of `shell-prompt-pattern',
977 which should work well in many cases."
981 (defcustom tramp-password-prompt-regexp
982 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
983 "*Regexp matching password-like prompts.
984 The regexp should match at end of buffer.
986 The `sudo' program appears to insert a `^@' character into the prompt."
990 (defcustom tramp-wrong-passwd-regexp
992 ;; These strings should be on the last line
993 (regexp-opt '("Permission denied"
999 "Name or service not known"
1000 "Host key verification failed."
1001 "No supported authentication methods left to try!"
1002 "Tramp connection closed") t)
1006 ;; Here comes a list of regexes, separated by \\|
1007 "Received signal [0-9]+"
1009 "*Regexp matching a `login failed' message.
1010 The regexp should match at end of buffer."
1014 (defcustom tramp-yesno-prompt-regexp
1016 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
1018 "Regular expression matching all yes/no queries which need to be confirmed.
1019 The confirmation should be done with yes or no.
1020 The regexp should match at end of buffer.
1021 See also `tramp-yn-prompt-regexp'."
1025 (defcustom tramp-yn-prompt-regexp
1027 (regexp-opt '("Store key in cache? (y/n)"
1028 "Update cached key? (y/n, Return cancels connection)") t)
1030 "Regular expression matching all y/n queries which need to be confirmed.
1031 The confirmation should be done with y or n.
1032 The regexp should match at end of buffer.
1033 See also `tramp-yesno-prompt-regexp'."
1037 (defcustom tramp-terminal-prompt-regexp
1041 "Terminal type\\? \\[.*\\]"
1043 "Regular expression matching all terminal setting prompts.
1044 The regexp should match at end of buffer.
1045 The answer will be provided by `tramp-action-terminal', which see."
1049 (defcustom tramp-operation-not-permitted-regexp
1050 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
1051 (regexp-opt '("Operation not permitted") t))
1052 "Regular expression matching keep-date problems in (s)cp operations.
1053 Copying has been performed successfully already, so this message can
1058 (defcustom tramp-copy-failed-regexp
1060 (regexp-opt '("Permission denied"
1061 "not a regular file"
1063 "No such file or directory") t)
1065 "Regular expression matching copy problems in (s)cp operations."
1069 (defcustom tramp-process-alive-regexp
1071 "Regular expression indicating a process has finished.
1072 In fact this expression is empty by intention, it will be used only to
1073 check regularly the status of the associated process.
1074 The answer will be provided by `tramp-action-process-alive',
1075 `tramp-action-out-of-band', which see."
1079 (defcustom tramp-temp-name-prefix "tramp."
1080 "*Prefix to use for temporary files.
1081 If this is a relative file name (such as \"tramp.\"), it is considered
1082 relative to the directory name returned by the function
1083 `tramp-compat-temporary-file-directory' (which see). It may also be an
1084 absolute file name; don't forget to include a prefix for the filename
1089 (defconst tramp-temp-buffer-name " *tramp temp*"
1090 "Buffer name for a temporary buffer.
1091 It shall be used in combination with `generate-new-buffer-name'.")
1093 (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
1094 "*Alist specifying extra arguments to pass to the remote shell.
1095 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
1096 matching the shell file name and ARGS is a string specifying the
1099 This variable is only used when Tramp needs to start up another shell
1100 for tilde expansion. The extra arguments should typically prevent the
1101 shell from reading its init file."
1103 ;; This might be the wrong way to test whether the widget type
1104 ;; `alist' is available. Who knows the right way to test it?
1105 :type (if (get 'alist 'widget-type)
1106 '(alist :key-type string :value-type string)
1107 '(repeat (cons string string))))
1109 ;; XEmacs is distributed with few Lisp packages. Further packages are
1110 ;; installed using EFS. If we use a unified filename format, then
1111 ;; Tramp is required in addition to EFS. (But why can't Tramp just
1112 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
1113 ;; just like before.) Another reason for using a separate filename
1114 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
1115 ;; Tramp only knows how to deal with `file-name-handler-alist', not
1116 ;; the other places.
1118 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
1120 (defcustom tramp-syntax
1121 (if (featurep 'xemacs) 'sep 'ftp)
1122 "Tramp filename syntax to be used.
1124 It can have the following values:
1126 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
1127 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
1128 'url -- URL-like syntax."
1130 :type (if (featurep 'xemacs)
1131 '(choice (const :tag "EFS" ftp)
1132 (const :tag "XEmacs" sep)
1133 (const :tag "URL" url))
1134 '(choice (const :tag "Ange-FTP" ftp)
1135 (const :tag "URL" url))))
1137 (defconst tramp-prefix-format
1138 (cond ((equal tramp-syntax 'ftp) "/")
1139 ((equal tramp-syntax 'sep) "/[")
1140 ((equal tramp-syntax 'url) "/")
1141 (t (error "Wrong `tramp-syntax' defined")))
1142 "*String matching the very beginning of Tramp file names.
1143 Used in `tramp-make-tramp-file-name'.")
1145 (defconst tramp-prefix-regexp
1146 (concat "^" (regexp-quote tramp-prefix-format))
1147 "*Regexp matching the very beginning of Tramp file names.
1148 Should always start with \"^\". Derived from `tramp-prefix-format'.")
1150 (defconst tramp-method-regexp
1152 "*Regexp matching methods identifiers.")
1154 (defconst tramp-postfix-method-format
1155 (cond ((equal tramp-syntax 'ftp) ":")
1156 ((equal tramp-syntax 'sep) "/")
1157 ((equal tramp-syntax 'url) "://")
1158 (t (error "Wrong `tramp-syntax' defined")))
1159 "*String matching delimeter between method and user or host names.
1160 Used in `tramp-make-tramp-file-name'.")
1162 (defconst tramp-postfix-method-regexp
1163 (regexp-quote tramp-postfix-method-format)
1164 "*Regexp matching delimeter between method and user or host names.
1165 Derived from `tramp-postfix-method-format'.")
1167 (defconst tramp-user-regexp
1169 "*Regexp matching user names.")
1171 (defconst tramp-prefix-domain-format "%"
1172 "*String matching delimeter between user and domain names.")
1174 (defconst tramp-prefix-domain-regexp
1175 (regexp-quote tramp-prefix-domain-format)
1176 "*Regexp matching delimeter between user and domain names.
1177 Derived from `tramp-prefix-domain-format'.")
1179 (defconst tramp-domain-regexp
1181 "*Regexp matching domain names.")
1183 (defconst tramp-user-with-domain-regexp
1184 (concat "\\(" tramp-user-regexp "\\)"
1185 tramp-prefix-domain-regexp
1186 "\\(" tramp-domain-regexp "\\)")
1187 "*Regexp matching user names with domain names.")
1189 (defconst tramp-postfix-user-format
1191 "*String matching delimeter between user and host names.
1192 Used in `tramp-make-tramp-file-name'.")
1194 (defconst tramp-postfix-user-regexp
1195 (regexp-quote tramp-postfix-user-format)
1196 "*Regexp matching delimeter between user and host names.
1197 Derived from `tramp-postfix-user-format'.")
1199 (defconst tramp-host-regexp
1201 "*Regexp matching host names.")
1203 (defconst tramp-prefix-ipv6-format
1204 (cond ((equal tramp-syntax 'ftp) "[")
1205 ((equal tramp-syntax 'sep) "")
1206 ((equal tramp-syntax 'url) "[")
1207 (t (error "Wrong `tramp-syntax' defined")))
1208 "*String matching left hand side of IPv6 addresses.
1209 Used in `tramp-make-tramp-file-name'.")
1211 (defconst tramp-prefix-ipv6-regexp
1212 (regexp-quote tramp-prefix-ipv6-format)
1213 "*Regexp matching left hand side of IPv6 addresses.
1214 Derived from `tramp-prefix-ipv6-format'.")
1216 ;; The following regexp is a bit sloppy. But it shall serve our purposes.
1217 (defconst tramp-ipv6-regexp
1218 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9]+"
1219 "*Regexp matching IPv6 addresses.")
1221 (defconst tramp-postfix-ipv6-format
1222 (cond ((equal tramp-syntax 'ftp) "]")
1223 ((equal tramp-syntax 'sep) "")
1224 ((equal tramp-syntax 'url) "]")
1225 (t (error "Wrong `tramp-syntax' defined")))
1226 "*String matching right hand side of IPv6 addresses.
1227 Used in `tramp-make-tramp-file-name'.")
1229 (defconst tramp-postfix-ipv6-regexp
1230 (regexp-quote tramp-postfix-ipv6-format)
1231 "*Regexp matching right hand side of IPv6 addresses.
1232 Derived from `tramp-postfix-ipv6-format'.")
1234 (defconst tramp-prefix-port-format
1235 (cond ((equal tramp-syntax 'ftp) "#")
1236 ((equal tramp-syntax 'sep) "#")
1237 ((equal tramp-syntax 'url) ":")
1238 (t (error "Wrong `tramp-syntax' defined")))
1239 "*String matching delimeter between host names and port numbers.")
1241 (defconst tramp-prefix-port-regexp
1242 (regexp-quote tramp-prefix-port-format)
1243 "*Regexp matching delimeter between host names and port numbers.
1244 Derived from `tramp-prefix-port-format'.")
1246 (defconst tramp-port-regexp
1248 "*Regexp matching port numbers.")
1250 (defconst tramp-host-with-port-regexp
1251 (concat "\\(" tramp-host-regexp "\\)"
1252 tramp-prefix-port-regexp
1253 "\\(" tramp-port-regexp "\\)")
1254 "*Regexp matching host names with port numbers.")
1256 (defconst tramp-postfix-host-format
1257 (cond ((equal tramp-syntax 'ftp) ":")
1258 ((equal tramp-syntax 'sep) "]")
1259 ((equal tramp-syntax 'url) "")
1260 (t (error "Wrong `tramp-syntax' defined")))
1261 "*String matching delimeter between host names and localnames.
1262 Used in `tramp-make-tramp-file-name'.")
1264 (defconst tramp-postfix-host-regexp
1265 (regexp-quote tramp-postfix-host-format)
1266 "*Regexp matching delimeter between host names and localnames.
1267 Derived from `tramp-postfix-host-format'.")
1269 (defconst tramp-localname-regexp
1271 "*Regexp matching localnames.")
1273 ;; File name format.
1275 (defconst tramp-file-name-structure
1279 "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
1280 "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
1281 "\\(" "\\(" tramp-host-regexp
1283 tramp-prefix-ipv6-regexp tramp-ipv6-regexp
1284 tramp-postfix-ipv6-regexp "\\)"
1285 "\\(" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?"
1286 tramp-postfix-host-regexp
1287 "\\(" tramp-localname-regexp "\\)")
1290 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
1291 the Tramp file name structure.
1293 The first element REGEXP is a regular expression matching a Tramp file
1294 name. The regex should contain parentheses around the method name,
1295 the user name, the host name, and the file name parts.
1297 The second element METHOD is a number, saying which pair of
1298 parentheses matches the method name. The third element USER is
1299 similar, but for the user name. The fourth element HOST is similar,
1300 but for the host name. The fifth element FILE is for the file name.
1301 These numbers are passed directly to `match-string', which see. That
1302 means the opening parentheses are counted to identify the pair.
1304 See also `tramp-file-name-regexp'.")
1307 (defconst tramp-file-name-regexp-unified
1308 "\\`/\\([^[/:]+\\|[^/]+]\\):"
1309 "Value for `tramp-file-name-regexp' for unified remoting.
1310 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1311 Tramp. See `tramp-file-name-structure' for more explanations.")
1314 (defconst tramp-file-name-regexp-separate
1316 "Value for `tramp-file-name-regexp' for separate remoting.
1317 XEmacs uses a separate filename syntax for Tramp and EFS.
1318 See `tramp-file-name-structure' for more explanations.")
1321 (defconst tramp-file-name-regexp-url
1323 "Value for `tramp-file-name-regexp' for URL-like remoting.
1324 See `tramp-file-name-structure' for more explanations.")
1327 (defconst tramp-file-name-regexp
1328 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
1329 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
1330 ((equal tramp-syntax 'url) tramp-file-name-regexp-url)
1331 (t (error "Wrong `tramp-syntax' defined")))
1332 "*Regular expression matching file names handled by Tramp.
1333 This regexp should match Tramp file names but no other file names.
1334 \(When tramp.el is loaded, this regular expression is prepended to
1335 `file-name-handler-alist', and that is searched sequentially. Thus,
1336 if the Tramp entry appears rather early in the `file-name-handler-alist'
1337 and is a bit too general, then some files might be considered Tramp
1338 files which are not really Tramp files.
1340 Please note that the entry in `file-name-handler-alist' is made when
1341 this file (tramp.el) is loaded. This means that this variable must be set
1342 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1343 updated after changing this variable.
1345 Also see `tramp-file-name-structure'.")
1348 (defconst tramp-root-regexp
1349 (if (memq system-type '(cygwin windows-nt))
1350 "^\\([a-zA-Z]:\\)?/"
1352 "Beginning of an incomplete Tramp file name.
1353 Usually, it is just \"^/\". On W32 systems, there might be a
1354 volume letter, which will be removed by `tramp-drop-volume-letter'.")
1357 (defconst tramp-completion-file-name-regexp-unified
1358 (concat tramp-root-regexp "[^/]*$")
1359 "Value for `tramp-completion-file-name-regexp' for unified remoting.
1360 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
1361 See `tramp-file-name-structure' for more explanations.")
1364 (defconst tramp-completion-file-name-regexp-separate
1365 (concat tramp-root-regexp "\\([[][^]]*\\)?$")
1366 "Value for `tramp-completion-file-name-regexp' for separate remoting.
1367 XEmacs uses a separate filename syntax for Tramp and EFS.
1368 See `tramp-file-name-structure' for more explanations.")
1371 (defconst tramp-completion-file-name-regexp-url
1372 (concat tramp-root-regexp "[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?$")
1373 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
1374 See `tramp-file-name-structure' for more explanations.")
1377 (defconst tramp-completion-file-name-regexp
1378 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
1379 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
1380 ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url)
1381 (t (error "Wrong `tramp-syntax' defined")))
1382 "*Regular expression matching file names handled by Tramp completion.
1383 This regexp should match partial Tramp file names only.
1385 Please note that the entry in `file-name-handler-alist' is made when
1386 this file (tramp.el) is loaded. This means that this variable must be set
1387 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1388 updated after changing this variable.
1390 Also see `tramp-file-name-structure'.")
1392 (defconst tramp-actions-before-shell
1393 '((tramp-login-prompt-regexp tramp-action-login)
1394 (tramp-password-prompt-regexp tramp-action-password)
1395 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1396 (shell-prompt-pattern tramp-action-succeed)
1397 (tramp-shell-prompt-pattern tramp-action-succeed)
1398 (tramp-yesno-prompt-regexp tramp-action-yesno)
1399 (tramp-yn-prompt-regexp tramp-action-yn)
1400 (tramp-terminal-prompt-regexp tramp-action-terminal)
1401 (tramp-process-alive-regexp tramp-action-process-alive))
1402 "List of pattern/action pairs.
1403 Whenever a pattern matches, the corresponding action is performed.
1404 Each item looks like (PATTERN ACTION).
1406 The PATTERN should be a symbol, a variable. The value of this
1407 variable gives the regular expression to search for. Note that the
1408 regexp must match at the end of the buffer, \"\\'\" is implicitly
1411 The ACTION should also be a symbol, but a function. When the
1412 corresponding PATTERN matches, the ACTION function is called.")
1414 (defconst tramp-actions-copy-out-of-band
1415 '((tramp-password-prompt-regexp tramp-action-password)
1416 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1417 (tramp-copy-failed-regexp tramp-action-permission-denied)
1418 (tramp-process-alive-regexp tramp-action-out-of-band))
1419 "List of pattern/action pairs.
1420 This list is used for copying/renaming with out-of-band methods.
1422 See `tramp-actions-before-shell' for more info.")
1424 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
1425 ;; known to have a bug in `process-send-string'; some ssh connections appear
1426 ;; to drop bytes when data is sent too quickly. There is also a connection
1427 ;; buffer local variable, which is computed depending on remote host properties
1428 ;; when `tramp-chunksize' is zero or nil.
1429 (defcustom tramp-chunksize
1430 (when (and (not (featurep 'xemacs))
1431 (memq system-type '(hpux)))
1433 ;; Parentheses in docstring starting at beginning of line are escaped.
1434 ;; Fontification is messed up when
1435 ;; `open-paren-in-column-0-is-defun-start' set to t.
1436 "*If non-nil, chunksize for sending input to local process.
1437 It is necessary only on systems which have a buggy `process-send-string'
1438 implementation. The necessity, whether this variable must be set, can be
1439 checked via the following code:
1442 (let* ((user \"xxx\") (host \"yyy\")
1444 (sent init) (received init))
1445 (while (= sent received)
1446 (setq sent (+ sent step))
1448 (let ((proc (start-process (buffer-name) (current-buffer)
1449 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
1450 (when (memq (process-status proc) '(run open))
1451 (process-send-string proc (make-string sent ?\\ ))
1452 (process-send-eof proc)
1453 (process-send-eof proc))
1454 (while (not (progn (goto-char (point-min))
1455 (re-search-forward \"\\\\w+\" (point-max) t)))
1456 (accept-process-output proc 1))
1457 (when (memq (process-status proc) '(run open))
1458 (setq received (string-to-number (match-string 0)))
1459 (delete-process proc)
1460 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1462 (if (> sent (+ init step))
1463 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1465 (message \"Test does not work\")
1466 (display-buffer (current-buffer))
1469 In the Emacs normally running Tramp, evaluate the above code
1470 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1471 respectively). You can do this, for example, by pasting it into
1472 the `*scratch*' buffer and then hitting C-j with the cursor after the
1473 last closing parenthesis. Note that it works only if you have configured
1474 \"ssh\" to run without password query, see ssh-agent(1).
1476 You will see the number of bytes sent successfully to the remote host.
1477 If that number exceeds 1000, you can stop the execution by hitting
1478 C-g, because your Emacs is likely clean.
1480 When it is necessary to set `tramp-chunksize', you might consider to
1481 use an out-of-the-band method (like \"scp\") instead of an internal one
1482 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
1485 If your Emacs is buggy, the code stops and gives you an indication
1486 about the value `tramp-chunksize' should be set. Maybe you could just
1487 experiment a bit, e.g. changing the values of `init' and `step'
1488 in the third line of the code.
1490 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1491 this variable to be set as well."
1493 :type '(choice (const nil) integer))
1495 ;; Logging in to a remote host normally requires obtaining a pty. But
1496 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1497 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1498 ;; for an override of the system default.
1499 (defcustom tramp-process-connection-type t
1500 "Overrides `process-connection-type' for connections from Tramp.
1501 Tramp binds process-connection-type to the value given here before
1502 opening a connection to a remote host."
1504 :type '(choice (const nil) (const t) (const pty)))
1506 (defcustom tramp-completion-reread-directory-timeout 10
1507 "Defines seconds since last remote command before rereading a directory.
1508 A remote directory might have changed its contents. In order to
1509 make it visible during file name completion in the minibuffer,
1510 Tramp flushes its cache and rereads the directory contents when
1511 more than `tramp-completion-reread-directory-timeout' seconds
1512 have been gone since last remote command execution. A value of 0
1513 would require an immediate reread during filename completion, nil
1514 means to use always cached values for the directory contents."
1516 :type '(choice (const nil) integer))
1518 ;;; Internal Variables:
1520 (defvar tramp-end-of-output
1523 tramp-rsh-end-of-line
1524 (md5 (concat (prin1-to-string process-environment) (current-time-string)))
1525 tramp-rsh-end-of-line)
1526 "String used to recognize end of output.")
1528 (defvar tramp-current-method nil
1529 "Connection method for this *tramp* buffer.")
1531 (defvar tramp-current-user nil
1532 "Remote login name for this *tramp* buffer.")
1534 (defvar tramp-current-host nil
1535 "Remote host for this *tramp* buffer.")
1537 (defconst tramp-uudecode
1538 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
1540 rm -f /tmp/tramp.$$"
1541 "Shell function to implement `uudecode' to standard output.
1542 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
1543 for this or `uudecode -p', but some systems don't, and for them
1544 we have this shell function.")
1546 ;; Perl script to implement `file-attributes' in a Lisp `read'able
1547 ;; output. If you are hacking on this, note that you get *no* output
1548 ;; unless this spits out a complete line, including the '\n' at the
1550 ;; The device number is returned as "-1", because there will be a virtual
1551 ;; device number set in `tramp-handle-file-attributes'.
1552 (defconst tramp-perl-file-attributes
1554 @stat = lstat($ARGV[0]);
1555 if (($stat[2] & 0170000) == 0120000)
1557 $type = readlink($ARGV[0]);
1558 $type = \"\\\"$type\\\"\";
1560 elsif (($stat[2] & 0170000) == 040000)
1568 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1569 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1571 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
1576 $stat[8] >> 16 & 0xffff,
1578 $stat[9] >> 16 & 0xffff,
1580 $stat[10] >> 16 & 0xffff,
1584 $stat[1] >> 16 & 0xffff,
1586 );' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1587 "Perl script to produce output suitable for use with `file-attributes'
1588 on the remote file system.
1589 Escape sequence %s is replaced with name of Perl binary.
1590 This string is passed to `format', so percent characters need to be doubled.")
1592 (defconst tramp-perl-directory-files-and-attributes
1594 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
1595 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
1596 @list = readdir(DIR);
1600 for($i = 0; $i < $n; $i++)
1602 $filename = $list[$i];
1603 @stat = lstat($filename);
1604 if (($stat[2] & 0170000) == 0120000)
1606 $type = readlink($filename);
1607 $type = \"\\\"$type\\\"\";
1609 elsif (($stat[2] & 0170000) == 040000)
1617 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1618 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1620 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
1626 $stat[8] >> 16 & 0xffff,
1628 $stat[9] >> 16 & 0xffff,
1630 $stat[10] >> 16 & 0xffff,
1634 $stat[1] >> 16 & 0xffff,
1636 $stat[0] >> 16 & 0xffff,
1639 printf(\")\\n\");' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1640 "Perl script implementing `directory-files-attributes' as Lisp `read'able
1642 Escape sequence %s is replaced with name of Perl binary.
1643 This string is passed to `format', so percent characters need to be doubled.")
1645 ;; ;; These two use uu encoding.
1646 ;; (defvar tramp-perl-encode "%s -e'\
1647 ;; print qq(begin 644 xxx\n);
1650 ;; while (read(STDIN, $s, 45)) {
1651 ;; print pack(q(u), $s);
1656 ;; "Perl program to use for encoding a file.
1657 ;; Escape sequence %s is replaced with name of Perl binary.")
1659 ;; (defvar tramp-perl-decode "%s -ne '
1660 ;; print unpack q(u), $_;
1662 ;; "Perl program to use for decoding a file.
1663 ;; Escape sequence %s is replaced with name of Perl binary.")
1665 ;; These two use base64 encoding.
1666 (defconst tramp-perl-encode-with-module
1667 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
1668 "Perl program to use for encoding a file.
1669 Escape sequence %s is replaced with name of Perl binary.
1670 This string is passed to `format', so percent characters need to be doubled.
1671 This implementation requires the MIME::Base64 Perl module to be installed
1672 on the remote host.")
1674 (defconst tramp-perl-decode-with-module
1675 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
1676 "Perl program to use for decoding a file.
1677 Escape sequence %s is replaced with name of Perl binary.
1678 This string is passed to `format', so percent characters need to be doubled.
1679 This implementation requires the MIME::Base64 Perl module to be installed
1680 on the remote host.")
1682 (defconst tramp-perl-encode
1684 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1685 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
1686 # Free Software Foundation, Inc.
1691 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
1692 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
1697 # We read in chunks of 54 bytes, to generate output lines
1698 # of 72 chars (plus end of line)
1701 while (my $data = <STDIN>) {
1704 # Only for the last chunk, and only if did not fill the last three-byte packet
1706 my $mod = length($data) %% 3;
1707 $pad = q(=) x (3 - $mod) if $mod;
1710 # Not the fastest method, but it is simple: unpack to binary string, split
1711 # by groups of 6 bits and convert back from binary to byte; then map into
1712 # the translation table
1716 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
1720 "Perl program to use for encoding a file.
1721 Escape sequence %s is replaced with name of Perl binary.
1722 This string is passed to `format', so percent characters need to be doubled.")
1724 (defconst tramp-perl-decode
1726 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1727 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
1728 # Free Software Foundation, Inc.
1733 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
1734 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
1737 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
1741 # We are going to accumulate into $pending to accept any line length
1742 # (we do not check they are <= 76 chars as the RFC says)
1745 while (my $data = <STDIN>) {
1748 # If we find one or two =, we have reached the end and
1749 # any following data is to be discarded
1750 my $finished = $data =~ s/(==?).*/$1/;
1753 my $len = length($pending);
1754 my $chunk = substr($pending, 0, $len & ~3);
1755 $pending = substr($pending, $len & ~3 + 1);
1757 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
1758 # split in 8-bit chunks and convert back to char.
1761 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
1765 "Perl program to use for decoding a file.
1766 Escape sequence %s is replaced with name of Perl binary.
1767 This string is passed to `format', so percent characters need to be doubled.")
1769 (defconst tramp-file-mode-type-map
1770 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
1772 (2 . "c") ; character device
1773 (3 . "m") ; multiplexed character device (v7)
1774 (4 . "d") ; directory
1775 (5 . "?") ; Named special file (XENIX)
1776 (6 . "b") ; block device
1777 (7 . "?") ; multiplexed block device (v7)
1778 (8 . "-") ; regular file
1779 (9 . "n") ; network special file (HP-UX)
1780 (10 . "l") ; symlink
1781 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
1783 (13 . "D") ; door special (Solaris)
1784 (14 . "w")) ; whiteout (BSD)
1785 "A list of file types returned from the `stat' system call.
1786 This is used to map a mode number to a permission string.")
1788 ;; New handlers should be added here. The following operations can be
1789 ;; handled using the normal primitives: file-name-sans-versions,
1791 (defconst tramp-file-name-handler-alist
1792 '((load . tramp-handle-load)
1793 (make-symbolic-link . tramp-handle-make-symbolic-link)
1794 (file-name-as-directory . tramp-handle-file-name-as-directory)
1795 (file-name-directory . tramp-handle-file-name-directory)
1796 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
1797 (file-truename . tramp-handle-file-truename)
1798 (file-exists-p . tramp-handle-file-exists-p)
1799 (file-directory-p . tramp-handle-file-directory-p)
1800 (file-executable-p . tramp-handle-file-executable-p)
1801 (file-readable-p . tramp-handle-file-readable-p)
1802 (file-regular-p . tramp-handle-file-regular-p)
1803 (file-symlink-p . tramp-handle-file-symlink-p)
1804 (file-writable-p . tramp-handle-file-writable-p)
1805 (file-ownership-preserved-p . tramp-handle-file-ownership-preserved-p)
1806 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
1807 (file-attributes . tramp-handle-file-attributes)
1808 (file-modes . tramp-handle-file-modes)
1809 (directory-files . tramp-handle-directory-files)
1810 (directory-files-and-attributes . tramp-handle-directory-files-and-attributes)
1811 (file-name-all-completions . tramp-handle-file-name-all-completions)
1812 (file-name-completion . tramp-handle-file-name-completion)
1813 (add-name-to-file . tramp-handle-add-name-to-file)
1814 (copy-file . tramp-handle-copy-file)
1815 (rename-file . tramp-handle-rename-file)
1816 (set-file-modes . tramp-handle-set-file-modes)
1817 (set-file-times . tramp-handle-set-file-times)
1818 (make-directory . tramp-handle-make-directory)
1819 (delete-directory . tramp-handle-delete-directory)
1820 (delete-file . tramp-handle-delete-file)
1821 (directory-file-name . tramp-handle-directory-file-name)
1822 ;; `executable-find' is not official yet.
1823 (executable-find . tramp-handle-executable-find)
1824 (start-file-process . tramp-handle-start-file-process)
1825 (process-file . tramp-handle-process-file)
1826 (shell-command . tramp-handle-shell-command)
1827 (insert-directory . tramp-handle-insert-directory)
1828 (expand-file-name . tramp-handle-expand-file-name)
1829 (substitute-in-file-name . tramp-handle-substitute-in-file-name)
1830 (file-local-copy . tramp-handle-file-local-copy)
1831 (file-remote-p . tramp-handle-file-remote-p)
1832 (insert-file-contents . tramp-handle-insert-file-contents)
1833 (insert-file-contents-literally
1834 . tramp-handle-insert-file-contents-literally)
1835 (write-region . tramp-handle-write-region)
1836 (find-backup-file-name . tramp-handle-find-backup-file-name)
1837 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
1838 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
1839 (dired-compress-file . tramp-handle-dired-compress-file)
1840 (dired-recursive-delete-directory
1841 . tramp-handle-dired-recursive-delete-directory)
1842 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
1843 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime))
1844 "Alist of handler functions.
1845 Operations not mentioned here will be handled by the normal Emacs functions.")
1847 ;; Handlers for partial Tramp file names. For Emacs just
1848 ;; `file-name-all-completions' is needed.
1850 (defconst tramp-completion-file-name-handler-alist
1851 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1852 (file-name-completion . tramp-completion-handle-file-name-completion))
1853 "Alist of completion handler functions.
1854 Used for file names matching `tramp-file-name-regexp'. Operations not
1855 mentioned here will be handled by `tramp-file-name-handler-alist' or the
1856 normal Emacs functions.")
1858 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1859 (defvar tramp-foreign-file-name-handler-alist
1860 ;; (identity . tramp-sh-file-name-handler) should always be the last
1861 ;; entry, since `identity' always matches.
1862 '((identity . tramp-sh-file-name-handler))
1863 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1864 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1867 ;;; Internal functions which must come first:
1869 (defsubst tramp-debug-message (vec fmt-string &rest args)
1870 "Append message to debug buffer.
1871 Message is formatted with FMT-STRING as control string and the remaining
1872 ARGS to actually emit the message (if applicable)."
1873 (when (get-buffer (tramp-buffer-name vec))
1874 (with-current-buffer (tramp-get-debug-buffer vec)
1875 (goto-char (point-max))
1879 (insert (format-time-string "%T "))
1881 (let ((btn 1) btf fn)
1883 (setq btf (nth 1 (backtrace-frame btn)))
1887 (setq fn (symbol-name btf))
1888 (unless (and (string-match "^tramp" fn)
1890 "^tramp\\(-debug\\)?\\(-message\\|-error\\)$"
1893 (setq btn (1+ btn))))
1894 ;; The following code inserts filename and line number.
1895 ;; Should be deactivated by default, because it is time
1897 ; (let ((ffn (find-function-noselect (intern fn))))
1901 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1902 ; (with-current-buffer (car ffn)
1903 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1904 (insert (format "%s " fn)))
1906 (insert (apply 'format fmt-string args)))))
1908 (defsubst tramp-message (vec-or-proc level fmt-string &rest args)
1909 "Emit a message depending on verbosity level.
1910 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
1911 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
1912 less than LEVEL. The message is emitted only if `tramp-verbose' is
1913 greater than or equal to LEVEL.
1915 The message is also logged into the debug buffer when `tramp-verbose'
1916 is greater than or equal 4.
1918 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
1919 control string and the remaining ARGS to actually emit the message (if
1922 (when (<= level tramp-verbose)
1923 ;; Match data must be preserved!
1925 ;; Display only when there is a minimum level.
1932 ((= level 2) "Warning: ")
1936 ;; Log only when there is a minimum level.
1937 (when (>= tramp-verbose 4)
1938 (when (and vec-or-proc
1939 (processp vec-or-proc)
1940 (buffer-name (process-buffer vec-or-proc)))
1941 (with-current-buffer (process-buffer vec-or-proc)
1942 ;; Translate proc to vec.
1943 (setq vec-or-proc (tramp-dissect-file-name default-directory))))
1944 (when (and vec-or-proc (vectorp vec-or-proc))
1945 (apply 'tramp-debug-message
1947 (concat (format "(%d) # " level) fmt-string)
1949 ;; Suppress all errors.
1952 (defsubst tramp-error (vec-or-proc signal fmt-string &rest args)
1954 VEC-OR-PROC identifies the connection to use, SIGNAL is the
1955 signal identifier to be raised, remaining args passed to
1956 `tramp-message'. Finally, signal SIGNAL is raised."
1959 (error-message-string
1960 (list signal (get signal 'error-message) (apply 'format fmt-string args))))
1961 (signal signal (list (apply 'format fmt-string args))))
1963 (defsubst tramp-error-with-buffer
1964 (buffer vec-or-proc signal fmt-string &rest args)
1965 "Emit an error, and show BUFFER.
1966 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
1967 an input event arrives. The other arguments are passed to `tramp-error'."
1968 (save-window-excursion
1970 (apply 'tramp-error vec-or-proc signal fmt-string args)
1971 (when (and vec-or-proc (not (zerop tramp-verbose)))
1972 (let ((enable-recursive-minibuffers t))
1974 (or (and (bufferp buffer) buffer)
1975 (and (processp vec-or-proc) (process-buffer vec-or-proc))
1976 (tramp-get-buffer vec-or-proc)))
1979 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1980 "Parse a Tramp filename and make components available in the body.
1982 First arg FILENAME is evaluated and dissected into its components.
1983 Second arg VAR is a symbol. It is used as a variable name to hold
1984 the filename structure. It is also used as a prefix for the variables
1985 holding the components. For example, if VAR is the symbol `foo', then
1986 `foo' will be bound to the whole structure, `foo-method' will be bound to
1987 the method component, and so on for `foo-user', `foo-host', `foo-localname'.
1989 Remaining args are Lisp expressions to be evaluated (inside an implicit
1992 If VAR is nil, then we bind `v' to the structure and `method', `user',
1993 `host', `localname' to the components."
1994 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
1995 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
1996 (tramp-file-name-method ,(or var 'v)))
1997 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
1998 (tramp-file-name-user ,(or var 'v)))
1999 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
2000 (tramp-file-name-host ,(or var 'v)))
2001 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
2002 (tramp-file-name-localname ,(or var 'v))))
2005 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
2006 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
2007 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
2009 (defmacro with-file-property (vec file property &rest body)
2010 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
2011 FILE must be a local file name on a connection identified via VEC."
2012 `(if (file-name-absolute-p ,file)
2013 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
2014 (when (eq value 'undef)
2015 ;; We cannot pass @body as parameter to
2016 ;; `tramp-set-file-property' because it mangles our
2018 (setq value (progn ,@body))
2019 (tramp-set-file-property ,vec ,file ,property value))
2023 (put 'with-file-property 'lisp-indent-function 3)
2024 (put 'with-file-property 'edebug-form-spec t)
2025 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-file-property\\>"))
2027 (defmacro with-connection-property (key property &rest body)
2028 "Checks in Tramp for property PROPERTY, otherwise executes BODY and set."
2029 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
2030 (when (eq value 'undef)
2031 ;; We cannot pass ,@body as parameter to
2032 ;; `tramp-set-connection-property' because it mangles our debug
2034 (setq value (progn ,@body))
2035 (tramp-set-connection-property ,key ,property value))
2038 (put 'with-connection-property 'lisp-indent-function 2)
2039 (put 'with-connection-property 'edebug-form-spec t)
2040 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-connection-property\\>"))
2042 (eval-and-compile ; silence compiler
2043 (if (memq system-type '(cygwin windows-nt))
2044 (defun tramp-drop-volume-letter (name)
2045 "Cut off unnecessary drive letter from file NAME.
2046 The function `tramp-handle-expand-file-name' calls `expand-file-name'
2047 locally on a remote file name. When the local system is a W32 system
2048 but the remote system is Unix, this introduces a superfluous drive
2049 letter into the file name. This function removes it."
2051 (if (string-match tramp-root-regexp name)
2052 (replace-match "/" nil t name)
2055 (defalias 'tramp-drop-volume-letter 'identity)))
2057 (defsubst tramp-make-tramp-temp-file (vec)
2058 "Create a temporary file on the remote host identified by VEC.
2059 Return the local name of the temporary file."
2061 (tramp-make-tramp-file-name
2062 (tramp-file-name-method vec)
2063 (tramp-file-name-user vec)
2064 (tramp-file-name-host vec)
2065 (tramp-drop-volume-letter
2067 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))))
2070 ;; `make-temp-file' would be the natural choice for
2071 ;; implementation. But it calls `write-region' internally,
2072 ;; which also needs a temporary file - we would end in an
2074 (setq result (make-temp-name prefix))
2075 (if (file-exists-p result)
2077 ;; This creates the file by side effect.
2078 (set-file-times result)
2079 (set-file-modes result (tramp-octal-to-decimal "0700"))))
2081 ;; Return the local part.
2082 (with-parsed-tramp-file-name result nil localname)))
2085 ;;; Config Manipulation Functions:
2087 (defun tramp-set-completion-function (method function-list)
2088 "Sets the list of completion functions for METHOD.
2089 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
2090 The FUNCTION is intended to parse FILE according its syntax.
2091 It might be a predefined FUNCTION, or a user defined FUNCTION.
2092 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
2093 `tramp-parse-sconfig', `tramp-parse-hosts', `tramp-parse-passwd',
2094 and `tramp-parse-netrc'.
2098 (tramp-set-completion-function
2100 '((tramp-parse-sconfig \"/etc/ssh_config\")
2101 (tramp-parse-sconfig \"~/.ssh/config\")))"
2103 (let ((r function-list)
2105 (setq tramp-completion-function-alist
2106 (delete (assoc method tramp-completion-function-alist)
2107 tramp-completion-function-alist))
2110 ;; Remove double entries.
2111 (when (member (car v) (cdr v))
2112 (setcdr v (delete (car v) (cdr v))))
2113 ;; Check for function and file or registry key.
2114 (unless (and (functionp (nth 0 (car v)))
2115 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
2116 ;; Windows registry.
2117 (and (memq system-type '(cygwin windows-nt))
2119 (tramp-local-call-process
2120 "reg" nil nil nil "query" (nth 1 (car v)))))
2121 ;; Configuration file.
2122 (file-exists-p (nth 1 (car v)))))
2123 (setq r (delete (car v) r)))
2127 (add-to-list 'tramp-completion-function-alist
2130 (defun tramp-get-completion-function (method)
2131 "Returns a list of completion functions for METHOD.
2132 For definition of that list see `tramp-set-completion-function'."
2134 ;; Hosts visited once shall be remembered.
2135 `(tramp-parse-connection-properties ,method)
2136 ;; The method related defaults.
2137 (cdr (assoc method tramp-completion-function-alist))))
2140 ;;; Fontification of `read-file-name':
2142 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
2143 (defvar tramp-rfn-eshadow-overlay)
2144 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
2146 (defun tramp-rfn-eshadow-setup-minibuffer ()
2147 "Set up a minibuffer for `file-name-shadow-mode'.
2148 Adds another overlay hiding filename parts according to Tramp's
2149 special handling of `substitute-in-file-name'."
2150 (when (symbol-value 'minibuffer-completing-file-name)
2151 (setq tramp-rfn-eshadow-overlay
2152 (funcall (symbol-function 'make-overlay)
2153 (funcall (symbol-function 'minibuffer-prompt-end))
2154 (funcall (symbol-function 'minibuffer-prompt-end))))
2155 ;; Copy rfn-eshadow-overlay properties.
2156 (let ((props (funcall (symbol-function 'overlay-properties)
2157 (symbol-value 'rfn-eshadow-overlay))))
2159 (funcall (symbol-function 'overlay-put)
2160 tramp-rfn-eshadow-overlay (pop props) (pop props))))))
2162 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
2163 (add-hook 'rfn-eshadow-setup-minibuffer-hook
2164 'tramp-rfn-eshadow-setup-minibuffer)
2165 (add-hook 'tramp-unload-hook
2167 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
2168 'tramp-rfn-eshadow-setup-minibuffer))))
2170 (defun tramp-rfn-eshadow-update-overlay ()
2171 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
2172 This is intended to be used as a minibuffer `post-command-hook' for
2173 `file-name-shadow-mode'; the minibuffer should have already
2174 been set up by `rfn-eshadow-setup-minibuffer'."
2175 ;; In remote files name, there is a shadowing just for the local part.
2176 (let ((end (or (funcall (symbol-function 'overlay-end)
2177 (symbol-value 'rfn-eshadow-overlay))
2178 (funcall (symbol-function 'minibuffer-prompt-end)))))
2179 (when (file-remote-p (buffer-substring-no-properties end (point-max)))
2183 (1+ (or (string-match "/" (buffer-string) end) end)) (point-max))
2184 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
2185 (rfn-eshadow-update-overlay-hook nil))
2186 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
2187 (funcall (symbol-function 'rfn-eshadow-update-overlay))))))))
2189 (when (boundp 'rfn-eshadow-update-overlay-hook)
2190 (add-hook 'rfn-eshadow-update-overlay-hook
2191 'tramp-rfn-eshadow-update-overlay))
2194 ;;; File Name Handler Functions:
2196 (defun tramp-handle-make-symbolic-link
2197 (filename linkname &optional ok-if-already-exists)
2198 "Like `make-symbolic-link' for Tramp files.
2199 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
2200 the symlink. If LINKNAME is a Tramp file, only the localname component is
2201 used as the target of the symlink.
2203 If LINKNAME is a Tramp file and the localname component is relative, then
2204 it is expanded first, before the localname component is taken. Note that
2205 this can give surprising results if the user/host for the source and
2206 target of the symlink differ."
2207 (with-parsed-tramp-file-name linkname l
2208 (let ((ln (tramp-get-remote-ln l))
2209 (cwd (tramp-run-real-handler
2210 'file-name-directory (list l-localname))))
2214 "Making a symbolic link. ln(1) does not exist on the remote host."))
2216 ;; Do the 'confirm if exists' thing.
2217 (when (file-exists-p linkname)
2219 (if (or (null ok-if-already-exists) ; not allowed to exist
2220 (and (numberp ok-if-already-exists)
2223 "File %s already exists; make it a link anyway? "
2226 l 'file-already-exists "File %s already exists" l-localname)
2227 (delete-file linkname)))
2229 ;; If FILENAME is a Tramp name, use just the localname component.
2230 (when (tramp-tramp-file-p filename)
2232 (tramp-file-name-localname
2233 (tramp-dissect-file-name (expand-file-name filename)))))
2235 ;; Right, they are on the same host, regardless of user, method, etc.
2236 ;; We now make the link on the remote machine. This will occur as the user
2237 ;; that FILENAME belongs to.
2239 (tramp-send-command-and-check
2240 l (format "cd %s && %s -sf %s %s" cwd ln filename l-localname) t)))))
2242 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
2243 "Like `load' for Tramp files."
2244 (with-parsed-tramp-file-name (expand-file-name file) nil
2246 (cond ((file-exists-p (concat file ".elc"))
2247 (setq file (concat file ".elc")))
2248 ((file-exists-p (concat file ".el"))
2249 (setq file (concat file ".el")))))
2251 ;; The first condition is always true for absolute file names.
2252 ;; Included for safety's sake.
2253 (unless (or (file-name-directory file)
2254 (string-match "\\.elc?\\'" file))
2257 "File `%s' does not include a `.el' or `.elc' suffix" file)))
2259 (when (not (file-exists-p file))
2260 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
2261 (if (not (file-exists-p file))
2263 (unless nomessage (tramp-message v 0 "Loading %s..." file))
2264 (let ((local-copy (file-local-copy file)))
2265 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2267 (load local-copy noerror t t)
2268 (delete-file local-copy)))
2269 (unless nomessage (tramp-message v 0 "Loading %s...done" file))
2272 ;; Localname manipulation functions that grok Tramp localnames...
2273 (defun tramp-handle-file-name-as-directory (file)
2274 "Like `file-name-as-directory' but aware of Tramp files."
2275 ;; `file-name-as-directory' would be sufficient except localname is
2276 ;; the empty string.
2277 (let ((v (tramp-dissect-file-name file t)))
2278 ;; Run the command on the localname portion only.
2279 (tramp-make-tramp-file-name
2280 (tramp-file-name-method v)
2281 (tramp-file-name-user v)
2282 (tramp-file-name-host v)
2283 (tramp-run-real-handler
2284 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))))
2286 (defun tramp-handle-file-name-directory (file)
2287 "Like `file-name-directory' but aware of Tramp files."
2288 ;; Everything except the last filename thing is the directory. We
2289 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2290 ;; the remote file name parts. This is a problem when we are in
2291 ;; file name completion.
2292 (let ((v (tramp-dissect-file-name file t)))
2293 ;; Run the command on the localname portion only.
2294 (tramp-make-tramp-file-name
2295 (tramp-file-name-method v)
2296 (tramp-file-name-user v)
2297 (tramp-file-name-host v)
2298 (tramp-run-real-handler
2299 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2301 (defun tramp-handle-file-name-nondirectory (file)
2302 "Like `file-name-nondirectory' but aware of Tramp files."
2303 (with-parsed-tramp-file-name file nil
2304 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2306 (defun tramp-handle-file-truename (filename &optional counter prev-dirs)
2307 "Like `file-truename' for Tramp files."
2308 (with-parsed-tramp-file-name (expand-file-name filename) nil
2309 (with-file-property v localname "file-truename"
2310 (let* ((directory-sep-char ?/) ; for XEmacs
2311 (steps (tramp-split-string localname "/"))
2312 (localnamedir (tramp-run-real-handler
2313 'file-name-as-directory (list localname)))
2314 (is-dir (string= localname localnamedir))
2317 ;; Don't make the following value larger than necessary.
2318 ;; People expect an error message in a timely fashion when
2319 ;; something is wrong; otherwise they might think that Emacs
2320 ;; is hung. Of course, correctness has to come first.
2322 (result nil) ;result steps in reverse order
2324 (tramp-message v 4 "Finding true name for `%s'" filename)
2325 (while (and steps (< numchase numchase-limit))
2326 (setq thisstep (pop steps))
2329 (mapconcat 'identity
2330 (append '("") (reverse result) (list thisstep))
2332 (setq symlink-target
2333 (nth 0 (file-attributes
2334 (tramp-make-tramp-file-name
2336 (mapconcat 'identity
2341 (cond ((string= "." thisstep)
2342 (tramp-message v 5 "Ignoring step `.'"))
2343 ((string= ".." thisstep)
2344 (tramp-message v 5 "Processing step `..'")
2346 ((stringp symlink-target)
2347 ;; It's a symlink, follow it.
2348 (tramp-message v 5 "Follow symlink to %s" symlink-target)
2349 (setq numchase (1+ numchase))
2350 (when (file-name-absolute-p symlink-target)
2352 ;; If the symlink was absolute, we'll get a string like
2353 ;; "/user@host:/some/target"; extract the
2354 ;; "/some/target" part from it.
2355 (when (tramp-tramp-file-p symlink-target)
2356 (unless (tramp-equal-remote filename symlink-target)
2359 "Symlink target `%s' on wrong host" symlink-target))
2360 (setq symlink-target localname))
2362 (append (tramp-split-string symlink-target "/")
2366 (setq result (cons thisstep result)))))
2367 (when (>= numchase numchase-limit)
2370 "Maximum number (%d) of symlinks exceeded" numchase-limit))
2371 (setq result (reverse result))
2372 ;; Combine list to form string.
2375 (mapconcat 'identity (cons "" result) "/")
2377 (when (and is-dir (or (string= "" result)
2378 (not (string= (substring result -1) "/"))))
2379 (setq result (concat result "/")))
2380 (tramp-message v 4 "True name of `%s' is `%s'" filename result)
2381 (tramp-make-tramp-file-name method user host result)))))
2385 (defun tramp-handle-file-exists-p (filename)
2386 "Like `file-exists-p' for Tramp files."
2387 (with-parsed-tramp-file-name filename nil
2388 (with-file-property v localname "file-exists-p"
2389 (zerop (tramp-send-command-and-check
2393 (tramp-get-file-exists-command v)
2394 (tramp-shell-quote-argument localname)))))))
2396 ;; Inodes don't exist for some file systems. Therefore we must
2397 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
2398 ;; applied might be not so efficient (Ange-FTP uses hashes). But
2399 ;; performance isn't the major issue given that file transfer will
2401 (defvar tramp-inodes nil
2402 "Keeps virtual inodes numbers.")
2404 ;; Devices must distinguish physical file systems. The device numbers
2405 ;; provided by "lstat" aren't unique, because we operate on different hosts.
2406 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
2407 ;; EFS use device number "-1". In order to be different, we use device number
2408 ;; (-1 . x), whereby "x" is unique for a given (method user host).
2409 (defvar tramp-devices nil
2410 "Keeps virtual device numbers.")
2412 ;; CCC: This should check for an error condition and signal failure
2413 ;; when something goes wrong.
2414 ;; Daniel Pittman <daniel@danann.net>
2415 (defun tramp-handle-file-attributes (filename &optional id-format)
2416 "Like `file-attributes' for Tramp files."
2417 (unless id-format (setq id-format 'integer))
2418 (with-parsed-tramp-file-name (expand-file-name filename) nil
2419 (with-file-property v localname (format "file-attributes-%s" id-format)
2420 (when (file-exists-p filename)
2421 ;; file exists, find out stuff
2423 (tramp-convert-file-attributes
2425 (if (tramp-get-remote-stat v)
2426 (tramp-handle-file-attributes-with-stat v localname id-format)
2427 (if (tramp-get-remote-perl v)
2428 (tramp-handle-file-attributes-with-perl v localname id-format)
2429 (tramp-handle-file-attributes-with-ls
2430 v localname id-format)))))))))
2432 (defun tramp-handle-file-attributes-with-ls (vec localname &optional id-format)
2433 "Implement `file-attributes' for Tramp files using the ls(1) command."
2435 res-inode res-filemodes res-numlinks
2436 res-uid res-gid res-size res-symlink-target)
2437 (tramp-message vec 5 "file attributes with ls: %s" localname)
2441 (tramp-get-ls-command vec)
2442 (if (eq id-format 'integer) "-ildn" "-ild")
2443 (tramp-shell-quote-argument localname)))
2444 ;; parse `ls -l' output ...
2445 (with-current-buffer (tramp-get-buffer vec)
2446 (goto-char (point-min))
2450 (read (current-buffer))
2451 (invalid-read-syntax
2452 (when (and (equal (cadr err)
2453 "Integer constant overflow in reader")
2455 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
2457 (let* ((big (read (substring (car (cddr err)) 0
2458 (match-beginning 1))))
2459 (small (read (match-string 1 (car (cddr err)))))
2460 (twiddle (/ small 65536)))
2461 (cons (+ big twiddle)
2462 (- small (* twiddle 65536))))))))
2463 ;; ... file mode flags
2464 (setq res-filemodes (symbol-name (read (current-buffer))))
2466 (setq res-numlinks (read (current-buffer)))
2468 (setq res-uid (read (current-buffer)))
2469 (setq res-gid (read (current-buffer)))
2470 (if (eq id-format 'integer)
2472 (unless (numberp res-uid) (setq res-uid -1))
2473 (unless (numberp res-gid) (setq res-gid -1)))
2475 (unless (stringp res-uid) (setq res-uid (symbol-name res-uid)))
2476 (unless (stringp res-gid) (setq res-gid (symbol-name res-gid)))))
2478 (setq res-size (read (current-buffer)))
2479 ;; From the file modes, figure out other stuff.
2480 (setq symlinkp (eq ?l (aref res-filemodes 0)))
2481 (setq dirp (eq ?d (aref res-filemodes 0)))
2482 ;; if symlink, find out file name pointed to
2484 (search-forward "-> ")
2485 (setq res-symlink-target
2486 (buffer-substring (point) (tramp-compat-line-end-position))))
2487 ;; return data gathered
2489 ;; 0. t for directory, string (name linked to) for symbolic
2491 (or dirp res-symlink-target)
2492 ;; 1. Number of links to file.
2498 ;; 4. Last access time, as a list of two integers. First
2499 ;; integer has high-order 16 bits of time, second has low 16
2501 ;; 5. Last modification time, likewise.
2502 ;; 6. Last status change time, likewise.
2503 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
2504 ;; 7. Size in bytes (-1, if number is out of range).
2506 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
2508 ;; 9. t if file's gid would change if file were deleted and
2509 ;; recreated. Will be set in `tramp-convert-file-attributes'
2511 ;; 10. inode number.
2513 ;; 11. Device number. Will be replaced by a virtual device number.
2517 (defun tramp-handle-file-attributes-with-perl
2518 (vec localname &optional id-format)
2519 "Implement `file-attributes' for Tramp files using a Perl script."
2520 (tramp-message vec 5 "file attributes with perl: %s" localname)
2521 (tramp-maybe-send-script
2522 vec tramp-perl-file-attributes "tramp_perl_file_attributes")
2523 (tramp-send-command-and-read
2525 (format "tramp_perl_file_attributes %s %s"
2526 (tramp-shell-quote-argument localname) id-format)))
2528 (defun tramp-handle-file-attributes-with-stat
2529 (vec localname &optional id-format)
2530 "Implement `file-attributes' for Tramp files using stat(1) command."
2531 (tramp-message vec 5 "file attributes with stat: %s" localname)
2532 (tramp-send-command-and-read
2535 "%s -c '((\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)' %s"
2536 (tramp-get-remote-stat vec)
2537 (if (eq id-format 'integer) "%u" "\"%U\"")
2538 (if (eq id-format 'integer) "%g" "\"%G\"")
2539 (tramp-shell-quote-argument localname))))
2541 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
2542 "Like `set-visited-file-modtime' for Tramp files."
2543 (unless (buffer-file-name)
2544 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
2547 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
2548 (let ((f (buffer-file-name))
2550 (with-parsed-tramp-file-name f nil
2551 (let* ((attr (file-attributes f))
2552 ;; '(-1 65535) means file doesn't exists yet.
2553 (modtime (or (nth 5 attr) '(-1 65535))))
2554 (when (boundp 'last-coding-system-used)
2555 (setq coding-system-used (symbol-value 'last-coding-system-used)))
2556 ;; We use '(0 0) as a don't-know value. See also
2557 ;; `tramp-handle-file-attributes-with-ls'.
2558 (if (not (equal modtime '(0 0)))
2559 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
2563 (format "%s -ild %s"
2564 (tramp-get-ls-command v)
2565 (tramp-shell-quote-argument localname)))
2566 (setq attr (buffer-substring (point)
2567 (progn (end-of-line) (point)))))
2568 (tramp-set-file-property
2569 v localname "visited-file-modtime-ild" attr))
2570 (when (boundp 'last-coding-system-used)
2571 (set 'last-coding-system-used coding-system-used))
2574 ;; CCC continue here
2576 ;; This function makes the same assumption as
2577 ;; `tramp-handle-set-visited-file-modtime'.
2578 (defun tramp-handle-verify-visited-file-modtime (buf)
2579 "Like `verify-visited-file-modtime' for Tramp files.
2580 At the time `verify-visited-file-modtime' calls this function, we
2581 already know that the buffer is visiting a file and that
2582 `visited-file-modtime' does not return 0. Do not call this
2583 function directly, unless those two cases are already taken care
2585 (with-current-buffer buf
2586 ;; There is no file visiting the buffer, or the buffer has no
2587 ;; recorded last modification time.
2588 (if (or (not (buffer-file-name))
2589 (eq (visited-file-modtime) 0))
2591 (let ((f (buffer-file-name)))
2592 (with-parsed-tramp-file-name f nil
2593 (tramp-flush-file-property v localname)
2594 (let* ((attr (file-attributes f))
2595 (modtime (nth 5 attr))
2596 (mt (visited-file-modtime)))
2599 ;; file exists, and has a known modtime.
2600 ((and attr (not (equal modtime '(0 0))))
2601 (< (abs (tramp-time-diff
2603 ;; For compatibility, deal with both the old
2604 ;; (HIGH . LOW) and the new (HIGH LOW)
2605 ;; return values of `visited-file-modtime'.
2607 (list (car mt) (cdr mt))
2610 ;; modtime has the don't know value.
2614 (format "%s -ild %s"
2615 (tramp-get-ls-command v)
2616 (tramp-shell-quote-argument localname)))
2617 (with-current-buffer (tramp-get-buffer v)
2618 (setq attr (buffer-substring
2619 (point) (progn (end-of-line) (point)))))
2622 (tramp-get-file-property
2623 v localname "visited-file-modtime-ild" "")))
2624 ;; If file does not exist, say it is not modified
2625 ;; if and only if that agrees with the buffer's record.
2626 (t (equal mt '(-1 65535))))))))))
2628 (defun tramp-handle-set-file-modes (filename mode)
2629 "Like `set-file-modes' for Tramp files."
2630 (with-parsed-tramp-file-name filename nil
2631 (tramp-flush-file-property v localname)
2632 (unless (zerop (tramp-send-command-and-check
2634 (format "chmod %s %s"
2635 (tramp-decimal-to-octal mode)
2636 (tramp-shell-quote-argument localname))))
2637 ;; FIXME: extract the proper text from chmod's stderr.
2639 v 'file-error "Error while changing file's mode %s" filename))))
2641 (defun tramp-handle-set-file-times (filename &optional time)
2642 "Like `set-file-times' for Tramp files."
2644 (if (file-remote-p filename)
2645 (with-parsed-tramp-file-name filename nil
2646 (tramp-flush-file-property v localname)
2647 (let ((time (if (or (null time) (equal time '(0 0)))
2651 ;; With GNU Emacs, `format-time-string' has an
2652 ;; optional parameter UNIVERSAL. This is preferred,
2653 ;; because we could handle the case when the remote
2654 ;; host is located in a different time zone as the
2656 (and (functionp 'subr-arity)
2657 (subrp (symbol-function 'format-time-string))
2658 (= 3 (cdr (funcall (symbol-function 'subr-arity)
2660 'format-time-string)))))))
2661 (tramp-send-command-and-check
2662 v (format "%s touch -t %s %s"
2663 (if utc "TZ=UTC; export TZ;" "")
2665 (format-time-string "%Y%m%d%H%M.%S" time t)
2666 (format-time-string "%Y%m%d%H%M.%S" time))
2667 (tramp-shell-quote-argument localname)))))
2669 ;; We handle also the local part, because in older Emacsen,
2670 ;; without `set-file-times', this function is an alias for this.
2671 ;; We are local, so we don't need the UTC settings.
2672 (tramp-local-call-process
2673 "touch" nil nil nil "-t"
2674 (format-time-string "%Y%m%d%H%M.%S" time)
2675 (tramp-shell-quote-argument filename)))))
2677 (defun tramp-set-file-uid-gid (filename &optional uid gid)
2678 "Set the ownership for FILENAME.
2679 If UID and GID are provided, these values are used; otherwise uid
2680 and gid of the corresponding user is taken. Both parameters must be integers."
2681 ;; CCC: Modern Unices allow chown only for root. So we might need
2682 ;; another implementation, see `dired-do-chown'. OTOH, it is
2683 ;; mostly working with su(do)? when it is needed, so it shall
2684 ;; succeed in the majority of cases.
2685 (if (file-remote-p filename)
2686 (with-parsed-tramp-file-name filename nil
2687 (let ((uid (or (and (integerp uid) uid)
2688 (tramp-get-remote-uid v 'integer)))
2689 (gid (or (and (integerp gid) gid)
2690 (tramp-get-remote-gid v 'integer))))
2693 "chown %d:%d %s" uid gid
2694 (tramp-shell-quote-argument localname)))))
2696 ;; We handle also the local part, because there doesn't exist
2697 ;; `set-file-uid-gid'. On Win32 "chown" might not work.
2698 (let ((uid (or (and (integerp uid) uid) (tramp-get-local-uid 'integer)))
2699 (gid (or (and (integerp gid) gid) (tramp-get-local-gid 'integer))))
2700 (tramp-local-call-process
2702 (format "%d:%d" uid gid) (tramp-shell-quote-argument filename)))))
2704 ;; Simple functions using the `test' command.
2706 (defun tramp-handle-file-executable-p (filename)
2707 "Like `file-executable-p' for Tramp files."
2708 (with-parsed-tramp-file-name filename nil
2709 (with-file-property v localname "file-executable-p"
2710 (zerop (tramp-run-test "-x" filename)))))
2712 (defun tramp-handle-file-readable-p (filename)
2713 "Like `file-readable-p' for Tramp files."
2714 (with-parsed-tramp-file-name filename nil
2715 (with-file-property v localname "file-readable-p"
2716 (zerop (tramp-run-test "-r" filename)))))
2718 ;; When the remote shell is started, it looks for a shell which groks
2719 ;; tilde expansion. Here, we assume that all shells which grok tilde
2720 ;; expansion will also provide a `test' command which groks `-nt' (for
2721 ;; newer than). If this breaks, tell me about it and I'll try to do
2722 ;; something smarter about it.
2723 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2724 "Like `file-newer-than-file-p' for Tramp files."
2725 (cond ((not (file-exists-p file1))
2727 ((not (file-exists-p file2))
2729 ;; We are sure both files exist at this point.
2732 ;; We try to get the mtime of both files. If they are not
2733 ;; equal to the "dont-know" value, then we subtract the times
2734 ;; and obtain the result.
2735 (let ((fa1 (file-attributes file1))
2736 (fa2 (file-attributes file2)))
2737 (if (and (not (equal (nth 5 fa1) '(0 0)))
2738 (not (equal (nth 5 fa2) '(0 0))))
2739 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
2740 ;; If one of them is the dont-know value, then we can
2741 ;; still try to run a shell command on the remote host.
2742 ;; However, this only works if both files are Tramp
2743 ;; files and both have the same method, same user, same
2745 (unless (tramp-equal-remote file1 file2)
2746 (with-parsed-tramp-file-name
2747 (if (tramp-tramp-file-p file1) file1 file2) nil
2750 "Files %s and %s must have same method, user, host"
2752 (with-parsed-tramp-file-name file1 nil
2753 (zerop (tramp-run-test2
2754 (tramp-get-test-nt-command v) file1 file2)))))))))
2756 ;; Functions implemented using the basic functions above.
2758 (defun tramp-handle-file-modes (filename)
2759 "Like `file-modes' for Tramp files."
2760 (let ((truename (or (file-truename filename) filename)))
2761 (when (file-exists-p truename)
2762 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2764 (defun tramp-handle-file-directory-p (filename)
2765 "Like `file-directory-p' for Tramp files."
2766 ;; Care must be taken that this function returns `t' for symlinks
2767 ;; pointing to directories. Surely the most obvious implementation
2768 ;; would be `test -d', but that returns false for such symlinks.
2769 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
2770 ;; I now think he's right. So we could be using `test -d', couldn't
2773 ;; Alternatives: `cd %s', `test -d %s'
2774 (with-parsed-tramp-file-name filename nil
2775 (with-file-property v localname "file-directory-p"
2776 (zerop (tramp-run-test "-d" filename)))))
2778 (defun tramp-handle-file-regular-p (filename)
2779 "Like `file-regular-p' for Tramp files."
2780 (and (file-exists-p filename)
2781 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2783 (defun tramp-handle-file-symlink-p (filename)
2784 "Like `file-symlink-p' for Tramp files."
2785 (with-parsed-tramp-file-name filename nil
2786 (let ((x (car (file-attributes filename))))
2788 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2789 ;; might do weird things.
2790 (if (file-name-absolute-p x)
2791 (tramp-make-tramp-file-name method user host x)
2794 (defun tramp-handle-file-writable-p (filename)
2795 "Like `file-writable-p' for Tramp files."
2796 (with-parsed-tramp-file-name filename nil
2797 (with-file-property v localname "file-writable-p"
2798 (if (file-exists-p filename)
2799 ;; Existing files must be writable.
2800 (zerop (tramp-run-test "-w" filename))
2801 ;; If file doesn't exist, check if directory is writable.
2802 (and (zerop (tramp-run-test
2803 "-d" (file-name-directory filename)))
2804 (zerop (tramp-run-test
2805 "-w" (file-name-directory filename))))))))
2807 (defun tramp-handle-file-ownership-preserved-p (filename)
2808 "Like `file-ownership-preserved-p' for Tramp files."
2809 (with-parsed-tramp-file-name filename nil
2810 (with-file-property v localname "file-ownership-preserved-p"
2811 (let ((attributes (file-attributes filename)))
2812 ;; Return t if the file doesn't exist, since it's true that no
2813 ;; information would be lost by an (attempted) delete and create.
2814 (or (null attributes)
2815 (= (nth 2 attributes) (tramp-get-remote-uid v 'integer)))))))
2817 ;; Other file name ops.
2819 (defun tramp-handle-directory-file-name (directory)
2820 "Like `directory-file-name' for Tramp files."
2821 ;; If localname component of filename is "/", leave it unchanged.
2822 ;; Otherwise, remove any trailing slash from localname component.
2823 ;; Method, host, etc, are unchanged. Does it make sense to try
2824 ;; to avoid parsing the filename?
2825 (with-parsed-tramp-file-name directory nil
2826 (if (and (not (zerop (length localname)))
2827 (eq (aref localname (1- (length localname))) ?/)
2828 (not (string= localname "/")))
2829 (substring directory 0 -1)
2832 ;; Directory listings.
2834 (defun tramp-handle-directory-files
2835 (directory &optional full match nosort files-only)
2836 "Like `directory-files' for Tramp files."
2837 ;; FILES-ONLY is valid for XEmacs only.
2838 (when (file-directory-p directory)
2839 (setq directory (expand-file-name directory))
2840 (let ((temp (nreverse (file-name-all-completions "" directory)))
2844 (setq item (directory-file-name (pop temp)))
2845 (when (and (or (null match) (string-match match item))
2846 (or (null files-only)
2848 (and (equal files-only t) (file-regular-p item))
2850 (file-directory-p item)))
2851 (push (if full (expand-file-name item directory) item)
2855 (defun tramp-handle-directory-files-and-attributes
2856 (directory &optional full match nosort id-format)
2857 "Like `directory-files-and-attributes' for Tramp files."
2858 (unless id-format (setq id-format 'integer))
2859 (when (file-directory-p directory)
2860 (setq directory (expand-file-name directory))
2862 (tramp-compat-copy-tree
2863 (with-parsed-tramp-file-name directory nil
2866 (format "directory-files-and-attributes-%s" id-format)
2871 (tramp-convert-file-attributes v (cdr x))))
2872 (if (tramp-get-remote-stat v)
2873 (tramp-handle-directory-files-and-attributes-with-stat
2874 v localname id-format)
2875 (if (tramp-get-remote-perl v)
2876 (tramp-handle-directory-files-and-attributes-with-perl
2877 v localname id-format)))))))))
2881 (setq item (pop temp))
2882 (when (or (null match) (string-match match (car item)))
2884 (setcar item (expand-file-name (car item) directory)))
2885 (push item result)))
2889 (sort result (lambda (x y) (string< (car x) (car y))))))))
2891 (defun tramp-handle-directory-files-and-attributes-with-perl
2892 (vec localname &optional id-format)
2893 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
2894 (tramp-message vec 5 "directory-files-and-attributes with perl: %s" localname)
2895 (tramp-maybe-send-script
2896 vec tramp-perl-directory-files-and-attributes
2897 "tramp_perl_directory_files_and_attributes")
2899 (tramp-send-command-and-read
2901 (format "tramp_perl_directory_files_and_attributes %s %s"
2902 (tramp-shell-quote-argument localname) id-format))))
2903 (when (stringp object) (tramp-error vec 'file-error object))
2906 (defun tramp-handle-directory-files-and-attributes-with-stat
2907 (vec localname &optional id-format)
2908 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
2909 (tramp-message vec 5 "directory-files-and-attributes with stat: %s" localname)
2910 (tramp-send-command-and-read
2914 "cd %s; echo \"(\"; (%s -ab | xargs "
2915 "%s -c '(\"%%n\" (\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)'); "
2917 (tramp-shell-quote-argument localname)
2918 (tramp-get-ls-command vec)
2919 (tramp-get-remote-stat vec)
2920 (if (eq id-format 'integer) "%u" "\"%U\"")
2921 (if (eq id-format 'integer) "%g" "\"%G\""))))
2923 ;; This function should return "foo/" for directories and "bar" for
2925 (defun tramp-handle-file-name-all-completions (filename directory)
2926 "Like `file-name-all-completions' for Tramp files."
2927 (unless (save-match-data (string-match "/" filename))
2928 (with-parsed-tramp-file-name (expand-file-name directory) nil
2929 ;; Flush the directory cache. There could be changed directory
2931 (when (and (integerp tramp-completion-reread-directory-timeout)
2934 (tramp-get-file-property
2935 v localname "last-completion" '(0 0 0)))
2936 tramp-completion-reread-directory-timeout))
2937 (tramp-flush-file-property v localname))
2943 (with-file-property v localname "file-name-all-completions"
2945 (tramp-barf-unless-okay
2947 (format "cd %s" (tramp-shell-quote-argument localname))
2948 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
2949 (tramp-shell-quote-argument localname))
2951 ;; Get a list of directories and files, including reliably
2952 ;; tagging the directories with a trailing '/'. Because I
2953 ;; rock. --daniel@danann.net
2956 (format (concat "%s -ab 2>/dev/null | while read f; do "
2957 "if %s -d \"$f\" 2>/dev/null; "
2958 "then echo \"$f/\"; else echo \"$f\"; fi; done")
2959 (tramp-get-ls-command v)
2960 (tramp-get-test-command v)))
2962 ;; Now grab the output.
2963 (with-current-buffer (tramp-get-buffer v)
2964 (goto-char (point-max))
2965 (while (zerop (forward-line -1))
2966 (push (buffer-substring
2967 (point) (tramp-compat-line-end-position))
2970 (tramp-set-file-property
2971 v localname "last-completion" (current-time))
2974 ;; The following isn't needed for Emacs 20 but for 19.34?
2975 (defun tramp-handle-file-name-completion
2976 (filename directory &optional predicate)
2977 "Like `file-name-completion' for Tramp files."
2978 (unless (tramp-tramp-file-p directory)
2980 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2984 (mapcar 'list (file-name-all-completions filename directory))
2986 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2990 (defun tramp-handle-add-name-to-file
2991 (filename newname &optional ok-if-already-exists)
2992 "Like `add-name-to-file' for Tramp files."
2993 (unless (tramp-equal-remote filename newname)
2994 (with-parsed-tramp-file-name
2995 (if (tramp-tramp-file-p filename) filename newname) nil
2998 "add-name-to-file: %s"
2999 "only implemented for same method, same user, same host")))
3000 (with-parsed-tramp-file-name filename v1
3001 (with-parsed-tramp-file-name newname v2
3002 (let ((ln (when v1 (tramp-get-remote-ln v1))))
3003 (when (and (not ok-if-already-exists)
3004 (file-exists-p newname)
3005 (not (numberp ok-if-already-exists))
3008 "File %s already exists; make it a new name anyway? "
3012 "add-name-to-file: file %s already exists" newname))
3013 (tramp-flush-file-property v2 v2-localname)
3014 (tramp-barf-unless-okay
3016 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
3017 (tramp-shell-quote-argument v2-localname))
3018 "error with add-name-to-file, see buffer `%s' for details"
3021 (defun tramp-handle-copy-file
3022 (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
3023 "Like `copy-file' for Tramp files."
3024 ;; Check if both files are local -- invoke normal copy-file.
3025 ;; Otherwise, use Tramp from local system.
3026 (setq filename (expand-file-name filename))
3027 (setq newname (expand-file-name newname))
3029 ;; At least one file a Tramp file?
3030 ((or (tramp-tramp-file-p filename)
3031 (tramp-tramp-file-p newname))
3032 (tramp-do-copy-or-rename-file
3033 'copy filename newname ok-if-already-exists keep-date preserve-uid-gid))
3036 (tramp-run-real-handler
3038 (list filename newname ok-if-already-exists keep-date preserve-uid-gid)))
3040 (tramp-run-real-handler
3041 'copy-file (list filename newname ok-if-already-exists keep-date)))))
3043 (defun tramp-handle-rename-file
3044 (filename newname &optional ok-if-already-exists)
3045 "Like `rename-file' for Tramp files."
3046 ;; Check if both files are local -- invoke normal rename-file.
3047 ;; Otherwise, use Tramp from local system.
3048 (setq filename (expand-file-name filename))
3049 (setq newname (expand-file-name newname))
3050 ;; At least one file a Tramp file?
3051 (if (or (tramp-tramp-file-p filename)
3052 (tramp-tramp-file-p newname))
3053 (tramp-do-copy-or-rename-file
3054 'rename filename newname ok-if-already-exists t t)
3055 (tramp-run-real-handler
3056 'rename-file (list filename newname ok-if-already-exists))))
3058 (defun tramp-do-copy-or-rename-file
3059 (op filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
3060 "Copy or rename a remote file.
3061 OP must be `copy' or `rename' and indicates the operation to perform.
3062 FILENAME specifies the file to copy or rename, NEWNAME is the name of
3063 the new file (for copy) or the new name of the file (for rename).
3064 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
3065 KEEP-DATE means to make sure that NEWNAME has the same timestamp
3066 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
3067 the uid and gid if both files are on the same host.
3069 This function is invoked by `tramp-handle-copy-file' and
3070 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
3071 and `rename'. FILENAME and NEWNAME must be absolute file names."
3072 (unless (memq op '(copy rename))
3073 (error "Unknown operation `%s', must be `copy' or `rename'" op))
3074 (let ((t1 (tramp-tramp-file-p filename))
3075 (t2 (tramp-tramp-file-p newname)))
3077 (when (and (not ok-if-already-exists) (file-exists-p newname))
3078 (with-parsed-tramp-file-name (if t1 filename newname) nil
3080 v 'file-already-exists "File %s already exists" newname)))
3084 ;; Both are Tramp files.
3086 (with-parsed-tramp-file-name filename v1
3087 (with-parsed-tramp-file-name newname v2
3089 ;; Shortcut: if method, host, user are the same for both
3090 ;; files, we invoke `cp' or `mv' on the remote host
3092 ((tramp-equal-remote filename newname)
3093 (tramp-do-copy-or-rename-file-directly
3095 ok-if-already-exists keep-date preserve-uid-gid))
3097 ;; If both source and target are Tramp files,
3098 ;; both are using the same copy-program, then we
3099 ;; can invoke rcp directly. Note that
3100 ;; default-directory should point to a local
3101 ;; directory if we want to invoke rcp.
3102 ((and (equal v1-method v2-method)
3103 (tramp-method-out-of-band-p v1)
3104 (> (nth 7 (file-attributes filename))
3105 tramp-copy-size-limit))
3106 (tramp-do-copy-or-rename-file-out-of-band
3107 op filename newname keep-date))
3109 ;; No shortcut was possible. So we copy the
3110 ;; file first. If the operation was `rename', we go
3111 ;; back and delete the original file (if the copy was
3112 ;; successful). The approach is simple-minded: we
3113 ;; create a new buffer, insert the contents of the
3114 ;; source file into it, then write out the buffer to
3115 ;; the target file. The advantage is that it doesn't
3116 ;; matter which filename handlers are used for the
3117 ;; source and target file.
3119 (tramp-do-copy-or-rename-file-via-buffer
3120 op filename newname keep-date))))))
3122 ;; One file is a Tramp file, the other one is local.
3124 (with-parsed-tramp-file-name (if t1 filename newname) nil
3126 ;; Fast track on local machine.
3127 ((tramp-local-host-p v)
3128 (tramp-do-copy-or-rename-file-directly
3130 ok-if-already-exists keep-date preserve-uid-gid))
3132 ;; If the Tramp file has an out-of-band method, the corresponding
3133 ;; copy-program can be invoked.
3134 ((and (tramp-method-out-of-band-p v)
3135 (> (nth 7 (file-attributes filename))
3136 tramp-copy-size-limit))
3137 (tramp-do-copy-or-rename-file-out-of-band
3138 op filename newname keep-date))
3140 ;; Use the inline method via a Tramp buffer.
3141 (t (tramp-do-copy-or-rename-file-via-buffer
3142 op filename newname keep-date)))))
3145 ;; One of them must be a Tramp file.
3146 (error "Tramp implementation says this cannot happen")))
3148 ;; In case of `rename', we must flush the cache of the source file.
3149 (when (and t1 (eq op 'rename))
3150 (with-parsed-tramp-file-name filename nil
3151 (tramp-flush-file-property v localname)))
3153 ;; When newname did exist, we have wrong cached values.
3155 (with-parsed-tramp-file-name newname nil
3156 (tramp-flush-file-property v localname))))))
3158 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
3159 "Use an Emacs buffer to copy or rename a file.
3160 First arg OP is either `copy' or `rename' and indicates the operation.
3161 FILENAME is the source file, NEWNAME the target file.
3162 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
3164 ;; We must disable multibyte, because binary data shall not be
3166 (set-buffer-multibyte nil)
3167 (let ((coding-system-for-read 'binary)
3168 (jka-compr-inhibit t))
3169 (insert-file-contents-literally filename))
3170 ;; We don't want the target file to be compressed, so we let-bind
3171 ;; `jka-compr-inhibit' to t.
3172 (let ((coding-system-for-write 'binary)
3173 (jka-compr-inhibit t))
3174 (write-region (point-min) (point-max) newname)))
3175 ;; KEEP-DATE handling.
3176 (when keep-date (set-file-times newname (nth 5 (file-attributes filename))))
3178 (set-file-modes newname (file-modes filename))
3179 ;; If the operation was `rename', delete the original file.
3180 (unless (eq op 'copy) (delete-file filename)))
3182 (defun tramp-do-copy-or-rename-file-directly
3183 (op filename newname ok-if-already-exists keep-date preserve-uid-gid)
3184 "Invokes `cp' or `mv' on the remote system.
3185 OP must be one of `copy' or `rename', indicating `cp' or `mv',
3186 respectively. FILENAME specifies the file to copy or rename,
3187 NEWNAME is the name of the new file (for copy) or the new name of
3188 the file (for rename). Both files must reside on the same host.
3189 KEEP-DATE means to make sure that NEWNAME has the same timestamp
3190 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
3191 the uid and gid from FILENAME."
3192 (let ((t1 (tramp-tramp-file-p filename))
3193 (t2 (tramp-tramp-file-p newname)))
3194 (with-parsed-tramp-file-name (if t1 filename newname) nil
3195 (let* ((cmd (cond ((and (eq op 'copy) preserve-uid-gid) "cp -f -p")
3196 ((eq op 'copy) "cp -f")
3197 ((eq op 'rename) "mv -f")
3200 "Unknown operation `%s', must be `copy' or `rename'"
3203 (if t1 (tramp-handle-file-remote-p filename 'localname) filename))
3205 (if t2 (tramp-handle-file-remote-p newname 'localname) newname))
3206 (prefix (file-remote-p (if t1 filename newname))))
3209 ;; Both files are on a remote host, with same user.
3213 (format "%s %s %s" cmd
3214 (tramp-shell-quote-argument localname1)
3215 (tramp-shell-quote-argument localname2)))
3216 (with-current-buffer (tramp-get-buffer v)
3217 (goto-char (point-min))
3221 ;; Mask cp -f error.
3223 tramp-operation-not-permitted-regexp nil t))
3224 (zerop (tramp-send-command-and-check v nil)))
3225 (tramp-error-with-buffer
3227 "Copying directly failed, see buffer `%s' for details."
3230 ;; We are on the local host.
3233 ;; We can do it directly.
3234 ((let (file-name-handler-alist)
3235 (and (file-readable-p localname1)
3236 (file-writable-p (file-name-directory localname2))
3237 (or (file-directory-p localname2)
3238 (file-writable-p localname2))))
3240 (tramp-compat-copy-file
3241 localname1 localname2 ok-if-already-exists
3242 keep-date preserve-uid-gid)
3243 (tramp-run-real-handler
3244 'rename-file (list localname1 localname2 ok-if-already-exists))))
3246 ;; We can do it directly with `tramp-send-command'
3247 ((let (file-name-handler-alist)
3248 (and (file-readable-p (concat prefix localname1))
3250 (file-name-directory (concat prefix localname2)))))
3251 (tramp-do-copy-or-rename-file-directly
3252 op (concat prefix localname1) (concat prefix localname2)
3253 ok-if-already-exists keep-date t)
3254 ;; We must change the ownership to the local user.
3255 (tramp-set-file-uid-gid
3256 (concat prefix localname2)
3257 (tramp-get-local-uid 'integer)
3258 (tramp-get-local-gid 'integer)))
3260 ;; We need a temporary file in between.
3262 ;; Create the temporary file.
3263 (let ((tmpfile (tramp-compat-make-temp-file localname1)))
3271 (tramp-shell-quote-argument localname1)
3272 (tramp-shell-quote-argument tmpfile)))
3273 ;; We must change the ownership as remote user.
3274 (tramp-set-file-uid-gid
3275 (concat prefix tmpfile)
3276 (tramp-get-local-uid 'integer)
3277 (tramp-get-local-gid 'integer)))
3280 (tramp-compat-copy-file
3281 localname1 tmpfile ok-if-already-exists
3282 keep-date preserve-uid-gid)
3283 (tramp-run-real-handler
3285 (list localname1 tmpfile ok-if-already-exists)))
3286 ;; We must change the ownership as local user.
3287 (tramp-set-file-uid-gid
3289 (tramp-get-remote-uid v 'integer)
3290 (tramp-get-remote-gid v 'integer))))
3292 ;; Move the temporary file to its destination.
3298 (tramp-shell-quote-argument tmpfile)
3299 (tramp-shell-quote-argument localname2))))
3301 (tramp-run-real-handler
3303 (list tmpfile localname2 ok-if-already-exists)))))
3307 (delete-file tmpfile)
3308 (signal (car err) (cdr err))))))))))
3310 ;; Set the time and mode. Mask possible errors.
3311 ;; Won't be applied for 'rename.
3313 (when (and keep-date (not preserve-uid-gid))
3314 (set-file-times newname (nth 5 (file-attributes filename)))
3315 (set-file-modes newname (file-modes filename)))
3318 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
3319 "Invoke rcp program to copy.
3320 One of FILENAME and NEWNAME must be a Tramp name, the other must
3321 be a local filename. The method used must be an out-of-band method."
3322 (let ((t1 (tramp-tramp-file-p filename))
3323 (t2 (tramp-tramp-file-p newname))
3324 copy-program copy-args copy-keep-date port spec
3327 (with-parsed-tramp-file-name (if t1 filename newname) nil
3329 ;; Expand hops. Might be necessary for gateway methods.
3330 (setq v (car (tramp-compute-multi-hops v)))
3331 (aset v 3 localname)
3333 ;; Check which ones of source and target are Tramp files.
3334 (setq source (if t1 (tramp-make-copy-program-file-name v) filename)
3335 target (if t2 (tramp-make-copy-program-file-name v) newname))
3337 ;; Check for port number. Until now, there's no need for handling
3338 ;; like method, user, host.
3339 (setq host (tramp-file-name-real-host v)
3340 port (tramp-file-name-port v)
3341 port (or (and port (number-to-string port)) ""))
3343 ;; Compose copy command.
3344 (setq spec `((?h . ,host) (?u . ,user) (?p . ,port)
3345 (?t . ,(tramp-get-connection-property
3346 (tramp-get-connection-process v) "temp-file" ""))
3347 (?k . ,(if keep-date " " "")))
3348 copy-program (tramp-get-method-parameter
3349 method 'tramp-copy-program)
3350 copy-keep-date (tramp-get-method-parameter
3351 method 'tramp-copy-keep-date)
3358 ;; " " is indication for keep-date argument.
3359 x (delete " " (mapcar '(lambda (y) (format-spec y spec)) x)))
3360 (unless (member "" x) (mapconcat 'identity x " ")))
3361 (tramp-get-method-parameter method 'tramp-copy-args))))
3363 ;; Check for program.
3364 (when (and (fboundp 'executable-find)
3365 (not (let ((default-directory
3366 (tramp-compat-temporary-file-directory)))
3367 (executable-find copy-program))))
3369 v 'file-error "Cannot find copy program: %s" copy-program))
3371 (tramp-message v 0 "Transferring %s to %s..." filename newname)
3375 ;; The default directory must be remote.
3376 (let ((default-directory
3377 (file-name-directory (if t1 filename newname))))
3378 ;; Set the transfer process properties.
3379 (tramp-set-connection-property
3380 v "process-name" (buffer-name (current-buffer)))
3381 (tramp-set-connection-property
3382 v "process-buffer" (current-buffer))
3384 ;; Use an asynchronous process. By this, password can
3385 ;; be handled. The default directory must be local, in
3386 ;; order to apply the correct `copy-program'. We don't
3387 ;; set a timeout, because the copying of large files can
3388 ;; last longer than 60 secs.
3389 (let ((p (let ((default-directory
3390 (tramp-compat-temporary-file-directory)))
3391 (apply 'start-process
3392 (tramp-get-connection-property
3393 v "process-name" nil)
3394 (tramp-get-connection-property
3395 v "process-buffer" nil)
3397 (append copy-args (list source target))))))
3399 v 6 "%s" (mapconcat 'identity (process-command p) " "))
3400 (tramp-set-process-query-on-exit-flag p nil)
3401 (tramp-process-actions p v tramp-actions-copy-out-of-band))))
3403 ;; Reset the transfer process properties.
3404 (tramp-set-connection-property v "process-name" nil)
3405 (tramp-set-connection-property v "process-buffer" nil))
3407 (tramp-message v 0 "Transferring %s to %s...done" filename newname)
3409 ;; Handle KEEP-DATE argument.
3410 (when (and keep-date (not copy-keep-date))
3411 (set-file-times newname (nth 5 (file-attributes filename))))
3414 (unless (and keep-date copy-keep-date)
3415 (set-file-modes newname (file-modes filename))))
3417 ;; If the operation was `rename', delete the original file.
3418 (unless (eq op 'copy)
3419 (delete-file filename))))
3421 (defun tramp-handle-make-directory (dir &optional parents)
3422 "Like `make-directory' for Tramp files."
3423 (setq dir (expand-file-name dir))
3424 (with-parsed-tramp-file-name dir nil
3426 (tramp-barf-unless-okay
3429 (if parents "mkdir -p" "mkdir")
3430 (tramp-shell-quote-argument localname))
3431 "Couldn't make directory %s" dir))))
3433 (defun tramp-handle-delete-directory (directory)
3434 "Like `delete-directory' for Tramp files."
3435 (setq directory (expand-file-name directory))
3436 (with-parsed-tramp-file-name directory nil
3437 (tramp-flush-directory-property v localname)
3438 (unless (zerop (tramp-send-command-and-check
3440 (format "rmdir %s" (tramp-shell-quote-argument localname))))
3441 (tramp-error v 'file-error "Couldn't delete %s" directory))))
3443 (defun tramp-handle-delete-file (filename)
3444 "Like `delete-file' for Tramp files."
3445 (setq filename (expand-file-name filename))
3446 (with-parsed-tramp-file-name filename nil
3447 (tramp-flush-file-property v localname)
3448 (unless (zerop (tramp-send-command-and-check
3451 (tramp-shell-quote-argument localname))))
3452 (tramp-error v 'file-error "Couldn't delete %s" filename))))
3456 ;; CCC: This does not seem to be enough. Something dies when
3457 ;; we try and delete two directories under Tramp :/
3458 (defun tramp-handle-dired-recursive-delete-directory (filename)
3459 "Recursively delete the directory given.
3460 This is like `dired-recursive-delete-directory' for Tramp files."
3461 (with-parsed-tramp-file-name filename nil
3462 (tramp-flush-directory-property v filename)
3463 ;; Run a shell command 'rm -r <localname>'
3464 ;; Code shamelessly stolen for the dired implementation and, um, hacked :)
3465 (unless (file-exists-p filename)
3466 (tramp-error v 'file-error "No such directory: %s" filename))
3467 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
3470 (format "rm -rf %s" (tramp-shell-quote-argument localname))
3471 ;; Don't read the output, do it explicitely.
3473 ;; Wait for the remote system to return to us...
3474 ;; This might take a while, allow it plenty of time.
3475 (tramp-wait-for-output (tramp-get-connection-process v) 120)
3476 ;; Make sure that it worked...
3477 (and (file-exists-p filename)
3479 v 'file-error "Failed to recursively delete %s" filename))))
3481 (defun tramp-handle-dired-compress-file (file &rest ok-flag)
3482 "Like `dired-compress-file' for Tramp files."
3483 ;; OK-FLAG is valid for XEmacs only, but not implemented.
3484 ;; Code stolen mainly from dired-aux.el.
3485 (with-parsed-tramp-file-name file nil
3486 (tramp-flush-file-property v localname)
3489 (if (not (featurep 'xemacs))
3491 (symbol-value 'dired-compress-file-suffixes)
3492 ;; XEmacs has `dired-compression-method-alist', which is
3493 ;; transformed into `dired-compress-file-suffixes' structure.
3496 (list (concat (regexp-quote (nth 1 x)) "\\'")
3498 (mapconcat 'identity (nth 3 x) " ")))
3499 (symbol-value 'dired-compression-method-alist))))
3501 ;; See if any suffix rule matches this file name.
3503 (let (case-fold-search)
3504 (if (string-match (car (car suffixes)) localname)
3505 (setq suffix (car suffixes) suffixes nil))
3506 (setq suffixes (cdr suffixes))))
3508 (cond ((file-symlink-p file)
3510 ((and suffix (nth 2 suffix))
3511 ;; We found an uncompression rule.
3512 (tramp-message v 0 "Uncompressing %s..." file)
3513 (when (zerop (tramp-send-command-and-check
3514 v (concat (nth 2 suffix) " " localname)))
3515 (tramp-message v 0 "Uncompressing %s...done" file)
3516 ;; `dired-remove-file' is not defined in XEmacs
3517 (funcall (symbol-function 'dired-remove-file) file)
3518 (string-match (car suffix) file)
3519 (concat (substring file 0 (match-beginning 0)))))
3521 ;; We don't recognize the file as compressed, so compress it.
3523 (tramp-message v 0 "Compressing %s..." file)
3524 (when (zerop (tramp-send-command-and-check
3525 v (concat "gzip -f " localname)))
3526 (tramp-message v 0 "Compressing %s...done" file)
3527 ;; `dired-remove-file' is not defined in XEmacs
3528 (funcall (symbol-function 'dired-remove-file) file)
3529 (cond ((file-exists-p (concat file ".gz"))
3530 (concat file ".gz"))
3531 ((file-exists-p (concat file ".z"))
3535 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
3536 ;; not sure at all that this is the right way to do it, but let's hope
3537 ;; it works for now, and wait for a guru to point out the Right Way to
3539 ;;(eval-when-compile
3540 ;; (unless (fboundp 'dired-insert-set-properties)
3541 ;; (fset 'dired-insert-set-properties 'ignore)))
3542 ;; Gerd suggests this:
3543 (eval-when-compile (require 'dired))
3544 ;; Note that dired is required at run-time, too, when it is needed.
3545 ;; It is only needed on XEmacs for the function
3546 ;; `dired-insert-set-properties'.
3548 (defun tramp-handle-insert-directory
3549 (filename switches &optional wildcard full-directory-p)
3550 "Like `insert-directory' for Tramp files."
3551 (setq filename (expand-file-name filename))
3552 (with-parsed-tramp-file-name filename nil
3553 (tramp-flush-file-property v localname)
3554 (if (and (featurep 'ls-lisp)
3555 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
3556 (tramp-run-real-handler
3557 'insert-directory (list filename switches wildcard full-directory-p))
3558 ;; For the moment, we assume that the remote "ls" program does not
3559 ;; grok "--dired". In the future, we should detect this on
3560 ;; connection setup.
3561 (when (string-match "^--dired\\s-+" switches)
3562 (setq switches (replace-match "" nil t switches)))
3564 v 4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
3565 switches filename (if wildcard "yes" "no")
3566 (if full-directory-p "yes" "no"))
3568 (setq wildcard (tramp-run-real-handler
3569 'file-name-nondirectory (list localname)))
3570 (setq localname (tramp-run-real-handler
3571 'file-name-directory (list localname))))
3572 (when (listp switches)
3573 (setq switches (mapconcat 'identity switches " ")))
3574 (unless full-directory-p
3575 (setq switches (concat "-d " switches)))
3577 (setq switches (concat switches " " wildcard)))
3578 ;; If `full-directory-p', we just say `ls -l FILENAME'.
3579 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
3580 (if full-directory-p
3584 (tramp-get-ls-command v)
3588 (tramp-shell-quote-argument (concat localname ".")))))
3589 (tramp-barf-unless-okay
3591 (format "cd %s" (tramp-shell-quote-argument
3592 (tramp-run-real-handler
3593 'file-name-directory (list localname))))
3595 (tramp-shell-quote-argument
3596 (tramp-run-real-handler 'file-name-directory (list localname))))
3600 (tramp-get-ls-command v)
3604 (tramp-run-real-handler
3605 'file-name-nondirectory (list localname)))))
3607 (tramp-shell-quote-argument
3608 (tramp-run-real-handler
3609 'file-name-nondirectory (list localname)))))))
3610 ;; We cannot use `insert-buffer-substring' because the Tramp buffer
3611 ;; changes its contents before insertion due to calling
3612 ;; `expand-file' and alike.
3614 (with-current-buffer (tramp-get-buffer v)
3615 (buffer-string))))))
3617 (defun tramp-handle-unhandled-file-name-directory (filename)
3618 "Like `unhandled-file-name-directory' for Tramp files."
3619 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3620 ;; for backward compatibility.
3621 (expand-file-name "~/"))
3623 ;; Canonicalization of file names.
3625 (defun tramp-handle-expand-file-name (name &optional dir)
3626 "Like `expand-file-name' for Tramp files.
3627 If the localname part of the given filename starts with \"/../\" then
3628 the result will be a local, non-Tramp, filename."
3629 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
3630 (setq dir (or dir default-directory "/"))
3631 ;; Unless NAME is absolute, concat DIR and NAME.
3632 (unless (file-name-absolute-p name)
3633 (setq name (concat (file-name-as-directory dir) name)))
3634 ;; If NAME is not a Tramp file, run the real handler.
3635 (if (not (tramp-tramp-file-p name))
3636 (tramp-run-real-handler 'expand-file-name (list name nil))
3638 (with-parsed-tramp-file-name name nil
3639 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
3640 (setq localname (concat "~/" localname)))
3641 ;; Tilde expansion if necessary. This needs a shell which
3642 ;; groks tilde expansion! The function `tramp-find-shell' is
3643 ;; supposed to find such a shell on the remote host. Please
3644 ;; tell me about it when this doesn't work on your system.
3645 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
3646 (let ((uname (match-string 1 localname))
3647 (fname (match-string 2 localname)))
3648 ;; We cannot simply apply "~/", because under sudo "~/" is
3649 ;; expanded to the local user home directory but to the
3650 ;; root home directory. On the other hand, using always
3651 ;; the default user name for tilde expansion is not
3652 ;; appropriate either, because ssh and companions might
3653 ;; use a user name from the config file.
3654 (when (and (string-equal uname "~")
3655 (string-match "\\`su\\(do\\)?\\'" method))
3656 (setq uname (concat uname user)))
3658 (with-connection-property v uname
3659 (tramp-send-command v (format "cd %s; pwd" uname))
3660 (with-current-buffer (tramp-get-buffer v)
3661 (goto-char (point-min))
3662 (buffer-substring (point) (tramp-compat-line-end-position)))))
3663 (setq localname (concat uname fname))))
3664 ;; There might be a double slash, for example when "~/"
3665 ;; expands to "/". Remove this.
3666 (while (string-match "//" localname)
3667 (setq localname (replace-match "/" t t localname)))
3668 ;; No tilde characters in file name, do normal
3669 ;; expand-file-name (this does "/./" and "/../"). We bind
3670 ;; `directory-sep-char' here for XEmacs on Windows, which
3671 ;; would otherwise use backslash. `default-directory' is
3672 ;; bound, because on Windows there would be problems with UNC
3673 ;; shares or Cygwin mounts.
3674 (let ((directory-sep-char ?/)
3675 (default-directory (tramp-compat-temporary-file-directory)))
3676 (tramp-make-tramp-file-name
3678 (tramp-drop-volume-letter
3679 (tramp-run-real-handler
3680 'expand-file-name (list localname))))))))
3682 (defun tramp-replace-environment-variables (filename)
3683 "Replace environment variables in FILENAME.
3684 Return the string with the replaced variables."
3686 (let ((idx (string-match "$\\w+" filename)))
3687 ;; `$' is coded as `$$'.
3688 (when (and idx (or (zerop idx) (not (eq ?$ (aref filename (1- idx))))))
3691 (substitute-in-file-name (match-string 0 filename))
3695 (defun tramp-handle-substitute-in-file-name (filename)
3696 "Like `substitute-in-file-name' for Tramp files.
3697 \"//\" and \"/~\" substitute only in the local filename part.
3698 If the URL Tramp syntax is chosen, \"//\" as method delimeter and \"/~\" at
3699 beginning of local filename are not substituted."
3700 ;; First, we must replace environment variables.
3701 (setq filename (tramp-replace-environment-variables filename))
3702 (with-parsed-tramp-file-name filename nil
3703 (if (equal tramp-syntax 'url)
3704 ;; We need to check localname only. The other parts cannot contain
3706 (if (and (> (length localname) 1)
3707 (or (string-match "//" localname)
3708 (string-match "/~" localname 1)))
3709 (tramp-run-real-handler 'substitute-in-file-name (list filename))
3710 (tramp-make-tramp-file-name
3711 (when method (substitute-in-file-name method))
3712 (when user (substitute-in-file-name user))
3713 (when host (substitute-in-file-name host))
3715 (tramp-run-real-handler
3716 'substitute-in-file-name (list localname)))))
3717 ;; Ignore in LOCALNAME everything before "//" or "/~".
3718 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3720 (concat (file-remote-p filename)
3721 (replace-match "\\1" nil nil localname)))
3722 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3723 (when (string-match "~$" filename)
3724 (setq filename (concat filename "/"))))
3725 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3727 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
3728 ;; which calls corresponding functions (see minibuf.el).
3729 (when (fboundp 'minibuffer-electric-separator)
3734 (around ,(intern (format "tramp-advice-%s" x)) activate)
3735 "Invoke `substitute-in-file-name' for Tramp files."
3736 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
3737 (tramp-tramp-file-p (buffer-substring)))
3738 ;; We don't need to handle `last-input-event', because
3739 ;; due to the key map we know it must be ?/ or ?~.
3740 (let ((s (concat (buffer-substring (point-min) (point))
3741 (string last-command-char))))
3742 (delete-region (point-min) (point))
3743 (insert (substitute-in-file-name s))
3744 (setq ad-return-value last-command-char))
3747 '(minibuffer-electric-separator
3748 minibuffer-electric-tilde)))
3751 ;;; Remote commands:
3753 (defun tramp-handle-executable-find (command)
3754 "Like `executable-find' for Tramp files."
3755 (with-parsed-tramp-file-name default-directory nil
3756 (tramp-find-executable v command (tramp-get-remote-path v) t)))
3758 ;; We use BUFFER also as connection buffer during setup. Because of
3759 ;; this, its original contents must be saved, and restored once
3760 ;; connection has been setup.
3761 (defun tramp-handle-start-file-process (name buffer program &rest args)
3762 "Like `start-file-process' for Tramp files."
3763 (with-parsed-tramp-file-name default-directory nil
3768 ;; BUFFER can be nil. We use a temporary buffer.
3769 (setq buffer (generate-new-buffer tramp-temp-buffer-name)))
3770 (while (get-process name1)
3771 ;; NAME must be unique as process name.
3773 name1 (format "%s<%d>" name i)))
3775 ;; Set the new process properties.
3776 (tramp-set-connection-property v "process-name" name)
3777 (tramp-set-connection-property v "process-buffer" buffer)
3778 ;; Activate narrowing in order to save BUFFER contents.
3779 ;; Clear also the modification time; otherwise we might be
3780 ;; interrupted by `verify-visited-file-modtime'.
3781 (with-current-buffer (tramp-get-connection-buffer v)
3782 (clear-visited-file-modtime)
3783 (narrow-to-region (point-max) (point-max)))
3784 ;; Goto working directory. `tramp-send-command' opens a new
3787 v (format "cd %s" (tramp-shell-quote-argument localname)))
3788 ;; Send the command.
3792 (mapconcat 'tramp-shell-quote-argument
3793 (cons program args) " "))
3795 ;; Set query flag for this process.
3796 (tramp-set-process-query-on-exit-flag
3797 (tramp-get-connection-process v) t)
3799 (tramp-get-connection-process v))
3801 (with-current-buffer (tramp-get-connection-buffer v)
3802 (if (string-match tramp-temp-buffer-name (buffer-name))
3804 (set-process-buffer (tramp-get-connection-process v) nil)
3805 (kill-buffer (current-buffer)))
3807 (goto-char (point-max))))
3808 (tramp-set-connection-property v "process-name" nil)
3809 (tramp-set-connection-property v "process-buffer" nil))))
3811 (defun tramp-handle-process-file
3812 (program &optional infile destination display &rest args)
3813 "Like `process-file' for Tramp files."
3814 ;; The implementation is not complete yet.
3815 (when (and (numberp destination) (zerop destination))
3816 (error "Implementation does not handle immediate return"))
3818 (with-parsed-tramp-file-name default-directory nil
3819 (let (command input tmpinput stderr tmpstderr outbuf ret)
3821 (setq command (mapconcat 'tramp-shell-quote-argument
3822 (cons program args) " "))
3825 (setq input "/dev/null")
3826 (setq infile (expand-file-name infile))
3827 (if (tramp-equal-remote default-directory infile)
3828 ;; INFILE is on the same remote host.
3829 (setq input (with-parsed-tramp-file-name infile nil localname))
3830 ;; INFILE must be copied to remote host.
3831 (setq input (tramp-make-tramp-temp-file v)
3832 tmpinput (tramp-make-tramp-file-name method user host input))
3833 (copy-file infile tmpinput t)))
3834 (when input (setq command (format "%s <%s" command input)))
3836 ;; Determine output.
3839 ((bufferp destination)
3840 (setq outbuf destination))
3842 ((stringp destination)
3843 (setq outbuf (get-buffer-create destination)))
3844 ;; (REAL-DESTINATION ERROR-DESTINATION)
3845 ((consp destination)
3848 ((bufferp (car destination))
3849 (setq outbuf (car destination)))
3850 ((stringp (car destination))
3851 (setq outbuf (get-buffer-create (car destination))))
3853 (setq outbuf (current-buffer))))
3856 ((stringp (cadr destination))
3857 (setcar (cdr destination) (expand-file-name (cadr destination)))
3858 (if (tramp-equal-remote default-directory (cadr destination))
3859 ;; stderr is on the same remote host.
3860 (setq stderr (with-parsed-tramp-file-name
3861 (cadr destination) nil localname))
3862 ;; stderr must be copied to remote host. The temporary
3863 ;; file must be deleted after execution.
3864 (setq stderr (tramp-make-tramp-temp-file v)
3865 tmpstderr (tramp-make-tramp-file-name
3866 method user host stderr))))
3867 ;; stderr to be discarded
3868 ((null (cadr destination))
3869 (setq stderr "/dev/null"))))
3872 (setq outbuf (current-buffer))))
3873 (when stderr (setq command (format "%s 2>%s" command stderr)))
3875 ;; Goto working directory.
3877 v (format "cd %s" (tramp-shell-quote-argument localname)))
3878 ;; Send the command. It might not return in time, so we protect it.
3881 (tramp-send-command v command)
3882 ;; We should show the output anyway.
3884 (let ((output-string
3885 (with-current-buffer (tramp-get-connection-buffer v)
3886 (buffer-substring (point-min) (point-max)))))
3887 (with-current-buffer outbuf
3888 (insert output-string)))
3889 (when display (display-buffer outbuf))))
3890 ;; When the user did interrupt, we should do it also.
3892 (kill-buffer (tramp-get-connection-buffer v))
3895 ;; Check return code.
3896 (unless ret (setq ret (tramp-send-command-and-check v nil)))
3897 ;; Provide error file.
3898 (when tmpstderr (rename-file tmpstderr (cadr destination) t))
3900 (when tmpinput (delete-file tmpinput))
3901 ;; Return exit status.
3904 (defun tramp-local-call-process
3905 (program &optional infile destination display &rest args)
3906 "Calls `call-process' on the local host.
3907 This is needed because for some Emacs flavors Tramp has
3908 defadviced `call-process' to behave like `process-file'. The
3909 Lisp error raised when PROGRAM is nil is trapped also, returning 1."
3910 (let ((default-directory
3911 (if (file-remote-p default-directory)
3912 (tramp-compat-temporary-file-directory)
3913 default-directory)))
3914 (if (executable-find program)
3915 (apply 'call-process program infile destination display args)
3918 (defun tramp-handle-call-process-region
3919 (start end program &optional delete buffer display &rest args)
3920 "Like `call-process-region' for Tramp files."
3921 (let ((tmpfile (tramp-compat-make-temp-file "")))
3922 (write-region start end tmpfile)
3923 (when delete (delete-region start end))
3925 (apply 'call-process program tmpfile buffer display args)
3926 (delete-file tmpfile))))
3928 (defun tramp-handle-shell-command
3929 (command &optional output-buffer error-buffer)
3930 "Like `shell-command' for Tramp files."
3931 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3932 ;; We cannot use `shell-file-name' and `shell-command-switch',
3933 ;; they are variables of the local host.
3934 (args (list "/bin/sh" "-c" (substring command 0 asynchronous)))
3938 ((bufferp output-buffer) output-buffer)
3939 ((stringp output-buffer) (get-buffer-create output-buffer))
3941 (setq current-buffer-p t)
3943 (t (get-buffer-create
3945 "*Async Shell Command*"
3946 "*Shell Command Output*")))))
3949 ((bufferp error-buffer) error-buffer)
3950 ((stringp error-buffer) (get-buffer-create error-buffer))))
3952 (if (and (not asynchronous) error-buffer)
3953 (with-parsed-tramp-file-name default-directory nil
3954 (list output-buffer (tramp-make-tramp-temp-file v)))
3956 (p (get-buffer-process output-buffer)))
3958 ;; Check whether there is another process running. Tramp does not
3959 ;; support 2 (asynchronous) processes in parallel.
3961 (if (yes-or-no-p "A command is running. Kill it? ")
3965 (error "Shell command in progress")))
3967 (if current-buffer-p
3969 (barf-if-buffer-read-only)
3971 (with-current-buffer output-buffer
3972 (setq buffer-read-only nil)
3975 (if (and (not current-buffer-p) (integerp asynchronous))
3978 (apply 'start-file-process "*Async Shell*" buffer args)
3980 (pop-to-buffer output-buffer)
3981 (setq mode-line-process '(":%s"))
3982 (require 'shell) (shell-mode))
3986 (apply 'process-file (car args) nil buffer nil (cdr args))
3987 ;; Insert error messages if they were separated.
3988 (when (listp buffer)
3989 (with-current-buffer error-buffer
3990 (insert-file-contents (cadr buffer)))
3991 (delete-file (cadr buffer)))
3992 (if current-buffer-p
3993 ;; This is like exchange-point-and-mark, but doesn't
3994 ;; activate the mark. It is cleaner to avoid activation,
3995 ;; even though the command loop would deactivate the mark
3996 ;; because we inserted text.
3997 (goto-char (prog1 (mark t)
3998 (set-marker (mark-marker) (point)
4000 ;; There's some output, display it.
4001 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
4002 (if (functionp 'display-message-or-buffer)
4003 (funcall (symbol-function 'display-message-or-buffer)
4005 (pop-to-buffer output-buffer))))))))
4009 (defvar tramp-handle-file-local-copy-hook nil
4010 "Normal hook to be run at the end of `tramp-handle-file-local-copy'.")
4012 (defun tramp-handle-file-local-copy (filename)
4013 "Like `file-local-copy' for Tramp files."
4015 (with-parsed-tramp-file-name filename nil
4016 (unless (file-exists-p filename)
4019 "Cannot make local copy of non-existing file `%s'" filename))
4021 (let ((rem-enc (tramp-get-remote-coding v "remote-encoding"))
4022 (loc-dec (tramp-get-local-coding v "local-decoding"))
4023 (tmpfile (tramp-compat-make-temp-file filename)))
4027 ;; `copy-file' handles direct copy and out-of-band methods.
4028 ((or (tramp-local-host-p v)
4029 (and (tramp-method-out-of-band-p v)
4030 (> (nth 7 (file-attributes filename))
4031 tramp-copy-size-limit)))
4032 (copy-file filename tmpfile t t))
4034 ;; Use inline encoding for file transfer.
4037 (tramp-message v 5 "Encoding remote file %s..." filename)
4038 (tramp-barf-unless-okay
4040 (format "%s < %s" rem-enc (tramp-shell-quote-argument localname))
4041 "Encoding remote file failed")
4042 (tramp-message v 5 "Encoding remote file %s...done" filename)
4044 (if (and (symbolp loc-dec) (fboundp loc-dec))
4045 ;; If local decoding is a function, we call it. We
4046 ;; must disable multibyte, because
4047 ;; `uudecode-decode-region' doesn't handle it
4050 (set-buffer-multibyte nil)
4051 (insert-buffer-substring (tramp-get-buffer v))
4053 v 5 "Decoding remote file %s with function %s..."
4055 (funcall loc-dec (point-min) (point-max))
4056 (let ((coding-system-for-write 'binary))
4057 (write-region (point-min) (point-max) tmpfile)))
4059 ;; If tramp-decoding-function is not defined for this
4060 ;; method, we invoke tramp-decoding-command instead.
4061 (let ((tmpfile2 (tramp-compat-make-temp-file filename)))
4062 (let ((coding-system-for-write 'binary))
4063 (write-region (point-min) (point-max) tmpfile2))
4065 v 5 "Decoding remote file %s with command %s..."
4068 (tramp-call-local-coding-command loc-dec tmpfile2 tmpfile)
4069 (delete-file tmpfile2))))
4071 (tramp-message v 5 "Decoding remote file %s...done" filename)
4072 ;; Set proper permissions.
4073 (set-file-modes tmpfile (file-modes filename))
4074 ;; Set local user ownership.
4075 (tramp-set-file-uid-gid tmpfile)))
4077 ;; Oops, I don't know what to do.
4079 v 'file-error "Wrong method specification for `%s'" method)))
4083 (delete-file tmpfile)
4084 (signal (car err) (cdr err))))
4086 (run-hooks 'tramp-handle-file-local-copy-hook)
4089 (defun tramp-handle-file-remote-p (filename &optional identification connected)
4090 "Like `file-remote-p' for Tramp files."
4091 (when (tramp-tramp-file-p filename)
4092 (with-parsed-tramp-file-name filename nil
4093 (and (or (not connected)
4094 (let ((p (tramp-get-connection-process v)))
4095 (and p (processp p) (memq (process-status p) '(run open)))))
4097 ((eq identification 'method) method)
4098 ((eq identification 'user) user)
4099 ((eq identification 'host) host)
4100 ((eq identification 'localname) localname)
4101 (t (tramp-make-tramp-file-name method user host "")))))))
4103 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
4104 "Like `find-operation-coding-system' for Tramp filenames.
4105 Tramp's `insert-file-contents' and `write-region' work over
4106 temporary file names. If `file-coding-system-alist' contains an
4107 expression, which matches more than the file name suffix, the
4108 coding system might not be determined. This function repairs it."
4110 (dolist (elt file-coding-system-alist result)
4111 (when (and (consp elt) (string-match (car elt) filename))
4112 ;; We found a matching entry in `file-coding-system-alist'.
4113 ;; So we add a similar entry, but with the temporary file name
4116 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
4118 (defun tramp-handle-insert-file-contents
4119 (filename &optional visit beg end replace)
4120 "Like `insert-file-contents' for Tramp files."
4121 (barf-if-buffer-read-only)
4122 (setq filename (expand-file-name filename))
4123 (let (coding-system-used result)
4124 (with-parsed-tramp-file-name filename nil
4126 (if (not (file-exists-p filename))
4129 (setq buffer-file-name filename)
4130 (set-visited-file-modtime)
4131 (set-buffer-modified-p nil))
4132 ;; We don't raise a Tramp error, because it might be
4133 ;; suppressed, like in `find-file-noselect-1'.
4134 (signal 'file-error (list "File not found on remote host" filename))
4135 (list (expand-file-name filename) 0))
4137 (if (and (tramp-local-host-p v)
4138 (let (file-name-handler-alist) (file-readable-p localname)))
4139 ;; Short track: if we are on the local host, we can run directly.
4141 (tramp-run-real-handler
4142 'insert-file-contents
4143 (list localname visit beg end replace)))
4145 ;; `insert-file-contents-literally' takes care to avoid calling
4146 ;; jka-compr. By let-binding inhibit-file-name-operation, we
4147 ;; propagate that care to the file-local-copy operation.
4149 (let ((inhibit-file-name-operation
4150 (when (eq inhibit-file-name-operation
4151 'insert-file-contents)
4153 (file-local-copy filename))))
4154 (tramp-message v 4 "Inserting local temp file `%s'..." local-copy)
4155 ;; We must ensure that `file-coding-system-alist' matches
4158 (let ((file-coding-system-alist
4159 (tramp-find-file-name-coding-system-alist
4160 filename local-copy)))
4162 (insert-file-contents local-copy nil beg end replace))
4163 ;; Now `last-coding-system-used' has right value. Remember it.
4164 (when (boundp 'last-coding-system-used)
4165 (setq coding-system-used
4166 (symbol-value 'last-coding-system-used))))
4167 (delete-file local-copy))
4169 v 4 "Inserting local temp file `%s'...done" local-copy)
4170 (when (boundp 'last-coding-system-used)
4171 (set 'last-coding-system-used coding-system-used))))
4174 (setq buffer-read-only (not (file-writable-p filename)))
4175 (setq buffer-file-name filename)
4176 (set-visited-file-modtime)
4177 (set-buffer-modified-p nil))
4178 (list (expand-file-name filename)
4181 ;; This is needed for XEmacs only. Code stolen from files.el.
4182 (defun tramp-handle-insert-file-contents-literally
4183 (filename &optional visit beg end replace)
4184 "Like `insert-file-contents-literally' for Tramp files."
4185 (let ((format-alist nil)
4186 (after-insert-file-functions nil)
4187 (coding-system-for-read 'no-conversion)
4188 (coding-system-for-write 'no-conversion)
4189 (find-buffer-file-type-function
4190 (if (fboundp 'find-buffer-file-type)
4191 (symbol-function 'find-buffer-file-type)
4193 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
4194 (inhibit-file-name-operation 'insert-file-contents))
4197 (fset 'find-buffer-file-type (lambda (filename) t))
4198 (insert-file-contents filename visit beg end replace))
4199 (if find-buffer-file-type-function
4200 (fset 'find-buffer-file-type find-buffer-file-type-function)
4201 (fmakunbound 'find-buffer-file-type)))))
4203 (defun tramp-handle-find-backup-file-name (filename)
4204 "Like `find-backup-file-name' for Tramp files."
4205 (with-parsed-tramp-file-name filename nil
4206 ;; We set both variables. It doesn't matter whether it is
4208 (let ((backup-directory-alist
4210 (when (boundp 'backup-directory-alist)
4211 (if (boundp 'tramp-backup-directory-alist)
4216 (if (and (stringp (cdr x))
4217 (file-name-absolute-p (cdr x))
4218 (not (tramp-file-name-p (cdr x))))
4219 (tramp-make-tramp-file-name method user host (cdr x))
4221 (symbol-value 'tramp-backup-directory-alist))
4222 (symbol-value 'backup-directory-alist))))
4224 (bkup-backup-directory-info
4226 (when (boundp 'bkup-backup-directory-info)
4227 (if (boundp 'tramp-bkup-backup-directory-info)
4233 (if (and (stringp (car (cdr x)))
4234 (file-name-absolute-p (car (cdr x)))
4235 (not (tramp-file-name-p (car (cdr x)))))
4236 (tramp-make-tramp-file-name
4237 method user host (car (cdr x)))
4240 (symbol-value 'tramp-bkup-backup-directory-info))
4241 (symbol-value 'bkup-backup-directory-info)))))
4243 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
4245 (defun tramp-handle-make-auto-save-file-name ()
4246 "Like `make-auto-save-file-name' for Tramp files.
4247 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
4248 (let ((tramp-auto-save-directory tramp-auto-save-directory)
4250 (tramp-subst-strs-in-string
4257 (buffer-file-name))))
4258 ;; File name must be unique. This is ensured with Emacs 22 (see
4259 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
4260 ;; all other cases we must do it ourselves.
4261 (when (boundp 'auto-save-file-name-transforms)
4264 (when (and (string-match (car x) buffer-file-name)
4265 (not (car (cddr x))))
4266 (setq tramp-auto-save-directory
4267 (or tramp-auto-save-directory
4268 (tramp-compat-temporary-file-directory)))))
4269 (symbol-value 'auto-save-file-name-transforms)))
4270 ;; Create directory.
4271 (when tramp-auto-save-directory
4272 (setq buffer-file-name
4273 (expand-file-name buffer-file-name tramp-auto-save-directory))
4274 (unless (file-exists-p tramp-auto-save-directory)
4275 (make-directory tramp-auto-save-directory t)))
4276 ;; Run plain `make-auto-save-file-name'. There might be an advice when
4277 ;; it is not a magic file name operation (since Emacs 22).
4278 ;; We must deactivate it temporarily.
4279 (if (not (ad-is-active 'make-auto-save-file-name))
4280 (tramp-run-real-handler 'make-auto-save-file-name nil)
4282 (ad-deactivate 'make-auto-save-file-name)
4284 (tramp-run-real-handler 'make-auto-save-file-name nil)
4285 (ad-activate 'make-auto-save-file-name)))))
4287 (defvar tramp-handle-write-region-hook nil
4288 "Normal hook to be run at the end of `tramp-handle-write-region'.")
4290 ;; CCC grok APPEND, LOCKNAME
4291 (defun tramp-handle-write-region
4292 (start end filename &optional append visit lockname confirm)
4293 "Like `write-region' for Tramp files."
4294 (setq filename (expand-file-name filename))
4295 (with-parsed-tramp-file-name filename nil
4296 (unless (null append)
4298 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
4299 ;; Following part commented out because we don't know what to do about
4300 ;; file locking, and it does not appear to be a problem to ignore it.
4301 ;; Ange-ftp ignores it, too.
4302 ;; (when (and lockname (stringp lockname))
4303 ;; (setq lockname (expand-file-name lockname)))
4304 ;; (unless (or (eq lockname nil)
4305 ;; (string= lockname filename))
4307 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
4309 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
4310 (when (and (not (featurep 'xemacs)) confirm (file-exists-p filename))
4311 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename))
4312 (tramp-error v 'file-error "File not overwritten")))
4314 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename 'integer))
4315 (tramp-get-remote-uid v 'integer)))
4316 (gid (or (nth 3 (tramp-compat-file-attributes filename 'integer))
4317 (tramp-get-remote-gid v 'integer))))
4319 (if (and (tramp-local-host-p v)
4320 ;; `file-writable-p' calls 'file-expand-file-name'. We
4321 ;; cannot use `tramp-run-real-handler' therefore.
4322 (let (file-name-handler-alist)
4324 (file-writable-p (file-name-directory localname))
4325 (or (file-directory-p localname)
4326 (file-writable-p localname)))))
4327 ;; Short track: if we are on the local host, we can run directly.
4328 (tramp-run-real-handler
4330 (list start end localname append 'no-message lockname confirm))
4332 (let ((rem-dec (tramp-get-remote-coding v "remote-decoding"))
4333 (loc-enc (tramp-get-local-coding v "local-encoding"))
4334 (modes (save-excursion (file-modes filename)))
4335 ;; We use this to save the value of
4336 ;; `last-coding-system-used' after writing the tmp file.
4337 ;; At the end of the function, we set
4338 ;; `last-coding-system-used' to this saved value. This
4339 ;; way, any intermediary coding systems used while
4340 ;; talking to the remote shell or suchlike won't hose
4341 ;; this variable. This approach was snarfed from
4344 ;; Write region into a tmp file. This isn't really
4345 ;; needed if we use an encoding function, but currently
4346 ;; we use it always because this makes the logic
4348 (tmpfile (tramp-compat-make-temp-file filename)))
4350 ;; We say `no-message' here because we don't want the
4351 ;; visited file modtime data to be clobbered from the temp
4352 ;; file. We call `set-visited-file-modtime' ourselves later
4353 ;; on. We must ensure that `file-coding-system-alist'
4354 ;; matches `tmpfile'.
4355 (let ((file-coding-system-alist
4356 (tramp-find-file-name-coding-system-alist filename tmpfile)))
4358 (tramp-run-real-handler
4360 (list start end tmpfile append 'no-message lockname confirm))
4362 (delete-file tmpfile)
4363 (signal (car err) (cdr err))))
4365 ;; Now, `last-coding-system-used' has the right value. Remember it.
4366 (when (boundp 'last-coding-system-used)
4367 (setq coding-system-used
4368 (symbol-value 'last-coding-system-used))))
4370 ;; The permissions of the temporary file should be set. If
4371 ;; filename does not exist (eq modes nil) it has been
4372 ;; renamed to the backup file. This case `save-buffer'
4373 ;; handles permissions.
4374 (when modes (set-file-modes tmpfile modes))
4376 ;; This is a bit lengthy due to the different methods
4377 ;; possible for file transfer. First, we check whether the
4378 ;; method uses an rcp program. If so, we call it.
4379 ;; Otherwise, both encoding and decoding command must be
4380 ;; specified. However, if the method _also_ specifies an
4381 ;; encoding function, then that is used for encoding the
4382 ;; contents of the tmp file.
4384 ;; `rename-file' handles direct copy and out-of-band methods.
4385 ((or (tramp-local-host-p v)
4386 (and (tramp-method-out-of-band-p v)
4387 (> (- (or end (point-max)) (or start (point-min)))
4388 tramp-copy-size-limit)))
4390 (rename-file tmpfile filename t)
4392 (delete-file tmpfile)
4393 (signal (car err) (cdr err)))))
4395 ;; Use inline file transfer.
4398 (tramp-message v 5 "Encoding region...")
4401 ;; Use encoding function or command.
4402 (if (and (symbolp loc-enc) (fboundp loc-enc))
4405 v 5 "Encoding region using function `%s'..."
4406 (symbol-name loc-enc))
4407 (let ((coding-system-for-read 'binary))
4408 (insert-file-contents-literally tmpfile))
4409 ;; CCC. The following `let' is a workaround
4410 ;; for the base64.el that comes with
4411 ;; pgnus-0.84. If both of the following
4412 ;; conditions are satisfied, it tries to write
4413 ;; to a local file in default-directory, but
4414 ;; at this point, default-directory is remote.
4415 ;; (`call-process-region' can't write to remote
4416 ;; files, it seems.) The file in question is
4417 ;; a tmp file anyway.
4418 (let ((default-directory
4419 (tramp-compat-temporary-file-directory)))
4420 (funcall loc-enc (point-min) (point-max))))
4423 v 5 "Encoding region using command `%s'..." loc-enc)
4424 (unless (equal 0 (tramp-call-local-coding-command
4428 "Cannot write to `%s', local encoding command `%s' failed"
4431 ;; Send buffer into remote decoding command which
4432 ;; writes to remote file. Because this happens on
4433 ;; the remote host, we cannot use the function.
4434 (goto-char (point-max))
4435 (unless (bolp) (newline))
4437 v 5 "Decoding region into remote file %s..." filename)
4441 "%s >%s <<'EOF'\n%sEOF"
4443 (tramp-shell-quote-argument localname)
4445 (tramp-barf-unless-okay
4447 "Couldn't write region to `%s', decode using `%s' failed"
4449 ;; When `file-precious-flag' is set, the region is
4450 ;; written to a temporary file. Check that the
4451 ;; checksum is equal to that from the local tmpfile.
4452 (when file-precious-flag
4455 ;; cksum runs locally, if possible.
4456 (zerop (tramp-local-call-process "cksum" tmpfile t))
4457 ;; cksum runs remotely.
4459 (tramp-send-command-and-check
4462 "cksum <%s" (tramp-shell-quote-argument localname))))
4463 ;; ... they are different.
4467 (with-current-buffer (tramp-get-buffer v)
4471 (concat "Couldn't write region to `%s',"
4472 " decode using `%s' failed")
4475 v 5 "Decoding region into remote file %s...done" filename)
4476 (tramp-flush-file-property v localname))
4479 (delete-file tmpfile)))
4481 ;; That's not expected.
4485 (concat "Method `%s' should specify both encoding and "
4486 "decoding command or an rcp program")
4489 ;; Make `last-coding-system-used' have the right value.
4490 (when coding-system-used
4491 (set 'last-coding-system-used coding-system-used))))
4493 ;; We must protect `last-coding-system-used', now we have set it
4494 ;; to its correct value.
4495 (let (last-coding-system-used)
4496 ;; Set file modification time.
4497 (when (or (eq visit t) (stringp visit))
4498 (set-visited-file-modtime
4499 ;; We must pass modtime explicitely, because filename can
4500 ;; be different from (buffer-file-name), f.e. if
4501 ;; `file-precious-flag' is set.
4502 (nth 5 (file-attributes filename))))
4504 ;; Set the ownership.
4505 (tramp-set-file-uid-gid filename uid gid)
4506 (when (or (eq visit t) (null visit) (stringp visit))
4507 (tramp-message v 0 "Wrote %s" filename))
4508 (run-hooks 'tramp-handle-write-region-hook)))))
4511 (progn (defun tramp-run-real-handler (operation args)
4512 "Invoke normal file name handler for OPERATION.
4513 First arg specifies the OPERATION, second arg is a list of arguments to
4514 pass to the OPERATION."
4515 (let* ((inhibit-file-name-handlers
4516 `(tramp-file-name-handler
4517 tramp-completion-file-name-handler
4518 cygwin-mount-name-hook-function
4519 cygwin-mount-map-drive-hook-function
4521 ,(and (eq inhibit-file-name-operation operation)
4522 inhibit-file-name-handlers)))
4523 (inhibit-file-name-operation operation))
4524 (apply operation args))))
4527 (progn (defun tramp-completion-run-real-handler (operation args)
4528 "Invoke `tramp-file-name-handler' for OPERATION.
4529 First arg specifies the OPERATION, second arg is a list of arguments to
4530 pass to the OPERATION."
4531 (let* ((inhibit-file-name-handlers
4532 `(tramp-completion-file-name-handler
4533 cygwin-mount-name-hook-function
4534 cygwin-mount-map-drive-hook-function
4536 ,(and (eq inhibit-file-name-operation operation)
4537 inhibit-file-name-handlers)))
4538 (inhibit-file-name-operation operation))
4539 (apply operation args))))
4541 ;; We handle here all file primitives. Most of them have the file
4542 ;; name as first parameter; nevertheless we check for them explicitly
4543 ;; in order to be signaled if a new primitive appears. This
4544 ;; scenario is needed because there isn't a way to decide by
4545 ;; syntactical means whether a foreign method must be called. It would
4546 ;; ease the life if `file-name-handler-alist' would support a decision
4547 ;; function as well but regexp only.
4548 (defun tramp-file-name-for-operation (operation &rest args)
4549 "Return file name related to OPERATION file primitive.
4550 ARGS are the arguments OPERATION has been called with."
4552 ; FILE resp DIRECTORY
4554 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
4555 'delete-file 'diff-latest-backup-file 'directory-file-name
4556 'directory-files 'directory-files-and-attributes
4557 'dired-compress-file 'dired-uncache
4558 'file-accessible-directory-p 'file-attributes
4559 'file-directory-p 'file-executable-p 'file-exists-p
4560 'file-local-copy 'file-remote-p 'file-modes
4561 'file-name-as-directory 'file-name-directory
4562 'file-name-nondirectory 'file-name-sans-versions
4563 'file-ownership-preserved-p 'file-readable-p
4564 'file-regular-p 'file-symlink-p 'file-truename
4565 'file-writable-p 'find-backup-file-name 'find-file-noselect
4566 'get-file-buffer 'insert-directory 'insert-file-contents
4567 'load 'make-directory 'make-directory-internal
4568 'set-file-modes 'substitute-in-file-name
4569 'unhandled-file-name-directory 'vc-registered
4573 'abbreviate-file-name 'create-file-buffer
4574 'dired-file-modtime 'dired-make-compressed-filename
4575 'dired-recursive-delete-directory 'dired-set-file-modtime
4576 'dired-shell-unhandle-file-name 'dired-uucode-file
4577 'insert-file-contents-literally 'make-temp-name 'recover-file
4578 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
4579 (if (file-name-absolute-p (nth 0 args))
4581 (expand-file-name (nth 0 args))))
4582 ; FILE DIRECTORY resp FILE1 FILE2
4584 (list 'add-name-to-file 'copy-file 'expand-file-name
4585 'file-name-all-completions 'file-name-completion
4586 'file-newer-than-file-p 'make-symbolic-link 'rename-file
4588 'dired-make-relative-symlink
4589 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
4592 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
4593 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
4594 (t (buffer-file-name (current-buffer))))))
4596 ((eq operation 'write-region)
4600 (list 'set-visited-file-modtime 'verify-visited-file-modtime
4601 ; since Emacs 22 only
4602 'make-auto-save-file-name
4606 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
4609 (list ; not in Emacs 23
4613 ; since Emacs 22 only
4615 ; since Emacs 23 only
4618 'dired-print-file 'dired-shell-call-process
4620 'executable-find 'start-process 'call-process))
4622 ; unknown file primitive
4623 (t (error "unknown file I/O primitive: %s" operation))))
4625 (defun tramp-find-foreign-file-name-handler (filename)
4626 "Return foreign file name handler if exists."
4627 (when (and (stringp filename) (tramp-tramp-file-p filename))
4628 (let ((v (tramp-dissect-file-name filename t))
4629 (handler tramp-foreign-file-name-handler-alist)
4631 ;; When we are not fully sure that filename completion is safe,
4632 ;; we should not return a handler.
4633 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
4634 (and (tramp-file-name-host v)
4635 (not (member (tramp-file-name-host v)
4636 (mapcar 'car tramp-methods))))
4637 (not (tramp-completion-mode-p)))
4639 (setq elt (car handler)
4640 handler (cdr handler))
4641 (when (funcall (car elt) filename)
4648 (defun tramp-file-name-handler (operation &rest args)
4649 "Invoke Tramp file name handler.
4650 Falls back to normal file name handler if no Tramp file name handler exists."
4654 (tramp-replace-environment-variables
4655 (apply 'tramp-file-name-for-operation operation args)))
4656 (completion (tramp-completion-mode-p))
4657 (foreign (tramp-find-foreign-file-name-handler filename)))
4658 (with-parsed-tramp-file-name filename nil
4660 ;; When we are in completion mode, some operations
4661 ;; shouldn't be handled by backend.
4662 ((and completion (zerop (length localname))
4663 (memq operation '(file-exists-p file-directory-p)))
4665 ((and completion (zerop (length localname))
4666 (memq operation '(file-name-as-directory)))
4668 ;; Call the backend function.
4669 (foreign (apply foreign operation args))
4670 ;; Nothing to do for us.
4671 (t (tramp-run-real-handler operation args))))))
4672 ;; When `tramp-mode' is not enabled, we don't do anything.
4673 (tramp-run-real-handler operation args)))
4675 ;; In Emacs, there is some concurrency due to timers. If a timer
4676 ;; interrupts Tramp and wishes to use the same connection buffer as
4677 ;; the "main" Emacs, then garbage might occur in the connection
4678 ;; buffer. Therefore, we need to make sure that a timer does not use
4679 ;; the same connection buffer as the "main" Emacs. We implement a
4680 ;; cheap global lock, instead of locking each connection buffer
4681 ;; separately. The global lock is based on two variables,
4682 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
4683 ;; (with setq) to indicate a lock. But Tramp also calls itself during
4684 ;; processing of a single file operation, so we need to allow
4685 ;; recursive calls. That's where the `tramp-locker' variable comes in
4686 ;; -- it is let-bound to t during the execution of the current
4687 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
4688 ;; then we should just proceed because we have been called
4689 ;; recursively. But if `tramp-locker' is nil, then we are a timer
4690 ;; interrupting the "main" Emacs, and then we signal an error.
4692 (defvar tramp-locked nil
4693 "If non-nil, then Tramp is currently busy.
4694 Together with `tramp-locker', this implements a locking mechanism
4695 preventing reentrant calls of Tramp.")
4697 (defvar tramp-locker nil
4698 "If non-nil, then a caller has locked Tramp.
4699 Together with `tramp-locked', this implements a locking mechanism
4700 preventing reentrant calls of Tramp.")
4702 (defun tramp-sh-file-name-handler (operation &rest args)
4703 "Invoke remote-shell Tramp file name handler.
4704 Fall back to normal file name handler if no Tramp handler exists."
4705 (when (and tramp-locked (not tramp-locker))
4706 (setq tramp-locked nil)
4707 (signal 'file-error (list "Forbidden reentrant call of Tramp")))
4708 (let ((tl tramp-locked))
4711 (setq tramp-locked t)
4712 (let ((tramp-locker t))
4714 (let ((fn (assoc operation tramp-file-name-handler-alist)))
4716 (apply (cdr fn) args)
4717 (tramp-run-real-handler operation args))))))
4718 (setq tramp-locked tl))))
4721 (progn (defun tramp-completion-file-name-handler (operation &rest args)
4722 "Invoke Tramp file name completion handler.
4723 Falls back to normal file name handler if no Tramp file name handler exists."
4724 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
4725 ;; would otherwise use backslash.
4726 (let ((directory-sep-char ?/)
4727 (fn (assoc operation tramp-completion-file-name-handler-alist)))
4728 ;; When `tramp-mode' is not enabled, we don't do anything.
4729 (if (and fn tramp-mode)
4730 (save-match-data (apply (cdr fn) args))
4731 (tramp-completion-run-real-handler operation args)))))
4734 (defsubst tramp-register-file-name-handler ()
4735 "Add Tramp file name handler to `file-name-handler-alist'."
4736 ;; Remove autoloaded handler from file name handler alist. Useful,
4737 ;; if `tramp-syntax' has been changed.
4738 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
4739 (setq file-name-handler-alist (delete a1 file-name-handler-alist)))
4741 (add-to-list 'file-name-handler-alist
4742 (cons tramp-file-name-regexp 'tramp-file-name-handler))
4743 ;; If jka-compr is already loaded, move it to the front of
4744 ;; `file-name-handler-alist'.
4745 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4747 (setq file-name-handler-alist
4748 (cons jka (delete jka file-name-handler-alist))))))
4750 ;; `tramp-file-name-handler' must be registered before evaluation of
4751 ;; site-start and init files, because there might exist remote files
4752 ;; already, f.e. files kept via recentf-mode.
4753 ;;;###autoload(tramp-register-file-name-handler)
4754 (tramp-register-file-name-handler)
4757 (defsubst tramp-register-completion-file-name-handler ()
4758 "Add Tramp completion file name handler to `file-name-handler-alist'."
4759 ;; Remove autoloaded handler from file name handler alist. Useful,
4760 ;; if `tramp-syntax' has been changed.
4762 'tramp-completion-file-name-handler file-name-handler-alist)))
4763 (setq file-name-handler-alist (delete a1 file-name-handler-alist)))
4764 ;; `partial-completion-mode' is unknown in XEmacs. So we should
4765 ;; load it unconditionally there. In the GNU Emacs case, method/
4766 ;; user/host name completion shall be bound to `partial-completion-mode'.
4767 ;; `ido-mode' and `icy-mode' are other packages which extend file
4769 (when (or (not (boundp 'partial-completion-mode))
4770 (symbol-value 'partial-completion-mode)
4772 (featurep 'icicles))
4773 (add-to-list 'file-name-handler-alist
4774 (cons tramp-completion-file-name-regexp
4775 'tramp-completion-file-name-handler))
4776 (put 'tramp-completion-file-name-handler 'safe-magic t))
4777 ;; If jka-compr is already loaded, move it to the front of
4778 ;; `file-name-handler-alist'.
4779 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4781 (setq file-name-handler-alist
4782 (cons jka (delete jka file-name-handler-alist))))))
4784 ;; During autoload, it shall be checked whether
4785 ;; `partial-completion-mode' is active. Therefore registering of
4786 ;; `tramp-completion-file-name-handler' will be delayed.
4787 ;;;###autoload(add-hook
4788 ;;;###autoload 'after-init-hook
4789 ;;;###autoload 'tramp-register-completion-file-name-handler)
4790 (tramp-register-completion-file-name-handler)
4793 (defun tramp-unload-file-name-handlers ()
4794 (setq file-name-handler-alist
4795 (delete (rassoc 'tramp-file-name-handler
4796 file-name-handler-alist)
4797 (delete (rassoc 'tramp-completion-file-name-handler
4798 file-name-handler-alist)
4799 file-name-handler-alist))))
4801 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
4803 ;;; File name handler functions for completion mode:
4805 (defvar tramp-completion-mode nil
4806 "If non-nil, external packages signal that they are in file name completion.
4808 This is necessary, because Tramp uses a heuristic depending on last
4809 input event. This fails when external packages use other characters
4810 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
4811 should never be set globally, the intention is to let-bind it.")
4813 ;; Necessary because `tramp-file-name-regexp-unified' and
4814 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
4815 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
4816 ;; to `tramp-file-name-handler'). Otherwise, it takes
4817 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
4818 ;; risky, because completing a file might require loading other files,
4819 ;; like "~/.netrc", and for them it shouldn't be decided based on that
4820 ;; variable. On the other hand, those files shouldn't have partial
4821 ;; Tramp file name syntax. Maybe another variable should be introduced
4822 ;; overwriting this check in such cases. Or we change Tramp file name
4823 ;; syntax in order to avoid ambiguities, like in XEmacs ...
4824 (defun tramp-completion-mode-p ()
4825 "Checks whether method / user name / host name completion is active."
4827 ;; Signal from outside.
4828 tramp-completion-mode
4830 (equal last-input-event 'tab)
4831 (and (natnump last-input-event)
4833 ;; ?\t has event-modifier 'control.
4834 (equal last-input-event ?\t)
4835 (and (not (event-modifiers last-input-event))
4836 (or (equal last-input-event ?\?)
4837 (equal last-input-event ?\ )))))
4839 (and (featurep 'xemacs)
4840 ;; `last-input-event' might be nil.
4841 (not (null last-input-event))
4842 ;; `last-input-event' may have no character approximation.
4843 (funcall (symbol-function 'event-to-character) last-input-event)
4845 ;; ?\t has event-modifier 'control.
4847 (funcall (symbol-function 'event-to-character)
4848 last-input-event) ?\t)
4849 (and (not (event-modifiers last-input-event))
4851 (funcall (symbol-function 'event-to-character)
4852 last-input-event) ?\?)
4854 (funcall (symbol-function 'event-to-character)
4855 last-input-event) ?\ )))))))
4857 ;; Method, host name and user name completion.
4858 ;; `tramp-completion-dissect-file-name' returns a list of
4859 ;; tramp-file-name structures. For all of them we return possible completions.
4861 (defun tramp-completion-handle-file-name-all-completions (filename directory)
4862 "Like `file-name-all-completions' for partial Tramp files."
4864 (let* ((fullname (tramp-drop-volume-letter
4865 (expand-file-name filename directory)))
4866 ;; Possible completion structures.
4867 (v (tramp-completion-dissect-file-name fullname))
4871 (let* ((car (car v))
4872 (method (tramp-file-name-method car))
4873 (user (tramp-file-name-user car))
4874 (host (tramp-file-name-host car))
4875 (localname (tramp-file-name-localname car))
4876 (m (tramp-find-method method user host))
4877 (tramp-current-user user) ; see `tramp-parse-passwd'
4880 (unless localname ;; Nothing to complete.
4884 ;; Method dependent user / host combinations.
4888 (setq all-user-hosts
4889 (append all-user-hosts
4890 (funcall (nth 0 x) (nth 1 x)))))
4891 (tramp-get-completion-function m))
4897 (tramp-get-completion-user-host
4898 method user host (nth 0 x) (nth 1 x)))
4899 (delq nil all-user-hosts)))))
4901 ;; Possible methods.
4903 (append result (tramp-get-completion-methods m)))))
4907 ;; Unify list, remove nil elements.
4909 (let ((car (car result)))
4913 (substring car (length (tramp-drop-volume-letter directory)))))
4914 (setq result (cdr result))))
4916 ;; Complete local parts.
4920 (tramp-completion-run-real-handler
4921 'file-name-all-completions (list filename directory))
4924 ;; Method, host name and user name completion for a file.
4926 (defun tramp-completion-handle-file-name-completion
4927 (filename directory &optional predicate)
4928 "Like `file-name-completion' for Tramp files."
4931 (mapcar 'list (file-name-all-completions filename directory))
4933 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
4935 ;; I misuse a little bit the tramp-file-name structure in order to handle
4936 ;; completion possibilities for partial methods / user names / host names.
4937 ;; Return value is a list of tramp-file-name structures according to possible
4938 ;; completions. If "localname" is non-nil it means there
4939 ;; shouldn't be a completion anymore.
4941 ;; Expected results:
4943 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
4944 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
4945 ;; [nil "x" nil nil]
4946 ;; ["x" nil nil nil]
4948 ;; "/x:" "/x:y" "/x:y:"
4949 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
4951 ;; ["x" nil "" nil] ["x" nil "y" nil]
4952 ;; ["x" "" nil nil] ["x" "y" nil nil]
4954 ;; "/x:y@" "/x:y@z" "/x:y@z:"
4955 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
4956 ;; "/[x/y@" "/[x/y@z"
4957 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
4958 (defun tramp-completion-dissect-file-name (name)
4959 "Returns a list of `tramp-file-name' structures.
4960 They are collected by `tramp-completion-dissect-file-name1'."
4964 (tramp-completion-ipv6-regexp
4967 (if (zerop (length tramp-postfix-ipv6-format))
4968 tramp-postfix-host-format
4969 tramp-postfix-ipv6-format)))
4970 ;; "/method" "/[method"
4971 (tramp-completion-file-name-structure1
4972 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
4975 (tramp-completion-file-name-structure2
4976 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
4979 (tramp-completion-file-name-structure3
4980 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
4982 ;; "/[ipv6" "/[ipv6"
4983 (tramp-completion-file-name-structure4
4984 (list (concat tramp-prefix-regexp
4985 tramp-prefix-ipv6-regexp
4986 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
4988 ;; "/user@host" "/[user@host"
4989 (tramp-completion-file-name-structure5
4990 (list (concat tramp-prefix-regexp
4991 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4992 "\\(" tramp-host-regexp x-nil "\\)$")
4994 ;; "/user@[ipv6" "/[user@ipv6"
4995 (tramp-completion-file-name-structure6
4996 (list (concat tramp-prefix-regexp
4997 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4998 tramp-prefix-ipv6-regexp
4999 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5001 ;; "/method:user" "/[method/user" "/method://user"
5002 (tramp-completion-file-name-structure7
5003 (list (concat tramp-prefix-regexp
5004 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5005 "\\(" tramp-user-regexp x-nil "\\)$")
5007 ;; "/method:host" "/[method/host" "/method://host"
5008 (tramp-completion-file-name-structure8
5009 (list (concat tramp-prefix-regexp
5010 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5011 "\\(" tramp-host-regexp x-nil "\\)$")
5013 ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6"
5014 (tramp-completion-file-name-structure9
5015 (list (concat tramp-prefix-regexp
5016 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5017 tramp-prefix-ipv6-regexp
5018 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5020 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
5021 (tramp-completion-file-name-structure10
5022 (list (concat tramp-prefix-regexp
5023 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5024 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5025 "\\(" tramp-host-regexp x-nil "\\)$")
5027 ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6"
5028 (tramp-completion-file-name-structure11
5029 (list (concat tramp-prefix-regexp
5030 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5031 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5032 tramp-prefix-ipv6-regexp
5033 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5035 ;; "/method: "/method:/"
5036 (tramp-completion-file-name-structure12
5038 (if (equal tramp-syntax 'url)
5039 (concat tramp-prefix-regexp
5040 "\\(" tramp-method-regexp "\\)"
5041 "\\(" (substring tramp-postfix-method-regexp 0 1)
5042 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
5044 ;; Should not match if not URL syntax.
5045 (concat tramp-prefix-regexp "/$"))
5047 ;; "/method: "/method:/"
5048 (tramp-completion-file-name-structure13
5050 (if (equal tramp-syntax 'url)
5051 (concat tramp-prefix-regexp
5052 "\\(" tramp-method-regexp "\\)"
5053 "\\(" (substring tramp-postfix-method-regexp 0 1)
5054 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
5056 ;; Should not match if not URL syntax.
5057 (concat tramp-prefix-regexp "/$"))
5060 (mapc (lambda (regexp)
5061 (add-to-list 'result
5062 (tramp-completion-dissect-file-name1 regexp name)))
5064 tramp-completion-file-name-structure1
5065 tramp-completion-file-name-structure2
5066 tramp-completion-file-name-structure3
5067 tramp-completion-file-name-structure4
5068 tramp-completion-file-name-structure5
5069 tramp-completion-file-name-structure6
5070 tramp-completion-file-name-structure7
5071 tramp-completion-file-name-structure8
5072 tramp-completion-file-name-structure9
5073 tramp-completion-file-name-structure10
5074 tramp-completion-file-name-structure11
5075 tramp-completion-file-name-structure12
5076 tramp-completion-file-name-structure13
5077 tramp-file-name-structure))
5081 (defun tramp-completion-dissect-file-name1 (structure name)
5082 "Returns a `tramp-file-name' structure matching STRUCTURE.
5083 The structure consists of remote method, remote user,
5084 remote host and localname (filename on remote host)."
5087 (when (string-match (nth 0 structure) name)
5088 (let ((method (and (nth 1 structure)
5089 (match-string (nth 1 structure) name)))
5090 (user (and (nth 2 structure)
5091 (match-string (nth 2 structure) name)))
5092 (host (and (nth 3 structure)
5093 (match-string (nth 3 structure) name)))
5094 (localname (and (nth 4 structure)
5095 (match-string (nth 4 structure) name))))
5096 (vector method user host localname)))))
5098 ;; This function returns all possible method completions, adding the
5099 ;; trailing method delimeter.
5100 (defun tramp-get-completion-methods (partial-method)
5101 "Returns all method completions for PARTIAL-METHOD."
5105 (string-match (concat "^" (regexp-quote partial-method)) method)
5106 (tramp-completion-make-tramp-file-name method nil nil nil)))
5107 (mapcar 'car tramp-methods)))
5109 ;; Compares partial user and host names with possible completions.
5110 (defun tramp-get-completion-user-host (method partial-user partial-host user host)
5111 "Returns the most expanded string for user and host name completion.
5112 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
5115 ((and partial-user partial-host)
5117 (string-match (concat "^" (regexp-quote partial-host)) host)
5118 (string-equal partial-user (or user partial-user)))
5119 (setq user partial-user)
5126 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
5132 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
5138 (unless (zerop (+ (length user) (length host)))
5139 (tramp-completion-make-tramp-file-name method user host nil)))
5141 (defun tramp-parse-rhosts (filename)
5142 "Return a list of (user host) tuples allowed to access.
5143 Either user or host may be nil."
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-rhosts-group) res))))
5156 (defun tramp-parse-rhosts-group ()
5157 "Return a (user host) tuple allowed to access.
5158 Either user or host may be nil."
5162 "^\\(" tramp-host-regexp "\\)"
5163 "\\([ \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 (append (list (match-string 3) (match-string 1)))))
5171 (defun tramp-parse-shosts (filename)
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))
5178 (when (file-readable-p filename)
5180 (insert-file-contents filename)
5181 (goto-char (point-min))
5183 (push (tramp-parse-shosts-group) res))))
5186 (defun tramp-parse-shosts-group ()
5187 "Return a (user host) tuple allowed to access.
5188 User is always nil."
5190 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
5191 (narrow-to-region (point) (tramp-compat-line-end-position))
5192 (when (re-search-forward regexp nil t)
5193 (setq result (list nil (match-string 1))))
5196 (> (skip-chars-forward ",") 0)
5200 (defun tramp-parse-sconfig (filename)
5201 "Return a list of (user host) tuples allowed to access.
5202 User is always nil."
5203 ;; On Windows, there are problems in completion when
5204 ;; `default-directory' is remote.
5205 (let ((default-directory (tramp-compat-temporary-file-directory))
5207 (when (file-readable-p filename)
5209 (insert-file-contents filename)
5210 (goto-char (point-min))
5212 (push (tramp-parse-sconfig-group) res))))
5215 (defun tramp-parse-sconfig-group ()
5216 "Return a (user host) tuple allowed to access.
5217 User is always nil."
5219 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)")))
5220 (narrow-to-region (point) (tramp-compat-line-end-position))
5221 (when (re-search-forward regexp nil t)
5222 (setq result (list nil (match-string 1))))
5225 (> (skip-chars-forward ",") 0)
5229 (defun tramp-parse-shostkeys (dirname)
5230 "Return a list of (user host) tuples allowed to access.
5231 User is always nil."
5232 ;; On Windows, there are problems in completion when
5233 ;; `default-directory' is remote.
5234 (let* ((default-directory (tramp-compat-temporary-file-directory))
5235 (regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$"))
5236 (files (when (file-directory-p dirname) (directory-files dirname)))
5239 (when (string-match regexp (car files))
5240 (push (list nil (match-string 1 (car files))) result))
5241 (setq files (cdr files)))
5244 (defun tramp-parse-sknownhosts (dirname)
5245 "Return a list of (user host) tuples allowed to access.
5246 User is always nil."
5247 ;; On Windows, there are problems in completion when
5248 ;; `default-directory' is remote.
5249 (let* ((default-directory (tramp-compat-temporary-file-directory))
5250 (regexp (concat "^\\(" tramp-host-regexp
5251 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
5252 (files (when (file-directory-p dirname) (directory-files dirname)))
5255 (when (string-match regexp (car files))
5256 (push (list nil (match-string 1 (car files))) result))
5257 (setq files (cdr files)))
5260 (defun tramp-parse-hosts (filename)
5261 "Return a list of (user host) tuples allowed to access.
5262 User is always nil."
5263 ;; On Windows, there are problems in completion when
5264 ;; `default-directory' is remote.
5265 (let ((default-directory (tramp-compat-temporary-file-directory))
5267 (when (file-readable-p filename)
5269 (insert-file-contents filename)
5270 (goto-char (point-min))
5272 (push (tramp-parse-hosts-group) res))))
5275 (defun tramp-parse-hosts-group ()
5276 "Return a (user host) tuple allowed to access.
5277 User is always nil."
5280 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)")))
5281 (narrow-to-region (point) (tramp-compat-line-end-position))
5282 (when (re-search-forward regexp nil t)
5283 (setq result (list nil (match-string 1))))
5286 (> (skip-chars-forward " \t") 0)
5290 ;; For su-alike methods it would be desirable to return "root@localhost"
5291 ;; as default. Unfortunately, we have no information whether any user name
5292 ;; has been typed already. So we use `tramp-current-user' as indication,
5293 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
5294 (defun tramp-parse-passwd (filename)
5295 "Return a list of (user host) tuples allowed to access.
5296 Host is always \"localhost\"."
5297 ;; On Windows, there are problems in completion when
5298 ;; `default-directory' is remote.
5299 (let ((default-directory (tramp-compat-temporary-file-directory))
5301 (if (zerop (length tramp-current-user))
5303 (when (file-readable-p filename)
5305 (insert-file-contents filename)
5306 (goto-char (point-min))
5308 (push (tramp-parse-passwd-group) res))))
5311 (defun tramp-parse-passwd-group ()
5312 "Return a (user host) tuple allowed to access.
5313 Host is always \"localhost\"."
5315 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
5316 (narrow-to-region (point) (tramp-compat-line-end-position))
5317 (when (re-search-forward regexp nil t)
5318 (setq result (list (match-string 1) "localhost")))
5323 (defun tramp-parse-netrc (filename)
5324 "Return a list of (user host) tuples allowed to access.
5326 ;; On Windows, there are problems in completion when
5327 ;; `default-directory' is remote.
5328 (let ((default-directory (tramp-compat-temporary-file-directory))
5330 (when (file-readable-p filename)
5332 (insert-file-contents filename)
5333 (goto-char (point-min))
5335 (push (tramp-parse-netrc-group) res))))
5338 (defun tramp-parse-netrc-group ()
5339 "Return a (user host) tuple allowed to access.
5344 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
5345 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
5346 (narrow-to-region (point) (tramp-compat-line-end-position))
5347 (when (re-search-forward regexp nil t)
5348 (setq result (list (match-string 3) (match-string 1))))
5353 (defun tramp-parse-putty (registry)
5354 "Return a list of (user host) tuples allowed to access.
5355 User is always nil."
5356 ;; On Windows, there are problems in completion when
5357 ;; `default-directory' is remote.
5358 (let ((default-directory (tramp-compat-temporary-file-directory))
5361 (when (zerop (tramp-local-call-process "reg" nil t nil "query" registry))
5362 (goto-char (point-min))
5364 (push (tramp-parse-putty-group registry) res))))
5367 (defun tramp-parse-putty-group (registry)
5368 "Return a (user host) tuple allowed to access.
5369 User is always nil."
5371 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
5372 (narrow-to-region (point) (tramp-compat-line-end-position))
5373 (when (re-search-forward regexp nil t)
5374 (setq result (list nil (match-string 1))))
5379 ;;; Internal Functions:
5381 (defun tramp-maybe-send-script (vec script name)
5382 "Define in remote shell function NAME implemented as SCRIPT.
5383 Only send the definition if it has not already been done."
5384 (let* ((p (tramp-get-connection-process vec))
5385 (scripts (tramp-get-connection-property p "scripts" nil)))
5386 (unless (member name scripts)
5387 (tramp-message vec 5 "Sending script `%s'..." name)
5388 ;; The script could contain a call of Perl. This is masked with `%s'.
5389 (tramp-send-command-and-check
5391 (format "%s () {\n%s\n}" name
5392 (format script (tramp-get-remote-perl vec))))
5393 (tramp-set-connection-property p "scripts" (cons name scripts))
5394 (tramp-message vec 5 "Sending script `%s'...done." name))))
5396 (defun tramp-set-auto-save ()
5397 (when (and ;; ange-ftp has its own auto-save mechanism
5398 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
5399 'tramp-sh-file-name-handler)
5401 (auto-save-mode 1)))
5402 (add-hook 'find-file-hooks 'tramp-set-auto-save t)
5403 (add-hook 'tramp-unload-hook
5405 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
5407 (defun tramp-run-test (switch filename)
5408 "Run `test' on the remote system, given a SWITCH and a FILENAME.
5409 Returns the exit code of the `test' program."
5410 (with-parsed-tramp-file-name filename nil
5411 (tramp-send-command-and-check
5415 (tramp-get-test-command v)
5417 (tramp-shell-quote-argument localname)))))
5419 (defun tramp-run-test2 (format-string file1 file2)
5420 "Run `test'-like program on the remote system, given FILE1, FILE2.
5421 FORMAT-STRING contains the program name, switches, and place holders.
5422 Returns the exit code of the `test' program. Barfs if the methods,
5423 hosts, or files, disagree."
5424 (unless (tramp-equal-remote file1 file2)
5425 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1) file1 file2) nil
5428 "tramp-run-test2 only implemented for same method, user, host")))
5429 (with-parsed-tramp-file-name file1 v1
5430 (with-parsed-tramp-file-name file1 v2
5431 (tramp-send-command-and-check
5433 (format format-string
5434 (tramp-shell-quote-argument v1-localname)
5435 (tramp-shell-quote-argument v2-localname))))))
5437 (defun tramp-buffer-name (vec)
5438 "A name for the connection buffer VEC."
5439 ;; We must use `tramp-file-name-real-host', because for gateway
5440 ;; methods the default port will be expanded later on, which would
5442 (let ((method (tramp-file-name-method vec))
5443 (user (tramp-file-name-user vec))
5444 (host (tramp-file-name-real-host vec)))
5445 (if (not (zerop (length user)))
5446 (format "*tramp/%s %s@%s*" method user host)
5447 (format "*tramp/%s %s*" method host))))
5449 (defun tramp-get-buffer (vec)
5450 "Get the connection buffer to be used for VEC."
5451 (or (get-buffer (tramp-buffer-name vec))
5452 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
5453 (setq buffer-undo-list t)
5454 (setq default-directory
5455 (tramp-make-tramp-file-name
5456 (tramp-file-name-method vec)
5457 (tramp-file-name-user vec)
5458 (tramp-file-name-host vec)
5462 (defun tramp-get-connection-buffer (vec)
5463 "Get the connection buffer to be used for VEC.
5464 In case a second asynchronous communication has been started, it is different
5465 from `tramp-get-buffer'."
5466 (or (tramp-get-connection-property vec "process-buffer" nil)
5467 (tramp-get-buffer vec)))
5469 (defun tramp-get-connection-process (vec)
5470 "Get the connection process to be used for VEC.
5471 In case a second asynchronous communication has been started, it is different
5472 from the default one."
5474 (or (tramp-get-connection-property vec "process-name" nil)
5475 (tramp-buffer-name vec))))
5477 (defun tramp-debug-buffer-name (vec)
5478 "A name for the debug buffer for VEC."
5479 ;; We must use `tramp-file-name-real-host', because for gateway
5480 ;; methods the default port will be expanded later on, which would
5482 (let ((method (tramp-file-name-method vec))
5483 (user (tramp-file-name-user vec))
5484 (host (tramp-file-name-real-host vec)))
5485 (if (not (zerop (length user)))
5486 (format "*debug tramp/%s %s@%s*" method user host)
5487 (format "*debug tramp/%s %s*" method host))))
5489 (defun tramp-get-debug-buffer (vec)
5490 "Get the debug buffer for VEC."
5491 (with-current-buffer
5492 (get-buffer-create (tramp-debug-buffer-name vec))
5494 (setq buffer-undo-list t)
5495 ;; Activate outline-mode. This runs `text-mode-hook' and
5496 ;; `outline-mode-hook'. We must prevent that local processes
5497 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell"
5499 (let ((default-directory (tramp-compat-temporary-file-directory)))
5501 (set (make-local-variable 'outline-regexp)
5502 "[0-9]+:[0-9]+:[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #")
5503 ; (set (make-local-variable 'outline-regexp)
5504 ; "[a-z.-]+:[0-9]+: [a-z0-9-]+ (\\([0-9]+\\)) #")
5505 (set (make-local-variable 'outline-level) 'tramp-outline-level))
5508 (defun tramp-outline-level ()
5509 "Return the depth to which a statement is nested in the outline.
5510 Point must be at the beginning of a header line.
5512 The outline level is equal to the verbosity of the Tramp message."
5513 (1+ (string-to-number (match-string 1))))
5515 (defun tramp-find-executable
5516 (vec progname dirlist &optional ignore-tilde ignore-path)
5517 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
5518 First arg VEC specifies the connection, PROGNAME is the program
5519 to search for, and DIRLIST gives the list of directories to
5520 search. If IGNORE-TILDE is non-nil, directory names starting
5521 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
5524 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
5526 This function expects to be in the right *tramp* buffer."
5527 (with-current-buffer (tramp-get-buffer vec)
5529 ;; Check whether the executable is in $PATH. "which(1)" does not
5530 ;; report always a correct error code; therefore we check the
5531 ;; number of words it returns.
5533 (tramp-send-command vec (format "which \\%s | wc -w" progname))
5534 (goto-char (point-min))
5535 (if (looking-at "^1$")
5536 (setq result (concat "\\" progname))))
5539 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
5540 ;; `remove' is in CL, and we want to avoid CL dependencies.
5543 (setq d (car dirlist))
5544 (setq dirlist (cdr dirlist))
5545 (unless (char-equal ?~ (aref d 0))
5546 (setq newdl (cons d newdl))))
5547 (setq dirlist (nreverse newdl))))
5550 (format (concat "while read d; "
5551 "do if test -x $d/%s -a -f $d/%s; "
5552 "then echo tramp_executable $d/%s; "
5553 "break; fi; done <<'EOF'\n"
5555 progname progname progname (mapconcat 'identity dirlist "\n")))
5556 (goto-char (point-max))
5557 (when (search-backward "tramp_executable " nil t)
5558 (skip-chars-forward "^ ")
5559 (skip-chars-forward " ")
5560 (setq result (buffer-substring
5561 (point) (tramp-compat-line-end-position)))))
5564 (defun tramp-set-remote-path (vec)
5565 "Sets the remote environment PATH to existing directories.
5566 I.e., for each directory in `tramp-remote-path', it is tested
5567 whether it exists and if so, it is added to the environment
5569 (tramp-message vec 5 (format "Setting $PATH environment variable"))
5571 vec (format "PATH=%s; export PATH"
5572 (mapconcat 'identity (tramp-get-remote-path vec) ":"))))
5574 ;; ------------------------------------------------------------
5575 ;; -- Communication with external shell --
5576 ;; ------------------------------------------------------------
5578 (defun tramp-find-file-exists-command (vec)
5579 "Find a command on the remote host for checking if a file exists.
5580 Here, we are looking for a command which has zero exit status if the
5581 file exists and nonzero exit status otherwise."
5582 (let ((existing "/")
5584 (tramp-shell-quote-argument "/ this file does not exist "))
5586 ;; The algorithm is as follows: we try a list of several commands.
5587 ;; For each command, we first run `$cmd /' -- this should return
5588 ;; true, as the root directory always exists. And then we run
5589 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
5590 ;; does not exist. This should return false. We use the first
5591 ;; command we find that seems to work.
5592 ;; The list of commands to try is as follows:
5593 ;; `ls -d' This works on most systems, but NetBSD 1.4
5594 ;; has a bug: `ls' always returns zero exit
5595 ;; status, even for files which don't exist.
5596 ;; `test -e' Some Bourne shells have a `test' builtin
5597 ;; which does not know the `-e' option.
5598 ;; `/bin/test -e' For those, the `test' binary on disk normally
5599 ;; provides the option. Alas, the binary
5600 ;; is sometimes `/bin/test' and sometimes it's
5602 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
5604 (and (setq result (format "%s -e" (tramp-get-test-command vec)))
5605 (zerop (tramp-send-command-and-check
5606 vec (format "%s %s" result existing)))
5607 (not (zerop (tramp-send-command-and-check
5608 vec (format "%s %s" result nonexisting)))))
5609 (and (setq result "/bin/test -e")
5610 (zerop (tramp-send-command-and-check
5611 vec (format "%s %s" result existing)))
5612 (not (zerop (tramp-send-command-and-check
5613 vec (format "%s %s" result nonexisting)))))
5614 (and (setq result "/usr/bin/test -e")
5615 (zerop (tramp-send-command-and-check
5616 vec (format "%s %s" result existing)))
5617 (not (zerop (tramp-send-command-and-check
5618 vec (format "%s %s" result nonexisting)))))
5619 (and (setq result (format "%s -d" (tramp-get-ls-command vec)))
5620 (zerop (tramp-send-command-and-check
5621 vec (format "%s %s" result existing)))
5622 (not (zerop (tramp-send-command-and-check
5623 vec (format "%s %s" result nonexisting))))))
5625 vec 'file-error "Couldn't find command to check if file exists"))
5628 ;; CCC test ksh or bash found for tilde expansion?
5629 (defun tramp-find-shell (vec)
5630 "Opens a shell on the remote host which groks tilde expansion."
5631 (unless (tramp-get-connection-property vec "remote-shell" nil)
5633 (with-current-buffer (tramp-get-buffer vec)
5634 (tramp-send-command vec "echo ~root" t)
5636 ((string-match "^~root$" (buffer-string))
5638 (or (tramp-find-executable
5639 vec "bash" (tramp-get-remote-path vec) t)
5640 (tramp-find-executable
5641 vec "ksh" (tramp-get-remote-path vec) t)))
5645 "Couldn't find a shell which groks tilde expansion"))
5646 ;; Find arguments for this shell.
5647 (let ((alist tramp-sh-extra-args)
5649 (while (and alist (null extra-args))
5650 (setq item (pop alist))
5651 (when (string-match (car item) shell)
5652 (setq extra-args (cdr item))))
5653 (when extra-args (setq shell (concat shell " " extra-args))))
5655 vec 5 "Starting remote shell `%s' for tilde expansion..." shell)
5656 (let ((tramp-end-of-output "$ "))
5659 (format "PROMPT_COMMAND='' PS1='$ ' PS2='' PS3='' exec %s" shell)
5662 (tramp-message vec 5 "Setting remote shell prompt...")
5663 (tramp-send-command vec (format "PS1='%s'" tramp-end-of-output) t)
5664 (tramp-send-command vec "PS2=''" t)
5665 (tramp-send-command vec "PS3=''" t)
5666 (tramp-send-command vec "PROMPT_COMMAND=''" t)
5667 (tramp-message vec 5 "Setting remote shell prompt...done"))
5670 vec 5 "Remote `%s' groks tilde expansion, good"
5671 (tramp-get-method-parameter
5672 (tramp-file-name-method vec) 'tramp-remote-sh))
5673 (tramp-set-connection-property
5675 (tramp-get-method-parameter
5676 (tramp-file-name-method vec) 'tramp-remote-sh))))))))
5678 ;; ------------------------------------------------------------
5679 ;; -- Functions for establishing connection --
5680 ;; ------------------------------------------------------------
5682 ;; The following functions are actions to be taken when seeing certain
5683 ;; prompts from the remote host. See the variable
5684 ;; `tramp-actions-before-shell' for usage of these functions.
5686 (defun tramp-action-login (proc vec)
5687 "Send the login name."
5688 (when (not (stringp tramp-current-user))
5689 (save-window-excursion
5690 (let ((enable-recursive-minibuffers t))
5691 (pop-to-buffer (tramp-get-connection-buffer vec))
5692 (setq tramp-current-user (read-string (match-string 0))))))
5693 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
5694 (with-current-buffer (tramp-get-connection-buffer vec)
5695 (tramp-message vec 6 "\n%s" (buffer-string)))
5696 (tramp-send-string vec tramp-current-user))
5698 (defun tramp-action-password (proc vec)
5699 "Query the user for a password."
5700 (tramp-message vec 3 "Sending password")
5701 (tramp-enter-password proc))
5703 (defun tramp-action-succeed (proc vec)
5704 "Signal success in finding shell prompt."
5705 (throw 'tramp-action 'ok))
5707 (defun tramp-action-permission-denied (proc vec)
5708 "Signal permission denied."
5710 (throw 'tramp-action 'permission-denied))
5712 (defun tramp-action-yesno (proc vec)
5713 "Ask the user for confirmation using `yes-or-no-p'.
5714 Send \"yes\" to remote process on confirmation, abort otherwise.
5715 See also `tramp-action-yn'."
5716 (save-window-excursion
5717 (let ((enable-recursive-minibuffers t))
5718 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
5719 (unless (yes-or-no-p (match-string 0))
5721 (throw 'tramp-action 'permission-denied))
5722 (with-current-buffer (tramp-get-connection-buffer vec)
5723 (tramp-message vec 6 "\n%s" (buffer-string)))
5724 (tramp-send-string vec "yes"))))
5726 (defun tramp-action-yn (proc vec)
5727 "Ask the user for confirmation using `y-or-n-p'.
5728 Send \"y\" to remote process on confirmation, abort otherwise.
5729 See also `tramp-action-yesno'."
5730 (save-window-excursion
5731 (let ((enable-recursive-minibuffers t))
5732 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
5733 (unless (y-or-n-p (match-string 0))
5735 (throw 'tramp-action 'permission-denied))
5736 (with-current-buffer (tramp-get-connection-buffer vec)
5737 (tramp-message vec 6 "\n%s" (buffer-string)))
5738 (tramp-send-string vec "y"))))
5740 (defun tramp-action-terminal (proc vec)
5741 "Tell the remote host which terminal type to use.
5742 The terminal type can be configured with `tramp-terminal-type'."
5743 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
5744 (with-current-buffer (tramp-get-connection-buffer vec)
5745 (tramp-message vec 6 "\n%s" (buffer-string)))
5746 (tramp-send-string vec tramp-terminal-type))
5748 (defun tramp-action-process-alive (proc vec)
5749 "Check whether a process has finished."
5750 (unless (memq (process-status proc) '(run open))
5751 (throw 'tramp-action 'process-died)))
5753 (defun tramp-action-out-of-band (proc vec)
5754 "Check whether an out-of-band copy has finished."
5755 (cond ((and (memq (process-status proc) '(stop exit))
5756 (zerop (process-exit-status proc)))
5757 (tramp-message vec 3 "Process has finished.")
5758 (throw 'tramp-action 'ok))
5759 ((or (and (memq (process-status proc) '(stop exit))
5760 (not (zerop (process-exit-status proc))))
5761 (memq (process-status proc) '(signal)))
5762 ;; `scp' could have copied correctly, but set modes could have failed.
5763 ;; This can be ignored.
5764 (with-current-buffer (process-buffer proc)
5765 (goto-char (point-min))
5766 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
5768 (tramp-message vec 5 "'set mode' error ignored.")
5769 (tramp-message vec 3 "Process has finished.")
5770 (throw 'tramp-action 'ok))
5771 (tramp-message vec 3 "Process has died.")
5772 (throw 'tramp-action 'process-died))))
5775 ;; Functions for processing the actions.
5777 (defun tramp-process-one-action (proc vec actions)
5778 "Wait for output from the shell and perform one action."
5779 (let (found todo item pattern action)
5781 ;; Reread output once all actions have been performed.
5782 ;; Obviously, the output was not complete.
5783 (tramp-accept-process-output proc 1)
5786 (setq item (pop todo))
5787 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
5788 (setq action (nth 1 item))
5790 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
5791 (when (tramp-check-for-regexp proc pattern)
5792 (tramp-message vec 5 "Call `%s'" (symbol-name action))
5793 (setq found (funcall action proc vec)))))
5796 (defun tramp-process-actions (proc vec actions &optional timeout)
5797 "Perform actions until success or TIMEOUT."
5800 (tramp-message proc 3 "Waiting for prompts from remote shell")
5802 (catch 'tramp-action
5804 (with-timeout (timeout)
5805 (tramp-process-one-action proc vec actions))
5806 (tramp-process-one-action proc vec actions)))))
5807 (with-current-buffer (tramp-get-connection-buffer vec)
5808 (tramp-message vec 6 "\n%s" (buffer-string)))
5809 (unless (eq exit 'ok)
5810 (tramp-clear-passwd vec)
5811 (tramp-error-with-buffer
5814 ((eq exit 'permission-denied) "Permission denied")
5815 ((eq exit 'process-died) "Process died")
5816 (t "Login failed"))))))
5818 ;; Utility functions.
5820 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
5821 "Like `accept-process-output' for Tramp processes.
5822 This is needed in order to hide `last-coding-system-used', which is set
5823 for process communication also."
5824 (with-current-buffer (process-buffer proc)
5825 (tramp-message proc 10 "%s %s" proc (process-status proc))
5826 (let (buffer-read-only last-coding-system-used)
5827 ;; Under Windows XP, accept-process-output doesn't return
5828 ;; sometimes. So we add an additional timeout.
5829 (with-timeout ((or timeout 1))
5830 (accept-process-output proc timeout timeout-msecs)))
5831 (tramp-message proc 10 "\n%s" (buffer-string))))
5833 (defun tramp-check-for-regexp (proc regexp)
5834 "Check whether REGEXP is contained in process buffer of PROC.
5835 Erase echoed commands if exists."
5836 (with-current-buffer (process-buffer proc)
5837 (goto-char (point-min))
5839 ;; Check whether we need to remove echo output.
5840 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
5841 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
5842 (let ((begin (match-beginning 0)))
5843 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
5844 ;; Discard echo from remote output.
5845 (tramp-set-connection-property proc "check-remote-echo" nil)
5846 (tramp-message proc 5 "echo-mark found")
5848 (delete-region begin (point))
5849 (goto-char (point-min)))))
5852 ;; No echo to be handled, now we can look for the regexp.
5853 (not (tramp-get-connection-property proc "check-remote-echo" nil))
5854 ;; Sometimes the echo is invisible.
5855 (not (re-search-forward tramp-echo-mark-marker nil t)))
5856 (goto-char (point-min))
5857 (re-search-forward regexp nil t))))
5859 (defun tramp-wait-for-regexp (proc timeout regexp)
5860 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
5861 Expects the output of PROC to be sent to the current buffer. Returns
5862 the string that matched, or nil. Waits indefinitely if TIMEOUT is
5864 (with-current-buffer (process-buffer proc)
5865 (let ((found (tramp-check-for-regexp proc regexp))
5866 (start-time (current-time)))
5868 ;; Work around a bug in XEmacs 21, where the timeout
5869 ;; expires faster than it should. This degenerates
5870 ;; to polling for buggy XEmacsen, but oh, well.
5871 (while (and (not found)
5872 (< (tramp-time-diff (current-time) start-time)
5874 (with-timeout (timeout)
5876 (tramp-accept-process-output proc 1)
5877 (unless (memq (process-status proc) '(run open))
5878 (tramp-error-with-buffer
5879 nil proc 'file-error "Process has died"))
5880 (setq found (tramp-check-for-regexp proc regexp))))))
5883 (tramp-accept-process-output proc 1)
5884 (unless (memq (process-status proc) '(run open))
5885 (tramp-error-with-buffer
5886 nil proc 'file-error "Process has died"))
5887 (setq found (tramp-check-for-regexp proc regexp)))))
5888 (tramp-message proc 6 "\n%s" (buffer-string))
5892 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
5894 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
5897 (defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
5898 "Wait for shell prompt and barf if none appears.
5899 Looks at process PROC to see if a shell prompt appears in TIMEOUT
5900 seconds. If not, it produces an error message with the given ERROR-ARGS."
5902 (tramp-wait-for-regexp
5905 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern))
5906 (apply 'tramp-error-with-buffer nil proc 'file-error error-args)))
5908 ;; We don't call `tramp-send-string' in order to hide the password
5909 ;; from the debug buffer, and because end-of-line handling of the
5911 (defun tramp-enter-password (proc)
5912 "Prompt for a password and send it to the remote end."
5913 (process-send-string
5914 proc (concat (tramp-read-passwd proc)
5915 (or (tramp-get-method-parameter
5916 tramp-current-method
5917 'tramp-password-end-of-line)
5918 tramp-default-password-end-of-line))))
5920 (defun tramp-open-connection-setup-interactive-shell (proc vec)
5921 "Set up an interactive shell.
5922 Mainly sets the prompt and the echo correctly. PROC is the shell
5923 process to set up. VEC specifies the connection."
5924 (let ((tramp-end-of-output "$ "))
5925 ;; It is useful to set the prompt in the following command because
5926 ;; some people have a setting for $PS1 which /bin/sh doesn't know
5927 ;; about and thus /bin/sh will display a strange prompt. For
5928 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
5929 ;; display the current working directory but /bin/sh will display
5930 ;; a dollar sign. The following command line sets $PS1 to a sane
5931 ;; value, and works under Bourne-ish shells as well as csh-like
5932 ;; shells. Daniel Pittman reports that the unusual positioning of
5933 ;; the single quotes makes it work under `rc', too. We also unset
5934 ;; the variable $ENV because that is read by some sh
5935 ;; implementations (eg, bash when called as sh) on startup; this
5936 ;; way, we avoid the startup file clobbering $PS1. $PROMP_COMMAND
5937 ;; is another way to set the prompt in /bin/bash, it must be
5938 ;; discarded as well.
5942 "exec env ENV='' PROMPT_COMMAND='' PS1='$ ' PS2='' PS3='' %s"
5943 (tramp-get-method-parameter
5944 (tramp-file-name-method vec) 'tramp-remote-sh))
5948 (tramp-message vec 5 "Setting up remote shell environment")
5949 (tramp-send-command vec "stty -inlcr -echo kill '^U' erase '^H'" t)
5950 ;; Check whether the echo has really been disabled. Some
5951 ;; implementations, like busybox of embedded GNU/Linux, don't
5952 ;; support disabling.
5953 (tramp-send-command vec "echo foo" t)
5954 (with-current-buffer (process-buffer proc)
5955 (goto-char (point-min))
5956 (when (looking-at "echo foo")
5957 (tramp-set-connection-property proc "remote-echo" t)
5958 (tramp-message vec 5 "Remote echo still on. Ok.")
5959 ;; Make sure backspaces and their echo are enabled and no line
5960 ;; width magic interferes with them.
5961 (tramp-send-command vec "stty icanon erase ^H cols 32767" t))))
5963 (tramp-message vec 5 "Setting shell prompt")
5964 ;; We can set $PS1 to `tramp-end-of-output' only when the echo has
5965 ;; been disabled. Otherwise, the echo of the command would be
5966 ;; regarded as prompt already.
5967 (tramp-send-command vec (format "PS1='%s'" tramp-end-of-output) t)
5968 (tramp-send-command vec "PS2=''" t)
5969 (tramp-send-command vec "PS3=''" t)
5970 (tramp-send-command vec "PROMPT_COMMAND=''" t)
5972 ;; Try to set up the coding system correctly.
5973 ;; CCC this can't be the right way to do it. Hm.
5974 (tramp-message vec 5 "Determining coding system")
5975 (tramp-send-command vec "echo foo ; echo bar" t)
5976 (with-current-buffer (process-buffer proc)
5977 (goto-char (point-min))
5978 (if (featurep 'mule)
5979 ;; Use MULE to select the right EOL convention for communicating
5980 ;; with the process.
5981 (let* ((cs (or (funcall (symbol-function 'process-coding-system) proc)
5982 (cons 'undecided 'undecided)))
5983 cs-decode cs-encode)
5984 (when (symbolp cs) (setq cs (cons cs cs)))
5985 (setq cs-decode (car cs))
5986 (setq cs-encode (cdr cs))
5987 (unless cs-decode (setq cs-decode 'undecided))
5988 (unless cs-encode (setq cs-encode 'undecided))
5989 (setq cs-encode (tramp-coding-system-change-eol-conversion
5991 (when (search-forward "\r" nil t)
5992 (setq cs-decode (tramp-coding-system-change-eol-conversion
5994 (funcall (symbol-function 'set-buffer-process-coding-system)
5995 cs-decode cs-encode))
5996 ;; Look for ^M and do something useful if found.
5997 (when (search-forward "\r" nil t)
5998 ;; We have found a ^M but cannot frob the process coding system
5999 ;; because we're running on a non-MULE Emacs. Let's try
6001 (tramp-send-command vec "stty -onlcr" t))))
6002 (tramp-send-command vec "set +o vi +o emacs" t)
6004 ;; Check whether the output of "uname -sr" has been changed. If
6005 ;; yes, this is a strong indication that we must expire all
6006 ;; connection properties. We start again with
6007 ;; `tramp-maybe-open-connection', it will be catched there.
6008 (tramp-message vec 5 "Checking system information")
6009 (let ((old-uname (tramp-get-connection-property vec "uname" nil))
6011 (tramp-set-connection-property
6013 (tramp-send-command-and-read vec "echo \\\"`uname -sr`\\\""))))
6014 (when (and (stringp old-uname) (not (string-equal old-uname new-uname)))
6015 (with-current-buffer (tramp-get-debug-buffer vec)
6016 ;; Keep the debug buffer
6018 (generate-new-buffer-name tramp-temp-buffer-name) 'unique)
6019 (funcall (symbol-function 'tramp-cleanup-connection) vec)
6020 (if (= (point-min) (point-max))
6022 (rename-buffer (tramp-debug-buffer-name vec) 'unique))
6023 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
6024 (tramp-get-buffer vec)
6027 "Connection reset, because remote host changed from `%s' to `%s'"
6028 old-uname new-uname)
6029 (throw 'uname-changed (tramp-maybe-open-connection vec)))))
6031 ;; Check whether the remote host suffers from buggy
6032 ;; `send-process-string'. This is known for FreeBSD (see comment in
6033 ;; `send_process', file process.c). I've tested sending 624 bytes
6034 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
6035 ;; this host type is detected locally. It cannot handle remote
6037 (with-connection-property proc "chunksize"
6039 ((and (integerp tramp-chunksize) (> tramp-chunksize 0))
6043 vec 5 "Checking remote host type for `send-process-string' bug")
6045 "^FreeBSD" (tramp-get-connection-property vec "uname" ""))
6048 ;; Set remote PATH variable.
6049 (tramp-set-remote-path vec)
6051 ;; Search for a good shell before searching for a command which
6052 ;; checks if a file exists. This is done because Tramp wants to use
6053 ;; "test foo; echo $?" to check if various conditions hold, and
6054 ;; there are buggy /bin/sh implementations which don't execute the
6055 ;; "echo $?" part if the "test" part has an error. In particular,
6056 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
6057 ;; with buggy /bin/sh implementations will have a working bash or
6059 (tramp-find-shell vec)
6061 ;; Disable unexpected output.
6062 (tramp-send-command vec "mesg n; biff n" t)
6064 ;; Set the environment.
6065 (tramp-message vec 5 "Setting default environment")
6066 (let ((env (copy-sequence tramp-remote-process-environment))
6069 (setq item (split-string (car env) "="))
6070 (if (and (stringp (cadr item)) (not (string-equal (cadr item) "")))
6072 vec (format "%s=%s; export %s" (car item) (cadr item) (car item)) t)
6073 (push (car item) unset))
6074 (setq env (cdr env)))
6077 vec (format "unset %s" (mapconcat 'identity unset " "))))) t)
6079 ;; CCC: We should either implement a Perl version of base64 encoding
6080 ;; and decoding. Then we just use that in the last item. The other
6081 ;; alternative is to use the Perl version of UU encoding. But then
6082 ;; we need a Lisp version of uuencode.
6084 ;; Old text from documentation of tramp-methods:
6085 ;; Using a uuencode/uudecode inline method is discouraged, please use one
6086 ;; of the base64 methods instead since base64 encoding is much more
6087 ;; reliable and the commands are more standardized between the different
6088 ;; Unix versions. But if you can't use base64 for some reason, please
6089 ;; note that the default uudecode command does not work well for some
6090 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
6091 ;; the following command for uudecode:
6093 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
6095 ;; For Irix, no solution is known yet.
6097 (defconst tramp-local-coding-commands
6098 '((b64 base64-encode-region base64-decode-region)
6099 (uu tramp-uuencode-region uudecode-decode-region)
6101 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
6102 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
6103 "List of local coding commands for inline transfer.
6104 Each item is a list that looks like this:
6106 \(FORMAT ENCODING DECODING)
6108 FORMAT is symbol describing the encoding/decoding format. It can be
6109 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
6111 ENCODING and DECODING can be strings, giving commands, or symbols,
6112 giving functions. If they are strings, then they can contain
6113 the \"%s\" format specifier. If that specifier is present, the input
6114 filename will be put into the command line at that spot. If the
6115 specifier is not present, the input should be read from standard
6118 If they are functions, they will be called with two arguments, start
6119 and end of region, and are expected to replace the region contents
6120 with the encoded or decoded results, respectively.")
6122 (defconst tramp-remote-coding-commands
6123 '((b64 "mimencode -b" "mimencode -u -b")
6124 (b64 "mmencode -b" "mmencode -u -b")
6125 (b64 "recode data..base64" "recode base64..data")
6126 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module)
6127 (b64 tramp-perl-encode tramp-perl-decode)
6128 (uu "uuencode xxx" "uudecode -o /dev/stdout")
6129 (uu "uuencode xxx" "uudecode -o -")
6130 (uu "uuencode xxx" "uudecode -p")
6131 (uu "uuencode xxx" tramp-uudecode)
6133 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
6134 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
6135 "List of remote coding commands for inline transfer.
6136 Each item is a list that looks like this:
6138 \(FORMAT ENCODING DECODING)
6140 FORMAT is symbol describing the encoding/decoding format. It can be
6141 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
6143 ENCODING and DECODING can be strings, giving commands, or symbols,
6144 giving variables. If they are strings, then they can contain
6145 the \"%s\" format specifier. If that specifier is present, the input
6146 filename will be put into the command line at that spot. If the
6147 specifier is not present, the input should be read from standard
6150 If they are variables, this variable is a string containing a Perl
6151 implementation for this functionality. This Perl program will be transferred
6152 to the remote host, and it is avalible as shell function with the same name.")
6154 (defun tramp-find-inline-encoding (vec)
6155 "Find an inline transfer encoding that works.
6156 Goes through the list `tramp-local-coding-commands' and
6157 `tramp-remote-coding-commands'."
6159 (let ((local-commands tramp-local-coding-commands)
6161 loc-enc loc-dec rem-enc rem-dec litem ritem found)
6162 (while (and local-commands (not found))
6163 (setq litem (pop local-commands))
6164 (catch 'wont-work-local
6165 (let ((format (nth 0 litem))
6166 (remote-commands tramp-remote-coding-commands))
6167 (setq loc-enc (nth 1 litem))
6168 (setq loc-dec (nth 2 litem))
6169 ;; If the local encoder or decoder is a string, the
6170 ;; corresponding command has to work locally.
6171 (if (not (stringp loc-enc))
6173 vec 5 "Checking local encoding function `%s'" loc-enc)
6175 vec 5 "Checking local encoding command `%s' for sanity" loc-enc)
6176 (unless (zerop (tramp-call-local-coding-command
6178 (throw 'wont-work-local nil)))
6179 (if (not (stringp loc-dec))
6181 vec 5 "Checking local decoding function `%s'" loc-dec)
6183 vec 5 "Checking local decoding command `%s' for sanity" loc-dec)
6184 (unless (zerop (tramp-call-local-coding-command
6186 (throw 'wont-work-local nil)))
6187 ;; Search for remote coding commands with the same format
6188 (while (and remote-commands (not found))
6189 (setq ritem (pop remote-commands))
6190 (catch 'wont-work-remote
6191 (when (equal format (nth 0 ritem))
6192 (setq rem-enc (nth 1 ritem))
6193 (setq rem-dec (nth 2 ritem))
6194 ;; Check if remote encoding and decoding commands can be
6195 ;; called remotely with null input and output. This makes
6196 ;; sure there are no syntax errors and the command is really
6197 ;; found. Note that we do not redirect stdout to /dev/null,
6198 ;; for two reasons: when checking the decoding command, we
6199 ;; actually check the output it gives. And also, when
6200 ;; redirecting "mimencode" output to /dev/null, then as root
6201 ;; it might change the permissions of /dev/null!
6202 (when (not (stringp rem-enc))
6203 (let ((name (symbol-name rem-enc)))
6204 (while (string-match (regexp-quote "-") name)
6205 (setq name (replace-match "_" nil t name)))
6206 (tramp-maybe-send-script vec (symbol-value rem-enc) name)
6207 (setq rem-enc name)))
6210 "Checking remote encoding command `%s' for sanity" rem-enc)
6211 (unless (zerop (tramp-send-command-and-check
6212 vec (format "%s </dev/null" rem-enc) t))
6213 (throw 'wont-work-remote nil))
6215 (when (not (stringp rem-dec))
6216 (let ((name (symbol-name rem-dec)))
6217 (while (string-match (regexp-quote "-") name)
6218 (setq name (replace-match "_" nil t name)))
6219 (tramp-maybe-send-script vec (symbol-value rem-dec) name)
6220 (setq rem-dec name)))
6223 "Checking remote decoding command `%s' for sanity" rem-dec)
6224 (unless (zerop (tramp-send-command-and-check
6226 (format "echo %s | %s | %s"
6227 magic rem-enc rem-dec) t))
6228 (throw 'wont-work-remote nil))
6230 (with-current-buffer (tramp-get-buffer vec)
6231 (goto-char (point-min))
6232 (unless (looking-at (regexp-quote magic))
6233 (throw 'wont-work-remote nil)))
6235 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
6236 (setq rem-enc (nth 1 ritem))
6237 (setq rem-dec (nth 2 ritem))
6238 (setq found t)))))))
6240 ;; Did we find something?
6242 (tramp-message vec 2 "Couldn't find an inline transfer encoding"))
6244 ;; Set connection properties.
6245 (tramp-message vec 5 "Using local encoding `%s'" loc-enc)
6246 (tramp-set-connection-property vec "local-encoding" loc-enc)
6247 (tramp-message vec 5 "Using local decoding `%s'" loc-dec)
6248 (tramp-set-connection-property vec "local-decoding" loc-dec)
6249 (tramp-message vec 5 "Using remote encoding `%s'" rem-enc)
6250 (tramp-set-connection-property vec "remote-encoding" rem-enc)
6251 (tramp-message vec 5 "Using remote decoding `%s'" rem-dec)
6252 (tramp-set-connection-property vec "remote-decoding" rem-dec))))
6254 (defun tramp-call-local-coding-command (cmd input output)
6255 "Call the local encoding or decoding command.
6256 If CMD contains \"%s\", provide input file INPUT there in command.
6257 Otherwise, INPUT is passed via standard input.
6258 INPUT can also be nil which means `/dev/null'.
6259 OUTPUT can be a string (which specifies a filename), or t (which
6260 means standard output and thus the current buffer), or nil (which
6262 (tramp-local-call-process
6263 tramp-encoding-shell
6264 (when (and input (not (string-match "%s" cmd))) input)
6265 (if (eq output t) t nil)
6267 tramp-encoding-command-switch
6269 (if (string-match "%s" cmd) (format cmd input) cmd)
6270 (if (stringp output) (concat "> " output) ""))))
6272 (defun tramp-compute-multi-hops (vec)
6273 "Expands VEC according to `tramp-default-proxies-alist'.
6274 Gateway hops are already opened."
6275 (let ((target-alist `(,vec))
6276 (choices tramp-default-proxies-alist)
6279 ;; Look for proxy hosts to be passed.
6281 (setq item (pop choices)
6285 (string-match (or (nth 0 item) "")
6286 (or (tramp-file-name-host (car target-alist)) ""))
6288 (string-match (or (nth 1 item) "")
6289 (or (tramp-file-name-user (car target-alist)) "")))
6291 ;; No more hops needed.
6293 ;; Replace placeholders.
6297 `((?u . ,(or (tramp-file-name-user (car target-alist)) ""))
6298 (?h . ,(or (tramp-file-name-host (car target-alist)) "")))))
6299 (with-parsed-tramp-file-name proxy l
6301 (add-to-list 'target-alist l)
6302 ;; Start next search.
6303 (setq choices tramp-default-proxies-alist)))))
6306 (when (and (boundp 'tramp-gw-tunnel-method)
6307 (string-match (format
6309 (symbol-value 'tramp-gw-tunnel-method)
6310 (symbol-value 'tramp-gw-socks-method))
6311 (tramp-file-name-method (car target-alist))))
6312 (let ((gw (pop target-alist))
6313 (hop (pop target-alist)))
6314 ;; Is the method prepared for gateways?
6315 (unless (tramp-get-method-parameter
6316 (tramp-file-name-method hop) 'tramp-default-port)
6319 "Method `%s' is not supported for gateway access."
6320 (tramp-file-name-method hop)))
6321 ;; Add default port if needed.
6324 tramp-host-with-port-regexp (tramp-file-name-host hop))
6327 (tramp-file-name-host hop) tramp-prefix-port-format
6329 (tramp-get-method-parameter
6330 (tramp-file-name-method hop) 'tramp-default-port)))))
6331 ;; Open the gateway connection.
6335 (tramp-file-name-method hop) (tramp-file-name-user hop)
6336 (funcall (symbol-function 'tramp-gw-open-connection) vec gw hop) nil))
6337 ;; For the password prompt, we need the correct values.
6338 ;; Therefore, we must remember the gateway vector. But we
6339 ;; cannot do it as connection property, because it shouldn't
6340 ;; be persistent. And we have no started process yet either.
6341 (tramp-set-file-property (car target-alist) "" "gateway" hop)))
6343 ;; Foreign and out-of-band methods are not supported for multi-hops.
6344 (when (cdr target-alist)
6345 (setq choices target-alist)
6347 (setq item (pop choices))
6351 (tramp-get-method-parameter
6352 (tramp-file-name-method item) 'tramp-login-program))
6353 (tramp-get-method-parameter
6354 (tramp-file-name-method item) 'tramp-copy-program))
6357 "Method `%s' is not supported for multi-hops."
6358 (tramp-file-name-method item)))))
6360 ;; In case the host name is not used for the remote shell
6361 ;; command, the user could be misguided by applying a random
6363 (let* ((v (car target-alist))
6364 (method (tramp-file-name-method v))
6365 (host (tramp-file-name-host v)))
6368 ;; There are multi-hops.
6370 ;; The host name is used for the remote shell command.
6372 '("%h") (tramp-get-method-parameter method 'tramp-login-args))
6373 ;; The host is local. We cannot use `tramp-local-host-p'
6374 ;; here, because it opens a connection as well.
6375 (string-match tramp-local-host-regexp host))
6378 "Host `%s' looks like a remote host, `%s' can only use the local host"
6384 (defun tramp-maybe-open-connection (vec)
6385 "Maybe open a connection VEC.
6386 Does not do anything if a connection is already open, but re-opens the
6387 connection if a previous connection has died for some reason."
6388 (catch 'uname-changed
6389 (let ((p (tramp-get-connection-process vec))
6390 (process-environment (copy-sequence process-environment)))
6392 ;; If too much time has passed since last command was sent, look
6393 ;; whether process is still alive. If it isn't, kill it. When
6394 ;; using ssh, it can sometimes happen that the remote end has
6395 ;; hung up but the local ssh client doesn't recognize this until
6396 ;; it tries to send some data to the remote end. So that's why
6397 ;; we try to send a command from time to time, then look again
6398 ;; whether the process is really alive.
6400 (when (and (> (tramp-time-diff
6402 (tramp-get-connection-property
6403 p "last-cmd-time" '(0 0 0)))
6405 p (processp p) (memq (process-status p) '(run open)))
6406 (tramp-send-command vec "echo are you awake" t t)
6407 (unless (and (memq (process-status p) '(run open))
6408 (tramp-wait-for-output p 10))
6409 ;; The error will be catched locally.
6410 (tramp-error vec 'file-error "Awake did fail")))
6412 (tramp-flush-connection-property vec)
6413 (tramp-flush-connection-property p)
6417 ;; New connection must be opened.
6418 (unless (and p (processp p) (memq (process-status p) '(run open)))
6420 ;; We call `tramp-get-buffer' in order to get a debug buffer for
6421 ;; messages from the beginning.
6422 (tramp-get-buffer vec)
6423 (if (zerop (length (tramp-file-name-user vec)))
6425 vec 3 "Opening connection for %s using %s..."
6426 (tramp-file-name-host vec)
6427 (tramp-file-name-method vec))
6429 vec 3 "Opening connection for %s@%s using %s..."
6430 (tramp-file-name-user vec)
6431 (tramp-file-name-host vec)
6432 (tramp-file-name-method vec)))
6434 ;; Start new process.
6435 (when (and p (processp p))
6437 (setenv "TERM" tramp-terminal-type)
6438 (setenv "LC_ALL" "C")
6439 (setenv "PROMPT_COMMAND")
6441 (let* ((target-alist (tramp-compute-multi-hops vec))
6442 (process-connection-type tramp-process-connection-type)
6443 (process-adaptive-read-buffering nil)
6444 (coding-system-for-read nil)
6445 ;; This must be done in order to avoid our file name handler.
6446 (p (let ((default-directory
6447 (tramp-compat-temporary-file-directory)))
6449 (or (tramp-get-connection-property vec "process-name" nil)
6450 (tramp-buffer-name vec))
6451 (tramp-get-connection-buffer vec)
6452 tramp-encoding-shell)))
6456 vec 6 "%s" (mapconcat 'identity (process-command p) " "))
6458 ;; Check whether process is alive.
6459 (tramp-set-process-query-on-exit-flag p nil)
6460 (tramp-message vec 3 "Waiting 60s for local shell to come up...")
6461 (tramp-barf-if-no-shell-prompt
6462 p 60 "Couldn't find local shell prompt %s" tramp-encoding-shell)
6464 ;; Now do all the connections as specified.
6466 (let* ((hop (car target-alist))
6467 (l-method (tramp-file-name-method hop))
6468 (l-user (tramp-file-name-user hop))
6469 (l-host (tramp-file-name-host hop))
6472 (tramp-get-method-parameter l-method 'tramp-login-program))
6474 (tramp-get-method-parameter l-method 'tramp-login-args))
6476 (tramp-get-method-parameter l-method 'tramp-gw-args))
6477 (gw (tramp-get-file-property hop "" "gateway" nil))
6478 (g-method (and gw (tramp-file-name-method gw)))
6479 (g-user (and gw (tramp-file-name-user gw)))
6480 (g-host (and gw (tramp-file-name-host gw)))
6481 (command login-program)
6482 ;; We don't create the temporary file. In fact, it
6483 ;; is just a prefix for the ControlPath option of
6484 ;; ssh; the real temporary file has another name, and
6485 ;; it is created and protected by ssh. It is also
6486 ;; removed by ssh, when the connection is closed.
6488 (tramp-set-connection-property
6492 tramp-temp-name-prefix
6493 (tramp-compat-temporary-file-directory)))))
6496 ;; Add gateway arguments if necessary.
6497 (when (and gw gw-args)
6498 (setq login-args (append login-args gw-args)))
6500 ;; Check for port number. Until now, there's no need
6501 ;; for handling like method, user, host.
6502 (when (string-match tramp-host-with-port-regexp l-host)
6503 (setq l-port (match-string 2 l-host)
6504 l-host (match-string 1 l-host)))
6506 ;; Set variables for computing the prompt for reading
6507 ;; password. They can also be derived from a gateway.
6508 (setq tramp-current-method (or g-method l-method)
6509 tramp-current-user (or g-user l-user)
6510 tramp-current-host (or g-host l-host))
6512 ;; Replace login-args place holders.
6514 l-host (or l-host "")
6515 l-user (or l-user "")
6516 l-port (or l-port "")
6517 spec `((?h . ,l-host) (?u . ,l-user) (?p . ,l-port)
6524 (setq x (mapcar '(lambda (y) (format-spec y spec)) x))
6525 (unless (member "" x) (mapconcat 'identity x " ")))
6527 ;; String to detect failed connection. Every single
6528 ;; word must be enclosed with '\"'; otherwise it is
6529 ;; detected during connection setup.
6530 ;; Local shell could be a Windows COMSPEC. It doesn't
6531 ;; know the ";" syntax, but we must exit always for
6532 ;; `start-process'. "exec" does not work either.
6535 "; echo \"Tramp\" \"connection\" \"closed\"; sleep 1"))
6536 ;; We don't reach a Windows shell. Could be initial only.
6539 ;; Send the command.
6540 (tramp-message vec 3 "Sending command `%s'" command)
6541 (tramp-send-command vec command t t)
6542 (tramp-process-actions p vec tramp-actions-before-shell 60)
6543 (tramp-message vec 3 "Found remote shell prompt on `%s'" l-host))
6545 (setq target-alist (cdr target-alist)))
6547 ;; Make initial shell settings.
6548 (tramp-open-connection-setup-interactive-shell p vec))))))
6550 (defun tramp-send-command (vec command &optional neveropen nooutput)
6551 "Send the COMMAND to connection VEC.
6552 Erases temporary buffer before sending the command. If optional
6553 arg NEVEROPEN is non-nil, never try to open the connection. This
6554 is meant to be used from `tramp-maybe-open-connection' only. The
6555 function waits for output unless NOOUTPUT is set."
6556 (unless neveropen (tramp-maybe-open-connection vec))
6557 (let ((p (tramp-get-connection-process vec)))
6558 (when (tramp-get-connection-property p "remote-echo" nil)
6559 ;; We mark the command string that it can be erased in the output buffer.
6560 (tramp-set-connection-property p "check-remote-echo" t)
6561 (setq command (format "%s%s%s" tramp-echo-mark command tramp-echo-mark)))
6562 (tramp-message vec 6 "%s" command)
6563 (tramp-send-string vec command)
6564 (unless nooutput (tramp-wait-for-output p))))
6566 (defun tramp-wait-for-output (proc &optional timeout)
6567 "Wait for output from remote rsh command."
6568 (with-current-buffer (process-buffer proc)
6569 ;; Initially, `tramp-end-of-output' is "$ ". There might be
6570 ;; leading escape sequences, which must be ignored.
6572 (if (string-match (regexp-quote "\n") tramp-end-of-output)
6574 'identity (split-string tramp-end-of-output "\n") "\r?\n")
6575 (format "^[^$\n]*%s\r?$" (regexp-quote tramp-end-of-output))))
6576 (found (tramp-wait-for-regexp proc timeout regexp)))
6578 (let (buffer-read-only)
6579 (goto-char (point-max))
6580 (re-search-backward regexp nil t)
6581 (delete-region (point) (point-max)))
6585 "[[Remote prompt `%s' not found in %d secs]]"
6586 tramp-end-of-output timeout)
6589 "[[Remote prompt `%s' not found]]" tramp-end-of-output)))
6590 ;; Return value is whether end-of-output sentinel was found.
6593 (defun tramp-send-command-and-check (vec command &optional subshell)
6594 "Run COMMAND and check its exit status.
6595 Sends `echo $?' along with the COMMAND for checking the exit status. If
6596 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
6598 If the optional argument SUBSHELL is non-nil, the command is executed in
6599 a subshell, ie surrounded by parentheses."
6602 (concat (if subshell "( " "")
6604 (if command " 2>/dev/null; " "")
6605 "echo tramp_exit_status $?"
6606 (if subshell " )" " ")))
6607 (with-current-buffer (tramp-get-connection-buffer vec)
6608 (goto-char (point-max))
6609 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t)
6611 vec 'file-error "Couldn't find exit status of `%s'" command))
6612 (skip-chars-forward "^ ")
6614 (read (current-buffer))
6615 (let (buffer-read-only) (delete-region (match-beginning 0) (point-max))))))
6617 (defun tramp-barf-unless-okay (vec command fmt &rest args)
6618 "Run COMMAND, check exit status, throw error if exit status not okay.
6619 Similar to `tramp-send-command-and-check' but accepts two more arguments
6620 FMT and ARGS which are passed to `error'."
6621 (unless (zerop (tramp-send-command-and-check vec command))
6622 (apply 'tramp-error vec 'file-error fmt args)))
6624 (defun tramp-send-command-and-read (vec command)
6625 "Run COMMAND and return the output, which must be a Lisp expression.
6626 In case there is no valid Lisp expression, it raises an error"
6627 (tramp-barf-unless-okay vec command "`%s' returns with error" command)
6628 (with-current-buffer (tramp-get-connection-buffer vec)
6629 ;; Read the expression.
6630 (goto-char (point-min))
6632 (prog1 (read (current-buffer))
6634 (when (re-search-forward "\\S-" (tramp-compat-line-end-position) t)
6638 "`%s' does not return a valid Lisp expression: `%s'"
6639 command (buffer-string))))))
6641 ;; It seems that Tru64 Unix does not like it if long strings are sent
6642 ;; to it in one go. (This happens when sending the Perl
6643 ;; `file-attributes' implementation, for instance.) Therefore, we
6644 ;; have this function which sends the string in chunks.
6645 (defun tramp-send-string (vec string)
6646 "Send the STRING via connection VEC.
6648 The STRING is expected to use Unix line-endings, but the lines sent to
6649 the remote host use line-endings as defined in the variable
6650 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
6651 (let* ((p (tramp-get-connection-process vec))
6652 (chunksize (tramp-get-connection-property p "chunksize" nil)))
6655 vec 'file-error "Can't send string to remote host -- not logged in"))
6656 (tramp-set-connection-property p "last-cmd-time" (current-time))
6657 (tramp-message vec 10 "%s" string)
6658 (with-current-buffer (tramp-get-connection-buffer vec)
6659 ;; Clean up the buffer. We cannot call `erase-buffer' because
6660 ;; narrowing might be in effect.
6661 (let (buffer-read-only) (delete-region (point-min) (point-max)))
6662 ;; Replace "\n" by `tramp-rsh-end-of-line'.
6664 (mapconcat 'identity
6665 (split-string string "\n")
6666 tramp-rsh-end-of-line))
6667 (unless (or (string= string "")
6668 (string-equal (substring string -1) tramp-rsh-end-of-line))
6669 (setq string (concat string tramp-rsh-end-of-line)))
6671 (if (and chunksize (not (zerop chunksize)))
6673 (end (length string)))
6676 vec 10 "Sending chunk from %s to %s"
6677 pos (min (+ pos chunksize) end))
6678 (process-send-string
6679 p (substring string pos (min (+ pos chunksize) end)))
6680 (setq pos (+ pos chunksize))))
6681 (process-send-string p string)))))
6683 (defun tramp-mode-string-to-int (mode-string)
6684 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
6685 (let* (case-fold-search
6686 (mode-chars (string-to-vector mode-string))
6687 (owner-read (aref mode-chars 1))
6688 (owner-write (aref mode-chars 2))
6689 (owner-execute-or-setid (aref mode-chars 3))
6690 (group-read (aref mode-chars 4))
6691 (group-write (aref mode-chars 5))
6692 (group-execute-or-setid (aref mode-chars 6))
6693 (other-read (aref mode-chars 7))
6694 (other-write (aref mode-chars 8))
6695 (other-execute-or-sticky (aref mode-chars 9)))
6699 ((char-equal owner-read ?r) (tramp-octal-to-decimal "00400"))
6700 ((char-equal owner-read ?-) 0)
6701 (t (error "Second char `%c' must be one of `r-'" owner-read)))
6703 ((char-equal owner-write ?w) (tramp-octal-to-decimal "00200"))
6704 ((char-equal owner-write ?-) 0)
6705 (t (error "Third char `%c' must be one of `w-'" owner-write)))
6707 ((char-equal owner-execute-or-setid ?x)
6708 (tramp-octal-to-decimal "00100"))
6709 ((char-equal owner-execute-or-setid ?S)
6710 (tramp-octal-to-decimal "04000"))
6711 ((char-equal owner-execute-or-setid ?s)
6712 (tramp-octal-to-decimal "04100"))
6713 ((char-equal owner-execute-or-setid ?-) 0)
6714 (t (error "Fourth char `%c' must be one of `xsS-'"
6715 owner-execute-or-setid)))
6717 ((char-equal group-read ?r) (tramp-octal-to-decimal "00040"))
6718 ((char-equal group-read ?-) 0)
6719 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
6721 ((char-equal group-write ?w) (tramp-octal-to-decimal "00020"))
6722 ((char-equal group-write ?-) 0)
6723 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
6725 ((char-equal group-execute-or-setid ?x)
6726 (tramp-octal-to-decimal "00010"))
6727 ((char-equal group-execute-or-setid ?S)
6728 (tramp-octal-to-decimal "02000"))
6729 ((char-equal group-execute-or-setid ?s)
6730 (tramp-octal-to-decimal "02010"))
6731 ((char-equal group-execute-or-setid ?-) 0)
6732 (t (error "Seventh char `%c' must be one of `xsS-'"
6733 group-execute-or-setid)))
6735 ((char-equal other-read ?r)
6736 (tramp-octal-to-decimal "00004"))
6737 ((char-equal other-read ?-) 0)
6738 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
6740 ((char-equal other-write ?w) (tramp-octal-to-decimal "00002"))
6741 ((char-equal other-write ?-) 0)
6742 (t (error "Nineth char `%c' must be one of `w-'" other-write)))
6744 ((char-equal other-execute-or-sticky ?x)
6745 (tramp-octal-to-decimal "00001"))
6746 ((char-equal other-execute-or-sticky ?T)
6747 (tramp-octal-to-decimal "01000"))
6748 ((char-equal other-execute-or-sticky ?t)
6749 (tramp-octal-to-decimal "01001"))
6750 ((char-equal other-execute-or-sticky ?-) 0)
6751 (t (error "Tenth char `%c' must be one of `xtT-'"
6752 other-execute-or-sticky)))))))
6754 (defun tramp-convert-file-attributes (vec attr)
6755 "Convert file-attributes ATTR generated by perl script, stat or ls.
6756 Convert file mode bits to string and set virtual device number.
6758 ;; Convert last access time.
6759 (unless (listp (nth 4 attr))
6760 (setcar (nthcdr 4 attr)
6761 (list (floor (nth 4 attr) 65536)
6762 (floor (mod (nth 4 attr) 65536)))))
6763 ;; Convert last modification time.
6764 (unless (listp (nth 5 attr))
6765 (setcar (nthcdr 5 attr)
6766 (list (floor (nth 5 attr) 65536)
6767 (floor (mod (nth 5 attr) 65536)))))
6768 ;; Convert last status change time.
6769 (unless (listp (nth 6 attr))
6770 (setcar (nthcdr 6 attr)
6771 (list (floor (nth 6 attr) 65536)
6772 (floor (mod (nth 6 attr) 65536)))))
6773 ;; Convert file size.
6774 (when (< (nth 7 attr) 0)
6775 (setcar (nthcdr 7 attr) -1))
6776 (when (and (floatp (nth 7 attr))
6777 (<= (nth 7 attr) (tramp-compat-most-positive-fixnum)))
6778 (setcar (nthcdr 7 attr) (round (nth 7 attr))))
6779 ;; Convert file mode bits to string.
6780 (unless (stringp (nth 8 attr))
6781 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr)))
6782 (when (stringp (car attr))
6783 (aset (nth 8 attr) 0 ?l)))
6784 ;; Convert directory indication bit.
6785 (when (string-match "^d" (nth 8 attr))
6787 ;; Convert symlink from `tramp-handle-file-attributes-with-stat'.
6788 (when (consp (car attr))
6789 (if (and (stringp (caar attr))
6790 (string-match ".+ -> .\\(.+\\)." (caar attr)))
6791 (setcar attr (match-string 1 (caar attr)))
6793 ;; Set file's gid change bit.
6794 (setcar (nthcdr 9 attr)
6795 (if (numberp (nth 3 attr))
6796 (not (= (nth 3 attr)
6797 (tramp-get-remote-gid vec 'integer)))
6800 (tramp-get-remote-gid vec 'string)))))
6802 (unless (listp (nth 10 attr))
6803 (setcar (nthcdr 10 attr)
6805 (cons (floor (nth 10 attr) 65536)
6806 (floor (mod (nth 10 attr) 65536)))
6807 ;; Inodes can be incredible huge. We must hide this.
6808 (error (tramp-get-inode vec)))))
6809 ;; Set virtual device number.
6810 (setcar (nthcdr 11 attr)
6811 (tramp-get-device vec))
6814 (defun tramp-get-inode (vec)
6815 "Returns the virtual inode number.
6816 If it doesn't exist, generate a new one."
6817 (let ((string (tramp-make-tramp-file-name
6818 (tramp-file-name-method vec)
6819 (tramp-file-name-user vec)
6820 (tramp-file-name-host vec)
6822 (unless (assoc string tramp-inodes)
6823 (add-to-list 'tramp-inodes
6824 (list string (length tramp-inodes))))
6825 (nth 1 (assoc string tramp-inodes))))
6827 (defun tramp-get-device (vec)
6828 "Returns the virtual device number.
6829 If it doesn't exist, generate a new one."
6830 (let ((string (tramp-make-tramp-file-name
6831 (tramp-file-name-method vec)
6832 (tramp-file-name-user vec)
6833 (tramp-file-name-host vec)
6835 (unless (assoc string tramp-devices)
6836 (add-to-list 'tramp-devices
6837 (list string (length tramp-devices))))
6838 (cons -1 (nth 1 (assoc string tramp-devices)))))
6840 (defun tramp-file-mode-from-int (mode)
6841 "Turn an integer representing a file mode into an ls(1)-like string."
6842 (let ((type (cdr (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
6843 (user (logand (lsh mode -6) 7))
6844 (group (logand (lsh mode -3) 7))
6845 (other (logand (lsh mode -0) 7))
6846 (suid (> (logand (lsh mode -9) 4) 0))
6847 (sgid (> (logand (lsh mode -9) 2) 0))
6848 (sticky (> (logand (lsh mode -9) 1) 0)))
6849 (setq user (tramp-file-mode-permissions user suid "s"))
6850 (setq group (tramp-file-mode-permissions group sgid "s"))
6851 (setq other (tramp-file-mode-permissions other sticky "t"))
6852 (concat type user group other)))
6854 (defun tramp-file-mode-permissions (perm suid suid-text)
6855 "Convert a permission bitset into a string.
6856 This is used internally by `tramp-file-mode-from-int'."
6857 (let ((r (> (logand perm 4) 0))
6858 (w (> (logand perm 2) 0))
6859 (x (> (logand perm 1) 0)))
6860 (concat (or (and r "r") "-")
6861 (or (and w "w") "-")
6862 (or (and suid x suid-text) ; suid, execute
6863 (and suid (upcase suid-text)) ; suid, !execute
6864 (and x "x") "-")))) ; !suid
6866 (defun tramp-decimal-to-octal (i)
6867 "Return a string consisting of the octal digits of I.
6868 Not actually used. Use `(format \"%o\" i)' instead?"
6869 (cond ((< i 0) (error "Cannot convert negative number to octal"))
6870 ((not (integerp i)) (error "Cannot convert non-integer to octal"))
6872 (t (concat (tramp-decimal-to-octal (/ i 8))
6873 (number-to-string (% i 8))))))
6875 ;; Kudos to Gerd Moellmann for this suggestion.
6876 (defun tramp-octal-to-decimal (ostr)
6877 "Given a string of octal digits, return a decimal number."
6878 (let ((x (or ostr "")))
6879 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
6880 (unless (string-match "\\`[0-7]*\\'" x)
6881 (error "Non-octal junk in string `%s'" x))
6882 (string-to-number ostr 8)))
6884 (defun tramp-shell-case-fold (string)
6885 "Converts STRING to shell glob pattern which ignores case."
6888 (if (equal (downcase c) (upcase c))
6890 (format "[%c%c]" (downcase c) (upcase c))))
6895 ;; ------------------------------------------------------------
6896 ;; -- Tramp file names --
6897 ;; ------------------------------------------------------------
6898 ;; Conversion functions between external representation and
6899 ;; internal data structure. Convenience functions for internal
6902 (defun tramp-file-name-p (vec)
6903 "Check whether VEC is a Tramp object."
6904 (and (vectorp vec) (= 4 (length vec))))
6906 (defun tramp-file-name-method (vec)
6907 "Return method component of VEC."
6908 (and (tramp-file-name-p vec) (aref vec 0)))
6910 (defun tramp-file-name-user (vec)
6911 "Return user component of VEC."
6912 (and (tramp-file-name-p vec) (aref vec 1)))
6914 (defun tramp-file-name-host (vec)
6915 "Return host component of VEC."
6916 (and (tramp-file-name-p vec) (aref vec 2)))
6918 (defun tramp-file-name-localname (vec)
6919 "Return localname component of VEC."
6920 (and (tramp-file-name-p vec) (aref vec 3)))
6922 ;; The user part of a Tramp file name vector can be of kind
6923 ;; "user%domain". Sometimes, we must extract these parts.
6924 (defun tramp-file-name-real-user (vec)
6925 "Return the user name of VEC without domain."
6926 (let ((user (tramp-file-name-user vec)))
6927 (if (and (stringp user)
6928 (string-match tramp-user-with-domain-regexp user))
6929 (match-string 1 user)
6932 (defun tramp-file-name-domain (vec)
6933 "Return the domain name of VEC."
6934 (let ((user (tramp-file-name-user vec)))
6936 (string-match tramp-user-with-domain-regexp user)
6937 (match-string 2 user))))
6939 ;; The host part of a Tramp file name vector can be of kind
6940 ;; "host#port". Sometimes, we must extract these parts.
6941 (defun tramp-file-name-real-host (vec)
6942 "Return the host name of VEC without port."
6943 (let ((host (tramp-file-name-host vec)))
6944 (if (and (stringp host)
6945 (string-match tramp-host-with-port-regexp host))
6946 (match-string 1 host)
6949 (defun tramp-file-name-port (vec)
6950 "Return the port number of VEC."
6951 (let ((host (tramp-file-name-host vec)))
6953 (string-match tramp-host-with-port-regexp host)
6954 (string-to-number (match-string 2 host)))))
6956 (defun tramp-tramp-file-p (name)
6957 "Return t if NAME is a Tramp file."
6959 (string-match tramp-file-name-regexp name)))
6961 (defun tramp-find-method (method user host)
6962 "Return the right method string to use.
6963 This is METHOD, if non-nil. Otherwise, do a lookup in
6964 `tramp-default-method-alist'."
6966 (let ((choices tramp-default-method-alist)
6969 (setq item (pop choices))
6970 (when (and (string-match (or (nth 0 item) "") (or host ""))
6971 (string-match (or (nth 1 item) "") (or user "")))
6972 (setq lmethod (nth 2 item))
6973 (setq choices nil)))
6975 tramp-default-method))
6977 (defun tramp-find-user (method user host)
6978 "Return the right user string to use.
6979 This is USER, if non-nil. Otherwise, do a lookup in
6980 `tramp-default-user-alist'."
6982 (let ((choices tramp-default-user-alist)
6985 (setq item (pop choices))
6986 (when (and (string-match (or (nth 0 item) "") (or method ""))
6987 (string-match (or (nth 1 item) "") (or host "")))
6988 (setq luser (nth 2 item))
6989 (setq choices nil)))
6991 tramp-default-user))
6993 (defun tramp-find-host (method user host)
6994 "Return the right host string to use.
6995 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
6996 (or (and (> (length host) 0) host)
6997 tramp-default-host))
6999 (defun tramp-dissect-file-name (name &optional nodefault)
7000 "Return a `tramp-file-name' structure.
7001 The structure consists of remote method, remote user, remote host
7002 and localname (file name on remote host). If NODEFAULT is
7003 non-nil, the file name parts are not expanded to their default
7006 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
7007 (unless match (error "Not a Tramp file name: %s" name))
7008 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
7009 (user (match-string (nth 2 tramp-file-name-structure) name))
7010 (host (match-string (nth 3 tramp-file-name-structure) name))
7011 (localname (match-string (nth 4 tramp-file-name-structure) name)))
7012 (when (member method '("multi" "multiu"))
7014 "`%s' method is no longer supported, see (info \"(tramp)Multi-hops\")"
7017 (when (string-match tramp-prefix-ipv6-regexp host)
7018 (setq host (replace-match "" nil t host)))
7019 (when (string-match tramp-postfix-ipv6-regexp host)
7020 (setq host (replace-match "" nil t host))))
7022 (vector method user host localname)
7024 (tramp-find-method method user host)
7025 (tramp-find-user method user host)
7026 (tramp-find-host method user host)
7029 (defun tramp-equal-remote (file1 file2)
7030 "Checks, whether the remote parts of FILE1 and FILE2 are identical.
7031 The check depends on method, user and host name of the files. If
7032 one of the components is missing, the default values are used.
7033 The local file name parts of FILE1 and FILE2 are not taken into
7038 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
7040 would yield `t'. On the other hand, the following check results in nil:
7042 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
7043 (and (stringp (file-remote-p file1))
7044 (stringp (file-remote-p file2))
7045 (string-equal (file-remote-p file1) (file-remote-p file2))))
7047 (defun tramp-make-tramp-file-name (method user host localname)
7048 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME."
7049 (concat tramp-prefix-format
7050 (when (not (zerop (length method)))
7051 (concat method tramp-postfix-method-format))
7052 (when (not (zerop (length user)))
7053 (concat user tramp-postfix-user-format))
7055 (if (string-match tramp-ipv6-regexp host)
7056 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
7058 tramp-postfix-host-format
7059 (when localname localname)))
7061 (defun tramp-completion-make-tramp-file-name (method user host localname)
7062 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
7063 It must not be a complete Tramp file name, but as long as there are
7064 necessary only. This function will be used in file name completion."
7065 (concat tramp-prefix-format
7066 (when (not (zerop (length method)))
7067 (concat method tramp-postfix-method-format))
7068 (when (not (zerop (length user)))
7069 (concat user tramp-postfix-user-format))
7070 (when (not (zerop (length host)))
7072 (if (string-match tramp-ipv6-regexp host)
7073 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
7075 tramp-postfix-host-format))
7076 (when localname localname)))
7078 (defun tramp-make-copy-program-file-name (vec)
7079 "Create a file name suitable to be passed to `rcp' and workalikes."
7080 (let ((user (tramp-file-name-user vec))
7081 (host (tramp-file-name-real-host vec))
7082 (localname (tramp-shell-quote-argument
7083 (tramp-file-name-localname vec))))
7084 (if (not (zerop (length user)))
7085 (format "%s@%s:%s" user host localname)
7086 (format "%s:%s" host localname))))
7088 (defun tramp-method-out-of-band-p (vec)
7089 "Return t if this is an out-of-band method, nil otherwise."
7090 (tramp-get-method-parameter (tramp-file-name-method vec) 'tramp-copy-program))
7092 (defun tramp-local-host-p (vec)
7093 "Return t if this points to the local host, nil otherwise."
7094 ;; We cannot use `tramp-file-name-real-host'. A port is an
7095 ;; indication for an ssh tunnel or alike.
7096 (let ((host (tramp-file-name-host vec)))
7099 (string-match tramp-local-host-regexp host)
7100 ;; The local temp directory must be writable for the other user.
7102 (tramp-make-tramp-file-name
7103 (tramp-file-name-method vec)
7104 (tramp-file-name-user vec)
7106 (tramp-compat-temporary-file-directory))))))
7108 ;; Variables local to connection.
7110 (defun tramp-get-remote-path (vec)
7111 (with-connection-property vec "remote-path"
7112 (let* ((remote-path (tramp-compat-copy-tree tramp-remote-path))
7113 (elt (memq 'tramp-default-remote-path remote-path))
7114 (default-remote-path
7118 (tramp-send-command-and-read vec "getconf PATH"))
7119 ;; Default if "getconf" is not available.
7123 "`getconf PATH' not successful, using default value \"%s\"."
7125 "/bin:/usr/bin")))))
7127 ;; Replace place holder `tramp-default-remote-path'.
7130 (tramp-split-string default-remote-path ":")
7132 (setq remote-path (delq 'tramp-default-remote-path remote-path)))
7134 ;; Remove non-existing directories.
7140 (with-connection-property vec x
7142 (tramp-make-tramp-file-name
7143 (tramp-file-name-method vec)
7144 (tramp-file-name-user vec)
7145 (tramp-file-name-host vec)
7150 (defun tramp-get-remote-tmpdir (vec)
7151 (with-connection-property vec "tmp-directory"
7152 (let ((dir (tramp-shell-quote-argument "/tmp")))
7154 (tramp-send-command-and-check
7155 vec (format "%s -d %s" (tramp-get-test-command vec) dir)))
7157 (tramp-send-command-and-check
7158 vec (format "%s -w %s" (tramp-get-test-command vec) dir))))
7160 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
7162 (defun tramp-get-ls-command (vec)
7163 (with-connection-property vec "ls"
7164 (with-current-buffer (tramp-get-buffer vec)
7165 (tramp-message vec 5 "Finding a suitable `ls' command")
7168 (dolist (cmd '("ls" "gnuls" "gls"))
7169 (let ((dl (tramp-get-remote-path vec))
7175 (tramp-find-executable vec cmd dl t t)))
7177 (when (zerop (tramp-send-command-and-check
7178 vec (format "%s -lnd /" result)))
7179 (throw 'ls-found result))
7180 (setq dl (cdr dl))))))
7181 (tramp-error vec 'file-error "Couldn't find a proper `ls' command")))))
7183 (defun tramp-get-test-command (vec)
7184 (with-connection-property vec "test"
7185 (with-current-buffer (tramp-get-buffer vec)
7186 (tramp-message vec 5 "Finding a suitable `test' command")
7187 (if (zerop (tramp-send-command-and-check vec "test 0"))
7189 (tramp-find-executable vec "test" (tramp-get-remote-path vec))))))
7191 (defun tramp-get-test-nt-command (vec)
7192 ;; Does `test A -nt B' work? Use abominable `find' construct if it
7193 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
7194 ;; for otherwise the shell crashes.
7195 (with-connection-property vec "test-nt"
7199 vec (format "( %s / -nt / )" (tramp-get-test-command vec)))
7200 (with-current-buffer (tramp-get-buffer vec)
7201 (goto-char (point-min))
7202 (when (looking-at (regexp-quote tramp-end-of-output))
7203 (format "%s %%s -nt %%s" (tramp-get-test-command vec)))))
7208 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
7209 (tramp-get-test-command vec)))
7210 "tramp_test_nt %s %s"))))
7212 (defun tramp-get-file-exists-command (vec)
7213 (with-connection-property vec "file-exists"
7214 (with-current-buffer (tramp-get-buffer vec)
7215 (tramp-message vec 5 "Finding command to check if file exists")
7216 (tramp-find-file-exists-command vec))))
7218 (defun tramp-get-remote-ln (vec)
7219 (with-connection-property vec "ln"
7220 (with-current-buffer (tramp-get-buffer vec)
7221 (tramp-message vec 5 "Finding a suitable `ln' command")
7222 (tramp-find-executable vec "ln" (tramp-get-remote-path vec)))))
7224 (defun tramp-get-remote-perl (vec)
7225 (with-connection-property vec "perl"
7226 (with-current-buffer (tramp-get-buffer vec)
7227 (tramp-message vec 5 "Finding a suitable `perl' command")
7228 (or (tramp-find-executable vec "perl5" (tramp-get-remote-path vec))
7229 (tramp-find-executable vec "perl" (tramp-get-remote-path vec))))))
7231 (defun tramp-get-remote-stat (vec)
7232 (with-connection-property vec "stat"
7233 (with-current-buffer (tramp-get-buffer vec)
7234 (tramp-message vec 5 "Finding a suitable `stat' command")
7235 (let ((result (tramp-find-executable
7236 vec "stat" (tramp-get-remote-path vec)))
7238 ;; Check whether stat(1) returns usable syntax. %s does not
7239 ;; work on older AIX systems.
7242 ;; We don't want to display an error message.
7243 (with-temp-message (or (current-message) "")
7245 (tramp-send-command-and-read
7246 vec (format "%s -c '(\"%%N\" %%s)' /" result))
7248 (unless (and (listp tmp) (stringp (car tmp))
7249 (string-match "^./.$" (car tmp))
7250 (integerp (cadr tmp)))
7254 (defun tramp-get-remote-id (vec)
7255 (with-connection-property vec "id"
7256 (with-current-buffer (tramp-get-buffer vec)
7257 (tramp-message vec 5 "Finding POSIX `id' command")
7260 (let ((dl (tramp-get-remote-path vec))
7266 (tramp-find-executable vec "id" dl t t)))
7267 ;; Check POSIX parameter.
7268 (when (zerop (tramp-send-command-and-check
7269 vec (format "%s -u" result)))
7270 (throw 'id-found result))
7271 (setq dl (cdr dl)))))
7272 (tramp-error vec 'file-error "Couldn't find a POSIX `id' command")))))
7274 (defun tramp-get-remote-uid (vec id-format)
7275 (with-connection-property vec (format "uid-%s" id-format)
7276 (let ((res (tramp-send-command-and-read
7278 (format "%s -u%s %s"
7279 (tramp-get-remote-id vec)
7280 (if (equal id-format 'integer) "" "n")
7281 (if (equal id-format 'integer)
7282 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7283 ;; The command might not always return a number.
7284 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7286 (defun tramp-get-remote-gid (vec id-format)
7287 (with-connection-property vec (format "gid-%s" id-format)
7288 (let ((res (tramp-send-command-and-read
7290 (format "%s -g%s %s"
7291 (tramp-get-remote-id vec)
7292 (if (equal id-format 'integer) "" "n")
7293 (if (equal id-format 'integer)
7294 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7295 ;; The command might not always return a number.
7296 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7298 (defun tramp-get-local-uid (id-format)
7299 (if (equal id-format 'integer) (user-uid) (user-login-name)))
7301 (defun tramp-get-local-gid (id-format)
7302 (nth 3 (tramp-compat-file-attributes "~/" id-format)))
7304 ;; Some predefined connection properties.
7305 (defun tramp-get-remote-coding (vec prop)
7306 ;; Local coding handles properties like remote coding. So we could
7307 ;; call it without pain.
7308 (let ((ret (tramp-get-local-coding vec prop)))
7309 ;; The connection property might have been cached. So we must send
7310 ;; the script - maybe.
7311 (when (and ret (symbolp ret))
7312 (let ((name (symbol-name ret)))
7313 (while (string-match (regexp-quote "-") name)
7314 (setq name (replace-match "_" nil t name)))
7315 (tramp-maybe-send-script vec (symbol-value ret) name)
7317 ;; Return the value.
7320 (defun tramp-get-local-coding (vec prop)
7322 (tramp-get-connection-property vec prop nil)
7324 (tramp-find-inline-encoding vec)
7325 (tramp-get-connection-property vec prop nil))))
7327 (defun tramp-get-method-parameter (method param)
7328 "Return the method parameter PARAM.
7329 If the `tramp-methods' entry does not exist, return NIL."
7330 (let ((entry (assoc param (assoc method tramp-methods))))
7331 (when entry (cadr entry))))
7333 ;; Auto saving to a special directory.
7335 (defun tramp-exists-file-name-handler (operation &rest args)
7336 "Checks whether OPERATION runs a file name handler."
7337 ;; The file name handler is determined on base of either an
7338 ;; argument, `buffer-file-name', or `default-directory'.
7340 (let* ((buffer-file-name "/")
7341 (default-directory "/")
7342 (fnha file-name-handler-alist)
7343 (check-file-name-operation operation)
7344 (file-name-handler-alist
7347 '(lambda (operation &rest args)
7348 "Returns OPERATION if it is the one to be checked."
7349 (if (equal check-file-name-operation operation)
7351 (let ((file-name-handler-alist fnha))
7352 (apply operation args))))))))
7353 (equal (apply operation args) operation))
7356 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
7357 (defadvice make-auto-save-file-name
7358 (around tramp-advice-make-auto-save-file-name () activate)
7359 "Invoke `tramp-handle-make-auto-save-file-name' for Tramp files."
7360 (if (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))
7361 (setq ad-return-value (tramp-handle-make-auto-save-file-name))
7363 (add-hook 'tramp-unload-hook
7364 '(lambda () (ad-unadvise 'make-auto-save-file-name))))
7366 ;; In Emacs < 22 and XEmacs < 21.5 autosaved remote files have
7367 ;; permission 0666 minus umask. This is a security threat.
7369 (defun tramp-set-auto-save-file-modes ()
7370 "Set permissions of autosaved remote files to the original permissions."
7371 (let ((bfn (buffer-file-name)))
7372 (when (and (stringp bfn)
7373 (tramp-tramp-file-p bfn)
7375 (stringp buffer-auto-save-file-name)
7376 (not (equal bfn buffer-auto-save-file-name)))
7377 (unless (file-exists-p buffer-auto-save-file-name)
7378 (write-region "" nil buffer-auto-save-file-name))
7379 ;; Permissions should be set always, because there might be an old
7380 ;; auto-saved file belonging to another original file. This could
7381 ;; be a security threat.
7382 (set-file-modes buffer-auto-save-file-name
7383 (or (file-modes bfn) (tramp-octal-to-decimal "0600"))))))
7385 (unless (or (> emacs-major-version 21)
7386 (and (featurep 'xemacs)
7387 (= emacs-major-version 21)
7388 (> emacs-minor-version 4)))
7389 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
7390 (add-hook 'tramp-unload-hook
7392 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
7394 (defun tramp-subst-strs-in-string (alist string)
7395 "Replace all occurrences of the string FROM with TO in STRING.
7396 ALIST is of the form ((FROM . TO) ...)."
7399 (let* ((pr (car alist))
7402 (while (string-match (regexp-quote from) string)
7403 (setq string (replace-match to t t string)))
7404 (setq alist (cdr alist))))
7407 ;; ------------------------------------------------------------
7408 ;; -- Compatibility functions section --
7409 ;; ------------------------------------------------------------
7411 (defun tramp-read-passwd (proc &optional prompt)
7412 "Read a password from user (compat function).
7413 Consults the auth-source package.
7414 Invokes `password-read' if available, `read-passwd' else."
7415 (let* ((key (tramp-make-tramp-file-name
7416 tramp-current-method tramp-current-user
7417 tramp-current-host ""))
7420 (with-current-buffer (process-buffer proc)
7421 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
7422 (format "%s for %s " (capitalize (match-string 1)) key)))))
7425 ;; See if auth-sources contains something useful, if it's bound.
7426 (when (boundp 'auth-sources)
7427 ;; Try with Tramp's current method.
7428 (funcall (symbol-function 'auth-source-user-or-password)
7429 "password" tramp-current-host tramp-current-method))
7430 ;; Else, get the password interactively.
7431 (if (functionp 'password-read)
7432 (let ((password (funcall (symbol-function 'password-read)
7434 (funcall (symbol-function 'password-cache-add) key password)
7436 (read-passwd pw-prompt)))))
7438 (defun tramp-clear-passwd (vec)
7439 "Clear password cache for connection related to VEC."
7440 (when (functionp 'password-cache-remove)
7442 (symbol-function 'password-cache-remove)
7443 (tramp-make-tramp-file-name
7444 (tramp-file-name-method vec)
7445 (tramp-file-name-user vec)
7446 (tramp-file-name-host vec)
7449 ;; Snarfed code from time-date.el and parse-time.el
7451 (defconst tramp-half-a-year '(241 17024)
7452 "Evaluated by \"(days-to-time 183)\".")
7454 (defconst tramp-parse-time-months
7455 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
7456 ("apr" . 4) ("may" . 5) ("jun" . 6)
7457 ("jul" . 7) ("aug" . 8) ("sep" . 9)
7458 ("oct" . 10) ("nov" . 11) ("dec" . 12))
7459 "Alist mapping month names to integers.")
7461 (defun tramp-time-less-p (t1 t2)
7462 "Say whether time value T1 is less than time value T2."
7463 (unless t1 (setq t1 '(0 0)))
7464 (unless t2 (setq t2 '(0 0)))
7465 (or (< (car t1) (car t2))
7466 (and (= (car t1) (car t2))
7467 (< (nth 1 t1) (nth 1 t2)))))
7469 (defun tramp-time-subtract (t1 t2)
7470 "Subtract two time values.
7471 Return the difference in the format of a time value."
7472 (unless t1 (setq t1 '(0 0)))
7473 (unless t2 (setq t2 '(0 0)))
7474 (let ((borrow (< (cadr t1) (cadr t2))))
7475 (list (- (car t1) (car t2) (if borrow 1 0))
7476 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
7478 (defun tramp-time-diff (t1 t2)
7479 "Return the difference between the two times, in seconds.
7480 T1 and T2 are time values (as returned by `current-time' for example)."
7481 ;; Pacify byte-compiler with `symbol-function'.
7482 (cond ((and (fboundp 'subtract-time)
7483 (fboundp 'float-time))
7484 (funcall (symbol-function 'float-time)
7485 (funcall (symbol-function 'subtract-time) t1 t2)))
7486 ((and (fboundp 'subtract-time)
7487 (fboundp 'time-to-seconds))
7488 (funcall (symbol-function 'time-to-seconds)
7489 (funcall (symbol-function 'subtract-time) t1 t2)))
7490 ((fboundp 'itimer-time-difference)
7491 (funcall (symbol-function 'itimer-time-difference)
7492 (if (< (length t1) 3) (append t1 '(0)) t1)
7493 (if (< (length t2) 3) (append t2 '(0)) t2)))
7495 (let ((time (tramp-time-subtract t1 t2)))
7496 (+ (* (car time) 65536.0)
7498 (/ (or (nth 2 time) 0) 1000000.0))))))
7500 (defun tramp-coding-system-change-eol-conversion (coding-system eol-type)
7501 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
7502 EOL-TYPE can be one of `dos', `unix', or `mac'."
7503 (cond ((fboundp 'coding-system-change-eol-conversion)
7504 (funcall (symbol-function 'coding-system-change-eol-conversion)
7505 coding-system eol-type))
7506 ((fboundp 'subsidiary-coding-system)
7507 (funcall (symbol-function 'subsidiary-coding-system)
7509 (cond ((eq eol-type 'dos) 'crlf)
7510 ((eq eol-type 'unix) 'lf)
7511 ((eq eol-type 'mac) 'cr)
7513 (error "Unknown EOL-TYPE `%s', must be %s"
7515 "`dos', `unix', or `mac'")))))
7516 (t (error "Can't change EOL conversion -- is MULE missing?"))))
7518 (defun tramp-split-string (string pattern)
7519 "Like `split-string' but omit empty strings.
7520 In Emacs, (split-string \"/foo/bar\" \"/\") returns (\"foo\" \"bar\").
7521 This is, the first, empty, element is omitted. In XEmacs, the first
7522 element is not omitted.
7524 Note: this function has been written for `tramp-handle-file-truename'.
7525 If you want to use it for something else, you'll have to check whether
7526 it does the right thing."
7527 (delete "" (split-string string pattern)))
7529 (defun tramp-set-process-query-on-exit-flag (process flag)
7530 "Specify if query is needed for process when Emacs is exited.
7531 If the second argument flag is non-nil, Emacs will query the user before
7532 exiting if process is running."
7533 (if (fboundp 'set-process-query-on-exit-flag)
7534 (funcall (symbol-function 'set-process-query-on-exit-flag) process flag)
7535 (funcall (symbol-function 'process-kill-without-query) process flag)))
7538 ;; ------------------------------------------------------------
7539 ;; -- Kludges section --
7540 ;; ------------------------------------------------------------
7542 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
7543 ;; does not deal well with newline characters. Newline is replaced by
7544 ;; backslash newline. But if, say, the string `a backslash newline b'
7545 ;; is passed to a shell, the shell will expand this into "ab",
7546 ;; completely omitting the newline. This is not what was intended.
7547 ;; It does not appear to be possible to make the function
7548 ;; `shell-quote-argument' work with newlines without making it
7549 ;; dependent on the shell used. But within this package, we know that
7550 ;; we will always use a Bourne-like shell, so we use an approach which
7553 ;; The approach is simple: we call `shell-quote-argument', then
7554 ;; massage the newline part of the result.
7556 ;; This function should produce a string which is grokked by a Unix
7557 ;; shell, even if the Emacs is running on Windows. Since this is the
7558 ;; kludges section, we bind `system-type' in such a way that
7559 ;; `shell-quote-arguments' behaves as if on Unix.
7561 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
7562 ;; function to work with Bourne-like shells.
7564 ;; CCC: This function should be rewritten so that
7565 ;; `shell-quote-argument' is not used. This way, we are safe from
7566 ;; changes in `shell-quote-argument'.
7567 (defun tramp-shell-quote-argument (s)
7568 "Similar to `shell-quote-argument', but groks newlines.
7569 Only works for Bourne-like shells."
7570 (let ((system-type 'not-windows))
7572 (let ((result (shell-quote-argument s))
7573 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
7574 (when (and (>= (length result) 2)
7575 (string= (substring result 0 2) "\\~"))
7576 (setq result (substring result 1)))
7577 (while (string-match nl result)
7578 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
7582 ;; We currently (sometimes) use "[" and "]" in the filename format.
7583 ;; This means that Emacs wants to expand wildcards if
7584 ;; `find-file-wildcards' is non-nil, and then barfs because no
7585 ;; expansion could be found. We detect this situation and do
7586 ;; something really awful: we have `file-expand-wildcards' return the
7587 ;; original filename if it can't expand anything. Let's just hope
7588 ;; that this doesn't break anything else.
7589 ;; CCC: This check is now also really awful; we should search all
7590 ;; of the filename format, not just the prefix.
7591 (when (string-match "\\[" tramp-prefix-format)
7592 (defadvice file-expand-wildcards
7593 (around tramp-advice-file-expand-wildcards activate)
7594 (let ((name (ad-get-arg 0)))
7595 (if (tramp-tramp-file-p name)
7596 ;; If it's a Tramp file, dissect it and look if wildcards
7597 ;; need to be expanded at all.
7600 (tramp-file-name-localname (tramp-dissect-file-name name)))
7601 (setq ad-return-value (or ad-do-it (list name)))
7602 (setq ad-return-value (list name)))
7603 ;; If it is not a Tramp file, just run the original function.
7604 (setq ad-return-value (or ad-do-it (list name))))))
7605 (add-hook 'tramp-unload-hook
7606 '(lambda () (ad-unadvise 'file-expand-wildcards))))
7608 ;; Checklist for `tramp-unload-hook'
7609 ;; - Unload all `tramp-*' packages
7610 ;; - Reset `file-name-handler-alist'
7611 ;; - Cleanup hooks where Tramp functions are in
7612 ;; - Cleanup advised functions
7613 ;; - Cleanup autoloads
7615 (defun tramp-unload-tramp ()
7616 "Discard Tramp from loading remote files."
7618 ;; When Tramp is not loaded yet, its autoloads are still active.
7619 (tramp-unload-file-name-handlers)
7620 ;; ange-ftp settings must be enabled.
7621 (when (functionp 'tramp-ftp-enable-ange-ftp)
7622 (funcall (symbol-function 'tramp-ftp-enable-ange-ftp)))
7623 ;; Maybe its not loaded yet.
7625 (unload-feature 'tramp 'force)
7628 (when (and load-in-progress
7629 (string-match "Loading tramp..." (or (current-message) "")))
7630 (message "Loading tramp...done"))
7636 ;; * Allow putting passwords in the filename.
7637 ;; This should be implemented via a general mechanism to add
7638 ;; parameters in filenames. There is currently a kludge for
7639 ;; putting the port number into the filename for ssh and ftp
7640 ;; files. This could be subsumed by the new mechanism as well.
7641 ;; Another approach is to read a netrc file like ~/.authinfo
7643 ;; * Handle nonlocal exits such as C-g.
7644 ;; * But it would probably be better to use with-local-quit at the
7645 ;; place where it's actually needed: around any potentially
7646 ;; indefinitely blocking piece of code. In this case it would be
7647 ;; within Tramp around one of its calls to accept-process-output (or
7648 ;; around one of the loops that calls accept-process-output)
7649 ;; (Stefan Monnier).
7650 ;; * Autodetect if remote `ls' groks the "--dired" switch.
7651 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
7652 ;; `shell-quote-argument'.
7653 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
7654 ;; by the files in that directory. Add this here.
7655 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
7656 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
7657 ;; * When logging in, keep looking for questions according to an alist
7658 ;; and then invoke the right function.
7659 ;; * Case-insensitive filename completion. (Norbert Goevert.)
7660 ;; * Don't use globbing for directories with many files, as this is
7661 ;; likely to produce long command lines, and some shells choke on
7662 ;; long command lines.
7663 ;; * `vc-directory' does not work. It never displays any files, even
7664 ;; if it does show files when run locally.
7665 ;; * Allow correction of passwords, if the remote end allows this.
7666 ;; (Mark Hershberger)
7667 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
7668 ;; * Grok `append' parameter for `write-region'.
7669 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
7670 ;; * abbreviate-file-name
7671 ;; * better error checking. At least whenever we see something
7672 ;; strange when doing zerop, we should kill the process and start
7673 ;; again. (Greg Stark)
7674 ;; * Provide a local cache of old versions of remote files for the rsync
7675 ;; transfer method to use. (Greg Stark)
7676 ;; * Remove unneeded parameters from methods.
7677 ;; * Invoke rsync once for copying a whole directory hierarchy.
7678 ;; (Francesco Potortì)
7679 ;; * Make it work for different encodings, and for different file name
7680 ;; encodings, too. (Daniel Pittman)
7681 ;; * Progress reports while copying files. (Michael Kifer)
7682 ;; * Don't search for perl5 and perl. Instead, only search for perl and
7683 ;; then look if it's the right version (with `perl -v').
7684 ;; * When editing a remote CVS controlled file as a different user, VC
7685 ;; gets confused about the file locking status. Try to find out why
7686 ;; the workaround doesn't work.
7687 ;; * Username and hostname completion.
7688 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
7689 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
7690 ;; Code is nearly identical.
7691 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
7692 ;; until the last but one hop via `start-file-process'. Apply it
7693 ;; also for ftp and smb.
7694 ;; * WIBNI if we had a command "trampclient"? If I was editing in
7695 ;; some shell with root priviledges, it would be nice if I could
7697 ;; trampclient filename.c
7698 ;; as an editor, and the _current_ shell would connect to an Emacs
7699 ;; server and would be used in an existing non-priviledged Emacs
7700 ;; session for doing the editing in question.
7701 ;; That way, I need not tell Emacs my password again and be afraid
7702 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
7703 ;; once display a just typed password in the context of a keyboard
7704 ;; sequence prompt for a question immediately following in a shell
7705 ;; script run within Emacs -- nasty).
7706 ;; And if I have some ssh session running to a different computer,
7707 ;; having the possibility of passing a local file there to a local
7708 ;; Emacs session (in case I can arrange for a connection back) would
7710 ;; Likely the corresponding Tramp server should not allow the
7711 ;; equivalent of the emacsclient -eval option in order to make this
7712 ;; reasonably unproblematic. And maybe trampclient should have some
7713 ;; way of passing credentials, like by using an SSL socket or
7714 ;; something. (David Kastrup)
7715 ;; * Could Tramp reasonably look for a prompt after ^M rather than
7716 ;; only after ^J ? (Stefan Monnier)
7717 ;; * Reconnect directly to a compliant shell without first going
7718 ;; through the user's default shell. (Pete Forman)
7719 ;; * Make `tramp-default-user' obsolete.
7720 ;; * Tramp shall reconnect automatically to its ssh connection when it
7721 ;; detects that the process "has died". (David Reitter)
7722 ;; * How can I interrupt the remote process with a signal
7723 ;; (interrupt-process seems not to work)? (Markus Triska)
7724 ;; * Avoid the local shell entirely for starting remote processes. If
7725 ;; so, I think even a signal, when delivered directly to the local
7726 ;; SSH instance, would correctly be propagated to the remote process
7727 ;; automatically; possibly SSH would have to be started with
7728 ;; "-t". (Markus Triska)
7729 ;; * Add gvfs support.
7730 ;; * Set `tramp-copy-size-limit' to 0, when there is no remote
7731 ;; encoding routine.
7732 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
7733 ;; isn't on the remote host. (Mark A. Hershberger)
7735 ;; Functions for file-name-handler-alist:
7736 ;; diff-latest-backup-file -- in diff.el
7737 ;; dired-uncache -- this will be needed when we do insert-directory caching
7738 ;; file-name-sans-versions -- use primitive?
7739 ;; get-file-buffer -- use primitive
7742 ;; arch-tag: 3a21a994-182b-48fa-b0cd-c1d9fede424a
7743 ;;; tramp.el ends here