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 ;; tramp-gvfs needs D-Bus messages. Available since Emacs 23
144 ;; on some system types. We don't call `dbus-ping', because
145 ;; this would load dbus.el.
146 (when (and (featurep 'dbusbind)
148 (funcall 'dbus-get-unique-name :session)
150 (tramp-compat-process-running-p "gvfs-fuse-daemon"))
153 ;; Load gateways. It needs `make-network-process' from Emacs 22.
154 (when (functionp 'make-network-process) 'tramp-gw)
156 ;; tramp-imap needs both epa (from Emacs 23.1) and imap-hash
157 ;; (from Emacs 23.2).
158 (when (and (locate-library "epa") (locate-library "imap-hash"))
162 ;; We have used just some basic tests, whether a package shall
163 ;; be added. There might still be other errors during loading,
164 ;; which we will catch here.
165 (catch 'tramp-loading
167 (add-hook 'tramp-unload-hook
169 (when (featurep (quote ,feature))
170 (unload-feature (quote ,feature) 'force)))))
171 (unless (featurep feature)
172 (message "Loading %s failed, ignoring this package" feature)))))
174 ;;; User Customizable Internal Variables:
177 "Edit remote files with a combination of rsh and rcp or similar programs."
181 ;; Maybe we need once a real Tramp mode, with key bindings etc.
183 (defcustom tramp-mode t
184 "*Whether Tramp is enabled.
185 If it is set to nil, all remote file names are used literally."
189 (defcustom tramp-verbose 3
190 "*Verbosity level for Tramp messages.
191 Any level x includes messages for all levels 1 .. x-1. The levels are
193 0 silent (no tramp messages at all)
196 3 connection to remote hosts (default level)
199 6 sent and received strings
201 8 connection properties
208 (when (boundp 'backup-directory-alist)
209 (defcustom tramp-backup-directory-alist nil
210 "Alist of filename patterns and backup directory names.
211 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
212 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
213 is a local file name, the backup directory is prepended with Tramp file
214 name prefix \(method, user, host\) of file.
216 \(setq tramp-backup-directory-alist backup-directory-alist\)
218 gives the same backup policy for Tramp files on their hosts like the
219 policy for local files."
221 :type '(repeat (cons (regexp :tag "Regexp matching filename")
222 (directory :tag "Backup directory name"))))))
224 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
225 ;; the package "backup-dir" might not be loaded yet.
227 (when (featurep 'xemacs)
228 (defcustom tramp-bkup-backup-directory-info nil
229 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
230 It has the same meaning like `bkup-backup-directory-info' from package
231 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
232 file name, the backup directory is prepended with Tramp file name prefix
233 \(method, user, host\) of file.
235 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
237 gives the same backup policy for Tramp files on their hosts like the
238 policy for local files."
240 (list (regexp :tag "File regexp")
241 (string :tag "Backup Dir")
246 (const search-upward))))
249 (defcustom tramp-auto-save-directory nil
250 "*Put auto-save files in this directory, if set.
251 The idea is to use a local directory so that auto-saving is faster."
253 :type '(choice (const nil) string))
255 (defcustom tramp-encoding-shell
256 (if (memq system-type '(windows-nt))
259 "*Use this program for encoding and decoding commands on the local host.
260 This shell is used to execute the encoding and decoding command on the
261 local host, so if you want to use `~' in those commands, you should
262 choose a shell here which groks tilde expansion. `/bin/sh' normally
263 does not understand tilde expansion.
265 For encoding and deocding, commands like the following are executed:
267 /bin/sh -c COMMAND < INPUT > OUTPUT
269 This variable can be used to change the \"/bin/sh\" part. See the
270 variable `tramp-encoding-command-switch' for the \"-c\" part.
272 Note that this variable is not used for remote commands. There are
273 mechanisms in tramp.el which automatically determine the right shell to
274 use for the remote host."
276 :type '(file :must-match t))
278 (defcustom tramp-encoding-command-switch
279 (if (string-match "cmd\\.exe" tramp-encoding-shell)
282 "*Use this switch together with `tramp-encoding-shell' for local commands.
283 See the variable `tramp-encoding-shell' for more information."
287 (defcustom tramp-copy-size-limit 10240
288 "*The maximum file size where inline copying is preferred over an out-of-the-band copy."
292 (defcustom tramp-terminal-type "dumb"
293 "*Value of TERM environment variable for logging in to remote host.
294 Because Tramp wants to parse the output of the remote shell, it is easily
295 confused by ANSI color escape sequences and suchlike. Often, shell init
296 files conditionalize this setup based on the TERM environment variable."
300 (defvar tramp-methods
301 `(("rcp" (tramp-login-program "rsh")
302 (tramp-login-args (("%h") ("-l" "%u")))
303 (tramp-remote-sh "/bin/sh")
304 (tramp-copy-program "rcp")
305 (tramp-copy-args (("-p" "%k") ("-r")))
306 (tramp-copy-keep-date t)
307 (tramp-copy-recursive t)
308 (tramp-password-end-of-line nil))
309 ("scp" (tramp-login-program "ssh")
310 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
312 (tramp-remote-sh "/bin/sh")
313 (tramp-copy-program "scp")
314 (tramp-copy-args (("-P" "%p") ("-p" "%k")
316 (tramp-copy-keep-date t)
317 (tramp-copy-recursive t)
318 (tramp-password-end-of-line nil)
319 (tramp-gw-args (("-o"
320 "GlobalKnownHostsFile=/dev/null")
321 ("-o" "UserKnownHostsFile=/dev/null")
322 ("-o" "StrictHostKeyChecking=no")))
323 (tramp-default-port 22))
324 ("scp1" (tramp-login-program "ssh")
325 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
327 (tramp-remote-sh "/bin/sh")
328 (tramp-copy-program "scp")
329 (tramp-copy-args (("-1") ("-P" "%p") ("-p" "%k")
331 (tramp-copy-keep-date t)
332 (tramp-copy-recursive t)
333 (tramp-password-end-of-line nil)
334 (tramp-gw-args (("-o"
335 "GlobalKnownHostsFile=/dev/null")
336 ("-o" "UserKnownHostsFile=/dev/null")
337 ("-o" "StrictHostKeyChecking=no")))
338 (tramp-default-port 22))
339 ("scp2" (tramp-login-program "ssh")
340 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
342 (tramp-remote-sh "/bin/sh")
343 (tramp-copy-program "scp")
344 (tramp-copy-args (("-2") ("-P" "%p") ("-p" "%k")
346 (tramp-copy-keep-date t)
347 (tramp-copy-recursive t)
348 (tramp-password-end-of-line nil)
349 (tramp-gw-args (("-o"
350 "GlobalKnownHostsFile=/dev/null")
351 ("-o" "UserKnownHostsFile=/dev/null")
352 ("-o" "StrictHostKeyChecking=no")))
353 (tramp-default-port 22))
355 (tramp-login-program "ssh1")
356 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
358 (tramp-remote-sh "/bin/sh")
359 (tramp-copy-program "scp1")
360 (tramp-copy-args (("-p" "%k") ("-r")))
361 (tramp-copy-keep-date t)
362 (tramp-copy-recursive t)
363 (tramp-password-end-of-line nil))
365 (tramp-login-program "ssh2")
366 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
368 (tramp-remote-sh "/bin/sh")
369 (tramp-copy-program "scp2")
370 (tramp-copy-args (("-p" "%k") ("-r")))
371 (tramp-copy-keep-date t)
372 (tramp-copy-recursive t)
373 (tramp-password-end-of-line nil))
374 ("sftp" (tramp-login-program "ssh")
375 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
377 (tramp-remote-sh "/bin/sh")
378 (tramp-copy-program "sftp")
379 (tramp-copy-args nil)
380 (tramp-copy-keep-date nil)
381 (tramp-password-end-of-line nil))
382 ("rsync" (tramp-login-program "ssh")
383 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
385 (tramp-remote-sh "/bin/sh")
386 (tramp-copy-program "rsync")
387 (tramp-copy-args (("-e" "ssh") ("-t" "%k") ("-r")))
388 (tramp-copy-keep-date t)
389 (tramp-copy-recursive t)
390 (tramp-password-end-of-line nil))
392 (tramp-login-program "ssh")
393 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
394 ("-o" "ControlPath=%t.%%r@%%h:%%p")
395 ("-o" "ControlMaster=yes")
397 (tramp-remote-sh "/bin/sh")
398 (tramp-copy-program "rsync")
399 (tramp-copy-args (("-t" "%k") ("-r")))
400 (tramp-copy-env (("RSYNC_RSH")
403 " -o ControlPath=%t.%%r@%%h:%%p"
404 " -o ControlMaster=auto"))))
405 (tramp-copy-keep-date t)
406 (tramp-copy-recursive t)
407 (tramp-password-end-of-line nil))
408 ("remcp" (tramp-login-program "remsh")
409 (tramp-login-args (("%h") ("-l" "%u")))
410 (tramp-remote-sh "/bin/sh")
411 (tramp-copy-program "rcp")
412 (tramp-copy-args (("-p" "%k")))
413 (tramp-copy-keep-date t)
414 (tramp-password-end-of-line nil))
415 ("rsh" (tramp-login-program "rsh")
416 (tramp-login-args (("%h") ("-l" "%u")))
417 (tramp-remote-sh "/bin/sh")
418 (tramp-copy-program nil)
419 (tramp-copy-args nil)
420 (tramp-copy-keep-date nil)
421 (tramp-password-end-of-line nil))
422 ("ssh" (tramp-login-program "ssh")
423 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
425 (tramp-remote-sh "/bin/sh")
426 (tramp-copy-program nil)
427 (tramp-copy-args nil)
428 (tramp-copy-keep-date nil)
429 (tramp-password-end-of-line nil)
430 (tramp-gw-args (("-o"
431 "GlobalKnownHostsFile=/dev/null")
432 ("-o" "UserKnownHostsFile=/dev/null")
433 ("-o" "StrictHostKeyChecking=no")))
434 (tramp-default-port 22))
435 ("ssh1" (tramp-login-program "ssh")
436 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
438 (tramp-remote-sh "/bin/sh")
439 (tramp-copy-program nil)
440 (tramp-copy-args nil)
441 (tramp-copy-keep-date nil)
442 (tramp-password-end-of-line nil)
443 (tramp-gw-args (("-o"
444 "GlobalKnownHostsFile=/dev/null")
445 ("-o" "UserKnownHostsFile=/dev/null")
446 ("-o" "StrictHostKeyChecking=no")))
447 (tramp-default-port 22))
448 ("ssh2" (tramp-login-program "ssh")
449 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
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 (tramp-gw-args (("-o"
457 "GlobalKnownHostsFile=/dev/null")
458 ("-o" "UserKnownHostsFile=/dev/null")
459 ("-o" "StrictHostKeyChecking=no")))
460 (tramp-default-port 22))
462 (tramp-login-program "ssh1")
463 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
465 (tramp-remote-sh "/bin/sh")
466 (tramp-copy-program nil)
467 (tramp-copy-args nil)
468 (tramp-copy-keep-date nil)
469 (tramp-password-end-of-line nil))
471 (tramp-login-program "ssh2")
472 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p")
474 (tramp-remote-sh "/bin/sh")
475 (tramp-copy-program nil)
476 (tramp-copy-args nil)
477 (tramp-copy-keep-date nil)
478 (tramp-password-end-of-line nil))
479 ("remsh" (tramp-login-program "remsh")
480 (tramp-login-args (("%h") ("-l" "%u")))
481 (tramp-remote-sh "/bin/sh")
482 (tramp-copy-program nil)
483 (tramp-copy-args nil)
484 (tramp-copy-keep-date nil)
485 (tramp-password-end-of-line nil))
487 (tramp-login-program "telnet")
488 (tramp-login-args (("%h") ("%p")))
489 (tramp-remote-sh "/bin/sh")
490 (tramp-copy-program nil)
491 (tramp-copy-args nil)
492 (tramp-copy-keep-date nil)
493 (tramp-password-end-of-line nil)
494 (tramp-default-port 23))
495 ("su" (tramp-login-program "su")
496 (tramp-login-args (("-") ("%u")))
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 ("sudo" (tramp-login-program "sudo")
503 (tramp-login-args (("-u" "%u")
504 ("-s") ("-H") ("-p" "Password:")))
505 (tramp-remote-sh "/bin/sh")
506 (tramp-copy-program nil)
507 (tramp-copy-args nil)
508 (tramp-copy-keep-date nil)
509 (tramp-password-end-of-line nil))
510 ("scpc" (tramp-login-program "ssh")
511 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
512 ("-o" "ControlPath=%t.%%r@%%h:%%p")
513 ("-o" "ControlMaster=yes")
515 (tramp-remote-sh "/bin/sh")
516 (tramp-copy-program "scp")
517 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q")
518 ("-o" "ControlPath=%t.%%r@%%h:%%p")
519 ("-o" "ControlMaster=auto")))
520 (tramp-copy-keep-date t)
521 (tramp-password-end-of-line nil)
522 (tramp-gw-args (("-o"
523 "GlobalKnownHostsFile=/dev/null")
524 ("-o" "UserKnownHostsFile=/dev/null")
525 ("-o" "StrictHostKeyChecking=no")))
526 (tramp-default-port 22))
527 ("scpx" (tramp-login-program "ssh")
528 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
529 ("-e" "none" "-t" "-t" "/bin/sh")))
530 (tramp-remote-sh "/bin/sh")
531 (tramp-copy-program "scp")
532 (tramp-copy-args (("-p" "%k")))
533 (tramp-copy-keep-date t)
534 (tramp-password-end-of-line nil)
535 (tramp-gw-args (("-o"
536 "GlobalKnownHostsFile=/dev/null")
537 ("-o" "UserKnownHostsFile=/dev/null")
538 ("-o" "StrictHostKeyChecking=no")))
539 (tramp-default-port 22))
540 ("sshx" (tramp-login-program "ssh")
541 (tramp-login-args (("%h") ("-l" "%u") ("-p" "%p") ("-q")
542 ("-e" "none" "-t" "-t" "/bin/sh")))
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 (tramp-gw-args (("-o"
549 "GlobalKnownHostsFile=/dev/null")
550 ("-o" "UserKnownHostsFile=/dev/null")
551 ("-o" "StrictHostKeyChecking=no")))
552 (tramp-default-port 22))
554 (tramp-login-program "krlogin")
555 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
556 (tramp-remote-sh "/bin/sh")
557 (tramp-copy-program nil)
558 (tramp-copy-args nil)
559 (tramp-copy-keep-date nil)
560 (tramp-password-end-of-line nil))
561 ("plink" (tramp-login-program "plink")
562 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
564 (tramp-remote-sh "/bin/sh")
565 (tramp-copy-program nil)
566 (tramp-copy-args nil)
567 (tramp-copy-keep-date nil)
568 (tramp-password-end-of-line "xy") ;see docstring for "xy"
569 (tramp-default-port 22))
571 (tramp-login-program "plink")
572 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
574 (tramp-remote-sh "/bin/sh")
575 (tramp-copy-program nil)
576 (tramp-copy-args nil)
577 (tramp-copy-keep-date nil)
578 (tramp-password-end-of-line "xy") ;see docstring for "xy"
579 (tramp-default-port 22))
581 (tramp-login-program "plink")
582 ;; ("%h") must be a single element, see
583 ;; `tramp-compute-multi-hops'.
584 (tramp-login-args (("-load") ("%h") ("-t")
586 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=$ '"
587 tramp-terminal-type))
589 (tramp-remote-sh "/bin/sh")
590 (tramp-copy-program nil)
591 (tramp-copy-args nil)
592 (tramp-copy-keep-date nil)
593 (tramp-password-end-of-line nil))
594 ("pscp" (tramp-login-program "plink")
595 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
597 (tramp-remote-sh "/bin/sh")
598 (tramp-copy-program "pscp")
599 (tramp-copy-args (("-P" "%p") ("-scp") ("-p" "%k")))
600 (tramp-copy-keep-date t)
601 (tramp-password-end-of-line "xy") ;see docstring for "xy"
602 (tramp-default-port 22))
603 ("psftp" (tramp-login-program "plink")
604 (tramp-login-args (("%h") ("-l" "%u") ("-P" "%p")
606 (tramp-remote-sh "/bin/sh")
607 (tramp-copy-program "pscp")
608 (tramp-copy-args (("-P" "%p") ("-sftp") ("-p" "%k")))
609 (tramp-copy-keep-date t)
610 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
611 ("fcp" (tramp-login-program "fsh")
612 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
613 (tramp-remote-sh "/bin/sh -i")
614 (tramp-copy-program "fcp")
615 (tramp-copy-args (("-p" "%k")))
616 (tramp-copy-keep-date t)
617 (tramp-password-end-of-line nil)))
618 "*Alist of methods for remote files.
619 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
620 Each NAME stands for a remote access method. Each PARAM is a
621 pair of the form (KEY VALUE). The following KEYs are defined:
623 This specifies the Bourne shell to use on the remote host. This
624 MUST be a Bourne-like shell. It is normally not necessary to set
625 this to any value other than \"/bin/sh\": Tramp wants to use a shell
626 which groks tilde expansion, but it can search for it. Also note
627 that \"/bin/sh\" exists on all Unixen, this might not be true for
628 the value that you decide to use. You Have Been Warned.
629 * `tramp-login-program'
630 This specifies the name of the program to use for logging in to the
631 remote host. This may be the name of rsh or a workalike program,
632 or the name of telnet or a workalike, or the name of su or a workalike.
634 This specifies the list of arguments to pass to the above
635 mentioned program. Please note that this is a list of list of arguments,
636 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
637 here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
638 There are some patterns: \"%h\" in this list is replaced by the host
639 name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
640 port number, and \"%%\" can be used to obtain a literal percent character.
641 If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
642 expansion (i.e. no host or no user specified), this list is not used as
643 argument. By this, arguments like (\"-l\" \"%u\") are optional.
644 \"%t\" is replaced by the temporary file name produced with
645 `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date
646 parameter of a program, if exists.
647 * `tramp-copy-program'
648 This specifies the name of the program to use for remotely copying
649 the file; this might be the absolute filename of rcp or the name of
652 This specifies the list of parameters to pass to the above mentioned
653 program, the hints for `tramp-login-args' also apply here.
654 * `tramp-copy-keep-date'
655 This specifies whether the copying program when the preserves the
656 timestamp of the original file.
657 * `tramp-default-port'
658 The default port of a method is needed in case of gateway connections.
659 Additionally, it is used as indication which method is prepared for
662 As the attribute name says, additional arguments are specified here
663 when a method is applied via a gateway.
664 * `tramp-password-end-of-line'
665 This specifies the string to use for terminating the line after
666 submitting the password. If this method parameter is nil, then the
667 value of the normal variable `tramp-default-password-end-of-line'
668 is used. This parameter is necessary because the \"plink\" program
669 requires any two characters after sending the password. These do
670 not have to be newline or carriage return characters. Other login
671 programs are happy with just one character, the newline character.
672 We use \"xy\" as the value for methods using \"plink\".
674 What does all this mean? Well, you should specify `tramp-login-program'
675 for all methods; this program is used to log in to the remote site. Then,
676 there are two ways to actually transfer the files between the local and the
677 remote side. One way is using an additional rcp-like program. If you want
678 to do this, set `tramp-copy-program' in the method.
680 Another possibility for file transfer is inline transfer, i.e. the
681 file is passed through the same buffer used by `tramp-login-program'. In
682 this case, the file contents need to be protected since the
683 `tramp-login-program' might use escape codes or the connection might not
684 be eight-bit clean. Therefore, file contents are encoded for transit.
685 See the variables `tramp-local-coding-commands' and
686 `tramp-remote-coding-commands' for details.
688 So, to summarize: if the method is an out-of-band method, then you
689 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
690 inline method, then these two parameters should be nil. Methods which
691 are fit for gateways must have `tramp-default-port' at least.
695 When using `su' or `sudo' the phrase `open connection to a remote
696 host' sounds strange, but it is used nevertheless, for consistency.
697 No connection is opened to a remote host, but `su' or `sudo' is
698 started on the local host. You should specify a remote host
699 `localhost' or the name of the local host. Another host name is
700 useful only in combination with `tramp-default-proxies-alist'.")
702 (defcustom tramp-default-method
703 ;; An external copy method seems to be preferred, because it is much
704 ;; more performant for large files, and it hasn't too serious delays
705 ;; for small files. But it must be ensured that there aren't
706 ;; permanent password queries. Either a password agent like
707 ;; "ssh-agent" or "Pageant" shall run, or the optional
708 ;; password-cache.el or auth-sources.el packages shall be active for
709 ;; password caching. "scpc" would be another good choice because of
710 ;; the "ControlMaster" option, but this is a more modern alternative
711 ;; in OpenSSH 4, which cannot be taken as default.
713 ;; PuTTY is installed.
714 ((executable-find "pscp")
715 (if (or (fboundp 'password-read)
716 (fboundp 'auth-source-user-or-password)
717 ;; Pageant is running.
718 (tramp-compat-process-running-p "Pageant"))
721 ;; There is an ssh installation.
722 ((executable-find "scp")
723 (if (or (fboundp 'password-read)
724 (fboundp 'auth-source-user-or-password)
725 ;; ssh-agent is running.
726 (getenv "SSH_AUTH_SOCK")
727 (getenv "SSH_AGENT_PID"))
732 "*Default method to use for transferring files.
733 See `tramp-methods' for possibilities.
734 Also see `tramp-default-method-alist'."
738 (defcustom tramp-default-method-alist
739 '(("\\`localhost\\'" "\\`root\\'" "su"))
740 "*Default method to use for specific host/user pairs.
741 This is an alist of items (HOST USER METHOD). The first matching item
742 specifies the method to use for a file name which does not specify a
743 method. HOST and USER are regular expressions or nil, which is
744 interpreted as a regular expression which always matches. If no entry
745 matches, the variable `tramp-default-method' takes effect.
747 If the file name does not specify the user, lookup is done using the
748 empty string for the user name.
750 See `tramp-methods' for a list of possibilities for METHOD."
752 :type '(repeat (list (regexp :tag "Host regexp")
753 (regexp :tag "User regexp")
754 (string :tag "Method"))))
756 (defcustom tramp-default-user
758 "*Default user to use for transferring files.
759 It is nil by default; otherwise settings in configuration files like
760 \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'.
762 This variable is regarded as obsolete, and will be removed soon."
764 :type '(choice (const nil) string))
766 (defcustom tramp-default-user-alist
767 `(("\\`su\\(do\\)?\\'" nil "root")
768 ("\\`r\\(em\\)?\\(cp\\|sh\\)\\|telnet\\|plink1?\\'"
769 nil ,(user-login-name)))
770 "*Default user to use for specific method/host pairs.
771 This is an alist of items (METHOD HOST USER). The first matching item
772 specifies the user to use for a file name which does not specify a
773 user. METHOD and USER are regular expressions or nil, which is
774 interpreted as a regular expression which always matches. If no entry
775 matches, the variable `tramp-default-user' takes effect.
777 If the file name does not specify the method, lookup is done using the
778 empty string for the method name."
780 :type '(repeat (list (regexp :tag "Method regexp")
781 (regexp :tag "Host regexp")
782 (string :tag "User"))))
784 (defcustom tramp-default-host
786 "*Default host to use for transferring files.
787 Useful for su and sudo methods mostly."
791 (defcustom tramp-default-proxies-alist nil
792 "*Route to be followed for specific host/user pairs.
793 This is an alist of items (HOST USER PROXY). The first matching
794 item specifies the proxy to be passed for a file name located on
795 a remote target matching USER@HOST. HOST and USER are regular
796 expressions. PROXY must be a Tramp filename without a localname
797 part. Method and user name on PROXY are optional, which is
798 interpreted with the default values. PROXY can contain the
799 patterns %h and %u, which are replaced by the strings matching
800 HOST or USER, respectively.
802 HOST, USER or PROXY could also be Lisp forms, which will be
803 evaluated. The result must be a string or nil, which is
804 interpreted as a regular expression which always matches."
806 :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
807 (choice :tag "User regexp" regexp sexp)
808 (choice :tag "Proxy remote name" string (const nil)))))
810 (defconst tramp-local-host-regexp
812 "^" (regexp-opt (list "localhost" (system-name) "127\.0\.0\.1" "::1") t) "$")
813 "*Host names which are regarded as local host.")
815 (defconst tramp-completion-function-alist-rsh
816 '((tramp-parse-rhosts "/etc/hosts.equiv")
817 (tramp-parse-rhosts "~/.rhosts"))
818 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
820 (defconst tramp-completion-function-alist-ssh
821 '((tramp-parse-rhosts "/etc/hosts.equiv")
822 (tramp-parse-rhosts "/etc/shosts.equiv")
823 (tramp-parse-shosts "/etc/ssh_known_hosts")
824 (tramp-parse-sconfig "/etc/ssh_config")
825 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
826 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
827 (tramp-parse-rhosts "~/.rhosts")
828 (tramp-parse-rhosts "~/.shosts")
829 (tramp-parse-shosts "~/.ssh/known_hosts")
830 (tramp-parse-sconfig "~/.ssh/config")
831 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
832 (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
833 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
835 (defconst tramp-completion-function-alist-telnet
836 '((tramp-parse-hosts "/etc/hosts"))
837 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
839 (defconst tramp-completion-function-alist-su
840 '((tramp-parse-passwd "/etc/passwd"))
841 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
843 (defconst tramp-completion-function-alist-putty
845 "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"))
846 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty methods.")
848 (defvar tramp-completion-function-alist nil
849 "*Alist of methods for remote files.
850 This is a list of entries of the form (NAME PAIR1 PAIR2 ...).
851 Each NAME stands for a remote access method. Each PAIR is of the form
852 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
853 names from FILE for completion. The following predefined FUNCTIONs exists:
855 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
856 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
857 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
858 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
859 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
860 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
861 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
862 * `tramp-parse-netrc' for \"~/.netrc\" like files.
863 * `tramp-parse-putty' for PuTTY registry keys.
865 FUNCTION can also be a customer defined function. For more details see
868 (eval-after-load "tramp"
870 (tramp-set-completion-function
871 "rcp" tramp-completion-function-alist-rsh)
872 (tramp-set-completion-function
873 "scp" tramp-completion-function-alist-ssh)
874 (tramp-set-completion-function
875 "scp1" tramp-completion-function-alist-ssh)
876 (tramp-set-completion-function
877 "scp2" tramp-completion-function-alist-ssh)
878 (tramp-set-completion-function
879 "scp1_old" tramp-completion-function-alist-ssh)
880 (tramp-set-completion-function
881 "scp2_old" tramp-completion-function-alist-ssh)
882 (tramp-set-completion-function
883 "rsync" tramp-completion-function-alist-ssh)
884 (tramp-set-completion-function
885 "rsyncc" tramp-completion-function-alist-ssh)
886 (tramp-set-completion-function
887 "remcp" tramp-completion-function-alist-rsh)
888 (tramp-set-completion-function
889 "rsh" tramp-completion-function-alist-rsh)
890 (tramp-set-completion-function
891 "ssh" tramp-completion-function-alist-ssh)
892 (tramp-set-completion-function
893 "ssh1" tramp-completion-function-alist-ssh)
894 (tramp-set-completion-function
895 "ssh2" tramp-completion-function-alist-ssh)
896 (tramp-set-completion-function
897 "ssh1_old" tramp-completion-function-alist-ssh)
898 (tramp-set-completion-function
899 "ssh2_old" tramp-completion-function-alist-ssh)
900 (tramp-set-completion-function
901 "remsh" tramp-completion-function-alist-rsh)
902 (tramp-set-completion-function
903 "telnet" tramp-completion-function-alist-telnet)
904 (tramp-set-completion-function
905 "su" tramp-completion-function-alist-su)
906 (tramp-set-completion-function
907 "sudo" tramp-completion-function-alist-su)
908 (tramp-set-completion-function
909 "scpx" tramp-completion-function-alist-ssh)
910 (tramp-set-completion-function
911 "sshx" tramp-completion-function-alist-ssh)
912 (tramp-set-completion-function
913 "krlogin" tramp-completion-function-alist-rsh)
914 (tramp-set-completion-function
915 "plink" tramp-completion-function-alist-ssh)
916 (tramp-set-completion-function
917 "plink1" tramp-completion-function-alist-ssh)
918 (tramp-set-completion-function
919 "plinkx" tramp-completion-function-alist-putty)
920 (tramp-set-completion-function
921 "pscp" tramp-completion-function-alist-ssh)
922 (tramp-set-completion-function
923 "fcp" tramp-completion-function-alist-ssh)))
925 (defconst tramp-echo-mark-marker "_echo"
926 "String marker to surround echoed commands.")
928 (defconst tramp-echo-mark "_echo\b\b\b\b\b"
929 "String mark to be transmitted around shell commands.
930 Used to separate their echo from the output they produce. This
931 will only be used if we cannot disable remote echo via stty.
932 This string must have no effect on the remote shell except for
933 producing some echo which can later be detected by
934 `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker',
935 followed by an equal number of backspaces to erase them will
938 (defconst tramp-echoed-echo-mark-regexp "_echo\\(\b\\( \b\\)?\\)\\{5\\}"
939 "Regexp which matches `tramp-echo-mark' as it gets echoed by
942 (defcustom tramp-rsh-end-of-line "\n"
943 "*String used for end of line in rsh connections.
944 I don't think this ever needs to be changed, so please tell me about it
945 if you need to change this.
946 Also see the method parameter `tramp-password-end-of-line' and the normal
947 variable `tramp-default-password-end-of-line'."
951 (defcustom tramp-default-password-end-of-line
952 tramp-rsh-end-of-line
953 "*String used for end of line after sending a password.
954 This variable provides the default value for the method parameter
955 `tramp-password-end-of-line', see `tramp-methods' for more details.
957 It seems that people using plink under Windows need to send
958 \"\\r\\n\" (carriage-return, then newline) after a password, but just
959 \"\\n\" after all other lines. This variable can be used for the
960 password, see `tramp-rsh-end-of-line' for the other cases.
962 The default value is to use the same value as `tramp-rsh-end-of-line'."
966 ;; "getconf PATH" yields:
967 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
968 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
969 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
970 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
971 (defcustom tramp-remote-path
972 '(tramp-default-remote-path "/usr/sbin" "/usr/local/bin"
973 "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
974 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin")
975 "*List of directories to search for executables on remote host.
976 For every remote host, this variable will be set buffer local,
977 keeping the list of existing directories on that host.
979 You can use `~' in this list, but when searching for a shell which groks
980 tilde expansion, all directory names starting with `~' will be ignored.
982 `Default Directories' represent the list of directories given by
983 the command \"getconf PATH\". It is recommended to use this
984 entry on top of this list, because these are the default
985 directories for POSIX compatible commands.
987 `Private Directories' are the settings of the $PATH environment,
988 as given in your `~/.profile'."
990 :type '(repeat (choice
991 (const :tag "Default Directories" tramp-default-remote-path)
992 (const :tag "Private Directories" tramp-own-remote-path)
993 (string :tag "Directory"))))
995 (defcustom tramp-remote-process-environment
996 `("HISTFILE=$HOME/.tramp_history" "HISTSIZE=1" "LC_ALL=C"
997 ,(concat "TERM=" tramp-terminal-type)
998 "EMACS=t" ;; Deprecated.
999 ,(format "INSIDE_EMACS=%s,tramp:%s" emacs-version tramp-version)
1000 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH="
1001 "autocorrect=" "correct=")
1003 "*List of environment variables to be set on the remote host.
1005 Each element should be a string of the form ENVVARNAME=VALUE. An
1006 entry ENVVARNAME= diables the corresponding environment variable,
1007 which might have been set in the init files like ~/.profile.
1009 Special handling is applied to the PATH environment, which should
1010 not be set here. Instead of, it should be set via `tramp-remote-path'."
1012 :type '(repeat string))
1014 (defcustom tramp-login-prompt-regexp
1015 ".*ogin\\( .*\\)?: *"
1016 "*Regexp matching login-like prompts.
1017 The regexp should match at end of buffer.
1019 Sometimes the prompt is reported to look like \"login as:\"."
1023 (defcustom tramp-shell-prompt-pattern
1024 ;; Allow a prompt to start right after a ^M since it indeed would be
1025 ;; displayed at the beginning of the line (and Zsh uses it).
1026 "\\(?:^\\|
\\)[^#$%>\n]*[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*"
1027 "Regexp to match prompts from remote shell.
1028 Normally, Tramp expects you to configure `shell-prompt-pattern'
1029 correctly, but sometimes it happens that you are connecting to a
1030 remote host which sends a different kind of shell prompt. Therefore,
1031 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
1032 and also things matched by this variable. The default value of this
1033 variable is similar to the default value of `shell-prompt-pattern',
1034 which should work well in many cases."
1038 (defcustom tramp-password-prompt-regexp
1039 "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *"
1040 "*Regexp matching password-like prompts.
1041 The regexp should match at end of buffer.
1043 The `sudo' program appears to insert a `^@' character into the prompt."
1047 (defcustom tramp-wrong-passwd-regexp
1049 ;; These strings should be on the last line
1050 (regexp-opt '("Permission denied"
1053 "Connection refused"
1056 "Name or service not known"
1057 "Host key verification failed."
1058 "No supported authentication methods left to try!") t)
1062 ;; Here comes a list of regexes, separated by \\|
1063 "Received signal [0-9]+"
1065 "*Regexp matching a `login failed' message.
1066 The regexp should match at end of buffer."
1070 (defcustom tramp-yesno-prompt-regexp
1072 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
1074 "Regular expression matching all yes/no queries which need to be confirmed.
1075 The confirmation should be done with yes or no.
1076 The regexp should match at end of buffer.
1077 See also `tramp-yn-prompt-regexp'."
1081 (defcustom tramp-yn-prompt-regexp
1083 (regexp-opt '("Store key in cache? (y/n)"
1084 "Update cached key? (y/n, Return cancels connection)") t)
1086 "Regular expression matching all y/n queries which need to be confirmed.
1087 The confirmation should be done with y or n.
1088 The regexp should match at end of buffer.
1089 See also `tramp-yesno-prompt-regexp'."
1093 (defcustom tramp-terminal-prompt-regexp
1097 "Terminal type\\? \\[.*\\]"
1099 "Regular expression matching all terminal setting prompts.
1100 The regexp should match at end of buffer.
1101 The answer will be provided by `tramp-action-terminal', which see."
1105 (defcustom tramp-operation-not-permitted-regexp
1106 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
1107 (regexp-opt '("Operation not permitted") t))
1108 "Regular expression matching keep-date problems in (s)cp operations.
1109 Copying has been performed successfully already, so this message can
1114 (defcustom tramp-copy-failed-regexp
1116 (regexp-opt '("Permission denied"
1117 "not a regular file"
1119 "No such file or directory") t)
1121 "Regular expression matching copy problems in (s)cp operations."
1125 (defcustom tramp-process-alive-regexp
1127 "Regular expression indicating a process has finished.
1128 In fact this expression is empty by intention, it will be used only to
1129 check regularly the status of the associated process.
1130 The answer will be provided by `tramp-action-process-alive',
1131 `tramp-action-out-of-band', which see."
1135 (defcustom tramp-temp-name-prefix "tramp."
1136 "*Prefix to use for temporary files.
1137 If this is a relative file name (such as \"tramp.\"), it is considered
1138 relative to the directory name returned by the function
1139 `tramp-compat-temporary-file-directory' (which see). It may also be an
1140 absolute file name; don't forget to include a prefix for the filename
1145 (defconst tramp-temp-buffer-name " *tramp temp*"
1146 "Buffer name for a temporary buffer.
1147 It shall be used in combination with `generate-new-buffer-name'.")
1149 (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
1150 "*Alist specifying extra arguments to pass to the remote shell.
1151 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
1152 matching the shell file name and ARGS is a string specifying the
1155 This variable is only used when Tramp needs to start up another shell
1156 for tilde expansion. The extra arguments should typically prevent the
1157 shell from reading its init file."
1159 ;; This might be the wrong way to test whether the widget type
1160 ;; `alist' is available. Who knows the right way to test it?
1161 :type (if (get 'alist 'widget-type)
1162 '(alist :key-type string :value-type string)
1163 '(repeat (cons string string))))
1165 ;; XEmacs is distributed with few Lisp packages. Further packages are
1166 ;; installed using EFS. If we use a unified filename format, then
1167 ;; Tramp is required in addition to EFS. (But why can't Tramp just
1168 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
1169 ;; just like before.) Another reason for using a separate filename
1170 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
1171 ;; Tramp only knows how to deal with `file-name-handler-alist', not
1172 ;; the other places.
1174 ;; Currently, we have the choice between 'ftp, 'sep, and 'url.
1176 (defcustom tramp-syntax
1177 (if (featurep 'xemacs) 'sep 'ftp)
1178 "Tramp filename syntax to be used.
1180 It can have the following values:
1182 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default)
1183 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs)
1184 'url -- URL-like syntax."
1186 :type (if (featurep 'xemacs)
1187 '(choice (const :tag "EFS" ftp)
1188 (const :tag "XEmacs" sep)
1189 (const :tag "URL" url))
1190 '(choice (const :tag "Ange-FTP" ftp)
1191 (const :tag "URL" url))))
1193 (defconst tramp-prefix-format
1194 (cond ((equal tramp-syntax 'ftp) "/")
1195 ((equal tramp-syntax 'sep) "/[")
1196 ((equal tramp-syntax 'url) "/")
1197 (t (error "Wrong `tramp-syntax' defined")))
1198 "*String matching the very beginning of Tramp file names.
1199 Used in `tramp-make-tramp-file-name'.")
1201 (defconst tramp-prefix-regexp
1202 (concat "^" (regexp-quote tramp-prefix-format))
1203 "*Regexp matching the very beginning of Tramp file names.
1204 Should always start with \"^\". Derived from `tramp-prefix-format'.")
1206 (defconst tramp-method-regexp
1208 "*Regexp matching methods identifiers.")
1210 (defconst tramp-postfix-method-format
1211 (cond ((equal tramp-syntax 'ftp) ":")
1212 ((equal tramp-syntax 'sep) "/")
1213 ((equal tramp-syntax 'url) "://")
1214 (t (error "Wrong `tramp-syntax' defined")))
1215 "*String matching delimeter between method and user or host names.
1216 Used in `tramp-make-tramp-file-name'.")
1218 (defconst tramp-postfix-method-regexp
1219 (regexp-quote tramp-postfix-method-format)
1220 "*Regexp matching delimeter between method and user or host names.
1221 Derived from `tramp-postfix-method-format'.")
1223 (defconst tramp-user-regexp
1225 "*Regexp matching user names.")
1227 (defconst tramp-prefix-domain-format "%"
1228 "*String matching delimeter between user and domain names.")
1230 (defconst tramp-prefix-domain-regexp
1231 (regexp-quote tramp-prefix-domain-format)
1232 "*Regexp matching delimeter between user and domain names.
1233 Derived from `tramp-prefix-domain-format'.")
1235 (defconst tramp-domain-regexp
1237 "*Regexp matching domain names.")
1239 (defconst tramp-user-with-domain-regexp
1240 (concat "\\(" tramp-user-regexp "\\)"
1241 tramp-prefix-domain-regexp
1242 "\\(" tramp-domain-regexp "\\)")
1243 "*Regexp matching user names with domain names.")
1245 (defconst tramp-postfix-user-format
1247 "*String matching delimeter between user and host names.
1248 Used in `tramp-make-tramp-file-name'.")
1250 (defconst tramp-postfix-user-regexp
1251 (regexp-quote tramp-postfix-user-format)
1252 "*Regexp matching delimeter between user and host names.
1253 Derived from `tramp-postfix-user-format'.")
1255 (defconst tramp-host-regexp
1257 "*Regexp matching host names.")
1259 (defconst tramp-prefix-ipv6-format
1260 (cond ((equal tramp-syntax 'ftp) "[")
1261 ((equal tramp-syntax 'sep) "")
1262 ((equal tramp-syntax 'url) "[")
1263 (t (error "Wrong `tramp-syntax' defined")))
1264 "*String matching left hand side of IPv6 addresses.
1265 Used in `tramp-make-tramp-file-name'.")
1267 (defconst tramp-prefix-ipv6-regexp
1268 (regexp-quote tramp-prefix-ipv6-format)
1269 "*Regexp matching left hand side of IPv6 addresses.
1270 Derived from `tramp-prefix-ipv6-format'.")
1272 ;; The following regexp is a bit sloppy. But it shall serve our
1273 ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in
1274 ;; "::ffff:192.168.0.1".
1275 (defconst tramp-ipv6-regexp
1276 "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
1277 "*Regexp matching IPv6 addresses.")
1279 (defconst tramp-postfix-ipv6-format
1280 (cond ((equal tramp-syntax 'ftp) "]")
1281 ((equal tramp-syntax 'sep) "")
1282 ((equal tramp-syntax 'url) "]")
1283 (t (error "Wrong `tramp-syntax' defined")))
1284 "*String matching right hand side of IPv6 addresses.
1285 Used in `tramp-make-tramp-file-name'.")
1287 (defconst tramp-postfix-ipv6-regexp
1288 (regexp-quote tramp-postfix-ipv6-format)
1289 "*Regexp matching right hand side of IPv6 addresses.
1290 Derived from `tramp-postfix-ipv6-format'.")
1292 (defconst tramp-prefix-port-format
1293 (cond ((equal tramp-syntax 'ftp) "#")
1294 ((equal tramp-syntax 'sep) "#")
1295 ((equal tramp-syntax 'url) ":")
1296 (t (error "Wrong `tramp-syntax' defined")))
1297 "*String matching delimeter between host names and port numbers.")
1299 (defconst tramp-prefix-port-regexp
1300 (regexp-quote tramp-prefix-port-format)
1301 "*Regexp matching delimeter between host names and port numbers.
1302 Derived from `tramp-prefix-port-format'.")
1304 (defconst tramp-port-regexp
1306 "*Regexp matching port numbers.")
1308 (defconst tramp-host-with-port-regexp
1309 (concat "\\(" tramp-host-regexp "\\)"
1310 tramp-prefix-port-regexp
1311 "\\(" tramp-port-regexp "\\)")
1312 "*Regexp matching host names with port numbers.")
1314 (defconst tramp-postfix-host-format
1315 (cond ((equal tramp-syntax 'ftp) ":")
1316 ((equal tramp-syntax 'sep) "]")
1317 ((equal tramp-syntax 'url) "")
1318 (t (error "Wrong `tramp-syntax' defined")))
1319 "*String matching delimeter between host names and localnames.
1320 Used in `tramp-make-tramp-file-name'.")
1322 (defconst tramp-postfix-host-regexp
1323 (regexp-quote tramp-postfix-host-format)
1324 "*Regexp matching delimeter between host names and localnames.
1325 Derived from `tramp-postfix-host-format'.")
1327 (defconst tramp-localname-regexp
1329 "*Regexp matching localnames.")
1331 ;; File name format.
1333 (defconst tramp-file-name-structure
1337 "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
1338 "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
1339 "\\(" "\\(" tramp-host-regexp
1341 tramp-prefix-ipv6-regexp tramp-ipv6-regexp
1342 tramp-postfix-ipv6-regexp "\\)"
1343 "\\(" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?"
1344 tramp-postfix-host-regexp
1345 "\\(" tramp-localname-regexp "\\)")
1348 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
1349 the Tramp file name structure.
1351 The first element REGEXP is a regular expression matching a Tramp file
1352 name. The regex should contain parentheses around the method name,
1353 the user name, the host name, and the file name parts.
1355 The second element METHOD is a number, saying which pair of
1356 parentheses matches the method name. The third element USER is
1357 similar, but for the user name. The fourth element HOST is similar,
1358 but for the host name. The fifth element FILE is for the file name.
1359 These numbers are passed directly to `match-string', which see. That
1360 means the opening parentheses are counted to identify the pair.
1362 See also `tramp-file-name-regexp'.")
1365 (defconst tramp-file-name-regexp-unified
1366 "\\`/\\([^[/:]+\\|[^/]+]\\):"
1367 "Value for `tramp-file-name-regexp' for unified remoting.
1368 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1369 Tramp. See `tramp-file-name-structure' for more explanations.")
1372 (defconst tramp-file-name-regexp-separate
1374 "Value for `tramp-file-name-regexp' for separate remoting.
1375 XEmacs uses a separate filename syntax for Tramp and EFS.
1376 See `tramp-file-name-structure' for more explanations.")
1379 (defconst tramp-file-name-regexp-url
1381 "Value for `tramp-file-name-regexp' for URL-like remoting.
1382 See `tramp-file-name-structure' for more explanations.")
1385 (defconst tramp-file-name-regexp
1386 (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified)
1387 ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate)
1388 ((equal tramp-syntax 'url) tramp-file-name-regexp-url)
1389 (t (error "Wrong `tramp-syntax' defined")))
1390 "*Regular expression matching file names handled by Tramp.
1391 This regexp should match Tramp file names but no other file names.
1392 \(When tramp.el is loaded, this regular expression is prepended to
1393 `file-name-handler-alist', and that is searched sequentially. Thus,
1394 if the Tramp entry appears rather early in the `file-name-handler-alist'
1395 and is a bit too general, then some files might be considered Tramp
1396 files which are not really Tramp files.
1398 Please note that the entry in `file-name-handler-alist' is made when
1399 this file (tramp.el) is loaded. This means that this variable must be set
1400 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1401 updated after changing this variable.
1403 Also see `tramp-file-name-structure'.")
1406 (defconst tramp-root-regexp
1407 (if (memq system-type '(cygwin windows-nt))
1408 "\\`\\([a-zA-Z]:\\)?/"
1410 "Beginning of an incomplete Tramp file name.
1411 Usually, it is just \"\\\\`/\". On W32 systems, there might be a
1412 volume letter, which will be removed by `tramp-drop-volume-letter'.")
1415 (defconst tramp-completion-file-name-regexp-unified
1416 (concat tramp-root-regexp "[^/]*\\'")
1417 "Value for `tramp-completion-file-name-regexp' for unified remoting.
1418 GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP.
1419 See `tramp-file-name-structure' for more explanations.")
1422 (defconst tramp-completion-file-name-regexp-separate
1423 (concat tramp-root-regexp "\\([[][^]]*\\)?\\'")
1424 "Value for `tramp-completion-file-name-regexp' for separate remoting.
1425 XEmacs uses a separate filename syntax for Tramp and EFS.
1426 See `tramp-file-name-structure' for more explanations.")
1429 (defconst tramp-completion-file-name-regexp-url
1430 (concat tramp-root-regexp "[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?\\'")
1431 "Value for `tramp-completion-file-name-regexp' for URL-like remoting.
1432 See `tramp-file-name-structure' for more explanations.")
1435 (defconst tramp-completion-file-name-regexp
1436 (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified)
1437 ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate)
1438 ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url)
1439 (t (error "Wrong `tramp-syntax' defined")))
1440 "*Regular expression matching file names handled by Tramp completion.
1441 This regexp should match partial Tramp file names only.
1443 Please note that the entry in `file-name-handler-alist' is made when
1444 this file (tramp.el) is loaded. This means that this variable must be set
1445 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1446 updated after changing this variable.
1448 Also see `tramp-file-name-structure'.")
1450 (defconst tramp-actions-before-shell
1451 '((tramp-login-prompt-regexp tramp-action-login)
1452 (tramp-password-prompt-regexp tramp-action-password)
1453 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1454 (shell-prompt-pattern tramp-action-succeed)
1455 (tramp-shell-prompt-pattern tramp-action-succeed)
1456 (tramp-yesno-prompt-regexp tramp-action-yesno)
1457 (tramp-yn-prompt-regexp tramp-action-yn)
1458 (tramp-terminal-prompt-regexp tramp-action-terminal)
1459 (tramp-process-alive-regexp tramp-action-process-alive))
1460 "List of pattern/action pairs.
1461 Whenever a pattern matches, the corresponding action is performed.
1462 Each item looks like (PATTERN ACTION).
1464 The PATTERN should be a symbol, a variable. The value of this
1465 variable gives the regular expression to search for. Note that the
1466 regexp must match at the end of the buffer, \"\\'\" is implicitly
1469 The ACTION should also be a symbol, but a function. When the
1470 corresponding PATTERN matches, the ACTION function is called.")
1472 (defconst tramp-actions-copy-out-of-band
1473 '((tramp-password-prompt-regexp tramp-action-password)
1474 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1475 (tramp-copy-failed-regexp tramp-action-permission-denied)
1476 (tramp-process-alive-regexp tramp-action-out-of-band))
1477 "List of pattern/action pairs.
1478 This list is used for copying/renaming with out-of-band methods.
1480 See `tramp-actions-before-shell' for more info.")
1482 ;; Chunked sending kludge. We set this to 500 for black-listed constellations
1483 ;; known to have a bug in `process-send-string'; some ssh connections appear
1484 ;; to drop bytes when data is sent too quickly. There is also a connection
1485 ;; buffer local variable, which is computed depending on remote host properties
1486 ;; when `tramp-chunksize' is zero or nil.
1487 (defcustom tramp-chunksize
1488 (when (and (not (featurep 'xemacs))
1489 (memq system-type '(hpux)))
1491 ;; Parentheses in docstring starting at beginning of line are escaped.
1492 ;; Fontification is messed up when
1493 ;; `open-paren-in-column-0-is-defun-start' set to t.
1494 "*If non-nil, chunksize for sending input to local process.
1495 It is necessary only on systems which have a buggy `process-send-string'
1496 implementation. The necessity, whether this variable must be set, can be
1497 checked via the following code:
1500 (let* ((user \"xxx\") (host \"yyy\")
1502 (sent init) (received init))
1503 (while (= sent received)
1504 (setq sent (+ sent step))
1506 (let ((proc (start-process (buffer-name) (current-buffer)
1507 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
1508 (when (memq (process-status proc) '(run open))
1509 (process-send-string proc (make-string sent ?\\ ))
1510 (process-send-eof proc)
1511 (process-send-eof proc))
1512 (while (not (progn (goto-char (point-min))
1513 (re-search-forward \"\\\\w+\" (point-max) t)))
1514 (accept-process-output proc 1))
1515 (when (memq (process-status proc) '(run open))
1516 (setq received (string-to-number (match-string 0)))
1517 (delete-process proc)
1518 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1520 (if (> sent (+ init step))
1521 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1523 (message \"Test does not work\")
1524 (display-buffer (current-buffer))
1527 In the Emacs normally running Tramp, evaluate the above code
1528 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1529 respectively). You can do this, for example, by pasting it into
1530 the `*scratch*' buffer and then hitting C-j with the cursor after the
1531 last closing parenthesis. Note that it works only if you have configured
1532 \"ssh\" to run without password query, see ssh-agent(1).
1534 You will see the number of bytes sent successfully to the remote host.
1535 If that number exceeds 1000, you can stop the execution by hitting
1536 C-g, because your Emacs is likely clean.
1538 When it is necessary to set `tramp-chunksize', you might consider to
1539 use an out-of-the-band method (like \"scp\") instead of an internal one
1540 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
1543 If your Emacs is buggy, the code stops and gives you an indication
1544 about the value `tramp-chunksize' should be set. Maybe you could just
1545 experiment a bit, e.g. changing the values of `init' and `step'
1546 in the third line of the code.
1548 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1549 this variable to be set as well."
1551 :type '(choice (const nil) integer))
1553 ;; Logging in to a remote host normally requires obtaining a pty. But
1554 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1555 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1556 ;; for an override of the system default.
1557 (defcustom tramp-process-connection-type t
1558 "Overrides `process-connection-type' for connections from Tramp.
1559 Tramp binds process-connection-type to the value given here before
1560 opening a connection to a remote host."
1562 :type '(choice (const nil) (const t) (const pty)))
1564 (defcustom tramp-completion-reread-directory-timeout 10
1565 "Defines seconds since last remote command before rereading a directory.
1566 A remote directory might have changed its contents. In order to
1567 make it visible during file name completion in the minibuffer,
1568 Tramp flushes its cache and rereads the directory contents when
1569 more than `tramp-completion-reread-directory-timeout' seconds
1570 have been gone since last remote command execution. A value of 0
1571 would require an immediate reread during filename completion, nil
1572 means to use always cached values for the directory contents."
1574 :type '(choice (const nil) integer))
1576 ;;; Internal Variables:
1578 (defvar tramp-end-of-output
1581 (md5 (concat (prin1-to-string process-environment) (current-time-string))))
1582 "String used to recognize end of output.
1583 The '$' character at the end is quoted; the string cannot be
1584 detected as prompt when being sent on echoing hosts, therefore.")
1586 (defvar tramp-current-method nil
1587 "Connection method for this *tramp* buffer.")
1589 (defvar tramp-current-user nil
1590 "Remote login name for this *tramp* buffer.")
1592 (defvar tramp-current-host nil
1593 "Remote host for this *tramp* buffer.")
1595 (defconst tramp-uudecode
1596 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
1598 rm -f /tmp/tramp.$$"
1599 "Shell function to implement `uudecode' to standard output.
1600 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
1601 for this or `uudecode -p', but some systems don't, and for them
1602 we have this shell function.")
1604 ;; Perl script to implement `file-attributes' in a Lisp `read'able
1605 ;; output. If you are hacking on this, note that you get *no* output
1606 ;; unless this spits out a complete line, including the '\n' at the
1608 ;; The device number is returned as "-1", because there will be a virtual
1609 ;; device number set in `tramp-handle-file-attributes'.
1610 (defconst tramp-perl-file-attributes
1612 @stat = lstat($ARGV[0]);
1617 if (($stat[2] & 0170000) == 0120000)
1619 $type = readlink($ARGV[0]);
1620 $type = \"\\\"$type\\\"\";
1622 elsif (($stat[2] & 0170000) == 040000)
1630 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1631 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1633 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
1638 $stat[8] >> 16 & 0xffff,
1640 $stat[9] >> 16 & 0xffff,
1642 $stat[10] >> 16 & 0xffff,
1646 $stat[1] >> 16 & 0xffff,
1648 );' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1649 "Perl script to produce output suitable for use with `file-attributes'
1650 on the remote file system.
1651 Escape sequence %s is replaced with name of Perl binary.
1652 This string is passed to `format', so percent characters need to be doubled.")
1654 (defconst tramp-perl-directory-files-and-attributes
1656 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
1657 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
1658 @list = readdir(DIR);
1662 for($i = 0; $i < $n; $i++)
1664 $filename = $list[$i];
1665 @stat = lstat($filename);
1666 if (($stat[2] & 0170000) == 0120000)
1668 $type = readlink($filename);
1669 $type = \"\\\"$type\\\"\";
1671 elsif (($stat[2] & 0170000) == 040000)
1679 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1680 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1682 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
1688 $stat[8] >> 16 & 0xffff,
1690 $stat[9] >> 16 & 0xffff,
1692 $stat[10] >> 16 & 0xffff,
1696 $stat[1] >> 16 & 0xffff,
1698 $stat[0] >> 16 & 0xffff,
1701 printf(\")\\n\");' \"$1\" \"$2\" \"$3\" 2>/dev/null"
1702 "Perl script implementing `directory-files-attributes' as Lisp `read'able
1704 Escape sequence %s is replaced with name of Perl binary.
1705 This string is passed to `format', so percent characters need to be doubled.")
1707 ;; ;; These two use uu encoding.
1708 ;; (defvar tramp-perl-encode "%s -e'\
1709 ;; print qq(begin 644 xxx\n);
1712 ;; while (read(STDIN, $s, 45)) {
1713 ;; print pack(q(u), $s);
1718 ;; "Perl program to use for encoding a file.
1719 ;; Escape sequence %s is replaced with name of Perl binary.")
1721 ;; (defvar tramp-perl-decode "%s -ne '
1722 ;; print unpack q(u), $_;
1724 ;; "Perl program to use for decoding a file.
1725 ;; Escape sequence %s is replaced with name of Perl binary.")
1727 ;; These two use base64 encoding.
1728 (defconst tramp-perl-encode-with-module
1729 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
1730 "Perl program to use for encoding a file.
1731 Escape sequence %s is replaced with name of Perl binary.
1732 This string is passed to `format', so percent characters need to be doubled.
1733 This implementation requires the MIME::Base64 Perl module to be installed
1734 on the remote host.")
1736 (defconst tramp-perl-decode-with-module
1737 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
1738 "Perl program to use for decoding a file.
1739 Escape sequence %s is replaced with name of Perl binary.
1740 This string is passed to `format', so percent characters need to be doubled.
1741 This implementation requires the MIME::Base64 Perl module to be installed
1742 on the remote host.")
1744 (defconst tramp-perl-encode
1746 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1747 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
1748 # Free Software Foundation, Inc.
1753 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
1754 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
1759 # We read in chunks of 54 bytes, to generate output lines
1760 # of 72 chars (plus end of line)
1763 while (my $data = <STDIN>) {
1766 # Only for the last chunk, and only if did not fill the last three-byte packet
1768 my $mod = length($data) %% 3;
1769 $pad = q(=) x (3 - $mod) if $mod;
1772 # Not the fastest method, but it is simple: unpack to binary string, split
1773 # by groups of 6 bits and convert back from binary to byte; then map into
1774 # the translation table
1778 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
1782 "Perl program to use for encoding a file.
1783 Escape sequence %s is replaced with name of Perl binary.
1784 This string is passed to `format', so percent characters need to be doubled.")
1786 (defconst tramp-perl-decode
1788 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1789 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
1790 # Free Software Foundation, Inc.
1795 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
1796 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
1799 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
1803 # We are going to accumulate into $pending to accept any line length
1804 # (we do not check they are <= 76 chars as the RFC says)
1807 while (my $data = <STDIN>) {
1810 # If we find one or two =, we have reached the end and
1811 # any following data is to be discarded
1812 my $finished = $data =~ s/(==?).*/$1/;
1815 my $len = length($pending);
1816 my $chunk = substr($pending, 0, $len & ~3);
1817 $pending = substr($pending, $len & ~3 + 1);
1819 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
1820 # split in 8-bit chunks and convert back to char.
1823 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
1827 "Perl program to use for decoding a file.
1828 Escape sequence %s is replaced with name of Perl binary.
1829 This string is passed to `format', so percent characters need to be doubled.")
1831 (defconst tramp-vc-registered-read-file-names
1833 for file in \"$@\"; do
1835 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" t)\"
1837 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" nil)\"
1840 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" t)\"
1842 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" nil)\"
1846 "Script to check existence of VC related files.
1847 It must be send formatted with two strings; the tests for file
1848 existence, and file readability.")
1850 (defconst tramp-file-mode-type-map
1851 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
1853 (2 . "c") ; character device
1854 (3 . "m") ; multiplexed character device (v7)
1855 (4 . "d") ; directory
1856 (5 . "?") ; Named special file (XENIX)
1857 (6 . "b") ; block device
1858 (7 . "?") ; multiplexed block device (v7)
1859 (8 . "-") ; regular file
1860 (9 . "n") ; network special file (HP-UX)
1861 (10 . "l") ; symlink
1862 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
1864 (13 . "D") ; door special (Solaris)
1865 (14 . "w")) ; whiteout (BSD)
1866 "A list of file types returned from the `stat' system call.
1867 This is used to map a mode number to a permission string.")
1869 ;; New handlers should be added here. The following operations can be
1870 ;; handled using the normal primitives: file-name-sans-versions,
1872 (defconst tramp-file-name-handler-alist
1873 '((load . tramp-handle-load)
1874 (make-symbolic-link . tramp-handle-make-symbolic-link)
1875 (file-name-as-directory . tramp-handle-file-name-as-directory)
1876 (file-name-directory . tramp-handle-file-name-directory)
1877 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
1878 (file-truename . tramp-handle-file-truename)
1879 (file-exists-p . tramp-handle-file-exists-p)
1880 (file-directory-p . tramp-handle-file-directory-p)
1881 (file-executable-p . tramp-handle-file-executable-p)
1882 (file-readable-p . tramp-handle-file-readable-p)
1883 (file-regular-p . tramp-handle-file-regular-p)
1884 (file-symlink-p . tramp-handle-file-symlink-p)
1885 (file-writable-p . tramp-handle-file-writable-p)
1886 (file-ownership-preserved-p . tramp-handle-file-ownership-preserved-p)
1887 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
1888 (file-attributes . tramp-handle-file-attributes)
1889 (file-modes . tramp-handle-file-modes)
1890 (directory-files . tramp-handle-directory-files)
1891 (directory-files-and-attributes . tramp-handle-directory-files-and-attributes)
1892 (file-name-all-completions . tramp-handle-file-name-all-completions)
1893 (file-name-completion . tramp-handle-file-name-completion)
1894 (add-name-to-file . tramp-handle-add-name-to-file)
1895 (copy-file . tramp-handle-copy-file)
1896 (copy-directory . tramp-handle-copy-directory)
1897 (rename-file . tramp-handle-rename-file)
1898 (set-file-modes . tramp-handle-set-file-modes)
1899 (set-file-times . tramp-handle-set-file-times)
1900 (make-directory . tramp-handle-make-directory)
1901 (delete-directory . tramp-handle-delete-directory)
1902 (delete-file . tramp-handle-delete-file)
1903 (directory-file-name . tramp-handle-directory-file-name)
1904 ;; `executable-find' is not official yet.
1905 (executable-find . tramp-handle-executable-find)
1906 (start-file-process . tramp-handle-start-file-process)
1907 (process-file . tramp-handle-process-file)
1908 (shell-command . tramp-handle-shell-command)
1909 (insert-directory . tramp-handle-insert-directory)
1910 (expand-file-name . tramp-handle-expand-file-name)
1911 (substitute-in-file-name . tramp-handle-substitute-in-file-name)
1912 (file-local-copy . tramp-handle-file-local-copy)
1913 (file-remote-p . tramp-handle-file-remote-p)
1914 (insert-file-contents . tramp-handle-insert-file-contents)
1915 (insert-file-contents-literally
1916 . tramp-handle-insert-file-contents-literally)
1917 (write-region . tramp-handle-write-region)
1918 (find-backup-file-name . tramp-handle-find-backup-file-name)
1919 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
1920 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
1921 (dired-compress-file . tramp-handle-dired-compress-file)
1922 (dired-recursive-delete-directory
1923 . tramp-handle-dired-recursive-delete-directory)
1924 (dired-uncache . tramp-handle-dired-uncache)
1925 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
1926 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
1927 (vc-registered . tramp-handle-vc-registered))
1928 "Alist of handler functions.
1929 Operations not mentioned here will be handled by the normal Emacs functions.")
1931 ;; Handlers for partial Tramp file names. For Emacs just
1932 ;; `file-name-all-completions' is needed.
1934 (defconst tramp-completion-file-name-handler-alist
1935 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1936 (file-name-completion . tramp-completion-handle-file-name-completion))
1937 "Alist of completion handler functions.
1938 Used for file names matching `tramp-file-name-regexp'. Operations not
1939 mentioned here will be handled by `tramp-file-name-handler-alist' or the
1940 normal Emacs functions.")
1942 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1943 (defvar tramp-foreign-file-name-handler-alist
1944 ;; (identity . tramp-sh-file-name-handler) should always be the last
1945 ;; entry, since `identity' always matches.
1946 '((identity . tramp-sh-file-name-handler))
1947 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1948 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1951 ;;; Internal functions which must come first:
1953 (defsubst tramp-debug-message (vec fmt-string &rest args)
1954 "Append message to debug buffer.
1955 Message is formatted with FMT-STRING as control string and the remaining
1956 ARGS to actually emit the message (if applicable)."
1957 (when (get-buffer (tramp-buffer-name vec))
1958 (with-current-buffer (tramp-get-debug-buffer vec)
1959 (goto-char (point-max))
1964 ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-"
1965 (if (featurep 'sxemacs) "SX" (if (featurep 'xemacs) "X" "GNU "))
1966 emacs-version tramp-version)))
1970 (let ((now (current-time)))
1971 (insert (format-time-string "%T." now))
1972 (insert (format "%06d " (nth 2 now))))
1973 ;; Calling function.
1974 (let ((btn 1) btf fn)
1976 (setq btf (nth 1 (backtrace-frame btn)))
1980 (setq fn (symbol-name btf))
1981 (unless (and (string-match "^tramp" fn)
1983 "^tramp\\(-debug\\)?\\(-message\\|-error\\)$"
1986 (setq btn (1+ btn))))
1987 ;; The following code inserts filename and line number.
1988 ;; Should be deactivated by default, because it is time
1990 ; (let ((ffn (find-function-noselect (intern fn))))
1994 ; (file-name-nondirectory (buffer-file-name (car ffn)))
1995 ; (with-current-buffer (car ffn)
1996 ; (1+ (count-lines (point-min) (cdr ffn)))))))
1997 (insert (format "%s " fn)))
1999 (insert (apply 'format fmt-string args)))))
2001 (defvar tramp-message-show-message t
2002 "Show Tramp message in the minibuffer.
2003 This variable is used to disable messages from `tramp-error'.
2004 The messages are visible anyway, because an error is raised.")
2006 (defsubst tramp-message (vec-or-proc level fmt-string &rest args)
2007 "Emit a message depending on verbosity level.
2008 VEC-OR-PROC identifies the Tramp buffer to use. It can be either a
2009 vector or a process. LEVEL says to be quiet if `tramp-verbose' is
2010 less than LEVEL. The message is emitted only if `tramp-verbose' is
2011 greater than or equal to LEVEL.
2013 The message is also logged into the debug buffer when `tramp-verbose'
2014 is greater than or equal 4.
2016 Calls functions `message' and `tramp-debug-message' with FMT-STRING as
2017 control string and the remaining ARGS to actually emit the message (if
2020 (when (<= level tramp-verbose)
2021 ;; Match data must be preserved!
2023 ;; Display only when there is a minimum level.
2024 (when (and tramp-message-show-message (<= level 3))
2030 ((= level 2) "Warning: ")
2034 ;; Log only when there is a minimum level.
2035 (when (>= tramp-verbose 4)
2036 (when (and vec-or-proc
2037 (processp vec-or-proc)
2038 (buffer-name (process-buffer vec-or-proc)))
2039 (with-current-buffer (process-buffer vec-or-proc)
2040 ;; Translate proc to vec.
2041 (setq vec-or-proc (tramp-dissect-file-name default-directory))))
2042 (when (and vec-or-proc (vectorp vec-or-proc))
2043 (apply 'tramp-debug-message
2045 (concat (format "(%d) # " level) fmt-string)
2047 ;; Suppress all errors.
2050 (defsubst tramp-error (vec-or-proc signal fmt-string &rest args)
2052 VEC-OR-PROC identifies the connection to use, SIGNAL is the
2053 signal identifier to be raised, remaining args passed to
2054 `tramp-message'. Finally, signal SIGNAL is raised."
2055 (let (tramp-message-show-message)
2058 (error-message-string
2060 (get signal 'error-message)
2061 (apply 'format fmt-string args))))
2062 (signal signal (list (apply 'format fmt-string args)))))
2064 (defsubst tramp-error-with-buffer
2065 (buffer vec-or-proc signal fmt-string &rest args)
2066 "Emit an error, and show BUFFER.
2067 If BUFFER is nil, show the connection buffer. Wait for 30\", or until
2068 an input event arrives. The other arguments are passed to `tramp-error'."
2069 (save-window-excursion
2071 (apply 'tramp-error vec-or-proc signal fmt-string args)
2072 (when (and vec-or-proc (not (zerop tramp-verbose)))
2073 (let ((enable-recursive-minibuffers t))
2075 (or (and (bufferp buffer) buffer)
2076 (and (processp vec-or-proc) (process-buffer vec-or-proc))
2077 (tramp-get-buffer vec-or-proc)))
2080 (defmacro with-parsed-tramp-file-name (filename var &rest body)
2081 "Parse a Tramp filename and make components available in the body.
2083 First arg FILENAME is evaluated and dissected into its components.
2084 Second arg VAR is a symbol. It is used as a variable name to hold
2085 the filename structure. It is also used as a prefix for the variables
2086 holding the components. For example, if VAR is the symbol `foo', then
2087 `foo' will be bound to the whole structure, `foo-method' will be bound to
2088 the method component, and so on for `foo-user', `foo-host', `foo-localname'.
2090 Remaining args are Lisp expressions to be evaluated (inside an implicit
2093 If VAR is nil, then we bind `v' to the structure and `method', `user',
2094 `host', `localname' to the components."
2095 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
2096 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
2097 (tramp-file-name-method ,(or var 'v)))
2098 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
2099 (tramp-file-name-user ,(or var 'v)))
2100 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
2101 (tramp-file-name-host ,(or var 'v)))
2102 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
2103 (tramp-file-name-localname ,(or var 'v))))
2106 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
2107 (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body))
2108 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>"))
2110 (defmacro with-file-property (vec file property &rest body)
2111 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
2112 FILE must be a local file name on a connection identified via VEC."
2113 `(if (file-name-absolute-p ,file)
2114 (let ((value (tramp-get-file-property ,vec ,file ,property 'undef)))
2115 (when (eq value 'undef)
2116 ;; We cannot pass @body as parameter to
2117 ;; `tramp-set-file-property' because it mangles our
2119 (setq value (progn ,@body))
2120 (tramp-set-file-property ,vec ,file ,property value))
2124 (put 'with-file-property 'lisp-indent-function 3)
2125 (put 'with-file-property 'edebug-form-spec t)
2126 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-file-property\\>"))
2128 (defmacro with-connection-property (key property &rest body)
2129 "Checks in Tramp for property PROPERTY, otherwise executes BODY and set."
2130 `(let ((value (tramp-get-connection-property ,key ,property 'undef)))
2131 (when (eq value 'undef)
2132 ;; We cannot pass ,@body as parameter to
2133 ;; `tramp-set-connection-property' because it mangles our debug
2135 (setq value (progn ,@body))
2136 (tramp-set-connection-property ,key ,property value))
2139 (put 'with-connection-property 'lisp-indent-function 2)
2140 (put 'with-connection-property 'edebug-form-spec t)
2141 (font-lock-add-keywords 'emacs-lisp-mode '("\\<with-connection-property\\>"))
2143 (eval-and-compile ; silence compiler
2144 (if (memq system-type '(cygwin windows-nt))
2145 (defun tramp-drop-volume-letter (name)
2146 "Cut off unnecessary drive letter from file NAME.
2147 The function `tramp-handle-expand-file-name' calls `expand-file-name'
2148 locally on a remote file name. When the local system is a W32 system
2149 but the remote system is Unix, this introduces a superfluous drive
2150 letter into the file name. This function removes it."
2152 (if (string-match tramp-root-regexp name)
2153 (replace-match "/" nil t name)
2156 (defalias 'tramp-drop-volume-letter 'identity)))
2158 (defsubst tramp-make-tramp-temp-file (vec)
2159 "Create a temporary file on the remote host identified by VEC.
2160 Return the local name of the temporary file."
2162 (tramp-make-tramp-file-name
2163 (tramp-file-name-method vec)
2164 (tramp-file-name-user vec)
2165 (tramp-file-name-host vec)
2166 (tramp-drop-volume-letter
2168 tramp-temp-name-prefix (tramp-get-remote-tmpdir vec)))))
2171 ;; `make-temp-file' would be the natural choice for
2172 ;; implementation. But it calls `write-region' internally,
2173 ;; which also needs a temporary file - we would end in an
2175 (setq result (make-temp-name prefix))
2176 (if (file-exists-p result)
2178 ;; This creates the file by side effect.
2179 (set-file-times result)
2180 (set-file-modes result (tramp-octal-to-decimal "0700"))))
2182 ;; Return the local part.
2183 (with-parsed-tramp-file-name result nil localname)))
2186 ;;; Config Manipulation Functions:
2188 (defun tramp-set-completion-function (method function-list)
2189 "Sets the list of completion functions for METHOD.
2190 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
2191 The FUNCTION is intended to parse FILE according its syntax.
2192 It might be a predefined FUNCTION, or a user defined FUNCTION.
2193 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
2194 `tramp-parse-sconfig', `tramp-parse-hosts', `tramp-parse-passwd',
2195 and `tramp-parse-netrc'.
2199 (tramp-set-completion-function
2201 '((tramp-parse-sconfig \"/etc/ssh_config\")
2202 (tramp-parse-sconfig \"~/.ssh/config\")))"
2204 (let ((r function-list)
2206 (setq tramp-completion-function-alist
2207 (delete (assoc method tramp-completion-function-alist)
2208 tramp-completion-function-alist))
2211 ;; Remove double entries.
2212 (when (member (car v) (cdr v))
2213 (setcdr v (delete (car v) (cdr v))))
2214 ;; Check for function and file or registry key.
2215 (unless (and (functionp (nth 0 (car v)))
2216 (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v)))
2217 ;; Windows registry.
2218 (and (memq system-type '(cygwin windows-nt))
2220 (tramp-local-call-process
2221 "reg" nil nil nil "query" (nth 1 (car v)))))
2222 ;; Configuration file.
2223 (file-exists-p (nth 1 (car v)))))
2224 (setq r (delete (car v) r)))
2228 (add-to-list 'tramp-completion-function-alist
2231 (defun tramp-get-completion-function (method)
2232 "Returns a list of completion functions for METHOD.
2233 For definition of that list see `tramp-set-completion-function'."
2235 ;; Hosts visited once shall be remembered.
2236 `(tramp-parse-connection-properties ,method)
2237 ;; The method related defaults.
2238 (cdr (assoc method tramp-completion-function-alist))))
2241 ;;; Fontification of `read-file-name':
2243 ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded.
2244 (defvar tramp-rfn-eshadow-overlay)
2245 (make-variable-buffer-local 'tramp-rfn-eshadow-overlay)
2247 (defun tramp-rfn-eshadow-setup-minibuffer ()
2248 "Set up a minibuffer for `file-name-shadow-mode'.
2249 Adds another overlay hiding filename parts according to Tramp's
2250 special handling of `substitute-in-file-name'."
2251 (when (symbol-value 'minibuffer-completing-file-name)
2252 (setq tramp-rfn-eshadow-overlay
2253 (funcall (symbol-function 'make-overlay)
2254 (funcall (symbol-function 'minibuffer-prompt-end))
2255 (funcall (symbol-function 'minibuffer-prompt-end))))
2256 ;; Copy rfn-eshadow-overlay properties.
2257 (let ((props (funcall (symbol-function 'overlay-properties)
2258 (symbol-value 'rfn-eshadow-overlay))))
2260 (funcall (symbol-function 'overlay-put)
2261 tramp-rfn-eshadow-overlay (pop props) (pop props))))))
2263 (when (boundp 'rfn-eshadow-setup-minibuffer-hook)
2264 (add-hook 'rfn-eshadow-setup-minibuffer-hook
2265 'tramp-rfn-eshadow-setup-minibuffer)
2266 (add-hook 'tramp-unload-hook
2268 (remove-hook 'rfn-eshadow-setup-minibuffer-hook
2269 'tramp-rfn-eshadow-setup-minibuffer))))
2271 (defconst tramp-rfn-eshadow-update-overlay-regexp
2272 (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format))
2274 (defun tramp-rfn-eshadow-update-overlay ()
2275 "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input.
2276 This is intended to be used as a minibuffer `post-command-hook' for
2277 `file-name-shadow-mode'; the minibuffer should have already
2278 been set up by `rfn-eshadow-setup-minibuffer'."
2279 ;; In remote files name, there is a shadowing just for the local part.
2280 (let ((end (or (funcall (symbol-function 'overlay-end)
2281 (symbol-value 'rfn-eshadow-overlay))
2282 (funcall (symbol-function 'minibuffer-prompt-end)))))
2283 (when (file-remote-p (buffer-substring-no-properties end (point-max)))
2287 (1+ (or (string-match
2288 tramp-rfn-eshadow-update-overlay-regexp (buffer-string) end)
2291 (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay)
2292 (rfn-eshadow-update-overlay-hook nil))
2293 (move-overlay rfn-eshadow-overlay (point-max) (point-max))
2294 (funcall (symbol-function 'rfn-eshadow-update-overlay))))))))
2296 (when (boundp 'rfn-eshadow-update-overlay-hook)
2297 (add-hook 'rfn-eshadow-update-overlay-hook
2298 'tramp-rfn-eshadow-update-overlay))
2301 ;;; File Name Handler Functions:
2303 (defun tramp-handle-make-symbolic-link
2304 (filename linkname &optional ok-if-already-exists)
2305 "Like `make-symbolic-link' for Tramp files.
2306 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
2307 the symlink. If LINKNAME is a Tramp file, only the localname component is
2308 used as the target of the symlink.
2310 If LINKNAME is a Tramp file and the localname component is relative, then
2311 it is expanded first, before the localname component is taken. Note that
2312 this can give surprising results if the user/host for the source and
2313 target of the symlink differ."
2314 (with-parsed-tramp-file-name linkname l
2315 (let ((ln (tramp-get-remote-ln l))
2316 (cwd (tramp-run-real-handler
2317 'file-name-directory (list l-localname))))
2321 "Making a symbolic link. ln(1) does not exist on the remote host."))
2323 ;; Do the 'confirm if exists' thing.
2324 (when (file-exists-p linkname)
2326 (if (or (null ok-if-already-exists) ; not allowed to exist
2327 (and (numberp ok-if-already-exists)
2330 "File %s already exists; make it a link anyway? "
2333 l 'file-already-exists "File %s already exists" l-localname)
2334 (delete-file linkname)))
2336 ;; If FILENAME is a Tramp name, use just the localname component.
2337 (when (tramp-tramp-file-p filename)
2339 (tramp-file-name-localname
2340 (tramp-dissect-file-name (expand-file-name filename)))))
2342 ;; Right, they are on the same host, regardless of user, method, etc.
2343 ;; We now make the link on the remote machine. This will occur as the user
2344 ;; that FILENAME belongs to.
2346 (tramp-send-command-and-check
2347 l (format "cd %s && %s -sf %s %s" cwd ln filename l-localname) t)))))
2349 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
2350 "Like `load' for Tramp files."
2351 (with-parsed-tramp-file-name (expand-file-name file) nil
2353 (cond ((file-exists-p (concat file ".elc"))
2354 (setq file (concat file ".elc")))
2355 ((file-exists-p (concat file ".el"))
2356 (setq file (concat file ".el")))))
2358 ;; The first condition is always true for absolute file names.
2359 ;; Included for safety's sake.
2360 (unless (or (file-name-directory file)
2361 (string-match "\\.elc?\\'" file))
2364 "File `%s' does not include a `.el' or `.elc' suffix" file)))
2366 (when (not (file-exists-p file))
2367 (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file)))
2368 (if (not (file-exists-p file))
2370 (unless nomessage (tramp-message v 0 "Loading %s..." file))
2371 (let ((local-copy (file-local-copy file)))
2372 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2374 (load local-copy noerror t t)
2375 (delete-file local-copy)))
2376 (unless nomessage (tramp-message v 0 "Loading %s...done" file))
2379 ;; Localname manipulation functions that grok Tramp localnames...
2380 (defun tramp-handle-file-name-as-directory (file)
2381 "Like `file-name-as-directory' but aware of Tramp files."
2382 ;; `file-name-as-directory' would be sufficient except localname is
2383 ;; the empty string.
2384 (let ((v (tramp-dissect-file-name file t)))
2385 ;; Run the command on the localname portion only.
2386 (tramp-make-tramp-file-name
2387 (tramp-file-name-method v)
2388 (tramp-file-name-user v)
2389 (tramp-file-name-host v)
2390 (tramp-run-real-handler
2391 'file-name-as-directory (list (or (tramp-file-name-localname v) ""))))))
2393 (defun tramp-handle-file-name-directory (file)
2394 "Like `file-name-directory' but aware of Tramp files."
2395 ;; Everything except the last filename thing is the directory. We
2396 ;; cannot apply `with-parsed-tramp-file-name', because this expands
2397 ;; the remote file name parts. This is a problem when we are in
2398 ;; file name completion.
2399 (let ((v (tramp-dissect-file-name file t)))
2400 ;; Run the command on the localname portion only.
2401 (tramp-make-tramp-file-name
2402 (tramp-file-name-method v)
2403 (tramp-file-name-user v)
2404 (tramp-file-name-host v)
2405 (tramp-run-real-handler
2406 'file-name-directory (list (or (tramp-file-name-localname v) ""))))))
2408 (defun tramp-handle-file-name-nondirectory (file)
2409 "Like `file-name-nondirectory' but aware of Tramp files."
2410 (with-parsed-tramp-file-name file nil
2411 (tramp-run-real-handler 'file-name-nondirectory (list localname))))
2413 (defun tramp-handle-file-truename (filename &optional counter prev-dirs)
2414 "Like `file-truename' for Tramp files."
2415 (with-parsed-tramp-file-name (expand-file-name filename) nil
2416 (with-file-property v localname "file-truename"
2417 (let* ((directory-sep-char ?/) ; for XEmacs
2418 (steps (tramp-compat-split-string localname "/"))
2419 (localnamedir (tramp-run-real-handler
2420 'file-name-as-directory (list localname)))
2421 (is-dir (string= localname localnamedir))
2424 ;; Don't make the following value larger than necessary.
2425 ;; People expect an error message in a timely fashion when
2426 ;; something is wrong; otherwise they might think that Emacs
2427 ;; is hung. Of course, correctness has to come first.
2429 (result nil) ;result steps in reverse order
2431 (tramp-message v 4 "Finding true name for `%s'" filename)
2432 (while (and steps (< numchase numchase-limit))
2433 (setq thisstep (pop steps))
2436 (mapconcat 'identity
2437 (append '("") (reverse result) (list thisstep))
2439 (setq symlink-target
2440 (nth 0 (file-attributes
2441 (tramp-make-tramp-file-name
2443 (mapconcat 'identity
2448 (cond ((string= "." thisstep)
2449 (tramp-message v 5 "Ignoring step `.'"))
2450 ((string= ".." thisstep)
2451 (tramp-message v 5 "Processing step `..'")
2453 ((stringp symlink-target)
2454 ;; It's a symlink, follow it.
2455 (tramp-message v 5 "Follow symlink to %s" symlink-target)
2456 (setq numchase (1+ numchase))
2457 (when (file-name-absolute-p symlink-target)
2459 ;; If the symlink was absolute, we'll get a string like
2460 ;; "/user@host:/some/target"; extract the
2461 ;; "/some/target" part from it.
2462 (when (tramp-tramp-file-p symlink-target)
2463 (unless (tramp-equal-remote filename symlink-target)
2466 "Symlink target `%s' on wrong host" symlink-target))
2467 (setq symlink-target localname))
2469 (append (tramp-compat-split-string symlink-target "/")
2473 (setq result (cons thisstep result)))))
2474 (when (>= numchase numchase-limit)
2477 "Maximum number (%d) of symlinks exceeded" numchase-limit))
2478 (setq result (reverse result))
2479 ;; Combine list to form string.
2482 (mapconcat 'identity (cons "" result) "/")
2484 (when (and is-dir (or (string= "" result)
2485 (not (string= (substring result -1) "/"))))
2486 (setq result (concat result "/")))
2487 (tramp-message v 4 "True name of `%s' is `%s'" filename result)
2488 (tramp-make-tramp-file-name method user host result)))))
2492 (defun tramp-handle-file-exists-p (filename)
2493 "Like `file-exists-p' for Tramp files."
2494 (with-parsed-tramp-file-name filename nil
2495 (with-file-property v localname "file-exists-p"
2496 (zerop (tramp-send-command-and-check
2500 (tramp-get-file-exists-command v)
2501 (tramp-shell-quote-argument localname)))))))
2503 ;; Inodes don't exist for some file systems. Therefore we must
2504 ;; generate virtual ones. Used in `find-buffer-visiting'. The method
2505 ;; applied might be not so efficient (Ange-FTP uses hashes). But
2506 ;; performance isn't the major issue given that file transfer will
2508 (defvar tramp-inodes nil
2509 "Keeps virtual inodes numbers.")
2511 ;; Devices must distinguish physical file systems. The device numbers
2512 ;; provided by "lstat" aren't unique, because we operate on different hosts.
2513 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
2514 ;; EFS use device number "-1". In order to be different, we use device number
2515 ;; (-1 . x), whereby "x" is unique for a given (method user host).
2516 (defvar tramp-devices nil
2517 "Keeps virtual device numbers.")
2519 ;; CCC: This should check for an error condition and signal failure
2520 ;; when something goes wrong.
2521 ;; Daniel Pittman <daniel@danann.net>
2522 (defun tramp-handle-file-attributes (filename &optional id-format)
2523 "Like `file-attributes' for Tramp files."
2524 (unless id-format (setq id-format 'integer))
2525 ;; Don't modify `last-coding-system-used' by accident.
2526 (let ((last-coding-system-used last-coding-system-used))
2527 (with-parsed-tramp-file-name (expand-file-name filename) nil
2528 (with-file-property v localname (format "file-attributes-%s" id-format)
2530 (tramp-convert-file-attributes
2533 ((tramp-get-remote-stat v)
2534 (tramp-do-file-attributes-with-stat v localname id-format))
2535 ((tramp-get-remote-perl v)
2536 (tramp-do-file-attributes-with-perl v localname id-format))
2538 (tramp-do-file-attributes-with-ls v localname id-format)))))))))
2540 (defun tramp-do-file-attributes-with-ls (vec localname &optional id-format)
2541 "Implement `file-attributes' for Tramp files using the ls(1) command."
2543 res-inode res-filemodes res-numlinks
2544 res-uid res-gid res-size res-symlink-target)
2545 (tramp-message vec 5 "file attributes with ls: %s" localname)
2548 (format "(%s %s || %s -h %s) && %s %s %s"
2549 (tramp-get-file-exists-command vec)
2550 (tramp-shell-quote-argument localname)
2551 (tramp-get-test-command vec)
2552 (tramp-shell-quote-argument localname)
2553 (tramp-get-ls-command vec)
2554 (if (eq id-format 'integer) "-ildn" "-ild")
2555 (tramp-shell-quote-argument localname)))
2556 ;; parse `ls -l' output ...
2557 (with-current-buffer (tramp-get-buffer vec)
2558 (when (> (buffer-size) 0)
2559 (goto-char (point-min))
2563 (read (current-buffer))
2564 (invalid-read-syntax
2565 (when (and (equal (cadr err)
2566 "Integer constant overflow in reader")
2568 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
2570 (let* ((big (read (substring (car (cddr err)) 0
2571 (match-beginning 1))))
2572 (small (read (match-string 1 (car (cddr err)))))
2573 (twiddle (/ small 65536)))
2574 (cons (+ big twiddle)
2575 (- small (* twiddle 65536))))))))
2576 ;; ... file mode flags
2577 (setq res-filemodes (symbol-name (read (current-buffer))))
2579 (setq res-numlinks (read (current-buffer)))
2581 (setq res-uid (read (current-buffer)))
2582 (setq res-gid (read (current-buffer)))
2583 (if (eq id-format 'integer)
2585 (unless (numberp res-uid) (setq res-uid -1))
2586 (unless (numberp res-gid) (setq res-gid -1)))
2588 (unless (stringp res-uid) (setq res-uid (symbol-name res-uid)))
2589 (unless (stringp res-gid) (setq res-gid (symbol-name res-gid)))))
2591 (setq res-size (read (current-buffer)))
2592 ;; From the file modes, figure out other stuff.
2593 (setq symlinkp (eq ?l (aref res-filemodes 0)))
2594 (setq dirp (eq ?d (aref res-filemodes 0)))
2595 ;; if symlink, find out file name pointed to
2597 (search-forward "-> ")
2598 (setq res-symlink-target
2599 (buffer-substring (point) (tramp-compat-line-end-position))))
2600 ;; return data gathered
2602 ;; 0. t for directory, string (name linked to) for symbolic
2604 (or dirp res-symlink-target)
2605 ;; 1. Number of links to file.
2611 ;; 4. Last access time, as a list of two integers. First
2612 ;; integer has high-order 16 bits of time, second has low 16
2614 ;; 5. Last modification time, likewise.
2615 ;; 6. Last status change time, likewise.
2616 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
2617 ;; 7. Size in bytes (-1, if number is out of range).
2619 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
2621 ;; 9. t if file's gid would change if file were deleted and
2622 ;; recreated. Will be set in `tramp-convert-file-attributes'
2624 ;; 10. inode number.
2626 ;; 11. Device number. Will be replaced by a virtual device number.
2630 (defun tramp-do-file-attributes-with-perl
2631 (vec localname &optional id-format)
2632 "Implement `file-attributes' for Tramp files using a Perl script."
2633 (tramp-message vec 5 "file attributes with perl: %s" localname)
2634 (tramp-maybe-send-script
2635 vec tramp-perl-file-attributes "tramp_perl_file_attributes")
2636 (tramp-send-command-and-read
2638 (format "tramp_perl_file_attributes %s %s"
2639 (tramp-shell-quote-argument localname) id-format)))
2641 (defun tramp-do-file-attributes-with-stat
2642 (vec localname &optional id-format)
2643 "Implement `file-attributes' for Tramp files using stat(1) command."
2644 (tramp-message vec 5 "file attributes with stat: %s" localname)
2645 (tramp-send-command-and-read
2648 "((%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)' %s || echo nil)"
2649 (tramp-get-file-exists-command vec)
2650 (tramp-shell-quote-argument localname)
2651 (tramp-get-test-command vec)
2652 (tramp-shell-quote-argument localname)
2653 (tramp-get-remote-stat vec)
2654 (if (eq id-format 'integer) "%u" "\"%U\"")
2655 (if (eq id-format 'integer) "%g" "\"%G\"")
2656 (tramp-shell-quote-argument localname))))
2658 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
2659 "Like `set-visited-file-modtime' for Tramp files."
2660 (unless (buffer-file-name)
2661 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
2664 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
2665 (let ((f (buffer-file-name))
2667 (with-parsed-tramp-file-name f nil
2668 (let* ((attr (file-attributes f))
2669 ;; '(-1 65535) means file doesn't exists yet.
2670 (modtime (or (nth 5 attr) '(-1 65535))))
2671 (when (boundp 'last-coding-system-used)
2672 (setq coding-system-used (symbol-value 'last-coding-system-used)))
2673 ;; We use '(0 0) as a don't-know value. See also
2674 ;; `tramp-do-file-attributes-with-ls'.
2675 (if (not (equal modtime '(0 0)))
2676 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
2680 (format "%s -ild %s"
2681 (tramp-get-ls-command v)
2682 (tramp-shell-quote-argument localname)))
2683 (setq attr (buffer-substring (point)
2684 (progn (end-of-line) (point)))))
2685 (tramp-set-file-property
2686 v localname "visited-file-modtime-ild" attr))
2687 (when (boundp 'last-coding-system-used)
2688 (set 'last-coding-system-used coding-system-used))
2691 ;; This function makes the same assumption as
2692 ;; `tramp-handle-set-visited-file-modtime'.
2693 (defun tramp-handle-verify-visited-file-modtime (buf)
2694 "Like `verify-visited-file-modtime' for Tramp files.
2695 At the time `verify-visited-file-modtime' calls this function, we
2696 already know that the buffer is visiting a file and that
2697 `visited-file-modtime' does not return 0. Do not call this
2698 function directly, unless those two cases are already taken care
2700 (with-current-buffer buf
2701 ;; There is no file visiting the buffer, or the buffer has no
2702 ;; recorded last modification time.
2703 (if (or (not (buffer-file-name))
2704 (eq (visited-file-modtime) 0))
2706 (let ((f (buffer-file-name)))
2707 (with-parsed-tramp-file-name f nil
2708 (tramp-flush-file-property v localname)
2709 (let* ((attr (file-attributes f))
2710 (modtime (nth 5 attr))
2711 (mt (visited-file-modtime)))
2714 ;; File exists, and has a known modtime.
2715 ((and attr (not (equal modtime '(0 0))))
2716 (< (abs (tramp-time-diff
2718 ;; For compatibility, deal with both the old
2719 ;; (HIGH . LOW) and the new (HIGH LOW) return
2720 ;; values of `visited-file-modtime'.
2722 (list (car mt) (cdr mt))
2725 ;; Modtime has the don't know value.
2729 (format "%s -ild %s"
2730 (tramp-get-ls-command v)
2731 (tramp-shell-quote-argument localname)))
2732 (with-current-buffer (tramp-get-buffer v)
2733 (setq attr (buffer-substring
2734 (point) (progn (end-of-line) (point)))))
2737 (tramp-get-file-property
2738 v localname "visited-file-modtime-ild" "")))
2739 ;; If file does not exist, say it is not modified if and
2740 ;; only if that agrees with the buffer's record.
2741 (t (equal mt '(-1 65535))))))))))
2743 (defun tramp-handle-set-file-modes (filename mode)
2744 "Like `set-file-modes' for Tramp files."
2745 (with-parsed-tramp-file-name filename nil
2746 (tramp-flush-file-property v localname)
2747 (unless (zerop (tramp-send-command-and-check
2749 (format "chmod %s %s"
2750 (tramp-decimal-to-octal mode)
2751 (tramp-shell-quote-argument localname))))
2752 ;; FIXME: extract the proper text from chmod's stderr.
2754 v 'file-error "Error while changing file's mode %s" filename))))
2756 (defun tramp-handle-set-file-times (filename &optional time)
2757 "Like `set-file-times' for Tramp files."
2759 (if (file-remote-p filename)
2760 (with-parsed-tramp-file-name filename nil
2761 (tramp-flush-file-property v localname)
2762 (let ((time (if (or (null time) (equal time '(0 0)))
2766 ;; With GNU Emacs, `format-time-string' has an
2767 ;; optional parameter UNIVERSAL. This is preferred,
2768 ;; because we could handle the case when the remote
2769 ;; host is located in a different time zone as the
2771 (and (functionp 'subr-arity)
2772 (subrp (symbol-function 'format-time-string))
2773 (= 3 (cdr (funcall (symbol-function 'subr-arity)
2775 'format-time-string)))))))
2776 (tramp-send-command-and-check
2777 v (format "%s touch -t %s %s"
2778 (if utc "TZ=UTC; export TZ;" "")
2780 (format-time-string "%Y%m%d%H%M.%S" time t)
2781 (format-time-string "%Y%m%d%H%M.%S" time))
2782 (tramp-shell-quote-argument localname)))))
2784 ;; We handle also the local part, because in older Emacsen,
2785 ;; without `set-file-times', this function is an alias for this.
2786 ;; We are local, so we don't need the UTC settings.
2787 (tramp-local-call-process
2788 "touch" nil nil nil "-t"
2789 (format-time-string "%Y%m%d%H%M.%S" time)
2790 (tramp-shell-quote-argument filename)))))
2792 (defun tramp-set-file-uid-gid (filename &optional uid gid)
2793 "Set the ownership for FILENAME.
2794 If UID and GID are provided, these values are used; otherwise uid
2795 and gid of the corresponding user is taken. Both parameters must be integers."
2796 ;; Modern Unices allow chown only for root. So we might need
2797 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
2798 ;; working with su(do)? when it is needed, so it shall succeed in
2799 ;; the majority of cases.
2800 ;; Don't modify `last-coding-system-used' by accident.
2801 (let ((last-coding-system-used last-coding-system-used))
2802 (if (file-remote-p filename)
2803 (with-parsed-tramp-file-name filename nil
2804 (if (and (zerop (user-uid)) (tramp-local-host-p v))
2805 ;; If we are root on the local host, we can do it directly.
2806 (tramp-set-file-uid-gid localname uid gid)
2807 (let ((uid (or (and (integerp uid) uid)
2808 (tramp-get-remote-uid v 'integer)))
2809 (gid (or (and (integerp gid) gid)
2810 (tramp-get-remote-gid v 'integer))))
2813 "chown %d:%d %s" uid gid
2814 (tramp-shell-quote-argument localname))))))
2816 ;; We handle also the local part, because there doesn't exist
2817 ;; `set-file-uid-gid'. On W32 "chown" might not work.
2818 (let ((uid (or (and (integerp uid) uid) (tramp-get-local-uid 'integer)))
2819 (gid (or (and (integerp gid) gid) (tramp-get-local-gid 'integer))))
2820 (tramp-local-call-process
2822 (format "%d:%d" uid gid) (tramp-shell-quote-argument filename))))))
2824 ;; Simple functions using the `test' command.
2826 (defun tramp-handle-file-executable-p (filename)
2827 "Like `file-executable-p' for Tramp files."
2828 (with-parsed-tramp-file-name filename nil
2829 (with-file-property v localname "file-executable-p"
2830 (zerop (tramp-run-test "-x" filename)))))
2832 (defun tramp-handle-file-readable-p (filename)
2833 "Like `file-readable-p' for Tramp files."
2834 (with-parsed-tramp-file-name filename nil
2835 (with-file-property v localname "file-readable-p"
2836 (zerop (tramp-run-test "-r" filename)))))
2838 ;; When the remote shell is started, it looks for a shell which groks
2839 ;; tilde expansion. Here, we assume that all shells which grok tilde
2840 ;; expansion will also provide a `test' command which groks `-nt' (for
2841 ;; newer than). If this breaks, tell me about it and I'll try to do
2842 ;; something smarter about it.
2843 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2844 "Like `file-newer-than-file-p' for Tramp files."
2845 (cond ((not (file-exists-p file1))
2847 ((not (file-exists-p file2))
2849 ;; We are sure both files exist at this point.
2852 ;; We try to get the mtime of both files. If they are not
2853 ;; equal to the "dont-know" value, then we subtract the times
2854 ;; and obtain the result.
2855 (let ((fa1 (file-attributes file1))
2856 (fa2 (file-attributes file2)))
2857 (if (and (not (equal (nth 5 fa1) '(0 0)))
2858 (not (equal (nth 5 fa2) '(0 0))))
2859 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
2860 ;; If one of them is the dont-know value, then we can
2861 ;; still try to run a shell command on the remote host.
2862 ;; However, this only works if both files are Tramp
2863 ;; files and both have the same method, same user, same
2865 (unless (tramp-equal-remote file1 file2)
2866 (with-parsed-tramp-file-name
2867 (if (tramp-tramp-file-p file1) file1 file2) nil
2870 "Files %s and %s must have same method, user, host"
2872 (with-parsed-tramp-file-name file1 nil
2873 (zerop (tramp-run-test2
2874 (tramp-get-test-nt-command v) file1 file2)))))))))
2876 ;; Functions implemented using the basic functions above.
2878 (defun tramp-handle-file-modes (filename)
2879 "Like `file-modes' for Tramp files."
2880 (let ((truename (or (file-truename filename) filename)))
2881 (when (file-exists-p truename)
2882 (tramp-mode-string-to-int (nth 8 (file-attributes truename))))))
2884 (defun tramp-default-file-modes (filename)
2885 "Return file modes of FILENAME as integer.
2886 If the file modes of FILENAME cannot be determined, return the
2887 value of `default-file-modes', without execute permissions."
2888 (or (file-modes filename)
2889 (logand (default-file-modes) (tramp-octal-to-decimal "0666"))))
2891 (defun tramp-handle-file-directory-p (filename)
2892 "Like `file-directory-p' for Tramp files."
2893 ;; Care must be taken that this function returns `t' for symlinks
2894 ;; pointing to directories. Surely the most obvious implementation
2895 ;; would be `test -d', but that returns false for such symlinks.
2896 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
2897 ;; I now think he's right. So we could be using `test -d', couldn't
2900 ;; Alternatives: `cd %s', `test -d %s'
2901 (with-parsed-tramp-file-name filename nil
2902 (with-file-property v localname "file-directory-p"
2903 (zerop (tramp-run-test "-d" filename)))))
2905 (defun tramp-handle-file-regular-p (filename)
2906 "Like `file-regular-p' for Tramp files."
2907 (and (file-exists-p filename)
2908 (eq ?- (aref (nth 8 (file-attributes filename)) 0))))
2910 (defun tramp-handle-file-symlink-p (filename)
2911 "Like `file-symlink-p' for Tramp files."
2912 (with-parsed-tramp-file-name filename nil
2913 (let ((x (car (file-attributes filename))))
2915 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2916 ;; might do weird things.
2917 (if (file-name-absolute-p x)
2918 (tramp-make-tramp-file-name method user host x)
2921 (defun tramp-handle-file-writable-p (filename)
2922 "Like `file-writable-p' for Tramp files."
2923 (with-parsed-tramp-file-name filename nil
2924 (with-file-property v localname "file-writable-p"
2925 (if (file-exists-p filename)
2926 ;; Existing files must be writable.
2927 (zerop (tramp-run-test "-w" filename))
2928 ;; If file doesn't exist, check if directory is writable.
2929 (and (zerop (tramp-run-test
2930 "-d" (file-name-directory filename)))
2931 (zerop (tramp-run-test
2932 "-w" (file-name-directory filename))))))))
2934 (defun tramp-handle-file-ownership-preserved-p (filename)
2935 "Like `file-ownership-preserved-p' for Tramp files."
2936 (with-parsed-tramp-file-name filename nil
2937 (with-file-property v localname "file-ownership-preserved-p"
2938 (let ((attributes (file-attributes filename)))
2939 ;; Return t if the file doesn't exist, since it's true that no
2940 ;; information would be lost by an (attempted) delete and create.
2941 (or (null attributes)
2942 (= (nth 2 attributes) (tramp-get-remote-uid v 'integer)))))))
2944 ;; Other file name ops.
2946 (defun tramp-handle-directory-file-name (directory)
2947 "Like `directory-file-name' for Tramp files."
2948 ;; If localname component of filename is "/", leave it unchanged.
2949 ;; Otherwise, remove any trailing slash from localname component.
2950 ;; Method, host, etc, are unchanged. Does it make sense to try
2951 ;; to avoid parsing the filename?
2952 (with-parsed-tramp-file-name directory nil
2953 (if (and (not (zerop (length localname)))
2954 (eq (aref localname (1- (length localname))) ?/)
2955 (not (string= localname "/")))
2956 (substring directory 0 -1)
2959 ;; Directory listings.
2961 (defun tramp-handle-directory-files
2962 (directory &optional full match nosort files-only)
2963 "Like `directory-files' for Tramp files."
2964 ;; FILES-ONLY is valid for XEmacs only.
2965 (when (file-directory-p directory)
2966 (setq directory (expand-file-name directory))
2967 (let ((temp (nreverse (file-name-all-completions "" directory)))
2971 (setq item (directory-file-name (pop temp)))
2972 (when (and (or (null match) (string-match match item))
2973 (or (null files-only)
2975 (and (equal files-only t) (file-regular-p item))
2977 (file-directory-p item)))
2978 (push (if full (expand-file-name item directory) item)
2982 (defun tramp-handle-directory-files-and-attributes
2983 (directory &optional full match nosort id-format)
2984 "Like `directory-files-and-attributes' for Tramp files."
2985 (unless id-format (setq id-format 'integer))
2986 (when (file-directory-p directory)
2987 (setq directory (expand-file-name directory))
2989 (tramp-compat-copy-tree
2990 (with-parsed-tramp-file-name directory nil
2993 (format "directory-files-and-attributes-%s" id-format)
2998 (tramp-convert-file-attributes v (cdr x))))
3000 ((tramp-get-remote-stat v)
3001 (tramp-do-directory-files-and-attributes-with-stat
3002 v localname id-format))
3003 ((tramp-get-remote-perl v)
3004 (tramp-do-directory-files-and-attributes-with-perl
3005 v localname id-format)))))))))
3009 (setq item (pop temp))
3010 (when (or (null match) (string-match match (car item)))
3012 (setcar item (expand-file-name (car item) directory)))
3013 (push item result)))
3017 (sort result (lambda (x y) (string< (car x) (car y))))))))
3019 (defun tramp-do-directory-files-and-attributes-with-perl
3020 (vec localname &optional id-format)
3021 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
3022 (tramp-message vec 5 "directory-files-and-attributes with perl: %s" localname)
3023 (tramp-maybe-send-script
3024 vec tramp-perl-directory-files-and-attributes
3025 "tramp_perl_directory_files_and_attributes")
3027 (tramp-send-command-and-read
3029 (format "tramp_perl_directory_files_and_attributes %s %s"
3030 (tramp-shell-quote-argument localname) id-format))))
3031 (when (stringp object) (tramp-error vec 'file-error object))
3034 (defun tramp-do-directory-files-and-attributes-with-stat
3035 (vec localname &optional id-format)
3036 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
3037 (tramp-message vec 5 "directory-files-and-attributes with stat: %s" localname)
3038 (tramp-send-command-and-read
3042 ;; We must care about filenames with spaces, or starting with
3043 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
3044 ;; but it does not work on all remote systems. Therefore, we
3045 ;; quote the filenames via sed.
3046 "cd %s; echo \"(\"; (%s -a | sed -e s/\\$/\\\"/g -e s/^/\\\"/g | xargs "
3047 "%s -c '(\"%%n\" (\"%%N\") %%h %s %s %%X.0 %%Y.0 %%Z.0 %%s.0 \"%%A\" t %%i.0 -1)'); "
3049 (tramp-shell-quote-argument localname)
3050 (tramp-get-ls-command vec)
3051 (tramp-get-remote-stat vec)
3052 (if (eq id-format 'integer) "%u" "\"%U\"")
3053 (if (eq id-format 'integer) "%g" "\"%G\""))))
3055 ;; This function should return "foo/" for directories and "bar" for
3057 (defun tramp-handle-file-name-all-completions (filename directory)
3058 "Like `file-name-all-completions' for Tramp files."
3059 (unless (save-match-data (string-match "/" filename))
3060 (with-parsed-tramp-file-name (expand-file-name directory) nil
3061 ;; Flush the directory cache. There could be changed directory
3063 (when (and (integerp tramp-completion-reread-directory-timeout)
3066 (tramp-get-file-property
3067 v localname "last-completion" '(0 0 0)))
3068 tramp-completion-reread-directory-timeout))
3069 (tramp-flush-file-property v localname))
3075 (with-file-property v localname "file-name-all-completions"
3077 (tramp-barf-unless-okay
3079 (format "cd %s" (tramp-shell-quote-argument localname))
3080 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
3081 (tramp-shell-quote-argument localname))
3083 ;; Get a list of directories and files, including reliably
3084 ;; tagging the directories with a trailing '/'. Because I
3085 ;; rock. --daniel@danann.net
3088 (format (concat "%s -a 2>/dev/null | while read f; do "
3089 "if %s -d \"$f\" 2>/dev/null; "
3090 "then echo \"$f/\"; else echo \"$f\"; fi; done")
3091 (tramp-get-ls-command v)
3092 (tramp-get-test-command v)))
3094 ;; Now grab the output.
3095 (with-current-buffer (tramp-get-buffer v)
3096 (goto-char (point-max))
3097 (while (zerop (forward-line -1))
3098 (push (buffer-substring
3099 (point) (tramp-compat-line-end-position))
3102 (tramp-set-file-property
3103 v localname "last-completion" (current-time))
3106 ;; The following isn't needed for Emacs 20 but for 19.34?
3107 (defun tramp-handle-file-name-completion
3108 (filename directory &optional predicate)
3109 "Like `file-name-completion' for Tramp files."
3110 (unless (tramp-tramp-file-p directory)
3112 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
3116 (mapcar 'list (file-name-all-completions filename directory))
3118 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
3122 (defun tramp-handle-add-name-to-file
3123 (filename newname &optional ok-if-already-exists)
3124 "Like `add-name-to-file' for Tramp files."
3125 (unless (tramp-equal-remote filename newname)
3126 (with-parsed-tramp-file-name
3127 (if (tramp-tramp-file-p filename) filename newname) nil
3130 "add-name-to-file: %s"
3131 "only implemented for same method, same user, same host")))
3132 (with-parsed-tramp-file-name filename v1
3133 (with-parsed-tramp-file-name newname v2
3134 (let ((ln (when v1 (tramp-get-remote-ln v1))))
3135 (when (and (not ok-if-already-exists)
3136 (file-exists-p newname)
3137 (not (numberp ok-if-already-exists))
3140 "File %s already exists; make it a new name anyway? "
3144 "add-name-to-file: file %s already exists" newname))
3145 (tramp-flush-file-property v2 v2-localname)
3146 (tramp-barf-unless-okay
3148 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
3149 (tramp-shell-quote-argument v2-localname))
3150 "error with add-name-to-file, see buffer `%s' for details"
3153 (defun tramp-handle-copy-file
3154 (filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
3155 "Like `copy-file' for Tramp files."
3156 ;; Check if both files are local -- invoke normal copy-file.
3157 ;; Otherwise, use Tramp from local system.
3158 (setq filename (expand-file-name filename))
3159 (setq newname (expand-file-name newname))
3161 ;; At least one file a Tramp file?
3162 ((or (tramp-tramp-file-p filename)
3163 (tramp-tramp-file-p newname))
3164 (tramp-do-copy-or-rename-file
3165 'copy filename newname ok-if-already-exists keep-date preserve-uid-gid))
3168 (tramp-run-real-handler
3170 (list filename newname ok-if-already-exists keep-date preserve-uid-gid)))
3172 (tramp-run-real-handler
3173 'copy-file (list filename newname ok-if-already-exists keep-date)))))
3175 (defun tramp-handle-copy-directory (dirname newname &optional keep-date parents)
3176 "Like `copy-directory' for Tramp files."
3177 (let ((t1 (tramp-tramp-file-p dirname))
3178 (t2 (tramp-tramp-file-p newname)))
3179 (with-parsed-tramp-file-name (if t1 dirname newname) nil
3180 (if (and (tramp-get-method-parameter method 'tramp-copy-recursive)
3181 ;; When DIRNAME and NEWNAME are remote, they must have
3183 (or (null t1) (null t2)
3184 (string-equal (file-remote-p dirname 'method)
3185 (file-remote-p newname 'method))))
3186 ;; scp or rsync DTRT.
3188 (setq dirname (directory-file-name (expand-file-name dirname))
3189 newname (directory-file-name (expand-file-name newname)))
3190 (if (and (file-directory-p newname)
3191 (not (string-equal (file-name-nondirectory dirname)
3192 (file-name-nondirectory newname))))
3195 (file-name-nondirectory dirname) newname)))
3196 (if (not (file-directory-p (file-name-directory newname)))
3197 (make-directory (file-name-directory newname) parents))
3198 (tramp-do-copy-or-rename-file-out-of-band
3199 'copy dirname newname keep-date))
3200 ;; We must do it file-wise.
3201 (tramp-run-real-handler
3202 'copy-directory (list dirname newname keep-date parents))))))
3204 (defun tramp-handle-rename-file
3205 (filename newname &optional ok-if-already-exists)
3206 "Like `rename-file' for Tramp files."
3207 ;; Check if both files are local -- invoke normal rename-file.
3208 ;; Otherwise, use Tramp from local system.
3209 (setq filename (expand-file-name filename))
3210 (setq newname (expand-file-name newname))
3211 ;; At least one file a Tramp file?
3212 (if (or (tramp-tramp-file-p filename)
3213 (tramp-tramp-file-p newname))
3214 (tramp-do-copy-or-rename-file
3215 'rename filename newname ok-if-already-exists t t)
3216 (tramp-run-real-handler
3217 'rename-file (list filename newname ok-if-already-exists))))
3219 (defun tramp-do-copy-or-rename-file
3220 (op filename newname &optional ok-if-already-exists keep-date preserve-uid-gid)
3221 "Copy or rename a remote file.
3222 OP must be `copy' or `rename' and indicates the operation to perform.
3223 FILENAME specifies the file to copy or rename, NEWNAME is the name of
3224 the new file (for copy) or the new name of the file (for rename).
3225 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
3226 KEEP-DATE means to make sure that NEWNAME has the same timestamp
3227 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
3228 the uid and gid if both files are on the same host.
3230 This function is invoked by `tramp-handle-copy-file' and
3231 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
3232 and `rename'. FILENAME and NEWNAME must be absolute file names."
3233 (unless (memq op '(copy rename))
3234 (error "Unknown operation `%s', must be `copy' or `rename'" op))
3235 (let ((t1 (tramp-tramp-file-p filename))
3236 (t2 (tramp-tramp-file-p newname)))
3238 (when (and (not ok-if-already-exists) (file-exists-p newname))
3239 (with-parsed-tramp-file-name (if t1 filename newname) nil
3241 v 'file-already-exists "File %s already exists" newname)))
3243 (with-parsed-tramp-file-name (if t1 filename newname) nil
3244 (tramp-message v 0 "Transferring %s to %s..." filename newname))
3248 ;; Both are Tramp files.
3250 (with-parsed-tramp-file-name filename v1
3251 (with-parsed-tramp-file-name newname v2
3253 ;; Shortcut: if method, host, user are the same for both
3254 ;; files, we invoke `cp' or `mv' on the remote host
3256 ((tramp-equal-remote filename newname)
3257 (tramp-do-copy-or-rename-file-directly
3259 ok-if-already-exists keep-date preserve-uid-gid))
3261 ;; Try out-of-band operation.
3262 ((tramp-method-out-of-band-p
3263 v1 (nth 7 (file-attributes filename)))
3264 (tramp-do-copy-or-rename-file-out-of-band
3265 op filename newname keep-date))
3267 ;; No shortcut was possible. So we copy the
3268 ;; file first. If the operation was `rename', we go
3269 ;; back and delete the original file (if the copy was
3270 ;; successful). The approach is simple-minded: we
3271 ;; create a new buffer, insert the contents of the
3272 ;; source file into it, then write out the buffer to
3273 ;; the target file. The advantage is that it doesn't
3274 ;; matter which filename handlers are used for the
3275 ;; source and target file.
3277 (tramp-do-copy-or-rename-file-via-buffer
3278 op filename newname keep-date))))))
3280 ;; One file is a Tramp file, the other one is local.
3282 (with-parsed-tramp-file-name (if t1 filename newname) nil
3284 ;; Fast track on local machine.
3285 ((tramp-local-host-p v)
3286 (tramp-do-copy-or-rename-file-directly
3288 ok-if-already-exists keep-date preserve-uid-gid))
3290 ;; If the Tramp file has an out-of-band method, the corresponding
3291 ;; copy-program can be invoked.
3292 ((tramp-method-out-of-band-p v (nth 7 (file-attributes filename)))
3293 (tramp-do-copy-or-rename-file-out-of-band
3294 op filename newname keep-date))
3296 ;; Use the inline method via a Tramp buffer.
3297 (t (tramp-do-copy-or-rename-file-via-buffer
3298 op filename newname keep-date)))))
3301 ;; One of them must be a Tramp file.
3302 (error "Tramp implementation says this cannot happen")))
3304 ;; In case of `rename', we must flush the cache of the source file.
3305 (when (and t1 (eq op 'rename))
3306 (with-parsed-tramp-file-name filename nil
3307 (tramp-flush-file-property v localname)))
3309 ;; When newname did exist, we have wrong cached values.
3311 (with-parsed-tramp-file-name newname nil
3312 (tramp-flush-file-property v localname)))
3314 (with-parsed-tramp-file-name (if t1 filename newname) nil
3315 (tramp-message v 0 "Transferring %s to %s...done" filename newname)))))
3317 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
3318 "Use an Emacs buffer to copy or rename a file.
3319 First arg OP is either `copy' or `rename' and indicates the operation.
3320 FILENAME is the source file, NEWNAME the target file.
3321 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
3323 ;; We must disable multibyte, because binary data shall not be
3325 (set-buffer-multibyte nil)
3326 (let ((coding-system-for-read 'binary)
3327 (jka-compr-inhibit t))
3328 (insert-file-contents-literally filename))
3329 ;; We don't want the target file to be compressed, so we let-bind
3330 ;; `jka-compr-inhibit' to t.
3331 (let ((coding-system-for-write 'binary)
3332 (jka-compr-inhibit t))
3333 (write-region (point-min) (point-max) newname)))
3334 ;; KEEP-DATE handling.
3335 (when keep-date (set-file-times newname (nth 5 (file-attributes filename))))
3337 (set-file-modes newname (tramp-default-file-modes filename))
3338 ;; If the operation was `rename', delete the original file.
3339 (unless (eq op 'copy) (delete-file filename)))
3341 (defun tramp-do-copy-or-rename-file-directly
3342 (op filename newname ok-if-already-exists keep-date preserve-uid-gid)
3343 "Invokes `cp' or `mv' on the remote system.
3344 OP must be one of `copy' or `rename', indicating `cp' or `mv',
3345 respectively. FILENAME specifies the file to copy or rename,
3346 NEWNAME is the name of the new file (for copy) or the new name of
3347 the file (for rename). Both files must reside on the same host.
3348 KEEP-DATE means to make sure that NEWNAME has the same timestamp
3349 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
3350 the uid and gid from FILENAME."
3351 (let ((t1 (tramp-tramp-file-p filename))
3352 (t2 (tramp-tramp-file-p newname))
3353 (file-times (nth 5 (file-attributes filename)))
3354 (file-modes (tramp-default-file-modes filename)))
3355 (with-parsed-tramp-file-name (if t1 filename newname) nil
3356 (let* ((cmd (cond ((and (eq op 'copy) preserve-uid-gid) "cp -f -p")
3357 ((eq op 'copy) "cp -f")
3358 ((eq op 'rename) "mv -f")
3361 "Unknown operation `%s', must be `copy' or `rename'"
3364 (if t1 (tramp-handle-file-remote-p filename 'localname) filename))
3366 (if t2 (tramp-handle-file-remote-p newname 'localname) newname))
3367 (prefix (file-remote-p (if t1 filename newname))))
3370 ;; Both files are on a remote host, with same user.
3374 (format "%s %s %s" cmd
3375 (tramp-shell-quote-argument localname1)
3376 (tramp-shell-quote-argument localname2)))
3377 (with-current-buffer (tramp-get-buffer v)
3378 (goto-char (point-min))
3382 ;; Mask cp -f error.
3384 tramp-operation-not-permitted-regexp nil t))
3385 (zerop (tramp-send-command-and-check v nil)))
3386 (tramp-error-with-buffer
3388 "Copying directly failed, see buffer `%s' for details."
3391 ;; We are on the local host.
3394 ;; We can do it directly.
3395 ((let (file-name-handler-alist)
3396 (and (file-readable-p localname1)
3397 (file-writable-p (file-name-directory localname2))
3398 (or (file-directory-p localname2)
3399 (file-writable-p localname2))))
3401 (tramp-compat-copy-file
3402 localname1 localname2 ok-if-already-exists
3403 keep-date preserve-uid-gid)
3404 (tramp-run-real-handler
3405 'rename-file (list localname1 localname2 ok-if-already-exists))))
3407 ;; We can do it directly with `tramp-send-command'
3408 ((and (file-readable-p (concat prefix localname1))
3410 (file-name-directory (concat prefix localname2)))
3411 (or (file-directory-p (concat prefix localname2))
3412 (file-writable-p (concat prefix localname2))))
3413 (tramp-do-copy-or-rename-file-directly
3414 op (concat prefix localname1) (concat prefix localname2)
3415 ok-if-already-exists keep-date t)
3416 ;; We must change the ownership to the local user.
3417 (tramp-set-file-uid-gid
3418 (concat prefix localname2)
3419 (tramp-get-local-uid 'integer)
3420 (tramp-get-local-gid 'integer)))
3422 ;; We need a temporary file in between.
3424 ;; Create the temporary file.
3425 (let ((tmpfile (tramp-compat-make-temp-file localname1)))
3432 (tramp-send-command-and-check
3435 (tramp-shell-quote-argument localname1)
3436 (tramp-shell-quote-argument tmpfile))))
3437 (tramp-error-with-buffer
3439 "Copying directly failed, see buffer `%s' for details."
3440 (tramp-get-buffer v)))
3441 ;; We must change the ownership as remote user.
3442 ;; Since this does not work reliable, we also
3443 ;; give read permissions.
3445 (concat prefix tmpfile) (tramp-octal-to-decimal "0777"))
3446 (tramp-set-file-uid-gid
3447 (concat prefix tmpfile)
3448 (tramp-get-local-uid 'integer)
3449 (tramp-get-local-gid 'integer)))
3452 (tramp-compat-copy-file
3453 localname1 tmpfile t
3454 keep-date preserve-uid-gid)
3455 (tramp-run-real-handler
3457 (list localname1 tmpfile t)))
3458 ;; We must change the ownership as local user.
3459 ;; Since this does not work reliable, we also
3460 ;; give read permissions.
3461 (set-file-modes tmpfile (tramp-octal-to-decimal "0777"))
3462 (tramp-set-file-uid-gid
3464 (tramp-get-remote-uid v 'integer)
3465 (tramp-get-remote-gid v 'integer))))
3467 ;; Move the temporary file to its destination.
3472 (tramp-send-command-and-check
3475 (tramp-shell-quote-argument tmpfile)
3476 (tramp-shell-quote-argument localname2))))
3477 (tramp-error-with-buffer
3479 "Copying directly failed, see buffer `%s' for details."
3480 (tramp-get-buffer v))))
3482 (tramp-run-real-handler
3484 (list tmpfile localname2 ok-if-already-exists)))))
3488 (delete-file tmpfile)
3491 ;; Set the time and mode. Mask possible errors.
3494 (set-file-times newname file-times)
3495 (set-file-modes newname file-modes))
3498 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
3499 "Invoke rcp program to copy.
3500 The method used must be an out-of-band method."
3501 (let ((t1 (tramp-tramp-file-p filename))
3502 (t2 (tramp-tramp-file-p newname))
3503 copy-program copy-args copy-env copy-keep-date port spec
3506 (with-parsed-tramp-file-name (if t1 filename newname) nil
3509 ;; Both are Tramp files. We shall optimize it, when the
3510 ;; methods for filename and newname are the same.
3511 (let ((tmpfile (tramp-compat-make-temp-file localname)))
3514 (tramp-do-copy-or-rename-file-out-of-band
3515 op filename tmpfile keep-date)
3516 (tramp-do-copy-or-rename-file-out-of-band
3517 'rename tmpfile newname keep-date))
3520 (delete-file tmpfile)
3523 ;; Expand hops. Might be necessary for gateway methods.
3524 (setq v (car (tramp-compute-multi-hops v)))
3525 (aset v 3 localname)
3527 ;; Check which ones of source and target are Tramp files.
3528 (setq source (if t1 (tramp-make-copy-program-file-name v) filename)
3530 (if (and (file-directory-p filename)
3532 (file-name-nondirectory filename)
3533 (file-name-nondirectory newname)))
3534 'file-name-directory
3536 (if t2 (tramp-make-copy-program-file-name v) newname)))
3538 ;; Check for port number. Until now, there's no need for handling
3539 ;; like method, user, host.
3540 (setq host (tramp-file-name-real-host v)
3541 port (tramp-file-name-port v)
3542 port (or (and port (number-to-string port)) ""))
3544 ;; Compose copy command.
3545 (setq spec `((?h . ,host) (?u . ,user) (?p . ,port)
3546 (?t . ,(tramp-get-connection-property
3547 (tramp-get-connection-process v) "temp-file" ""))
3548 (?k . ,(if keep-date " " "")))
3549 copy-program (tramp-get-method-parameter
3550 method 'tramp-copy-program)
3551 copy-keep-date (tramp-get-method-parameter
3552 method 'tramp-copy-keep-date)
3560 ;; " " is indication for keep-date argument.
3561 (delete " " (mapcar (lambda (y) (format-spec y spec)) x)))
3562 (unless (member "" x) (mapconcat 'identity x " ")))
3563 (tramp-get-method-parameter method 'tramp-copy-args)))
3569 (setq x (mapcar (lambda (y) (format-spec y spec)) x))
3570 (unless (member "" x) (mapconcat 'identity x " ")))
3571 (tramp-get-method-parameter method 'tramp-copy-env))))
3573 ;; Check for program.
3574 (when (and (fboundp 'executable-find)
3575 (not (let ((default-directory
3576 (tramp-compat-temporary-file-directory)))
3577 (executable-find copy-program))))
3579 v 'file-error "Cannot find copy program: %s" copy-program))
3583 ;; The default directory must be remote.
3584 (let ((default-directory
3585 (file-name-directory (if t1 filename newname)))
3586 (process-environment (copy-sequence process-environment)))
3587 ;; Set the transfer process properties.
3588 (tramp-set-connection-property
3589 v "process-name" (buffer-name (current-buffer)))
3590 (tramp-set-connection-property
3591 v "process-buffer" (current-buffer))
3593 (tramp-message v 5 "%s=\"%s\"" (car copy-env) (cadr copy-env))
3594 (setenv (pop copy-env) (pop copy-env)))
3596 ;; Use an asynchronous process. By this, password can
3597 ;; be handled. The default directory must be local, in
3598 ;; order to apply the correct `copy-program'. We don't
3599 ;; set a timeout, because the copying of large files can
3600 ;; last longer than 60 secs.
3601 (let ((p (let ((default-directory
3602 (tramp-compat-temporary-file-directory)))
3603 (apply 'start-process
3604 (tramp-get-connection-property
3605 v "process-name" nil)
3606 (tramp-get-connection-property
3607 v "process-buffer" nil)
3609 (append copy-args (list source target))))))
3611 v 6 "%s" (mapconcat 'identity (process-command p) " "))
3612 (tramp-set-process-query-on-exit-flag p nil)
3613 (tramp-process-actions p v tramp-actions-copy-out-of-band))))
3615 ;; Reset the transfer process properties.
3616 (tramp-set-connection-property v "process-name" nil)
3617 (tramp-set-connection-property v "process-buffer" nil))
3619 ;; Handle KEEP-DATE argument.
3620 (when (and keep-date (not copy-keep-date))
3621 (set-file-times newname (nth 5 (file-attributes filename))))
3624 (unless (and keep-date copy-keep-date)
3625 (set-file-modes newname (tramp-default-file-modes filename))))
3627 ;; If the operation was `rename', delete the original file.
3628 (unless (eq op 'copy)
3629 (delete-file filename)))))
3631 (defun tramp-handle-make-directory (dir &optional parents)
3632 "Like `make-directory' for Tramp files."
3633 (setq dir (expand-file-name dir))
3634 (with-parsed-tramp-file-name dir nil
3635 (tramp-flush-directory-property v (file-name-directory localname))
3637 (tramp-barf-unless-okay
3640 (if parents "mkdir -p" "mkdir")
3641 (tramp-shell-quote-argument localname))
3642 "Couldn't make directory %s" dir))))
3644 (defun tramp-handle-delete-directory (directory &optional recursive)
3645 "Like `delete-directory' for Tramp files."
3646 (setq directory (expand-file-name directory))
3647 (with-parsed-tramp-file-name directory nil
3648 (tramp-flush-directory-property v localname)
3649 (unless (zerop (tramp-send-command-and-check
3653 (if recursive "rm -rf" "rmdir")
3654 (tramp-shell-quote-argument localname))))
3655 (tramp-error v 'file-error "Couldn't delete %s" directory))))
3657 (defun tramp-handle-delete-file (filename)
3658 "Like `delete-file' for Tramp files."
3659 (setq filename (expand-file-name filename))
3660 (with-parsed-tramp-file-name filename nil
3661 (tramp-flush-file-property v localname)
3662 (unless (zerop (tramp-send-command-and-check
3665 (tramp-shell-quote-argument localname))))
3666 (tramp-error v 'file-error "Couldn't delete %s" filename))))
3670 ;; CCC: This does not seem to be enough. Something dies when
3671 ;; we try and delete two directories under Tramp :/
3672 (defun tramp-handle-dired-recursive-delete-directory (filename)
3673 "Recursively delete the directory given.
3674 This is like `dired-recursive-delete-directory' for Tramp files."
3675 (with-parsed-tramp-file-name filename nil
3676 ;; Run a shell command 'rm -r <localname>'
3677 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
3678 (unless (file-exists-p filename)
3679 (tramp-error v 'file-error "No such directory: %s" filename))
3680 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
3683 (format "rm -rf %s" (tramp-shell-quote-argument localname))
3684 ;; Don't read the output, do it explicitely.
3686 ;; Wait for the remote system to return to us...
3687 ;; This might take a while, allow it plenty of time.
3688 (tramp-wait-for-output (tramp-get-connection-process v) 120)
3689 ;; Make sure that it worked...
3690 (tramp-flush-directory-property v localname)
3691 (and (file-exists-p filename)
3693 v 'file-error "Failed to recursively delete %s" filename))))
3695 (defun tramp-handle-dired-compress-file (file &rest ok-flag)
3696 "Like `dired-compress-file' for Tramp files."
3697 ;; OK-FLAG is valid for XEmacs only, but not implemented.
3698 ;; Code stolen mainly from dired-aux.el.
3699 (with-parsed-tramp-file-name file nil
3700 (tramp-flush-file-property v localname)
3703 (if (not (featurep 'xemacs))
3705 (symbol-value 'dired-compress-file-suffixes)
3706 ;; XEmacs has `dired-compression-method-alist', which is
3707 ;; transformed into `dired-compress-file-suffixes' structure.
3710 (list (concat (regexp-quote (nth 1 x)) "\\'")
3712 (mapconcat 'identity (nth 3 x) " ")))
3713 (symbol-value 'dired-compression-method-alist))))
3715 ;; See if any suffix rule matches this file name.
3717 (let (case-fold-search)
3718 (if (string-match (car (car suffixes)) localname)
3719 (setq suffix (car suffixes) suffixes nil))
3720 (setq suffixes (cdr suffixes))))
3722 (cond ((file-symlink-p file)
3724 ((and suffix (nth 2 suffix))
3725 ;; We found an uncompression rule.
3726 (tramp-message v 0 "Uncompressing %s..." file)
3727 (when (zerop (tramp-send-command-and-check
3728 v (concat (nth 2 suffix) " " localname)))
3729 (tramp-message v 0 "Uncompressing %s...done" file)
3730 ;; `dired-remove-file' is not defined in XEmacs
3731 (funcall (symbol-function 'dired-remove-file) file)
3732 (string-match (car suffix) file)
3733 (concat (substring file 0 (match-beginning 0)))))
3735 ;; We don't recognize the file as compressed, so compress it.
3737 (tramp-message v 0 "Compressing %s..." file)
3738 (when (zerop (tramp-send-command-and-check
3739 v (concat "gzip -f " localname)))
3740 (tramp-message v 0 "Compressing %s...done" file)
3741 ;; `dired-remove-file' is not defined in XEmacs
3742 (funcall (symbol-function 'dired-remove-file) file)
3743 (cond ((file-exists-p (concat file ".gz"))
3744 (concat file ".gz"))
3745 ((file-exists-p (concat file ".z"))
3749 (defun tramp-handle-dired-uncache (dir)
3750 "Like `dired-uncache' for Tramp files."
3751 (with-parsed-tramp-file-name dir nil
3752 (tramp-flush-file-property v localname)))
3754 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
3755 ;; not sure at all that this is the right way to do it, but let's hope
3756 ;; it works for now, and wait for a guru to point out the Right Way to
3758 ;;(eval-when-compile
3759 ;; (unless (fboundp 'dired-insert-set-properties)
3760 ;; (fset 'dired-insert-set-properties 'ignore)))
3761 ;; Gerd suggests this:
3762 (eval-when-compile (require 'dired))
3763 ;; Note that dired is required at run-time, too, when it is needed.
3764 ;; It is only needed on XEmacs for the function
3765 ;; `dired-insert-set-properties'.
3767 (defun tramp-handle-insert-directory
3768 (filename switches &optional wildcard full-directory-p)
3769 "Like `insert-directory' for Tramp files."
3770 (setq filename (expand-file-name filename))
3771 (with-parsed-tramp-file-name filename nil
3772 (if (and (featurep 'ls-lisp)
3773 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
3774 (tramp-run-real-handler
3775 'insert-directory (list filename switches wildcard full-directory-p))
3776 (when (and (string-match "^--dired\\s-+" switches)
3777 (not (tramp-get-ls-command-with-dired v)))
3778 (setq switches (replace-match "" nil t switches)))
3780 v 4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
3781 switches filename (if wildcard "yes" "no")
3782 (if full-directory-p "yes" "no"))
3784 (setq wildcard (tramp-run-real-handler
3785 'file-name-nondirectory (list localname)))
3786 (setq localname (tramp-run-real-handler
3787 'file-name-directory (list localname))))
3788 (when (listp switches)
3789 (setq switches (mapconcat 'identity switches " ")))
3790 (unless full-directory-p
3791 (setq switches (concat "-d " switches)))
3793 (setq switches (concat switches " " wildcard)))
3794 ;; If `full-directory-p', we just say `ls -l FILENAME'.
3795 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
3796 (if full-directory-p
3800 (tramp-get-ls-command v)
3804 (tramp-shell-quote-argument (concat localname ".")))))
3805 (tramp-barf-unless-okay
3807 (format "cd %s" (tramp-shell-quote-argument
3808 (tramp-run-real-handler
3809 'file-name-directory (list localname))))
3811 (tramp-shell-quote-argument
3812 (tramp-run-real-handler 'file-name-directory (list localname))))
3816 (tramp-get-ls-command v)
3820 (tramp-run-real-handler
3821 'file-name-nondirectory (list localname)))))
3823 (tramp-shell-quote-argument
3824 (tramp-run-real-handler
3825 'file-name-nondirectory (list localname)))))))
3826 (let ((beg (point)))
3827 ;; We cannot use `insert-buffer-substring' because the Tramp
3828 ;; buffer changes its contents before insertion due to calling
3829 ;; `expand-file' and alike.
3831 (with-current-buffer (tramp-get-buffer v)
3834 ;; Check for "--dired" output.
3836 (when (looking-at "//DIRED//")
3837 (let ((end (tramp-compat-line-end-position))
3839 ;; Now read the numeric positions of file names.
3843 (while (< (point) end)
3844 (let ((start (+ beg (read (current-buffer))))
3845 (end (+ beg (read (current-buffer)))))
3846 (if (memq (char-after end) '(?\n ?\ ))
3847 ;; End is followed by \n or by " -> ".
3848 (put-text-property start end 'dired-filename t)))))
3849 ;; Remove trailing lines.
3850 (goto-char (tramp-compat-line-beginning-position))
3851 (while (looking-at "//")
3853 (delete-region (match-beginning 0) (point)))))
3854 (goto-char (point-max)))))
3856 (defun tramp-handle-unhandled-file-name-directory (filename)
3857 "Like `unhandled-file-name-directory' for Tramp files."
3858 ;; With Emacs 23, we could simply return `nil'. But we must keep it
3859 ;; for backward compatibility.
3860 (expand-file-name "~/"))
3862 ;; Canonicalization of file names.
3864 (defun tramp-handle-expand-file-name (name &optional dir)
3865 "Like `expand-file-name' for Tramp files.
3866 If the localname part of the given filename starts with \"/../\" then
3867 the result will be a local, non-Tramp, filename."
3868 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
3869 (setq dir (or dir default-directory "/"))
3870 ;; Unless NAME is absolute, concat DIR and NAME.
3871 (unless (file-name-absolute-p name)
3872 (setq name (concat (file-name-as-directory dir) name)))
3873 ;; If NAME is not a Tramp file, run the real handler.
3874 (if (not (tramp-tramp-file-p name))
3875 (tramp-run-real-handler 'expand-file-name (list name nil))
3877 (with-parsed-tramp-file-name name nil
3878 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
3879 (setq localname (concat "~/" localname)))
3880 ;; Tilde expansion if necessary. This needs a shell which
3881 ;; groks tilde expansion! The function `tramp-find-shell' is
3882 ;; supposed to find such a shell on the remote host. Please
3883 ;; tell me about it when this doesn't work on your system.
3884 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
3885 (let ((uname (match-string 1 localname))
3886 (fname (match-string 2 localname)))
3887 ;; We cannot simply apply "~/", because under sudo "~/" is
3888 ;; expanded to the local user home directory but to the
3889 ;; root home directory. On the other hand, using always
3890 ;; the default user name for tilde expansion is not
3891 ;; appropriate either, because ssh and companions might
3892 ;; use a user name from the config file.
3893 (when (and (string-equal uname "~")
3894 (string-match "\\`su\\(do\\)?\\'" method))
3895 (setq uname (concat uname user)))
3897 (with-connection-property v uname
3898 (tramp-send-command v (format "cd %s; pwd" uname))
3899 (with-current-buffer (tramp-get-buffer v)
3900 (goto-char (point-min))
3901 (buffer-substring (point) (tramp-compat-line-end-position)))))
3902 (setq localname (concat uname fname))))
3903 ;; There might be a double slash, for example when "~/"
3904 ;; expands to "/". Remove this.
3905 (while (string-match "//" localname)
3906 (setq localname (replace-match "/" t t localname)))
3907 ;; No tilde characters in file name, do normal
3908 ;; `expand-file-name' (this does "/./" and "/../"). We bind
3909 ;; `directory-sep-char' here for XEmacs on Windows, which would
3910 ;; otherwise use backslash. `default-directory' is bound,
3911 ;; because on Windows there would be problems with UNC shares or
3913 (let ((directory-sep-char ?/)
3914 (default-directory (tramp-compat-temporary-file-directory)))
3915 (tramp-make-tramp-file-name
3917 (tramp-drop-volume-letter
3918 (tramp-run-real-handler
3919 'expand-file-name (list localname))))))))
3921 (defun tramp-replace-environment-variables (filename)
3922 "Replace environment variables in FILENAME.
3923 Return the string with the replaced variables."
3925 (let ((idx (string-match "$\\w+" filename)))
3926 ;; `$' is coded as `$$'.
3927 (when (and idx (or (zerop idx) (not (eq ?$ (aref filename (1- idx))))))
3930 (substitute-in-file-name (match-string 0 filename))
3934 (defun tramp-handle-substitute-in-file-name (filename)
3935 "Like `substitute-in-file-name' for Tramp files.
3936 \"//\" and \"/~\" substitute only in the local filename part.
3937 If the URL Tramp syntax is chosen, \"//\" as method delimeter and \"/~\" at
3938 beginning of local filename are not substituted."
3939 ;; First, we must replace environment variables.
3940 (setq filename (tramp-replace-environment-variables filename))
3941 (with-parsed-tramp-file-name filename nil
3942 (if (equal tramp-syntax 'url)
3943 ;; We need to check localname only. The other parts cannot contain
3945 (if (and (> (length localname) 1)
3946 (or (string-match "//" localname)
3947 (string-match "/~" localname 1)))
3948 (tramp-run-real-handler 'substitute-in-file-name (list filename))
3949 (tramp-make-tramp-file-name
3950 (when method (substitute-in-file-name method))
3951 (when user (substitute-in-file-name user))
3952 (when host (substitute-in-file-name host))
3954 (tramp-run-real-handler
3955 'substitute-in-file-name (list localname)))))
3956 ;; Ignore in LOCALNAME everything before "//" or "/~".
3957 (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname))
3959 (concat (file-remote-p filename)
3960 (replace-match "\\1" nil nil localname)))
3961 ;; "/m:h:~" does not work for completion. We use "/m:h:~/".
3962 (when (string-match "~$" filename)
3963 (setq filename (concat filename "/"))))
3964 (tramp-run-real-handler 'substitute-in-file-name (list filename)))))
3966 ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~,
3967 ;; which calls corresponding functions (see minibuf.el).
3968 (when (fboundp 'minibuffer-electric-separator)
3973 (around ,(intern (format "tramp-advice-%s" x)) activate)
3974 "Invoke `substitute-in-file-name' for Tramp files."
3975 (if (and (symbol-value 'minibuffer-electric-file-name-behavior)
3976 (tramp-tramp-file-p (buffer-substring)))
3977 ;; We don't need to handle `last-input-event', because
3978 ;; due to the key map we know it must be ?/ or ?~.
3979 (let ((s (concat (buffer-substring (point-min) (point))
3980 (string last-command-char))))
3981 (delete-region (point-min) (point))
3982 (insert (substitute-in-file-name s))
3983 (setq ad-return-value last-command-char))
3986 '(minibuffer-electric-separator
3987 minibuffer-electric-tilde)))
3990 ;;; Remote commands:
3992 (defun tramp-handle-executable-find (command)
3993 "Like `executable-find' for Tramp files."
3994 (with-parsed-tramp-file-name default-directory nil
3995 (tramp-find-executable v command (tramp-get-remote-path v) t)))
3997 ;; We use BUFFER also as connection buffer during setup. Because of
3998 ;; this, its original contents must be saved, and restored once
3999 ;; connection has been setup.
4000 (defun tramp-handle-start-file-process (name buffer program &rest args)
4001 "Like `start-file-process' for Tramp files."
4002 (with-parsed-tramp-file-name default-directory nil
4003 (unless (stringp program)
4005 v 'file-error "pty association is not supported for `%s'" name))
4007 (let ((command (format "cd %s; exec %s"
4008 (tramp-shell-quote-argument localname)
4009 (mapconcat 'tramp-shell-quote-argument
4010 (cons program args) " ")))
4014 ;; BUFFER can be nil. We use a temporary buffer.
4015 (setq buffer (generate-new-buffer tramp-temp-buffer-name)))
4016 (while (get-process name1)
4017 ;; NAME must be unique as process name.
4019 name1 (format "%s<%d>" name i)))
4021 ;; Set the new process properties.
4022 (tramp-set-connection-property v "process-name" name)
4023 (tramp-set-connection-property v "process-buffer" buffer)
4024 ;; Activate narrowing in order to save BUFFER contents.
4025 ;; Clear also the modification time; otherwise we might be
4026 ;; interrupted by `verify-visited-file-modtime'.
4027 (with-current-buffer (tramp-get-connection-buffer v)
4028 (clear-visited-file-modtime)
4029 (narrow-to-region (point-max) (point-max)))
4030 ;; Send the command. `tramp-send-command' opens a new
4032 (tramp-send-command v command nil t) ; nooutput
4033 ;; Set query flag for this process.
4034 (tramp-set-process-query-on-exit-flag
4035 (tramp-get-connection-process v) t)
4037 (tramp-get-connection-process v))
4039 (with-current-buffer (tramp-get-connection-buffer v)
4040 (if (string-match tramp-temp-buffer-name (buffer-name))
4042 (set-process-buffer (tramp-get-connection-process v) nil)
4043 (kill-buffer (current-buffer)))
4045 (goto-char (point-max))))
4046 (tramp-set-connection-property v "process-name" nil)
4047 (tramp-set-connection-property v "process-buffer" nil))))
4049 (defun tramp-handle-process-file
4050 (program &optional infile destination display &rest args)
4051 "Like `process-file' for Tramp files."
4052 ;; The implementation is not complete yet.
4053 (when (and (numberp destination) (zerop destination))
4054 (error "Implementation does not handle immediate return"))
4056 (with-parsed-tramp-file-name default-directory nil
4057 (let (command input tmpinput stderr tmpstderr outbuf ret)
4059 (setq command (mapconcat 'tramp-shell-quote-argument
4060 (cons program args) " "))
4063 (setq input "/dev/null")
4064 (setq infile (expand-file-name infile))
4065 (if (tramp-equal-remote default-directory infile)
4066 ;; INFILE is on the same remote host.
4067 (setq input (with-parsed-tramp-file-name infile nil localname))
4068 ;; INFILE must be copied to remote host.
4069 (setq input (tramp-make-tramp-temp-file v)
4070 tmpinput (tramp-make-tramp-file-name method user host input))
4071 (copy-file infile tmpinput t)))
4072 (when input (setq command (format "%s <%s" command input)))
4074 ;; Determine output.
4077 ((bufferp destination)
4078 (setq outbuf destination))
4080 ((stringp destination)
4081 (setq outbuf (get-buffer-create destination)))
4082 ;; (REAL-DESTINATION ERROR-DESTINATION)
4083 ((consp destination)
4086 ((bufferp (car destination))
4087 (setq outbuf (car destination)))
4088 ((stringp (car destination))
4089 (setq outbuf (get-buffer-create (car destination))))
4091 (setq outbuf (current-buffer))))
4094 ((stringp (cadr destination))
4095 (setcar (cdr destination) (expand-file-name (cadr destination)))
4096 (if (tramp-equal-remote default-directory (cadr destination))
4097 ;; stderr is on the same remote host.
4098 (setq stderr (with-parsed-tramp-file-name
4099 (cadr destination) nil localname))
4100 ;; stderr must be copied to remote host. The temporary
4101 ;; file must be deleted after execution.
4102 (setq stderr (tramp-make-tramp-temp-file v)
4103 tmpstderr (tramp-make-tramp-file-name
4104 method user host stderr))))
4105 ;; stderr to be discarded.
4106 ((null (cadr destination))
4107 (setq stderr "/dev/null"))))
4110 (setq outbuf (current-buffer))))
4111 (when stderr (setq command (format "%s 2>%s" command stderr)))
4113 ;; Goto working directory.
4115 v (format "cd %s" (tramp-shell-quote-argument localname)))
4116 ;; Send the command. It might not return in time, so we protect it.
4119 (tramp-send-command v command)
4120 ;; We should show the output anyway.
4122 (let ((output-string
4123 (with-current-buffer (tramp-get-connection-buffer v)
4124 (buffer-substring (point-min) (point-max)))))
4125 (with-current-buffer outbuf
4126 (insert output-string)))
4127 (when display (display-buffer outbuf))))
4128 ;; When the user did interrupt, we should do it also. We use
4129 ;; return code -1 as marker.
4131 (kill-buffer (tramp-get-connection-buffer v))
4135 (kill-buffer (tramp-get-connection-buffer v))
4138 ;; Check return code.
4139 (unless ret (setq ret (tramp-send-command-and-check v nil)))
4140 ;; Provide error file.
4141 (when tmpstderr (rename-file tmpstderr (cadr destination) t))
4143 ;; Cleanup. We remove all file cache values for the connection,
4144 ;; because the remote process could have changed them.
4145 (when tmpinput (delete-file tmpinput))
4147 ;; `process-file-side-effects' has been introduced with GNU
4148 ;; Emacs 23.2. If set to `nil', no remote file will be changed
4149 ;; by `program'. If it doesn't exist, we assume its default
4151 (unless (and (boundp 'process-file-side-effects)
4152 (not (symbol-value 'process-file-side-effects)))
4153 (tramp-flush-directory-property v ""))
4155 ;; Return exit status.
4160 (defun tramp-local-call-process
4161 (program &optional infile destination display &rest args)
4162 "Calls `call-process' on the local host.
4163 This is needed because for some Emacs flavors Tramp has
4164 defadviced `call-process' to behave like `process-file'. The
4165 Lisp error raised when PROGRAM is nil is trapped also, returning 1."
4166 (let ((default-directory
4167 (if (file-remote-p default-directory)
4168 (tramp-compat-temporary-file-directory)
4169 default-directory)))
4170 (if (executable-find program)
4171 (apply 'call-process program infile destination display args)
4174 (defun tramp-handle-call-process-region
4175 (start end program &optional delete buffer display &rest args)
4176 "Like `call-process-region' for Tramp files."
4177 (let ((tmpfile (tramp-compat-make-temp-file "")))
4178 (write-region start end tmpfile)
4179 (when delete (delete-region start end))
4181 (apply 'call-process program tmpfile buffer display args)
4182 (delete-file tmpfile))))
4184 (defun tramp-handle-shell-command
4185 (command &optional output-buffer error-buffer)
4186 "Like `shell-command' for Tramp files."
4187 (let* ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
4188 ;; We cannot use `shell-file-name' and `shell-command-switch',
4189 ;; they are variables of the local host.
4190 (args (list "/bin/sh" "-c" (substring command 0 asynchronous)))
4194 ((bufferp output-buffer) output-buffer)
4195 ((stringp output-buffer) (get-buffer-create output-buffer))
4197 (setq current-buffer-p t)
4199 (t (get-buffer-create
4201 "*Async Shell Command*"
4202 "*Shell Command Output*")))))
4205 ((bufferp error-buffer) error-buffer)
4206 ((stringp error-buffer) (get-buffer-create error-buffer))))
4208 (if (and (not asynchronous) error-buffer)
4209 (with-parsed-tramp-file-name default-directory nil
4210 (list output-buffer (tramp-make-tramp-temp-file v)))
4212 (p (get-buffer-process output-buffer)))
4214 ;; Check whether there is another process running. Tramp does not
4215 ;; support 2 (asynchronous) processes in parallel.
4217 (if (yes-or-no-p "A command is running. Kill it? ")
4221 (error "Shell command in progress")))
4223 (if current-buffer-p
4225 (barf-if-buffer-read-only)
4227 (with-current-buffer output-buffer
4228 (setq buffer-read-only nil)
4231 (if (and (not current-buffer-p) (integerp asynchronous))
4234 (apply 'start-file-process "*Async Shell*" buffer args)
4236 (pop-to-buffer output-buffer)
4237 (setq mode-line-process '(":%s"))
4238 (require 'shell) (shell-mode))
4242 (apply 'process-file (car args) nil buffer nil (cdr args))
4243 ;; Insert error messages if they were separated.
4244 (when (listp buffer)
4245 (with-current-buffer error-buffer
4246 (insert-file-contents (cadr buffer)))
4247 (delete-file (cadr buffer)))
4248 (if current-buffer-p
4249 ;; This is like exchange-point-and-mark, but doesn't
4250 ;; activate the mark. It is cleaner to avoid activation,
4251 ;; even though the command loop would deactivate the mark
4252 ;; because we inserted text.
4253 (goto-char (prog1 (mark t)
4254 (set-marker (mark-marker) (point)
4256 ;; There's some output, display it.
4257 (when (with-current-buffer output-buffer (> (point-max) (point-min)))
4258 (if (functionp 'display-message-or-buffer)
4259 (funcall (symbol-function 'display-message-or-buffer)
4261 (pop-to-buffer output-buffer))))))))
4265 (defvar tramp-handle-file-local-copy-hook nil
4266 "Normal hook to be run at the end of `tramp-handle-file-local-copy'.")
4268 (defun tramp-handle-file-local-copy (filename)
4269 "Like `file-local-copy' for Tramp files."
4271 (with-parsed-tramp-file-name filename nil
4272 (unless (file-exists-p filename)
4275 "Cannot make local copy of non-existing file `%s'" filename))
4277 (let ((rem-enc (tramp-get-remote-coding v "remote-encoding"))
4278 (loc-dec (tramp-get-local-coding v "local-decoding"))
4279 (tmpfile (tramp-compat-make-temp-file filename)))
4283 ;; `copy-file' handles direct copy and out-of-band methods.
4284 ((or (tramp-local-host-p v)
4285 (tramp-method-out-of-band-p
4286 v (nth 7 (file-attributes filename))))
4287 (copy-file filename tmpfile t t))
4289 ;; Use inline encoding for file transfer.
4292 (tramp-message v 5 "Encoding remote file %s..." filename)
4293 (tramp-barf-unless-okay
4295 (format "%s < %s" rem-enc (tramp-shell-quote-argument localname))
4296 "Encoding remote file failed")
4297 (tramp-message v 5 "Encoding remote file %s...done" filename)
4299 (if (and (symbolp loc-dec) (fboundp loc-dec))
4300 ;; If local decoding is a function, we call it. We
4301 ;; must disable multibyte, because
4302 ;; `uudecode-decode-region' doesn't handle it
4305 (set-buffer-multibyte nil)
4306 (insert-buffer-substring (tramp-get-buffer v))
4308 v 5 "Decoding remote file %s with function %s..."
4310 (funcall loc-dec (point-min) (point-max))
4311 ;; Unset `file-name-handler-alist'. Otherwise,
4312 ;; epa-file gets confused.
4313 (let (file-name-handler-alist
4314 (coding-system-for-write 'binary))
4315 (write-region (point-min) (point-max) tmpfile)))
4317 ;; If tramp-decoding-function is not defined for this
4318 ;; method, we invoke tramp-decoding-command instead.
4319 (let ((tmpfile2 (tramp-compat-make-temp-file filename)))
4320 ;; Unset `file-name-handler-alist'. Otherwise,
4321 ;; epa-file gets confused.
4322 (let (file-name-handler-alist
4323 (coding-system-for-write 'binary))
4324 (write-region (point-min) (point-max) tmpfile2))
4326 v 5 "Decoding remote file %s with command %s..."
4329 (tramp-call-local-coding-command loc-dec tmpfile2 tmpfile)
4330 (delete-file tmpfile2))))
4332 (tramp-message v 5 "Decoding remote file %s...done" filename)
4333 ;; Set proper permissions.
4334 (set-file-modes tmpfile (tramp-default-file-modes filename))
4335 ;; Set local user ownership.
4336 (tramp-set-file-uid-gid tmpfile)))
4338 ;; Oops, I don't know what to do.
4340 v 'file-error "Wrong method specification for `%s'" method)))
4344 (delete-file tmpfile)
4345 (signal (car err) (cdr err))))
4347 (run-hooks 'tramp-handle-file-local-copy-hook)
4350 (defun tramp-handle-file-remote-p (filename &optional identification connected)
4351 "Like `file-remote-p' for Tramp files."
4352 (when (tramp-tramp-file-p filename)
4353 (with-parsed-tramp-file-name filename nil
4354 (and (or (not connected)
4355 (let ((p (tramp-get-connection-process v)))
4356 (and p (processp p) (memq (process-status p) '(run open)))))
4358 ((eq identification 'method) method)
4359 ((eq identification 'user) user)
4360 ((eq identification 'host) host)
4361 ((eq identification 'localname) localname)
4362 (t (tramp-make-tramp-file-name method user host "")))))))
4364 (defun tramp-find-file-name-coding-system-alist (filename tmpname)
4365 "Like `find-operation-coding-system' for Tramp filenames.
4366 Tramp's `insert-file-contents' and `write-region' work over
4367 temporary file names. If `file-coding-system-alist' contains an
4368 expression, which matches more than the file name suffix, the
4369 coding system might not be determined. This function repairs it."
4371 (dolist (elt file-coding-system-alist result)
4372 (when (and (consp elt) (string-match (car elt) filename))
4373 ;; We found a matching entry in `file-coding-system-alist'.
4374 ;; So we add a similar entry, but with the temporary file name
4377 'result (cons (regexp-quote tmpname) (cdr elt)) 'append)))))
4379 (defun tramp-handle-insert-file-contents
4380 (filename &optional visit beg end replace)
4381 "Like `insert-file-contents' for Tramp files."
4382 (barf-if-buffer-read-only)
4383 (setq filename (expand-file-name filename))
4384 (let (coding-system-used result local-copy remote-copy)
4385 (with-parsed-tramp-file-name filename nil
4387 (if (not (file-exists-p filename))
4388 ;; We don't raise a Tramp error, because it might be
4389 ;; suppressed, like in `find-file-noselect-1'.
4391 (list "File not found on remote host" filename))
4393 (if (and (tramp-local-host-p v)
4394 (let (file-name-handler-alist)
4395 (file-readable-p localname)))
4396 ;; Short track: if we are on the local host, we can
4399 (tramp-run-real-handler
4400 'insert-file-contents
4401 (list localname visit beg end replace)))
4403 ;; When we shall insert only a part of the file, we copy
4406 (setq remote-copy (tramp-make-tramp-temp-file v))
4411 (format "tail -c +%d %s | head -c +%d >%s"
4412 (1+ beg) (tramp-shell-quote-argument localname)
4413 (- end beg) remote-copy))
4415 (format "tail -c +%d %s >%s"
4416 (1+ beg) (tramp-shell-quote-argument localname)
4419 (format "head -c +%d %s >%s"
4420 (1+ end) (tramp-shell-quote-argument localname)
4423 ;; `insert-file-contents-literally' takes care to avoid
4424 ;; calling jka-compr. By let-binding
4425 ;; `inhibit-file-name-operation', we propagate that care
4426 ;; to the `file-local-copy' operation.
4428 (let ((inhibit-file-name-operation
4429 (when (eq inhibit-file-name-operation
4430 'insert-file-contents)
4433 (if (stringp remote-copy)
4434 (tramp-make-tramp-file-name
4435 method user host remote-copy)
4438 v 4 "Inserting local temp file `%s'..." local-copy)
4440 ;; We must ensure that `file-coding-system-alist'
4441 ;; matches `local-copy'.
4442 (let ((file-coding-system-alist
4443 (tramp-find-file-name-coding-system-alist
4444 filename local-copy)))
4446 (insert-file-contents
4447 local-copy nil nil nil replace))
4448 ;; Now `last-coding-system-used' has right value.
4450 (when (boundp 'last-coding-system-used)
4451 (setq coding-system-used
4452 (symbol-value 'last-coding-system-used))))
4455 v 4 "Inserting local temp file `%s'...done" local-copy)
4456 (when (boundp 'last-coding-system-used)
4457 (set 'last-coding-system-used coding-system-used))))
4462 (setq buffer-file-name filename)
4463 (setq buffer-read-only (not (file-writable-p filename)))
4464 (set-visited-file-modtime)
4465 (set-buffer-modified-p nil))
4466 (when (stringp local-copy)
4467 (delete-file local-copy))
4468 (when (stringp remote-copy)
4470 (tramp-make-tramp-file-name method user host remote-copy))))))
4473 (list (expand-file-name filename)
4476 ;; This is needed for XEmacs only. Code stolen from files.el.
4477 (defun tramp-handle-insert-file-contents-literally
4478 (filename &optional visit beg end replace)
4479 "Like `insert-file-contents-literally' for Tramp files."
4480 (let ((format-alist nil)
4481 (after-insert-file-functions nil)
4482 (coding-system-for-read 'no-conversion)
4483 (coding-system-for-write 'no-conversion)
4484 (find-buffer-file-type-function
4485 (if (fboundp 'find-buffer-file-type)
4486 (symbol-function 'find-buffer-file-type)
4488 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
4489 (inhibit-file-name-operation 'insert-file-contents))
4492 (fset 'find-buffer-file-type (lambda (filename) t))
4493 (insert-file-contents filename visit beg end replace))
4495 (if find-buffer-file-type-function
4496 (fset 'find-buffer-file-type find-buffer-file-type-function)
4497 (fmakunbound 'find-buffer-file-type)))))
4499 (defun tramp-handle-find-backup-file-name (filename)
4500 "Like `find-backup-file-name' for Tramp files."
4501 (with-parsed-tramp-file-name filename nil
4502 ;; We set both variables. It doesn't matter whether it is
4504 (let ((backup-directory-alist
4506 (when (boundp 'backup-directory-alist)
4507 (if (symbol-value 'tramp-backup-directory-alist)
4512 (if (and (stringp (cdr x))
4513 (file-name-absolute-p (cdr x))
4514 (not (tramp-file-name-p (cdr x))))
4515 (tramp-make-tramp-file-name method user host (cdr x))
4517 (symbol-value 'tramp-backup-directory-alist))
4518 (symbol-value 'backup-directory-alist))))
4520 (bkup-backup-directory-info
4522 (when (boundp 'bkup-backup-directory-info)
4523 (if (symbol-value 'tramp-bkup-backup-directory-info)
4529 (if (and (stringp (car (cdr x)))
4530 (file-name-absolute-p (car (cdr x)))
4531 (not (tramp-file-name-p (car (cdr x)))))
4532 (tramp-make-tramp-file-name
4533 method user host (car (cdr x)))
4536 (symbol-value 'tramp-bkup-backup-directory-info))
4537 (symbol-value 'bkup-backup-directory-info)))))
4539 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
4541 (defun tramp-handle-make-auto-save-file-name ()
4542 "Like `make-auto-save-file-name' for Tramp files.
4543 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
4544 (let ((tramp-auto-save-directory tramp-auto-save-directory)
4546 (tramp-subst-strs-in-string
4553 (buffer-file-name))))
4554 ;; File name must be unique. This is ensured with Emacs 22 (see
4555 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
4556 ;; all other cases we must do it ourselves.
4557 (when (boundp 'auto-save-file-name-transforms)
4560 (when (and (string-match (car x) buffer-file-name)
4561 (not (car (cddr x))))
4562 (setq tramp-auto-save-directory
4563 (or tramp-auto-save-directory
4564 (tramp-compat-temporary-file-directory)))))
4565 (symbol-value 'auto-save-file-name-transforms)))
4566 ;; Create directory.
4567 (when tramp-auto-save-directory
4568 (setq buffer-file-name
4569 (expand-file-name buffer-file-name tramp-auto-save-directory))
4570 (unless (file-exists-p tramp-auto-save-directory)
4571 (make-directory tramp-auto-save-directory t)))
4572 ;; Run plain `make-auto-save-file-name'. There might be an advice when
4573 ;; it is not a magic file name operation (since Emacs 22).
4574 ;; We must deactivate it temporarily.
4575 (if (not (ad-is-active 'make-auto-save-file-name))
4576 (tramp-run-real-handler 'make-auto-save-file-name nil)
4578 (ad-deactivate 'make-auto-save-file-name)
4580 (tramp-run-real-handler 'make-auto-save-file-name nil)
4581 (ad-activate 'make-auto-save-file-name)))))
4583 (defvar tramp-handle-write-region-hook nil
4584 "Normal hook to be run at the end of `tramp-handle-write-region'.")
4586 ;; CCC grok APPEND, LOCKNAME
4587 (defun tramp-handle-write-region
4588 (start end filename &optional append visit lockname confirm)
4589 "Like `write-region' for Tramp files."
4590 (setq filename (expand-file-name filename))
4591 (with-parsed-tramp-file-name filename nil
4592 (unless (null append)
4594 v 'file-error "Cannot append to file using Tramp (`%s')" filename))
4595 ;; Following part commented out because we don't know what to do about
4596 ;; file locking, and it does not appear to be a problem to ignore it.
4597 ;; Ange-ftp ignores it, too.
4598 ;; (when (and lockname (stringp lockname))
4599 ;; (setq lockname (expand-file-name lockname)))
4600 ;; (unless (or (eq lockname nil)
4601 ;; (string= lockname filename))
4603 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
4605 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
4606 (when (and (not (featurep 'xemacs)) confirm (file-exists-p filename))
4607 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename))
4608 (tramp-error v 'file-error "File not overwritten")))
4610 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename 'integer))
4611 (tramp-get-remote-uid v 'integer)))
4612 (gid (or (nth 3 (tramp-compat-file-attributes filename 'integer))
4613 (tramp-get-remote-gid v 'integer))))
4615 (if (and (tramp-local-host-p v)
4616 ;; `file-writable-p' calls `file-expand-file-name'. We
4617 ;; cannot use `tramp-run-real-handler' therefore.
4618 (let (file-name-handler-alist)
4620 (file-writable-p (file-name-directory localname))
4621 (or (file-directory-p localname)
4622 (file-writable-p localname)))))
4623 ;; Short track: if we are on the local host, we can run directly.
4625 (tramp-run-real-handler
4627 (list start end localname append 'no-message lockname confirm))
4628 (tramp-flush-file-property v localname))
4630 (let ((rem-dec (tramp-get-remote-coding v "remote-decoding"))
4631 (loc-enc (tramp-get-local-coding v "local-encoding"))
4632 (modes (save-excursion (tramp-default-file-modes filename)))
4633 ;; We use this to save the value of
4634 ;; `last-coding-system-used' after writing the tmp file.
4635 ;; At the end of the function, we set
4636 ;; `last-coding-system-used' to this saved value. This
4637 ;; way, any intermediary coding systems used while
4638 ;; talking to the remote shell or suchlike won't hose
4639 ;; this variable. This approach was snarfed from
4642 ;; Write region into a tmp file. This isn't really
4643 ;; needed if we use an encoding function, but currently
4644 ;; we use it always because this makes the logic
4646 (tmpfile (tramp-compat-make-temp-file filename)))
4648 ;; We say `no-message' here because we don't want the
4649 ;; visited file modtime data to be clobbered from the temp
4650 ;; file. We call `set-visited-file-modtime' ourselves later
4651 ;; on. We must ensure that `file-coding-system-alist'
4652 ;; matches `tmpfile'.
4653 (let ((file-coding-system-alist
4654 (tramp-find-file-name-coding-system-alist filename tmpfile)))
4656 (tramp-run-real-handler
4658 (list start end tmpfile append 'no-message lockname confirm))
4660 (delete-file tmpfile)
4661 (signal (car err) (cdr err))))
4663 ;; Now, `last-coding-system-used' has the right value. Remember it.
4664 (when (boundp 'last-coding-system-used)
4665 (setq coding-system-used
4666 (symbol-value 'last-coding-system-used))))
4668 ;; The permissions of the temporary file should be set. If
4669 ;; filename does not exist (eq modes nil) it has been
4670 ;; renamed to the backup file. This case `save-buffer'
4671 ;; handles permissions.
4672 (when modes (set-file-modes tmpfile modes))
4674 ;; This is a bit lengthy due to the different methods
4675 ;; possible for file transfer. First, we check whether the
4676 ;; method uses an rcp program. If so, we call it.
4677 ;; Otherwise, both encoding and decoding command must be
4678 ;; specified. However, if the method _also_ specifies an
4679 ;; encoding function, then that is used for encoding the
4680 ;; contents of the tmp file.
4682 ;; `rename-file' handles direct copy and out-of-band methods.
4683 ((or (tramp-local-host-p v)
4684 (tramp-method-out-of-band-p
4685 v (- (or end (point-max)) (or start (point-min)))))
4687 (rename-file tmpfile filename t)
4689 (delete-file tmpfile)
4690 (signal (car err) (cdr err)))))
4692 ;; Use inline file transfer.
4695 (tramp-message v 5 "Encoding region...")
4698 ;; Use encoding function or command.
4699 (if (and (symbolp loc-enc) (fboundp loc-enc))
4702 v 5 "Encoding region using function `%s'..."
4703 (symbol-name loc-enc))
4704 (let ((coding-system-for-read 'binary))
4705 (insert-file-contents-literally tmpfile))
4706 ;; The following `let' is a workaround for the
4707 ;; base64.el that comes with pgnus-0.84. If
4708 ;; both of the following conditions are
4709 ;; satisfied, it tries to write to a local
4710 ;; file in default-directory, but at this
4711 ;; point, default-directory is remote.
4712 ;; (`call-process-region' can't write to
4713 ;; remote files, it seems.) The file in
4714 ;; question is a tmp file anyway.
4715 (let ((default-directory
4716 (tramp-compat-temporary-file-directory)))
4717 (funcall loc-enc (point-min) (point-max))))
4720 v 5 "Encoding region using command `%s'..." loc-enc)
4721 (unless (equal 0 (tramp-call-local-coding-command
4725 "Cannot write to `%s', local encoding command `%s' failed"
4728 ;; Send buffer into remote decoding command which
4729 ;; writes to remote file. Because this happens on
4730 ;; the remote host, we cannot use the function.
4731 (goto-char (point-max))
4732 (unless (bolp) (newline))
4734 v 5 "Decoding region into remote file %s..." filename)
4738 "%s >%s <<'EOF'\n%sEOF"
4740 (tramp-shell-quote-argument localname)
4742 (tramp-barf-unless-okay
4744 "Couldn't write region to `%s', decode using `%s' failed"
4746 ;; When `file-precious-flag' is set, the region is
4747 ;; written to a temporary file. Check that the
4748 ;; checksum is equal to that from the local tmpfile.
4749 (when file-precious-flag
4752 ;; cksum runs locally, if possible.
4753 (zerop (tramp-local-call-process "cksum" tmpfile t))
4754 ;; cksum runs remotely.
4756 (tramp-send-command-and-check
4759 "cksum <%s" (tramp-shell-quote-argument localname))))
4760 ;; ... they are different.
4764 (with-current-buffer (tramp-get-buffer v)
4768 (concat "Couldn't write region to `%s',"
4769 " decode using `%s' failed")
4772 v 5 "Decoding region into remote file %s...done" filename)
4773 (tramp-flush-file-property v localname))
4776 (delete-file tmpfile)))
4778 ;; That's not expected.
4782 (concat "Method `%s' should specify both encoding and "
4783 "decoding command or an rcp program")
4786 ;; Make `last-coding-system-used' have the right value.
4787 (when coding-system-used
4788 (set 'last-coding-system-used coding-system-used))))
4790 ;; We must protect `last-coding-system-used', now we have set it
4791 ;; to its correct value.
4792 (let (last-coding-system-used)
4793 ;; Set file modification time.
4794 (when (or (eq visit t) (stringp visit))
4795 (set-visited-file-modtime
4796 ;; We must pass modtime explicitely, because filename can
4797 ;; be different from (buffer-file-name), f.e. if
4798 ;; `file-precious-flag' is set.
4799 (nth 5 (file-attributes filename))))
4801 ;; Set the ownership.
4802 (tramp-set-file-uid-gid filename uid gid)
4803 (when (or (eq visit t) (null visit) (stringp visit))
4804 (tramp-message v 0 "Wrote %s" filename))
4805 (run-hooks 'tramp-handle-write-region-hook)))))
4807 (defvar tramp-vc-registered-file-names nil
4808 "List used to collect file names, which are checked during `vc-registered'.")
4810 ;; VC backends check for the existence of various different special
4811 ;; files. This is very time consuming, because every single check
4812 ;; requires a remote command (the file cache must be invalidated).
4813 ;; Therefore, we apply a kind of optimization. We install the file
4814 ;; name handler `tramp-vc-file-name-handler', which does nothing but
4815 ;; remembers all file names for which `file-exists-p' or
4816 ;; `file-readable-p' has been applied. A first run of `vc-registered'
4817 ;; is performed. Afterwards, a script is applied for all collected
4818 ;; file names, using just one remote command. The result of this
4819 ;; script is used to fill the file cache with actual values. Now we
4820 ;; can reset the file name handlers, and we make a second run of
4821 ;; `vc-registered', which returns the expected result without sending
4822 ;; any other remote command.
4823 (defun tramp-handle-vc-registered (file)
4824 "Like `vc-registered' for Tramp files."
4825 (with-parsed-tramp-file-name file nil
4827 ;; There could be new files, created by the vc backend. We cannot
4828 ;; reuse the old cache entries, therefore.
4829 (let (tramp-vc-registered-file-names
4830 (tramp-cache-inhibit-cache (current-time))
4831 (file-name-handler-alist
4832 `((,tramp-file-name-regexp . tramp-vc-file-name-handler))))
4834 ;; Here we collect only file names, which need an operation.
4835 (tramp-run-real-handler 'vc-registered (list file))
4836 (tramp-message v 10 "\n%s" tramp-vc-registered-file-names)
4838 ;; Send just one command, in order to fill the cache.
4839 (when tramp-vc-registered-file-names
4840 (tramp-maybe-send-script
4842 (format tramp-vc-registered-read-file-names
4843 (tramp-get-file-exists-command v)
4844 (format "%s -r" (tramp-get-test-command v)))
4845 "tramp_vc_registered_read_file_names")
4849 (tramp-send-command-and-read
4852 "tramp_vc_registered_read_file_names %s"
4853 (mapconcat 'tramp-shell-quote-argument
4854 tramp-vc-registered-file-names
4857 (tramp-set-file-property v (car elt) (cadr elt) (cadr (cdr elt))))))
4859 ;; Second run. Now all `file-exists-p' or `file-readable-p' calls
4860 ;; shall be answered from the file cache.
4861 ;; We unset `process-file-side-effects' in order to keep the cache
4862 ;; when `process-file' calls appear.
4863 (let (process-file-side-effects)
4864 (tramp-run-real-handler 'vc-registered (list file)))))
4867 (progn (defun tramp-run-real-handler (operation args)
4868 "Invoke normal file name handler for OPERATION.
4869 First arg specifies the OPERATION, second arg is a list of arguments to
4870 pass to the OPERATION."
4871 (let* ((inhibit-file-name-handlers
4872 `(tramp-file-name-handler
4873 tramp-vc-file-name-handler
4874 tramp-completion-file-name-handler
4875 cygwin-mount-name-hook-function
4876 cygwin-mount-map-drive-hook-function
4878 ,(and (eq inhibit-file-name-operation operation)
4879 inhibit-file-name-handlers)))
4880 (inhibit-file-name-operation operation))
4881 (apply operation args))))
4884 (progn (defun tramp-completion-run-real-handler (operation args)
4885 "Invoke `tramp-file-name-handler' for OPERATION.
4886 First arg specifies the OPERATION, second arg is a list of arguments to
4887 pass to the OPERATION."
4888 (let* ((inhibit-file-name-handlers
4889 `(tramp-completion-file-name-handler
4890 cygwin-mount-name-hook-function
4891 cygwin-mount-map-drive-hook-function
4893 ,(and (eq inhibit-file-name-operation operation)
4894 inhibit-file-name-handlers)))
4895 (inhibit-file-name-operation operation))
4896 (apply operation args))))
4898 ;; We handle here all file primitives. Most of them have the file
4899 ;; name as first parameter; nevertheless we check for them explicitly
4900 ;; in order to be signaled if a new primitive appears. This
4901 ;; scenario is needed because there isn't a way to decide by
4902 ;; syntactical means whether a foreign method must be called. It would
4903 ;; ease the life if `file-name-handler-alist' would support a decision
4904 ;; function as well but regexp only.
4905 (defun tramp-file-name-for-operation (operation &rest args)
4906 "Return file name related to OPERATION file primitive.
4907 ARGS are the arguments OPERATION has been called with."
4909 ; FILE resp DIRECTORY
4911 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
4912 'delete-file 'diff-latest-backup-file 'directory-file-name
4913 'directory-files 'directory-files-and-attributes
4914 'dired-compress-file 'dired-uncache
4915 'file-accessible-directory-p 'file-attributes
4916 'file-directory-p 'file-executable-p 'file-exists-p
4917 'file-local-copy 'file-remote-p 'file-modes
4918 'file-name-as-directory 'file-name-directory
4919 'file-name-nondirectory 'file-name-sans-versions
4920 'file-ownership-preserved-p 'file-readable-p
4921 'file-regular-p 'file-symlink-p 'file-truename
4922 'file-writable-p 'find-backup-file-name 'find-file-noselect
4923 'get-file-buffer 'insert-directory 'insert-file-contents
4924 'load 'make-directory 'make-directory-internal
4925 'set-file-modes 'substitute-in-file-name
4926 'unhandled-file-name-directory 'vc-registered
4930 'abbreviate-file-name 'create-file-buffer
4931 'dired-file-modtime 'dired-make-compressed-filename
4932 'dired-recursive-delete-directory 'dired-set-file-modtime
4933 'dired-shell-unhandle-file-name 'dired-uucode-file
4934 'insert-file-contents-literally 'make-temp-name 'recover-file
4935 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
4936 (if (file-name-absolute-p (nth 0 args))
4938 (expand-file-name (nth 0 args))))
4939 ; FILE DIRECTORY resp FILE1 FILE2
4941 (list 'add-name-to-file 'copy-file 'expand-file-name
4942 'file-name-all-completions 'file-name-completion
4943 'file-newer-than-file-p 'make-symbolic-link 'rename-file
4947 'dired-make-relative-symlink
4948 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
4951 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
4952 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
4953 (t (buffer-file-name (current-buffer))))))
4955 ((eq operation 'write-region)
4959 (list 'set-visited-file-modtime 'verify-visited-file-modtime
4960 ; since Emacs 22 only
4961 'make-auto-save-file-name
4965 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
4968 (list ; not in Emacs 23
4972 ; since Emacs 22 only
4974 ; since Emacs 23 only
4977 'dired-print-file 'dired-shell-call-process
4979 'executable-find 'start-process 'call-process))
4981 ; unknown file primitive
4982 (t (error "unknown file I/O primitive: %s" operation))))
4984 (defun tramp-find-foreign-file-name-handler (filename)
4985 "Return foreign file name handler if exists."
4986 (when (and (stringp filename) (tramp-tramp-file-p filename))
4987 (let ((v (tramp-dissect-file-name filename t))
4988 (handler tramp-foreign-file-name-handler-alist)
4990 ;; When we are not fully sure that filename completion is safe,
4991 ;; we should not return a handler.
4992 (when (or (tramp-file-name-method v) (tramp-file-name-user v)
4993 (and (tramp-file-name-host v)
4994 (not (member (tramp-file-name-host v)
4995 (mapcar 'car tramp-methods))))
4996 (not (tramp-completion-mode-p)))
4998 (setq elt (car handler)
4999 handler (cdr handler))
5000 (when (funcall (car elt) filename)
5007 (defun tramp-file-name-handler (operation &rest args)
5008 "Invoke Tramp file name handler.
5009 Falls back to normal file name handler if no Tramp file name handler exists."
5013 (tramp-replace-environment-variables
5014 (apply 'tramp-file-name-for-operation operation args)))
5015 (completion (tramp-completion-mode-p))
5016 (foreign (tramp-find-foreign-file-name-handler filename)))
5017 (with-parsed-tramp-file-name filename nil
5019 ;; When we are in completion mode, some operations
5020 ;; shouldn't be handled by backend.
5021 ((and completion (zerop (length localname))
5022 (memq operation '(file-exists-p file-directory-p)))
5024 ((and completion (zerop (length localname))
5025 (memq operation '(file-name-as-directory)))
5027 ;; Call the backend function.
5028 (foreign (apply foreign operation args))
5029 ;; Nothing to do for us.
5030 (t (tramp-run-real-handler operation args))))))
5031 ;; When `tramp-mode' is not enabled, we don't do anything.
5032 (tramp-run-real-handler operation args)))
5034 ;; In Emacs, there is some concurrency due to timers. If a timer
5035 ;; interrupts Tramp and wishes to use the same connection buffer as
5036 ;; the "main" Emacs, then garbage might occur in the connection
5037 ;; buffer. Therefore, we need to make sure that a timer does not use
5038 ;; the same connection buffer as the "main" Emacs. We implement a
5039 ;; cheap global lock, instead of locking each connection buffer
5040 ;; separately. The global lock is based on two variables,
5041 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
5042 ;; (with setq) to indicate a lock. But Tramp also calls itself during
5043 ;; processing of a single file operation, so we need to allow
5044 ;; recursive calls. That's where the `tramp-locker' variable comes in
5045 ;; -- it is let-bound to t during the execution of the current
5046 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
5047 ;; then we should just proceed because we have been called
5048 ;; recursively. But if `tramp-locker' is nil, then we are a timer
5049 ;; interrupting the "main" Emacs, and then we signal an error.
5051 (defvar tramp-locked nil
5052 "If non-nil, then Tramp is currently busy.
5053 Together with `tramp-locker', this implements a locking mechanism
5054 preventing reentrant calls of Tramp.")
5056 (defvar tramp-locker nil
5057 "If non-nil, then a caller has locked Tramp.
5058 Together with `tramp-locked', this implements a locking mechanism
5059 preventing reentrant calls of Tramp.")
5061 (defun tramp-sh-file-name-handler (operation &rest args)
5062 "Invoke remote-shell Tramp file name handler.
5063 Fall back to normal file name handler if no Tramp handler exists."
5064 (when (and tramp-locked (not tramp-locker))
5065 (setq tramp-locked nil)
5066 (signal 'file-error (list "Forbidden reentrant call of Tramp")))
5067 (let ((tl tramp-locked))
5070 (setq tramp-locked t)
5071 (let ((tramp-locker t))
5073 (let ((fn (assoc operation tramp-file-name-handler-alist)))
5075 (apply (cdr fn) args)
5076 (tramp-run-real-handler operation args))))))
5077 (setq tramp-locked tl))))
5079 (defun tramp-vc-file-name-handler (operation &rest args)
5080 "Invoke special file name handler, which collects files to be handled."
5083 (tramp-replace-environment-variables
5084 (apply 'tramp-file-name-for-operation operation args)))
5085 (fn (assoc operation tramp-file-name-handler-alist)))
5086 (with-parsed-tramp-file-name filename nil
5088 ;; That's what we want: file names, for which checks are
5089 ;; applied. We assume, that VC uses only `file-exists-p' and
5090 ;; `file-readable-p' checks; otherwise we must extend the
5091 ;; list. We do not perform any action, but return nil, in
5092 ;; order to keep `vc-registered' running.
5093 ((and fn (memq operation '(file-exists-p file-readable-p)))
5094 (add-to-list 'tramp-vc-registered-file-names localname 'append)
5096 ;; Tramp file name handlers like `expand-file-name'. They
5099 (save-match-data (apply (cdr fn) args)))
5100 ;; Default file name handlers, we don't care.
5101 (t (tramp-run-real-handler operation args)))))))
5104 (progn (defun tramp-completion-file-name-handler (operation &rest args)
5105 "Invoke Tramp file name completion handler.
5106 Falls back to normal file name handler if no Tramp file name handler exists."
5107 ;; We bind `directory-sep-char' here for XEmacs on Windows, which
5108 ;; would otherwise use backslash.
5109 (let ((directory-sep-char ?/)
5110 (fn (assoc operation tramp-completion-file-name-handler-alist)))
5112 ;; When `tramp-mode' is not enabled, we don't do anything.
5114 ;; For other syntaxes than `sep', the regexp matches many common
5115 ;; situations where the user doesn't actually want to use Tramp.
5116 ;; So to avoid autoloading Tramp after typing just "/s", we
5117 ;; disable this part of the completion, unless the user implicitly
5118 ;; indicated his interest in using a fancier completion system.
5119 (or (eq tramp-syntax 'sep)
5120 (featurep 'tramp) ; If it's loaded, we may as well use it.
5121 (and (boundp 'partial-completion-mode) partial-completion-mode)
5122 ;; FIXME: These may have been loaded even if the user never
5123 ;; intended to use them.
5125 (featurep 'icicles)))
5126 (save-match-data (apply (cdr fn) args))
5127 (tramp-completion-run-real-handler operation args)))))
5130 (progn (defun tramp-register-file-name-handlers ()
5131 "Add Tramp file name handlers to `file-name-handler-alist'."
5132 ;; Remove autoloaded handlers from file name handler alist. Useful,
5133 ;; if `tramp-syntax' has been changed.
5134 (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist)))
5135 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
5137 'tramp-completion-file-name-handler file-name-handler-alist)))
5138 (setq file-name-handler-alist (delq a1 file-name-handler-alist)))
5139 ;; Add the handlers.
5140 (add-to-list 'file-name-handler-alist
5141 (cons tramp-file-name-regexp 'tramp-file-name-handler))
5142 (add-to-list 'file-name-handler-alist
5143 (cons tramp-completion-file-name-regexp
5144 'tramp-completion-file-name-handler))
5145 (put 'tramp-completion-file-name-handler 'safe-magic t)
5146 ;; If jka-compr or epa-file are already loaded, move them to the
5147 ;; front of `file-name-handler-alist'.
5148 (dolist (fnh '(epa-file-handler jka-compr-handler))
5149 (let ((entry (rassoc fnh file-name-handler-alist)))
5151 (setq file-name-handler-alist
5152 (cons entry (delete entry file-name-handler-alist))))))))
5154 ;; `tramp-file-name-handler' must be registered before evaluation of
5155 ;; site-start and init files, because there might exist remote files
5156 ;; already, f.e. files kept via recentf-mode.
5157 ;;;###autoload(tramp-register-file-name-handlers)
5158 (tramp-register-file-name-handlers)
5161 (defun tramp-unload-file-name-handlers ()
5162 (setq file-name-handler-alist
5163 (delete (rassoc 'tramp-file-name-handler
5164 file-name-handler-alist)
5165 (delete (rassoc 'tramp-completion-file-name-handler
5166 file-name-handler-alist)
5167 file-name-handler-alist))))
5169 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
5171 ;;; File name handler functions for completion mode:
5173 (defvar tramp-completion-mode nil
5174 "If non-nil, external packages signal that they are in file name completion.
5176 This is necessary, because Tramp uses a heuristic depending on last
5177 input event. This fails when external packages use other characters
5178 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
5179 should never be set globally, the intention is to let-bind it.")
5181 ;; Necessary because `tramp-file-name-regexp-unified' and
5182 ;; `tramp-completion-file-name-regexp-unified' aren't different. If
5183 ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding
5184 ;; to `tramp-file-name-handler'). Otherwise, it takes
5185 ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit
5186 ;; risky, because completing a file might require loading other files,
5187 ;; like "~/.netrc", and for them it shouldn't be decided based on that
5188 ;; variable. On the other hand, those files shouldn't have partial
5189 ;; Tramp file name syntax. Maybe another variable should be introduced
5190 ;; overwriting this check in such cases. Or we change Tramp file name
5191 ;; syntax in order to avoid ambiguities, like in XEmacs ...
5192 (defun tramp-completion-mode-p ()
5193 "Checks whether method / user name / host name completion is active."
5195 ;; Signal from outside.
5196 tramp-completion-mode
5198 (equal last-input-event 'tab)
5199 (and (natnump last-input-event)
5201 ;; ?\t has event-modifier 'control.
5202 (equal last-input-event ?\t)
5203 (and (not (event-modifiers last-input-event))
5204 (or (equal last-input-event ?\?)
5205 (equal last-input-event ?\ )))))
5207 (and (featurep 'xemacs)
5208 ;; `last-input-event' might be nil.
5209 (not (null last-input-event))
5210 ;; `last-input-event' may have no character approximation.
5211 (funcall (symbol-function 'event-to-character) last-input-event)
5213 ;; ?\t has event-modifier 'control.
5215 (funcall (symbol-function 'event-to-character)
5216 last-input-event) ?\t)
5217 (and (not (event-modifiers last-input-event))
5219 (funcall (symbol-function 'event-to-character)
5220 last-input-event) ?\?)
5222 (funcall (symbol-function 'event-to-character)
5223 last-input-event) ?\ )))))))
5225 ;; Method, host name and user name completion.
5226 ;; `tramp-completion-dissect-file-name' returns a list of
5227 ;; tramp-file-name structures. For all of them we return possible completions.
5229 (defun tramp-completion-handle-file-name-all-completions (filename directory)
5230 "Like `file-name-all-completions' for partial Tramp files."
5232 (let* ((fullname (tramp-drop-volume-letter
5233 (expand-file-name filename directory)))
5234 ;; Possible completion structures.
5235 (v (tramp-completion-dissect-file-name fullname))
5239 (let* ((car (car v))
5240 (method (tramp-file-name-method car))
5241 (user (tramp-file-name-user car))
5242 (host (tramp-file-name-host car))
5243 (localname (tramp-file-name-localname car))
5244 (m (tramp-find-method method user host))
5245 (tramp-current-user user) ; see `tramp-parse-passwd'
5248 (unless localname ;; Nothing to complete.
5252 ;; Method dependent user / host combinations.
5256 (setq all-user-hosts
5257 (append all-user-hosts
5258 (funcall (nth 0 x) (nth 1 x)))))
5259 (tramp-get-completion-function m))
5265 (tramp-get-completion-user-host
5266 method user host (nth 0 x) (nth 1 x)))
5267 (delq nil all-user-hosts)))))
5269 ;; Possible methods.
5271 (append result (tramp-get-completion-methods m)))))
5275 ;; Unify list, remove nil elements.
5277 (let ((car (car result)))
5281 (substring car (length (tramp-drop-volume-letter directory)))))
5282 (setq result (cdr result))))
5284 ;; Complete local parts.
5288 (tramp-completion-run-real-handler
5289 'file-name-all-completions (list filename directory))
5292 ;; Method, host name and user name completion for a file.
5294 (defun tramp-completion-handle-file-name-completion
5295 (filename directory &optional predicate)
5296 "Like `file-name-completion' for Tramp files."
5299 (mapcar 'list (file-name-all-completions filename directory))
5301 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
5303 ;; I misuse a little bit the tramp-file-name structure in order to handle
5304 ;; completion possibilities for partial methods / user names / host names.
5305 ;; Return value is a list of tramp-file-name structures according to possible
5306 ;; completions. If "localname" is non-nil it means there
5307 ;; shouldn't be a completion anymore.
5309 ;; Expected results:
5311 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
5312 ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil]
5313 ;; [nil "x" nil nil]
5314 ;; ["x" nil nil nil]
5316 ;; "/x:" "/x:y" "/x:y:"
5317 ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""]
5319 ;; ["x" nil "" nil] ["x" nil "y" nil]
5320 ;; ["x" "" nil nil] ["x" "y" nil nil]
5322 ;; "/x:y@" "/x:y@z" "/x:y@z:"
5323 ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""]
5324 ;; "/[x/y@" "/[x/y@z"
5325 ;; ["x" nil "y" nil] ["x" "y" "z" nil]
5326 (defun tramp-completion-dissect-file-name (name)
5327 "Returns a list of `tramp-file-name' structures.
5328 They are collected by `tramp-completion-dissect-file-name1'."
5332 (tramp-completion-ipv6-regexp
5335 (if (zerop (length tramp-postfix-ipv6-format))
5336 tramp-postfix-host-format
5337 tramp-postfix-ipv6-format)))
5338 ;; "/method" "/[method"
5339 (tramp-completion-file-name-structure1
5340 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
5343 (tramp-completion-file-name-structure2
5344 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
5347 (tramp-completion-file-name-structure3
5348 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
5350 ;; "/[ipv6" "/[ipv6"
5351 (tramp-completion-file-name-structure4
5352 (list (concat tramp-prefix-regexp
5353 tramp-prefix-ipv6-regexp
5354 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5356 ;; "/user@host" "/[user@host"
5357 (tramp-completion-file-name-structure5
5358 (list (concat tramp-prefix-regexp
5359 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5360 "\\(" tramp-host-regexp x-nil "\\)$")
5362 ;; "/user@[ipv6" "/[user@ipv6"
5363 (tramp-completion-file-name-structure6
5364 (list (concat tramp-prefix-regexp
5365 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5366 tramp-prefix-ipv6-regexp
5367 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5369 ;; "/method:user" "/[method/user" "/method://user"
5370 (tramp-completion-file-name-structure7
5371 (list (concat tramp-prefix-regexp
5372 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5373 "\\(" tramp-user-regexp x-nil "\\)$")
5375 ;; "/method:host" "/[method/host" "/method://host"
5376 (tramp-completion-file-name-structure8
5377 (list (concat tramp-prefix-regexp
5378 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5379 "\\(" tramp-host-regexp x-nil "\\)$")
5381 ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6"
5382 (tramp-completion-file-name-structure9
5383 (list (concat tramp-prefix-regexp
5384 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5385 tramp-prefix-ipv6-regexp
5386 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5388 ;; "/method:user@host" "/[method/user@host" "/method://user@host"
5389 (tramp-completion-file-name-structure10
5390 (list (concat tramp-prefix-regexp
5391 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5392 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5393 "\\(" tramp-host-regexp x-nil "\\)$")
5395 ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6"
5396 (tramp-completion-file-name-structure11
5397 (list (concat tramp-prefix-regexp
5398 "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp
5399 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
5400 tramp-prefix-ipv6-regexp
5401 "\\(" tramp-completion-ipv6-regexp x-nil "\\)$")
5403 ;; "/method: "/method:/"
5404 (tramp-completion-file-name-structure12
5406 (if (equal tramp-syntax 'url)
5407 (concat tramp-prefix-regexp
5408 "\\(" tramp-method-regexp "\\)"
5409 "\\(" (substring tramp-postfix-method-regexp 0 1)
5410 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
5412 ;; Should not match if not URL syntax.
5413 (concat tramp-prefix-regexp "/$"))
5415 ;; "/method: "/method:/"
5416 (tramp-completion-file-name-structure13
5418 (if (equal tramp-syntax 'url)
5419 (concat tramp-prefix-regexp
5420 "\\(" tramp-method-regexp "\\)"
5421 "\\(" (substring tramp-postfix-method-regexp 0 1)
5422 "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)"
5424 ;; Should not match if not URL syntax.
5425 (concat tramp-prefix-regexp "/$"))
5428 (mapc (lambda (regexp)
5429 (add-to-list 'result
5430 (tramp-completion-dissect-file-name1 regexp name)))
5432 tramp-completion-file-name-structure1
5433 tramp-completion-file-name-structure2
5434 tramp-completion-file-name-structure3
5435 tramp-completion-file-name-structure4
5436 tramp-completion-file-name-structure5
5437 tramp-completion-file-name-structure6
5438 tramp-completion-file-name-structure7
5439 tramp-completion-file-name-structure8
5440 tramp-completion-file-name-structure9
5441 tramp-completion-file-name-structure10
5442 tramp-completion-file-name-structure11
5443 tramp-completion-file-name-structure12
5444 tramp-completion-file-name-structure13
5445 tramp-file-name-structure))
5449 (defun tramp-completion-dissect-file-name1 (structure name)
5450 "Returns a `tramp-file-name' structure matching STRUCTURE.
5451 The structure consists of remote method, remote user,
5452 remote host and localname (filename on remote host)."
5455 (when (string-match (nth 0 structure) name)
5456 (let ((method (and (nth 1 structure)
5457 (match-string (nth 1 structure) name)))
5458 (user (and (nth 2 structure)
5459 (match-string (nth 2 structure) name)))
5460 (host (and (nth 3 structure)
5461 (match-string (nth 3 structure) name)))
5462 (localname (and (nth 4 structure)
5463 (match-string (nth 4 structure) name))))
5464 (vector method user host localname)))))
5466 ;; This function returns all possible method completions, adding the
5467 ;; trailing method delimeter.
5468 (defun tramp-get-completion-methods (partial-method)
5469 "Returns all method completions for PARTIAL-METHOD."
5473 (string-match (concat "^" (regexp-quote partial-method)) method)
5474 (tramp-completion-make-tramp-file-name method nil nil nil)))
5475 (mapcar 'car tramp-methods)))
5477 ;; Compares partial user and host names with possible completions.
5478 (defun tramp-get-completion-user-host (method partial-user partial-host user host)
5479 "Returns the most expanded string for user and host name completion.
5480 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
5483 ((and partial-user partial-host)
5485 (string-match (concat "^" (regexp-quote partial-host)) host)
5486 (string-equal partial-user (or user partial-user)))
5487 (setq user partial-user)
5494 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
5500 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
5506 (unless (zerop (+ (length user) (length host)))
5507 (tramp-completion-make-tramp-file-name method user host nil)))
5509 (defun tramp-parse-rhosts (filename)
5510 "Return a list of (user host) tuples allowed to access.
5511 Either user or host may be nil."
5512 ;; On Windows, there are problems in completion when
5513 ;; `default-directory' is remote.
5514 (let ((default-directory (tramp-compat-temporary-file-directory))
5516 (when (file-readable-p filename)
5518 (insert-file-contents filename)
5519 (goto-char (point-min))
5521 (push (tramp-parse-rhosts-group) res))))
5524 (defun tramp-parse-rhosts-group ()
5525 "Return a (user host) tuple allowed to access.
5526 Either user or host may be nil."
5530 "^\\(" tramp-host-regexp "\\)"
5531 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
5532 (narrow-to-region (point) (tramp-compat-line-end-position))
5533 (when (re-search-forward regexp nil t)
5534 (setq result (append (list (match-string 3) (match-string 1)))))
5539 (defun tramp-parse-shosts (filename)
5540 "Return a list of (user host) tuples allowed to access.
5541 User is always nil."
5542 ;; On Windows, there are problems in completion when
5543 ;; `default-directory' is remote.
5544 (let ((default-directory (tramp-compat-temporary-file-directory))
5546 (when (file-readable-p filename)
5548 (insert-file-contents filename)
5549 (goto-char (point-min))
5551 (push (tramp-parse-shosts-group) res))))
5554 (defun tramp-parse-shosts-group ()
5555 "Return a (user host) tuple allowed to access.
5556 User is always nil."
5558 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
5559 (narrow-to-region (point) (tramp-compat-line-end-position))
5560 (when (re-search-forward regexp nil t)
5561 (setq result (list nil (match-string 1))))
5564 (> (skip-chars-forward ",") 0)
5568 (defun tramp-parse-sconfig (filename)
5569 "Return a list of (user host) tuples allowed to access.
5570 User is always nil."
5571 ;; On Windows, there are problems in completion when
5572 ;; `default-directory' is remote.
5573 (let ((default-directory (tramp-compat-temporary-file-directory))
5575 (when (file-readable-p filename)
5577 (insert-file-contents filename)
5578 (goto-char (point-min))
5580 (push (tramp-parse-sconfig-group) res))))
5583 (defun tramp-parse-sconfig-group ()
5584 "Return a (user host) tuple allowed to access.
5585 User is always nil."
5587 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)")))
5588 (narrow-to-region (point) (tramp-compat-line-end-position))
5589 (when (re-search-forward regexp nil t)
5590 (setq result (list nil (match-string 1))))
5593 (> (skip-chars-forward ",") 0)
5597 (defun tramp-parse-shostkeys (dirname)
5598 "Return a list of (user host) tuples allowed to access.
5599 User is always nil."
5600 ;; On Windows, there are problems in completion when
5601 ;; `default-directory' is remote.
5602 (let* ((default-directory (tramp-compat-temporary-file-directory))
5603 (regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$"))
5604 (files (when (file-directory-p dirname) (directory-files dirname)))
5607 (when (string-match regexp (car files))
5608 (push (list nil (match-string 1 (car files))) result))
5609 (setq files (cdr files)))
5612 (defun tramp-parse-sknownhosts (dirname)
5613 "Return a list of (user host) tuples allowed to access.
5614 User is always nil."
5615 ;; On Windows, there are problems in completion when
5616 ;; `default-directory' is remote.
5617 (let* ((default-directory (tramp-compat-temporary-file-directory))
5618 (regexp (concat "^\\(" tramp-host-regexp
5619 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
5620 (files (when (file-directory-p dirname) (directory-files dirname)))
5623 (when (string-match regexp (car files))
5624 (push (list nil (match-string 1 (car files))) result))
5625 (setq files (cdr files)))
5628 (defun tramp-parse-hosts (filename)
5629 "Return a list of (user host) tuples allowed to access.
5630 User is always nil."
5631 ;; On Windows, there are problems in completion when
5632 ;; `default-directory' is remote.
5633 (let ((default-directory (tramp-compat-temporary-file-directory))
5635 (when (file-readable-p filename)
5637 (insert-file-contents filename)
5638 (goto-char (point-min))
5640 (push (tramp-parse-hosts-group) res))))
5643 (defun tramp-parse-hosts-group ()
5644 "Return a (user host) tuple allowed to access.
5645 User is always nil."
5648 (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)")))
5649 (narrow-to-region (point) (tramp-compat-line-end-position))
5650 (when (re-search-forward regexp nil t)
5651 (setq result (list nil (match-string 1))))
5654 (> (skip-chars-forward " \t") 0)
5658 ;; For su-alike methods it would be desirable to return "root@localhost"
5659 ;; as default. Unfortunately, we have no information whether any user name
5660 ;; has been typed already. So we use `tramp-current-user' as indication,
5661 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
5662 (defun tramp-parse-passwd (filename)
5663 "Return a list of (user host) tuples allowed to access.
5664 Host is always \"localhost\"."
5665 ;; On Windows, there are problems in completion when
5666 ;; `default-directory' is remote.
5667 (let ((default-directory (tramp-compat-temporary-file-directory))
5669 (if (zerop (length tramp-current-user))
5671 (when (file-readable-p filename)
5673 (insert-file-contents filename)
5674 (goto-char (point-min))
5676 (push (tramp-parse-passwd-group) res))))
5679 (defun tramp-parse-passwd-group ()
5680 "Return a (user host) tuple allowed to access.
5681 Host is always \"localhost\"."
5683 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
5684 (narrow-to-region (point) (tramp-compat-line-end-position))
5685 (when (re-search-forward regexp nil t)
5686 (setq result (list (match-string 1) "localhost")))
5691 (defun tramp-parse-netrc (filename)
5692 "Return a list of (user host) tuples allowed to access.
5694 ;; On Windows, there are problems in completion when
5695 ;; `default-directory' is remote.
5696 (let ((default-directory (tramp-compat-temporary-file-directory))
5698 (when (file-readable-p filename)
5700 (insert-file-contents filename)
5701 (goto-char (point-min))
5703 (push (tramp-parse-netrc-group) res))))
5706 (defun tramp-parse-netrc-group ()
5707 "Return a (user host) tuple allowed to access.
5712 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
5713 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
5714 (narrow-to-region (point) (tramp-compat-line-end-position))
5715 (when (re-search-forward regexp nil t)
5716 (setq result (list (match-string 3) (match-string 1))))
5721 (defun tramp-parse-putty (registry)
5722 "Return a list of (user host) tuples allowed to access.
5723 User is always nil."
5724 ;; On Windows, there are problems in completion when
5725 ;; `default-directory' is remote.
5726 (let ((default-directory (tramp-compat-temporary-file-directory))
5729 (when (zerop (tramp-local-call-process "reg" nil t nil "query" registry))
5730 (goto-char (point-min))
5732 (push (tramp-parse-putty-group registry) res))))
5735 (defun tramp-parse-putty-group (registry)
5736 "Return a (user host) tuple allowed to access.
5737 User is always nil."
5739 (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)")))
5740 (narrow-to-region (point) (tramp-compat-line-end-position))
5741 (when (re-search-forward regexp nil t)
5742 (setq result (list nil (match-string 1))))
5747 ;;; Internal Functions:
5749 (defun tramp-maybe-send-script (vec script name)
5750 "Define in remote shell function NAME implemented as SCRIPT.
5751 Only send the definition if it has not already been done."
5752 (let* ((p (tramp-get-connection-process vec))
5753 (scripts (tramp-get-connection-property p "scripts" nil)))
5754 (unless (member name scripts)
5755 (tramp-message vec 5 "Sending script `%s'..." name)
5756 ;; The script could contain a call of Perl. This is masked with `%s'.
5757 (tramp-send-command-and-check
5759 (format "%s () {\n%s\n}" name
5760 (format script (tramp-get-remote-perl vec))))
5761 (tramp-set-connection-property p "scripts" (cons name scripts))
5762 (tramp-message vec 5 "Sending script `%s'...done." name))))
5764 (defun tramp-set-auto-save ()
5765 (when (and ;; ange-ftp has its own auto-save mechanism
5766 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
5767 'tramp-sh-file-name-handler)
5769 (auto-save-mode 1)))
5770 (add-hook 'find-file-hooks 'tramp-set-auto-save t)
5771 (add-hook 'tramp-unload-hook
5773 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
5775 (defun tramp-run-test (switch filename)
5776 "Run `test' on the remote system, given a SWITCH and a FILENAME.
5777 Returns the exit code of the `test' program."
5778 (with-parsed-tramp-file-name filename nil
5779 (tramp-send-command-and-check
5783 (tramp-get-test-command v)
5785 (tramp-shell-quote-argument localname)))))
5787 (defun tramp-run-test2 (format-string file1 file2)
5788 "Run `test'-like program on the remote system, given FILE1, FILE2.
5789 FORMAT-STRING contains the program name, switches, and place holders.
5790 Returns the exit code of the `test' program. Barfs if the methods,
5791 hosts, or files, disagree."
5792 (unless (tramp-equal-remote file1 file2)
5793 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1) file1 file2) nil
5796 "tramp-run-test2 only implemented for same method, user, host")))
5797 (with-parsed-tramp-file-name file1 v1
5798 (with-parsed-tramp-file-name file1 v2
5799 (tramp-send-command-and-check
5801 (format format-string
5802 (tramp-shell-quote-argument v1-localname)
5803 (tramp-shell-quote-argument v2-localname))))))
5805 (defun tramp-buffer-name (vec)
5806 "A name for the connection buffer VEC."
5807 ;; We must use `tramp-file-name-real-host', because for gateway
5808 ;; methods the default port will be expanded later on, which would
5810 (let ((method (tramp-file-name-method vec))
5811 (user (tramp-file-name-user vec))
5812 (host (tramp-file-name-real-host vec)))
5813 (if (not (zerop (length user)))
5814 (format "*tramp/%s %s@%s*" method user host)
5815 (format "*tramp/%s %s*" method host))))
5817 (defun tramp-get-buffer (vec)
5818 "Get the connection buffer to be used for VEC."
5819 (or (get-buffer (tramp-buffer-name vec))
5820 (with-current-buffer (get-buffer-create (tramp-buffer-name vec))
5821 (setq buffer-undo-list t)
5822 (setq default-directory
5823 (tramp-make-tramp-file-name
5824 (tramp-file-name-method vec)
5825 (tramp-file-name-user vec)
5826 (tramp-file-name-host vec)
5830 (defun tramp-get-connection-buffer (vec)
5831 "Get the connection buffer to be used for VEC.
5832 In case a second asynchronous communication has been started, it is different
5833 from `tramp-get-buffer'."
5834 (or (tramp-get-connection-property vec "process-buffer" nil)
5835 (tramp-get-buffer vec)))
5837 (defun tramp-get-connection-process (vec)
5838 "Get the connection process to be used for VEC.
5839 In case a second asynchronous communication has been started, it is different
5840 from the default one."
5842 (or (tramp-get-connection-property vec "process-name" nil)
5843 (tramp-buffer-name vec))))
5845 (defun tramp-debug-buffer-name (vec)
5846 "A name for the debug buffer for VEC."
5847 ;; We must use `tramp-file-name-real-host', because for gateway
5848 ;; methods the default port will be expanded later on, which would
5850 (let ((method (tramp-file-name-method vec))
5851 (user (tramp-file-name-user vec))
5852 (host (tramp-file-name-real-host vec)))
5853 (if (not (zerop (length user)))
5854 (format "*debug tramp/%s %s@%s*" method user host)
5855 (format "*debug tramp/%s %s*" method host))))
5857 (defun tramp-get-debug-buffer (vec)
5858 "Get the debug buffer for VEC."
5859 (with-current-buffer
5860 (get-buffer-create (tramp-debug-buffer-name vec))
5862 (setq buffer-undo-list t)
5863 ;; Activate outline-mode. This runs `text-mode-hook' and
5864 ;; `outline-mode-hook'. We must prevent that local processes
5865 ;; die. Yes: I've seen `flyspell-mode', which starts "ispell"
5867 (let ((default-directory (tramp-compat-temporary-file-directory)))
5869 (set (make-local-variable 'outline-regexp)
5870 "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #")
5871 ; (set (make-local-variable 'outline-regexp)
5872 ; "[a-z.-]+:[0-9]+: [a-z0-9-]+ (\\([0-9]+\\)) #")
5873 (set (make-local-variable 'outline-level) 'tramp-outline-level))
5876 (defun tramp-outline-level ()
5877 "Return the depth to which a statement is nested in the outline.
5878 Point must be at the beginning of a header line.
5880 The outline level is equal to the verbosity of the Tramp message."
5881 (1+ (string-to-number (match-string 1))))
5883 (defun tramp-find-executable
5884 (vec progname dirlist &optional ignore-tilde ignore-path)
5885 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
5886 First arg VEC specifies the connection, PROGNAME is the program
5887 to search for, and DIRLIST gives the list of directories to
5888 search. If IGNORE-TILDE is non-nil, directory names starting
5889 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
5892 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
5894 This function expects to be in the right *tramp* buffer."
5895 (with-current-buffer (tramp-get-buffer vec)
5897 ;; Check whether the executable is in $PATH. "which(1)" does not
5898 ;; report always a correct error code; therefore we check the
5899 ;; number of words it returns.
5901 (tramp-send-command vec (format "which \\%s | wc -w" progname))
5902 (goto-char (point-min))
5903 (if (looking-at "^1$")
5904 (setq result (concat "\\" progname))))
5907 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
5908 ;; `remove' is in CL, and we want to avoid CL dependencies.
5911 (setq d (car dirlist))
5912 (setq dirlist (cdr dirlist))
5913 (unless (char-equal ?~ (aref d 0))
5914 (setq newdl (cons d newdl))))
5915 (setq dirlist (nreverse newdl))))
5918 (format (concat "while read d; "
5919 "do if test -x $d/%s -a -f $d/%s; "
5920 "then echo tramp_executable $d/%s; "
5921 "break; fi; done <<'EOF'\n"
5923 progname progname progname (mapconcat 'identity dirlist "\n")))
5924 (goto-char (point-max))
5925 (when (search-backward "tramp_executable " nil t)
5926 (skip-chars-forward "^ ")
5927 (skip-chars-forward " ")
5928 (setq result (buffer-substring
5929 (point) (tramp-compat-line-end-position)))))
5932 (defun tramp-set-remote-path (vec)
5933 "Sets the remote environment PATH to existing directories.
5934 I.e., for each directory in `tramp-remote-path', it is tested
5935 whether it exists and if so, it is added to the environment
5937 (tramp-message vec 5 (format "Setting $PATH environment variable"))
5939 vec (format "PATH=%s; export PATH"
5940 (mapconcat 'identity (tramp-get-remote-path vec) ":"))))
5942 ;; ------------------------------------------------------------
5943 ;; -- Communication with external shell --
5944 ;; ------------------------------------------------------------
5946 (defun tramp-find-file-exists-command (vec)
5947 "Find a command on the remote host for checking if a file exists.
5948 Here, we are looking for a command which has zero exit status if the
5949 file exists and nonzero exit status otherwise."
5950 (let ((existing "/")
5952 (tramp-shell-quote-argument "/ this file does not exist "))
5954 ;; The algorithm is as follows: we try a list of several commands.
5955 ;; For each command, we first run `$cmd /' -- this should return
5956 ;; true, as the root directory always exists. And then we run
5957 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
5958 ;; does not exist. This should return false. We use the first
5959 ;; command we find that seems to work.
5960 ;; The list of commands to try is as follows:
5961 ;; `ls -d' This works on most systems, but NetBSD 1.4
5962 ;; has a bug: `ls' always returns zero exit
5963 ;; status, even for files which don't exist.
5964 ;; `test -e' Some Bourne shells have a `test' builtin
5965 ;; which does not know the `-e' option.
5966 ;; `/bin/test -e' For those, the `test' binary on disk normally
5967 ;; provides the option. Alas, the binary
5968 ;; is sometimes `/bin/test' and sometimes it's
5970 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
5972 (and (setq result (format "%s -e" (tramp-get-test-command vec)))
5973 (zerop (tramp-send-command-and-check
5974 vec (format "%s %s" result existing)))
5975 (not (zerop (tramp-send-command-and-check
5976 vec (format "%s %s" result nonexisting)))))
5977 (and (setq result "/bin/test -e")
5978 (zerop (tramp-send-command-and-check
5979 vec (format "%s %s" result existing)))
5980 (not (zerop (tramp-send-command-and-check
5981 vec (format "%s %s" result nonexisting)))))
5982 (and (setq result "/usr/bin/test -e")
5983 (zerop (tramp-send-command-and-check
5984 vec (format "%s %s" result existing)))
5985 (not (zerop (tramp-send-command-and-check
5986 vec (format "%s %s" result nonexisting)))))
5987 (and (setq result (format "%s -d" (tramp-get-ls-command vec)))
5988 (zerop (tramp-send-command-and-check
5989 vec (format "%s %s" result existing)))
5990 (not (zerop (tramp-send-command-and-check
5991 vec (format "%s %s" result nonexisting))))))
5993 vec 'file-error "Couldn't find command to check if file exists"))
5996 ;; CCC test ksh or bash found for tilde expansion?
5997 (defun tramp-find-shell (vec)
5998 "Opens a shell on the remote host which groks tilde expansion."
5999 (unless (tramp-get-connection-property vec "remote-shell" nil)
6001 (with-current-buffer (tramp-get-buffer vec)
6002 (tramp-send-command vec "echo ~root" t)
6004 ((string-match "^~root$" (buffer-string))
6006 (or (tramp-find-executable
6007 vec "bash" (tramp-get-remote-path vec) t)
6008 (tramp-find-executable
6009 vec "ksh" (tramp-get-remote-path vec) t)))
6013 "Couldn't find a shell which groks tilde expansion"))
6014 ;; Find arguments for this shell.
6015 (let ((alist tramp-sh-extra-args)
6017 (while (and alist (null extra-args))
6018 (setq item (pop alist))
6019 (when (string-match (car item) shell)
6020 (setq extra-args (cdr item))))
6021 (when extra-args (setq shell (concat shell " " extra-args))))
6023 vec 5 "Starting remote shell `%s' for tilde expansion..." shell)
6024 (let ((tramp-end-of-output "$ "))
6027 (format "PROMPT_COMMAND='' PS1=%s PS2='' PS3='' exec %s"
6028 (shell-quote-argument tramp-end-of-output) shell)
6031 (tramp-message vec 5 "Setting remote shell prompt...")
6033 vec (format "PS1=%s" (shell-quote-argument tramp-end-of-output)) t)
6034 (tramp-send-command vec "PS2=''" t)
6035 (tramp-send-command vec "PS3=''" t)
6036 (tramp-send-command vec "PROMPT_COMMAND=''" t)
6037 (tramp-message vec 5 "Setting remote shell prompt...done"))
6040 vec 5 "Remote `%s' groks tilde expansion, good"
6041 (tramp-get-method-parameter
6042 (tramp-file-name-method vec) 'tramp-remote-sh))
6043 (tramp-set-connection-property
6045 (tramp-get-method-parameter
6046 (tramp-file-name-method vec) 'tramp-remote-sh))))))))
6048 ;; ------------------------------------------------------------
6049 ;; -- Functions for establishing connection --
6050 ;; ------------------------------------------------------------
6052 ;; The following functions are actions to be taken when seeing certain
6053 ;; prompts from the remote host. See the variable
6054 ;; `tramp-actions-before-shell' for usage of these functions.
6056 (defun tramp-action-login (proc vec)
6057 "Send the login name."
6058 (when (not (stringp tramp-current-user))
6059 (save-window-excursion
6060 (let ((enable-recursive-minibuffers t))
6061 (pop-to-buffer (tramp-get-connection-buffer vec))
6062 (setq tramp-current-user (read-string (match-string 0))))))
6063 (tramp-message vec 3 "Sending login name `%s'" tramp-current-user)
6064 (with-current-buffer (tramp-get-connection-buffer vec)
6065 (tramp-message vec 6 "\n%s" (buffer-string)))
6066 (tramp-send-string vec tramp-current-user))
6068 (defun tramp-action-password (proc vec)
6069 "Query the user for a password."
6070 (with-current-buffer (process-buffer proc)
6071 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
6072 (tramp-message vec 3 "Sending %s" (match-string 1)))
6073 (tramp-enter-password proc))
6075 (defun tramp-action-succeed (proc vec)
6076 "Signal success in finding shell prompt."
6077 (throw 'tramp-action 'ok))
6079 (defun tramp-action-permission-denied (proc vec)
6080 "Signal permission denied."
6082 (throw 'tramp-action 'permission-denied))
6084 (defun tramp-action-yesno (proc vec)
6085 "Ask the user for confirmation using `yes-or-no-p'.
6086 Send \"yes\" to remote process on confirmation, abort otherwise.
6087 See also `tramp-action-yn'."
6088 (save-window-excursion
6089 (let ((enable-recursive-minibuffers t))
6090 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
6091 (unless (yes-or-no-p (match-string 0))
6093 (throw 'tramp-action 'permission-denied))
6094 (with-current-buffer (tramp-get-connection-buffer vec)
6095 (tramp-message vec 6 "\n%s" (buffer-string)))
6096 (tramp-send-string vec "yes"))))
6098 (defun tramp-action-yn (proc vec)
6099 "Ask the user for confirmation using `y-or-n-p'.
6100 Send \"y\" to remote process on confirmation, abort otherwise.
6101 See also `tramp-action-yesno'."
6102 (save-window-excursion
6103 (let ((enable-recursive-minibuffers t))
6104 (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec)))
6105 (unless (y-or-n-p (match-string 0))
6107 (throw 'tramp-action 'permission-denied))
6108 (with-current-buffer (tramp-get-connection-buffer vec)
6109 (tramp-message vec 6 "\n%s" (buffer-string)))
6110 (tramp-send-string vec "y"))))
6112 (defun tramp-action-terminal (proc vec)
6113 "Tell the remote host which terminal type to use.
6114 The terminal type can be configured with `tramp-terminal-type'."
6115 (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type)
6116 (with-current-buffer (tramp-get-connection-buffer vec)
6117 (tramp-message vec 6 "\n%s" (buffer-string)))
6118 (tramp-send-string vec tramp-terminal-type))
6120 (defun tramp-action-process-alive (proc vec)
6121 "Check whether a process has finished."
6122 (unless (memq (process-status proc) '(run open))
6123 (throw 'tramp-action 'process-died)))
6125 (defun tramp-action-out-of-band (proc vec)
6126 "Check whether an out-of-band copy has finished."
6127 (cond ((and (memq (process-status proc) '(stop exit))
6128 (zerop (process-exit-status proc)))
6129 (tramp-message vec 3 "Process has finished.")
6130 (throw 'tramp-action 'ok))
6131 ((or (and (memq (process-status proc) '(stop exit))
6132 (not (zerop (process-exit-status proc))))
6133 (memq (process-status proc) '(signal)))
6134 ;; `scp' could have copied correctly, but set modes could have failed.
6135 ;; This can be ignored.
6136 (with-current-buffer (process-buffer proc)
6137 (goto-char (point-min))
6138 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
6140 (tramp-message vec 5 "'set mode' error ignored.")
6141 (tramp-message vec 3 "Process has finished.")
6142 (throw 'tramp-action 'ok))
6143 (tramp-message vec 3 "Process has died.")
6144 (throw 'tramp-action 'process-died))))
6147 ;; Functions for processing the actions.
6149 (defun tramp-process-one-action (proc vec actions)
6150 "Wait for output from the shell and perform one action."
6151 (let (found todo item pattern action)
6153 ;; Reread output once all actions have been performed.
6154 ;; Obviously, the output was not complete.
6155 (tramp-accept-process-output proc 1)
6158 (setq item (pop todo))
6159 (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item))))
6160 (setq action (nth 1 item))
6162 vec 5 "Looking for regexp \"%s\" from remote shell" pattern)
6163 (when (tramp-check-for-regexp proc pattern)
6164 (tramp-message vec 5 "Call `%s'" (symbol-name action))
6165 (setq found (funcall action proc vec)))))
6168 (defun tramp-process-actions (proc vec actions &optional timeout)
6169 "Perform actions until success or TIMEOUT."
6170 ;; Enable auth-source and password-cache.
6171 (tramp-set-connection-property proc "first-password-request" t)
6174 (tramp-message proc 3 "Waiting for prompts from remote shell")
6176 (catch 'tramp-action
6178 (with-timeout (timeout)
6179 (tramp-process-one-action proc vec actions))
6180 (tramp-process-one-action proc vec actions)))))
6181 (with-current-buffer (tramp-get-connection-buffer vec)
6182 (tramp-message vec 6 "\n%s" (buffer-string)))
6183 (unless (eq exit 'ok)
6184 (tramp-clear-passwd vec)
6185 (tramp-error-with-buffer
6188 ((eq exit 'permission-denied) "Permission denied")
6189 ((eq exit 'process-died) "Process died")
6190 (t "Login failed"))))))
6192 ;; Utility functions.
6194 (defun tramp-accept-process-output (&optional proc timeout timeout-msecs)
6195 "Like `accept-process-output' for Tramp processes.
6196 This is needed in order to hide `last-coding-system-used', which is set
6197 for process communication also."
6198 (with-current-buffer (process-buffer proc)
6199 (tramp-message proc 10 "%s %s" proc (process-status proc))
6200 (let (buffer-read-only last-coding-system-used)
6201 ;; Under Windows XP, accept-process-output doesn't return
6202 ;; sometimes. So we add an additional timeout.
6203 (with-timeout ((or timeout 1))
6204 (accept-process-output proc timeout timeout-msecs)))
6205 (tramp-message proc 10 "\n%s" (buffer-string))))
6207 (defun tramp-check-for-regexp (proc regexp)
6208 "Check whether REGEXP is contained in process buffer of PROC.
6209 Erase echoed commands if exists."
6210 (with-current-buffer (process-buffer proc)
6211 (goto-char (point-min))
6213 ;; Check whether we need to remove echo output.
6214 (when (and (tramp-get-connection-property proc "check-remote-echo" nil)
6215 (re-search-forward tramp-echoed-echo-mark-regexp nil t))
6216 (let ((begin (match-beginning 0)))
6217 (when (re-search-forward tramp-echoed-echo-mark-regexp nil t)
6218 ;; Discard echo from remote output.
6219 (tramp-set-connection-property proc "check-remote-echo" nil)
6220 (tramp-message proc 5 "echo-mark found")
6222 (delete-region begin (point))
6223 (goto-char (point-min)))))
6225 (when (not (tramp-get-connection-property proc "check-remote-echo" nil))
6226 ;; No echo to be handled, now we can look for the regexp.
6227 (goto-char (point-min))
6228 (re-search-forward regexp nil t))))
6230 (defun tramp-wait-for-regexp (proc timeout regexp)
6231 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
6232 Expects the output of PROC to be sent to the current buffer. Returns
6233 the string that matched, or nil. Waits indefinitely if TIMEOUT is
6235 (with-current-buffer (process-buffer proc)
6236 (let ((found (tramp-check-for-regexp proc regexp))
6237 (start-time (current-time)))
6239 ;; Work around a bug in XEmacs 21, where the timeout
6240 ;; expires faster than it should. This degenerates
6241 ;; to polling for buggy XEmacsen, but oh, well.
6242 (while (and (not found)
6243 (< (tramp-time-diff (current-time) start-time)
6245 (with-timeout (timeout)
6247 (tramp-accept-process-output proc 1)
6248 (unless (memq (process-status proc) '(run open))
6249 (tramp-error-with-buffer
6250 nil proc 'file-error "Process has died"))
6251 (setq found (tramp-check-for-regexp proc regexp))))))
6254 (tramp-accept-process-output proc 1)
6255 (unless (memq (process-status proc) '(run open))
6256 (tramp-error-with-buffer
6257 nil proc 'file-error "Process has died"))
6258 (setq found (tramp-check-for-regexp proc regexp)))))
6259 (tramp-message proc 6 "\n%s" (buffer-string))
6263 proc 'file-error "[[Regexp `%s' not found in %d secs]]"
6265 (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp)))
6268 (defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
6269 "Wait for shell prompt and barf if none appears.
6270 Looks at process PROC to see if a shell prompt appears in TIMEOUT
6271 seconds. If not, it produces an error message with the given ERROR-ARGS."
6273 (tramp-wait-for-regexp
6276 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern))
6277 (apply 'tramp-error-with-buffer nil proc 'file-error error-args)))
6279 ;; We don't call `tramp-send-string' in order to hide the password
6280 ;; from the debug buffer, and because end-of-line handling of the
6282 (defun tramp-enter-password (proc)
6283 "Prompt for a password and send it to the remote end."
6284 (process-send-string
6285 proc (concat (tramp-read-passwd proc)
6286 (or (tramp-get-method-parameter
6287 tramp-current-method
6288 'tramp-password-end-of-line)
6289 tramp-default-password-end-of-line))))
6291 (defun tramp-open-connection-setup-interactive-shell (proc vec)
6292 "Set up an interactive shell.
6293 Mainly sets the prompt and the echo correctly. PROC is the shell
6294 process to set up. VEC specifies the connection."
6295 (let ((tramp-end-of-output "$ "))
6296 ;; It is useful to set the prompt in the following command because
6297 ;; some people have a setting for $PS1 which /bin/sh doesn't know
6298 ;; about and thus /bin/sh will display a strange prompt. For
6299 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
6300 ;; display the current working directory but /bin/sh will display
6301 ;; a dollar sign. The following command line sets $PS1 to a sane
6302 ;; value, and works under Bourne-ish shells as well as csh-like
6303 ;; shells. Daniel Pittman reports that the unusual positioning of
6304 ;; the single quotes makes it work under `rc', too. We also unset
6305 ;; the variable $ENV because that is read by some sh
6306 ;; implementations (eg, bash when called as sh) on startup; this
6307 ;; way, we avoid the startup file clobbering $PS1. $PROMP_COMMAND
6308 ;; is another way to set the prompt in /bin/bash, it must be
6309 ;; discarded as well.
6313 "exec env ENV='' PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s"
6314 (shell-quote-argument tramp-end-of-output)
6315 (tramp-get-method-parameter
6316 (tramp-file-name-method vec) 'tramp-remote-sh))
6320 (tramp-message vec 5 "Setting up remote shell environment")
6321 (tramp-send-command vec "stty -inlcr -echo kill '^U' erase '^H'" t)
6322 ;; Check whether the echo has really been disabled. Some
6323 ;; implementations, like busybox of embedded GNU/Linux, don't
6324 ;; support disabling.
6325 (tramp-send-command vec "echo foo" t)
6326 (with-current-buffer (process-buffer proc)
6327 (goto-char (point-min))
6328 (when (looking-at "echo foo")
6329 (tramp-set-connection-property proc "remote-echo" t)
6330 (tramp-message vec 5 "Remote echo still on. Ok.")
6331 ;; Make sure backspaces and their echo are enabled and no line
6332 ;; width magic interferes with them.
6333 (tramp-send-command vec "stty icanon erase ^H cols 32767" t))))
6335 (tramp-message vec 5 "Setting shell prompt")
6337 vec (format "PS1=%s" (shell-quote-argument tramp-end-of-output)) t)
6338 (tramp-send-command vec "PS2=''" t)
6339 (tramp-send-command vec "PS3=''" t)
6340 (tramp-send-command vec "PROMPT_COMMAND=''" t)
6342 ;; Try to set up the coding system correctly.
6343 ;; CCC this can't be the right way to do it. Hm.
6344 (tramp-message vec 5 "Determining coding system")
6345 (tramp-send-command vec "echo foo ; echo bar" t)
6346 (with-current-buffer (process-buffer proc)
6347 (goto-char (point-min))
6348 (if (featurep 'mule)
6349 ;; Use MULE to select the right EOL convention for communicating
6350 ;; with the process.
6351 (let* ((cs (or (funcall (symbol-function 'process-coding-system) proc)
6352 (cons 'undecided 'undecided)))
6353 cs-decode cs-encode)
6354 (when (symbolp cs) (setq cs (cons cs cs)))
6355 (setq cs-decode (car cs))
6356 (setq cs-encode (cdr cs))
6357 (unless cs-decode (setq cs-decode 'undecided))
6358 (unless cs-encode (setq cs-encode 'undecided))
6359 (setq cs-encode (tramp-coding-system-change-eol-conversion
6361 (when (search-forward "\r" nil t)
6362 (setq cs-decode (tramp-coding-system-change-eol-conversion
6364 (funcall (symbol-function 'set-buffer-process-coding-system)
6365 cs-decode cs-encode)
6367 vec 5 "Setting coding system to `%s' and `%s'" cs-decode cs-encode))
6368 ;; Look for ^M and do something useful if found.
6369 (when (search-forward "\r" nil t)
6370 ;; We have found a ^M but cannot frob the process coding system
6371 ;; because we're running on a non-MULE Emacs. Let's try
6373 (tramp-send-command vec "stty -onlcr" t))))
6374 (tramp-send-command vec "set +o vi +o emacs" t)
6376 ;; Check whether the output of "uname -sr" has been changed. If
6377 ;; yes, this is a strong indication that we must expire all
6378 ;; connection properties. We start again with
6379 ;; `tramp-maybe-open-connection', it will be catched there.
6380 (tramp-message vec 5 "Checking system information")
6381 (let ((old-uname (tramp-get-connection-property vec "uname" nil))
6383 (tramp-set-connection-property
6385 (tramp-send-command-and-read vec "echo \\\"`uname -sr`\\\""))))
6386 (when (and (stringp old-uname) (not (string-equal old-uname new-uname)))
6387 (with-current-buffer (tramp-get-debug-buffer vec)
6388 ;; Keep the debug buffer
6390 (generate-new-buffer-name tramp-temp-buffer-name) 'unique)
6391 (funcall (symbol-function 'tramp-cleanup-connection) vec)
6392 (if (= (point-min) (point-max))
6394 (rename-buffer (tramp-debug-buffer-name vec) 'unique))
6395 ;; We call `tramp-get-buffer' in order to keep the debug buffer.
6396 (tramp-get-buffer vec)
6399 "Connection reset, because remote host changed from `%s' to `%s'"
6400 old-uname new-uname)
6401 (throw 'uname-changed (tramp-maybe-open-connection vec)))))
6403 ;; Check whether the remote host suffers from buggy
6404 ;; `send-process-string'. This is known for FreeBSD (see comment in
6405 ;; `send_process', file process.c). I've tested sending 624 bytes
6406 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
6407 ;; this host type is detected locally. It cannot handle remote
6409 (with-connection-property proc "chunksize"
6411 ((and (integerp tramp-chunksize) (> tramp-chunksize 0))
6415 vec 5 "Checking remote host type for `send-process-string' bug")
6417 "^FreeBSD" (tramp-get-connection-property vec "uname" ""))
6420 ;; Set remote PATH variable.
6421 (tramp-set-remote-path vec)
6423 ;; Search for a good shell before searching for a command which
6424 ;; checks if a file exists. This is done because Tramp wants to use
6425 ;; "test foo; echo $?" to check if various conditions hold, and
6426 ;; there are buggy /bin/sh implementations which don't execute the
6427 ;; "echo $?" part if the "test" part has an error. In particular,
6428 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
6429 ;; with buggy /bin/sh implementations will have a working bash or
6431 (tramp-find-shell vec)
6433 ;; Disable unexpected output.
6434 (tramp-send-command vec "mesg n; biff n" t)
6436 ;; Set the environment.
6437 (tramp-message vec 5 "Setting default environment")
6439 ;; On OpenSolaris, there is a bug when HISTFILE is changed in place
6440 ;; <http://bugs.opensolaris.org/view_bug.do?bug_id=6834184>. We
6441 ;; apply the workaround.
6442 (if (string-equal (tramp-get-connection-property vec "uname" "") "SunOS 5.11")
6443 (tramp-send-command vec "unset HISTFILE"))
6445 (let ((env (copy-sequence tramp-remote-process-environment))
6448 (setq item (tramp-compat-split-string (car env) "="))
6449 (if (and (stringp (cadr item)) (not (string-equal (cadr item) "")))
6451 vec (format "%s=%s; export %s" (car item) (cadr item) (car item)) t)
6452 (push (car item) unset))
6453 (setq env (cdr env)))
6456 vec (format "unset %s" (mapconcat 'identity unset " "))))) t)
6458 ;; CCC: We should either implement a Perl version of base64 encoding
6459 ;; and decoding. Then we just use that in the last item. The other
6460 ;; alternative is to use the Perl version of UU encoding. But then
6461 ;; we need a Lisp version of uuencode.
6463 ;; Old text from documentation of tramp-methods:
6464 ;; Using a uuencode/uudecode inline method is discouraged, please use one
6465 ;; of the base64 methods instead since base64 encoding is much more
6466 ;; reliable and the commands are more standardized between the different
6467 ;; Unix versions. But if you can't use base64 for some reason, please
6468 ;; note that the default uudecode command does not work well for some
6469 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
6470 ;; the following command for uudecode:
6472 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
6474 ;; For Irix, no solution is known yet.
6476 (defconst tramp-local-coding-commands
6477 '((b64 base64-encode-region base64-decode-region)
6478 (uu tramp-uuencode-region uudecode-decode-region)
6480 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
6481 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
6482 "List of local coding commands for inline transfer.
6483 Each item is a list that looks like this:
6485 \(FORMAT ENCODING DECODING)
6487 FORMAT is symbol describing the encoding/decoding format. It can be
6488 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
6490 ENCODING and DECODING can be strings, giving commands, or symbols,
6491 giving functions. If they are strings, then they can contain
6492 the \"%s\" format specifier. If that specifier is present, the input
6493 filename will be put into the command line at that spot. If the
6494 specifier is not present, the input should be read from standard
6497 If they are functions, they will be called with two arguments, start
6498 and end of region, and are expected to replace the region contents
6499 with the encoded or decoded results, respectively.")
6501 (defconst tramp-remote-coding-commands
6502 '((b64 "base64" "base64 -d")
6503 (b64 "mimencode -b" "mimencode -u -b")
6504 (b64 "mmencode -b" "mmencode -u -b")
6505 (b64 "recode data..base64" "recode base64..data")
6506 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module)
6507 (b64 tramp-perl-encode tramp-perl-decode)
6508 (uu "uuencode xxx" "uudecode -o /dev/stdout")
6509 (uu "uuencode xxx" "uudecode -o -")
6510 (uu "uuencode xxx" "uudecode -p")
6511 (uu "uuencode xxx" tramp-uudecode)
6513 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
6514 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
6515 "List of remote coding commands for inline transfer.
6516 Each item is a list that looks like this:
6518 \(FORMAT ENCODING DECODING)
6520 FORMAT is symbol describing the encoding/decoding format. It can be
6521 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
6523 ENCODING and DECODING can be strings, giving commands, or symbols,
6524 giving variables. If they are strings, then they can contain
6525 the \"%s\" format specifier. If that specifier is present, the input
6526 filename will be put into the command line at that spot. If the
6527 specifier is not present, the input should be read from standard
6530 If they are variables, this variable is a string containing a Perl
6531 implementation for this functionality. This Perl program will be transferred
6532 to the remote host, and it is avalible as shell function with the same name.")
6534 (defun tramp-find-inline-encoding (vec)
6535 "Find an inline transfer encoding that works.
6536 Goes through the list `tramp-local-coding-commands' and
6537 `tramp-remote-coding-commands'."
6539 (let ((local-commands tramp-local-coding-commands)
6541 loc-enc loc-dec rem-enc rem-dec litem ritem found)
6542 (while (and local-commands (not found))
6543 (setq litem (pop local-commands))
6544 (catch 'wont-work-local
6545 (let ((format (nth 0 litem))
6546 (remote-commands tramp-remote-coding-commands))
6547 (setq loc-enc (nth 1 litem))
6548 (setq loc-dec (nth 2 litem))
6549 ;; If the local encoder or decoder is a string, the
6550 ;; corresponding command has to work locally.
6551 (if (not (stringp loc-enc))
6553 vec 5 "Checking local encoding function `%s'" loc-enc)
6555 vec 5 "Checking local encoding command `%s' for sanity" loc-enc)
6556 (unless (zerop (tramp-call-local-coding-command
6558 (throw 'wont-work-local nil)))
6559 (if (not (stringp loc-dec))
6561 vec 5 "Checking local decoding function `%s'" loc-dec)
6563 vec 5 "Checking local decoding command `%s' for sanity" loc-dec)
6564 (unless (zerop (tramp-call-local-coding-command
6566 (throw 'wont-work-local nil)))
6567 ;; Search for remote coding commands with the same format
6568 (while (and remote-commands (not found))
6569 (setq ritem (pop remote-commands))
6570 (catch 'wont-work-remote
6571 (when (equal format (nth 0 ritem))
6572 (setq rem-enc (nth 1 ritem))
6573 (setq rem-dec (nth 2 ritem))
6574 ;; Check if remote encoding and decoding commands can be
6575 ;; called remotely with null input and output. This makes
6576 ;; sure there are no syntax errors and the command is really
6577 ;; found. Note that we do not redirect stdout to /dev/null,
6578 ;; for two reasons: when checking the decoding command, we
6579 ;; actually check the output it gives. And also, when
6580 ;; redirecting "mimencode" output to /dev/null, then as root
6581 ;; it might change the permissions of /dev/null!
6582 (when (not (stringp rem-enc))
6583 (let ((name (symbol-name rem-enc)))
6584 (while (string-match (regexp-quote "-") name)
6585 (setq name (replace-match "_" nil t name)))
6586 (tramp-maybe-send-script vec (symbol-value rem-enc) name)
6587 (setq rem-enc name)))
6590 "Checking remote encoding command `%s' for sanity" rem-enc)
6591 (unless (zerop (tramp-send-command-and-check
6592 vec (format "%s </dev/null" rem-enc) t))
6593 (throw 'wont-work-remote nil))
6595 (when (not (stringp rem-dec))
6596 (let ((name (symbol-name rem-dec)))
6597 (while (string-match (regexp-quote "-") name)
6598 (setq name (replace-match "_" nil t name)))
6599 (tramp-maybe-send-script vec (symbol-value rem-dec) name)
6600 (setq rem-dec name)))
6603 "Checking remote decoding command `%s' for sanity" rem-dec)
6604 (unless (zerop (tramp-send-command-and-check
6606 (format "echo %s | %s | %s"
6607 magic rem-enc rem-dec) t))
6608 (throw 'wont-work-remote nil))
6610 (with-current-buffer (tramp-get-buffer vec)
6611 (goto-char (point-min))
6612 (unless (looking-at (regexp-quote magic))
6613 (throw 'wont-work-remote nil)))
6615 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
6616 (setq rem-enc (nth 1 ritem))
6617 (setq rem-dec (nth 2 ritem))
6618 (setq found t)))))))
6620 ;; Did we find something?
6622 (tramp-message vec 2 "Couldn't find an inline transfer encoding"))
6624 ;; Set connection properties.
6625 (tramp-message vec 5 "Using local encoding `%s'" loc-enc)
6626 (tramp-set-connection-property vec "local-encoding" loc-enc)
6627 (tramp-message vec 5 "Using local decoding `%s'" loc-dec)
6628 (tramp-set-connection-property vec "local-decoding" loc-dec)
6629 (tramp-message vec 5 "Using remote encoding `%s'" rem-enc)
6630 (tramp-set-connection-property vec "remote-encoding" rem-enc)
6631 (tramp-message vec 5 "Using remote decoding `%s'" rem-dec)
6632 (tramp-set-connection-property vec "remote-decoding" rem-dec))))
6634 (defun tramp-call-local-coding-command (cmd input output)
6635 "Call the local encoding or decoding command.
6636 If CMD contains \"%s\", provide input file INPUT there in command.
6637 Otherwise, INPUT is passed via standard input.
6638 INPUT can also be nil which means `/dev/null'.
6639 OUTPUT can be a string (which specifies a filename), or t (which
6640 means standard output and thus the current buffer), or nil (which
6642 (tramp-local-call-process
6643 tramp-encoding-shell
6644 (when (and input (not (string-match "%s" cmd))) input)
6645 (if (eq output t) t nil)
6647 tramp-encoding-command-switch
6649 (if (string-match "%s" cmd) (format cmd input) cmd)
6650 (if (stringp output) (concat "> " output) ""))))
6652 (defun tramp-compute-multi-hops (vec)
6653 "Expands VEC according to `tramp-default-proxies-alist'.
6654 Gateway hops are already opened."
6655 (let ((target-alist `(,vec))
6656 (choices tramp-default-proxies-alist)
6659 ;; Look for proxy hosts to be passed.
6661 (setq item (pop choices)
6662 proxy (eval (nth 2 item)))
6665 (string-match (or (eval (nth 0 item)) "")
6666 (or (tramp-file-name-host (car target-alist)) ""))
6668 (string-match (or (eval (nth 1 item)) "")
6669 (or (tramp-file-name-user (car target-alist)) "")))
6671 ;; No more hops needed.
6673 ;; Replace placeholders.
6677 `((?u . ,(or (tramp-file-name-user (car target-alist)) ""))
6678 (?h . ,(or (tramp-file-name-host (car target-alist)) "")))))
6679 (with-parsed-tramp-file-name proxy l
6681 (add-to-list 'target-alist l)
6682 ;; Start next search.
6683 (setq choices tramp-default-proxies-alist)))))
6686 (when (and (boundp 'tramp-gw-tunnel-method)
6687 (string-match (format
6689 (symbol-value 'tramp-gw-tunnel-method)
6690 (symbol-value 'tramp-gw-socks-method))
6691 (tramp-file-name-method (car target-alist))))
6692 (let ((gw (pop target-alist))
6693 (hop (pop target-alist)))
6694 ;; Is the method prepared for gateways?
6695 (unless (tramp-get-method-parameter
6696 (tramp-file-name-method hop) 'tramp-default-port)
6699 "Method `%s' is not supported for gateway access."
6700 (tramp-file-name-method hop)))
6701 ;; Add default port if needed.
6704 tramp-host-with-port-regexp (tramp-file-name-host hop))
6707 (tramp-file-name-host hop) tramp-prefix-port-format
6709 (tramp-get-method-parameter
6710 (tramp-file-name-method hop) 'tramp-default-port)))))
6711 ;; Open the gateway connection.
6715 (tramp-file-name-method hop) (tramp-file-name-user hop)
6716 (funcall (symbol-function 'tramp-gw-open-connection) vec gw hop) nil))
6717 ;; For the password prompt, we need the correct values.
6718 ;; Therefore, we must remember the gateway vector. But we
6719 ;; cannot do it as connection property, because it shouldn't
6720 ;; be persistent. And we have no started process yet either.
6721 (tramp-set-file-property (car target-alist) "" "gateway" hop)))
6723 ;; Foreign and out-of-band methods are not supported for multi-hops.
6724 (when (cdr target-alist)
6725 (setq choices target-alist)
6727 (setq item (pop choices))
6731 (tramp-get-method-parameter
6732 (tramp-file-name-method item) 'tramp-login-program))
6733 (tramp-get-method-parameter
6734 (tramp-file-name-method item) 'tramp-copy-program))
6737 "Method `%s' is not supported for multi-hops."
6738 (tramp-file-name-method item)))))
6740 ;; In case the host name is not used for the remote shell
6741 ;; command, the user could be misguided by applying a random
6743 (let* ((v (car target-alist))
6744 (method (tramp-file-name-method v))
6745 (host (tramp-file-name-host v)))
6748 ;; There are multi-hops.
6750 ;; The host name is used for the remote shell command.
6752 '("%h") (tramp-get-method-parameter method 'tramp-login-args))
6753 ;; The host is local. We cannot use `tramp-local-host-p'
6754 ;; here, because it opens a connection as well.
6755 (string-match tramp-local-host-regexp host))
6758 "Host `%s' looks like a remote host, `%s' can only use the local host"
6764 (defun tramp-maybe-open-connection (vec)
6765 "Maybe open a connection VEC.
6766 Does not do anything if a connection is already open, but re-opens the
6767 connection if a previous connection has died for some reason."
6768 (catch 'uname-changed
6769 (let ((p (tramp-get-connection-process vec))
6770 (process-environment (copy-sequence process-environment)))
6772 ;; If too much time has passed since last command was sent, look
6773 ;; whether process is still alive. If it isn't, kill it. When
6774 ;; using ssh, it can sometimes happen that the remote end has
6775 ;; hung up but the local ssh client doesn't recognize this until
6776 ;; it tries to send some data to the remote end. So that's why
6777 ;; we try to send a command from time to time, then look again
6778 ;; whether the process is really alive.
6780 (when (and (> (tramp-time-diff
6782 (tramp-get-connection-property
6783 p "last-cmd-time" '(0 0 0)))
6785 p (processp p) (memq (process-status p) '(run open)))
6786 (tramp-send-command vec "echo are you awake" t t)
6787 (unless (and (memq (process-status p) '(run open))
6788 (tramp-wait-for-output p 10))
6789 ;; The error will be catched locally.
6790 (tramp-error vec 'file-error "Awake did fail")))
6792 (tramp-flush-connection-property vec)
6793 (tramp-flush-connection-property p)
6797 ;; New connection must be opened.
6798 (unless (and p (processp p) (memq (process-status p) '(run open)))
6800 ;; We call `tramp-get-buffer' in order to get a debug buffer for
6801 ;; messages from the beginning.
6802 (tramp-get-buffer vec)
6803 (if (zerop (length (tramp-file-name-user vec)))
6805 vec 3 "Opening connection for %s using %s..."
6806 (tramp-file-name-host vec)
6807 (tramp-file-name-method vec))
6809 vec 3 "Opening connection for %s@%s using %s..."
6810 (tramp-file-name-user vec)
6811 (tramp-file-name-host vec)
6812 (tramp-file-name-method vec)))
6814 ;; Start new process.
6815 (when (and p (processp p))
6817 (setenv "TERM" tramp-terminal-type)
6818 (setenv "LC_ALL" "C")
6819 (setenv "PROMPT_COMMAND")
6821 (let* ((target-alist (tramp-compute-multi-hops vec))
6822 (process-connection-type tramp-process-connection-type)
6823 (process-adaptive-read-buffering nil)
6824 (coding-system-for-read nil)
6825 ;; This must be done in order to avoid our file name handler.
6826 (p (let ((default-directory
6827 (tramp-compat-temporary-file-directory)))
6829 (or (tramp-get-connection-property vec "process-name" nil)
6830 (tramp-buffer-name vec))
6831 (tramp-get-connection-buffer vec)
6832 tramp-encoding-shell))))
6835 vec 6 "%s" (mapconcat 'identity (process-command p) " "))
6837 ;; Check whether process is alive.
6838 (tramp-set-process-query-on-exit-flag p nil)
6839 (tramp-message vec 3 "Waiting 60s for local shell to come up...")
6840 (tramp-barf-if-no-shell-prompt
6841 p 60 "Couldn't find local shell prompt %s" tramp-encoding-shell)
6843 ;; Now do all the connections as specified.
6845 (let* ((hop (car target-alist))
6846 (l-method (tramp-file-name-method hop))
6847 (l-user (tramp-file-name-user hop))
6848 (l-host (tramp-file-name-host hop))
6851 (tramp-get-method-parameter l-method 'tramp-login-program))
6853 (tramp-get-method-parameter l-method 'tramp-login-args))
6855 (tramp-get-method-parameter l-method 'tramp-gw-args))
6856 (gw (tramp-get-file-property hop "" "gateway" nil))
6857 (g-method (and gw (tramp-file-name-method gw)))
6858 (g-user (and gw (tramp-file-name-user gw)))
6859 (g-host (and gw (tramp-file-name-host gw)))
6860 (command login-program)
6861 ;; We don't create the temporary file. In fact, it
6862 ;; is just a prefix for the ControlPath option of
6863 ;; ssh; the real temporary file has another name, and
6864 ;; it is created and protected by ssh. It is also
6865 ;; removed by ssh, when the connection is closed.
6867 (tramp-set-connection-property
6871 tramp-temp-name-prefix
6872 (tramp-compat-temporary-file-directory)))))
6875 ;; Add gateway arguments if necessary.
6876 (when (and gw gw-args)
6877 (setq login-args (append login-args gw-args)))
6879 ;; Check for port number. Until now, there's no need
6880 ;; for handling like method, user, host.
6881 (when (string-match tramp-host-with-port-regexp l-host)
6882 (setq l-port (match-string 2 l-host)
6883 l-host (match-string 1 l-host)))
6885 ;; Set variables for computing the prompt for reading
6886 ;; password. They can also be derived from a gateway.
6887 (setq tramp-current-method (or g-method l-method)
6888 tramp-current-user (or g-user l-user)
6889 tramp-current-host (or g-host l-host))
6891 ;; Replace login-args place holders.
6893 l-host (or l-host "")
6894 l-user (or l-user "")
6895 l-port (or l-port "")
6896 spec `((?h . ,l-host) (?u . ,l-user) (?p . ,l-port)
6903 (setq x (mapcar (lambda (y) (format-spec y spec)) x))
6904 (unless (member "" x) (mapconcat 'identity x " ")))
6906 ;; Local shell could be a Windows COMSPEC. It doesn't
6907 ;; know the ";" syntax, but we must exit always for
6908 ;; `start-file-process'. "exec" does not work either.
6909 " && exit || exit"))
6911 ;; Send the command.
6912 (tramp-message vec 3 "Sending command `%s'" command)
6913 (tramp-send-command vec command t t)
6914 (tramp-process-actions p vec tramp-actions-before-shell 60)
6915 (tramp-message vec 3 "Found remote shell prompt on `%s'" l-host))
6917 (setq target-alist (cdr target-alist)))
6919 ;; Make initial shell settings.
6920 (tramp-open-connection-setup-interactive-shell p vec))))))
6922 (defun tramp-send-command (vec command &optional neveropen nooutput)
6923 "Send the COMMAND to connection VEC.
6924 Erases temporary buffer before sending the command. If optional
6925 arg NEVEROPEN is non-nil, never try to open the connection. This
6926 is meant to be used from `tramp-maybe-open-connection' only. The
6927 function waits for output unless NOOUTPUT is set."
6928 (unless neveropen (tramp-maybe-open-connection vec))
6929 (let ((p (tramp-get-connection-process vec)))
6930 (when (tramp-get-connection-property p "remote-echo" nil)
6931 ;; We mark the command string that it can be erased in the output buffer.
6932 (tramp-set-connection-property p "check-remote-echo" t)
6933 (setq command (format "%s%s%s" tramp-echo-mark command tramp-echo-mark)))
6934 (tramp-message vec 6 "%s" command)
6935 (tramp-send-string vec command)
6936 (unless nooutput (tramp-wait-for-output p))))
6938 (defun tramp-wait-for-output (proc &optional timeout)
6939 "Wait for output from remote rsh command."
6940 (with-current-buffer (process-buffer proc)
6941 (let* (;; Initially, `tramp-end-of-output' is "$ ". There might
6942 ;; be leading escape sequences, which must be ignored.
6943 (regexp (format "[^$\n]*%s\r?$" (regexp-quote tramp-end-of-output)))
6944 ;; Sometimes, the commands do not return a newline but a
6945 ;; null byte before the shell prompt, for example "git
6946 ;; ls-files -c -z ...".
6947 (regexp1 (format "\\(^\\|\000\\)%s" regexp))
6948 (found (tramp-wait-for-regexp proc timeout regexp1)))
6950 (let (buffer-read-only)
6951 (goto-char (point-max))
6952 (re-search-backward regexp nil t)
6953 (delete-region (point) (point-max)))
6957 "[[Remote prompt `%s' not found in %d secs]]"
6958 tramp-end-of-output timeout)
6961 "[[Remote prompt `%s' not found]]" tramp-end-of-output)))
6962 ;; Return value is whether end-of-output sentinel was found.
6965 (defun tramp-send-command-and-check (vec command &optional subshell)
6966 "Run COMMAND and check its exit status.
6967 Sends `echo $?' along with the COMMAND for checking the exit status. If
6968 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
6970 If the optional argument SUBSHELL is non-nil, the command is executed in
6971 a subshell, ie surrounded by parentheses."
6974 (concat (if subshell "( " "")
6976 (if command " 2>/dev/null; " "")
6977 "echo tramp_exit_status $?"
6978 (if subshell " )" " ")))
6979 (with-current-buffer (tramp-get-connection-buffer vec)
6980 (goto-char (point-max))
6981 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t)
6983 vec 'file-error "Couldn't find exit status of `%s'" command))
6984 (skip-chars-forward "^ ")
6986 (read (current-buffer))
6987 (let (buffer-read-only) (delete-region (match-beginning 0) (point-max))))))
6989 (defun tramp-barf-unless-okay (vec command fmt &rest args)
6990 "Run COMMAND, check exit status, throw error if exit status not okay.
6991 Similar to `tramp-send-command-and-check' but accepts two more arguments
6992 FMT and ARGS which are passed to `error'."
6993 (unless (zerop (tramp-send-command-and-check vec command))
6994 (apply 'tramp-error vec 'file-error fmt args)))
6996 (defun tramp-send-command-and-read (vec command)
6997 "Run COMMAND and return the output, which must be a Lisp expression.
6998 In case there is no valid Lisp expression, it raises an error"
6999 (tramp-barf-unless-okay vec command "`%s' returns with error" command)
7000 (with-current-buffer (tramp-get-connection-buffer vec)
7001 ;; Read the expression.
7002 (goto-char (point-min))
7004 (prog1 (read (current-buffer))
7006 (when (re-search-forward "\\S-" (tramp-compat-line-end-position) t)
7010 "`%s' does not return a valid Lisp expression: `%s'"
7011 command (buffer-string))))))
7013 ;; It seems that Tru64 Unix does not like it if long strings are sent
7014 ;; to it in one go. (This happens when sending the Perl
7015 ;; `file-attributes' implementation, for instance.) Therefore, we
7016 ;; have this function which sends the string in chunks.
7017 (defun tramp-send-string (vec string)
7018 "Send the STRING via connection VEC.
7020 The STRING is expected to use Unix line-endings, but the lines sent to
7021 the remote host use line-endings as defined in the variable
7022 `tramp-rsh-end-of-line'. The communication buffer is erased before sending."
7023 (let* ((p (tramp-get-connection-process vec))
7024 (chunksize (tramp-get-connection-property p "chunksize" nil)))
7027 vec 'file-error "Can't send string to remote host -- not logged in"))
7028 (tramp-set-connection-property p "last-cmd-time" (current-time))
7029 (tramp-message vec 10 "%s" string)
7030 (with-current-buffer (tramp-get-connection-buffer vec)
7031 ;; Clean up the buffer. We cannot call `erase-buffer' because
7032 ;; narrowing might be in effect.
7033 (let (buffer-read-only) (delete-region (point-min) (point-max)))
7034 ;; Replace "\n" by `tramp-rsh-end-of-line'.
7036 (mapconcat 'identity
7037 (tramp-compat-split-string string "\n")
7038 tramp-rsh-end-of-line))
7039 (unless (or (string= string "")
7040 (string-equal (substring string -1) tramp-rsh-end-of-line))
7041 (setq string (concat string tramp-rsh-end-of-line)))
7043 (if (and chunksize (not (zerop chunksize)))
7045 (end (length string)))
7048 vec 10 "Sending chunk from %s to %s"
7049 pos (min (+ pos chunksize) end))
7050 (process-send-string
7051 p (substring string pos (min (+ pos chunksize) end)))
7052 (setq pos (+ pos chunksize))))
7053 (process-send-string p string)))))
7055 (defun tramp-mode-string-to-int (mode-string)
7056 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
7057 (let* (case-fold-search
7058 (mode-chars (string-to-vector mode-string))
7059 (owner-read (aref mode-chars 1))
7060 (owner-write (aref mode-chars 2))
7061 (owner-execute-or-setid (aref mode-chars 3))
7062 (group-read (aref mode-chars 4))
7063 (group-write (aref mode-chars 5))
7064 (group-execute-or-setid (aref mode-chars 6))
7065 (other-read (aref mode-chars 7))
7066 (other-write (aref mode-chars 8))
7067 (other-execute-or-sticky (aref mode-chars 9)))
7071 ((char-equal owner-read ?r) (tramp-octal-to-decimal "00400"))
7072 ((char-equal owner-read ?-) 0)
7073 (t (error "Second char `%c' must be one of `r-'" owner-read)))
7075 ((char-equal owner-write ?w) (tramp-octal-to-decimal "00200"))
7076 ((char-equal owner-write ?-) 0)
7077 (t (error "Third char `%c' must be one of `w-'" owner-write)))
7079 ((char-equal owner-execute-or-setid ?x)
7080 (tramp-octal-to-decimal "00100"))
7081 ((char-equal owner-execute-or-setid ?S)
7082 (tramp-octal-to-decimal "04000"))
7083 ((char-equal owner-execute-or-setid ?s)
7084 (tramp-octal-to-decimal "04100"))
7085 ((char-equal owner-execute-or-setid ?-) 0)
7086 (t (error "Fourth char `%c' must be one of `xsS-'"
7087 owner-execute-or-setid)))
7089 ((char-equal group-read ?r) (tramp-octal-to-decimal "00040"))
7090 ((char-equal group-read ?-) 0)
7091 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
7093 ((char-equal group-write ?w) (tramp-octal-to-decimal "00020"))
7094 ((char-equal group-write ?-) 0)
7095 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
7097 ((char-equal group-execute-or-setid ?x)
7098 (tramp-octal-to-decimal "00010"))
7099 ((char-equal group-execute-or-setid ?S)
7100 (tramp-octal-to-decimal "02000"))
7101 ((char-equal group-execute-or-setid ?s)
7102 (tramp-octal-to-decimal "02010"))
7103 ((char-equal group-execute-or-setid ?-) 0)
7104 (t (error "Seventh char `%c' must be one of `xsS-'"
7105 group-execute-or-setid)))
7107 ((char-equal other-read ?r)
7108 (tramp-octal-to-decimal "00004"))
7109 ((char-equal other-read ?-) 0)
7110 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
7112 ((char-equal other-write ?w) (tramp-octal-to-decimal "00002"))
7113 ((char-equal other-write ?-) 0)
7114 (t (error "Nineth char `%c' must be one of `w-'" other-write)))
7116 ((char-equal other-execute-or-sticky ?x)
7117 (tramp-octal-to-decimal "00001"))
7118 ((char-equal other-execute-or-sticky ?T)
7119 (tramp-octal-to-decimal "01000"))
7120 ((char-equal other-execute-or-sticky ?t)
7121 (tramp-octal-to-decimal "01001"))
7122 ((char-equal other-execute-or-sticky ?-) 0)
7123 (t (error "Tenth char `%c' must be one of `xtT-'"
7124 other-execute-or-sticky)))))))
7126 (defun tramp-convert-file-attributes (vec attr)
7127 "Convert file-attributes ATTR generated by perl script, stat or ls.
7128 Convert file mode bits to string and set virtual device number.
7131 ;; Convert last access time.
7132 (unless (listp (nth 4 attr))
7133 (setcar (nthcdr 4 attr)
7134 (list (floor (nth 4 attr) 65536)
7135 (floor (mod (nth 4 attr) 65536)))))
7136 ;; Convert last modification time.
7137 (unless (listp (nth 5 attr))
7138 (setcar (nthcdr 5 attr)
7139 (list (floor (nth 5 attr) 65536)
7140 (floor (mod (nth 5 attr) 65536)))))
7141 ;; Convert last status change time.
7142 (unless (listp (nth 6 attr))
7143 (setcar (nthcdr 6 attr)
7144 (list (floor (nth 6 attr) 65536)
7145 (floor (mod (nth 6 attr) 65536)))))
7146 ;; Convert file size.
7147 (when (< (nth 7 attr) 0)
7148 (setcar (nthcdr 7 attr) -1))
7149 (when (and (floatp (nth 7 attr))
7150 (<= (nth 7 attr) (tramp-compat-most-positive-fixnum)))
7151 (setcar (nthcdr 7 attr) (round (nth 7 attr))))
7152 ;; Convert file mode bits to string.
7153 (unless (stringp (nth 8 attr))
7154 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr)))
7155 (when (stringp (car attr))
7156 (aset (nth 8 attr) 0 ?l)))
7157 ;; Convert directory indication bit.
7158 (when (string-match "^d" (nth 8 attr))
7160 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
7161 (when (consp (car attr))
7162 (if (and (stringp (caar attr))
7163 (string-match ".+ -> .\\(.+\\)." (caar attr)))
7164 (setcar attr (match-string 1 (caar attr)))
7166 ;; Set file's gid change bit.
7167 (setcar (nthcdr 9 attr)
7168 (if (numberp (nth 3 attr))
7169 (not (= (nth 3 attr)
7170 (tramp-get-remote-gid vec 'integer)))
7173 (tramp-get-remote-gid vec 'string)))))
7175 (unless (listp (nth 10 attr))
7176 (setcar (nthcdr 10 attr)
7178 (cons (floor (nth 10 attr) 65536)
7179 (floor (mod (nth 10 attr) 65536)))
7180 ;; Inodes can be incredible huge. We must hide this.
7181 (error (tramp-get-inode vec)))))
7182 ;; Set virtual device number.
7183 (setcar (nthcdr 11 attr)
7184 (tramp-get-device vec))
7187 (defun tramp-get-inode (vec)
7188 "Returns the virtual inode number.
7189 If it doesn't exist, generate a new one."
7190 (let ((string (tramp-make-tramp-file-name
7191 (tramp-file-name-method vec)
7192 (tramp-file-name-user vec)
7193 (tramp-file-name-host vec)
7195 (unless (assoc string tramp-inodes)
7196 (add-to-list 'tramp-inodes
7197 (list string (length tramp-inodes))))
7198 (nth 1 (assoc string tramp-inodes))))
7200 (defun tramp-get-device (vec)
7201 "Returns the virtual device number.
7202 If it doesn't exist, generate a new one."
7203 (let ((string (tramp-make-tramp-file-name
7204 (tramp-file-name-method vec)
7205 (tramp-file-name-user vec)
7206 (tramp-file-name-host vec)
7208 (unless (assoc string tramp-devices)
7209 (add-to-list 'tramp-devices
7210 (list string (length tramp-devices))))
7211 (cons -1 (nth 1 (assoc string tramp-devices)))))
7213 (defun tramp-file-mode-from-int (mode)
7214 "Turn an integer representing a file mode into an ls(1)-like string."
7215 (let ((type (cdr (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
7216 (user (logand (lsh mode -6) 7))
7217 (group (logand (lsh mode -3) 7))
7218 (other (logand (lsh mode -0) 7))
7219 (suid (> (logand (lsh mode -9) 4) 0))
7220 (sgid (> (logand (lsh mode -9) 2) 0))
7221 (sticky (> (logand (lsh mode -9) 1) 0)))
7222 (setq user (tramp-file-mode-permissions user suid "s"))
7223 (setq group (tramp-file-mode-permissions group sgid "s"))
7224 (setq other (tramp-file-mode-permissions other sticky "t"))
7225 (concat type user group other)))
7227 (defun tramp-file-mode-permissions (perm suid suid-text)
7228 "Convert a permission bitset into a string.
7229 This is used internally by `tramp-file-mode-from-int'."
7230 (let ((r (> (logand perm 4) 0))
7231 (w (> (logand perm 2) 0))
7232 (x (> (logand perm 1) 0)))
7233 (concat (or (and r "r") "-")
7234 (or (and w "w") "-")
7235 (or (and suid x suid-text) ; suid, execute
7236 (and suid (upcase suid-text)) ; suid, !execute
7237 (and x "x") "-")))) ; !suid
7239 (defun tramp-decimal-to-octal (i)
7240 "Return a string consisting of the octal digits of I.
7241 Not actually used. Use `(format \"%o\" i)' instead?"
7242 (cond ((< i 0) (error "Cannot convert negative number to octal"))
7243 ((not (integerp i)) (error "Cannot convert non-integer to octal"))
7245 (t (concat (tramp-decimal-to-octal (/ i 8))
7246 (number-to-string (% i 8))))))
7248 ;; Kudos to Gerd Moellmann for this suggestion.
7249 (defun tramp-octal-to-decimal (ostr)
7250 "Given a string of octal digits, return a decimal number."
7251 (let ((x (or ostr "")))
7252 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
7253 (unless (string-match "\\`[0-7]*\\'" x)
7254 (error "Non-octal junk in string `%s'" x))
7255 (string-to-number ostr 8)))
7257 (defun tramp-shell-case-fold (string)
7258 "Converts STRING to shell glob pattern which ignores case."
7261 (if (equal (downcase c) (upcase c))
7263 (format "[%c%c]" (downcase c) (upcase c))))
7268 ;; ------------------------------------------------------------
7269 ;; -- Tramp file names --
7270 ;; ------------------------------------------------------------
7271 ;; Conversion functions between external representation and
7272 ;; internal data structure. Convenience functions for internal
7275 (defun tramp-file-name-p (vec)
7276 "Check whether VEC is a Tramp object."
7277 (and (vectorp vec) (= 4 (length vec))))
7279 (defun tramp-file-name-method (vec)
7280 "Return method component of VEC."
7281 (and (tramp-file-name-p vec) (aref vec 0)))
7283 (defun tramp-file-name-user (vec)
7284 "Return user component of VEC."
7285 (and (tramp-file-name-p vec) (aref vec 1)))
7287 (defun tramp-file-name-host (vec)
7288 "Return host component of VEC."
7289 (and (tramp-file-name-p vec) (aref vec 2)))
7291 (defun tramp-file-name-localname (vec)
7292 "Return localname component of VEC."
7293 (and (tramp-file-name-p vec) (aref vec 3)))
7295 ;; The user part of a Tramp file name vector can be of kind
7296 ;; "user%domain". Sometimes, we must extract these parts.
7297 (defun tramp-file-name-real-user (vec)
7298 "Return the user name of VEC without domain."
7300 (let ((user (tramp-file-name-user vec)))
7301 (if (and (stringp user)
7302 (string-match tramp-user-with-domain-regexp user))
7303 (match-string 1 user)
7306 (defun tramp-file-name-domain (vec)
7307 "Return the domain name of VEC."
7309 (let ((user (tramp-file-name-user vec)))
7311 (string-match tramp-user-with-domain-regexp user)
7312 (match-string 2 user)))))
7314 ;; The host part of a Tramp file name vector can be of kind
7315 ;; "host#port". Sometimes, we must extract these parts.
7316 (defun tramp-file-name-real-host (vec)
7317 "Return the host name of VEC without port."
7319 (let ((host (tramp-file-name-host vec)))
7320 (if (and (stringp host)
7321 (string-match tramp-host-with-port-regexp host))
7322 (match-string 1 host)
7325 (defun tramp-file-name-port (vec)
7326 "Return the port number of VEC."
7328 (let ((host (tramp-file-name-host vec)))
7330 (string-match tramp-host-with-port-regexp host)
7331 (string-to-number (match-string 2 host))))))
7333 (defun tramp-tramp-file-p (name)
7334 "Return t if NAME is a Tramp file."
7336 (string-match tramp-file-name-regexp name)))
7338 (defun tramp-find-method (method user host)
7339 "Return the right method string to use.
7340 This is METHOD, if non-nil. Otherwise, do a lookup in
7341 `tramp-default-method-alist'."
7343 (let ((choices tramp-default-method-alist)
7346 (setq item (pop choices))
7347 (when (and (string-match (or (nth 0 item) "") (or host ""))
7348 (string-match (or (nth 1 item) "") (or user "")))
7349 (setq lmethod (nth 2 item))
7350 (setq choices nil)))
7352 tramp-default-method))
7354 (defun tramp-find-user (method user host)
7355 "Return the right user string to use.
7356 This is USER, if non-nil. Otherwise, do a lookup in
7357 `tramp-default-user-alist'."
7359 (let ((choices tramp-default-user-alist)
7362 (setq item (pop choices))
7363 (when (and (string-match (or (nth 0 item) "") (or method ""))
7364 (string-match (or (nth 1 item) "") (or host "")))
7365 (setq luser (nth 2 item))
7366 (setq choices nil)))
7368 tramp-default-user))
7370 (defun tramp-find-host (method user host)
7371 "Return the right host string to use.
7372 This is HOST, if non-nil. Otherwise, it is `tramp-default-host'."
7373 (or (and (> (length host) 0) host)
7374 tramp-default-host))
7376 (defun tramp-dissect-file-name (name &optional nodefault)
7377 "Return a `tramp-file-name' structure.
7378 The structure consists of remote method, remote user, remote host
7379 and localname (file name on remote host). If NODEFAULT is
7380 non-nil, the file name parts are not expanded to their default
7383 (let ((match (string-match (nth 0 tramp-file-name-structure) name)))
7384 (unless match (error "Not a Tramp file name: %s" name))
7385 (let ((method (match-string (nth 1 tramp-file-name-structure) name))
7386 (user (match-string (nth 2 tramp-file-name-structure) name))
7387 (host (match-string (nth 3 tramp-file-name-structure) name))
7388 (localname (match-string (nth 4 tramp-file-name-structure) name)))
7389 (when (member method '("multi" "multiu"))
7391 "`%s' method is no longer supported, see (info \"(tramp)Multi-hops\")"
7394 (when (string-match tramp-prefix-ipv6-regexp host)
7395 (setq host (replace-match "" nil t host)))
7396 (when (string-match tramp-postfix-ipv6-regexp host)
7397 (setq host (replace-match "" nil t host))))
7399 (vector method user host localname)
7401 (tramp-find-method method user host)
7402 (tramp-find-user method user host)
7403 (tramp-find-host method user host)
7406 (defun tramp-equal-remote (file1 file2)
7407 "Checks, whether the remote parts of FILE1 and FILE2 are identical.
7408 The check depends on method, user and host name of the files. If
7409 one of the components is missing, the default values are used.
7410 The local file name parts of FILE1 and FILE2 are not taken into
7415 (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\")
7417 would yield `t'. On the other hand, the following check results in nil:
7419 (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")"
7420 (and (stringp (file-remote-p file1))
7421 (stringp (file-remote-p file2))
7422 (string-equal (file-remote-p file1) (file-remote-p file2))))
7424 (defun tramp-make-tramp-file-name (method user host localname)
7425 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME."
7426 (concat tramp-prefix-format
7427 (when (not (zerop (length method)))
7428 (concat method tramp-postfix-method-format))
7429 (when (not (zerop (length user)))
7430 (concat user tramp-postfix-user-format))
7432 (if (string-match tramp-ipv6-regexp host)
7433 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
7435 tramp-postfix-host-format
7436 (when localname localname)))
7438 (defun tramp-completion-make-tramp-file-name (method user host localname)
7439 "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME.
7440 It must not be a complete Tramp file name, but as long as there are
7441 necessary only. This function will be used in file name completion."
7442 (concat tramp-prefix-format
7443 (when (not (zerop (length method)))
7444 (concat method tramp-postfix-method-format))
7445 (when (not (zerop (length user)))
7446 (concat user tramp-postfix-user-format))
7447 (when (not (zerop (length host)))
7449 (if (string-match tramp-ipv6-regexp host)
7450 (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format)
7452 tramp-postfix-host-format))
7453 (when localname localname)))
7455 (defun tramp-make-copy-program-file-name (vec)
7456 "Create a file name suitable to be passed to `rcp' and workalikes."
7457 (let ((user (tramp-file-name-user vec))
7458 (host (tramp-file-name-real-host vec))
7459 (localname (tramp-shell-quote-argument
7460 (tramp-file-name-localname vec))))
7461 (if (not (zerop (length user)))
7462 (format "%s@%s:%s" user host localname)
7463 (format "%s:%s" host localname))))
7465 (defun tramp-method-out-of-band-p (vec size)
7466 "Return t if this is an out-of-band method, nil otherwise."
7468 ;; It shall be an out-of-band method.
7469 (tramp-get-method-parameter (tramp-file-name-method vec) 'tramp-copy-program)
7470 ;; Either the file size is large enough, or (in rare cases) there
7471 ;; does not exist a remote encoding.
7472 (or (> size tramp-copy-size-limit)
7473 (null (tramp-get-remote-coding vec "remote-encoding")))))
7475 (defun tramp-local-host-p (vec)
7476 "Return t if this points to the local host, nil otherwise."
7477 ;; We cannot use `tramp-file-name-real-host'. A port is an
7478 ;; indication for an ssh tunnel or alike.
7479 (let ((host (tramp-file-name-host vec)))
7482 (string-match tramp-local-host-regexp host)
7483 ;; The method shall be applied to one of the shell file name
7484 ;; handler. `tramp-local-host-p' is also called for "smb" and
7485 ;; alike, where it must fail.
7486 (tramp-get-method-parameter
7487 (tramp-file-name-method vec) 'tramp-login-program)
7488 ;; The local temp directory must be writable for the other user.
7490 (tramp-make-tramp-file-name
7491 (tramp-file-name-method vec)
7492 (tramp-file-name-user vec)
7494 (tramp-compat-temporary-file-directory)))
7495 ;; On some systems, chown runs only for root.
7496 (or (zerop (user-uid))
7497 (zerop (tramp-get-remote-uid vec 'integer))))))
7499 ;; Variables local to connection.
7501 (defun tramp-get-remote-path (vec)
7502 (with-connection-property
7503 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
7504 ;; cache the result for the session only. Otherwise, the result
7505 ;; is cached persistently.
7506 (if (memq 'tramp-own-remote-path tramp-remote-path)
7507 (tramp-get-connection-process vec)
7510 (let* ((remote-path (tramp-compat-copy-tree tramp-remote-path))
7511 (elt1 (memq 'tramp-default-remote-path remote-path))
7512 (elt2 (memq 'tramp-own-remote-path remote-path))
7513 (default-remote-path
7516 (tramp-send-command-and-read
7517 vec "echo \\\"`getconf PATH`\\\"")
7518 ;; Default if "getconf" is not available.
7522 "`getconf PATH' not successful, using default value \"%s\"."
7528 (tramp-send-command-and-read vec "echo \\\"$PATH\\\"")
7529 ;; Default if "getconf" is not available.
7532 vec 3 "$PATH not set, ignoring `tramp-own-remote-path'.")
7535 ;; Replace place holder `tramp-default-remote-path'.
7539 (tramp-compat-split-string default-remote-path ":")
7541 (setq remote-path (delq 'tramp-default-remote-path remote-path)))
7543 ;; Replace place holder `tramp-own-remote-path'.
7547 (tramp-compat-split-string own-remote-path ":")
7549 (setq remote-path (delq 'tramp-own-remote-path remote-path)))
7551 ;; Remove double entries.
7552 (setq elt1 remote-path)
7554 (while (and (car elt1) (setq elt2 (member (car elt1) (cdr elt1))))
7556 (setq elt1 (cdr elt1)))
7558 ;; Remove non-existing directories.
7566 (tramp-make-tramp-file-name
7567 (tramp-file-name-method vec)
7568 (tramp-file-name-user vec)
7569 (tramp-file-name-host vec)
7574 (defun tramp-get-remote-tmpdir (vec)
7575 (with-connection-property vec "tmp-directory"
7576 (let ((dir (tramp-shell-quote-argument "/tmp")))
7578 (tramp-send-command-and-check
7579 vec (format "%s -d %s" (tramp-get-test-command vec) dir)))
7581 (tramp-send-command-and-check
7582 vec (format "%s -w %s" (tramp-get-test-command vec) dir))))
7584 (tramp-error vec 'file-error "Directory %s not accessible" dir)))))
7586 (defun tramp-get-ls-command (vec)
7587 (with-connection-property vec "ls"
7588 (tramp-message vec 5 "Finding a suitable `ls' command")
7591 (dolist (cmd '("ls" "gnuls" "gls"))
7592 (let ((dl (tramp-get-remote-path vec))
7594 (while (and dl (setq result (tramp-find-executable vec cmd dl t t)))
7596 (when (zerop (tramp-send-command-and-check
7597 vec (format "%s -lnd /" result)))
7598 (throw 'ls-found result))
7599 (setq dl (cdr dl))))))
7600 (tramp-error vec 'file-error "Couldn't find a proper `ls' command"))))
7602 (defun tramp-get-ls-command-with-dired (vec)
7604 (with-connection-property vec "ls-dired"
7605 (tramp-message vec 5 "Checking, whether `ls --dired' works")
7606 (zerop (tramp-send-command-and-check
7607 vec (format "%s --dired /" (tramp-get-ls-command vec)))))))
7609 (defun tramp-get-test-command (vec)
7610 (with-connection-property vec "test"
7611 (tramp-message vec 5 "Finding a suitable `test' command")
7612 (if (zerop (tramp-send-command-and-check vec "test 0"))
7614 (tramp-find-executable vec "test" (tramp-get-remote-path vec)))))
7616 (defun tramp-get-test-nt-command (vec)
7617 ;; Does `test A -nt B' work? Use abominable `find' construct if it
7618 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
7619 ;; for otherwise the shell crashes.
7620 (with-connection-property vec "test-nt"
7624 vec (format "( %s / -nt / )" (tramp-get-test-command vec)))
7625 (with-current-buffer (tramp-get-buffer vec)
7626 (goto-char (point-min))
7627 (when (looking-at (regexp-quote tramp-end-of-output))
7628 (format "%s %%s -nt %%s" (tramp-get-test-command vec)))))
7633 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
7634 (tramp-get-test-command vec)))
7635 "tramp_test_nt %s %s"))))
7637 (defun tramp-get-file-exists-command (vec)
7638 (with-connection-property vec "file-exists"
7639 (tramp-message vec 5 "Finding command to check if file exists")
7640 (tramp-find-file-exists-command vec)))
7642 (defun tramp-get-remote-ln (vec)
7643 (with-connection-property vec "ln"
7644 (tramp-message vec 5 "Finding a suitable `ln' command")
7645 (tramp-find-executable vec "ln" (tramp-get-remote-path vec))))
7647 (defun tramp-get-remote-perl (vec)
7648 (with-connection-property vec "perl"
7649 (tramp-message vec 5 "Finding a suitable `perl' command")
7650 (or (tramp-find-executable vec "perl5" (tramp-get-remote-path vec))
7651 (tramp-find-executable vec "perl" (tramp-get-remote-path vec)))))
7653 (defun tramp-get-remote-stat (vec)
7654 (with-connection-property vec "stat"
7655 (tramp-message vec 5 "Finding a suitable `stat' command")
7656 (let ((result (tramp-find-executable
7657 vec "stat" (tramp-get-remote-path vec)))
7659 ;; Check whether stat(1) returns usable syntax. %s does not
7660 ;; work on older AIX systems.
7663 ;; We don't want to display an error message.
7664 (with-temp-message (or (current-message) "")
7666 (tramp-send-command-and-read
7667 vec (format "%s -c '(\"%%N\" %%s)' /" result))
7669 (unless (and (listp tmp) (stringp (car tmp))
7670 (string-match "^./.$" (car tmp))
7671 (integerp (cadr tmp)))
7675 (defun tramp-get-remote-id (vec)
7676 (with-connection-property vec "id"
7677 (tramp-message vec 5 "Finding POSIX `id' command")
7680 (let ((dl (tramp-get-remote-path vec))
7682 (while (and dl (setq result (tramp-find-executable vec "id" dl t t)))
7683 ;; Check POSIX parameter.
7684 (when (zerop (tramp-send-command-and-check
7685 vec (format "%s -u" result)))
7686 (throw 'id-found result))
7687 (setq dl (cdr dl)))))
7688 (tramp-error vec 'file-error "Couldn't find a POSIX `id' command"))))
7690 (defun tramp-get-remote-uid (vec id-format)
7691 (with-connection-property vec (format "uid-%s" id-format)
7692 (let ((res (tramp-send-command-and-read
7694 (format "%s -u%s %s"
7695 (tramp-get-remote-id vec)
7696 (if (equal id-format 'integer) "" "n")
7697 (if (equal id-format 'integer)
7698 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7699 ;; The command might not always return a number.
7700 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7702 (defun tramp-get-remote-gid (vec id-format)
7703 (with-connection-property vec (format "gid-%s" id-format)
7704 (let ((res (tramp-send-command-and-read
7706 (format "%s -g%s %s"
7707 (tramp-get-remote-id vec)
7708 (if (equal id-format 'integer) "" "n")
7709 (if (equal id-format 'integer)
7710 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
7711 ;; The command might not always return a number.
7712 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
7714 (defun tramp-get-local-uid (id-format)
7715 (if (equal id-format 'integer) (user-uid) (user-login-name)))
7717 (defun tramp-get-local-gid (id-format)
7718 (nth 3 (tramp-compat-file-attributes "~/" id-format)))
7720 ;; Some predefined connection properties.
7721 (defun tramp-get-remote-coding (vec prop)
7722 ;; Local coding handles properties like remote coding. So we could
7723 ;; call it without pain.
7724 (let ((ret (tramp-get-local-coding vec prop)))
7725 ;; The connection property might have been cached. So we must send
7726 ;; the script - maybe.
7727 (when (and ret (symbolp ret))
7728 (let ((name (symbol-name ret)))
7729 (while (string-match (regexp-quote "-") name)
7730 (setq name (replace-match "_" nil t name)))
7731 (tramp-maybe-send-script vec (symbol-value ret) name)
7733 ;; Return the value.
7736 (defun tramp-get-local-coding (vec prop)
7738 (tramp-get-connection-property vec prop nil)
7740 (tramp-find-inline-encoding vec)
7741 (tramp-get-connection-property vec prop nil))))
7743 (defun tramp-get-method-parameter (method param)
7744 "Return the method parameter PARAM.
7745 If the `tramp-methods' entry does not exist, return NIL."
7746 (let ((entry (assoc param (assoc method tramp-methods))))
7747 (when entry (cadr entry))))
7749 ;; Auto saving to a special directory.
7751 (defun tramp-exists-file-name-handler (operation &rest args)
7752 "Checks whether OPERATION runs a file name handler."
7753 ;; The file name handler is determined on base of either an
7754 ;; argument, `buffer-file-name', or `default-directory'.
7756 (let* ((buffer-file-name "/")
7757 (default-directory "/")
7758 (fnha file-name-handler-alist)
7759 (check-file-name-operation operation)
7760 (file-name-handler-alist
7763 (lambda (operation &rest args)
7764 "Returns OPERATION if it is the one to be checked."
7765 (if (equal check-file-name-operation operation)
7767 (let ((file-name-handler-alist fnha))
7768 (apply operation args))))))))
7769 (equal (apply operation args) operation))
7772 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
7773 (defadvice make-auto-save-file-name
7774 (around tramp-advice-make-auto-save-file-name () activate)
7775 "Invoke `tramp-handle-make-auto-save-file-name' for Tramp files."
7776 (if (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))
7777 ;; We cannot call `tramp-handle-make-auto-save-file-name'
7778 ;; directly, because this would bypass the locking mechanism.
7779 (setq ad-return-value
7780 (tramp-file-name-handler 'make-auto-save-file-name))
7782 (add-hook 'tramp-unload-hook
7783 (lambda () (ad-unadvise 'make-auto-save-file-name))))
7785 ;; In Emacs < 22 and XEmacs < 21.5 autosaved remote files have
7786 ;; permission 0666 minus umask. This is a security threat.
7788 (defun tramp-set-auto-save-file-modes ()
7789 "Set permissions of autosaved remote files to the original permissions."
7790 (let ((bfn (buffer-file-name)))
7791 (when (and (stringp bfn)
7792 (tramp-tramp-file-p bfn)
7794 (stringp buffer-auto-save-file-name)
7795 (not (equal bfn buffer-auto-save-file-name)))
7796 (unless (file-exists-p buffer-auto-save-file-name)
7797 (write-region "" nil buffer-auto-save-file-name))
7798 ;; Permissions should be set always, because there might be an old
7799 ;; auto-saved file belonging to another original file. This could
7800 ;; be a security threat.
7801 (set-file-modes buffer-auto-save-file-name
7802 (or (file-modes bfn) (tramp-octal-to-decimal "0600"))))))
7804 (unless (or (> emacs-major-version 21)
7805 (and (featurep 'xemacs)
7806 (= emacs-major-version 21)
7807 (> emacs-minor-version 4)))
7808 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
7809 (add-hook 'tramp-unload-hook
7811 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
7813 (defun tramp-subst-strs-in-string (alist string)
7814 "Replace all occurrences of the string FROM with TO in STRING.
7815 ALIST is of the form ((FROM . TO) ...)."
7818 (let* ((pr (car alist))
7821 (while (string-match (regexp-quote from) string)
7822 (setq string (replace-match to t t string)))
7823 (setq alist (cdr alist))))
7826 ;; ------------------------------------------------------------
7827 ;; -- Compatibility functions section --
7828 ;; ------------------------------------------------------------
7830 (defun tramp-read-passwd (proc &optional prompt)
7831 "Read a password from user (compat function).
7832 Consults the auth-source package.
7833 Invokes `password-read' if available, `read-passwd' else."
7834 (let* ((key (tramp-make-tramp-file-name
7835 tramp-current-method tramp-current-user
7836 tramp-current-host ""))
7839 (with-current-buffer (process-buffer proc)
7840 (tramp-check-for-regexp proc tramp-password-prompt-regexp)
7841 (format "%s for %s " (capitalize (match-string 1)) key)))))
7844 ;; See if auth-sources contains something useful, if it's bound.
7845 (and (boundp 'auth-sources)
7846 (tramp-get-connection-property proc "first-password-request" nil)
7847 ;; Try with Tramp's current method.
7848 (funcall (symbol-function 'auth-source-user-or-password)
7849 "password" tramp-current-host tramp-current-method))
7850 ;; Try the password cache.
7851 (when (functionp 'password-read)
7852 (unless (tramp-get-connection-property
7853 proc "first-password-request" nil)
7854 (funcall (symbol-function 'password-cache-remove) key))
7856 (funcall (symbol-function 'password-read) pw-prompt key)))
7857 (funcall (symbol-function 'password-cache-add) key password)
7859 ;; Else, get the password interactively.
7860 (read-passwd pw-prompt))
7861 (tramp-set-connection-property proc "first-password-request" nil))))
7863 (defun tramp-clear-passwd (vec)
7864 "Clear password cache for connection related to VEC."
7865 (when (functionp 'password-cache-remove)
7867 (symbol-function 'password-cache-remove)
7868 (tramp-make-tramp-file-name
7869 (tramp-file-name-method vec)
7870 (tramp-file-name-user vec)
7871 (tramp-file-name-host vec)
7874 ;; Snarfed code from time-date.el and parse-time.el
7876 (defconst tramp-half-a-year '(241 17024)
7877 "Evaluated by \"(days-to-time 183)\".")
7879 (defconst tramp-parse-time-months
7880 '(("jan" . 1) ("feb" . 2) ("mar" . 3)
7881 ("apr" . 4) ("may" . 5) ("jun" . 6)
7882 ("jul" . 7) ("aug" . 8) ("sep" . 9)
7883 ("oct" . 10) ("nov" . 11) ("dec" . 12))
7884 "Alist mapping month names to integers.")
7886 (defun tramp-time-less-p (t1 t2)
7887 "Say whether time value T1 is less than time value T2."
7888 (unless t1 (setq t1 '(0 0)))
7889 (unless t2 (setq t2 '(0 0)))
7890 (or (< (car t1) (car t2))
7891 (and (= (car t1) (car t2))
7892 (< (nth 1 t1) (nth 1 t2)))))
7894 (defun tramp-time-subtract (t1 t2)
7895 "Subtract two time values.
7896 Return the difference in the format of a time value."
7897 (unless t1 (setq t1 '(0 0)))
7898 (unless t2 (setq t2 '(0 0)))
7899 (let ((borrow (< (cadr t1) (cadr t2))))
7900 (list (- (car t1) (car t2) (if borrow 1 0))
7901 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2)))))
7903 (defun tramp-time-diff (t1 t2)
7904 "Return the difference between the two times, in seconds.
7905 T1 and T2 are time values (as returned by `current-time' for example)."
7906 ;; Pacify byte-compiler with `symbol-function'.
7907 (cond ((and (fboundp 'subtract-time)
7908 (fboundp 'float-time))
7909 (funcall (symbol-function 'float-time)
7910 (funcall (symbol-function 'subtract-time) t1 t2)))
7911 ((and (fboundp 'subtract-time)
7912 (fboundp 'time-to-seconds))
7913 (funcall (symbol-function 'time-to-seconds)
7914 (funcall (symbol-function 'subtract-time) t1 t2)))
7915 ((fboundp 'itimer-time-difference)
7916 (funcall (symbol-function 'itimer-time-difference)
7917 (if (< (length t1) 3) (append t1 '(0)) t1)
7918 (if (< (length t2) 3) (append t2 '(0)) t2)))
7920 (let ((time (tramp-time-subtract t1 t2)))
7921 (+ (* (car time) 65536.0)
7923 (/ (or (nth 2 time) 0) 1000000.0))))))
7925 (defun tramp-coding-system-change-eol-conversion (coding-system eol-type)
7926 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
7927 EOL-TYPE can be one of `dos', `unix', or `mac'."
7928 (cond ((fboundp 'coding-system-change-eol-conversion)
7929 (funcall (symbol-function 'coding-system-change-eol-conversion)
7930 coding-system eol-type))
7931 ((fboundp 'subsidiary-coding-system)
7932 (funcall (symbol-function 'subsidiary-coding-system)
7934 (cond ((eq eol-type 'dos) 'crlf)
7935 ((eq eol-type 'unix) 'lf)
7936 ((eq eol-type 'mac) 'cr)
7938 (error "Unknown EOL-TYPE `%s', must be %s"
7940 "`dos', `unix', or `mac'")))))
7941 (t (error "Can't change EOL conversion -- is MULE missing?"))))
7943 (defun tramp-set-process-query-on-exit-flag (process flag)
7944 "Specify if query is needed for process when Emacs is exited.
7945 If the second argument flag is non-nil, Emacs will query the user before
7946 exiting if process is running."
7947 (if (fboundp 'set-process-query-on-exit-flag)
7948 (funcall (symbol-function 'set-process-query-on-exit-flag) process flag)
7949 (funcall (symbol-function 'process-kill-without-query) process flag)))
7952 ;; ------------------------------------------------------------
7953 ;; -- Kludges section --
7954 ;; ------------------------------------------------------------
7956 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
7957 ;; does not deal well with newline characters. Newline is replaced by
7958 ;; backslash newline. But if, say, the string `a backslash newline b'
7959 ;; is passed to a shell, the shell will expand this into "ab",
7960 ;; completely omitting the newline. This is not what was intended.
7961 ;; It does not appear to be possible to make the function
7962 ;; `shell-quote-argument' work with newlines without making it
7963 ;; dependent on the shell used. But within this package, we know that
7964 ;; we will always use a Bourne-like shell, so we use an approach which
7967 ;; The approach is simple: we call `shell-quote-argument', then
7968 ;; massage the newline part of the result.
7970 ;; This function should produce a string which is grokked by a Unix
7971 ;; shell, even if the Emacs is running on Windows. Since this is the
7972 ;; kludges section, we bind `system-type' in such a way that
7973 ;; `shell-quote-arguments' behaves as if on Unix.
7975 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
7976 ;; function to work with Bourne-like shells.
7978 ;; CCC: This function should be rewritten so that
7979 ;; `shell-quote-argument' is not used. This way, we are safe from
7980 ;; changes in `shell-quote-argument'.
7981 (defun tramp-shell-quote-argument (s)
7982 "Similar to `shell-quote-argument', but groks newlines.
7983 Only works for Bourne-like shells."
7984 (let ((system-type 'not-windows))
7986 (let ((result (shell-quote-argument s))
7987 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
7988 (when (and (>= (length result) 2)
7989 (string= (substring result 0 2) "\\~"))
7990 (setq result (substring result 1)))
7991 (while (string-match nl result)
7992 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
7996 ;; We currently (sometimes) use "[" and "]" in the filename format.
7997 ;; This means that Emacs wants to expand wildcards if
7998 ;; `find-file-wildcards' is non-nil, and then barfs because no
7999 ;; expansion could be found. We detect this situation and do
8000 ;; something really awful: we have `file-expand-wildcards' return the
8001 ;; original filename if it can't expand anything. Let's just hope
8002 ;; that this doesn't break anything else.
8003 ;; CCC: This check is now also really awful; we should search all
8004 ;; of the filename format, not just the prefix.
8005 (when (string-match "\\[" tramp-prefix-format)
8006 (defadvice file-expand-wildcards
8007 (around tramp-advice-file-expand-wildcards activate)
8008 (let ((name (ad-get-arg 0)))
8009 (if (tramp-tramp-file-p name)
8010 ;; If it's a Tramp file, dissect it and look if wildcards
8011 ;; need to be expanded at all.
8014 (tramp-file-name-localname (tramp-dissect-file-name name)))
8015 (setq ad-return-value (or ad-do-it (list name)))
8016 (setq ad-return-value (list name)))
8017 ;; If it is not a Tramp file, just run the original function.
8018 (setq ad-return-value (or ad-do-it (list name))))))
8019 (add-hook 'tramp-unload-hook
8020 (lambda () (ad-unadvise 'file-expand-wildcards))))
8022 ;; Checklist for `tramp-unload-hook'
8023 ;; - Unload all `tramp-*' packages
8024 ;; - Reset `file-name-handler-alist'
8025 ;; - Cleanup hooks where Tramp functions are in
8026 ;; - Cleanup advised functions
8027 ;; - Cleanup autoloads
8029 (defun tramp-unload-tramp ()
8030 "Discard Tramp from loading remote files."
8032 ;; When Tramp is not loaded yet, its autoloads are still active.
8033 (tramp-unload-file-name-handlers)
8034 ;; ange-ftp settings must be enabled.
8035 (when (functionp 'tramp-ftp-enable-ange-ftp)
8036 (funcall (symbol-function 'tramp-ftp-enable-ange-ftp)))
8037 ;; Maybe its not loaded yet.
8039 (unload-feature 'tramp 'force)
8042 (when (and load-in-progress
8043 (string-match "Loading tramp..." (or (current-message) "")))
8044 (message "Loading tramp...done"))
8050 ;; * Handle nonlocal exits such as C-g.
8051 ;; * But it would probably be better to use with-local-quit at the
8052 ;; place where it's actually needed: around any potentially
8053 ;; indefinitely blocking piece of code. In this case it would be
8054 ;; within Tramp around one of its calls to accept-process-output (or
8055 ;; around one of the loops that calls accept-process-output)
8056 ;; (Stefan Monnier).
8057 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
8058 ;; `shell-quote-argument'.
8059 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
8060 ;; by the files in that directory. Add this here.
8061 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
8062 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
8063 ;; * Case-insensitive filename completion. (Norbert Goevert.)
8064 ;; * Don't use globbing for directories with many files, as this is
8065 ;; likely to produce long command lines, and some shells choke on
8066 ;; long command lines.
8067 ;; * `vc-directory' does not work. It never displays any files, even
8068 ;; if it does show files when run locally.
8069 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
8070 ;; * Grok `append' parameter for `write-region'.
8071 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
8072 ;; * abbreviate-file-name
8073 ;; * Better error checking. At least whenever we see something
8074 ;; strange when doing zerop, we should kill the process and start
8075 ;; again. (Greg Stark)
8076 ;; * Provide a local cache of old versions of remote files for the rsync
8077 ;; transfer method to use. (Greg Stark)
8078 ;; * Remove unneeded parameters from methods.
8079 ;; * Make it work for different encodings, and for different file name
8080 ;; encodings, too. (Daniel Pittman)
8081 ;; * Progress reports while copying files. (Michael Kifer)
8082 ;; * Don't search for perl5 and perl. Instead, only search for perl and
8083 ;; then look if it's the right version (with `perl -v').
8084 ;; * When editing a remote CVS controlled file as a different user, VC
8085 ;; gets confused about the file locking status. Try to find out why
8086 ;; the workaround doesn't work.
8087 ;; * Username and hostname completion.
8088 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
8089 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
8090 ;; Code is nearly identical.
8091 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
8092 ;; until the last but one hop via `start-file-process'. Apply it
8093 ;; also for ftp and smb.
8094 ;; * WIBNI if we had a command "trampclient"? If I was editing in
8095 ;; some shell with root priviledges, it would be nice if I could
8097 ;; trampclient filename.c
8098 ;; as an editor, and the _current_ shell would connect to an Emacs
8099 ;; server and would be used in an existing non-priviledged Emacs
8100 ;; session for doing the editing in question.
8101 ;; That way, I need not tell Emacs my password again and be afraid
8102 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
8103 ;; once display a just typed password in the context of a keyboard
8104 ;; sequence prompt for a question immediately following in a shell
8105 ;; script run within Emacs -- nasty).
8106 ;; And if I have some ssh session running to a different computer,
8107 ;; having the possibility of passing a local file there to a local
8108 ;; Emacs session (in case I can arrange for a connection back) would
8110 ;; Likely the corresponding Tramp server should not allow the
8111 ;; equivalent of the emacsclient -eval option in order to make this
8112 ;; reasonably unproblematic. And maybe trampclient should have some
8113 ;; way of passing credentials, like by using an SSL socket or
8114 ;; something. (David Kastrup)
8115 ;; * Reconnect directly to a compliant shell without first going
8116 ;; through the user's default shell. (Pete Forman)
8117 ;; * Make `tramp-default-user' obsolete.
8118 ;; * Tramp shall reconnect automatically to its ssh connection when it
8119 ;; detects that the process "has died". (David Reitter)
8120 ;; * How can I interrupt the remote process with a signal
8121 ;; (interrupt-process seems not to work)? (Markus Triska)
8122 ;; * Avoid the local shell entirely for starting remote processes. If
8123 ;; so, I think even a signal, when delivered directly to the local
8124 ;; SSH instance, would correctly be propagated to the remote process
8125 ;; automatically; possibly SSH would have to be started with
8126 ;; "-t". (Markus Triska)
8127 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
8128 ;; isn't on the remote host. (Mark A. Hershberger)
8129 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
8130 ;; * Implement a general server-local-variable mechanism, as there are
8131 ;; probably other variables that need different values for different
8132 ;; servers too. The user could then configure a variable (such as
8133 ;; tramp-server-local-variable-alist) to define any such variables
8134 ;; that they need to, which would then be let bound as appropriate
8135 ;; in tramp functions. (Jason Rumney)
8136 ;; * Optimize out-of-band copying, when both methods are scp-like (not
8138 ;; * Keep a second connection open for out-of-band methods like scp or
8140 ;; * Support ptys in `tramp-handle-start-file-process'.
8142 ;; Functions for file-name-handler-alist:
8143 ;; diff-latest-backup-file -- in diff.el
8145 ;; arch-tag: 3a21a994-182b-48fa-b0cd-c1d9fede424a
8146 ;;; tramp.el ends here