1 ;;; -*- mode: Emacs-Lisp; coding: iso-2022-7bit; -*-
2 ;;; tramp.el --- Transparent Remote Access, Multiple Protocol
4 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 ;; 2005, 2006 Free Software Foundation, Inc.
7 ;; Author: Kai Gro
\e,A_
\e(Bjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This package provides remote file editing, similar to ange-ftp.
31 ;; The difference is that ange-ftp uses FTP to transfer files between
32 ;; the local and the remote host, whereas tramp.el uses a combination
33 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
35 ;; For more detailed instructions, please see the info file.
40 ;; This package only works for Emacs 20 and higher, and for XEmacs 21
41 ;; and higher. (XEmacs 20 is missing the `with-timeout' macro. Emacs
42 ;; 19 is reported to have other problems. For XEmacs 21, you need the
43 ;; package `fsf-compat' for the `with-timeout' macro.)
45 ;; This version might not work with pre-Emacs 21 VC unless VC is
46 ;; loaded before tramp.el. Could you please test this and tell me about
47 ;; the result? Thanks.
49 ;; Also see the todo list at the bottom of this file.
51 ;; The current version of Tramp can be retrieved from the following URL:
52 ;; http://ftp.gnu.org/gnu/tramp/
54 ;; There's a mailing list for this, as well. Its name is:
55 ;; tramp-devel@gnu.org
56 ;; You can use the Web to subscribe, under the following URL:
57 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
59 ;; For the adventurous, the current development sources are available
60 ;; via CVS. You can find instructions about this at the following URL:
61 ;; http://savannah.gnu.org/projects/tramp/
62 ;; Click on "CVS" in the navigation bar near the top.
64 ;; Don't forget to put on your asbestos longjohns, first!
68 ;; The Tramp version number and bug report address, as prepared by configure.
70 (add-hook 'tramp-unload-hook
72 (when (featurep 'trampver)
73 (unload-feature 'trampver 'force))))
75 (if (featurep 'xemacs)
76 (require 'timer-funcs)
79 (require 'format-spec) ;from Gnus 5.8, also in tar ball
80 ;; As long as password.el is not part of (X)Emacs, it shouldn't
82 (if (featurep 'xemacs)
83 (load "password" 'noerror)
84 (require 'password nil 'noerror)) ;from No Gnus, also in tar ball
86 ;; The explicit check is not necessary in Emacs, which provides the
87 ;; feature even if implemented in C, but it appears to be necessary
89 (unless (and (fboundp 'base64-encode-region)
90 (fboundp 'base64-decode-region))
91 (require 'base64)) ;for the mimencode methods
95 (autoload 'tramp-uuencode-region "tramp-uu"
96 "Implementation of `uuencode' in Lisp.")
97 (add-hook 'tramp-unload-hook
99 (when (featurep 'tramp-uu)
100 (unload-feature 'tramp-uu 'force))))
102 (unless (fboundp 'uudecode-decode-region)
103 (autoload 'uudecode-decode-region "uudecode"))
105 ;; XEmacs is distributed with few Lisp packages. Further packages are
106 ;; installed using EFS. If we use a unified filename format, then
107 ;; Tramp is required in addition to EFS. (But why can't Tramp just
108 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
109 ;; just like before.) Another reason for using a separate filename
110 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
111 ;; Tramp only knows how to deal with `file-name-handler-alist', not
114 (defvar tramp-unified-filenames (not (featurep 'xemacs))
115 "Non-nil means to use unified Ange-FTP/Tramp filename syntax.
116 Nil means to use a separate filename syntax for Tramp.")
118 ;; Load foreign methods. Because they do require Tramp internally, this
119 ;; must be done with the `eval-after-load' trick.
121 ;; tramp-ftp supports Ange-FTP only. Not suited for XEmacs therefore.
122 (unless (featurep 'xemacs)
123 (eval-after-load "tramp"
126 (add-hook 'tramp-unload-hook
128 (when (featurep 'tramp-ftp)
129 (unload-feature 'tramp-ftp 'force)))))))
130 (when (and tramp-unified-filenames (featurep 'xemacs))
131 (eval-after-load "tramp"
134 (add-hook 'tramp-unload-hook
136 (when (featurep 'tramp-efs)
137 (unload-feature 'tramp-efs 'force)))))))
139 ;; tramp-smb uses "smbclient" from Samba.
140 ;; Not available under Cygwin and Windows, because they don't offer
141 ;; "smbclient". And even not necessary there, because Emacs supports
142 ;; UNC file names like "//host/share/localname".
143 (unless (memq system-type '(cygwin windows-nt))
144 (eval-after-load "tramp"
147 (add-hook 'tramp-unload-hook
149 (when (featurep 'tramp-smb)
150 (unload-feature 'tramp-smb 'force)))))))
155 ;; Emacs 19.34 compatibility hack -- is this needed?
156 (or (>= emacs-major-version 20)
159 (unless (boundp 'custom-print-functions)
160 (defvar custom-print-functions nil)) ; not autoloaded before Emacs 20.4
162 ;; Avoid byte-compiler warnings if the byte-compiler supports this.
163 ;; Currently, XEmacs supports this.
165 (when (featurep 'xemacs)
166 (let (unused-vars) ; Pacify Emacs byte-compiler
167 (defalias 'warnings 'identity) ; Pacify Emacs byte-compiler
168 (byte-compiler-options (warnings (- unused-vars))))))
170 ;; `directory-sep-char' is an obsolete variable in Emacs. But it is
171 ;; used in XEmacs, so we set it here and there. The following is needed
172 ;; to pacify Emacs byte-compiler.
174 (when (boundp 'byte-compile-not-obsolete-var)
175 (setq byte-compile-not-obsolete-var 'directory-sep-char)))
177 ;;; User Customizable Internal Variables:
180 "Edit remote files with a combination of rsh and rcp or similar programs."
184 (defcustom tramp-verbose 9
185 "*Verbosity level for tramp.el. 0 means be silent, 10 is most verbose."
189 (defcustom tramp-debug-buffer nil
190 "*Whether to send all commands and responses to a debug buffer."
196 (when (boundp 'backup-directory-alist)
197 (defcustom tramp-backup-directory-alist nil
198 "Alist of filename patterns and backup directory names.
199 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
200 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
201 is a local file name, the backup directory is prepended with Tramp file
202 name prefix \(multi-method, method, user, host\) of file.
204 \(setq tramp-backup-directory-alist backup-directory-alist\)
206 gives the same backup policy for Tramp files on their hosts like the
207 policy for local files."
209 :type '(repeat (cons (regexp :tag "Regexp matching filename")
210 (directory :tag "Backup directory name"))))))
212 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
213 ;; the package "backup-dir" might not be loaded yet.
215 (when (featurep 'xemacs)
216 (defcustom tramp-bkup-backup-directory-info nil
217 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
218 It has the same meaning like `bkup-backup-directory-info' from package
219 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
220 file name, the backup directory is prepended with Tramp file name prefix
221 \(multi-method, method, user, host\) of file.
223 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
225 gives the same backup policy for Tramp files on their hosts like the
226 policy for local files."
228 (list (regexp :tag "File regexp")
229 (string :tag "Backup Dir")
234 (const search-upward))))
237 (defcustom tramp-auto-save-directory nil
238 "*Put auto-save files in this directory, if set.
239 The idea is to use a local directory so that auto-saving is faster."
241 :type '(choice (const nil)
244 (defcustom tramp-encoding-shell
245 (if (memq system-type '(windows-nt))
248 "*Use this program for encoding and decoding commands on the local host.
249 This shell is used to execute the encoding and decoding command on the
250 local host, so if you want to use `~' in those commands, you should
251 choose a shell here which groks tilde expansion. `/bin/sh' normally
252 does not understand tilde expansion.
254 For encoding and deocding, commands like the following are executed:
256 /bin/sh -c COMMAND < INPUT > OUTPUT
258 This variable can be used to change the \"/bin/sh\" part. See the
259 variable `tramp-encoding-command-switch' for the \"-c\" part. Also, see the
260 variable `tramp-encoding-reads-stdin' to specify whether the commands read
261 standard input or a file.
263 Note that this variable is not used for remote commands. There are
264 mechanisms in tramp.el which automatically determine the right shell to
265 use for the remote host."
267 :type '(file :must-match t))
269 (defcustom tramp-encoding-command-switch
270 (if (string-match "cmd\\.exe" tramp-encoding-shell)
273 "*Use this switch together with `tramp-encoding-shell' for local commands.
274 See the variable `tramp-encoding-shell' for more information."
278 (defcustom tramp-encoding-reads-stdin t
279 "*If non-nil, encoding commands read from standard input.
280 If nil, the filename is the last argument.
282 Note that the commands always must write to standard output."
286 (defcustom tramp-multi-sh-program
288 "*Use this program for bootstrapping multi-hop connections.
289 This variable is similar to `tramp-encoding-shell', but it is only used
290 when initializing a multi-hop connection. Therefore, the set of
291 commands sent to this shell is quite restricted, and if you are
292 careful it works to use CMD.EXE under Windows (instead of a Bourne-ish
293 shell which does not normally exist on Windows anyway).
295 To use multi-hop methods from Windows, you also need suitable entries
296 in `tramp-multi-connection-function-alist' for the first hop.
298 This variable defaults to the value of `tramp-encoding-shell'."
300 :type '(file :must-match t))
302 ;; CCC I have changed all occurrences of comint-quote-filename with
303 ;; tramp-shell-quote-argument, except in tramp-handle-expand-many-files.
304 ;; There, comint-quote-filename was removed altogether. If it turns
305 ;; out to be necessary there, something will need to be done.
306 ;;-(defcustom tramp-file-name-quote-list
307 ;;- '(?] ?[ ?\| ?& ?< ?> ?\( ?\) ?\; ?\ ?\* ?\? ?\! ?\" ?\' ?\` ?# ?\@ ?\+ )
308 ;;- "*Protect these characters from the remote shell.
309 ;;-Any character in this list is quoted (preceded with a backslash)
310 ;;-because it means something special to the shell. This takes effect
311 ;;-when sending file and directory names to the remote shell.
313 ;;-See `comint-file-name-quote-list' for details."
315 ;;- :type '(repeat character))
317 (defcustom tramp-methods
318 '( ("rcp" (tramp-connection-function tramp-open-connection-rsh)
319 (tramp-login-program "rsh")
320 (tramp-copy-program "rcp")
321 (tramp-remote-sh "/bin/sh")
322 (tramp-login-args nil)
323 (tramp-copy-args nil)
324 (tramp-copy-keep-date-arg "-p")
325 (tramp-password-end-of-line nil))
326 ("scp" (tramp-connection-function tramp-open-connection-rsh)
327 (tramp-login-program "ssh")
328 (tramp-copy-program "scp")
329 (tramp-remote-sh "/bin/sh")
330 (tramp-login-args ("-e" "none"))
331 (tramp-copy-args nil)
332 (tramp-copy-keep-date-arg "-p")
333 (tramp-password-end-of-line nil))
334 ("scp1" (tramp-connection-function tramp-open-connection-rsh)
335 (tramp-login-program "ssh")
336 (tramp-copy-program "scp")
337 (tramp-remote-sh "/bin/sh")
338 (tramp-login-args ("-1" "-e" "none"))
339 (tramp-copy-args ("-1"))
340 (tramp-copy-keep-date-arg "-p")
341 (tramp-password-end-of-line nil))
342 ("scp2" (tramp-connection-function tramp-open-connection-rsh)
343 (tramp-login-program "ssh")
344 (tramp-copy-program "scp")
345 (tramp-remote-sh "/bin/sh")
346 (tramp-login-args ("-2" "-e" "none"))
347 (tramp-copy-args ("-2"))
348 (tramp-copy-keep-date-arg "-p")
349 (tramp-password-end-of-line nil))
351 (tramp-connection-function tramp-open-connection-rsh)
352 (tramp-login-program "ssh1")
353 (tramp-copy-program "scp1")
354 (tramp-remote-sh "/bin/sh")
355 (tramp-login-args ("-e" "none"))
356 (tramp-copy-args nil)
357 (tramp-copy-keep-date-arg "-p")
358 (tramp-password-end-of-line nil))
360 (tramp-connection-function tramp-open-connection-rsh)
361 (tramp-login-program "ssh2")
362 (tramp-copy-program "scp2")
363 (tramp-remote-sh "/bin/sh")
364 (tramp-login-args ("-e" "none"))
365 (tramp-copy-args nil)
366 (tramp-copy-keep-date-arg "-p")
367 (tramp-password-end-of-line nil))
368 ("rsync" (tramp-connection-function tramp-open-connection-rsh)
369 (tramp-login-program "ssh")
370 (tramp-copy-program "rsync")
371 (tramp-remote-sh "/bin/sh")
372 (tramp-login-args ("-e" "none"))
373 (tramp-copy-args ("-e" "ssh"))
374 (tramp-copy-keep-date-arg "-t")
375 (tramp-password-end-of-line nil))
376 ("remcp" (tramp-connection-function tramp-open-connection-rsh)
377 (tramp-login-program "remsh")
378 (tramp-copy-program "rcp")
379 (tramp-remote-sh "/bin/sh")
380 (tramp-login-args nil)
381 (tramp-copy-args nil)
382 (tramp-copy-keep-date-arg "-p")
383 (tramp-password-end-of-line nil))
384 ("rsh" (tramp-connection-function tramp-open-connection-rsh)
385 (tramp-login-program "rsh")
386 (tramp-copy-program nil)
387 (tramp-remote-sh "/bin/sh")
388 (tramp-login-args nil)
389 (tramp-copy-args nil)
390 (tramp-copy-keep-date-arg nil)
391 (tramp-password-end-of-line nil))
392 ("ssh" (tramp-connection-function tramp-open-connection-rsh)
393 (tramp-login-program "ssh")
394 (tramp-copy-program nil)
395 (tramp-remote-sh "/bin/sh")
396 (tramp-login-args ("-e" "none"))
397 (tramp-copy-args nil)
398 (tramp-copy-keep-date-arg nil)
399 (tramp-password-end-of-line nil))
400 ("ssh1" (tramp-connection-function tramp-open-connection-rsh)
401 (tramp-login-program "ssh")
402 (tramp-copy-program nil)
403 (tramp-remote-sh "/bin/sh")
404 (tramp-login-args ("-1" "-e" "none"))
405 (tramp-copy-args ("-1"))
406 (tramp-copy-keep-date-arg nil)
407 (tramp-password-end-of-line nil))
408 ("ssh2" (tramp-connection-function tramp-open-connection-rsh)
409 (tramp-login-program "ssh")
410 (tramp-copy-program nil)
411 (tramp-remote-sh "/bin/sh")
412 (tramp-login-args ("-2" "-e" "none"))
413 (tramp-copy-args ("-2"))
414 (tramp-copy-keep-date-arg nil)
415 (tramp-password-end-of-line nil))
417 (tramp-connection-function tramp-open-connection-rsh)
418 (tramp-login-program "ssh1")
419 (tramp-copy-program nil)
420 (tramp-remote-sh "/bin/sh")
421 (tramp-login-args ("-e" "none"))
422 (tramp-copy-args nil)
423 (tramp-copy-keep-date-arg nil)
424 (tramp-password-end-of-line nil))
426 (tramp-connection-function tramp-open-connection-rsh)
427 (tramp-login-program "ssh2")
428 (tramp-copy-program nil)
429 (tramp-remote-sh "/bin/sh")
430 (tramp-login-args ("-e" "none"))
431 (tramp-copy-args nil)
432 (tramp-copy-keep-date-arg nil)
433 (tramp-password-end-of-line nil))
434 ("remsh" (tramp-connection-function tramp-open-connection-rsh)
435 (tramp-login-program "remsh")
436 (tramp-copy-program nil)
437 (tramp-remote-sh "/bin/sh")
438 (tramp-login-args nil)
439 (tramp-copy-args nil)
440 (tramp-copy-keep-date-arg nil)
441 (tramp-password-end-of-line nil))
443 (tramp-connection-function tramp-open-connection-telnet)
444 (tramp-login-program "telnet")
445 (tramp-copy-program nil)
446 (tramp-remote-sh "/bin/sh")
447 (tramp-login-args nil)
448 (tramp-copy-args nil)
449 (tramp-copy-keep-date-arg nil)
450 (tramp-password-end-of-line nil))
451 ("su" (tramp-connection-function tramp-open-connection-su)
452 (tramp-login-program "su")
453 (tramp-copy-program nil)
454 (tramp-remote-sh "/bin/sh")
455 (tramp-login-args ("-" "%u"))
456 (tramp-copy-args nil)
457 (tramp-copy-keep-date-arg nil)
458 (tramp-password-end-of-line nil))
459 ("sudo" (tramp-connection-function tramp-open-connection-su)
460 (tramp-login-program "sudo")
461 (tramp-copy-program nil)
462 (tramp-remote-sh "/bin/sh")
463 (tramp-login-args ("-u" "%u" "-s"
465 (tramp-copy-args nil)
466 (tramp-copy-keep-date-arg nil)
467 (tramp-password-end-of-line nil))
468 ("multi" (tramp-connection-function tramp-open-connection-multi)
469 (tramp-login-program nil)
470 (tramp-copy-program nil)
471 (tramp-remote-sh "/bin/sh")
472 (tramp-login-args nil)
473 (tramp-copy-args nil)
474 (tramp-copy-keep-date-arg nil)
475 (tramp-password-end-of-line nil))
476 ("scpx" (tramp-connection-function tramp-open-connection-rsh)
477 (tramp-login-program "ssh")
478 (tramp-copy-program "scp")
479 (tramp-remote-sh "/bin/sh")
480 (tramp-login-args ("-e" "none" "-t" "-t" "/bin/sh"))
481 (tramp-copy-args nil)
482 (tramp-copy-keep-date-arg "-p")
483 (tramp-password-end-of-line nil))
484 ("sshx" (tramp-connection-function tramp-open-connection-rsh)
485 (tramp-login-program "ssh")
486 (tramp-copy-program nil)
487 (tramp-remote-sh "/bin/sh")
488 (tramp-login-args ("-e" "none" "-t" "-t" "/bin/sh"))
489 (tramp-copy-args nil)
490 (tramp-copy-keep-date-arg nil)
491 (tramp-password-end-of-line nil))
493 (tramp-connection-function tramp-open-connection-rsh)
494 (tramp-login-program "krlogin")
495 (tramp-copy-program nil)
496 (tramp-remote-sh "/bin/sh")
497 (tramp-login-args ("-x"))
498 (tramp-copy-args nil)
499 (tramp-copy-keep-date-arg nil)
500 (tramp-password-end-of-line nil))
502 (tramp-connection-function tramp-open-connection-rsh)
503 (tramp-login-program "plink")
504 (tramp-copy-program nil)
505 (tramp-remote-sh "/bin/sh")
506 (tramp-login-args ("-ssh")) ;optionally add "-v"
507 (tramp-copy-args nil)
508 (tramp-copy-keep-date-arg nil)
509 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
511 (tramp-connection-function tramp-open-connection-rsh)
512 (tramp-login-program "plink")
513 (tramp-copy-program nil)
514 (tramp-remote-sh "/bin/sh")
515 (tramp-login-args ("-1" "-ssh")) ;optionally add "-v"
516 (tramp-copy-args nil)
517 (tramp-copy-keep-date-arg nil)
518 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
520 (tramp-connection-function tramp-open-connection-rsh)
521 (tramp-login-program "plink")
522 (tramp-copy-program "pscp")
523 (tramp-remote-sh "/bin/sh")
524 (tramp-login-args ("-ssh"))
525 (tramp-copy-args nil)
526 (tramp-copy-keep-date-arg "-p")
527 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
529 (tramp-connection-function tramp-open-connection-rsh)
530 (tramp-login-program "fsh")
531 (tramp-copy-program "fcp")
532 (tramp-remote-sh "/bin/sh -i")
533 (tramp-login-args ("sh" "-i"))
534 (tramp-copy-args nil)
535 (tramp-copy-keep-date-arg "-p")
536 (tramp-password-end-of-line nil))
538 "*Alist of methods for remote files.
539 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
540 Each NAME stands for a remote access method. Each PARAM is a
541 pair of the form (KEY VALUE). The following KEYs are defined:
542 * `tramp-connection-function'
543 This specifies the function to use to connect to the remote host.
544 Currently, `tramp-open-connection-rsh', `tramp-open-connection-telnet'
545 and `tramp-open-connection-su' are defined. See the documentation
546 of these functions for more details.
548 This specifies the Bourne shell to use on the remote host. This
549 MUST be a Bourne-like shell. It is normally not necessary to set
550 this to any value other than \"/bin/sh\": tramp wants to use a shell
551 which groks tilde expansion, but it can search for it. Also note
552 that \"/bin/sh\" exists on all Unixen, this might not be true for
553 the value that you decide to use. You Have Been Warned.
554 * `tramp-login-program'
555 This specifies the name of the program to use for logging in to the
556 remote host. Depending on `tramp-connection-function', this may be
557 the name of rsh or a workalike program (when
558 `tramp-connection-function' is `tramp-open-connection-rsh'), or the
559 name of telnet or a workalike (for `tramp-open-connection-telnet'),
560 or the name of su or a workalike (for `tramp-open-connection-su').
562 This specifies the list of arguments to pass to the above
563 mentioned program. Please note that this is a list of arguments,
564 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
565 here. Instead, you want two list elements, one for \"-a\" and one
566 for \"-b\", or one for \"-f\" and one for \"foo\".
567 If `tramp-connection-function' is `tramp-open-connection-su', then
568 \"%u\" in this list is replaced by the user name, and \"%%\" can
569 be used to obtain a literal percent character.
570 * `tramp-copy-program'
571 This specifies the name of the program to use for remotely copying
572 the file; this might be the absolute filename of rcp or the name of
575 This specifies the list of parameters to pass to the above mentioned
576 program, the hints for `tramp-login-args' also apply here.
577 * `tramp-copy-keep-date-arg'
578 This specifies the parameter to use for the copying program when the
579 timestamp of the original file should be kept. For `rcp', use `-p', for
581 * `tramp-password-end-of-line'
582 This specifies the string to use for terminating the line after
583 submitting the password. If this method parameter is nil, then the
584 value of the normal variable `tramp-default-password-end-of-line'
585 is used. This parameter is necessary because the \"plink\" program
586 requires any two characters after sending the password. These do
587 not have to be newline or carriage return characters. Other login
588 programs are happy with just one character, the newline character.
589 We use \"xy\" as the value for methods using \"plink\".
591 What does all this mean? Well, you should specify `tramp-login-program'
592 for all methods; this program is used to log in to the remote site. Then,
593 there are two ways to actually transfer the files between the local and the
594 remote side. One way is using an additional rcp-like program. If you want
595 to do this, set `tramp-copy-program' in the method.
597 Another possibility for file transfer is inline transfer, i.e. the
598 file is passed through the same buffer used by `tramp-login-program'. In
599 this case, the file contents need to be protected since the
600 `tramp-login-program' might use escape codes or the connection might not
601 be eight-bit clean. Therefore, file contents are encoded for transit.
602 See the variable `tramp-coding-commands' for details.
604 So, to summarize: if the method is an out-of-band method, then you
605 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
606 inline method, then these two parameters should be nil. Every method,
607 inline or out of band, must specify `tramp-connection-function' plus
608 the associated arguments (for example, the login program if you chose
609 `tramp-open-connection-telnet').
613 When using `tramp-open-connection-su' the phrase `open connection to a
614 remote host' sounds strange, but it is used nevertheless, for
615 consistency. No connection is opened to a remote host, but `su' is
616 started on the local host. You are not allowed to specify a remote
617 host other than `localhost' or the name of the local host."
621 (set (list (const tramp-connection-function) function)
622 (list (const tramp-login-program)
623 (choice (const nil) string))
624 (list (const tramp-copy-program)
625 (choice (const nil) string))
626 (list (const tramp-remote-sh)
627 (choice (const nil) string))
628 (list (const tramp-login-args) (repeat string))
629 (list (const tramp-copy-args) (repeat string))
630 (list (const tramp-copy-keep-date-arg)
631 (choice (const nil) string))
632 (list (const tramp-encoding-command)
633 (choice (const nil) string))
634 (list (const tramp-decoding-command)
635 (choice (const nil) string))
636 (list (const tramp-encoding-function)
637 (choice (const nil) function))
638 (list (const tramp-decoding-function)
639 (choice (const nil) function))
640 (list (const tramp-password-end-of-line)
641 (choice (const nil) string))))))
643 (defcustom tramp-multi-methods '("multi" "multiu")
644 "*List of multi-hop methods.
645 Each entry in this list should be a method name as mentioned in the
646 variable `tramp-methods'."
648 :type '(repeat string))
650 (defcustom tramp-multi-connection-function-alist
651 '(("telnet" tramp-multi-connect-telnet "telnet %h%n")
652 ("rsh" tramp-multi-connect-rlogin "rsh %h -l %u%n")
653 ("remsh" tramp-multi-connect-rlogin "remsh %h -l %u%n")
654 ("ssh" tramp-multi-connect-rlogin "ssh %h -l %u%n")
655 ("ssht" tramp-multi-connect-rlogin "ssh %h -e none -t -t -l %u%n")
656 ("su" tramp-multi-connect-su "su - %u%n")
657 ("sudo" tramp-multi-connect-su "sudo -u %u -s -p Password:%n"))
658 "*List of connection functions for multi-hop methods.
659 Each list item is a list of three items (METHOD FUNCTION COMMAND),
660 where METHOD is the name as used in the file name, FUNCTION is the
661 function to be executed, and COMMAND is the shell command used for
664 COMMAND may contain percent escapes. `%u' will be replaced with the
665 user name, `%h' will be replaced with the host name, and `%n' will be
666 replaced with an end-of-line character, as specified in the variable
667 `tramp-rsh-end-of-line'. Use `%%' for a literal percent character.
668 Note that the interpretation of the percent escapes also depends on
669 the FUNCTION. For example, the `%u' escape is forbidden with the
670 function `tramp-multi-connect-telnet'. See the documentation of the
671 various functions for details."
673 :type '(repeat (list string function string)))
675 (defcustom tramp-default-method
676 (if (and (fboundp 'executable-find)
677 (executable-find "plink"))
680 "*Default method to use for transferring files.
681 See `tramp-methods' for possibilities.
682 Also see `tramp-default-method-alist'."
686 (defcustom tramp-default-method-alist
687 '(("\\`localhost\\'" "\\`root\\'" "su"))
688 "*Default method to use for specific user/host pairs.
689 This is an alist of items (HOST USER METHOD). The first matching item
690 specifies the method to use for a file name which does not specify a
691 method. HOST and USER are regular expressions or nil, which is
692 interpreted as a regular expression which always matches. If no entry
693 matches, the variable `tramp-default-method' takes effect.
695 If the file name does not specify the user, lookup is done using the
696 empty string for the user name.
698 See `tramp-methods' for a list of possibilities for METHOD."
700 :type '(repeat (list (regexp :tag "Host regexp")
701 (regexp :tag "User regexp")
702 (string :tag "Method"))))
704 ;; Default values for non-Unices seeked
705 (defconst tramp-completion-function-alist-rsh
706 (unless (memq system-type '(windows-nt))
707 '((tramp-parse-rhosts "/etc/hosts.equiv")
708 (tramp-parse-rhosts "~/.rhosts")))
709 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
711 ;; Default values for non-Unices seeked
712 (defconst tramp-completion-function-alist-ssh
713 (unless (memq system-type '(windows-nt))
714 '((tramp-parse-rhosts "/etc/hosts.equiv")
715 (tramp-parse-rhosts "/etc/shosts.equiv")
716 (tramp-parse-shosts "/etc/ssh_known_hosts")
717 (tramp-parse-sconfig "/etc/ssh_config")
718 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
719 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
720 (tramp-parse-rhosts "~/.rhosts")
721 (tramp-parse-rhosts "~/.shosts")
722 (tramp-parse-shosts "~/.ssh/known_hosts")
723 (tramp-parse-sconfig "~/.ssh/config")
724 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
725 (tramp-parse-sknownhosts "~/.ssh2/knownhosts")))
726 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
728 ;; Default values for non-Unices seeked
729 (defconst tramp-completion-function-alist-telnet
730 (unless (memq system-type '(windows-nt))
731 '((tramp-parse-hosts "/etc/hosts")))
732 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
734 ;; Default values for non-Unices seeked
735 (defconst tramp-completion-function-alist-su
736 (unless (memq system-type '(windows-nt))
737 '((tramp-parse-passwd "/etc/passwd")))
738 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
740 (defvar tramp-completion-function-alist nil
741 "*Alist of methods for remote files.
742 This is a list of entries of the form (NAME PAIR1 PAIR2 ...).
743 Each NAME stands for a remote access method. Each PAIR is of the form
744 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
745 names from FILE for completion. The following predefined FUNCTIONs exists:
747 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
748 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
749 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
750 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
751 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
752 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
753 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
754 * `tramp-parse-netrc' for \"~/.netrc\" like files.
756 FUNCTION can also be a customer defined function. For more details see
759 (eval-after-load "tramp"
761 (tramp-set-completion-function
762 "rcp" tramp-completion-function-alist-rsh)
763 (tramp-set-completion-function
764 "scp" tramp-completion-function-alist-ssh)
765 (tramp-set-completion-function
766 "scp1" tramp-completion-function-alist-ssh)
767 (tramp-set-completion-function
768 "scp2" tramp-completion-function-alist-ssh)
769 (tramp-set-completion-function
770 "scp1_old" tramp-completion-function-alist-ssh)
771 (tramp-set-completion-function
772 "scp2_old" tramp-completion-function-alist-ssh)
773 (tramp-set-completion-function
774 "rsync" tramp-completion-function-alist-rsh)
775 (tramp-set-completion-function
776 "remcp" tramp-completion-function-alist-rsh)
777 (tramp-set-completion-function
778 "rsh" tramp-completion-function-alist-rsh)
779 (tramp-set-completion-function
780 "ssh" tramp-completion-function-alist-ssh)
781 (tramp-set-completion-function
782 "ssh1" tramp-completion-function-alist-ssh)
783 (tramp-set-completion-function
784 "ssh2" tramp-completion-function-alist-ssh)
785 (tramp-set-completion-function
786 "ssh1_old" tramp-completion-function-alist-ssh)
787 (tramp-set-completion-function
788 "ssh2_old" tramp-completion-function-alist-ssh)
789 (tramp-set-completion-function
790 "remsh" tramp-completion-function-alist-rsh)
791 (tramp-set-completion-function
792 "telnet" tramp-completion-function-alist-telnet)
793 (tramp-set-completion-function
794 "su" tramp-completion-function-alist-su)
795 (tramp-set-completion-function
796 "sudo" tramp-completion-function-alist-su)
797 (tramp-set-completion-function
799 (tramp-set-completion-function
800 "scpx" tramp-completion-function-alist-ssh)
801 (tramp-set-completion-function
802 "sshx" tramp-completion-function-alist-ssh)
803 (tramp-set-completion-function
804 "krlogin" tramp-completion-function-alist-rsh)
805 (tramp-set-completion-function
806 "plink" tramp-completion-function-alist-ssh)
807 (tramp-set-completion-function
808 "plink1" tramp-completion-function-alist-ssh)
809 (tramp-set-completion-function
810 "pscp" tramp-completion-function-alist-ssh)
811 (tramp-set-completion-function
812 "fcp" tramp-completion-function-alist-ssh)))
814 (defcustom tramp-rsh-end-of-line "\n"
815 "*String used for end of line in rsh connections.
816 I don't think this ever needs to be changed, so please tell me about it
817 if you need to change this.
818 Also see the method parameter `tramp-password-end-of-line' and the normal
819 variable `tramp-default-password-end-of-line'."
823 (defcustom tramp-default-password-end-of-line
824 tramp-rsh-end-of-line
825 "*String used for end of line after sending a password.
826 This variable provides the default value for the method parameter
827 `tramp-password-end-of-line', see `tramp-methods' for more details.
829 It seems that people using plink under Windows need to send
830 \"\\r\\n\" (carriage-return, then newline) after a password, but just
831 \"\\n\" after all other lines. This variable can be used for the
832 password, see `tramp-rsh-end-of-line' for the other cases.
834 The default value is to use the same value as `tramp-rsh-end-of-line'."
838 (defcustom tramp-remote-path
839 ;; "/usr/xpg4/bin" has been placed first, because on Solaris a POSIX
840 ;; compatible "id" is needed.
841 '("/usr/xpg4/bin" "/bin" "/usr/bin" "/usr/sbin" "/usr/local/bin"
842 "/usr/ccs/bin" "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
843 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin")
844 "*List of directories to search for executables on remote host.
845 Please notify me about other semi-standard directories to include here.
847 You can use `~' in this list, but when searching for a shell which groks
848 tilde expansion, all directory names starting with `~' will be ignored."
850 :type '(repeat string))
852 (defcustom tramp-login-prompt-regexp
853 ".*ogin\\( .*\\)?: *"
854 "*Regexp matching login-like prompts.
855 The regexp should match at end of buffer.
857 Sometimes the prompt is reported to look like \"login as:\"."
861 (defcustom tramp-shell-prompt-pattern
862 "^[^#$%>\n]*[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*"
863 "Regexp to match prompts from remote shell.
864 Normally, Tramp expects you to configure `shell-prompt-pattern'
865 correctly, but sometimes it happens that you are connecting to a
866 remote host which sends a different kind of shell prompt. Therefore,
867 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
868 and also things matched by this variable. The default value of this
869 variable is similar to the default value of `shell-prompt-pattern',
870 which should work well in many cases."
874 (defcustom tramp-password-prompt-regexp
875 "^.*\\([pP]assword\\|passphrase\\).*:\^@? *"
876 "*Regexp matching password-like prompts.
877 The regexp should match at end of buffer.
879 The `sudo' program appears to insert a `^@' character into the prompt."
883 (defcustom tramp-wrong-passwd-regexp
885 ;; These strings should be on the last line
886 (regexp-opt '("Permission denied."
892 "Name or service not known"
893 "Host key verification failed.") t)
897 ;; Here comes a list of regexes, separated by \\|
898 "Received signal [0-9]+"
900 "*Regexp matching a `login failed' message.
901 The regexp should match at end of buffer."
905 (defcustom tramp-yesno-prompt-regexp
907 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
909 "Regular expression matching all yes/no queries which need to be confirmed.
910 The confirmation should be done with yes or no.
911 The regexp should match at end of buffer.
912 See also `tramp-yn-prompt-regexp'."
916 (defcustom tramp-yn-prompt-regexp
917 (concat (regexp-opt '("Store key in cache? (y/n)") t)
919 "Regular expression matching all y/n queries which need to be confirmed.
920 The confirmation should be done with y or n.
921 The regexp should match at end of buffer.
922 See also `tramp-yesno-prompt-regexp'."
926 (defcustom tramp-terminal-prompt-regexp
930 "Terminal type\\? \\[.*\\]"
932 "Regular expression matching all terminal setting prompts.
933 The regexp should match at end of buffer.
934 The answer will be provided by `tramp-action-terminal', which see."
938 (defcustom tramp-operation-not-permitted-regexp
939 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
940 (regexp-opt '("Operation not permitted") t))
941 "Regular expression matching keep-date problems in (s)cp operations.
942 Copying has been performed successfully already, so this message can
947 (defcustom tramp-process-alive-regexp
949 "Regular expression indicating a process has finished.
950 In fact this expression is empty by intention, it will be used only to
951 check regularly the status of the associated process.
952 The answer will be provided by `tramp-action-process-alive',
953 `tramp-multi-action-process-alive' and`tramp-action-out-of-band', which see."
957 (defcustom tramp-temp-name-prefix "tramp."
958 "*Prefix to use for temporary files.
959 If this is a relative file name (such as \"tramp.\"), it is considered
960 relative to the directory name returned by the function
961 `tramp-temporary-file-directory' (which see). It may also be an
962 absolute file name; don't forget to include a prefix for the filename
967 (defcustom tramp-discard-garbage nil
968 "*If non-nil, try to discard garbage sent by remote shell.
969 Some shells send such garbage upon connection setup."
973 (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
974 "*Alist specifying extra arguments to pass to the remote shell.
975 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
976 matching the shell file name and ARGS is a string specifying the
979 This variable is only used when Tramp needs to start up another shell
980 for tilde expansion. The extra arguments should typically prevent the
981 shell from reading its init file."
983 ;; This might be the wrong way to test whether the widget type
984 ;; `alist' is available. Who knows the right way to test it?
985 :type (if (get 'alist 'widget-type)
986 '(alist :key-type string :value-type string)
987 '(repeat (cons string string))))
989 (defcustom tramp-prefix-format
990 (if tramp-unified-filenames "/" "/[")
991 "*String matching the very beginning of tramp file names.
992 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
996 (defcustom tramp-prefix-regexp
997 (concat "^" (regexp-quote tramp-prefix-format))
998 "*Regexp matching the very beginning of tramp file names.
999 Should always start with \"^\". Derived from `tramp-prefix-format'."
1003 (defcustom tramp-method-regexp
1005 "*Regexp matching methods identifiers."
1009 ;; It is a little bit annoying that in XEmacs case this delimeter is different
1010 ;; for single-hop and multi-hop cases.
1011 (defcustom tramp-postfix-single-method-format
1012 (if tramp-unified-filenames ":" "/")
1013 "*String matching delimeter between method and user or host names.
1014 Applicable for single-hop methods.
1015 Used in `tramp-make-tramp-file-name'."
1019 (defcustom tramp-postfix-single-method-regexp
1020 (regexp-quote tramp-postfix-single-method-format)
1021 "*Regexp matching delimeter between method and user or host names.
1022 Applicable for single-hop methods.
1023 Derived from `tramp-postfix-single-method-format'."
1027 (defcustom tramp-postfix-multi-method-format
1029 "*String matching delimeter between method and user or host names.
1030 Applicable for multi-hop methods.
1031 Used in `tramp-make-tramp-multi-file-name'."
1035 (defcustom tramp-postfix-multi-method-regexp
1036 (regexp-quote tramp-postfix-multi-method-format)
1037 "*Regexp matching delimeter between method and user or host names.
1038 Applicable for multi-hop methods.
1039 Derived from `tramp-postfix-multi-method-format'."
1043 (defcustom tramp-postfix-multi-hop-format
1044 (if tramp-unified-filenames ":" "/")
1045 "*String matching delimeter between host and next method.
1046 Applicable for multi-hop methods.
1047 Used in `tramp-make-tramp-multi-file-name'."
1051 (defcustom tramp-postfix-multi-hop-regexp
1052 (regexp-quote tramp-postfix-multi-hop-format)
1053 "*Regexp matching delimeter between host and next method.
1054 Applicable for multi-hop methods.
1055 Derived from `tramp-postfix-multi-hop-format'."
1059 (defcustom tramp-user-regexp
1061 "*Regexp matching user names."
1065 (defcustom tramp-postfix-user-format
1067 "*String matching delimeter between user and host names.
1068 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
1072 (defcustom tramp-postfix-user-regexp
1073 (regexp-quote tramp-postfix-user-format)
1074 "*Regexp matching delimeter between user and host names.
1075 Derived from `tramp-postfix-user-format'."
1079 (defcustom tramp-host-regexp
1081 "*Regexp matching host names."
1085 (defcustom tramp-host-with-port-regexp
1087 "*Regexp matching host names."
1091 (defcustom tramp-postfix-host-format
1092 (if tramp-unified-filenames ":" "]")
1093 "*String matching delimeter between host names and localnames.
1094 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
1098 (defcustom tramp-postfix-host-regexp
1099 (regexp-quote tramp-postfix-host-format)
1100 "*Regexp matching delimeter between host names and localnames.
1101 Derived from `tramp-postfix-host-format'."
1105 (defcustom tramp-localname-regexp
1107 "*Regexp matching localnames."
1111 ;; File name format.
1113 (defcustom tramp-file-name-structure
1117 "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp "\\)?"
1118 "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
1119 "\\(" tramp-host-with-port-regexp "\\)" tramp-postfix-host-regexp
1120 "\\(" tramp-localname-regexp "\\)")
1123 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
1124 the tramp file name structure.
1126 The first element REGEXP is a regular expression matching a tramp file
1127 name. The regex should contain parentheses around the method name,
1128 the user name, the host name, and the file name parts.
1130 The second element METHOD is a number, saying which pair of
1131 parentheses matches the method name. The third element USER is
1132 similar, but for the user name. The fourth element HOST is similar,
1133 but for the host name. The fifth element FILE is for the file name.
1134 These numbers are passed directly to `match-string', which see. That
1135 means the opening parentheses are counted to identify the pair.
1137 See also `tramp-file-name-regexp'."
1139 :type '(list (regexp :tag "File name regexp")
1140 (integer :tag "Paren pair for method name")
1141 (integer :tag "Paren pair for user name ")
1142 (integer :tag "Paren pair for host name ")
1143 (integer :tag "Paren pair for file name ")))
1146 (defconst tramp-file-name-regexp-unified
1148 "Value for `tramp-file-name-regexp' for unified remoting.
1149 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1150 Tramp. See `tramp-file-name-structure-unified' for more explanations.")
1153 (defconst tramp-file-name-regexp-separate
1155 "Value for `tramp-file-name-regexp' for separate remoting.
1156 XEmacs uses a separate filename syntax for Tramp and EFS.
1157 See `tramp-file-name-structure-separate' for more explanations.")
1160 (defcustom tramp-file-name-regexp
1161 (if tramp-unified-filenames
1162 tramp-file-name-regexp-unified
1163 tramp-file-name-regexp-separate)
1164 "*Regular expression matching file names handled by tramp.
1165 This regexp should match tramp file names but no other file names.
1166 \(When tramp.el is loaded, this regular expression is prepended to
1167 `file-name-handler-alist', and that is searched sequentially. Thus,
1168 if the tramp entry appears rather early in the `file-name-handler-alist'
1169 and is a bit too general, then some files might be considered tramp
1170 files which are not really tramp files.
1172 Please note that the entry in `file-name-handler-alist' is made when
1173 this file (tramp.el) is loaded. This means that this variable must be set
1174 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1175 updated after changing this variable.
1177 Also see `tramp-file-name-structure'."
1182 (defconst tramp-completion-file-name-regexp-unified
1183 "^/$\\|^/[^/:][^/]*$"
1184 "Value for `tramp-completion-file-name-regexp' for unified remoting.
1185 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1186 Tramp. See `tramp-file-name-structure-unified' for more explanations.")
1189 (defconst tramp-completion-file-name-regexp-separate
1190 "^/\\([[][^]]*\\)?$"
1191 "Value for `tramp-completion-file-name-regexp' for separate remoting.
1192 XEmacs uses a separate filename syntax for Tramp and EFS.
1193 See `tramp-file-name-structure-separate' for more explanations.")
1196 (defcustom tramp-completion-file-name-regexp
1197 (if tramp-unified-filenames
1198 tramp-completion-file-name-regexp-unified
1199 tramp-completion-file-name-regexp-separate)
1200 "*Regular expression matching file names handled by tramp completion.
1201 This regexp should match partial tramp file names only.
1203 Please note that the entry in `file-name-handler-alist' is made when
1204 this file (tramp.el) is loaded. This means that this variable must be set
1205 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1206 updated after changing this variable.
1208 Also see `tramp-file-name-structure'."
1212 (defcustom tramp-multi-file-name-structure
1216 "\\(" "\\(" tramp-method-regexp "\\)" "\\)?"
1217 "\\(" "\\(" tramp-postfix-multi-hop-regexp "%s" "\\)+" "\\)?"
1218 tramp-postfix-host-regexp "\\(" tramp-localname-regexp "\\)")
1220 "*Describes the file name structure of `multi' files.
1221 Multi files allow you to contact a remote host in several hops.
1222 This is a list of four elements (REGEXP METHOD HOP LOCALNAME).
1224 The first element, REGEXP, gives a regular expression to match against
1225 the file name. In this regular expression, `%s' is replaced with the
1226 value of `tramp-multi-file-name-hop-structure'. (Note: in order to
1227 allow multiple hops, you normally want to use something like
1228 \"\\\\(\\\\(%s\\\\)+\\\\)\" in the regular expression. The outer pair
1229 of parentheses is used for the HOP element, see below.)
1231 All remaining elements are numbers. METHOD gives the number of the
1232 paren pair which matches the method name. HOP gives the number of the
1233 paren pair which matches the hop sequence. LOCALNAME gives the number of
1234 the paren pair which matches the localname (pathname) on the remote host.
1236 LOCALNAME can also be negative, which means to count from the end. Ie, a
1237 value of -1 means the last paren pair.
1239 I think it would be good if the regexp matches the whole of the
1240 string, but I haven't actually tried what happens if it doesn't..."
1242 :type '(list (regexp :tag "File name regexp")
1243 (integer :tag "Paren pair for method name")
1244 (integer :tag "Paren pair for hops")
1245 (integer :tag "Paren pair to match localname")))
1247 (defcustom tramp-multi-file-name-hop-structure
1250 "\\(" tramp-method-regexp "\\)" tramp-postfix-multi-method-regexp
1251 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
1252 "\\(" tramp-host-with-port-regexp "\\)")
1254 "*Describes the structure of a hop in multi files.
1255 This is a list of four elements (REGEXP METHOD USER HOST). First
1256 element REGEXP is used to match against the hop. Pair number METHOD
1257 matches the method of one hop, pair number USER matches the user of
1258 one hop, pair number HOST matches the host of one hop.
1260 This regular expression should match exactly all of one hop."
1262 :type '(list (regexp :tag "Hop regexp")
1263 (integer :tag "Paren pair for method name")
1264 (integer :tag "Paren pair for user name")
1265 (integer :tag "Paren pair for host name")))
1267 (defcustom tramp-make-multi-tramp-file-format
1269 (concat tramp-prefix-format "%m")
1270 (concat tramp-postfix-multi-hop-format
1271 "%m" tramp-postfix-multi-method-format
1272 "%u" tramp-postfix-user-format
1274 (concat tramp-postfix-host-format "%p"))
1275 "*Describes how to construct a `multi' file name.
1276 This is a list of three elements PREFIX, HOP and LOCALNAME.
1278 The first element PREFIX says how to construct the prefix, the second
1279 element HOP specifies what each hop looks like, and the final element
1280 LOCALNAME says how to construct the localname (pathname).
1282 In PREFIX, `%%' means `%' and `%m' means the method name.
1284 In HOP, `%%' means `%' and `%m', `%u', `%h' mean the hop method, hop
1285 user and hop host, respectively.
1287 In LOCALNAME, `%%' means `%' and `%p' means the localname.
1289 The resulting file name always contains one copy of PREFIX and one
1290 copy of LOCALNAME, but there is one copy of HOP for each hop in the file
1293 Note: the current implementation requires the prefix to contain the
1294 method name, followed by all the hops, and the localname must come
1297 :type '(list string string string))
1299 (defcustom tramp-terminal-type "dumb"
1300 "*Value of TERM environment variable for logging in to remote host.
1301 Because Tramp wants to parse the output of the remote shell, it is easily
1302 confused by ANSI color escape sequences and suchlike. Often, shell init
1303 files conditionalize this setup based on the TERM environment variable."
1307 (defcustom tramp-completion-without-shell-p nil
1308 "*If nil, use shell wildcards for completion, else rely on Lisp only.
1309 Using shell wildcards for completions has the advantage that it can be
1310 fast even in large directories, but completion is always
1311 case-sensitive. Relying on Lisp only means that case-insensitive
1312 completion is possible (subject to the variable `completion-ignore-case'),
1313 but it might be slow on large directories."
1317 (defcustom tramp-actions-before-shell
1318 '((tramp-password-prompt-regexp tramp-action-password)
1319 (tramp-login-prompt-regexp tramp-action-login)
1320 (shell-prompt-pattern tramp-action-succeed)
1321 (tramp-shell-prompt-pattern tramp-action-succeed)
1322 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1323 (tramp-yesno-prompt-regexp tramp-action-yesno)
1324 (tramp-yn-prompt-regexp tramp-action-yn)
1325 (tramp-terminal-prompt-regexp tramp-action-terminal)
1326 (tramp-process-alive-regexp tramp-action-process-alive))
1327 "List of pattern/action pairs.
1328 Whenever a pattern matches, the corresponding action is performed.
1329 Each item looks like (PATTERN ACTION).
1331 The PATTERN should be a symbol, a variable. The value of this
1332 variable gives the regular expression to search for. Note that the
1333 regexp must match at the end of the buffer, \"\\'\" is implicitly
1336 The ACTION should also be a symbol, but a function. When the
1337 corresponding PATTERN matches, the ACTION function is called."
1339 :type '(repeat (list variable function)))
1341 (defcustom tramp-actions-copy-out-of-band
1342 '((tramp-password-prompt-regexp tramp-action-password)
1343 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1344 (tramp-process-alive-regexp tramp-action-out-of-band))
1345 "List of pattern/action pairs.
1346 This list is used for copying/renaming with out-of-band methods.
1347 See `tramp-actions-before-shell' for more info."
1349 :type '(repeat (list variable function)))
1351 (defcustom tramp-multi-actions
1352 '((tramp-password-prompt-regexp tramp-multi-action-password)
1353 (tramp-login-prompt-regexp tramp-multi-action-login)
1354 (shell-prompt-pattern tramp-multi-action-succeed)
1355 (tramp-shell-prompt-pattern tramp-multi-action-succeed)
1356 (tramp-wrong-passwd-regexp tramp-multi-action-permission-denied)
1357 (tramp-process-alive-regexp tramp-multi-action-process-alive))
1358 "List of pattern/action pairs.
1359 This list is used for each hop in multi-hop connections.
1360 See `tramp-actions-before-shell' for more info."
1362 :type '(repeat (list variable function)))
1364 (defcustom tramp-initial-commands
1367 "unset autocorrect")
1368 "List of commands to send to the first remote shell that we see.
1369 These commands will be sent to any shell, and thus they should be
1370 designed to work in such circumstances. Also, restrict the commands
1371 to the bare necessity for getting the remote shell into a state
1372 where it is possible to execute the Bourne-ish shell.
1374 At the moment, the command to execute the Bourne-ish shell uses strange
1375 quoting which `tcsh' tries to correct, so we send the command \"unset
1376 autocorrect\" to the remote host."
1378 :type '(repeat string))
1380 ;; Chunked sending kluge. We set this to 500 for black-listed constellations
1381 ;; known to have a bug in `process-send-string'; some ssh connections appear
1382 ;; to drop bytes when data is sent too quickly. There is also a connection
1383 ;; buffer local variable, which is computed depending on remote host properties
1384 ;; when `tramp-chunksize' is zero or nil.
1385 (defcustom tramp-chunksize
1386 (when (and (not (featurep 'xemacs))
1387 (memq system-type '(hpux)))
1389 ;; Parentheses in docstring starting at beginning of line are escaped.
1390 ;; Fontification is messed up when
1391 ;; `open-paren-in-column-0-is-defun-start' set to t.
1392 "*If non-nil, chunksize for sending input to local process.
1393 It is necessary only on systems which have a buggy `process-send-string'
1394 implementation. The necessity, whether this variable must be set, can be
1395 checked via the following code:
1398 (let* ((user \"xxx\") (host \"yyy\")
1400 (sent init) (received init))
1401 (while (= sent received)
1402 (setq sent (+ sent step))
1404 (let ((proc (start-process (buffer-name) (current-buffer)
1405 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
1406 (when (memq (process-status proc) '(run open))
1407 (process-send-string proc (make-string sent ?\\ ))
1408 (process-send-eof proc)
1409 (process-send-eof proc))
1410 (while (not (progn (goto-char (point-min))
1411 (re-search-forward \"\\\\w+\" (point-max) t)))
1412 (accept-process-output proc 1))
1413 (when (memq (process-status proc) '(run open))
1414 (setq received (string-to-number (match-string 0)))
1415 (delete-process proc)
1416 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1418 (if (> sent (+ init step))
1419 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1421 (message \"Test does not work\")
1422 (display-buffer (current-buffer))
1425 In the Emacs normally running Tramp, evaluate the above code
1426 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1427 respectively). You can do this, for example, by pasting it into
1428 the `*scratch*' buffer and then hitting C-j with the cursor after the
1429 last closing parenthesis. Note that it works only if you have configured
1430 \"ssh\" to run without password query, see ssh-agent(1).
1432 You will see the number of bytes sent successfully to the remote host.
1433 If that number exceeds 1000, you can stop the execution by hitting
1434 C-g, because your Emacs is likely clean.
1436 If your Emacs is buggy, the code stops and gives you an indication
1437 about the value `tramp-chunksize' should be set. Maybe you could just
1438 experiment a bit, e.g. changing the values of `init' and `step'
1439 in the third line of the code.
1441 When it is necessary to set `tramp-chunksize', you might consider to
1442 use an out-of-the-band method (like \"scp\") instead of an internal one
1443 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
1446 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1447 this variable to be set as well."
1449 :type '(choice (const nil) integer))
1451 ;; Logging in to a remote host normally requires obtaining a pty. But
1452 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1453 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1454 ;; for an override of the system default.
1455 (defcustom tramp-process-connection-type t
1456 "Overrides `process-connection-type' for connections from Tramp.
1457 Tramp binds process-connection-type to the value given here before
1458 opening a connection to a remote host."
1460 :type '(choice (const nil) (const t) (const pty)))
1462 ;;; Internal Variables:
1464 (defvar tramp-buffer-file-attributes nil
1465 "Holds the `ls -ild' output for the current buffer.
1466 This variable is local to each buffer. It is not used if the remote
1467 machine groks Perl. If it is used, it's used as an emulation for
1468 the visited file modtime.")
1469 (make-variable-buffer-local 'tramp-buffer-file-attributes)
1471 (defvar tramp-md5-function
1472 (cond ((and (require 'md5) (fboundp 'md5)) 'md5)
1473 ((fboundp 'md5-encode)
1474 (lambda (x) (base64-encode-string
1475 (funcall (symbol-function 'md5-encode) x))))
1476 (t (error "Couldn't find an `md5' function")))
1477 "Function to call for running the MD5 algorithm.")
1479 (defvar tramp-end-of-output
1481 (funcall tramp-md5-function
1483 (prin1-to-string process-environment)
1484 (current-time-string)
1486 ;; (if (fboundp 'directory-files-and-attributes)
1487 ;; (funcall 'directory-files-and-attributes
1488 ;; (or (getenv "HOME")
1489 ;; (tramp-temporary-file-directory)))
1492 ;; (cons x (file-attributes x)))
1493 ;; (directory-files (or (getenv "HOME")
1494 ;; (tramp-temporary-file-directory))
1497 "String used to recognize end of output.")
1499 (defvar tramp-connection-function nil
1500 "This internal variable holds a parameter for `tramp-methods'.
1501 In the connection buffer, this variable has the value of the like-named
1502 method parameter, as specified in `tramp-methods' (which see).")
1504 (defvar tramp-remote-sh nil
1505 "This internal variable holds a parameter for `tramp-methods'.
1506 In the connection buffer, this variable has the value of the like-named
1507 method parameter, as specified in `tramp-methods' (which see).")
1509 (defvar tramp-login-program nil
1510 "This internal variable holds a parameter for `tramp-methods'.
1511 In the connection buffer, this variable has the value of the like-named
1512 method parameter, as specified in `tramp-methods' (which see).")
1514 (defvar tramp-login-args nil
1515 "This internal variable holds a parameter for `tramp-methods'.
1516 In the connection buffer, this variable has the value of the like-named
1517 method parameter, as specified in `tramp-methods' (which see).")
1519 (defvar tramp-copy-program nil
1520 "This internal variable holds a parameter for `tramp-methods'.
1521 In the connection buffer, this variable has the value of the like-named
1522 method parameter, as specified in `tramp-methods' (which see).")
1524 (defvar tramp-copy-args nil
1525 "This internal variable holds a parameter for `tramp-methods'.
1526 In the connection buffer, this variable has the value of the like-named
1527 method parameter, as specified in `tramp-methods' (which see).")
1529 (defvar tramp-copy-keep-date-arg nil
1530 "This internal variable holds a parameter for `tramp-methods'.
1531 In the connection buffer, this variable has the value of the like-named
1532 method parameter, as specified in `tramp-methods' (which see).")
1534 (defvar tramp-encoding-command nil
1535 "This internal variable holds a parameter for `tramp-methods'.
1536 In the connection buffer, this variable has the value of the like-named
1537 method parameter, as specified in `tramp-methods' (which see).")
1539 (defvar tramp-decoding-command nil
1540 "This internal variable holds a parameter for `tramp-methods'.
1541 In the connection buffer, this variable has the value of the like-named
1542 method parameter, as specified in `tramp-methods' (which see).")
1544 (defvar tramp-encoding-function nil
1545 "This internal variable holds a parameter for `tramp-methods'.
1546 In the connection buffer, this variable has the value of the like-named
1547 method parameter, as specified in `tramp-methods' (which see).")
1549 (defvar tramp-decoding-function nil
1550 "This internal variable holds a parameter for `tramp-methods'.
1551 In the connection buffer, this variable has the value of the like-named
1552 method parameter, as specified in `tramp-methods' (which see).")
1554 (defvar tramp-password-end-of-line nil
1555 "This internal variable holds a parameter for `tramp-methods'.
1556 In the connection buffer, this variable has the value of the like-named
1557 method parameter, as specified in `tramp-methods' (which see).")
1559 ;; CCC `local in each buffer'?
1560 (defvar tramp-ls-command nil
1561 "This command is used to get a long listing with numeric user and group ids.
1562 This variable is automatically made buffer-local to each rsh process buffer
1563 upon opening the connection.")
1565 (defvar tramp-current-multi-method nil
1566 "Name of `multi' connection method for this *tramp* buffer, or nil if not multi.
1567 This variable is automatically made buffer-local to each rsh process buffer
1568 upon opening the connection.")
1570 (defvar tramp-current-method nil
1571 "Connection method for this *tramp* buffer.
1572 This variable is automatically made buffer-local to each rsh process buffer
1573 upon opening the connection.")
1575 (defvar tramp-current-user nil
1576 "Remote login name for this *tramp* buffer.
1577 This variable is automatically made buffer-local to each rsh process buffer
1578 upon opening the connection.")
1580 (defvar tramp-current-host nil
1581 "Remote host for this *tramp* buffer.
1582 This variable is automatically made buffer-local to each rsh process buffer
1583 upon opening the connection.")
1585 (defvar tramp-test-groks-nt nil
1586 "Whether the `test' command groks the `-nt' switch.
1587 \(`test A -nt B' tests if file A is newer than file B.)
1588 This variable is automatically made buffer-local to each rsh process buffer
1589 upon opening the connection.")
1591 (defvar tramp-file-exists-command nil
1592 "Command to use for checking if a file exists.
1593 This variable is automatically made buffer-local to each rsh process buffer
1594 upon opening the connection.")
1596 (defconst tramp-uudecode "\
1598 \(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
1602 "Shell function to implement `uudecode' to standard output.
1603 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
1604 for this or `uudecode -p', but some systems don't, and for them
1605 we have this shell function.")
1607 ;; Perl script to implement `file-attributes' in a Lisp `read'able
1608 ;; output. If you are hacking on this, note that you get *no* output
1609 ;; unless this spits out a complete line, including the '\n' at the
1611 ;; The device number is returned as "-1", because there will be a virtual
1612 ;; device number set in `tramp-handle-file-attributes'
1613 (defconst tramp-perl-file-attributes "\
1614 @stat = lstat($ARGV[0]);
1615 if (($stat[2] & 0170000) == 0120000)
1617 $type = readlink($ARGV[0]);
1618 $type = \"\\\"$type\\\"\";
1620 elsif (($stat[2] & 0170000) == 040000)
1628 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1629 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1631 \"(%s %u %s %s (%u %u) (%u %u) (%u %u) %u %u t (%u . %u) -1)\\n\",
1636 $stat[8] >> 16 & 0xffff,
1638 $stat[9] >> 16 & 0xffff,
1640 $stat[10] >> 16 & 0xffff,
1644 $stat[1] >> 16 & 0xffff,
1647 "Perl script to produce output suitable for use with `file-attributes'
1648 on the remote file system.")
1650 (defconst tramp-perl-directory-files-and-attributes "\
1651 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
1652 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
1653 @list = readdir(DIR);
1657 for($i = 0; $i < $n; $i++)
1659 $filename = $list[$i];
1660 @stat = lstat($filename);
1661 if (($stat[2] & 0170000) == 0120000)
1663 $type = readlink($filename);
1664 $type = \"\\\"$type\\\"\";
1666 elsif (($stat[2] & 0170000) == 040000)
1674 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1675 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1677 \"(\\\"%s\\\" %s %u %s %s (%u %u) (%u %u) (%u %u) %u %u t (%u . %u) (%u %u))\\n\",
1683 $stat[8] >> 16 & 0xffff,
1685 $stat[9] >> 16 & 0xffff,
1687 $stat[10] >> 16 & 0xffff,
1691 $stat[1] >> 16 & 0xffff,
1693 $stat[0] >> 16 & 0xffff,
1697 "Perl script implementing `directory-files-attributes' as Lisp `read'able
1700 ;; ;; These two use uu encoding.
1701 ;; (defvar tramp-perl-encode "%s -e'\
1702 ;; print qq(begin 644 xxx\n);
1705 ;; while (read(STDIN, $s, 45)) {
1706 ;; print pack(q(u), $s);
1711 ;; "Perl program to use for encoding a file.
1712 ;; Escape sequence %s is replaced with name of Perl binary.")
1714 ;; (defvar tramp-perl-decode "%s -ne '
1715 ;; print unpack q(u), $_;
1717 ;; "Perl program to use for decoding a file.
1718 ;; Escape sequence %s is replaced with name of Perl binary.")
1720 ;; These two use base64 encoding.
1721 (defvar tramp-perl-encode-with-module
1722 "perl -MMIME::Base64 -0777 -ne 'print encode_base64($_)'"
1723 "Perl program to use for encoding a file.
1724 Escape sequence %s is replaced with name of Perl binary.
1725 This string is passed to `format', so percent characters need to be doubled.
1726 This implementation requires the MIME::Base64 Perl module to be installed
1727 on the remote host.")
1729 (defvar tramp-perl-decode-with-module
1730 "perl -MMIME::Base64 -0777 -ne 'print decode_base64($_)'"
1731 "Perl program to use for decoding a file.
1732 Escape sequence %s is replaced with name of Perl binary.
1733 This string is passed to `format', so percent characters need to be doubled.
1734 This implementation requires the MIME::Base64 Perl module to be installed
1735 on the remote host.")
1737 (defvar tramp-perl-encode
1739 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1740 # Copyright (C) 2002, 2006 Free Software Foundation, Inc.
1745 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
1746 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
1751 # We read in chunks of 54 bytes, to generate output lines
1752 # of 72 chars (plus end of line)
1755 while (my $data = <STDIN>) {
1758 # Only for the last chunk, and only if did not fill the last three-byte packet
1760 my $mod = length($data) %% 3;
1761 $pad = q(=) x (3 - $mod) if $mod;
1764 # Not the fastest method, but it is simple: unpack to binary string, split
1765 # by groups of 6 bits and convert back from binary to byte; then map into
1766 # the translation table
1770 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
1775 "Perl program to use for encoding a file.
1776 Escape sequence %s is replaced with name of Perl binary.
1777 This string is passed to `format', so percent characters need to be doubled.")
1779 (defvar tramp-perl-decode
1781 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1782 # Copyright (C) 2002, 2006 Free Software Foundation, Inc.
1787 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
1788 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
1791 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
1795 # We are going to accumulate into $pending to accept any line length
1796 # (we do not check they are <= 76 chars as the RFC says)
1799 while (my $data = <STDIN>) {
1802 # If we find one or two =, we have reached the end and
1803 # any following data is to be discarded
1804 my $finished = $data =~ s/(==?).*/$1/;
1807 my $len = length($pending);
1808 my $chunk = substr($pending, 0, $len & ~3);
1809 $pending = substr($pending, $len & ~3 + 1);
1811 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
1812 # split in 8-bit chunks and convert back to char.
1815 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
1820 "Perl program to use for decoding a file.
1821 Escape sequence %s is replaced with name of Perl binary.
1822 This string is passed to `format', so percent characters need to be doubled.")
1824 ; These values conform to `file-attributes' from XEmacs 21.2.
1825 ; GNU Emacs and other tools not checked.
1826 (defconst tramp-file-mode-type-map '((0 . "-") ; Normal file (SVID-v2 and XPG2)
1828 (2 . "c") ; character device
1829 (3 . "m") ; multiplexed character device (v7)
1830 (4 . "d") ; directory
1831 (5 . "?") ; Named special file (XENIX)
1832 (6 . "b") ; block device
1833 (7 . "?") ; multiplexed block device (v7)
1834 (8 . "-") ; regular file
1835 (9 . "n") ; network special file (HP-UX)
1836 (10 . "l") ; symlink
1837 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
1839 (13 . "D") ; door special (Solaris)
1840 (14 . "w")) ; whiteout (BSD)
1841 "A list of file types returned from the `stat' system call.
1842 This is used to map a mode number to a permission string.")
1844 (defvar tramp-dos-coding-system
1845 (if (and (fboundp 'coding-system-p)
1846 (funcall 'coding-system-p '(dos)))
1849 "Some Emacsen know the `dos' coding system, others need `undecided-dos'.")
1851 (defvar tramp-last-cmd nil
1852 "Internal Tramp variable recording the last command sent.
1853 This variable is buffer-local in every buffer.")
1854 (make-variable-buffer-local 'tramp-last-cmd)
1856 (defvar tramp-process-echoes nil
1857 "Whether to process echoes from the remote shell.")
1859 (defvar tramp-last-cmd-time nil
1860 "Internal Tramp variable recording the time when the last cmd was sent.
1861 This variable is buffer-local in every buffer.")
1862 (make-variable-buffer-local 'tramp-last-cmd-time)
1864 ;; This variable does not have the right value in XEmacs. What should
1865 ;; I use instead of find-operation-coding-system in XEmacs?
1866 (defvar tramp-feature-write-region-fix
1867 (when (fboundp 'find-operation-coding-system)
1868 (let ((file-coding-system-alist '(("test" emacs-mule))))
1869 (funcall (symbol-function 'find-operation-coding-system)
1870 'write-region 0 0 "" nil "test")))
1871 "Internal variable to say if `write-region' chooses the right coding.
1872 Older versions of Emacs chose the coding system for `write-region' based
1873 on the FILENAME argument, even if VISIT was a string.")
1875 ;; New handlers should be added here. The following operations can be
1876 ;; handled using the normal primitives: file-name-as-directory,
1877 ;; file-name-directory, file-name-nondirectory,
1878 ;; file-name-sans-versions, get-file-buffer.
1879 (defconst tramp-file-name-handler-alist
1881 (load . tramp-handle-load)
1882 (make-symbolic-link . tramp-handle-make-symbolic-link)
1883 (file-name-directory . tramp-handle-file-name-directory)
1884 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
1885 (file-truename . tramp-handle-file-truename)
1886 (file-exists-p . tramp-handle-file-exists-p)
1887 (file-directory-p . tramp-handle-file-directory-p)
1888 (file-executable-p . tramp-handle-file-executable-p)
1889 (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
1890 (file-readable-p . tramp-handle-file-readable-p)
1891 (file-regular-p . tramp-handle-file-regular-p)
1892 (file-symlink-p . tramp-handle-file-symlink-p)
1893 (file-writable-p . tramp-handle-file-writable-p)
1894 (file-ownership-preserved-p . tramp-handle-file-ownership-preserved-p)
1895 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
1896 (file-attributes . tramp-handle-file-attributes)
1897 (file-modes . tramp-handle-file-modes)
1898 (directory-files . tramp-handle-directory-files)
1899 (directory-files-and-attributes . tramp-handle-directory-files-and-attributes)
1900 (file-name-all-completions . tramp-handle-file-name-all-completions)
1901 (file-name-completion . tramp-handle-file-name-completion)
1902 (add-name-to-file . tramp-handle-add-name-to-file)
1903 (copy-file . tramp-handle-copy-file)
1904 (rename-file . tramp-handle-rename-file)
1905 (set-file-modes . tramp-handle-set-file-modes)
1906 (make-directory . tramp-handle-make-directory)
1907 (delete-directory . tramp-handle-delete-directory)
1908 (delete-file . tramp-handle-delete-file)
1909 (directory-file-name . tramp-handle-directory-file-name)
1910 (shell-command . tramp-handle-shell-command)
1911 (process-file . tramp-handle-process-file)
1912 (insert-directory . tramp-handle-insert-directory)
1913 (expand-file-name . tramp-handle-expand-file-name)
1914 (file-local-copy . tramp-handle-file-local-copy)
1915 (file-remote-p . tramp-handle-file-remote-p)
1916 (insert-file-contents . tramp-handle-insert-file-contents)
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-call-process . tramp-handle-dired-call-process)
1923 (dired-recursive-delete-directory
1924 . tramp-handle-dired-recursive-delete-directory)
1925 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
1926 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime))
1927 "Alist of handler functions.
1928 Operations not mentioned here will be handled by the normal Emacs functions.")
1930 ;; Handlers for partial tramp file names. For GNU Emacs just
1931 ;; `file-name-all-completions' is needed. The other ones are necessary
1933 (defconst tramp-completion-file-name-handler-alist
1935 (file-name-directory . tramp-completion-handle-file-name-directory)
1936 (file-name-nondirectory . tramp-completion-handle-file-name-nondirectory)
1937 (file-exists-p . tramp-completion-handle-file-exists-p)
1938 (file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1939 (file-name-completion . tramp-completion-handle-file-name-completion)
1940 (expand-file-name . tramp-completion-handle-expand-file-name))
1941 "Alist of completion handler functions.
1942 Used for file names matching `tramp-file-name-regexp'. Operations not
1943 mentioned here will be handled by `tramp-file-name-handler-alist' or the
1944 normal Emacs functions.")
1946 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
1947 (defvar tramp-foreign-file-name-handler-alist
1948 ;; (identity . tramp-sh-file-name-handler) should always be the last
1949 ;; entry, since `identity' always matches.
1950 '((identity . tramp-sh-file-name-handler))
1951 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
1952 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
1955 ;;; Internal functions which must come first.
1957 (defsubst tramp-message (level fmt-string &rest args)
1958 "Emit a message depending on verbosity level.
1959 First arg LEVEL says to be quiet if `tramp-verbose' is less than LEVEL. The
1960 message is emitted only if `tramp-verbose' is greater than or equal to LEVEL.
1961 Calls function `message' with FMT-STRING as control string and the remaining
1962 ARGS to actually emit the message (if applicable).
1964 This function expects to be called from the tramp buffer only!"
1965 (when (<= level tramp-verbose)
1966 (apply #'message (concat "tramp: " fmt-string) args)
1967 (when tramp-debug-buffer
1970 (tramp-get-debug-buffer
1971 tramp-current-multi-method tramp-current-method
1972 tramp-current-user tramp-current-host))
1973 (goto-char (point-max))
1976 (tramp-insert-with-face
1978 (concat "# " (apply #'format fmt-string args) "\n"))))))
1980 (defun tramp-message-for-buffer
1981 (multi-method method user host level fmt-string &rest args)
1982 "Like `tramp-message' but temporarily switches to the tramp buffer.
1983 First three args METHOD, USER, and HOST identify the tramp buffer to use,
1984 remaining args passed to `tramp-message'."
1986 (set-buffer (tramp-get-buffer multi-method method user host))
1987 (apply 'tramp-message level fmt-string args)))
1989 (defsubst tramp-line-end-position nil
1990 "Return point at end of line.
1991 Calls `line-end-position' or `point-at-eol' if defined, else
1992 own implementation."
1994 ((fboundp 'line-end-position) (funcall (symbol-function 'line-end-position)))
1995 ((fboundp 'point-at-eol) (funcall (symbol-function 'point-at-eol)))
1996 (t (save-excursion (end-of-line) (point)))))
1998 (defmacro with-parsed-tramp-file-name (filename var &rest body)
1999 "Parse a Tramp filename and make components available in the body.
2001 First arg FILENAME is evaluated and dissected into its components.
2002 Second arg VAR is a symbol. It is used as a variable name to hold
2003 the filename structure. It is also used as a prefix for the variables
2004 holding the components. For example, if VAR is the symbol `foo', then
2005 `foo' will be bound to the whole structure, `foo-multi-method' will
2006 be bound to the multi-method component, and so on for `foo-method',
2007 `foo-user', `foo-host', `foo-localname'.
2009 Remaining args are Lisp expressions to be evaluated (inside an implicit
2012 If VAR is nil, then we bind `v' to the structure and `multi-method',
2013 `method', `user', `host', `localname' to the components."
2014 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
2015 (,(if var (intern (concat (symbol-name var) "-multi-method")) 'multi-method)
2016 (tramp-file-name-multi-method ,(or var 'v)))
2017 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
2018 (tramp-file-name-method ,(or var 'v)))
2019 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
2020 (tramp-file-name-user ,(or var 'v)))
2021 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
2022 (tramp-file-name-host ,(or var 'v)))
2023 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
2024 (tramp-file-name-localname ,(or var 'v))))
2027 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
2028 ;; To be activated for debugging containing this macro
2029 ;; It works only when VAR is nil. Otherwise, it can be deactivated by
2030 ;; (put 'with-parsed-tramp-file-name 'edebug-form-spec 0)
2031 ;; I'm too stupid to write a precise SPEC for it.
2032 (put 'with-parsed-tramp-file-name 'edebug-form-spec t)
2034 (defmacro tramp-let-maybe (variable value &rest body)
2035 "Let-bind VARIABLE to VALUE in BODY, but only if VARIABLE is not obsolete.
2036 BODY is executed whether or not the variable is obsolete.
2037 The intent is to protect against `obsolete variable' warnings."
2038 `(if (get ',variable 'byte-obsolete-variable)
2040 (let ((,variable ,value))
2042 (put 'tramp-let-maybe 'lisp-indent-function 2)
2043 (put 'tramp-let-maybe 'edebug-form-spec t)
2045 ;;; Config Manipulation Functions:
2047 (defun tramp-set-completion-function (method function-list)
2048 "Sets the list of completion functions for METHOD.
2049 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
2050 The FUNCTION is intended to parse FILE according its syntax.
2051 It might be a predefined FUNCTION, or a user defined FUNCTION.
2052 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
2053 `tramp-parse-sconfig',`tramp-parse-hosts', `tramp-parse-passwd',
2054 and `tramp-parse-netrc'.
2058 (tramp-set-completion-function
2060 '((tramp-parse-sconfig \"/etc/ssh_config\")
2061 (tramp-parse-sconfig \"~/.ssh/config\")))"
2063 (let ((r function-list)
2065 (setq tramp-completion-function-alist
2066 (delete (assoc method tramp-completion-function-alist)
2067 tramp-completion-function-alist))
2070 ;; Remove double entries
2071 (when (member (car v) (cdr v))
2072 (setcdr v (delete (car v) (cdr v))))
2073 ;; Check for function and file
2074 (unless (and (functionp (nth 0 (car v)))
2075 (file-exists-p (nth 1 (car v))))
2076 (setq r (delete (car v) r)))
2080 (add-to-list 'tramp-completion-function-alist
2083 (defun tramp-get-completion-function (method)
2084 "Returns list of completion functions for METHOD.
2085 For definition of that list see `tramp-set-completion-function'."
2086 (cdr (assoc method tramp-completion-function-alist)))
2088 ;;; File Name Handler Functions:
2090 (defun tramp-handle-make-symbolic-link
2091 (filename linkname &optional ok-if-already-exists)
2092 "Like `make-symbolic-link' for tramp files.
2093 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
2094 the symlink. If LINKNAME is a Tramp file, only the localname component is
2095 used as the target of the symlink.
2097 If LINKNAME is a Tramp file and the localname component is relative, then
2098 it is expanded first, before the localname component is taken. Note that
2099 this can give surprising results if the user/host for the source and
2100 target of the symlink differ."
2101 (with-parsed-tramp-file-name linkname l
2102 (let ((ln (tramp-get-remote-ln l-multi-method l-method l-user l-host))
2103 (cwd (file-name-directory l-localname)))
2106 (list "Making a symbolic link."
2107 "ln(1) does not exist on the remote host.")))
2109 ;; Do the 'confirm if exists' thing.
2110 (when (file-exists-p linkname)
2112 (if (or (null ok-if-already-exists) ; not allowed to exist
2113 (and (numberp ok-if-already-exists)
2116 "File %s already exists; make it a link anyway? "
2118 (signal 'file-already-exists (list "File already exists" l-localname))
2119 (delete-file linkname)))
2121 ;; If FILENAME is a Tramp name, use just the localname component.
2122 (when (tramp-tramp-file-p filename)
2123 (setq filename (tramp-file-name-localname
2124 (tramp-dissect-file-name
2125 (expand-file-name filename)))))
2127 ;; Right, they are on the same host, regardless of user, method, etc.
2128 ;; We now make the link on the remote machine. This will occur as the user
2129 ;; that FILENAME belongs to.
2131 (tramp-send-command-and-check
2132 l-multi-method l-method l-user l-host
2133 (format "cd %s && %s -sf %s %s"
2140 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
2141 "Like `load' for tramp files. Not implemented!"
2142 (unless (file-name-absolute-p file)
2143 (error "Tramp cannot `load' files without absolute file name"))
2144 (with-parsed-tramp-file-name file nil
2146 (cond ((file-exists-p (concat file ".elc"))
2147 (setq file (concat file ".elc")))
2148 ((file-exists-p (concat file ".el"))
2149 (setq file (concat file ".el")))))
2151 ;; The first condition is always true for absolute file names.
2152 ;; Included for safety's sake.
2153 (unless (or (file-name-directory file)
2154 (string-match "\\.elc?\\'" file))
2155 (error "File `%s' does not include a `.el' or `.elc' suffix"
2158 (when (not (file-exists-p file))
2159 (error "Cannot load nonexistent file `%s'" file)))
2160 (if (not (file-exists-p file))
2163 (message "Loading %s..." file))
2164 (let ((local-copy (file-local-copy file)))
2165 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2166 (load local-copy noerror t t)
2167 (delete-file local-copy))
2169 (message "Loading %s...done" file))
2172 ;; Localname manipulation functions that grok TRAMP localnames...
2173 (defun tramp-handle-file-name-directory (file)
2174 "Like `file-name-directory' but aware of TRAMP files."
2175 ;; everything except the last filename thing is the directory
2176 (with-parsed-tramp-file-name file nil
2177 ;; For the following condition, two possibilities should be tried:
2178 ;; (1) (string= localname "")
2179 ;; (2) (or (string= localname "") (string= localname "/"))
2180 ;; The second variant fails when completing a "/" directory on
2181 ;; the remote host, that is a filename which looks like
2182 ;; "/user@host:/". But maybe wildcards fail with the first variant.
2183 ;; We should do some investigation.
2184 (if (string= localname "")
2185 ;; For a filename like "/[foo]", we return "/". The `else'
2186 ;; case would return "/[foo]" unchanged. But if we do that,
2187 ;; then `file-expand-wildcards' ceases to work. It's not
2188 ;; quite clear to me what's the intuition that tells that this
2189 ;; behavior is the right behavior, but oh, well.
2191 ;; run the command on the localname portion only
2192 ;; CCC: This should take into account the remote machine type, no?
2193 ;; --daniel <daniel@danann.net>
2194 (tramp-make-tramp-file-name multi-method method user host
2195 ;; This will not recurse...
2196 (or (file-name-directory localname) "")))))
2198 (defun tramp-handle-file-name-nondirectory (file)
2199 "Like `file-name-nondirectory' but aware of TRAMP files."
2200 (with-parsed-tramp-file-name file nil
2201 (file-name-nondirectory localname)))
2203 (defun tramp-handle-file-truename (filename &optional counter prev-dirs)
2204 "Like `file-truename' for tramp files."
2205 (with-parsed-tramp-file-name (expand-file-name filename) nil
2206 (let* ((steps (tramp-split-string localname "/"))
2207 (localnamedir (tramp-let-maybe directory-sep-char ?/ ;for XEmacs
2208 (file-name-as-directory localname)))
2209 (is-dir (string= localname localnamedir))
2212 ;; Don't make the following value larger than necessary.
2213 ;; People expect an error message in a timely fashion when
2214 ;; something is wrong; otherwise they might think that Emacs
2215 ;; is hung. Of course, correctness has to come first.
2217 (result nil) ;result steps in reverse order
2219 (tramp-message-for-buffer
2220 multi-method method user host
2221 10 "Finding true name for `%s'" filename)
2222 (while (and steps (< numchase numchase-limit))
2223 (setq thisstep (pop steps))
2224 (tramp-message-for-buffer
2225 multi-method method user host
2227 (mapconcat 'identity
2228 (append '("") (reverse result) (list thisstep))
2230 (setq symlink-target
2231 (nth 0 (file-attributes
2232 (tramp-make-tramp-file-name
2233 multi-method method user host
2234 (mapconcat 'identity
2239 (cond ((string= "." thisstep)
2240 (tramp-message-for-buffer multi-method method user host
2241 10 "Ignoring step `.'"))
2242 ((string= ".." thisstep)
2243 (tramp-message-for-buffer multi-method method user host
2244 10 "Processing step `..'")
2246 ((stringp symlink-target)
2247 ;; It's a symlink, follow it.
2248 (tramp-message-for-buffer
2249 multi-method method user host
2250 10 "Follow symlink to %s" symlink-target)
2251 (setq numchase (1+ numchase))
2252 (when (file-name-absolute-p symlink-target)
2254 ;; If the symlink was absolute, we'll get a string like
2255 ;; "/user@host:/some/target"; extract the
2256 ;; "/some/target" part from it.
2257 (when (tramp-tramp-file-p symlink-target)
2258 (with-parsed-tramp-file-name symlink-target sym
2259 (unless (equal (list multi-method method user host)
2260 (list sym-multi-method sym-method
2262 (error "Symlink target `%s' on wrong host"
2264 (setq symlink-target localname)))
2266 (append (tramp-split-string symlink-target "/") steps)))
2269 (setq result (cons thisstep result)))))
2270 (when (>= numchase numchase-limit)
2271 (error "Maximum number (%d) of symlinks exceeded" numchase-limit))
2272 (setq result (reverse result))
2273 ;; Combine list to form string.
2276 (mapconcat 'identity (cons "" result) "/")
2278 (when (and is-dir (or (string= "" result)
2279 (not (string= (substring result -1) "/"))))
2280 (setq result (concat result "/")))
2281 (tramp-message-for-buffer
2282 multi-method method user host
2283 10 "True name of `%s' is `%s'" filename result)
2284 (tramp-make-tramp-file-name
2285 multi-method method user host result))))
2289 (defun tramp-handle-file-exists-p (filename)
2290 "Like `file-exists-p' for tramp files."
2291 (with-parsed-tramp-file-name filename nil
2293 (zerop (tramp-send-command-and-check
2294 multi-method method user host
2296 (tramp-get-file-exists-command multi-method method user host)
2297 (tramp-shell-quote-argument localname)))))))
2299 ;; Devices must distinguish physical file systems. The device numbers
2300 ;; provided by "lstat" aren't unique, because we operate on different hosts.
2301 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
2302 ;; EFS use device number "-1". In order to be different, we use device number
2303 ;; (-1 x), whereby "x" is unique for a given (multi-method method user host).
2304 (defvar tramp-devices nil
2305 "Keeps virtual device numbers.")
2307 ;; CCC: This should check for an error condition and signal failure
2308 ;; when something goes wrong.
2309 ;; Daniel Pittman <daniel@danann.net>
2310 (defun tramp-handle-file-attributes (filename &optional id-format)
2311 "Like `file-attributes' for tramp files."
2312 (when (file-exists-p filename)
2313 ;; file exists, find out stuff
2314 (unless id-format (setq id-format 'integer))
2315 (with-parsed-tramp-file-name filename nil
2317 (tramp-convert-file-attributes
2318 multi-method method user host
2319 (if (tramp-get-remote-perl multi-method method user host)
2320 (tramp-handle-file-attributes-with-perl multi-method method user host
2321 localname id-format)
2322 (tramp-handle-file-attributes-with-ls multi-method method user host
2323 localname id-format)))))))
2325 (defun tramp-handle-file-attributes-with-ls
2326 (multi-method method user host localname &optional id-format)
2327 "Implement `file-attributes' for tramp files using the ls(1) command."
2329 res-inode res-filemodes res-numlinks
2330 res-uid res-gid res-size res-symlink-target)
2331 (tramp-message-for-buffer multi-method method user host 10
2332 "file attributes with ls: %s"
2333 (tramp-make-tramp-file-name
2334 multi-method method user host localname))
2336 multi-method method user host
2338 (tramp-get-ls-command multi-method method user host)
2339 (if (eq id-format 'integer) "-ildn" "-ild")
2340 (tramp-shell-quote-argument localname)))
2341 (tramp-wait-for-output)
2342 ;; parse `ls -l' output ...
2346 (read (current-buffer))
2347 (invalid-read-syntax
2348 (when (and (equal (cadr err)
2349 "Integer constant overflow in reader")
2351 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
2353 (let* ((big (read (substring (caddr err) 0
2354 (match-beginning 1))))
2355 (small (read (match-string 1 (caddr err))))
2356 (twiddle (/ small 65536)))
2357 (cons (+ big twiddle)
2358 (- small (* twiddle 65536))))))))
2359 ;; ... file mode flags
2360 (setq res-filemodes (symbol-name (read (current-buffer))))
2362 (setq res-numlinks (read (current-buffer)))
2364 (setq res-uid (read (current-buffer)))
2365 (setq res-gid (read (current-buffer)))
2366 (when (eq id-format 'integer)
2367 (unless (numberp res-uid) (setq res-uid -1))
2368 (unless (numberp res-gid) (setq res-gid -1)))
2370 (setq res-size (read (current-buffer)))
2371 ;; From the file modes, figure out other stuff.
2372 (setq symlinkp (eq ?l (aref res-filemodes 0)))
2373 (setq dirp (eq ?d (aref res-filemodes 0)))
2374 ;; if symlink, find out file name pointed to
2376 (search-forward "-> ")
2377 (setq res-symlink-target
2378 (buffer-substring (point)
2379 (tramp-line-end-position))))
2380 ;; return data gathered
2382 ;; 0. t for directory, string (name linked to) for symbolic
2384 (or dirp res-symlink-target nil)
2385 ;; 1. Number of links to file.
2391 ;; 4. Last access time, as a list of two integers. First
2392 ;; integer has high-order 16 bits of time, second has low 16
2394 ;; 5. Last modification time, likewise.
2395 ;; 6. Last status change time, likewise.
2396 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
2397 ;; 7. Size in bytes (-1, if number is out of range).
2399 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
2401 ;; 9. t iff file's gid would change if file were deleted and
2402 ;; recreated. Will be set in `tramp-convert-file-attributes'
2404 ;; 10. inode number.
2406 ;; 11. Device number. Will be replaced by a virtual device number.
2410 (defun tramp-handle-file-attributes-with-perl
2411 (multi-method method user host localname &optional id-format)
2412 "Implement `file-attributes' for tramp files using a Perl script."
2413 (tramp-message-for-buffer multi-method method user host 10
2414 "file attributes with perl: %s"
2415 (tramp-make-tramp-file-name
2416 multi-method method user host localname))
2417 (tramp-maybe-send-perl-script multi-method method user host
2418 tramp-perl-file-attributes
2419 "tramp_file_attributes")
2420 (tramp-send-command multi-method method user host
2421 (format "tramp_file_attributes %s %s"
2422 (tramp-shell-quote-argument localname) id-format))
2423 (tramp-wait-for-output)
2424 (read (current-buffer)))
2426 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
2427 "Like `set-visited-file-modtime' for tramp files."
2428 (unless (buffer-file-name)
2429 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
2432 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
2433 (let ((f (buffer-file-name))
2435 (with-parsed-tramp-file-name f nil
2436 (let* ((attr (file-attributes f))
2437 ;; '(-1 65535) means file doesn't exists yet.
2438 (modtime (or (nth 5 attr) '(-1 65535))))
2439 (when (boundp 'last-coding-system-used)
2440 (setq coding-system-used (symbol-value 'last-coding-system-used)))
2441 ;; We use '(0 0) as a don't-know value. See also
2442 ;; `tramp-handle-file-attributes-with-ls'.
2443 (if (not (equal modtime '(0 0)))
2444 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
2447 multi-method method user host
2448 (format "%s -ild %s"
2449 (tramp-get-ls-command multi-method method user host)
2450 (tramp-shell-quote-argument localname)))
2451 (tramp-wait-for-output)
2452 (setq attr (buffer-substring (point)
2453 (progn (end-of-line) (point)))))
2454 (setq tramp-buffer-file-attributes attr))
2455 (when (boundp 'last-coding-system-used)
2456 (set 'last-coding-system-used coding-system-used))
2459 ;; CCC continue here
2461 ;; This function makes the same assumption as
2462 ;; `tramp-handle-set-visited-file-modtime'.
2463 (defun tramp-handle-verify-visited-file-modtime (buf)
2464 "Like `verify-visited-file-modtime' for tramp files.
2465 At the time `verify-visited-file-modtime' calls this function, we
2466 already know that the buffer is visiting a file and that
2467 `visited-file-modtime' does not return 0. Do not call this
2468 function directly, unless those two cases are already taken care
2470 (with-current-buffer buf
2471 ;; There is no file visiting the buffer, or the buffer has no
2472 ;; recorded last modification time.
2473 (if (or (not (buffer-file-name))
2474 (eq (visited-file-modtime) 0))
2476 (let ((f (buffer-file-name)))
2477 (with-parsed-tramp-file-name f nil
2478 (let* ((attr (file-attributes f))
2479 (modtime (nth 5 attr))
2480 (mt (visited-file-modtime)))
2483 ;; file exists, and has a known modtime.
2484 ((and attr (not (equal modtime '(0 0))))
2485 (< (abs (tramp-time-diff
2487 ;; For compatibility, deal with both the old
2488 ;; (HIGH . LOW) and the new (HIGH LOW)
2489 ;; return values of `visited-file-modtime'.
2491 (list (car mt) (cdr mt))
2494 ;; modtime has the don't know value.
2498 multi-method method user host
2499 (format "%s -ild %s"
2500 (tramp-get-ls-command multi-method method user host)
2501 (tramp-shell-quote-argument localname)))
2502 (tramp-wait-for-output)
2503 (setq attr (buffer-substring
2504 (point) (progn (end-of-line) (point)))))
2505 (equal tramp-buffer-file-attributes attr))
2506 ;; If file does not exist, say it is not modified
2507 ;; if and only if that agrees with the buffer's record.
2508 (t (equal mt '(-1 65535))))))))))
2510 (defun tramp-handle-set-file-modes (filename mode)
2511 "Like `set-file-modes' for tramp files."
2512 (with-parsed-tramp-file-name filename nil
2514 (unless (zerop (tramp-send-command-and-check
2515 multi-method method user host
2516 (format "chmod %s %s"
2517 (tramp-decimal-to-octal mode)
2518 (tramp-shell-quote-argument localname))))
2521 ;; FIXME: extract the proper text from chmod's stderr.
2522 "error while changing file's mode"
2525 ;; Simple functions using the `test' command.
2527 (defun tramp-handle-file-executable-p (filename)
2528 "Like `file-executable-p' for tramp files."
2529 (with-parsed-tramp-file-name filename nil
2530 (zerop (tramp-run-test "-x" filename))))
2532 (defun tramp-handle-file-readable-p (filename)
2533 "Like `file-readable-p' for tramp files."
2534 (with-parsed-tramp-file-name filename nil
2535 (zerop (tramp-run-test "-r" filename))))
2537 (defun tramp-handle-file-accessible-directory-p (filename)
2538 "Like `file-accessible-directory-p' for tramp files."
2539 (with-parsed-tramp-file-name filename nil
2540 (and (zerop (tramp-run-test "-d" filename))
2541 (zerop (tramp-run-test "-r" filename))
2542 (zerop (tramp-run-test "-x" filename)))))
2544 ;; When the remote shell is started, it looks for a shell which groks
2545 ;; tilde expansion. Here, we assume that all shells which grok tilde
2546 ;; expansion will also provide a `test' command which groks `-nt' (for
2547 ;; newer than). If this breaks, tell me about it and I'll try to do
2548 ;; something smarter about it.
2549 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2550 "Like `file-newer-than-file-p' for tramp files."
2551 (cond ((not (file-exists-p file1))
2553 ((not (file-exists-p file2))
2555 ;; We are sure both files exist at this point.
2558 ;; We try to get the mtime of both files. If they are not
2559 ;; equal to the "dont-know" value, then we subtract the times
2560 ;; and obtain the result.
2561 (let ((fa1 (file-attributes file1))
2562 (fa2 (file-attributes file2)))
2563 (if (and (not (equal (nth 5 fa1) '(0 0)))
2564 (not (equal (nth 5 fa2) '(0 0))))
2565 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
2566 ;; If one of them is the dont-know value, then we can
2567 ;; still try to run a shell command on the remote host.
2568 ;; However, this only works if both files are Tramp
2569 ;; files and both have the same method, same user, same
2571 (unless (and (tramp-tramp-file-p file1)
2572 (tramp-tramp-file-p file2))
2576 "Cannot check if Tramp file is newer than non-Tramp file"
2578 (with-parsed-tramp-file-name file1 v1
2579 (with-parsed-tramp-file-name file2 v2
2580 (unless (and (equal v1-multi-method v2-multi-method)
2581 (equal v1-method v2-method)
2582 (equal v1-user v2-user)
2583 (equal v1-host v2-host))
2585 (list "Files must have same method, user, host"
2587 (unless (and (tramp-tramp-file-p file1)
2588 (tramp-tramp-file-p file2))
2590 (list "Files must be tramp files on same host"
2592 (if (tramp-get-test-groks-nt
2593 v1-multi-method v1-method v1-user v1-host)
2594 (zerop (tramp-run-test2 "test" file1 file2 "-nt"))
2595 (zerop (tramp-run-test2
2596 "tramp_test_nt" file1 file2)))))))))))
2598 ;; Functions implemented using the basic functions above.
2600 (defun tramp-handle-file-modes (filename)
2601 "Like `file-modes' for tramp files."
2602 (with-parsed-tramp-file-name filename nil
2603 (when (file-exists-p filename)
2604 (tramp-mode-string-to-int
2605 (nth 8 (file-attributes filename))))))
2607 (defun tramp-handle-file-directory-p (filename)
2608 "Like `file-directory-p' for tramp files."
2609 ;; Care must be taken that this function returns `t' for symlinks
2610 ;; pointing to directories. Surely the most obvious implementation
2611 ;; would be `test -d', but that returns false for such symlinks.
2612 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
2613 ;; I now think he's right. So we could be using `test -d', couldn't
2616 ;; Alternatives: `cd %s', `test -d %s'
2617 (with-parsed-tramp-file-name filename nil
2620 (tramp-send-command-and-check
2621 multi-method method user host
2622 (format "test -d %s"
2623 (tramp-shell-quote-argument localname))
2624 t))))) ;run command in subshell
2626 (defun tramp-handle-file-regular-p (filename)
2627 "Like `file-regular-p' for tramp files."
2628 (with-parsed-tramp-file-name filename nil
2629 (and (file-exists-p filename)
2630 (eq ?- (aref (nth 8 (file-attributes filename)) 0)))))
2632 (defun tramp-handle-file-symlink-p (filename)
2633 "Like `file-symlink-p' for tramp files."
2634 (with-parsed-tramp-file-name filename nil
2635 (let ((x (car (file-attributes filename))))
2637 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2638 ;; might do weird things.
2639 (if (file-name-absolute-p x)
2640 (tramp-make-tramp-file-name
2641 multi-method method user host x)
2644 (defun tramp-handle-file-writable-p (filename)
2645 "Like `file-writable-p' for tramp files."
2646 (with-parsed-tramp-file-name filename nil
2647 (if (file-exists-p filename)
2648 ;; Existing files must be writable.
2649 (zerop (tramp-run-test "-w" filename))
2650 ;; If file doesn't exist, check if directory is writable.
2651 (and (zerop (tramp-run-test
2652 "-d" (file-name-directory filename)))
2653 (zerop (tramp-run-test
2654 "-w" (file-name-directory filename)))))))
2656 (defun tramp-handle-file-ownership-preserved-p (filename)
2657 "Like `file-ownership-preserved-p' for tramp files."
2658 (with-parsed-tramp-file-name filename nil
2659 (let ((attributes (file-attributes filename)))
2660 ;; Return t if the file doesn't exist, since it's true that no
2661 ;; information would be lost by an (attempted) delete and create.
2662 (or (null attributes)
2663 (= (nth 2 attributes)
2664 (tramp-get-remote-uid multi-method method user host))))))
2666 ;; Other file name ops.
2668 ;; ;; Matthias K
\e,Av
\e(Bppe <mkoeppe@mail.math.uni-magdeburg.de>
2669 ;; (defun tramp-handle-directory-file-name (directory)
2670 ;; "Like `directory-file-name' for tramp files."
2671 ;; (if (and (eq (aref directory (- (length directory) 1)) ?/)
2672 ;; (not (eq (aref directory (- (length directory) 2)) ?:)))
2673 ;; (substring directory 0 (- (length directory) 1))
2676 ;; ;; Philippe Troin <phil@fifi.org>
2677 ;; (defun tramp-handle-directory-file-name (directory)
2678 ;; "Like `directory-file-name' for tramp files."
2679 ;; (with-parsed-tramp-file-name directory nil
2680 ;; (let ((directory-length-1 (1- (length directory))))
2682 ;; (if (and (eq (aref directory directory-length-1) ?/)
2683 ;; (eq (string-match tramp-file-name-regexp directory) 0)
2684 ;; (/= (match-end 0) directory-length-1))
2685 ;; (substring directory 0 directory-length-1)
2688 (defun tramp-handle-directory-file-name (directory)
2689 "Like `directory-file-name' for tramp files."
2690 ;; If localname component of filename is "/", leave it unchanged.
2691 ;; Otherwise, remove any trailing slash from localname component.
2692 ;; Method, host, etc, are unchanged. Does it make sense to try
2693 ;; to avoid parsing the filename?
2694 (with-parsed-tramp-file-name directory nil
2695 (if (and (not (zerop (length localname)))
2696 (eq (aref localname (1- (length localname))) ?/)
2697 (not (string= localname "/")))
2698 (substring directory 0 -1)
2701 ;; Directory listings.
2703 (defun tramp-handle-directory-files (directory
2704 &optional full match nosort files-only)
2705 "Like `directory-files' for tramp files."
2706 (with-parsed-tramp-file-name directory nil
2709 (tramp-barf-unless-okay
2710 multi-method method user host
2711 (concat "cd " (tramp-shell-quote-argument localname))
2714 "tramp-handle-directory-files: couldn't `cd %s'"
2715 (tramp-shell-quote-argument localname))
2717 multi-method method user host
2718 (concat (tramp-get-ls-command multi-method method user host)
2720 (tramp-wait-for-output)
2721 (goto-char (point-max))
2722 (while (zerop (forward-line -1))
2723 (setq x (buffer-substring (point)
2724 (tramp-line-end-position)))
2725 (when (or (not match) (string-match match x))
2727 (push (concat (file-name-as-directory directory)
2731 (tramp-send-command multi-method method user host "cd")
2732 (tramp-wait-for-output)
2733 ;; Remove non-files or non-directories if necessary. Using
2734 ;; the remote shell for this would probably be way faster.
2735 ;; Maybe something could be adapted from
2736 ;; tramp-handle-file-name-all-completions.
2738 (let ((temp (nreverse result))
2741 (if (equal files-only t)
2744 (setq item (pop temp))
2745 (when (file-regular-p item)
2746 (push item result)))
2749 (setq item (pop temp))
2750 (when (file-directory-p item)
2751 (push item result)))))))
2754 (defun tramp-handle-directory-files-and-attributes
2755 (directory &optional full match nosort id-format)
2756 "Like `directory-files-and-attributes' for tramp files."
2757 (when (tramp-handle-file-exists-p directory)
2759 (setq directory (tramp-handle-expand-file-name directory))
2760 (with-parsed-tramp-file-name directory nil
2761 (tramp-maybe-send-perl-script multi-method method user host
2762 tramp-perl-directory-files-and-attributes
2763 "tramp_directory_files_and_attributes")
2764 (tramp-send-command multi-method method user host
2765 (format "tramp_directory_files_and_attributes %s %s"
2766 (tramp-shell-quote-argument localname)
2767 (or id-format 'integer)))
2768 (tramp-wait-for-output)
2769 (let* ((root (cons nil (let ((object (read (current-buffer))))
2770 (when (stringp object)
2775 (if (and match (not (string-match match (caadr cell))))
2777 (setcdr cell (cddr cell))
2779 (setq cell (cdr cell))
2780 (let ((l (car cell)))
2781 (tramp-convert-file-attributes multi-method method user host
2783 ;; If FULL, make file name absolute
2784 (when full (setcar l (concat directory "/" (car l)))))))
2787 (sort (cdr root) (lambda (x y) (string< (car x) (car y))))))))))
2789 ;; This function should return "foo/" for directories and "bar" for
2790 ;; files. We use `ls -ad' to get a list of files (including
2791 ;; directories), and `find . -type d \! -name . -prune' to get a list
2793 (defun tramp-handle-file-name-all-completions (filename directory)
2794 "Like `file-name-all-completions' for tramp files."
2795 (with-parsed-tramp-file-name directory nil
2796 (unless (save-match-data (string-match "/" filename))
2797 (let* ((nowild tramp-completion-without-shell-p)
2800 (tramp-barf-unless-okay
2801 multi-method method user host
2802 (format "cd %s" (tramp-shell-quote-argument localname))
2804 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
2805 (tramp-shell-quote-argument localname))
2807 ;; Get a list of directories and files, including reliably
2808 ;; tagging the directories with a trailing '/'. Because I
2809 ;; rock. --daniel@danann.net
2811 multi-method method user host
2812 (format (concat "%s -a %s 2>/dev/null | while read f; do "
2813 "if test -d \"$f\" 2>/dev/null; "
2814 "then echo \"$f/\"; else echo \"$f\"; fi; done")
2815 (tramp-get-ls-command multi-method method user host)
2816 (if (or nowild (zerop (length filename)))
2819 (tramp-shell-quote-argument filename)))))
2821 ;; Now grab the output.
2822 (tramp-wait-for-output)
2823 (goto-char (point-max))
2824 (while (zerop (forward-line -1))
2825 (push (buffer-substring (point)
2826 (tramp-line-end-position))
2829 (tramp-send-command multi-method method user host "cd")
2830 (tramp-wait-for-output)
2834 (all-completions filename (mapcar 'list result))
2838 ;; The following isn't needed for Emacs 20 but for 19.34?
2839 (defun tramp-handle-file-name-completion (filename directory)
2840 "Like `file-name-completion' for tramp files."
2841 (unless (tramp-tramp-file-p directory)
2843 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2845 (with-parsed-tramp-file-name directory nil
2848 (mapcar (lambda (x) (cons x nil))
2849 (file-name-all-completions filename directory)))))
2853 (defun tramp-handle-add-name-to-file
2854 (filename newname &optional ok-if-already-exists)
2855 "Like `add-name-to-file' for tramp files."
2856 (with-parsed-tramp-file-name filename v1
2857 (with-parsed-tramp-file-name newname v2
2858 (let ((ln (when v1 (tramp-get-remote-ln
2859 v1-multi-method v1-method v1-user v1-host))))
2860 (unless (and v1-method v2-method v1-user v2-user v1-host v2-host
2861 (equal v1-multi-method v2-multi-method)
2862 (equal v1-method v2-method)
2863 (equal v1-user v2-user)
2864 (equal v1-host v2-host))
2865 (error "add-name-to-file: %s"
2866 "only implemented for same method, same user, same host"))
2867 (when (and (not ok-if-already-exists)
2868 (file-exists-p newname)
2869 (not (numberp ok-if-already-exists))
2872 "File %s already exists; make it a new name anyway? "
2874 (error "add-name-to-file: file %s already exists" newname))
2875 (tramp-barf-unless-okay
2876 v1-multi-method v1-method v1-user v1-host
2877 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
2878 (tramp-shell-quote-argument v2-localname))
2880 "error with add-name-to-file, see buffer `%s' for details"
2883 (defun tramp-handle-copy-file
2884 (filename newname &optional ok-if-already-exists keep-date)
2885 "Like `copy-file' for tramp files."
2886 ;; Check if both files are local -- invoke normal copy-file.
2887 ;; Otherwise, use tramp from local system.
2888 (setq filename (expand-file-name filename))
2889 (setq newname (expand-file-name newname))
2890 ;; At least one file a tramp file?
2891 (if (or (tramp-tramp-file-p filename)
2892 (tramp-tramp-file-p newname))
2893 (tramp-do-copy-or-rename-file
2894 'copy filename newname ok-if-already-exists keep-date)
2895 (tramp-run-real-handler
2897 (list filename newname ok-if-already-exists keep-date))))
2899 (defun tramp-handle-rename-file
2900 (filename newname &optional ok-if-already-exists)
2901 "Like `rename-file' for tramp files."
2902 ;; Check if both files are local -- invoke normal rename-file.
2903 ;; Otherwise, use tramp from local system.
2904 (setq filename (expand-file-name filename))
2905 (setq newname (expand-file-name newname))
2906 ;; At least one file a tramp file?
2907 (if (or (tramp-tramp-file-p filename)
2908 (tramp-tramp-file-p newname))
2909 (tramp-do-copy-or-rename-file
2910 'rename filename newname ok-if-already-exists)
2911 (tramp-run-real-handler 'rename-file
2912 (list filename newname ok-if-already-exists))))
2914 (defun tramp-do-copy-or-rename-file
2915 (op filename newname &optional ok-if-already-exists keep-date)
2916 "Copy or rename a remote file.
2917 OP must be `copy' or `rename' and indicates the operation to perform.
2918 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2919 the new file (for copy) or the new name of the file (for rename).
2920 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2921 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2924 This function is invoked by `tramp-handle-copy-file' and
2925 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
2926 and `rename'. FILENAME and NEWNAME must be absolute file names."
2927 (unless (memq op '(copy rename))
2928 (error "Unknown operation `%s', must be `copy' or `rename'" op))
2929 (unless ok-if-already-exists
2930 (when (file-exists-p newname)
2931 (signal 'file-already-exists
2933 (let ((t1 (tramp-tramp-file-p filename))
2934 (t2 (tramp-tramp-file-p newname))
2935 v1-multi-method v1-method v1-user v1-host v1-localname
2936 v2-multi-method v2-method v2-user v2-host v2-localname)
2938 ;; Check which ones of source and target are Tramp files.
2939 ;; We cannot invoke `with-parsed-tramp-file-name';
2940 ;; it fails if the file isn't a Tramp file name.
2942 (with-parsed-tramp-file-name filename l
2943 (setq v1-multi-method l-multi-method
2947 v1-localname l-localname))
2948 (setq v1-localname filename))
2950 (with-parsed-tramp-file-name newname l
2951 (setq v2-multi-method l-multi-method
2955 v2-localname l-localname))
2956 (setq v2-localname newname))
2959 ;; Both are Tramp files.
2962 ;; Shortcut: if method, host, user are the same for both
2963 ;; files, we invoke `cp' or `mv' on the remote host
2965 ((and (equal v1-multi-method v2-multi-method)
2966 (equal v1-method v2-method)
2967 (equal v1-user v2-user)
2968 (equal v1-host v2-host))
2969 (tramp-do-copy-or-rename-file-directly
2970 op v1-multi-method v1-method v1-user v1-host
2971 v1-localname v2-localname keep-date))
2972 ;; If both source and target are Tramp files,
2973 ;; both are using the same copy-program, then we
2974 ;; can invoke rcp directly. Note that
2975 ;; default-directory should point to a local
2976 ;; directory if we want to invoke rcp.
2977 ((and (not v1-multi-method)
2978 (not v2-multi-method)
2979 (equal v1-method v2-method)
2980 (tramp-method-out-of-band-p
2981 v1-multi-method v1-method v1-user v1-host)
2982 (not (string-match "\\([^#]*\\)#\\(.*\\)" v1-host))
2983 (not (string-match "\\([^#]*\\)#\\(.*\\)" v2-host)))
2984 (tramp-do-copy-or-rename-file-out-of-band
2985 op filename newname keep-date))
2986 ;; No shortcut was possible. So we copy the
2987 ;; file first. If the operation was `rename', we go
2988 ;; back and delete the original file (if the copy was
2989 ;; successful). The approach is simple-minded: we
2990 ;; create a new buffer, insert the contents of the
2991 ;; source file into it, then write out the buffer to
2992 ;; the target file. The advantage is that it doesn't
2993 ;; matter which filename handlers are used for the
2994 ;; source and target file.
2996 (tramp-do-copy-or-rename-file-via-buffer
2997 op filename newname keep-date))))
2999 ;; One file is a Tramp file, the other one is local.
3001 ;; If the Tramp file has an out-of-band method, the corresponding
3002 ;; copy-program can be invoked.
3003 (if (and (not v1-multi-method)
3004 (not v2-multi-method)
3005 (or (tramp-method-out-of-band-p
3006 v1-multi-method v1-method v1-user v1-host)
3007 (tramp-method-out-of-band-p
3008 v2-multi-method v2-method v2-user v2-host)))
3009 (tramp-do-copy-or-rename-file-out-of-band
3010 op filename newname keep-date)
3011 ;; Use the generic method via a Tramp buffer.
3012 (tramp-do-copy-or-rename-file-via-buffer
3013 op filename newname keep-date)))
3016 ;; One of them must be a Tramp file.
3017 (error "Tramp implementation says this cannot happen")))))
3019 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
3020 "Use an Emacs buffer to copy or rename a file.
3021 First arg OP is either `copy' or `rename' and indicates the operation.
3022 FILENAME is the source file, NEWNAME the target file.
3023 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
3024 (let ((trampbuf (get-buffer-create "*tramp output*"))
3025 (modtime (nth 5 (file-attributes filename))))
3026 (when (and keep-date (or (null modtime) (equal modtime '(0 0))))
3028 1 (concat "Warning: cannot preserve file time stamp"
3029 " with inline copying across machines")))
3031 (set-buffer trampbuf) (erase-buffer)
3032 (insert-file-contents-literally filename)
3033 ;; We don't want the target file to be compressed, so we let-bind
3034 ;; `jka-compr-inhibit' to t.
3035 (let ((coding-system-for-write 'binary)
3036 (jka-compr-inhibit t))
3037 (write-region (point-min) (point-max) newname))
3038 ;; KEEP-DATE handling.
3040 (when (and (not (null modtime))
3041 (not (equal modtime '(0 0))))
3042 (tramp-touch newname modtime)))
3044 (set-file-modes newname (file-modes filename)))
3045 ;; If the operation was `rename', delete the original file.
3046 (unless (eq op 'copy)
3047 (delete-file filename))))
3049 (defun tramp-do-copy-or-rename-file-directly
3050 (op multi-method method user host localname1 localname2 keep-date)
3051 "Invokes `cp' or `mv' on the remote system.
3052 OP must be one of `copy' or `rename', indicating `cp' or `mv',
3053 respectively. METHOD, USER, and HOST specify the connection.
3054 LOCALNAME1 and LOCALNAME2 specify the two arguments of `cp' or `mv'.
3055 If KEEP-DATE is non-nil, preserve the time stamp when copying."
3056 ;; CCC: What happens to the timestamp when renaming?
3057 (let ((cmd (cond ((and (eq op 'copy) keep-date) "cp -f -p")
3058 ((eq op 'copy) "cp -f")
3059 ((eq op 'rename) "mv -f")
3061 "Unknown operation `%s', must be `copy' or `rename'"
3065 multi-method method user host
3068 (tramp-shell-quote-argument localname1)
3069 (tramp-shell-quote-argument localname2)))
3070 (tramp-wait-for-output)
3071 (goto-char (point-min))
3074 (and (eq op 'copy) keep-date
3075 ;; Mask cp -f error.
3076 (re-search-forward tramp-operation-not-permitted-regexp nil t))
3077 (zerop (tramp-send-command-and-check
3078 multi-method method user host nil nil)))
3079 (pop-to-buffer (current-buffer))
3081 (format "Copying directly failed, see buffer `%s' for details."
3084 ;; CCC: Maybe `chmod --reference=localname1 localname2' could be used
3086 (unless (or (eq op 'rename) keep-date)
3088 (tramp-make-tramp-file-name multi-method method user host localname2)
3090 (tramp-make-tramp-file-name
3091 multi-method method user host localname1))))))
3093 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
3094 "Invoke rcp program to copy.
3095 One of FILENAME and NEWNAME must be a Tramp name, the other must
3096 be a local filename. The method used must be an out-of-band method."
3097 (let ((t1 (tramp-tramp-file-p filename))
3098 (t2 (tramp-tramp-file-p newname))
3099 v1-multi-method v1-method v1-user v1-host v1-localname
3100 v2-multi-method v2-method v2-user v2-host v2-localname
3101 multi-method method user host copy-program copy-args
3102 source target trampbuf)
3104 ;; Check which ones of source and target are Tramp files.
3105 ;; We cannot invoke `with-parsed-tramp-file-name';
3106 ;; it fails if the file isn't a Tramp file name.
3108 (with-parsed-tramp-file-name filename l
3109 (setq v1-multi-method l-multi-method
3113 v1-localname l-localname
3114 multi-method l-multi-method
3115 method (tramp-find-method
3116 v1-multi-method v1-method v1-user v1-host)
3119 copy-program (tramp-get-method-parameter
3120 v1-multi-method method
3121 v1-user v1-host 'tramp-copy-program)
3122 copy-args (tramp-get-method-parameter
3123 v1-multi-method method
3124 v1-user v1-host 'tramp-copy-args)))
3125 (setq v1-localname filename))
3128 (with-parsed-tramp-file-name newname l
3129 (setq v2-multi-method l-multi-method
3133 v2-localname l-localname
3134 multi-method l-multi-method
3135 method (tramp-find-method
3136 v2-multi-method v2-method v2-user v2-host)
3139 copy-program (tramp-get-method-parameter
3140 v2-multi-method method
3141 v2-user v2-host 'tramp-copy-program)
3142 copy-args (tramp-get-method-parameter
3143 v2-multi-method method
3144 v2-user v2-host 'tramp-copy-args)))
3145 (setq v2-localname newname))
3147 ;; The following should be changed. We need a more general
3148 ;; mechanism to parse extra host args.
3150 (setq source v1-localname)
3151 (when (string-match "\\([^#]*\\)#\\(.*\\)" v1-host)
3152 (setq copy-args (cons "-P" (cons (match-string 2 v1-host) copy-args)))
3153 (setq v1-host (match-string 1 v1-host)))
3155 (tramp-make-copy-program-file-name
3157 (tramp-shell-quote-argument v1-localname))))
3160 (setq target v2-localname)
3161 (when (string-match "\\([^#]*\\)#\\(.*\\)" v2-host)
3162 (setq copy-args (cons "-P" (cons (match-string 2 v2-host) copy-args)))
3163 (setq v2-host (match-string 1 v2-host)))
3165 (tramp-make-copy-program-file-name
3167 (tramp-shell-quote-argument v2-localname))))
3169 ;; Handle keep-date argument
3173 (cons (tramp-get-method-parameter
3174 v1-multi-method method
3175 v1-user v1-host 'tramp-copy-keep-date-arg)
3178 (cons (tramp-get-method-parameter
3179 v2-multi-method method
3180 v2-user v2-host 'tramp-copy-keep-date-arg)
3183 (setq copy-args (append copy-args (list source target))
3184 trampbuf (generate-new-buffer
3185 (tramp-buffer-name multi-method method user host)))
3187 ;; Use an asynchronous process. By this, password can be handled.
3190 ;; Check for program.
3191 (when (and (fboundp 'executable-find)
3192 (not (executable-find copy-program)))
3193 (error "Cannot find copy program: %s" copy-program))
3195 (set-buffer trampbuf)
3196 (setq tramp-current-multi-method multi-method
3197 tramp-current-method method
3198 tramp-current-user user
3199 tramp-current-host host)
3200 (message "Transferring %s to %s..." filename newname)
3202 ;; Use rcp-like program for file transfer.
3203 (let ((p (apply 'start-process (buffer-name trampbuf) trampbuf
3204 copy-program copy-args)))
3205 (tramp-set-process-query-on-exit-flag p nil)
3206 (tramp-process-actions p multi-method method user host
3207 tramp-actions-copy-out-of-band))
3208 (kill-buffer trampbuf)
3209 (message "Transferring %s to %s...done" filename newname)
3213 (set-file-modes newname (file-modes filename))))
3215 ;; If the operation was `rename', delete the original file.
3216 (unless (eq op 'copy)
3217 (delete-file filename))))
3220 (defun tramp-handle-make-directory (dir &optional parents)
3221 "Like `make-directory' for tramp files."
3222 (setq dir (expand-file-name dir))
3223 (with-parsed-tramp-file-name dir nil
3225 (tramp-barf-unless-okay
3226 multi-method method user host
3228 (if parents "mkdir -p" "mkdir")
3229 (tramp-shell-quote-argument localname))
3231 "Couldn't make directory %s" dir))))
3233 ;; CCC error checking?
3234 (defun tramp-handle-delete-directory (directory)
3235 "Like `delete-directory' for tramp files."
3236 (setq directory (expand-file-name directory))
3237 (with-parsed-tramp-file-name directory nil
3240 multi-method method user host
3241 (format "rmdir %s ; echo ok"
3242 (tramp-shell-quote-argument localname)))
3243 (tramp-wait-for-output))))
3245 (defun tramp-handle-delete-file (filename)
3246 "Like `delete-file' for tramp files."
3247 (setq filename (expand-file-name filename))
3248 (with-parsed-tramp-file-name filename nil
3250 (unless (zerop (tramp-send-command-and-check
3251 multi-method method user host
3253 (tramp-shell-quote-argument localname))))
3254 (signal 'file-error "Couldn't delete Tramp file")))))
3258 ;; CCC: This does not seem to be enough. Something dies when
3259 ;; we try and delete two directories under TRAMP :/
3260 (defun tramp-handle-dired-recursive-delete-directory (filename)
3261 "Recursively delete the directory given.
3262 This is like `dired-recursive-delete-directory' for tramp files."
3263 (with-parsed-tramp-file-name filename nil
3264 ;; run a shell command 'rm -r <localname>'
3265 ;; Code shamelessly stolen for the dired implementation and, um, hacked :)
3266 (or (file-exists-p filename)
3269 (list "Removing old file name" "no such directory" filename)))
3270 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
3271 (tramp-send-command multi-method method user host
3272 (format "rm -r %s" (tramp-shell-quote-argument localname)))
3273 ;; Wait for the remote system to return to us...
3274 ;; This might take a while, allow it plenty of time.
3275 (tramp-wait-for-output 120)
3276 ;; Make sure that it worked...
3277 (and (file-exists-p filename)
3278 (error "Failed to recursively delete %s" filename))))
3280 (defun tramp-handle-dired-call-process (program discard &rest arguments)
3281 "Like `dired-call-process' for tramp files."
3282 (with-parsed-tramp-file-name default-directory nil
3284 (tramp-barf-unless-okay
3285 multi-method method user host
3286 (format "cd %s" (tramp-shell-quote-argument localname))
3288 "tramp-handle-dired-call-process: Couldn't `cd %s'"
3289 (tramp-shell-quote-argument localname))
3291 multi-method method user host
3292 (mapconcat #'tramp-shell-quote-argument (cons program arguments) " "))
3293 (tramp-wait-for-output))
3295 ;; We cannot use `insert-buffer' because the tramp buffer
3296 ;; changes its contents before insertion due to calling
3297 ;; `expand-file' and alike.
3299 (with-current-buffer
3300 (tramp-get-buffer multi-method method user host)
3304 (tramp-send-command-and-check multi-method method user host nil)
3305 (tramp-send-command multi-method method user host "cd")
3306 (tramp-wait-for-output)))))
3308 (defun tramp-handle-dired-compress-file (file &rest ok-flag)
3309 "Like `dired-compress-file' for tramp files."
3310 ;; OK-FLAG is valid for XEmacs only, but not implemented.
3311 ;; Code stolen mainly from dired-aux.el.
3312 (with-parsed-tramp-file-name file nil
3315 (if (not (featurep 'xemacs))
3317 (symbol-value 'dired-compress-file-suffixes)
3318 ;; XEmacs has `dired-compression-method-alist', which is
3319 ;; transformed into `dired-compress-file-suffixes' structure.
3322 (list (concat (regexp-quote (nth 1 x)) "\\'")
3324 (mapconcat 'identity (nth 3 x) " ")))
3325 (symbol-value 'dired-compression-method-alist))))
3327 ;; See if any suffix rule matches this file name.
3329 (let (case-fold-search)
3330 (if (string-match (car (car suffixes)) localname)
3331 (setq suffix (car suffixes) suffixes nil))
3332 (setq suffixes (cdr suffixes))))
3334 (cond ((file-symlink-p file)
3336 ((and suffix (nth 2 suffix))
3337 ;; We found an uncompression rule.
3338 (message "Uncompressing %s..." file)
3339 (when (zerop (tramp-send-command-and-check
3340 multi-method method user host
3341 (concat (nth 2 suffix) " " localname)))
3342 (message "Uncompressing %s...done" file)
3343 ;; `dired-remove-file' is not defined in XEmacs
3344 (funcall (symbol-function 'dired-remove-file) file)
3345 (string-match (car suffix) file)
3346 (concat (substring file 0 (match-beginning 0)))))
3348 ;; We don't recognize the file as compressed, so compress it.
3350 (message "Compressing %s..." file)
3351 (when (zerop (tramp-send-command-and-check
3352 multi-method method user host
3353 (concat "gzip -f " localname)))
3354 (message "Compressing %s...done" file)
3355 ;; `dired-remove-file' is not defined in XEmacs
3356 (funcall (symbol-function 'dired-remove-file) file)
3357 (cond ((file-exists-p (concat file ".gz"))
3358 (concat file ".gz"))
3359 ((file-exists-p (concat file ".z"))
3363 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
3364 ;; not sure at all that this is the right way to do it, but let's hope
3365 ;; it works for now, and wait for a guru to point out the Right Way to
3367 ;;(eval-when-compile
3368 ;; (unless (fboundp 'dired-insert-set-properties)
3369 ;; (fset 'dired-insert-set-properties 'ignore)))
3370 ;; Gerd suggests this:
3371 (eval-when-compile (require 'dired))
3372 ;; Note that dired is required at run-time, too, when it is needed.
3373 ;; It is only needed on XEmacs for the function
3374 ;; `dired-insert-set-properties'.
3376 (defun tramp-handle-insert-directory
3377 (filename switches &optional wildcard full-directory-p)
3378 "Like `insert-directory' for tramp files."
3379 (if (and (boundp 'ls-lisp-use-insert-directory-program)
3380 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
3381 (tramp-run-real-handler 'insert-directory
3382 (list filename switches wildcard full-directory-p))
3383 ;; For the moment, we assume that the remote "ls" program does not
3384 ;; grok "--dired". In the future, we should detect this on
3385 ;; connection setup.
3386 (when (string-match "^--dired\\s-+" switches)
3387 (setq switches (replace-match "" nil t switches)))
3388 (setq filename (expand-file-name filename))
3389 (with-parsed-tramp-file-name filename nil
3390 (tramp-message-for-buffer
3391 multi-method method user host 10
3392 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
3393 switches filename (if wildcard "yes" "no")
3394 (if full-directory-p "yes" "no"))
3396 (setq wildcard (file-name-nondirectory localname))
3397 (setq localname (file-name-directory localname)))
3398 (when (listp switches)
3399 (setq switches (mapconcat 'identity switches " ")))
3400 (unless full-directory-p
3401 (setq switches (concat "-d " switches)))
3403 (setq switches (concat switches " " wildcard)))
3405 ;; If `full-directory-p', we just say `ls -l FILENAME'.
3406 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
3407 (if full-directory-p
3409 multi-method method user host
3411 (tramp-get-ls-command multi-method method user host)
3415 (tramp-shell-quote-argument (concat localname ".")))))
3416 (tramp-barf-unless-okay
3417 multi-method method user host
3418 (format "cd %s" (tramp-shell-quote-argument
3419 (file-name-directory localname)))
3422 (tramp-shell-quote-argument (file-name-directory localname)))
3424 multi-method method user host
3426 (tramp-get-ls-command multi-method method user host)
3430 (if (zerop (length (file-name-nondirectory localname)))
3432 (tramp-shell-quote-argument
3433 (file-name-nondirectory localname)))))))
3434 (sit-for 1) ;needed for rsh but not ssh?
3435 (tramp-wait-for-output))
3436 ;; The following let-binding is used by code that's commented
3437 ;; out. Let's leave the let-binding in for a while to see
3438 ;; that the commented-out code is really not needed. Commenting-out
3439 ;; happened on 2003-03-13.
3440 (let ((old-pos (point)))
3441 ;; We cannot use `insert-buffer' because the tramp buffer
3442 ;; changes its contents before insertion due to calling
3443 ;; `expand-file' and alike.
3445 (with-current-buffer
3446 (tramp-get-buffer multi-method method user host)
3448 ;; On XEmacs, we want to call (exchange-point-and-mark t), but
3449 ;; that doesn't exist on Emacs, so we use this workaround instead.
3450 ;; Since zmacs-region-stays doesn't exist in Emacs, this ought to
3451 ;; be safe. Thanks to Daniel Pittman <daniel@danann.net>.
3452 ;; (let ((zmacs-region-stays t))
3453 ;; (exchange-point-and-mark))
3455 (tramp-send-command multi-method method user host "cd")
3456 (tramp-wait-for-output))
3457 ;; For the time being, the XEmacs kludge is commented out.
3458 ;; Please test it on various XEmacs versions to see if it works.
3459 ;; ;; Another XEmacs specialty follows. What's the right way to do
3461 ;; (when (and (featurep 'xemacs)
3462 ;; (eq major-mode 'dired-mode))
3465 ;; (dired-insert-set-properties old-pos (point))))
3468 ;; Continuation of kluge to pacify byte-compiler.
3469 ;;(eval-when-compile
3470 ;; (when (eq (symbol-function 'dired-insert-set-properties) 'ignore)
3471 ;; (fmakunbound 'dired-insert-set-properties)))
3473 ;; CCC is this the right thing to do?
3474 (defun tramp-handle-unhandled-file-name-directory (filename)
3475 "Like `unhandled-file-name-directory' for tramp files."
3476 (with-parsed-tramp-file-name filename nil
3477 (expand-file-name "~/")))
3479 ;; Canonicalization of file names.
3481 (defun tramp-drop-volume-letter (name)
3482 "Cut off unnecessary drive letter from file NAME.
3483 The function `tramp-handle-expand-file-name' calls `expand-file-name'
3484 locally on a remote file name. When the local system is a W32 system
3485 but the remote system is Unix, this introduces a superfluous drive
3486 letter into the file name. This function removes it.
3488 Doesn't do anything if the NAME does not start with a drive letter."
3489 (if (and (> (length name) 1)
3490 (char-equal (aref name 1) ?:)
3491 (let ((c1 (aref name 0)))
3492 (or (and (>= c1 ?A) (<= c1 ?Z))
3493 (and (>= c1 ?a) (<= c1 ?z)))))
3497 (defun tramp-handle-expand-file-name (name &optional dir)
3498 "Like `expand-file-name' for tramp files.
3499 If the localname part of the given filename starts with \"/../\" then
3500 the result will be a local, non-Tramp, filename."
3501 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
3502 (setq dir (or dir default-directory "/"))
3503 ;; Unless NAME is absolute, concat DIR and NAME.
3504 (unless (file-name-absolute-p name)
3505 (setq name (concat (file-name-as-directory dir) name)))
3506 ;; If NAME is not a tramp file, run the real handler
3507 (if (not (tramp-tramp-file-p name))
3508 (tramp-run-real-handler 'expand-file-name
3511 (with-parsed-tramp-file-name name nil
3512 (unless (file-name-absolute-p localname)
3513 (setq localname (concat "~/" localname)))
3515 ;; Tilde expansion if necessary. This needs a shell which
3516 ;; groks tilde expansion! The function `tramp-find-shell' is
3517 ;; supposed to find such a shell on the remote host. Please
3518 ;; tell me about it when this doesn't work on your system.
3519 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
3520 (let ((uname (match-string 1 localname))
3521 (fname (match-string 2 localname)))
3522 ;; We cannot simply apply "~/", because under sudo "~/" is
3523 ;; expanded to the local user home directory but to the
3524 ;; root home directory. On the other hand, using always
3525 ;; the default user name for tilde expansion is not
3526 ;; appropriate either, because ssh and companions might
3527 ;; use a user name from the config file.
3528 (when (and (string-equal uname "~")
3531 (tramp-find-method multi-method method user host)))
3532 (setq uname (concat uname (or user "root"))))
3533 ;; CCC fanatic error checking?
3534 (set-buffer (tramp-get-buffer multi-method method user host))
3537 multi-method method user host
3538 (format "cd %s; pwd" uname)
3540 (tramp-wait-for-output)
3541 (goto-char (point-min))
3542 (setq uname (buffer-substring (point) (tramp-line-end-position)))
3543 (setq localname (concat uname fname))
3545 ;; There might be a double slash, for example when "~/"
3546 ;; expands to "/". Remove this.
3547 (while (string-match "//" localname)
3548 (setq localname (replace-match "/" t t localname)))
3549 ;; No tilde characters in file name, do normal
3550 ;; expand-file-name (this does "/./" and "/../"). We bind
3551 ;; directory-sep-char here for XEmacs on Windows, which would
3552 ;; otherwise use backslash. `default-directory' is bound to
3553 ;; "/", because on Windows there would be problems with UNC
3554 ;; shares or Cygwin mounts.
3555 (tramp-let-maybe directory-sep-char ?/
3556 (let ((default-directory "/"))
3557 (tramp-make-tramp-file-name
3558 multi-method (or method (tramp-find-default-method user host))
3560 (tramp-drop-volume-letter
3561 (tramp-run-real-handler 'expand-file-name
3562 (list localname))))))))))
3564 ;; old version follows. it uses ".." to cross file handler
3566 ;; ;; Look if localname starts with "/../" construct. If this is
3567 ;; ;; the case, then we return a local name instead of a remote name.
3568 ;; (if (string-match "^/\\.\\./" localname)
3569 ;; (expand-file-name (substring localname 3))
3570 ;; ;; No tilde characters in file name, do normal
3571 ;; ;; expand-file-name (this does "/./" and "/../"). We bind
3572 ;; ;; directory-sep-char here for XEmacs on Windows, which
3573 ;; ;; would otherwise use backslash.
3574 ;; (let ((directory-sep-char ?/))
3575 ;; (tramp-make-tramp-file-name
3576 ;; multi-method method user host
3577 ;; (tramp-drop-volume-letter
3578 ;; (tramp-run-real-handler 'expand-file-name
3579 ;; (list localname))))))))))
3583 (defvar tramp-async-proc nil
3584 "Global variable keeping asynchronous process object.
3585 Used in `tramp-handle-shell-command'")
3587 (defvar tramp-display-shell-command-buffer t
3588 "Whether to display output buffer of `shell-command'.
3589 This is necessary for handling DISPLAY of `process-file'.")
3591 (defun tramp-handle-shell-command (command &optional output-buffer error-buffer)
3592 "Like `shell-command' for tramp files.
3593 This will break if COMMAND prints a newline, followed by the value of
3594 `tramp-end-of-output', followed by another newline."
3595 ;; Asynchronous processes are far from being perfect. But it works at least
3596 ;; for `find-grep-dired' and `find-name-dired' in Emacs 22.
3597 (if (tramp-tramp-file-p default-directory)
3598 (with-parsed-tramp-file-name default-directory nil
3599 (let ((asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3601 (unless output-buffer
3605 "*Async Shell Command*"
3606 "*Shell Command Output*")))
3607 (set-buffer output-buffer)
3609 (unless (bufferp output-buffer)
3610 (setq output-buffer (current-buffer)))
3611 (set-buffer output-buffer)
3612 ;; Tramp doesn't handle the asynchronous case by an asynchronous
3613 ;; process. Instead of, another asynchronous process is opened
3614 ;; which gets the output of the (synchronous) Tramp process
3615 ;; via process-filter. ERROR-BUFFER is disabled.
3617 (setq command (substring command 0 (match-beginning 0))
3619 tramp-async-proc (start-process (buffer-name output-buffer)
3620 output-buffer "cat")))
3622 (tramp-barf-unless-okay
3623 multi-method method user host
3624 (format "cd %s" (tramp-shell-quote-argument localname))
3626 "tramp-handle-shell-command: Couldn't `cd %s'"
3627 (tramp-shell-quote-argument localname))
3628 ;; Define the process filter
3632 (tramp-get-buffer multi-method method user host))
3633 '(lambda (process string)
3634 ;; Write the output into the Tramp Process
3635 (save-current-buffer
3636 (set-buffer (process-buffer process))
3637 (goto-char (point-max))
3639 ;; Hand-over output to asynchronous process.
3642 (regexp-quote tramp-end-of-output) string)))
3645 (substring string 0 (1- (match-beginning 0)))))
3646 (process-send-string tramp-async-proc string)
3648 (set-process-filter process nil)
3649 (process-send-eof tramp-async-proc))))))
3652 multi-method method user host
3654 (format "( %s ) 2>/tmp/tramp.$$.err; tramp_old_status=$?"
3656 (format "%s; tramp_old_status=$?" command)))
3657 (unless asynchronous
3658 (tramp-wait-for-output)))
3659 (unless asynchronous
3660 ;; We cannot use `insert-buffer' because the tramp buffer
3661 ;; changes its contents before insertion due to calling
3662 ;; `expand-file' and alike.
3664 (with-current-buffer
3665 (tramp-get-buffer multi-method method user host)
3669 (unless (bufferp error-buffer)
3670 (setq error-buffer (get-buffer-create error-buffer)))
3672 multi-method method user host
3673 "cat /tmp/tramp.$$.err")
3674 (tramp-wait-for-output)
3675 (set-buffer error-buffer)
3676 ;; Same comment as above
3678 (with-current-buffer
3679 (tramp-get-buffer multi-method method user host)
3681 (tramp-send-command-and-check
3682 multi-method method user host "rm -f /tmp/tramp.$$.err")))
3684 (tramp-send-command multi-method method user host "cd")
3685 (unless asynchronous
3686 (tramp-wait-for-output))
3688 multi-method method user host
3689 (concat "tramp_set_exit_status $tramp_old_status;"
3690 " echo tramp_exit_status $?"))
3691 (unless asynchronous
3692 (tramp-wait-for-output)
3693 (goto-char (point-max))
3694 (unless (search-backward "tramp_exit_status " nil t)
3695 (error "Couldn't find exit status of `%s'" command))
3696 (skip-chars-forward "^ ")
3697 (setq status (read (current-buffer)))))
3698 (unless (zerop (buffer-size))
3699 (when tramp-display-shell-command-buffer
3700 (display-buffer output-buffer)))
3702 ;; The following is only executed if something strange was
3703 ;; happening. Emit a helpful message and do it anyway.
3704 (message "tramp-handle-shell-command called with non-tramp directory: `%s'"
3706 (tramp-run-real-handler 'shell-command
3707 (list command output-buffer error-buffer))))
3709 (defun tramp-handle-process-file (program &optional infile buffer display &rest args)
3710 "Like `process-file' for Tramp files."
3711 (when infile (error "Implementation does not handle input from file"))
3712 (when (and (numberp buffer) (zerop buffer))
3713 (error "Implementation does not handle immediate return"))
3714 (when (consp buffer) (error "Implementation does not handle error files"))
3715 (let ((tramp-display-shell-command-buffer display))
3717 (mapconcat 'tramp-shell-quote-argument (cons program args) " ")
3722 (defsubst tramp-make-temp-file ()
3723 (funcall (if (fboundp 'make-temp-file) 'make-temp-file 'make-temp-name)
3724 (expand-file-name tramp-temp-name-prefix
3725 (tramp-temporary-file-directory))))
3727 (defun tramp-handle-file-local-copy (filename)
3728 "Like `file-local-copy' for tramp files."
3729 (with-parsed-tramp-file-name filename nil
3730 (let ((tramp-buf (tramp-get-buffer multi-method method user host))
3731 ;; We used to bind the following as late as possible.
3732 ;; loc-enc and loc-dec were bound directly before the if
3733 ;; statement that checks them. But the functions
3734 ;; tramp-get-* might invoke the "are you awake" check in
3735 ;; tramp-maybe-open-connection, which is an unfortunate time
3736 ;; since we rely on the buffer contents at that spot.
3737 (rem-enc (tramp-get-remote-encoding multi-method method user host))
3738 (rem-dec (tramp-get-remote-decoding multi-method method user host))
3739 (loc-enc (tramp-get-local-encoding multi-method method user host))
3740 (loc-dec (tramp-get-local-decoding multi-method method user host))
3742 (unless (file-exists-p filename)
3743 (error "Cannot make local copy of non-existing file `%s'"
3745 (setq tmpfil (tramp-make-temp-file))
3747 (cond ((tramp-method-out-of-band-p multi-method method user host)
3748 ;; `copy-file' handles out-of-band methods
3749 (copy-file filename tmpfil t t))
3751 ((and rem-enc rem-dec)
3752 ;; Use inline encoding for file transfer.
3754 ;; Following line for setting tramp-current-method,
3755 ;; tramp-current-user, tramp-current-host.
3756 (set-buffer tramp-buf)
3757 (tramp-message 5 "Encoding remote file %s..." filename)
3758 (tramp-barf-unless-okay
3759 multi-method method user host
3760 (concat rem-enc " < " (tramp-shell-quote-argument localname))
3762 "Encoding remote file failed, see buffer `%s' for details"
3764 ;; Remove trailing status code
3765 (goto-char (point-max))
3766 (delete-region (point) (progn (forward-line -1) (point)))
3768 (tramp-message 5 "Decoding remote file %s..." filename)
3770 ;; Here is where loc-enc and loc-dec used to be let-bound.
3771 (if (and (symbolp loc-dec) (fboundp loc-dec))
3772 ;; If local decoding is a function, we call it.
3773 (let ((tmpbuf (get-buffer-create " *tramp tmp*")))
3776 (insert-buffer-substring tramp-buf)
3777 (tramp-message-for-buffer
3778 multi-method method user host
3779 6 "Decoding remote file %s with function %s..."
3782 ;; Douglas Gray Stephens <DGrayStephens@slb.com>
3783 ;; says that we need to strip tramp_exit_status
3784 ;; line from the output here. Go to point-max,
3785 ;; search backward for tramp_exit_status, delete
3786 ;; between point and point-max if found.
3787 (let ((coding-system-for-write 'binary))
3788 (funcall loc-dec (point-min) (point-max))
3789 (write-region (point-min) (point-max) tmpfil))
3790 (kill-buffer tmpbuf))
3791 ;; If tramp-decoding-function is not defined for this
3792 ;; method, we invoke tramp-decoding-command instead.
3793 (let ((tmpfil2 (tramp-make-temp-file)))
3794 (write-region (point-min) (point-max) tmpfil2)
3796 6 "Decoding remote file %s with command %s..."
3798 (tramp-call-local-coding-command
3799 loc-dec tmpfil2 tmpfil)
3800 (delete-file tmpfil2)))
3801 (tramp-message-for-buffer
3802 multi-method method user host
3803 5 "Decoding remote file %s...done" filename)
3804 ;; Set proper permissions.
3805 (set-file-modes tmpfil (file-modes filename))))
3807 (t (error "Wrong method specification for `%s'" method)))
3810 (defun tramp-handle-file-remote-p (filename)
3811 "Like `file-remote-p' for tramp files."
3812 (when (tramp-tramp-file-p filename)
3813 (with-parsed-tramp-file-name filename nil
3814 (make-tramp-file-name
3815 :multi-method multi-method
3821 (defun tramp-handle-insert-file-contents
3822 (filename &optional visit beg end replace)
3823 "Like `insert-file-contents' for tramp files."
3824 (barf-if-buffer-read-only)
3825 (setq filename (expand-file-name filename))
3826 (with-parsed-tramp-file-name filename nil
3827 (if (not (file-exists-p filename))
3830 (setq buffer-file-name filename)
3831 (set-visited-file-modtime)
3832 (set-buffer-modified-p nil))
3834 (format "File `%s' not found on remote host" filename))
3835 (list (expand-file-name filename) 0))
3836 ;; `insert-file-contents-literally' takes care to avoid calling
3837 ;; jka-compr. By let-binding inhibit-file-name-operation, we
3838 ;; propagate that care to the file-local-copy operation.
3840 (let ((inhibit-file-name-operation
3841 (when (eq inhibit-file-name-operation
3842 'insert-file-contents)
3844 (file-local-copy filename)))
3845 coding-system-used result)
3847 (setq buffer-file-name filename)
3848 (set-visited-file-modtime)
3849 (set-buffer-modified-p nil))
3850 (tramp-message-for-buffer
3851 multi-method method user host
3852 9 "Inserting local temp file `%s'..." local-copy)
3853 (setq result (insert-file-contents local-copy nil beg end replace))
3854 ;; Now `last-coding-system-used' has right value. Remember it.
3855 (when (boundp 'last-coding-system-used)
3856 (setq coding-system-used (symbol-value 'last-coding-system-used)))
3857 (tramp-message-for-buffer
3858 multi-method method user host
3859 9 "Inserting local temp file `%s'...done" local-copy)
3860 (delete-file local-copy)
3861 (when (boundp 'last-coding-system-used)
3862 (set 'last-coding-system-used coding-system-used))
3863 (list (expand-file-name filename)
3864 (second result))))))
3867 (defun tramp-handle-find-backup-file-name (filename)
3868 "Like `find-backup-file-name' for tramp files."
3869 (with-parsed-tramp-file-name filename nil
3870 ;; We set both variables. It doesn't matter whether it is
3872 (let ((backup-directory-alist
3874 (when (boundp 'backup-directory-alist)
3875 (if (boundp 'tramp-backup-directory-alist)
3880 (if (and (stringp (cdr x))
3881 (file-name-absolute-p (cdr x))
3882 (not (tramp-file-name-p (cdr x))))
3883 (tramp-make-tramp-file-name
3884 multi-method method user host (cdr x))
3886 (symbol-value 'tramp-backup-directory-alist))
3887 (symbol-value 'backup-directory-alist))))
3889 (bkup-backup-directory-info
3891 (when (boundp 'bkup-backup-directory-info)
3892 (if (boundp 'tramp-bkup-backup-directory-info)
3898 (if (and (stringp (car (cdr x)))
3899 (file-name-absolute-p (car (cdr x)))
3900 (not (tramp-file-name-p (car (cdr x)))))
3901 (tramp-make-tramp-file-name
3902 multi-method method user host (car (cdr x)))
3905 (symbol-value 'tramp-bkup-backup-directory-info))
3906 (symbol-value 'bkup-backup-directory-info)))))
3908 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
3910 (defun tramp-handle-make-auto-save-file-name ()
3911 "Like `make-auto-save-file-name' for tramp files.
3912 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3913 (when tramp-auto-save-directory
3914 (unless (file-exists-p tramp-auto-save-directory)
3915 (make-directory tramp-auto-save-directory t)))
3916 ;; jka-compr doesn't like auto-saving, so by appending "~" to the
3917 ;; file name we make sure that jka-compr isn't used for the
3919 (let ((buffer-file-name
3920 (if tramp-auto-save-directory
3922 (tramp-subst-strs-in-string
3930 tramp-auto-save-directory)
3931 (buffer-file-name))))
3932 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3933 ;; it is not a magic file name operation (since Emacs 22).
3934 ;; We must deactivate it temporarily.
3935 (if (not (ad-is-active 'make-auto-save-file-name))
3936 (tramp-run-real-handler
3937 'make-auto-save-file-name nil)
3939 (ad-deactivate 'make-auto-save-file-name)
3941 (tramp-run-real-handler
3942 'make-auto-save-file-name nil)
3943 (ad-activate 'make-auto-save-file-name)))))
3946 ;; CCC grok APPEND, LOCKNAME, CONFIRM
3947 (defun tramp-handle-write-region
3948 (start end filename &optional append visit lockname confirm)
3949 "Like `write-region' for tramp files."
3950 (unless (eq append nil)
3951 (error "Cannot append to file using tramp (`%s')" filename))
3952 (setq filename (expand-file-name filename))
3953 ;; Following part commented out because we don't know what to do about
3954 ;; file locking, and it does not appear to be a problem to ignore it.
3955 ;; Ange-ftp ignores it, too.
3956 ;; (when (and lockname (stringp lockname))
3957 ;; (setq lockname (expand-file-name lockname)))
3958 ;; (unless (or (eq lockname nil)
3959 ;; (string= lockname filename))
3961 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3962 ;; XEmacs takes a coding system as the seventh argument, not `confirm'
3963 (when (and (not (featurep 'xemacs))
3964 confirm (file-exists-p filename))
3965 (unless (y-or-n-p (format "File %s exists; overwrite anyway? "
3967 (error "File not overwritten")))
3968 (with-parsed-tramp-file-name filename nil
3969 (let ((curbuf (current-buffer))
3970 (rem-enc (tramp-get-remote-encoding multi-method method user host))
3971 (rem-dec (tramp-get-remote-decoding multi-method method user host))
3972 (loc-enc (tramp-get-local-encoding multi-method method user host))
3973 (loc-dec (tramp-get-local-decoding multi-method method user host))
3974 (trampbuf (get-buffer-create "*tramp output*"))
3975 (modes (file-modes filename))
3976 ;; We use this to save the value of `last-coding-system-used'
3977 ;; after writing the tmp file. At the end of the function,
3978 ;; we set `last-coding-system-used' to this saved value.
3979 ;; This way, any intermediary coding systems used while
3980 ;; talking to the remote shell or suchlike won't hose this
3981 ;; variable. This approach was snarfed from ange-ftp.el.
3984 ;; Write region into a tmp file. This isn't really needed if we
3985 ;; use an encoding function, but currently we use it always
3986 ;; because this makes the logic simpler.
3987 (setq tmpfil (tramp-make-temp-file))
3988 ;; Set current buffer. If connection wasn't open, `file-modes' has
3989 ;; changed it accidently.
3991 ;; We say `no-message' here because we don't want the visited file
3992 ;; modtime data to be clobbered from the temp file. We call
3993 ;; `set-visited-file-modtime' ourselves later on.
3994 (tramp-run-real-handler
3996 (if confirm ; don't pass this arg unless defined for backward compat.
3997 (list start end tmpfil append 'no-message lockname confirm)
3998 (list start end tmpfil append 'no-message lockname)))
3999 ;; Now, `last-coding-system-used' has the right value. Remember it.
4000 (when (boundp 'last-coding-system-used)
4001 (setq coding-system-used (symbol-value 'last-coding-system-used)))
4002 ;; The permissions of the temporary file should be set. If
4003 ;; filename does not exist (eq modes nil) it has been renamed to
4004 ;; the backup file. This case `save-buffer' handles
4006 (when modes (set-file-modes tmpfil modes))
4007 ;; This is a bit lengthy due to the different methods possible for
4008 ;; file transfer. First, we check whether the method uses an rcp
4009 ;; program. If so, we call it. Otherwise, both encoding and
4010 ;; decoding command must be specified. However, if the method
4011 ;; _also_ specifies an encoding function, then that is used for
4012 ;; encoding the contents of the tmp file.
4013 (cond ((tramp-method-out-of-band-p multi-method method user host)
4014 ;; `copy-file' handles out-of-band methods
4015 (copy-file tmpfil filename t t))
4017 ((and rem-enc rem-dec)
4018 ;; Use inline file transfer
4019 (let ((tmpbuf (get-buffer-create " *tramp file transfer*")))
4021 ;; Encode tmpfil into tmpbuf
4022 (tramp-message-for-buffer multi-method method user host
4023 5 "Encoding region...")
4026 ;; Use encoding function or command.
4027 (if (and (symbolp loc-enc) (fboundp loc-enc))
4029 (tramp-message-for-buffer
4030 multi-method method user host
4031 6 "Encoding region using function `%s'..."
4032 (symbol-name loc-enc))
4033 (insert-file-contents-literally tmpfil)
4034 ;; CCC. The following `let' is a workaround for
4035 ;; the base64.el that comes with pgnus-0.84. If
4036 ;; both of the following conditions are
4037 ;; satisfied, it tries to write to a local file
4038 ;; in default-directory, but at this point,
4039 ;; default-directory is remote.
4040 ;; (CALL-PROCESS-REGION can't write to remote
4041 ;; files, it seems.) The file in question is a
4043 (let ((default-directory
4044 (tramp-temporary-file-directory)))
4045 (funcall loc-enc (point-min) (point-max)))
4046 (goto-char (point-max))
4049 (tramp-message-for-buffer
4050 multi-method method user host
4051 6 "Encoding region using command `%s'..." loc-enc)
4052 (unless (equal 0 (tramp-call-local-coding-command
4054 (pop-to-buffer trampbuf)
4055 (error (concat "Cannot write to `%s', local encoding"
4056 " command `%s' failed")
4058 ;; Send tmpbuf into remote decoding command which
4059 ;; writes to remote file. Because this happens on the
4060 ;; remote host, we cannot use the function.
4061 (tramp-message-for-buffer
4062 multi-method method user host
4063 5 "Decoding region into remote file %s..." filename)
4065 multi-method method user host
4066 (format "%s >%s <<'EOF'"
4068 (tramp-shell-quote-argument localname)))
4070 (tramp-message-for-buffer
4071 multi-method method user host
4072 6 "Sending data to remote host...")
4073 (tramp-send-string multi-method method user host
4075 ;; wait for remote decoding to complete
4076 (tramp-message-for-buffer
4077 multi-method method user host
4078 6 "Sending end of data token...")
4080 multi-method method user host "EOF" nil t)
4081 (tramp-message-for-buffer
4082 multi-method method user host 6
4083 "Waiting for remote host to process data...")
4084 (set-buffer (tramp-get-buffer multi-method method user host))
4085 (tramp-wait-for-output)
4086 (tramp-barf-unless-okay
4087 multi-method method user host nil nil 'file-error
4088 (concat "Couldn't write region to `%s',"
4089 " decode using `%s' failed")
4091 (tramp-message 5 "Decoding region into remote file %s...done"
4093 (kill-buffer tmpbuf))))
4096 (concat "Method `%s' should specify both encoding and "
4097 "decoding command or an rcp program")
4099 (delete-file tmpfil)
4100 (unless (equal curbuf (current-buffer))
4101 (error "Buffer has changed from `%s' to `%s'"
4102 curbuf (current-buffer)))
4103 (when (or (eq visit t) (stringp visit))
4104 (set-visited-file-modtime
4105 ;; We must pass modtime explicitely, because filename can be different
4106 ;; from (buffer-file-name), f.e. if `file-precious-flag' is set.
4107 (nth 5 (file-attributes filename))))
4108 ;; Make `last-coding-system-used' have the right value.
4109 (when (boundp 'last-coding-system-used)
4110 (set 'last-coding-system-used coding-system-used))
4111 (when (or (eq visit t)
4114 (message "Wrote %s" filename)))))
4116 ;; Call down to the real handler.
4117 ;; Because EFS does not play nicely with TRAMP (both systems match a
4118 ;; TRAMP file name) it is needed to disable efs as well as tramp for the
4121 ;; Other than that, this is the canon file-handler code that the doco
4122 ;; says should be used here. Which is nice.
4124 ;; Under XEmacs current, EFS also hooks in as
4125 ;; efs-sifn-handler-function to handle any filename with environment
4126 ;; variables. This has two implications:
4127 ;; 1) That EFS may not be completely dead (yet) for TRAMP filenames
4128 ;; 2) That TRAMP might want to do the same thing.
4129 ;; Details as they come in.
4131 ;; Daniel Pittman <daniel@danann.net>
4133 ;; (defun tramp-run-real-handler (operation args)
4134 ;; "Invoke normal file name handler for OPERATION.
4135 ;; This inhibits EFS and Ange-FTP, too, because they conflict with tramp.
4136 ;; First arg specifies the OPERATION, remaining ARGS are passed to the
4138 ;; (let ((inhibit-file-name-handlers
4139 ;; (list 'tramp-file-name-handler
4140 ;; 'efs-file-handler-function
4141 ;; 'ange-ftp-hook-function
4142 ;; (and (eq inhibit-file-name-operation operation)
4143 ;; inhibit-file-name-handlers)))
4144 ;; (inhibit-file-name-operation operation))
4145 ;; (apply operation args)))
4147 (defun tramp-run-real-handler (operation args)
4148 "Invoke normal file name handler for OPERATION.
4149 First arg specifies the OPERATION, second arg is a list of arguments to
4150 pass to the OPERATION."
4151 (let* ((inhibit-file-name-handlers
4152 `(tramp-file-name-handler
4153 tramp-completion-file-name-handler
4154 cygwin-mount-name-hook-function
4155 cygwin-mount-map-drive-hook-function
4157 ,(and (eq inhibit-file-name-operation operation)
4158 inhibit-file-name-handlers)))
4159 (inhibit-file-name-operation operation))
4160 (apply operation args)))
4162 ;; This function is used from `tramp-completion-file-name-handler' functions
4163 ;; only, if `tramp-completion-mode' is true. But this cannot be checked here
4164 ;; because the check is based on a full filename, not available for all
4165 ;; basic I/O operations.
4166 (defun tramp-completion-run-real-handler (operation args)
4167 "Invoke `tramp-file-name-handler' for OPERATION.
4168 First arg specifies the OPERATION, second arg is a list of arguments to
4169 pass to the OPERATION."
4170 (let* ((inhibit-file-name-handlers
4171 `(tramp-completion-file-name-handler
4172 cygwin-mount-name-hook-function
4173 cygwin-mount-map-drive-hook-function
4175 ,(and (eq inhibit-file-name-operation operation)
4176 inhibit-file-name-handlers)))
4177 (inhibit-file-name-operation operation))
4178 (apply operation args)))
4180 ;; We handle here all file primitives. Most of them have the file
4181 ;; name as first parameter; nevertheless we check for them explicitly
4182 ;; in order to be signalled if a new primitive appears. This
4183 ;; scenario is needed because there isn't a way to decide by
4184 ;; syntactical means whether a foreign method must be called. It would
4185 ;; ease the life if `file-name-handler-alist' would support a decision
4186 ;; function as well but regexp only.
4187 (defun tramp-file-name-for-operation (operation &rest args)
4188 "Return file name related to OPERATION file primitive.
4189 ARGS are the arguments OPERATION has been called with."
4191 ; FILE resp DIRECTORY
4193 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
4194 'delete-file 'diff-latest-backup-file 'directory-file-name
4195 'directory-files 'directory-files-and-attributes
4196 'dired-compress-file 'dired-uncache
4197 'file-accessible-directory-p 'file-attributes
4198 'file-directory-p 'file-executable-p 'file-exists-p
4199 'file-local-copy 'file-remote-p 'file-modes
4200 'file-name-as-directory 'file-name-directory
4201 'file-name-nondirectory 'file-name-sans-versions
4202 'file-ownership-preserved-p 'file-readable-p
4203 'file-regular-p 'file-symlink-p 'file-truename
4204 'file-writable-p 'find-backup-file-name 'find-file-noselect
4205 'get-file-buffer 'insert-directory 'insert-file-contents
4206 'load 'make-directory 'make-directory-internal
4207 'set-file-modes 'substitute-in-file-name
4208 'unhandled-file-name-directory 'vc-registered
4210 'abbreviate-file-name 'create-file-buffer
4211 'dired-file-modtime 'dired-make-compressed-filename
4212 'dired-recursive-delete-directory 'dired-set-file-modtime
4213 'dired-shell-unhandle-file-name 'dired-uucode-file
4214 'insert-file-contents-literally 'recover-file
4215 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
4216 (if (file-name-absolute-p (nth 0 args))
4218 (expand-file-name (nth 0 args))))
4219 ; FILE DIRECTORY resp FILE1 FILE2
4221 (list 'add-name-to-file 'copy-file 'expand-file-name
4222 'file-name-all-completions 'file-name-completion
4223 'file-newer-than-file-p 'make-symbolic-link 'rename-file
4225 'dired-make-relative-symlink
4226 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
4229 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
4230 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
4231 (t (buffer-file-name (current-buffer))))))
4233 ((eq operation 'write-region)
4237 (list 'make-auto-save-file-name
4238 'set-visited-file-modtime 'verify-visited-file-modtime
4242 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
4245 (list 'dired-call-process
4251 'dired-print-file 'dired-shell-call-process))
4253 ; unknown file primitive
4254 (t (error "unknown file I/O primitive: %s" operation))))
4256 (defun tramp-find-foreign-file-name-handler (filename)
4257 "Return foreign file name handler if exists."
4258 (when (tramp-tramp-file-p filename)
4261 (handler-alist tramp-foreign-file-name-handler-alist))
4262 (while handler-alist
4263 (setq elt (car handler-alist)
4264 handler-alist (cdr handler-alist))
4265 (when (funcall (car elt) filename)
4266 (setq handler-alist nil)
4267 (setq res (cdr elt))))
4272 (defun tramp-file-name-handler (operation &rest args)
4273 "Invoke Tramp file name handler.
4274 Falls back to normal file name handler if no tramp file name handler exists."
4276 (let* ((filename (apply 'tramp-file-name-for-operation operation args))
4277 (foreign (tramp-find-foreign-file-name-handler filename)))
4279 (foreign (apply foreign operation args))
4280 (t (tramp-run-real-handler operation args))))))
4283 ;; In Emacs, there is some concurrency due to timers. If a timer
4284 ;; interrupts Tramp and wishes to use the same connection buffer as
4285 ;; the "main" Emacs, then garbage might occur in the connection
4286 ;; buffer. Therefore, we need to make sure that a timer does not use
4287 ;; the same connection buffer as the "main" Emacs. We implement a
4288 ;; cheap global lock, instead of locking each connection buffer
4289 ;; separately. The global lock is based on two variables,
4290 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
4291 ;; (with setq) to indicate a lock. But Tramp also calls itself during
4292 ;; processing of a single file operation, so we need to allow
4293 ;; recursive calls. That's where the `tramp-locker' variable comes in
4294 ;; -- it is let-bound to t during the execution of the current
4295 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
4296 ;; then we should just proceed because we have been called
4297 ;; recursively. But if `tramp-locker' is nil, then we are a timer
4298 ;; interrupting the "main" Emacs, and then we signal an error.
4300 (defvar tramp-locked nil
4301 "If non-nil, then Tramp is currently busy.
4302 Together with `tramp-locker', this implements a locking mechanism
4303 preventing reentrant calls of Tramp.")
4305 (defvar tramp-locker nil
4306 "If non-nil, then a caller has locked Tramp.
4307 Together with `tramp-locked', this implements a locking mechanism
4308 preventing reentrant calls of Tramp.")
4310 (defun tramp-sh-file-name-handler (operation &rest args)
4311 "Invoke remote-shell Tramp file name handler.
4312 Fall back to normal file name handler if no Tramp handler exists."
4313 (when (and tramp-locked (not tramp-locker))
4314 (signal 'file-error "Forbidden reentrant call of Tramp"))
4315 (let ((tl tramp-locked))
4318 (setq tramp-locked t)
4319 (let ((tramp-locker t))
4321 (let ((fn (assoc operation tramp-file-name-handler-alist)))
4323 (apply (cdr fn) args)
4324 (tramp-run-real-handler operation args))))))
4325 (setq tramp-locked tl))))
4328 (defun tramp-completion-file-name-handler (operation &rest args)
4329 "Invoke tramp file name completion handler.
4330 Falls back to normal file name handler if no tramp file name handler exists."
4331 ;; (setq tramp-debug-buffer t)
4332 ;; (tramp-message 1 "%s %s" operation args)
4333 ;; (tramp-message 1 "%s %s\n%s"
4334 ;; operation args (with-output-to-string (backtrace)))
4335 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
4337 (save-match-data (apply (cdr fn) args))
4338 (tramp-completion-run-real-handler operation args))))
4341 (put 'tramp-completion-file-name-handler 'safe-magic t)
4343 ;; Register in file name handler alist
4345 (add-to-list 'file-name-handler-alist
4346 (cons tramp-file-name-regexp 'tramp-file-name-handler))
4348 (add-to-list 'file-name-handler-alist
4349 (cons tramp-completion-file-name-regexp
4350 'tramp-completion-file-name-handler))
4353 (defun tramp-unload-file-name-handler-alist ()
4354 (setq file-name-handler-alist
4355 (delete (rassoc 'tramp-file-name-handler
4356 file-name-handler-alist)
4357 (delete (rassoc 'tramp-completion-file-name-handler
4358 file-name-handler-alist)
4359 file-name-handler-alist))))
4361 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handler-alist)
4363 (defun tramp-repair-jka-compr ()
4364 "If jka-compr is already loaded, move it to the front of
4365 `file-name-handler-alist'. On Emacs 22 or so this will not be
4367 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4369 (setq file-name-handler-alist
4370 (cons jka (delete jka file-name-handler-alist))))))
4371 (tramp-repair-jka-compr)
4374 ;;; Interactions with other packages:
4376 ;; -- complete.el --
4378 ;; This function contributed by Ed Sabol
4379 (defun tramp-handle-expand-many-files (name)
4380 "Like `PC-expand-many-files' for tramp files."
4381 (with-parsed-tramp-file-name name nil
4383 (if (or (string-match "\\*" name)
4384 (string-match "\\?" name)
4385 (string-match "\\[.*\\]" name))
4388 ;; CCC: To do it right, we should quote certain characters
4389 ;; in the file name, but since the echo command is going to
4390 ;; break anyway when there are spaces in the file names, we
4392 ;;-(let ((comint-file-name-quote-list
4393 ;;- (set-difference tramp-file-name-quote-list
4394 ;;- '(?\* ?\? ?[ ?]))))
4395 ;;- (tramp-send-command
4396 ;;- multi-method method user host
4397 ;;- (format "echo %s" (comint-quote-filename localname)))
4398 ;;- (tramp-wait-for-output))
4399 (tramp-send-command multi-method method user host
4400 (format "echo %s" localname))
4401 (tramp-wait-for-output)
4402 (setq bufstr (buffer-substring (point-min)
4403 (tramp-line-end-position)))
4404 (goto-char (point-min))
4405 (if (string-equal localname bufstr)
4408 (while (search-forward " " nil t)
4409 (delete-backward-char 1)
4411 (goto-char (point-max))
4412 (delete-backward-char 1)
4414 (goto-char (point-min))
4416 (function (lambda (x)
4417 (tramp-make-tramp-file-name multi-method method
4419 (read (current-buffer))))))
4420 (list (expand-file-name name))))))
4422 (eval-after-load "complete"
4424 (defadvice PC-expand-many-files
4425 (around tramp-advice-PC-expand-many-files (name) activate)
4426 "Invoke `tramp-handle-expand-many-files' for tramp files."
4427 (if (tramp-tramp-file-p name)
4428 (setq ad-return-value (tramp-handle-expand-many-files name))
4430 (add-hook 'tramp-unload-hook
4431 '(lambda () (ad-unadvise 'PC-expand-many-files)))))
4433 ;;; File name handler functions for completion mode
4435 (defvar tramp-completion-mode nil
4436 "If non-nil, we are in file name completion mode.")
4438 ;; Necessary because `tramp-file-name-regexp-unified' and
4439 ;; `tramp-completion-file-name-regexp-unified' aren't different.
4440 ;; If nil, `tramp-completion-run-real-handler' is called (i.e. forwarding to
4441 ;; `tramp-file-name-handler'). Otherwise, it takes `tramp-run-real-handler'.
4442 ;; Using `last-input-event' is a little bit risky, because completing a file
4443 ;; might require loading other files, like "~/.netrc", and for them it
4444 ;; shouldn't be decided based on that variable. On the other hand, those files
4445 ;; shouldn't have partial tramp file name syntax. Maybe another variable should
4446 ;; be introduced overwriting this check in such cases. Or we change tramp
4447 ;; file name syntax in order to avoid ambiguities, like in XEmacs ...
4448 ;; In case of non unified file names it can be always true (and wouldn't be
4449 ;; necessary, because there are different regexp).
4450 (defun tramp-completion-mode (file)
4451 "Checks whether method / user name / host name completion is active."
4453 (tramp-completion-mode t)
4454 ((not tramp-unified-filenames) t)
4455 ((string-match "^/.*:.*:$" file) nil)
4457 (concat tramp-prefix-regexp
4458 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp "$")
4460 (member (match-string 1 file) (mapcar 'car tramp-methods)))
4461 ((or (equal last-input-event 'tab)
4463 (and (integerp last-input-event)
4465 ;; ?\t has event-modifier 'control
4466 (char-equal last-input-event ?\t)
4467 (and (not (event-modifiers last-input-event))
4468 (or (char-equal last-input-event ?\?)
4469 (char-equal last-input-event ?\ )))))
4471 (and (featurep 'xemacs)
4473 ;; ?\t has event-modifier 'control
4475 (funcall (symbol-function 'event-to-character)
4476 last-input-event) ?\t)
4477 (and (not (event-modifiers last-input-event))
4479 (funcall (symbol-function 'event-to-character)
4480 last-input-event) ?\?)
4482 (funcall (symbol-function 'event-to-character)
4483 last-input-event) ?\ ))))))
4486 (defun tramp-completion-handle-file-exists-p (filename)
4487 "Like `file-exists-p' for tramp files."
4488 (if (tramp-completion-mode filename)
4489 (tramp-run-real-handler
4490 'file-exists-p (list filename))
4491 (tramp-completion-run-real-handler
4492 'file-exists-p (list filename))))
4494 ;; Localname manipulation in case of partial TRAMP file names.
4495 (defun tramp-completion-handle-file-name-directory (file)
4496 "Like `file-name-directory' but aware of TRAMP files."
4497 (if (tramp-completion-mode file)
4499 (tramp-completion-run-real-handler
4500 'file-name-directory (list file))))
4502 ;; Localname manipulation in case of partial TRAMP file names.
4503 (defun tramp-completion-handle-file-name-nondirectory (file)
4504 "Like `file-name-nondirectory' but aware of TRAMP files."
4506 file (length (tramp-completion-handle-file-name-directory file))))
4508 ;; Method, host name and user name completion.
4509 ;; `tramp-completion-dissect-file-name' returns a list of
4510 ;; tramp-file-name structures. For all of them we return possible completions.
4511 (defun tramp-completion-handle-file-name-all-completions (filename directory)
4512 "Like `file-name-all-completions' for partial tramp files."
4515 ;; We need to reset `tramp-completion-mode'.
4517 (setq tramp-completion-mode t)
4519 ((fullname (concat directory filename))
4520 ;; possible completion structures
4521 (v (tramp-completion-dissect-file-name fullname))
4525 (let* ((car (car v))
4526 (multi-method (tramp-file-name-multi-method car))
4527 (method (tramp-file-name-method car))
4528 (user (tramp-file-name-user car))
4529 (host (tramp-file-name-host car))
4530 (localname (tramp-file-name-localname car))
4531 (m (tramp-find-method multi-method method user host))
4532 (tramp-current-user user) ; see `tramp-parse-passwd'
4535 (unless (or multi-method ;; Not handled (yet).
4536 localname) ;; Nothing to complete
4540 ;; Method dependent user / host combinations
4544 (setq all-user-hosts
4545 (append all-user-hosts
4546 (funcall (nth 0 x) (nth 1 x)))))
4547 (tramp-get-completion-function m))
4549 (setq result (append result
4552 (tramp-get-completion-user-host
4553 method user host (nth 0 x) (nth 1 x)))
4554 (delq nil all-user-hosts)))))
4558 (append result (tramp-get-completion-methods m)))))
4562 ;; unify list, remove nil elements
4564 (let ((car (car result)))
4565 (when car (add-to-list 'result1 car))
4566 (setq result (cdr result))))
4568 ;; Complete local parts
4573 ;; "/ssh:" does not need to be expanded as hostname.
4574 (tramp-run-real-handler
4575 'file-name-all-completions (list filename directory))
4576 ;; No method/user/host found to be expanded.
4577 (tramp-completion-run-real-handler
4578 'file-name-all-completions (list filename directory)))
4581 (setq tramp-completion-mode nil)))
4583 ;; Method, host name and user name completion for a file.
4584 (defun tramp-completion-handle-file-name-completion (filename directory)
4585 "Like `file-name-completion' for tramp files."
4586 (try-completion filename
4587 (mapcar 'list (file-name-all-completions filename directory))))
4589 ;; I misuse a little bit the tramp-file-name structure in order to handle
4590 ;; completion possibilities for partial methods / user names / host names.
4591 ;; Return value is a list of tramp-file-name structures according to possible
4592 ;; completions. If "multi-method" or "localname" is non-nil it means there
4593 ;; shouldn't be a completion anymore.
4595 ;; Expected results:
4597 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
4598 ;; [nil nil nil "x" nil] [nil nil "x" nil nil] [nil nil "x" "y" nil]
4599 ;; [nil nil "x" nil nil]
4600 ;; [nil "x" nil nil nil]
4602 ;; "/x:" "/x:y" "/x:y:"
4603 ;; [nil nil nil "x" ""] [nil nil nil "x" "y"] [nil "x" nil "y" ""]
4605 ;; [nil "x" nil "" nil] [nil "x" nil "y" nil]
4606 ;; [nil "x" "" nil nil] [nil "x" "y" nil nil]
4608 ;; "/x:y@" "/x:y@z" "/x:y@z:"
4609 ;; [nil nil nil "x" "y@"] [nil nil nil "x" "y@z"] [nil "x" "y" "z" ""]
4610 ;; "/[x/y@" "/[x/y@z"
4611 ;; [nil "x" nil "y" nil] [nil "x" "y" "z" nil]
4612 (defun tramp-completion-dissect-file-name (name)
4613 "Returns a list of `tramp-file-name' structures.
4614 They are collected by `tramp-completion-dissect-file-name1'."
4618 ;; "/method" "/[method"
4619 (tramp-completion-file-name-structure1
4620 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
4623 (tramp-completion-file-name-structure2
4624 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
4627 (tramp-completion-file-name-structure3
4628 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
4630 ;; "/user@host" "/[user@host"
4631 (tramp-completion-file-name-structure4
4632 (list (concat tramp-prefix-regexp
4633 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4634 "\\(" tramp-host-regexp x-nil "\\)$")
4636 ;; "/method:user" "/[method/user"
4637 (tramp-completion-file-name-structure5
4638 (list (concat tramp-prefix-regexp
4639 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4640 "\\(" tramp-user-regexp x-nil "\\)$")
4642 ;; "/method:host" "/[method/host"
4643 (tramp-completion-file-name-structure6
4644 (list (concat tramp-prefix-regexp
4645 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4646 "\\(" tramp-host-regexp x-nil "\\)$")
4648 ;; "/method:user@host" "/[method/user@host"
4649 (tramp-completion-file-name-structure7
4650 (list (concat tramp-prefix-regexp
4651 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4652 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4653 "\\(" tramp-host-regexp x-nil "\\)$")
4656 (mapcar (lambda (regexp)
4657 (add-to-list 'result
4658 (tramp-completion-dissect-file-name1 regexp name)))
4660 tramp-completion-file-name-structure1
4661 tramp-completion-file-name-structure2
4662 tramp-completion-file-name-structure3
4663 tramp-completion-file-name-structure4
4664 tramp-completion-file-name-structure5
4665 tramp-completion-file-name-structure6
4666 tramp-completion-file-name-structure7
4667 tramp-file-name-structure))
4671 (defun tramp-completion-dissect-file-name1 (structure name)
4672 "Returns a `tramp-file-name' structure matching STRUCTURE.
4673 The structure consists of multi-method, remote method, remote user,
4674 remote host and localname (filename on remote host)."
4678 (when (string-match (nth 0 structure) name)
4679 (setq method (and (nth 1 structure)
4680 (match-string (nth 1 structure) name)))
4681 (if (and method (member method tramp-multi-methods))
4682 ;; Not handled (yet).
4683 (make-tramp-file-name
4684 :multi-method method
4689 (let ((user (and (nth 2 structure)
4690 (match-string (nth 2 structure) name)))
4691 (host (and (nth 3 structure)
4692 (match-string (nth 3 structure) name)))
4693 (localname (and (nth 4 structure)
4694 (match-string (nth 4 structure) name))))
4695 (make-tramp-file-name
4700 :localname localname)))))))
4702 ;; This function returns all possible method completions, adding the
4703 ;; trailing method delimeter.
4704 (defun tramp-get-completion-methods (partial-method)
4705 "Returns all method completions for PARTIAL-METHOD."
4709 (string-match (concat "^" (regexp-quote partial-method)) method)
4710 ;; we must remove leading "/".
4711 (substring (tramp-make-tramp-file-name nil method nil nil nil) 1)))
4712 (delete "multi" (mapcar 'car tramp-methods))))
4714 ;; Compares partial user and host names with possible completions.
4715 (defun tramp-get-completion-user-host (method partial-user partial-host user host)
4716 "Returns the most expanded string for user and host name completion.
4717 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
4720 ((and partial-user partial-host)
4722 (string-match (concat "^" (regexp-quote partial-host)) host)
4723 (string-equal partial-user (or user partial-user)))
4724 (setq user partial-user)
4731 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
4737 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
4743 (unless (zerop (+ (length user) (length host)))
4744 ;; we must remove leading "/".
4745 (substring (tramp-make-tramp-file-name nil method user host nil) 1)))
4747 (defun tramp-parse-rhosts (filename)
4748 "Return a list of (user host) tuples allowed to access.
4749 Either user or host may be nil."
4752 (when (file-readable-p filename)
4754 (insert-file-contents filename)
4755 (goto-char (point-min))
4757 (push (tramp-parse-rhosts-group) res))))
4760 ;; Taken from gnus/netrc.el
4762 (defalias 'tramp-point-at-eol
4763 (if (fboundp 'point-at-eol)
4765 'line-end-position)))
4767 (defun tramp-parse-rhosts-group ()
4768 "Return a (user host) tuple allowed to access.
4769 Either user or host may be nil."
4774 "^\\(" tramp-host-regexp "\\)"
4775 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
4777 (narrow-to-region (point) (tramp-point-at-eol))
4778 (when (re-search-forward regexp nil t)
4779 (setq result (append (list (match-string 3) (match-string 1)))))
4784 (defun tramp-parse-shosts (filename)
4785 "Return a list of (user host) tuples allowed to access.
4786 User is always nil."
4789 (when (file-readable-p filename)
4791 (insert-file-contents filename)
4792 (goto-char (point-min))
4794 (push (tramp-parse-shosts-group) res))))
4797 (defun tramp-parse-shosts-group ()
4798 "Return a (user host) tuple allowed to access.
4799 User is always nil."
4802 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
4804 (narrow-to-region (point) (tramp-point-at-eol))
4805 (when (re-search-forward regexp nil t)
4806 (setq result (list nil (match-string 1))))
4809 (> (skip-chars-forward ",") 0)
4813 (defun tramp-parse-sconfig (filename)
4814 "Return a list of (user host) tuples allowed to access.
4815 User is always nil."
4818 (when (file-readable-p filename)
4820 (insert-file-contents filename)
4821 (goto-char (point-min))
4823 (push (tramp-parse-sconfig-group) res))))
4826 (defun tramp-parse-sconfig-group ()
4827 "Return a (user host) tuple allowed to access.
4828 User is always nil."
4831 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)")))
4833 (narrow-to-region (point) (tramp-point-at-eol))
4834 (when (re-search-forward regexp nil t)
4835 (setq result (list nil (match-string 1))))
4838 (> (skip-chars-forward ",") 0)
4842 (defun tramp-parse-shostkeys (dirname)
4843 "Return a list of (user host) tuples allowed to access.
4844 User is always nil."
4846 (let ((regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$"))
4847 (files (when (file-directory-p dirname) (directory-files dirname)))
4851 (when (string-match regexp (car files))
4852 (push (list nil (match-string 1 (car files))) result))
4853 (setq files (cdr files)))
4856 (defun tramp-parse-sknownhosts (dirname)
4857 "Return a list of (user host) tuples allowed to access.
4858 User is always nil."
4860 (let ((regexp (concat "^\\(" tramp-host-regexp
4861 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
4862 (files (when (file-directory-p dirname) (directory-files dirname)))
4866 (when (string-match regexp (car files))
4867 (push (list nil (match-string 1 (car files))) result))
4868 (setq files (cdr files)))
4871 (defun tramp-parse-hosts (filename)
4872 "Return a list of (user host) tuples allowed to access.
4873 User is always nil."
4876 (when (file-readable-p filename)
4878 (insert-file-contents filename)
4879 (goto-char (point-min))
4881 (push (tramp-parse-hosts-group) res))))
4884 (defun tramp-parse-hosts-group ()
4885 "Return a (user host) tuple allowed to access.
4886 User is always nil."
4889 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
4891 (narrow-to-region (point) (tramp-point-at-eol))
4892 (when (re-search-forward regexp nil t)
4893 (unless (char-equal (or (char-after) ?\n) ?:) ; no IPv6
4894 (setq result (list nil (match-string 1)))))
4897 (> (skip-chars-forward " \t") 0)
4901 ;; For su-alike methods it would be desirable to return "root@localhost"
4902 ;; as default. Unfortunately, we have no information whether any user name
4903 ;; has been typed already. So we (mis-)use tramp-current-user as indication,
4904 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
4905 (defun tramp-parse-passwd (filename)
4906 "Return a list of (user host) tuples allowed to access.
4907 Host is always \"localhost\"."
4910 (if (zerop (length tramp-current-user))
4912 (when (file-readable-p filename)
4914 (insert-file-contents filename)
4915 (goto-char (point-min))
4917 (push (tramp-parse-passwd-group) res))))
4920 (defun tramp-parse-passwd-group ()
4921 "Return a (user host) tuple allowed to access.
4922 Host is always \"localhost\"."
4925 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
4927 (narrow-to-region (point) (tramp-point-at-eol))
4928 (when (re-search-forward regexp nil t)
4929 (setq result (list (match-string 1) "localhost")))
4934 (defun tramp-parse-netrc (filename)
4935 "Return a list of (user host) tuples allowed to access.
4939 (when (file-readable-p filename)
4941 (insert-file-contents filename)
4942 (goto-char (point-min))
4944 (push (tramp-parse-netrc-group) res))))
4947 (defun tramp-parse-netrc-group ()
4948 "Return a (user host) tuple allowed to access.
4954 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
4955 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
4957 (narrow-to-region (point) (tramp-point-at-eol))
4958 (when (re-search-forward regexp nil t)
4959 (setq result (list (match-string 3) (match-string 1))))
4964 (defun tramp-completion-handle-expand-file-name (name &optional dir)
4965 "Like `expand-file-name' for tramp files."
4966 (let ((fullname (concat (or dir default-directory) name)))
4967 (if (tramp-completion-mode fullname)
4968 (tramp-run-real-handler
4969 'expand-file-name (list name dir))
4970 (tramp-completion-run-real-handler
4971 'expand-file-name (list name dir)))))
4973 ;;; Internal Functions:
4975 (defun tramp-maybe-send-perl-script (multi-method method user host script name)
4976 "Define in remote shell function NAME implemented as perl SCRIPT.
4977 Only send the definition if it has not already been done.
4978 Function may have 0-3 parameters."
4979 (let ((remote-perl (tramp-get-remote-perl multi-method method user host)))
4980 (unless remote-perl (error "No remote perl"))
4981 (let ((perl-scripts (tramp-get-connection-property "perl-scripts" nil
4982 multi-method method user host)))
4983 (unless (memq name perl-scripts)
4984 (with-current-buffer (tramp-get-buffer multi-method method user host)
4985 (tramp-message 5 (concat "Sending the Perl script `" name "'..."))
4986 (tramp-send-string multi-method method user host
4992 "' \"$1\" \"$2\" \"$3\" 2>/dev/null\n}"))
4993 (tramp-wait-for-output)
4994 (tramp-set-connection-property "perl-scripts" (cons name perl-scripts)
4995 multi-method method user host)
4996 (tramp-message 5 (concat "Sending the Perl script `" name "'...done.")))))))
4998 (defun tramp-set-auto-save ()
4999 (when (and (buffer-file-name)
5000 (tramp-tramp-file-p (buffer-file-name))
5001 ;; ange-ftp has its own auto-save mechanism
5002 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
5003 'tramp-sh-file-name-handler)
5005 (auto-save-mode 1)))
5006 (add-hook 'find-file-hooks 'tramp-set-auto-save t)
5007 (add-hook 'tramp-unload-hook
5009 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
5011 (defun tramp-run-test (switch filename)
5012 "Run `test' on the remote system, given a SWITCH and a FILENAME.
5013 Returns the exit code of the `test' program."
5014 (let ((v (tramp-dissect-file-name filename)))
5016 (tramp-send-command-and-check
5017 (tramp-file-name-multi-method v) (tramp-file-name-method v)
5018 (tramp-file-name-user v) (tramp-file-name-host v)
5019 (format "test %s %s" switch
5020 (tramp-shell-quote-argument (tramp-file-name-localname v)))))))
5022 (defun tramp-run-test2 (program file1 file2 &optional switch)
5023 "Run `test'-like PROGRAM on the remote system, given FILE1, FILE2.
5024 The optional SWITCH is inserted between the two files.
5025 Returns the exit code of the `test' PROGRAM. Barfs if the methods,
5026 hosts, or files, disagree."
5027 (let* ((v1 (tramp-dissect-file-name file1))
5028 (v2 (tramp-dissect-file-name file2))
5029 (mmethod1 (tramp-file-name-multi-method v1))
5030 (mmethod2 (tramp-file-name-multi-method v2))
5031 (method1 (tramp-file-name-method v1))
5032 (method2 (tramp-file-name-method v2))
5033 (user1 (tramp-file-name-user v1))
5034 (user2 (tramp-file-name-user v2))
5035 (host1 (tramp-file-name-host v1))
5036 (host2 (tramp-file-name-host v2))
5037 (localname1 (tramp-file-name-localname v1))
5038 (localname2 (tramp-file-name-localname v2)))
5039 (unless (and method1 method2 host1 host2
5040 (equal mmethod1 mmethod2)
5041 (equal method1 method2)
5043 (equal host1 host2))
5044 (error "tramp-run-test2: %s"
5045 "only implemented for same method, same user, same host"))
5047 (tramp-send-command-and-check
5048 mmethod1 method1 user1 host1
5049 (format "%s %s %s %s"
5051 (tramp-shell-quote-argument localname1)
5053 (tramp-shell-quote-argument localname2))))))
5055 (defun tramp-touch (file time)
5056 "Set the last-modified timestamp of the given file.
5057 TIME is an Emacs internal time value as returned by `current-time'."
5058 (let ((touch-time (format-time-string "%Y%m%d%H%M.%S" time)))
5059 (if (tramp-tramp-file-p file)
5060 (with-parsed-tramp-file-name file nil
5061 (let ((buf (tramp-get-buffer multi-method method user host)))
5062 (unless (zerop (tramp-send-command-and-check
5063 multi-method method user host
5064 (format "touch -t %s %s"
5068 (error "tramp-touch: touch failed, see buffer `%s' for details"
5070 ;; It's a local file
5072 (unless (zerop (call-process
5073 "touch" nil (current-buffer) nil "-t" touch-time file))
5074 (pop-to-buffer (current-buffer))
5075 (error "tramp-touch: touch failed"))))))
5077 (defun tramp-buffer-name (multi-method method user host)
5078 "A name for the connection buffer for USER at HOST using METHOD."
5080 (tramp-buffer-name-multi-method "tramp" multi-method method user host)
5081 (let ((method (tramp-find-method multi-method method user host)))
5083 (format "*tramp/%s %s@%s*" method user host)
5084 (format "*tramp/%s %s*" method host)))))
5086 (defun tramp-buffer-name-multi-method (prefix multi-method method user host)
5087 "A name for the multi method connection buffer.
5088 MULTI-METHOD gives the multi method, METHOD the array of methods,
5089 USER the array of user names, HOST the array of host names."
5090 (unless (and (= (length method) (length user))
5091 (= (length method) (length host)))
5092 (error "Syntax error in multi method (implementation error)"))
5093 (let ((len (length method))
5098 (cons (if (aref user i)
5099 (format "%s#%s@%s:" (aref method i)
5100 (aref user i) (aref host i))
5101 (format "%s@%s:" (aref method i) (aref host i)))
5104 (format "*%s/%s %s*"
5106 (apply 'concat (reverse string-list)))))
5108 (defun tramp-get-buffer (multi-method method user host)
5109 "Get the connection buffer to be used for USER at HOST using METHOD."
5110 (with-current-buffer
5111 (get-buffer-create (tramp-buffer-name multi-method method user host))
5112 (setq buffer-undo-list t)
5115 (defun tramp-debug-buffer-name (multi-method method user host)
5116 "A name for the debug buffer for USER at HOST using METHOD."
5118 (tramp-buffer-name-multi-method "debug tramp"
5119 multi-method method user host)
5120 (let ((method (tramp-find-method multi-method method user host)))
5122 (format "*debug tramp/%s %s@%s*" method user host)
5123 (format "*debug tramp/%s %s*" method host)))))
5125 (defun tramp-get-debug-buffer (multi-method method user host)
5126 "Get the debug buffer for USER at HOST using METHOD."
5127 (with-current-buffer
5129 (tramp-debug-buffer-name multi-method method user host))
5130 (setq buffer-undo-list t)
5133 (defun tramp-find-executable (multi-method method user host
5134 progname dirlist ignore-tilde)
5135 "Searches for PROGNAME in all directories mentioned in DIRLIST.
5136 First args METHOD, USER and HOST specify the connection, PROGNAME
5137 is the program to search for, and DIRLIST gives the list of directories
5138 to search. If IGNORE-TILDE is non-nil, directory names starting
5139 with `~' will be ignored.
5141 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
5143 This function expects to be in the right *tramp* buffer."
5146 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
5147 ;; `remove' is in CL, and we want to avoid CL dependencies.
5150 (setq d (car dirlist))
5151 (setq dirlist (cdr dirlist))
5152 (unless (char-equal ?~ (aref d 0))
5153 (setq newdl (cons d newdl))))
5154 (setq dirlist (nreverse newdl))))
5156 multi-method method user host
5157 (format (concat "while read d; "
5158 "do if test -x $d/%s -a -f $d/%s; "
5159 "then echo tramp_executable $d/%s; "
5160 "break; fi; done <<'EOF'")
5161 progname progname progname))
5163 (tramp-send-command multi-method method user host d))
5165 (tramp-send-command multi-method method user host "EOF")
5166 (tramp-wait-for-output)
5167 (goto-char (point-max))
5168 (when (search-backward "tramp_executable " nil t)
5169 (skip-chars-forward "^ ")
5170 (skip-chars-forward " ")
5171 (buffer-substring (point) (tramp-line-end-position)))))
5173 (defun tramp-set-remote-path (multi-method method user host var dirlist)
5174 "Sets the remote environment VAR to existing directories from DIRLIST.
5175 I.e., for each directory in DIRLIST, it is tested whether it exists and if
5176 so, it is added to the environment variable VAR."
5177 (let ((existing-dirs
5182 (tramp-make-tramp-file-name multi-method method user host x))
5184 (tramp-make-tramp-file-name multi-method method user host x)))
5188 multi-method method user host
5190 (mapconcat 'identity (delq nil existing-dirs) ":")
5192 (tramp-wait-for-output)))
5194 ;; -- communication with external shell --
5196 (defun tramp-find-file-exists-command (multi-method method user host)
5197 "Find a command on the remote host for checking if a file exists.
5198 Here, we are looking for a command which has zero exit status if the
5199 file exists and nonzero exit status otherwise."
5200 (make-local-variable 'tramp-file-exists-command)
5201 (tramp-message 9 "Finding command to check if file exists")
5203 (tramp-make-tramp-file-name
5204 multi-method method user host
5205 "/")) ;assume this file always exists
5207 (tramp-make-tramp-file-name
5208 multi-method method user host
5209 "/ this file does not exist "))) ;assume this never exists
5210 ;; The algorithm is as follows: we try a list of several commands.
5211 ;; For each command, we first run `$cmd /' -- this should return
5212 ;; true, as the root directory always exists. And then we run
5213 ;; `$cmd /this\ file\ does\ not\ exist', hoping that the file indeed
5214 ;; does not exist. This should return false. We use the first
5215 ;; command we find that seems to work.
5216 ;; The list of commands to try is as follows:
5217 ;; `ls -d' This works on most systems, but NetBSD 1.4
5218 ;; has a bug: `ls' always returns zero exit
5219 ;; status, even for files which don't exist.
5220 ;; `test -e' Some Bourne shells have a `test' builtin
5221 ;; which does not know the `-e' option.
5222 ;; `/bin/test -e' For those, the `test' binary on disk normally
5223 ;; provides the option. Alas, the binary
5224 ;; is sometimes `/bin/test' and sometimes it's
5226 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
5228 (and (setq tramp-file-exists-command "test -e %s")
5229 (file-exists-p existing)
5230 (not (file-exists-p nonexisting)))
5231 (and (setq tramp-file-exists-command "/bin/test -e %s")
5232 (file-exists-p existing)
5233 (not (file-exists-p nonexisting)))
5234 (and (setq tramp-file-exists-command "/usr/bin/test -e %s")
5235 (file-exists-p existing)
5236 (not (file-exists-p nonexisting)))
5237 (and (setq tramp-file-exists-command "ls -d %s")
5238 (file-exists-p existing)
5239 (not (file-exists-p nonexisting))))
5240 (error "Couldn't find command to check if file exists"))))
5243 ;; CCC test ksh or bash found for tilde expansion?
5244 (defun tramp-find-shell (multi-method method user host)
5245 "Find a shell on the remote host which groks tilde expansion."
5247 (tramp-send-command multi-method method user host "echo ~root")
5248 (tramp-wait-for-output)
5250 ((string-match "^~root$" (buffer-string))
5252 (or (tramp-find-executable multi-method method user host
5253 "bash" tramp-remote-path t)
5254 (tramp-find-executable multi-method method user host
5255 "ksh" tramp-remote-path t)))
5257 (error "Couldn't find a shell which groks tilde expansion"))
5258 ;; Find arguments for this shell.
5259 (let ((alist tramp-sh-extra-args)
5261 (while (and alist (null extra-args))
5262 (setq item (pop alist))
5263 (when (string-match (car item) shell)
5264 (setq extra-args (cdr item))))
5265 (when extra-args (setq shell (concat shell " " extra-args))))
5267 5 "Starting remote shell `%s' for tilde expansion..." shell)
5269 multi-method method user host
5270 (concat "PS1='$ ' exec " shell)) ;
5271 (tramp-barf-if-no-shell-prompt
5272 (get-buffer-process (current-buffer))
5273 60 "Couldn't find remote `%s' prompt" shell)
5275 9 "Setting remote shell prompt...")
5276 ;; Douglas Gray Stephens <DGrayStephens@slb.com> says that we
5277 ;; must use "\n" here, not tramp-rsh-end-of-line. Kai left the
5278 ;; last tramp-rsh-end-of-line, Douglas wanted to replace that,
5280 (process-send-string nil (format "PS1='%s%s%s'; PS2=''; PS3=''%s"
5281 tramp-rsh-end-of-line
5283 tramp-rsh-end-of-line
5284 tramp-rsh-end-of-line))
5285 (tramp-wait-for-output)
5287 9 "Setting remote shell prompt...done")
5289 (t (tramp-message 5 "Remote `%s' groks tilde expansion, good"
5290 (tramp-get-method-parameter
5291 multi-method method user host 'tramp-remote-sh))))))
5293 (defun tramp-check-ls-command (multi-method method user host cmd)
5294 "Checks whether the given `ls' executable groks `-n'.
5295 METHOD, USER and HOST specify the connection, CMD (the absolute file name of)
5296 the `ls' executable. Returns t if CMD supports the `-n' option, nil
5298 (tramp-message 9 "Checking remote `%s' command for `-n' option" cmd)
5299 (when (file-executable-p
5300 (tramp-make-tramp-file-name multi-method method user host cmd))
5302 (tramp-message 7 "Testing remote command `%s' for -n..." cmd)
5304 (tramp-send-command-and-check
5305 multi-method method user host
5306 (format "%s -lnd / >/dev/null"
5308 (tramp-message 7 "Testing remote command `%s' for -n...%s"
5310 (if (zerop result) "okay" "failed"))
5313 (defun tramp-check-ls-commands (multi-method method user host cmd dirlist)
5314 "Checks whether the given `ls' executable in one of the dirs groks `-n'.
5315 Returns nil if none was found, else the command is returned."
5318 (tramp-let-maybe directory-sep-char ?/ ;for XEmacs
5319 ;; It would be better to use the CL function `find', but
5320 ;; we don't want run-time dependencies on CL.
5321 (while (and dl (not result))
5322 (let ((x (concat (file-name-as-directory (car dl)) cmd)))
5323 (when (tramp-check-ls-command multi-method method user host x)
5328 (defun tramp-find-ls-command (multi-method method user host)
5329 "Finds an `ls' command which groks the `-n' option, returning nil if failed.
5330 \(This option prints numeric user and group ids in a long listing.)"
5331 (tramp-message 9 "Finding a suitable `ls' command")
5333 (tramp-check-ls-commands multi-method method user host "ls" tramp-remote-path)
5334 (tramp-check-ls-commands multi-method method user host "gnuls" tramp-remote-path)
5335 (tramp-check-ls-commands multi-method method user host "gls" tramp-remote-path)))
5337 ;; ------------------------------------------------------------
5338 ;; -- Functions for establishing connection --
5339 ;; ------------------------------------------------------------
5341 ;; The following functions are actions to be taken when seeing certain
5342 ;; prompts from the remote host. See the variable
5343 ;; `tramp-actions-before-shell' for usage of these functions.
5345 (defun tramp-action-login (p multi-method method user host)
5346 "Send the login name."
5347 (tramp-message 9 "Sending login name `%s'"
5348 (or user (user-login-name)))
5350 (process-send-string nil (concat (or user (user-login-name))
5351 tramp-rsh-end-of-line)))
5353 (defun tramp-action-password (p multi-method method user host)
5354 "Query the user for a password."
5356 (format "Password for %s "
5357 (tramp-make-tramp-file-name
5358 nil method user host ""))))
5359 (tramp-message 9 "Sending password")
5360 (tramp-enter-password p pw-prompt user host)))
5362 (defun tramp-action-succeed (p multi-method method user host)
5363 "Signal success in finding shell prompt."
5364 (tramp-message 9 "Found remote shell prompt.")
5366 (throw 'tramp-action 'ok))
5368 (defun tramp-action-permission-denied (p multi-method method user host)
5369 "Signal permission denied."
5370 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5371 (tramp-message 9 "Permission denied by remote host.")
5373 (throw 'tramp-action 'permission-denied))
5375 (defun tramp-action-yesno (p multi-method method user host)
5376 "Ask the user for confirmation using `yes-or-no-p'.
5377 Send \"yes\" to remote process on confirmation, abort otherwise.
5378 See also `tramp-action-yn'."
5379 (save-window-excursion
5380 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5381 (unless (yes-or-no-p (match-string 0))
5384 (throw 'tramp-action 'permission-denied))
5385 (process-send-string p (concat "yes" tramp-rsh-end-of-line))
5388 (defun tramp-action-yn (p multi-method method user host)
5389 "Ask the user for confirmation using `y-or-n-p'.
5390 Send \"y\" to remote process on confirmation, abort otherwise.
5391 See also `tramp-action-yesno'."
5392 (save-window-excursion
5393 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5394 (unless (y-or-n-p (match-string 0))
5396 (throw 'tramp-action 'permission-denied))
5398 (process-send-string p (concat "y" tramp-rsh-end-of-line))))
5400 (defun tramp-action-terminal (p multi-method method user host)
5401 "Tell the remote host which terminal type to use.
5402 The terminal type can be configured with `tramp-terminal-type'."
5403 (tramp-message 9 "Setting `%s' as terminal type."
5404 tramp-terminal-type)
5406 (process-send-string nil (concat tramp-terminal-type
5407 tramp-rsh-end-of-line)))
5409 (defun tramp-action-process-alive (p multi-method method user host)
5410 "Check whether a process has finished."
5411 (unless (memq (process-status p) '(run open))
5412 (throw 'tramp-action 'process-died)))
5414 (defun tramp-action-out-of-band (p multi-method method user host)
5415 "Check whether an out-of-band copy has finished."
5416 (cond ((and (memq (process-status p) '(stop exit))
5417 (zerop (process-exit-status p)))
5418 (tramp-message 9 "Process has finished.")
5419 (throw 'tramp-action 'ok))
5420 ((or (and (memq (process-status p) '(stop exit))
5421 (not (zerop (process-exit-status p))))
5422 (memq (process-status p) '(signal)))
5423 ;; `scp' could have copied correctly, but set modes could have failed.
5424 ;; This can be ignored.
5425 (goto-char (point-min))
5426 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
5428 (tramp-message 10 "'set mode' error ignored.")
5429 (tramp-message 9 "Process has finished.")
5430 (throw 'tramp-action 'ok))
5431 (goto-char (point-min))
5432 (when (re-search-forward "^.cp.?: \\(.+: Permission denied.?\\)$" nil t)
5433 (error "Remote host: %s" (match-string 1)))
5434 (tramp-message 9 "Process has died.")
5435 (throw 'tramp-action 'process-died)))
5438 ;; The following functions are specifically for multi connections.
5440 (defun tramp-multi-action-login (p method user host)
5441 "Send the login name."
5442 (tramp-message 9 "Sending login name `%s'" user)
5444 (process-send-string p (concat user tramp-rsh-end-of-line)))
5446 (defun tramp-multi-action-password (p method user host)
5447 "Query the user for a password."
5449 (format "Password for %s "
5450 (tramp-make-tramp-file-name
5451 nil method user host ""))))
5452 (tramp-message 9 "Sending password")
5453 (tramp-enter-password p pw-prompt user host)))
5455 (defun tramp-multi-action-succeed (p method user host)
5456 "Signal success in finding shell prompt."
5457 (tramp-message 9 "Found shell prompt on `%s'" host)
5459 (throw 'tramp-action 'ok))
5461 (defun tramp-multi-action-permission-denied (p method user host)
5462 "Signal permission denied."
5463 (tramp-message 9 "Permission denied by remote host `%s'" host)
5466 (throw 'tramp-action 'permission-denied))
5468 (defun tramp-multi-action-process-alive (p method user host)
5469 "Check whether a process has finished."
5470 (unless (memq (process-status p) '(run open))
5471 (throw 'tramp-action 'process-died)))
5473 ;; Functions for processing the actions.
5475 (defun tramp-process-one-action (p multi-method method user host actions)
5476 "Wait for output from the shell and perform one action."
5477 (let (found item pattern action todo)
5479 (tramp-message 9 "Waiting 60s for prompt from remote shell")
5480 (with-timeout (60 (throw 'tramp-action 'timeout))
5482 (tramp-accept-process-output p 1)
5483 (goto-char (point-min))
5486 (goto-char (point-min))
5487 (setq item (pop todo))
5488 (setq pattern (symbol-value (nth 0 item)))
5489 (setq action (nth 1 item))
5490 (tramp-message 10 "Looking for regexp \"%s\" from remote shell"
5492 (when (re-search-forward (concat pattern "\\'") nil t)
5493 (setq found (funcall action p multi-method method user host)))))
5496 (defun tramp-process-actions (p multi-method method user host actions)
5497 "Perform actions until success."
5500 (tramp-message 9 "Waiting for prompts from remote shell")
5502 (catch 'tramp-action
5503 (tramp-process-one-action
5504 p multi-method method user host actions)
5506 (unless (eq exit 'ok)
5507 (tramp-clear-passwd user host)
5508 (error "Login failed"))))
5510 ;; For multi-actions.
5512 (defun tramp-process-one-multi-action (p method user host actions)
5513 "Wait for output from the shell and perform one action."
5514 (let (found item pattern action todo)
5516 (tramp-message 9 "Waiting 60s for prompt from remote shell")
5517 (with-timeout (60 (throw 'tramp-action 'timeout))
5519 (tramp-accept-process-output p 1)
5521 (goto-char (point-min))
5523 (goto-char (point-min))
5524 (setq item (pop todo))
5525 (setq pattern (symbol-value (nth 0 item)))
5526 (setq action (nth 1 item))
5527 (tramp-message 10 "Looking for regexp \"%s\" from remote shell"
5529 (when (re-search-forward (concat pattern "\\'") nil t)
5530 (setq found (funcall action p method user host)))))
5533 (defun tramp-process-multi-actions (p method user host actions)
5534 "Perform actions until success."
5537 (tramp-message 9 "Waiting for prompts from remote shell")
5539 (catch 'tramp-action
5540 (tramp-process-one-multi-action p method user host actions)
5542 (unless (eq exit 'ok)
5543 (tramp-clear-passwd user host)
5544 (error "Login failed"))))
5546 ;; Functions to execute when we have seen the remote shell prompt but
5547 ;; before we exec the Bourne-ish shell. Note that these commands
5548 ;; might be sent to any shell, not just a Bourne-ish shell. This
5549 ;; means that the commands need to work in all shells. (It is also
5550 ;; okay for some commands to just fail with an error message, but
5551 ;; please make sure that they at least don't crash the odd shell people
5552 ;; might be running...)
5553 (defun tramp-process-initial-commands (p
5554 multi-method method user host
5556 "Send list of commands to remote host, in order."
5559 (setq cmd (pop commands))
5561 (tramp-message 10 "Sending command to remote shell: %s"
5563 (tramp-send-command multi-method method user host cmd nil t)
5564 (tramp-barf-if-no-shell-prompt
5565 p 60 "Remote shell command failed: %s" cmd))
5568 ;; The actual functions for opening connections.
5570 (defun tramp-open-connection-telnet (multi-method method user host)
5571 "Open a connection using a telnet METHOD.
5572 This starts the command `telnet HOST ARGS'[*], then waits for a remote
5573 login prompt, then sends the user name USER, then waits for a remote
5574 password prompt. It queries the user for the password, then sends the
5575 password to the remote host.
5577 If USER is nil, uses value returned by `(user-login-name)' instead.
5579 Recognition of the remote shell prompt is based on the variables
5580 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5583 Please note that it is NOT possible to use this connection method
5584 together with an out-of-band transfer method! You must use an inline
5587 Maybe the different regular expressions need to be tuned.
5589 * Actually, the telnet program as well as the args to be used can be
5590 specified in the method parameters, see the variable `tramp-methods'."
5592 (when (tramp-method-out-of-band-p multi-method method user host)
5593 (error "Cannot use out-of-band method `%s' with telnet connection method"
5596 (error "Cannot multi-connect using telnet connection method"))
5597 (tramp-pre-connection multi-method method user host tramp-chunksize)
5598 (tramp-message 7 "Opening connection for %s@%s using %s..."
5599 (or user (user-login-name)) host method)
5600 (let ((process-environment (copy-sequence process-environment)))
5601 (setenv "TERM" tramp-terminal-type)
5603 (let* ((default-directory (tramp-temporary-file-directory))
5604 ;; If we omit the conditional here, then we would use
5605 ;; `undecided-dos' in some cases. With the conditional,
5606 ;; we use nil in these cases. Which one is right?
5607 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5608 (> emacs-major-version 20))
5609 tramp-dos-coding-system))
5610 (p (apply 'start-process
5611 (tramp-buffer-name multi-method method user host)
5612 (tramp-get-buffer multi-method method user host)
5613 (tramp-get-method-parameter
5615 (tramp-find-method multi-method method user host)
5616 user host 'tramp-login-program)
5618 (tramp-get-method-parameter
5620 (tramp-find-method multi-method method user host)
5621 user host 'tramp-login-args)))
5624 (tramp-set-process-query-on-exit-flag p nil)
5625 (set-buffer (tramp-get-buffer multi-method method user host))
5627 (tramp-process-actions p multi-method method user host
5628 tramp-actions-before-shell)
5629 (tramp-open-connection-setup-interactive-shell
5630 p multi-method method user host)
5631 (tramp-post-connection multi-method method user host)))))
5634 (defun tramp-open-connection-rsh (multi-method method user host)
5635 "Open a connection using an rsh METHOD.
5636 This starts the command `rsh HOST -l USER'[*], then waits for a remote
5637 password or shell prompt. If a password prompt is seen, the user is
5638 queried for a password, this function sends the password to the remote
5639 host and waits for a shell prompt.
5641 If USER is nil, start the command `rsh HOST'[*] instead
5643 Recognition of the remote shell prompt is based on the variables
5644 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5647 Kludgy feature: if HOST has the form \"xx#yy\", then yy is assumed to
5648 be a port number for ssh, and \"-p yy\" will be added to the list of
5649 arguments, and xx will be used as the host name to connect to.
5651 * Actually, the rsh program to be used can be specified in the
5652 method parameters, see the variable `tramp-methods'."
5655 (error "Cannot multi-connect using rsh connection method"))
5656 (tramp-pre-connection multi-method method user host tramp-chunksize)
5657 (if (and user (not (string= user "")))
5658 (tramp-message 7 "Opening connection for %s@%s using %s..."
5660 (tramp-message 7 "Opening connection at %s using %s..." host method))
5661 (let ((process-environment (copy-sequence process-environment))
5662 (bufnam (tramp-buffer-name multi-method method user host))
5663 (buf (tramp-get-buffer multi-method method user host))
5664 (login-program (tramp-get-method-parameter
5666 (tramp-find-method multi-method method user host)
5667 user host 'tramp-login-program))
5668 (login-args (tramp-get-method-parameter
5670 (tramp-find-method multi-method method user host)
5671 user host 'tramp-login-args))
5673 ;; The following should be changed. We need a more general
5674 ;; mechanism to parse extra host args.
5675 (when (string-match "\\([^#]*\\)#\\(.*\\)" host)
5676 (setq login-args (cons "-p" (cons (match-string 2 host) login-args)))
5677 (setq real-host (match-string 1 host)))
5678 (setenv "TERM" tramp-terminal-type)
5680 (let* ((default-directory (tramp-temporary-file-directory))
5681 ;; If we omit the conditional, we would use
5682 ;; `undecided-dos' in some cases. With the conditional,
5683 ;; we use nil in these cases. Which one is right?
5684 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5685 (> emacs-major-version 20))
5686 tramp-dos-coding-system))
5687 (p (if (and user (not (string= user "")))
5688 (apply #'start-process bufnam buf login-program
5689 real-host "-l" user login-args)
5690 (apply #'start-process bufnam buf login-program
5691 real-host login-args)))
5693 (tramp-set-process-query-on-exit-flag p nil)
5696 (tramp-process-actions p multi-method method user host
5697 tramp-actions-before-shell)
5698 (tramp-message 7 "Initializing remote shell")
5699 (tramp-open-connection-setup-interactive-shell
5700 p multi-method method user host)
5701 (tramp-post-connection multi-method method user host)))))
5703 (defun tramp-open-connection-su (multi-method method user host)
5704 "Open a connection using the `su' program with METHOD.
5705 This starts `su - USER', then waits for a password prompt. The HOST
5706 name must be equal to the local host name or to `localhost'.
5708 If USER is nil, uses value returned by user-login-name instead.
5710 Recognition of the remote shell prompt is based on the variables
5711 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5712 set up correctly. Note that the other user may have a different shell
5713 prompt than you do, so it is not at all unlikely that the variable
5714 `shell-prompt-pattern' is set up wrongly!"
5716 (when (tramp-method-out-of-band-p multi-method method user host)
5717 (error "Cannot use out-of-band method `%s' with `su' connection method"
5719 (unless (or (string-match (concat "^" (regexp-quote host))
5721 (string= "localhost" host)
5724 "Cannot connect to different host `%s' with `su' connection method"
5726 (tramp-pre-connection multi-method method user host tramp-chunksize)
5727 (tramp-message 7 "Opening connection for `%s' using `%s'..."
5728 (or user "<root>") method)
5729 (let ((process-environment (copy-sequence process-environment)))
5730 (setenv "TERM" tramp-terminal-type)
5732 (let* ((default-directory (tramp-temporary-file-directory))
5733 ;; If we omit the conditional, we use `undecided-dos' in
5734 ;; some cases. With the conditional, we use nil in these
5735 ;; cases. What's the difference? Which one is right?
5736 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5737 (> emacs-major-version 20))
5738 tramp-dos-coding-system))
5739 (p (apply 'start-process
5740 (tramp-buffer-name multi-method method user host)
5741 (tramp-get-buffer multi-method method user host)
5742 (tramp-get-method-parameter
5744 (tramp-find-method multi-method method user host)
5745 user host 'tramp-login-program)
5748 (format-spec x `((?u . ,(or user "root")))))
5749 (tramp-get-method-parameter
5751 (tramp-find-method multi-method method user host)
5752 user host 'tramp-login-args))))
5755 (tramp-set-process-query-on-exit-flag p nil)
5756 (set-buffer (tramp-get-buffer multi-method method user host))
5757 (tramp-process-actions p multi-method method user host
5758 tramp-actions-before-shell)
5759 (tramp-open-connection-setup-interactive-shell
5760 p multi-method method user host)
5761 (tramp-post-connection multi-method method
5764 ;; HHH: Not Changed. Multi method. It is not clear to me how this can
5765 ;; handle not giving a user name in the "file name".
5767 ;; This is more difficult than for the single-hop method. In the
5768 ;; multi-hop-method, the desired behaviour should be that the
5769 ;; user must specify names for the telnet hops of which the user
5770 ;; name is different than the "original" name (or different from
5771 ;; the previous hop.
5772 (defun tramp-open-connection-multi (multi-method method user host)
5773 "Open a multi-hop connection using METHOD.
5774 This uses a slightly changed file name syntax. The idea is to say
5775 [multi/telnet:u1@h1/rsh:u2@h2]/path/to/file
5776 This will use telnet to log in as u1 to h1, then use rsh from there to
5777 log in as u2 to h2."
5779 (unless multi-method
5780 (error "Multi-hop open connection function called on non-multi method"))
5781 (when (tramp-method-out-of-band-p multi-method method user host)
5782 (error "No out of band multi-hop connections"))
5783 (unless (and (arrayp method) (not (stringp method)))
5784 (error "METHOD must be an array of strings for multi methods"))
5785 (unless (and (arrayp user) (not (stringp user)))
5786 (error "USER must be an array of strings for multi methods"))
5787 (unless (and (arrayp host) (not (stringp host)))
5788 (error "HOST must be an array of strings for multi methods"))
5789 (unless (and (= (length method) (length user))
5790 (= (length method) (length host)))
5791 (error "Arrays METHOD, USER, HOST must have equal length"))
5792 (tramp-pre-connection multi-method method user host tramp-chunksize)
5793 (tramp-message 7 "Opening `%s' connection..." multi-method)
5794 (let ((process-environment (copy-sequence process-environment)))
5795 (setenv "TERM" tramp-terminal-type)
5797 (let* ((default-directory (tramp-temporary-file-directory))
5798 ;; If we omit the conditional, we use `undecided-dos' in
5799 ;; some cases. With the conditional, we use nil in these
5800 ;; cases. What's the difference? Which one is right?
5801 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5802 (> emacs-major-version 20))
5803 tramp-dos-coding-system))
5804 (p (start-process (tramp-buffer-name multi-method method user host)
5805 (tramp-get-buffer multi-method method user host)
5806 tramp-multi-sh-program))
5807 (num-hops (length method))
5809 (tramp-set-process-query-on-exit-flag p nil)
5810 (tramp-message 9 "Waiting 60s for local shell to come up...")
5811 (unless (tramp-wait-for-regexp
5812 p 60 (format "\\(%s\\)\\'\\|\\(%s\\)\\'"
5813 shell-prompt-pattern tramp-shell-prompt-pattern))
5814 (pop-to-buffer (buffer-name))
5816 (error "Couldn't find local shell prompt"))
5817 ;; Now do all the connections as specified.
5818 (while (< i num-hops)
5819 (let* ((m (aref method i))
5822 (entry (assoc m tramp-multi-connection-function-alist))
5823 (multi-func (nth 1 entry))
5824 (command (nth 2 entry)))
5825 ;; The multi-funcs don't need to do save-match-data, as that
5827 (funcall multi-func p m u h command)
5830 (tramp-open-connection-setup-interactive-shell
5831 p multi-method method user host)
5832 (tramp-post-connection multi-method method user host)))))
5834 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
5835 ;; of no user name provided. Hack to make it work as it did before:
5836 ;; changed `user' to `(or user (user-login-name))' in the places where
5837 ;; the value is actually used.
5838 (defun tramp-multi-connect-telnet (p method user host command)
5839 "Issue `telnet' command.
5840 Uses shell COMMAND to issue a `telnet' command to log in as USER to
5841 HOST. You can use percent escapes in COMMAND: `%h' is replaced with
5842 the host name, and `%n' is replaced with an end of line character, as
5843 set in `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
5846 If USER is nil, uses the return value of (user-login-name) instead."
5847 (let ((cmd (format-spec command
5848 `((?h . ,host) (?n . ,tramp-rsh-end-of-line))))
5849 (cmd1 (format-spec command `((?h . ,host) (?n . ""))))
5852 (tramp-message 9 "Sending telnet command `%s'" cmd1)
5853 (process-send-string p cmd)
5854 (tramp-process-multi-actions p method user host
5855 tramp-multi-actions)))
5857 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
5858 ;; of no user name provided. Hack to make it work as it did before:
5859 ;; changed `user' to `(or user (user-login-name))' in the places where
5860 ;; the value is actually used.
5861 (defun tramp-multi-connect-rlogin (p method user host command)
5862 "Issue `rlogin' command.
5863 Uses shell COMMAND to issue an `rlogin' command to log in as USER to
5864 HOST. You can use percent escapes in COMMAND. `%u' will be replaced
5865 with the user name, `%h' will be replaced with the host name, and `%n'
5866 will be replaced with the value of `tramp-rsh-end-of-line'. You can use
5867 `%%' if you want to use a literal percent character.
5869 If USER is nil, uses the return value of (user-login-name) instead."
5870 (let ((cmd (format-spec command `((?h . ,host)
5871 (?u . ,(or user (user-login-name)))
5872 (?n . ,tramp-rsh-end-of-line))))
5873 (cmd1 (format-spec command `((?h . ,host)
5874 (?u . ,(or user (user-login-name)))
5878 (tramp-message 9 "Sending rlogin command `%s'" cmd1)
5879 (process-send-string p cmd)
5880 (tramp-process-multi-actions p method user host
5881 tramp-multi-actions)))
5883 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
5884 ;; of no user name provided. Hack to make it work as it did before:
5885 ;; changed `user' to `(or user (user-login-name))' in the places where
5886 ;; the value is actually used.
5887 (defun tramp-multi-connect-su (p method user host command)
5888 "Issue `su' command.
5889 Uses shell COMMAND to issue a `su' command to log in as USER on
5890 HOST. The HOST name is ignored, this just changes the user id on the
5891 host currently logged in to.
5893 If USER is nil, uses the return value of (user-login-name) instead.
5895 You can use percent escapes in the COMMAND. `%u' is replaced with the
5896 user name, and `%n' is replaced with the value of
5897 `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
5899 (let ((cmd (format-spec command `((?u . ,(or user (user-login-name)))
5900 (?n . ,tramp-rsh-end-of-line))))
5901 (cmd1 (format-spec command `((?u . ,(or user (user-login-name)))
5905 (tramp-message 9 "Sending su command `%s'" cmd1)
5906 (process-send-string p cmd)
5907 (tramp-process-multi-actions p method user host
5908 tramp-multi-actions)))
5910 ;; Utility functions.
5912 (defun tramp-accept-process-output
5913 (&optional process timeout timeout-msecs)
5914 "Like `accept-process-output' for Tramp processes.
5915 This is needed in order to hide `last-coding-system-used', which is set
5916 for process communication also."
5917 (let (last-coding-system-used)
5918 (accept-process-output process timeout timeout-msecs)))
5920 (defun tramp-wait-for-regexp (proc timeout regexp)
5921 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
5922 Expects the output of PROC to be sent to the current buffer. Returns
5923 the string that matched, or nil. Waits indefinitely if TIMEOUT is
5926 (start-time (current-time)))
5928 ;; Work around a bug in XEmacs 21, where the timeout
5929 ;; expires faster than it should. This degenerates
5930 ;; to polling for buggy XEmacsen, but oh, well.
5931 (while (and (not found)
5932 (< (tramp-time-diff (current-time) start-time)
5934 (with-timeout (timeout)
5936 (tramp-accept-process-output proc 1)
5937 (unless (memq (process-status proc) '(run open))
5938 (error "Process has died"))
5939 (goto-char (point-min))
5940 (setq found (re-search-forward regexp nil t))))))
5943 (tramp-accept-process-output proc 1)
5944 (unless (memq (process-status proc) '(run open))
5945 (error "Process has died"))
5946 (goto-char (point-min))
5947 (setq found (re-search-forward regexp nil t)))))
5948 (when tramp-debug-buffer
5950 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
5951 tramp-current-user tramp-current-host)
5952 (point-min) (point-max))
5956 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
5957 tramp-current-user tramp-current-host))
5958 (goto-char (point-max))
5959 (insert "[[Regexp `" regexp "' not found"
5960 (if timeout (format " in %d secs" timeout) "")
5964 (defun tramp-wait-for-shell-prompt (proc timeout)
5965 "Wait for the shell prompt to appear from process PROC within TIMEOUT seconds.
5966 See `tramp-wait-for-regexp' for more details.
5967 Shell prompt pattern is determined by variables `shell-prompt-pattern'
5968 and `tramp-shell-prompt-pattern'."
5969 (tramp-wait-for-regexp
5971 (format "\\(%s\\|%s\\)\\'"
5972 shell-prompt-pattern tramp-shell-prompt-pattern)))
5974 (defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
5975 "Wait for shell prompt and barf if none appears.
5976 Looks at process PROC to see if a shell prompt appears in TIMEOUT
5977 seconds. If not, it produces an error message with the given ERROR-ARGS."
5978 (unless (tramp-wait-for-shell-prompt proc timeout)
5979 (pop-to-buffer (buffer-name))
5980 (apply 'error error-args)))
5982 (defun tramp-enter-password (p prompt user host)
5983 "Prompt for a password and send it to the remote end.
5984 Uses PROMPT as a prompt and sends the password to process P."
5985 (let ((pw (tramp-read-passwd user host prompt)))
5987 (process-send-string
5989 (or (tramp-get-method-parameter
5990 tramp-current-multi-method
5991 tramp-current-method
5994 'tramp-password-end-of-line)
5995 tramp-default-password-end-of-line)))))
5997 ;; HHH: Not Changed. This might handle the case where USER is not
5998 ;; given in the "File name" very poorly. Then, the local
5999 ;; variable tramp-current-user will be set to nil.
6000 (defun tramp-pre-connection (multi-method method user host chunksize)
6001 "Do some setup before actually logging in.
6002 METHOD, USER and HOST specify the connection."
6003 (set-buffer (tramp-get-buffer multi-method method user host))
6004 (set (make-local-variable 'tramp-current-multi-method) multi-method)
6005 (set (make-local-variable 'tramp-current-method) method)
6006 (set (make-local-variable 'tramp-current-user) user)
6007 (set (make-local-variable 'tramp-current-host) host)
6008 (set (make-local-variable 'tramp-chunksize) chunksize)
6009 (set (make-local-variable 'inhibit-eol-conversion) nil)
6012 (defun tramp-open-connection-setup-interactive-shell
6013 (p multi-method method user host)
6014 "Set up an interactive shell.
6015 Mainly sets the prompt and the echo correctly. P is the shell process
6016 to set up. METHOD, USER and HOST specify the connection."
6017 ;; Wait a bit in case the remote end feels like sending a little
6018 ;; junk first. It seems that fencepost.gnu.org does this when doing
6019 ;; a Kerberos login.
6021 (tramp-discard-garbage-erase-buffer p multi-method method user host)
6022 (tramp-process-initial-commands p multi-method method user host
6023 tramp-initial-commands)
6024 ;; It is useful to set the prompt in the following command because
6025 ;; some people have a setting for $PS1 which /bin/sh doesn't know
6026 ;; about and thus /bin/sh will display a strange prompt. For
6027 ;; example, if $PS1 has "${CWD}" in the value, then ksh will display
6028 ;; the current working directory but /bin/sh will display a dollar
6029 ;; sign. The following command line sets $PS1 to a sane value, and
6030 ;; works under Bourne-ish shells as well as csh-like shells. Daniel
6031 ;; Pittman reports that the unusual positioning of the single quotes
6032 ;; makes it work under `rc', too. We also unset the variable $ENV
6033 ;; because that is read by some sh implementations (eg, bash when
6034 ;; called as sh) on startup; this way, we avoid the startup file
6036 (tramp-send-command-internal
6037 multi-method method user host
6038 (format "exec env 'ENV=' 'PS1=$ ' %s"
6039 (tramp-get-method-parameter
6040 multi-method method user host 'tramp-remote-sh))
6041 (format "remote `%s' to come up"
6042 (tramp-get-method-parameter
6043 multi-method method user host 'tramp-remote-sh)))
6044 (tramp-barf-if-no-shell-prompt
6046 "Remote `%s' didn't come up. See buffer `%s' for details"
6047 (tramp-get-method-parameter multi-method method user host 'tramp-remote-sh)
6049 (tramp-message 8 "Setting up remote shell environment")
6050 (tramp-discard-garbage-erase-buffer p multi-method method user host)
6051 (tramp-send-command-internal multi-method method user host
6052 "stty -inlcr -echo kill '^U'")
6054 ;; Ignore garbage after stty command.
6055 (tramp-send-command-internal multi-method method user host
6058 (tramp-send-command-internal multi-method method user host
6059 "TERM=dumb; export TERM")
6061 ;; Check whether the remote host suffers from buggy `send-process-string'.
6062 ;; This is known for FreeBSD (see comment in `send_process', file process.c).
6063 ;; I've tested sending 624 bytes successfully, sending 625 bytes failed.
6064 ;; Emacs makes a hack when this host type is detected locally. It cannot
6065 ;; handle remote hosts, though.
6066 (when (or (not tramp-chunksize) (zerop tramp-chunksize))
6067 (tramp-message 9 "Checking remote host type for `send-process-string' bug")
6068 (tramp-send-command-internal multi-method method user host
6069 "(uname -sr) 2>/dev/null")
6070 (goto-char (point-min))
6071 (when (looking-at "FreeBSD")
6072 (setq tramp-chunksize 500)))
6074 ;; Try to set up the coding system correctly.
6075 ;; CCC this can't be the right way to do it. Hm.
6078 (tramp-message 9 "Determining coding system")
6079 (tramp-send-command-internal multi-method method user host
6080 "echo foo ; echo bar")
6081 (goto-char (point-min))
6082 (if (featurep 'mule)
6083 ;; Use MULE to select the right EOL convention for communicating
6084 ;; with the process.
6085 (let* ((cs (or (process-coding-system p) (cons 'undecided 'undecided)))
6086 cs-decode cs-encode)
6087 (when (symbolp cs) (setq cs (cons cs cs)))
6088 (setq cs-decode (car cs))
6089 (setq cs-encode (cdr cs))
6090 (unless cs-decode (setq cs-decode 'undecided))
6091 (unless cs-encode (setq cs-encode 'undecided))
6092 (setq cs-encode (tramp-coding-system-change-eol-conversion
6094 (when (search-forward "\r" nil t)
6095 (setq cs-decode (tramp-coding-system-change-eol-conversion
6097 (set-buffer-process-coding-system cs-decode cs-encode))
6098 ;; Look for ^M and do something useful if found.
6099 (when (search-forward "\r" nil t)
6100 ;; We have found a ^M but cannot frob the process coding system
6101 ;; because we're running on a non-MULE Emacs. Let's try
6104 (tramp-message 9 "Trying `stty -onlcr'")
6105 (tramp-send-command-internal multi-method method user host
6109 9 "Waiting 30s for `HISTFILE=$HOME/.tramp_history; HISTSIZE=1; export HISTFILE; export HISTSIZE'")
6110 (tramp-send-command-internal
6111 multi-method method user host
6112 "HISTFILE=$HOME/.tramp_history; HISTSIZE=1; export HISTFILE; export HISTSIZE")
6114 (tramp-message 9 "Waiting 30s for `set +o vi +o emacs'")
6115 (tramp-send-command-internal multi-method method user host
6116 "set +o vi +o emacs")
6118 (tramp-message 9 "Waiting 30s for `unset MAIL MAILCHECK MAILPATH'")
6119 (tramp-send-command-internal
6120 multi-method method user host
6121 "unset MAIL MAILCHECK MAILPATH 1>/dev/null 2>/dev/null")
6123 (tramp-message 9 "Waiting 30s for `unset CDPATH'")
6124 (tramp-send-command-internal multi-method method user host
6127 (tramp-message 9 "Setting shell prompt")
6128 ;; Douglas Gray Stephens <DGrayStephens@slb.com> says that we must
6129 ;; use "\n" here, not tramp-rsh-end-of-line. We also manually frob
6130 ;; the last time we sent a command, to avoid tramp-send-command to send
6131 ;; "echo are you awake".
6132 (setq tramp-last-cmd-time (current-time))
6134 multi-method method user host
6135 (format "PS1='%s%s%s'; PS2=''; PS3=''"
6136 tramp-rsh-end-of-line
6138 tramp-rsh-end-of-line))
6139 (tramp-wait-for-output))
6141 (defun tramp-post-connection (multi-method method user host)
6142 "Prepare a remote shell before being able to work on it.
6143 METHOD, USER and HOST specify the connection.
6144 Among other things, this finds a shell which groks tilde expansion,
6145 tries to find an `ls' command which groks the `-n' option, sets the
6146 locale to C and sets up the remote shell search path."
6147 ;; Search for a good shell before searching for a command which
6148 ;; checks if a file exists. This is done because Tramp wants to use
6149 ;; "test foo; echo $?" to check if various conditions hold, and
6150 ;; there are buggy /bin/sh implementations which don't execute the
6151 ;; "echo $?" part if the "test" part has an error. In particular,
6152 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
6153 ;; with buggy /bin/sh implementations will have a working bash or
6155 (tramp-find-shell multi-method method user host)
6156 ;; Without (sit-for 0.1) at least, my machine will almost always blow
6157 ;; up on 'not numberp /root' - a race that causes the 'echo ~root'
6158 ;; output of (tramp-find-shell) to show up along with the output of
6159 ;; (tramp-find-ls-command) testing.
6161 ;; I can't work out why this is a problem though. The (tramp-wait-for-output)
6162 ;; call in (tramp-find-shell) *should* make this not happen, I thought.
6164 ;; After much debugging I couldn't find any problem with the implementation
6165 ;; of that function though. The workaround stays for me at least. :/
6167 ;; Daniel Pittman <daniel@danann.net>
6170 (tramp-find-file-exists-command multi-method method user host)
6171 (make-local-variable 'tramp-ls-command)
6172 (setq tramp-ls-command (tramp-find-ls-command multi-method method user host))
6173 (unless tramp-ls-command
6176 "Danger! Couldn't find ls which groks -n. Muddling through anyway")
6177 (setq tramp-ls-command
6178 (tramp-find-executable multi-method method user host
6179 "ls" tramp-remote-path nil)))
6180 (unless tramp-ls-command
6181 (error "Fatal error: Couldn't find remote executable `ls'"))
6182 (tramp-message 5 "Using remote command `%s' for getting directory listings"
6184 (tramp-send-command multi-method method user host
6185 (concat "tramp_set_exit_status () {" tramp-rsh-end-of-line
6186 "return $1" tramp-rsh-end-of-line
6188 (tramp-wait-for-output)
6189 ;; Set remote PATH variable.
6190 (tramp-set-remote-path multi-method method user host "PATH" tramp-remote-path)
6191 ;; Tell remote shell to use standard time format, needed for
6192 ;; parsing `ls -l' output.
6193 (tramp-send-command multi-method method user host
6194 "LC_TIME=C; export LC_TIME; echo huhu")
6195 (tramp-wait-for-output)
6196 (tramp-send-command multi-method method user host
6197 "mesg n; echo huhu")
6198 (tramp-wait-for-output)
6199 (tramp-send-command multi-method method user host
6200 "biff n ; echo huhu")
6201 (tramp-wait-for-output)
6202 ;; Unalias ls(1) to work around issues with those silly people who make it
6203 ;; spit out ANSI escapes or whatever.
6204 (tramp-send-command multi-method method user host
6205 "unalias ls; echo huhu")
6206 (tramp-wait-for-output)
6207 ;; Does `test A -nt B' work? Use abominable `find' construct if it
6208 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
6209 ;; for otherwise the shell crashes.
6211 (make-local-variable 'tramp-test-groks-nt)
6212 (tramp-send-command multi-method method user host
6214 (tramp-wait-for-output)
6215 (goto-char (point-min))
6216 (setq tramp-test-groks-nt
6217 (looking-at (format "\n%s\r?\n" (regexp-quote tramp-end-of-output))))
6218 (unless tramp-test-groks-nt
6220 multi-method method user host
6221 (concat "tramp_test_nt () {" tramp-rsh-end-of-line
6222 "test -n \"`find $1 -prune -newer $2 -print`\"" tramp-rsh-end-of-line
6224 (tramp-wait-for-output)
6225 ;; Send the fallback `uudecode' script.
6227 (tramp-send-string multi-method method user host tramp-uudecode)
6228 (tramp-wait-for-output)
6231 (tramp-set-connection-property "perl-scripts" nil multi-method method user host)
6232 (let ((tramp-remote-perl
6233 (or (tramp-find-executable multi-method method user host
6234 "perl5" tramp-remote-path nil)
6235 (tramp-find-executable multi-method method user host
6236 "perl" tramp-remote-path nil))))
6237 (when tramp-remote-perl
6238 (tramp-set-connection-property "perl" tramp-remote-perl
6239 multi-method method user host)
6240 (unless (tramp-method-out-of-band-p multi-method method user host)
6241 (tramp-message 5 "Sending the Perl `mime-encode' implementations.")
6243 multi-method method user host
6244 (concat "tramp_encode () {\n"
6245 (format tramp-perl-encode tramp-remote-perl)
6248 (tramp-wait-for-output)
6250 multi-method method user host
6251 (concat "tramp_encode_with_module () {\n"
6252 (format tramp-perl-encode-with-module tramp-remote-perl)
6255 (tramp-wait-for-output)
6256 (tramp-message 5 "Sending the Perl `mime-decode' implementations.")
6258 multi-method method user host
6259 (concat "tramp_decode () {\n"
6260 (format tramp-perl-decode tramp-remote-perl)
6263 (tramp-wait-for-output)
6265 multi-method method user host
6266 (concat "tramp_decode_with_module () {\n"
6267 (format tramp-perl-decode-with-module tramp-remote-perl)
6270 (tramp-wait-for-output))))
6273 (let ((ln (tramp-find-executable multi-method method user host
6274 "ln" tramp-remote-path nil)))
6276 (tramp-set-connection-property "ln" ln multi-method method user host)))
6279 (tramp-send-command multi-method method user host "id -u; id -g")
6280 (tramp-wait-for-output)
6281 (goto-char (point-min))
6282 (tramp-set-connection-property
6283 "uid" (read (current-buffer)) multi-method method user host)
6284 (tramp-set-connection-property
6285 "gid" (read (current-buffer)) multi-method method user host)
6286 ;; Find the right encoding/decoding commands to use.
6288 (unless (tramp-method-out-of-band-p multi-method method user host)
6289 (tramp-find-inline-encoding multi-method method user host))
6290 ;; If encoding/decoding command are given, test to see if they work.
6291 ;; CCC: Maybe it would be useful to run the encoder both locally and
6292 ;; remotely to see if they produce the same result.
6293 (let ((rem-enc (tramp-get-remote-encoding multi-method method user host))
6294 (rem-dec (tramp-get-remote-decoding multi-method method user host))
6295 (magic-string "xyzzy"))
6296 (when (and (or rem-dec rem-enc) (not (and rem-dec rem-enc)))
6297 (tramp-kill-process multi-method method user host)
6298 ;; Improve error message and/or error check.
6300 "Must give both decoding and encoding command in method definition"))
6301 (when (and rem-enc rem-dec)
6304 "Checking to see if encoding/decoding commands work on remote host...")
6306 multi-method method user host
6307 (format "echo %s | %s | %s"
6308 (tramp-shell-quote-argument magic-string) rem-enc rem-dec))
6309 (tramp-wait-for-output)
6310 (unless (looking-at (regexp-quote magic-string))
6311 (tramp-kill-process multi-method method user host)
6312 (error "Remote host cannot execute de/encoding commands. See buffer `%s' for details"
6316 5 "Checking to see if encoding/decoding commands work on remote host...done"))))
6318 ;; CCC: We should either implement a Perl version of base64 encoding
6319 ;; and decoding. Then we just use that in the last item. The other
6320 ;; alternative is to use the Perl version of UU encoding. But then
6321 ;; we need a Lisp version of uuencode.
6323 ;; Old text from documentation of tramp-methods:
6324 ;; Using a uuencode/uudecode inline method is discouraged, please use one
6325 ;; of the base64 methods instead since base64 encoding is much more
6326 ;; reliable and the commands are more standardized between the different
6327 ;; Unix versions. But if you can't use base64 for some reason, please
6328 ;; note that the default uudecode command does not work well for some
6329 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
6330 ;; the following command for uudecode:
6332 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
6334 ;; For Irix, no solution is known yet.
6336 (defvar tramp-coding-commands
6337 '(("mimencode -b" "mimencode -u -b"
6338 base64-encode-region base64-decode-region)
6339 ("mmencode -b" "mmencode -u -b"
6340 base64-encode-region base64-decode-region)
6341 ("recode data..base64" "recode base64..data"
6342 base64-encode-region base64-decode-region)
6343 ("uuencode xxx" "uudecode -o /dev/stdout"
6344 tramp-uuencode-region uudecode-decode-region)
6345 ("uuencode xxx" "uudecode -o -"
6346 tramp-uuencode-region uudecode-decode-region)
6347 ("uuencode xxx" "uudecode -p"
6348 tramp-uuencode-region uudecode-decode-region)
6349 ("uuencode xxx" "tramp_uudecode"
6350 tramp-uuencode-region uudecode-decode-region)
6351 ("tramp_encode_with_module" "tramp_decode_with_module"
6352 base64-encode-region base64-decode-region)
6353 ("tramp_encode" "tramp_decode"
6354 base64-encode-region base64-decode-region))
6355 "List of coding commands for inline transfer.
6356 Each item is a list that looks like this:
6358 \(REMOTE-ENCODING REMOTE-DECODING LOCAL-ENCODING LOCAL-DECODING)
6360 The REMOTE-ENCODING should be a string, giving a command accepting a
6361 plain file on standard input and writing the encoded file to standard
6362 output. The REMOTE-DECODING should also be a string, giving a command
6363 accepting an encoded file on standard input and writing the decoded
6364 file to standard output.
6366 LOCAL-ENCODING and LOCAL-DECODING can be strings, giving commands, or
6367 symbols, giving functions. If they are strings, then they can contain
6368 the \"%s\" format specifier. If that specifier is present, the input
6369 filename will be put into the command line at that spot. If the
6370 specifier is not present, the input should be read from standard
6373 If they are functions, they will be called with two arguments, start
6374 and end of region, and are expected to replace the region contents
6375 with the encoded or decoded results, respectively.")
6377 (defun tramp-find-inline-encoding (multi-method method user host)
6378 "Find an inline transfer encoding that works.
6379 Goes through the list `tramp-coding-commands'."
6380 (let ((commands tramp-coding-commands)
6383 (while (and commands (null found))
6384 (setq item (pop commands))
6386 (let ((rem-enc (nth 0 item))
6387 (rem-dec (nth 1 item))
6388 (loc-enc (nth 2 item))
6389 (loc-dec (nth 3 item)))
6390 ;; Check if remote encoding and decoding commands can be
6391 ;; called remotely with null input and output. This makes
6392 ;; sure there are no syntax errors and the command is really
6393 ;; found. Note that we do not redirect stdout to /dev/null,
6394 ;; for two reaons: when checking the decoding command, we
6395 ;; actually check the output it gives. And also, when
6396 ;; redirecting "mimencode" output to /dev/null, then as root
6397 ;; it might change the permissions of /dev/null!
6398 (tramp-message-for-buffer
6399 multi-method method user host 9
6400 "Checking remote encoding command `%s' for sanity" rem-enc)
6401 (unless (zerop (tramp-send-command-and-check
6402 multi-method method user host
6403 (format "%s </dev/null" rem-enc) t))
6404 (throw 'wont-work nil))
6405 (tramp-message-for-buffer
6406 multi-method method user host 9
6407 "Checking remote decoding command `%s' for sanity" rem-dec)
6408 (unless (zerop (tramp-send-command-and-check
6409 multi-method method user host
6410 (format "echo %s | %s | %s"
6411 magic rem-enc rem-dec) t))
6412 (throw 'wont-work nil))
6414 (goto-char (point-min))
6415 (unless (looking-at (regexp-quote magic))
6416 (throw 'wont-work nil)))
6417 ;; If the local encoder or decoder is a string, the
6418 ;; corresponding command has to work locally.
6419 (when (stringp loc-enc)
6420 (tramp-message-for-buffer
6421 multi-method method user host 9
6422 "Checking local encoding command `%s' for sanity" loc-enc)
6423 (unless (zerop (tramp-call-local-coding-command
6425 (throw 'wont-work nil)))
6426 (when (stringp loc-dec)
6427 (tramp-message-for-buffer
6428 multi-method method user host 9
6429 "Checking local decoding command `%s' for sanity" loc-dec)
6430 (unless (zerop (tramp-call-local-coding-command
6432 (throw 'wont-work nil)))
6433 ;; CCC: At this point, maybe we should check that the output
6434 ;; of the commands is correct. But for the moment we will
6435 ;; assume that commands working on empty input will also
6436 ;; work in practice.
6437 (setq found item))))
6438 ;; Did we find something? If not, issue error. If so,
6439 ;; set connection properties.
6441 (error "Couldn't find an inline transfer encoding"))
6442 (let ((rem-enc (nth 0 found))
6443 (rem-dec (nth 1 found))
6444 (loc-enc (nth 2 found))
6445 (loc-dec (nth 3 found)))
6446 (tramp-message 10 "Using remote encoding %s" rem-enc)
6447 (tramp-set-remote-encoding multi-method method user host rem-enc)
6448 (tramp-message 10 "Using remote decoding %s" rem-dec)
6449 (tramp-set-remote-decoding multi-method method user host rem-dec)
6450 (tramp-message 10 "Using local encoding %s" loc-enc)
6451 (tramp-set-local-encoding multi-method method user host loc-enc)
6452 (tramp-message 10 "Using local decoding %s" loc-dec)
6453 (tramp-set-local-decoding multi-method method user host loc-dec))))
6455 (defun tramp-call-local-coding-command (cmd input output)
6456 "Call the local encoding or decoding command.
6457 If CMD contains \"%s\", provide input file INPUT there in command.
6458 Otherwise, INPUT is passed via standard input.
6459 INPUT can also be nil which means `/dev/null'.
6460 OUTPUT can be a string (which specifies a filename), or t (which
6461 means standard output and thus the current buffer), or nil (which
6464 tramp-encoding-shell ;program
6465 (when (and input (not (string-match "%s" cmd)))
6467 (if (eq output t) t nil) ;output
6469 tramp-encoding-command-switch
6470 ;; actual shell command
6472 (if (string-match "%s" cmd) (format cmd input) cmd)
6473 (if (stringp output) (concat "> " output) ""))))
6475 (defun tramp-maybe-open-connection (multi-method method user host)
6476 "Maybe open a connection to HOST, logging in as USER, using METHOD.
6477 Does not do anything if a connection is already open, but re-opens the
6478 connection if a previous connection has died for some reason."
6479 (let ((p (get-buffer-process
6480 (tramp-get-buffer multi-method method user host)))
6482 ;; If too much time has passed since last command was sent, look
6483 ;; whether process is still alive. If it isn't, kill it. When
6484 ;; using ssh, it can sometimes happen that the remote end has hung
6485 ;; up but the local ssh client doesn't recognize this until it
6486 ;; tries to send some data to the remote end. So that's why we
6487 ;; try to send a command from time to time, then look again
6488 ;; whether the process is really alive.
6490 (set-buffer (tramp-get-buffer multi-method method user host))
6491 (when (and tramp-last-cmd-time
6492 (> (tramp-time-diff (current-time) tramp-last-cmd-time) 60)
6493 p (processp p) (memq (process-status p) '(run open)))
6495 multi-method method user host "echo are you awake" nil t)
6496 (unless (and (memq (process-status p) '(run open))
6497 (tramp-wait-for-output 10))
6501 (unless (and p (processp p) (memq (process-status p) '(run open)))
6502 (when (and p (processp p))
6504 (let ((process-connection-type tramp-process-connection-type))
6505 (funcall (tramp-get-method-parameter
6507 (tramp-find-method multi-method method user host)
6508 user host 'tramp-connection-function)
6509 multi-method method user host)))))
6511 (defun tramp-send-command
6512 (multi-method method user host command &optional noerase neveropen)
6513 "Send the COMMAND to USER at HOST (logged in using METHOD).
6514 Erases temporary buffer before sending the command (unless NOERASE
6516 If optional seventh arg NEVEROPEN is non-nil, never try to open the
6517 connection. This is meant to be used from
6518 `tramp-maybe-open-connection' only."
6520 (tramp-maybe-open-connection multi-method method user host))
6521 (setq tramp-last-cmd-time (current-time))
6522 (setq tramp-last-cmd command)
6523 (when tramp-debug-buffer
6525 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6526 (goto-char (point-max))
6527 (tramp-insert-with-face 'bold (format "$ %s\n" command))))
6529 (set-buffer (tramp-get-buffer multi-method method user host))
6530 (unless noerase (erase-buffer))
6531 (setq proc (get-buffer-process (current-buffer)))
6532 (process-send-string proc
6533 (concat command tramp-rsh-end-of-line))))
6535 (defun tramp-send-command-internal
6536 (multi-method method user host command &optional msg)
6537 "Send command to remote host and wait for success.
6538 Sends COMMAND, then waits 30 seconds for shell prompt."
6539 (tramp-send-command multi-method method user host command t t)
6541 (tramp-message 9 "Waiting 30s for %s..." msg))
6542 (tramp-barf-if-no-shell-prompt
6544 "Couldn't `%s', see buffer `%s'" command (buffer-name)))
6546 (defun tramp-wait-for-output (&optional timeout)
6547 "Wait for output from remote rsh command."
6548 (let ((proc (get-buffer-process (current-buffer)))
6550 (start-time (current-time))
6551 (start-point (point))
6552 (end-of-output (concat "^"
6553 (regexp-quote tramp-end-of-output)
6555 ;; Algorithm: get waiting output. See if last line contains
6556 ;; end-of-output sentinel. If not, wait a bit and again get
6557 ;; waiting output. Repeat until timeout expires or end-of-output
6558 ;; sentinel is seen. Will hang if timeout is nil and
6559 ;; end-of-output sentinel never appears.
6562 ;; Work around an XEmacs bug, where the timeout expires
6563 ;; faster than it should. This degenerates into polling
6564 ;; for buggy XEmacsen, but oh, well.
6565 (while (and (not found)
6566 (< (tramp-time-diff (current-time) start-time)
6568 (with-timeout (timeout)
6570 (tramp-accept-process-output proc 1)
6571 (unless (memq (process-status proc) '(run open))
6572 (error "Process has died"))
6573 (goto-char (point-max))
6575 (setq found (looking-at end-of-output))))))
6578 (tramp-accept-process-output proc 1)
6579 (unless (memq (process-status proc) '(run open))
6580 (error "Process has died"))
6581 (goto-char (point-max))
6583 (setq found (looking-at end-of-output))))))
6584 ;; At this point, either the timeout has expired or we have found
6585 ;; the end-of-output sentinel.
6587 (goto-char (point-max))
6589 (delete-region (point) (point-max)))
6590 ;; If processing echoes, look for it in the first line and delete.
6591 (when tramp-process-echoes
6593 (goto-char start-point)
6594 (when (looking-at (regexp-quote tramp-last-cmd))
6595 (delete-region (point) (progn (forward-line 1) (point))))))
6596 ;; Add output to debug buffer if appropriate.
6597 (when tramp-debug-buffer
6599 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6600 tramp-current-user tramp-current-host)
6601 (point-min) (point-max))
6605 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6606 tramp-current-user tramp-current-host))
6607 (goto-char (point-max))
6608 (insert "[[Remote prompt `" end-of-output "' not found"
6609 (if timeout (format " in %d secs" timeout) "")
6611 (goto-char (point-min))
6612 ;; Return value is whether end-of-output sentinel was found.
6615 (defun tramp-send-command-and-check (multi-method method user host command
6617 "Run COMMAND and check its exit status.
6618 MULTI-METHOD and METHOD specify how to log in (as USER) to the remote HOST.
6619 Sends `echo $?' along with the COMMAND for checking the exit status. If
6620 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
6622 If the optional argument SUBSHELL is non-nil, the command is executed in
6623 a subshell, ie surrounded by parentheses."
6624 (tramp-send-command multi-method method user host
6625 (concat (if subshell "( " "")
6627 (if command " 2>/dev/null; " "")
6628 "echo tramp_exit_status $?"
6629 (if subshell " )" " ")))
6630 (tramp-wait-for-output)
6631 (goto-char (point-max))
6632 (unless (search-backward "tramp_exit_status " nil t)
6633 (error "Couldn't find exit status of `%s'" command))
6634 (skip-chars-forward "^ ")
6635 (read (current-buffer)))
6637 (defun tramp-barf-unless-okay (multi-method method user host command subshell
6638 signal fmt &rest args)
6639 "Run COMMAND, check exit status, throw error if exit status not okay.
6640 Similar to `tramp-send-command-and-check' but accepts two more arguments
6641 FMT and ARGS which are passed to `error'."
6642 (unless (zerop (tramp-send-command-and-check
6643 multi-method method user host command subshell))
6644 ;; CCC: really pop-to-buffer? Maybe it's appropriate to be more
6646 (pop-to-buffer (current-buffer))
6647 (funcall 'signal signal (apply 'format fmt args))))
6649 ;; It seems that Tru64 Unix does not like it if long strings are sent
6650 ;; to it in one go. (This happens when sending the Perl
6651 ;; `file-attributes' implementation, for instance.) Therefore, we
6652 ;; have this function which waits a bit at each line.
6653 (defun tramp-send-string
6654 (multi-method method user host string)
6655 "Send the STRING to USER at HOST using METHOD.
6657 The STRING is expected to use Unix line-endings, but the lines sent to
6658 the remote host use line-endings as defined in the variable
6659 `tramp-rsh-end-of-line'."
6660 (let ((proc (get-buffer-process
6661 (tramp-get-buffer multi-method method user host))))
6663 (error "Can't send string to remote host -- not logged in"))
6665 (when tramp-debug-buffer
6667 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6668 (goto-char (point-max))
6669 (tramp-insert-with-face 'bold (format "$ %s\n" string))))
6670 ;; replace "\n" by `tramp-rsh-end-of-line'
6672 (mapconcat 'identity
6673 (split-string string "\n")
6674 tramp-rsh-end-of-line))
6675 (unless (or (string= string "")
6676 (string-equal (substring string -1) tramp-rsh-end-of-line))
6677 (setq string (concat string tramp-rsh-end-of-line)))
6679 (if (and tramp-chunksize (not (zerop tramp-chunksize)))
6681 (end (length string)))
6683 (tramp-message-for-buffer
6684 multi-method method user host 10
6685 "Sending chunk from %s to %s"
6686 pos (min (+ pos tramp-chunksize) end))
6687 (process-send-string
6688 proc (substring string pos (min (+ pos tramp-chunksize) end)))
6689 (setq pos (+ pos tramp-chunksize))
6691 (process-send-string proc string))))
6693 (defun tramp-send-eof (multi-method method user host)
6694 "Send EOF to the remote end.
6695 METHOD, HOST and USER specify the connection."
6696 (let ((proc (get-buffer-process
6697 (tramp-get-buffer multi-method method user host))))
6699 (error "Can't send EOF to remote host -- not logged in"))
6700 (process-send-eof proc)))
6701 ; (process-send-string proc "\^D")))
6703 (defun tramp-kill-process (multi-method method user host)
6704 "Kill the connection process used by Tramp.
6705 MULTI-METHOD, METHOD, USER, and HOST specify the connection."
6706 (let ((proc (get-buffer-process
6707 (tramp-get-buffer multi-method method user host))))
6708 (kill-process proc)))
6710 (defun tramp-discard-garbage-erase-buffer (p multi-method method user host)
6711 "Erase buffer, then discard subsequent garbage.
6712 If `tramp-discard-garbage' is nil, just erase buffer."
6713 (if (not tramp-discard-garbage)
6715 (while (prog1 (erase-buffer) (tramp-accept-process-output p 0.25))
6716 (when tramp-debug-buffer
6718 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6719 (goto-char (point-max))
6720 (tramp-insert-with-face
6721 'bold (format "Additional characters detected\n")))))))
6723 (defun tramp-mode-string-to-int (mode-string)
6724 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
6725 (let* ((mode-chars (string-to-vector mode-string))
6726 (owner-read (aref mode-chars 1))
6727 (owner-write (aref mode-chars 2))
6728 (owner-execute-or-setid (aref mode-chars 3))
6729 (group-read (aref mode-chars 4))
6730 (group-write (aref mode-chars 5))
6731 (group-execute-or-setid (aref mode-chars 6))
6732 (other-read (aref mode-chars 7))
6733 (other-write (aref mode-chars 8))
6734 (other-execute-or-sticky (aref mode-chars 9)))
6738 (?r (tramp-octal-to-decimal "00400")) (?- 0)
6739 (t (error "Second char `%c' must be one of `r-'" owner-read)))
6741 (?w (tramp-octal-to-decimal "00200")) (?- 0)
6742 (t (error "Third char `%c' must be one of `w-'" owner-write)))
6743 (case owner-execute-or-setid
6744 (?x (tramp-octal-to-decimal "00100"))
6745 (?S (tramp-octal-to-decimal "04000"))
6746 (?s (tramp-octal-to-decimal "04100"))
6748 (t (error "Fourth char `%c' must be one of `xsS-'"
6749 owner-execute-or-setid)))
6751 (?r (tramp-octal-to-decimal "00040")) (?- 0)
6752 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
6754 (?w (tramp-octal-to-decimal "00020")) (?- 0)
6755 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
6756 (case group-execute-or-setid
6757 (?x (tramp-octal-to-decimal "00010"))
6758 (?S (tramp-octal-to-decimal "02000"))
6759 (?s (tramp-octal-to-decimal "02010"))
6761 (t (error "Seventh char `%c' must be one of `xsS-'"
6762 group-execute-or-setid)))
6764 (?r (tramp-octal-to-decimal "00004")) (?- 0)
6765 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
6767 (?w (tramp-octal-to-decimal "00002")) (?- 0)
6768 (t (error "Nineth char `%c' must be one of `w-'" other-write)))
6769 (case other-execute-or-sticky
6770 (?x (tramp-octal-to-decimal "00001"))
6771 (?T (tramp-octal-to-decimal "01000"))
6772 (?t (tramp-octal-to-decimal "01001"))
6774 (t (error "Tenth char `%c' must be one of `xtT-'"
6775 other-execute-or-sticky)))))))
6777 (defun tramp-convert-file-attributes (multi-method method user host attr)
6778 "Convert file-attributes ATTR generated by perl script or ls.
6779 Convert file mode bits to string and set virtual device number.
6781 ;; Convert file mode bits to string.
6782 (unless (stringp (nth 8 attr))
6783 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr))))
6784 ;; Set file's gid change bit. Possible only when id-format is 'integer.
6785 (when (numberp (nth 3 attr))
6786 (setcar (nthcdr 9 attr)
6787 (not (= (nth 3 attr)
6788 (tramp-get-remote-gid multi-method method user host)))))
6789 ;; Set virtual device number.
6790 (setcar (nthcdr 11 attr)
6791 (tramp-get-device multi-method method user host))
6794 (defun tramp-get-device (multi-method method user host)
6795 "Returns the virtual device number.
6796 If it doesn't exist, generate a new one."
6797 (let ((string (tramp-make-tramp-file-name multi-method method user host "")))
6798 (unless (assoc string tramp-devices)
6799 (add-to-list 'tramp-devices
6800 (list string (length tramp-devices))))
6801 (list -1 (nth 1 (assoc string tramp-devices)))))
6803 (defun tramp-file-mode-from-int (mode)
6804 "Turn an integer representing a file mode into an ls(1)-like string."
6805 (let ((type (cdr (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
6806 (user (logand (lsh mode -6) 7))
6807 (group (logand (lsh mode -3) 7))
6808 (other (logand (lsh mode -0) 7))
6809 (suid (> (logand (lsh mode -9) 4) 0))
6810 (sgid (> (logand (lsh mode -9) 2) 0))
6811 (sticky (> (logand (lsh mode -9) 1) 0)))
6812 (setq user (tramp-file-mode-permissions user suid "s"))
6813 (setq group (tramp-file-mode-permissions group sgid "s"))
6814 (setq other (tramp-file-mode-permissions other sticky "t"))
6815 (concat type user group other)))
6818 (defun tramp-file-mode-permissions (perm suid suid-text)
6819 "Convert a permission bitset into a string.
6820 This is used internally by `tramp-file-mode-from-int'."
6821 (let ((r (> (logand perm 4) 0))
6822 (w (> (logand perm 2) 0))
6823 (x (> (logand perm 1) 0)))
6824 (concat (or (and r "r") "-")
6825 (or (and w "w") "-")
6826 (or (and suid x suid-text) ; suid, execute
6827 (and suid (upcase suid-text)) ; suid, !execute
6828 (and x "x") "-")))) ; !suid
6831 (defun tramp-decimal-to-octal (i)
6832 "Return a string consisting of the octal digits of I.
6833 Not actually used. Use `(format \"%o\" i)' instead?"
6834 (cond ((< i 0) (error "Cannot convert negative number to octal"))
6835 ((not (integerp i)) (error "Cannot convert non-integer to octal"))
6837 (t (concat (tramp-decimal-to-octal (/ i 8))
6838 (number-to-string (% i 8))))))
6841 ;;(defun tramp-octal-to-decimal (ostr)
6842 ;; "Given a string of octal digits, return a decimal number."
6843 ;; (cond ((null ostr) 0)
6844 ;; ((string= "" ostr) 0)
6845 ;; (t (let ((last (aref ostr (1- (length ostr))))
6846 ;; (rest (substring ostr 0 (1- (length ostr)))))
6847 ;; (unless (and (>= last ?0)
6849 ;; (error "Not an octal digit: %c" last))
6850 ;; (+ (- last ?0) (* 8 (tramp-octal-to-decimal rest)))))))
6851 ;; Kudos to Gerd Moellmann for this suggestion.
6852 (defun tramp-octal-to-decimal (ostr)
6853 "Given a string of octal digits, return a decimal number."
6854 (let ((x (or ostr "")))
6855 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
6856 (unless (string-match "\\`[0-7]*\\'" x)
6857 (error "Non-octal junk in string `%s'" x))
6858 (string-to-number ostr 8)))
6860 (defun tramp-shell-case-fold (string)
6861 "Converts STRING to shell glob pattern which ignores case."
6864 (if (equal (downcase c) (upcase c))
6866 (format "[%c%c]" (downcase c) (upcase c))))
6871 ;; ------------------------------------------------------------
6872 ;; -- TRAMP file names --
6873 ;; ------------------------------------------------------------
6874 ;; Conversion functions between external representation and
6875 ;; internal data structure. Convenience functions for internal
6878 (defstruct tramp-file-name multi-method method user host localname)
6880 (defun tramp-tramp-file-p (name)
6881 "Return t iff NAME is a tramp file."
6883 (string-match tramp-file-name-regexp name)))
6885 ;; HHH: Changed. Used to assign the return value of (user-login-name)
6886 ;; to the `user' part of the structure if a user name was not
6887 ;; provided, now it assigns nil.
6888 (defun tramp-dissect-file-name (name)
6889 "Return an `tramp-file-name' structure.
6890 The structure consists of remote method, remote user, remote host and
6891 localname (file name on remote host)."
6893 (let* ((match (string-match (nth 0 tramp-file-name-structure) name))
6896 (if match (match-string (nth 1 tramp-file-name-structure) name)
6899 (format (nth 0 tramp-multi-file-name-structure)
6900 (nth 0 tramp-multi-file-name-hop-structure)) name)
6901 (match-string (nth 1 tramp-multi-file-name-structure) name))))
6902 (if (and method (member method tramp-multi-methods))
6903 ;; If it's a multi method, the file name structure contains
6904 ;; arrays of method, user and host.
6905 (tramp-dissect-multi-file-name name)
6906 ;; Normal method. First, find out default method.
6907 (unless match (error "Not a tramp file name: %s" name))
6908 (let ((user (match-string (nth 2 tramp-file-name-structure) name))
6909 (host (match-string (nth 3 tramp-file-name-structure) name))
6910 (localname (match-string (nth 4 tramp-file-name-structure) name)))
6911 (make-tramp-file-name
6916 :localname localname))))))
6918 (defun tramp-find-default-method (user host)
6919 "Look up the right method to use in `tramp-default-method-alist'."
6920 (let ((choices tramp-default-method-alist)
6921 (method tramp-default-method)
6924 (setq item (pop choices))
6925 (when (and (string-match (nth 0 item) (or host ""))
6926 (string-match (nth 1 item) (or user "")))
6927 (setq method (nth 2 item))
6928 (setq choices nil)))
6931 (defun tramp-find-method (multi-method method user host)
6932 "Return the right method string to use.
6933 This is MULTI-METHOD, if non-nil. Otherwise, it is METHOD, if non-nil.
6934 If both MULTI-METHOD and METHOD are nil, do a lookup in
6935 `tramp-default-method-alist'."
6936 (or multi-method method (tramp-find-default-method user host)))
6938 ;; HHH: Not Changed. Multi method. Will probably not handle the case where
6939 ;; a user name is not provided in the "file name" very well.
6940 (defun tramp-dissect-multi-file-name (name)
6941 "Not implemented yet."
6942 (let ((regexp (nth 0 tramp-multi-file-name-structure))
6943 (method-index (nth 1 tramp-multi-file-name-structure))
6944 (hops-index (nth 2 tramp-multi-file-name-structure))
6945 (localname-index (nth 3 tramp-multi-file-name-structure))
6946 (hop-regexp (nth 0 tramp-multi-file-name-hop-structure))
6947 (hop-method-index (nth 1 tramp-multi-file-name-hop-structure))
6948 (hop-user-index (nth 2 tramp-multi-file-name-hop-structure))
6949 (hop-host-index (nth 3 tramp-multi-file-name-hop-structure))
6950 method hops len hop-methods hop-users hop-hosts localname)
6951 (unless (string-match (format regexp hop-regexp) name)
6952 (error "Not a multi tramp file name: %s" name))
6953 (setq method (match-string method-index name))
6954 (setq hops (match-string hops-index name))
6955 (setq len (/ (length (match-data t)) 2))
6956 (when (< localname-index 0) (incf localname-index len))
6957 (setq localname (match-string localname-index name))
6959 (while (string-match hop-regexp hops index)
6960 (setq index (match-end 0))
6962 (cons (match-string hop-method-index hops) hop-methods))
6964 (cons (match-string hop-user-index hops) hop-users))
6966 (cons (match-string hop-host-index hops) hop-hosts))))
6967 (make-tramp-file-name
6968 :multi-method method
6969 :method (apply 'vector (reverse hop-methods))
6970 :user (apply 'vector (reverse hop-users))
6971 :host (apply 'vector (reverse hop-hosts))
6972 :localname localname)))
6974 (defun tramp-make-tramp-file-name (multi-method method user host localname)
6975 "Constructs a tramp file name from METHOD, USER, HOST and LOCALNAME."
6977 (tramp-make-tramp-multi-file-name multi-method method user host localname)
6979 (concat tramp-prefix-format
6980 (when method (concat "%m" tramp-postfix-single-method-format))
6981 (when user (concat "%u" tramp-postfix-user-format))
6982 (when host (concat "%h" tramp-postfix-host-format))
6983 (when localname (concat "%p")))
6984 `((?m . ,method) (?u . ,user) (?h . ,host) (?p . ,localname)))))
6986 ;; CCC: Henrik Holm: Not Changed. Multi Method. What should be done
6987 ;; with this when USER is nil?
6988 (defun tramp-make-tramp-multi-file-name (multi-method method user host localname)
6989 "Constructs a tramp file name for a multi-hop method."
6990 (unless tramp-make-multi-tramp-file-format
6991 (error "`tramp-make-multi-tramp-file-format' is nil"))
6992 (let* ((prefix-format (nth 0 tramp-make-multi-tramp-file-format))
6993 (hop-format (nth 1 tramp-make-multi-tramp-file-format))
6994 (localname-format (nth 2 tramp-make-multi-tramp-file-format))
6995 (prefix (format-spec prefix-format `((?m . ,multi-method))))
6997 (localname (format-spec localname-format `((?p . ,localname))))
6999 (len (length method)))
7001 (let ((m (aref method i)) (u (aref user i)) (h (aref host i)))
7002 (setq hops (concat hops (format-spec hop-format
7003 `((?m . ,m) (?u . ,u) (?h . ,h)))))
7005 (concat prefix hops localname)))
7007 (defun tramp-make-copy-program-file-name (user host localname)
7008 "Create a file name suitable to be passed to `rcp' and workalikes."
7010 (format "%s@%s:%s" user host localname)
7011 (format "%s:%s" host localname)))
7013 (defun tramp-method-out-of-band-p (multi-method method user host)
7014 "Return t if this is an out-of-band method, nil otherwise."
7015 (tramp-get-method-parameter
7017 (tramp-find-method multi-method method user host)
7018 user host 'tramp-copy-program))
7020 ;; Variables local to connection.
7022 (defun tramp-get-ls-command (multi-method method user host)
7024 (tramp-maybe-open-connection multi-method method user host)
7025 (set-buffer (tramp-get-buffer multi-method method user host))
7028 (defun tramp-get-test-groks-nt (multi-method method user host)
7030 (tramp-maybe-open-connection multi-method method user host)
7031 (set-buffer (tramp-get-buffer multi-method method user host))
7032 tramp-test-groks-nt))
7034 (defun tramp-get-file-exists-command (multi-method method user host)
7036 (tramp-maybe-open-connection multi-method method user host)
7037 (set-buffer (tramp-get-buffer multi-method method user host))
7038 tramp-file-exists-command))
7040 (defun tramp-get-remote-perl (multi-method method user host)
7041 (tramp-get-connection-property "perl" nil multi-method method user host))
7043 (defun tramp-get-remote-ln (multi-method method user host)
7044 (tramp-get-connection-property "ln" nil multi-method method user host))
7046 (defun tramp-get-remote-uid (multi-method method user host)
7047 (tramp-get-connection-property "uid" nil multi-method method user host))
7049 (defun tramp-get-remote-gid (multi-method method user host)
7050 (tramp-get-connection-property "gid" nil multi-method method user host))
7052 ;; Get a property of a TRAMP connection.
7053 (defun tramp-get-connection-property
7054 (property default multi-method method user host)
7055 "Get the named property for the connection.
7056 If the value is not set for the connection, return `default'"
7057 (tramp-maybe-open-connection multi-method method user host)
7058 (with-current-buffer (tramp-get-buffer multi-method method user host)
7061 (symbol-value (intern (concat "tramp-connection-property-" property)))
7064 ;; Set a property of a TRAMP connection.
7065 (defun tramp-set-connection-property
7066 (property value multi-method method user host)
7067 "Set the named property of a TRAMP connection."
7068 (tramp-maybe-open-connection multi-method method user host)
7069 (with-current-buffer (tramp-get-buffer multi-method method user host)
7070 (set (make-local-variable
7071 (intern (concat "tramp-connection-property-" property)))
7074 ;; Some predefined connection properties.
7075 (defun tramp-set-remote-encoding (multi-method method user host rem-enc)
7076 (tramp-set-connection-property "remote-encoding" rem-enc
7077 multi-method method user host))
7078 (defun tramp-get-remote-encoding (multi-method method user host)
7079 (tramp-get-connection-property "remote-encoding" nil
7080 multi-method method user host))
7082 (defun tramp-set-remote-decoding (multi-method method user host rem-dec)
7083 (tramp-set-connection-property "remote-decoding" rem-dec
7084 multi-method method user host))
7085 (defun tramp-get-remote-decoding (multi-method method user host)
7086 (tramp-get-connection-property "remote-decoding" nil
7087 multi-method method user host))
7089 (defun tramp-set-local-encoding (multi-method method user host loc-enc)
7090 (tramp-set-connection-property "local-encoding" loc-enc
7091 multi-method method user host))
7092 (defun tramp-get-local-encoding (multi-method method user host)
7093 (tramp-get-connection-property "local-encoding" nil
7094 multi-method method user host))
7096 (defun tramp-set-local-decoding (multi-method method user host loc-dec)
7097 (tramp-set-connection-property "local-decoding" loc-dec
7098 multi-method method user host))
7099 (defun tramp-get-local-decoding (multi-method method user host)
7100 (tramp-get-connection-property "local-decoding" nil
7101 multi-method method user host))
7103 (defun tramp-get-method-parameter (multi-method method user host param)
7104 "Return the method parameter PARAM.
7105 If the `tramp-methods' entry does not exist, use the variable PARAM
7107 (unless (boundp param)
7108 (error "Non-existing method parameter `%s'" param))
7109 (let ((entry (assoc param
7110 (assoc (tramp-find-method multi-method method user host)
7114 (symbol-value param))))
7117 ;; Auto saving to a special directory.
7119 (defun tramp-exists-file-name-handler (operation &rest args)
7120 (let ((buffer-file-name "/")
7121 (fnha file-name-handler-alist)
7122 (check-file-name-operation operation)
7123 (file-name-handler-alist
7126 '(lambda (operation &rest args)
7127 "Returns OPERATION if it is the one to be checked"
7128 (if (equal check-file-name-operation operation)
7130 (let ((file-name-handler-alist fnha))
7131 (apply operation args))))))))
7132 (eq (apply operation args) operation)))
7134 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
7135 (defadvice make-auto-save-file-name
7136 (around tramp-advice-make-auto-save-file-name () activate)
7137 "Invoke `tramp-handle-make-auto-save-file-name' for tramp files."
7138 (if (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))
7139 (setq ad-return-value (tramp-handle-make-auto-save-file-name))
7141 (add-hook 'tramp-unload-hook
7142 '(lambda () (ad-unadvise 'make-auto-save-file-name))))
7144 ;; In Emacs < 22 and XEmacs < 21.5 autosaved remote files have
7145 ;; permission 0666 minus umask. This is a security threat.
7147 (defun tramp-set-auto-save-file-modes ()
7148 "Set permissions of autosaved remote files to the original permissions."
7149 (let ((bfn (buffer-file-name)))
7150 (when (and (stringp bfn)
7151 (tramp-tramp-file-p bfn)
7152 (stringp buffer-auto-save-file-name)
7153 (not (equal bfn buffer-auto-save-file-name)))
7154 (unless (file-exists-p buffer-auto-save-file-name)
7155 (write-region "" nil buffer-auto-save-file-name))
7156 ;; Permissions should be set always, because there might be an old
7157 ;; auto-saved file belonging to another original file. This could
7158 ;; be a security threat.
7159 (set-file-modes buffer-auto-save-file-name
7160 (or (file-modes bfn) (tramp-octal-to-decimal "0600"))))))
7162 (unless (or (> emacs-major-version 21)
7163 (and (featurep 'xemacs)
7164 (= emacs-major-version 21)
7165 (> emacs-minor-version 4)))
7166 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
7167 (add-hook 'tramp-unload-hook
7169 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
7171 (defun tramp-subst-strs-in-string (alist string)
7172 "Replace all occurrences of the string FROM with TO in STRING.
7173 ALIST is of the form ((FROM . TO) ...)."
7176 (let* ((pr (car alist))
7179 (while (string-match (regexp-quote from) string)
7180 (setq string (replace-match to t t string)))
7181 (setq alist (cdr alist))))
7184 (defun tramp-insert-with-face (face string)
7185 "Insert text with a specific face."
7186 (let ((start (point)))
7188 (add-text-properties start (point) (list 'face face))))
7190 ;; ------------------------------------------------------------
7191 ;; -- Compatibility functions section --
7192 ;; ------------------------------------------------------------
7194 (defun tramp-temporary-file-directory ()
7195 "Return name of directory for temporary files (compat function).
7196 For Emacs, this is the variable `temporary-file-directory', for XEmacs
7197 this is the function `temp-directory'."
7198 (cond ((boundp 'temporary-file-directory)
7199 (symbol-value 'temporary-file-directory))
7200 ((fboundp 'temp-directory)
7201 (funcall (symbol-function 'temp-directory))) ;pacify byte-compiler
7202 ((let ((d (getenv "TEMP"))) (and d (file-directory-p d)))
7203 (file-name-as-directory (getenv "TEMP")))
7204 ((let ((d (getenv "TMP"))) (and d (file-directory-p d)))
7205 (file-name-as-directory (getenv "TMP")))
7206 ((let ((d (getenv "TMPDIR"))) (and d (file-directory-p d)))
7207 (file-name-as-directory (getenv "TMPDIR")))
7208 ((file-exists-p "c:/temp") (file-name-as-directory "c:/temp"))
7209 (t (message (concat "Neither `temporary-file-directory' nor "
7210 "`temp-directory' is defined -- using /tmp."))
7211 (file-name-as-directory "/tmp"))))
7213 (defun tramp-read-passwd (user host prompt)
7214 "Read a password from user (compat function).
7215 Invokes `password-read' if available, `read-passwd' else."
7216 (if (functionp 'password-read)
7217 (let* ((key (concat (or user (user-login-name)) "@" host))
7218 (password (apply #'password-read (list prompt key))))
7219 (apply #'password-cache-add (list key password))
7221 (read-passwd prompt)))
7223 (defun tramp-clear-passwd (&optional user host)
7224 "Clear password cache for connection related to current-buffer."
7226 (let ((filename (or buffer-file-name list-buffers-directory "")))
7227 (when (and (functionp 'password-cache-remove)
7228 (or (and user host) (tramp-tramp-file-p filename)))
7229 (let* ((v (when (tramp-tramp-file-p filename)
7230 (tramp-dissect-file-name filename)))
7231 (luser (or user (tramp-file-name-user v) (user-login-name)))
7232 (lhost (or host (tramp-file-name-host v) (system-name)))
7233 (key (concat luser "@" lhost)))
7234 (apply #'password-cache-remove (list key))))))
7236 (defun tramp-time-diff (t1 t2)
7237 "Return the difference between the two times, in seconds.
7238 T1 and T2 are time values (as returned by `current-time' for example).
7240 NOTE: This function will fail if the time difference is too large to
7242 ;; Pacify byte-compiler with `symbol-function'.
7243 (cond ((and (fboundp 'subtract-time)
7244 (fboundp 'float-time))
7245 (funcall (symbol-function 'float-time)
7246 (funcall (symbol-function 'subtract-time) t1 t2)))
7247 ((and (fboundp 'subtract-time)
7248 (fboundp 'time-to-seconds))
7249 (funcall (symbol-function 'time-to-seconds)
7250 (funcall (symbol-function 'subtract-time) t1 t2)))
7251 ((fboundp 'itimer-time-difference)
7253 (symbol-function 'itimer-time-difference)
7254 (if (< (length t1) 3) (append t1 '(0)) t1)
7255 (if (< (length t2) 3) (append t2 '(0)) t2))))
7257 ;; snarfed from Emacs 21 time-date.el; combining
7258 ;; time-to-seconds and subtract-time
7259 (let ((time (let ((borrow (< (cadr t1) (cadr t2))))
7260 (list (- (car t1) (car t2) (if borrow 1 0))
7261 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2))))))
7262 (+ (* (car time) 65536.0)
7264 (/ (or (nth 2 time) 0) 1000000.0))))))
7266 (defun tramp-coding-system-change-eol-conversion (coding-system eol-type)
7267 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
7268 EOL-TYPE can be one of `dos', `unix', or `mac'."
7269 (cond ((fboundp 'coding-system-change-eol-conversion)
7270 (apply #'coding-system-change-eol-conversion
7271 (list coding-system eol-type)))
7272 ((fboundp 'subsidiary-coding-system)
7274 #'subsidiary-coding-system
7276 (cond ((eq eol-type 'dos) 'crlf)
7277 ((eq eol-type 'unix) 'lf)
7278 ((eq eol-type 'mac) 'cr)
7280 (error "Unknown EOL-TYPE `%s', must be %s"
7282 "`dos', `unix', or `mac'"))))))
7283 (t (error "Can't change EOL conversion -- is MULE missing?"))))
7285 (defun tramp-split-string (string pattern)
7286 "Like `split-string' but omit empty strings.
7287 In Emacs, (split-string \"/foo/bar\" \"/\") returns (\"foo\" \"bar\").
7288 This is, the first, empty, element is omitted. In XEmacs, the first
7289 element is not omitted.
7291 Note: this function has been written for `tramp-handle-file-truename'.
7292 If you want to use it for something else, you'll have to check whether
7293 it does the right thing."
7294 (delete "" (split-string string pattern)))
7296 (defun tramp-set-process-query-on-exit-flag (process flag)
7297 "Specify if query is needed for process when Emacs is exited.
7298 If the second argument flag is non-nil, Emacs will query the user before
7299 exiting if process is running."
7301 (if (fboundp 'set-process-query-on-exit-flag)
7302 (symbol-function 'set-process-query-on-exit-flag)
7303 (symbol-function 'process-kill-without-query))
7307 ;; ------------------------------------------------------------
7308 ;; -- Kludges section --
7309 ;; ------------------------------------------------------------
7311 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
7312 ;; does not deal well with newline characters. Newline is replaced by
7313 ;; backslash newline. But if, say, the string `a backslash newline b'
7314 ;; is passed to a shell, the shell will expand this into "ab",
7315 ;; completely omitting the newline. This is not what was intended.
7316 ;; It does not appear to be possible to make the function
7317 ;; `shell-quote-argument' work with newlines without making it
7318 ;; dependent on the shell used. But within this package, we know that
7319 ;; we will always use a Bourne-like shell, so we use an approach which
7322 ;; The approach is simple: we call `shell-quote-argument', then
7323 ;; massage the newline part of the result.
7325 ;; This function should produce a string which is grokked by a Unix
7326 ;; shell, even if the Emacs is running on Windows. Since this is the
7327 ;; kludges section, we bind `system-type' in such a way that
7328 ;; `shell-quote-arguments' behaves as if on Unix.
7330 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
7331 ;; function to work with Bourne-like shells.
7333 ;; CCC: This function should be rewritten so that
7334 ;; `shell-quote-argument' is not used. This way, we are safe from
7335 ;; changes in `shell-quote-argument'.
7336 (defun tramp-shell-quote-argument (s)
7337 "Similar to `shell-quote-argument', but groks newlines.
7338 Only works for Bourne-like shells."
7339 (let ((system-type 'not-windows))
7341 (let ((result (shell-quote-argument s))
7342 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
7343 (when (and (>= (length result) 2)
7344 (string= (substring result 0 2) "\\~"))
7345 (setq result (substring result 1)))
7346 (while (string-match nl result)
7347 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
7351 ;; ;; EFS hooks itself into the file name handling stuff in more places
7352 ;; ;; than just `file-name-handler-alist'. The following tells EFS to stay
7353 ;; ;; away from tramp.el file names.
7355 ;; ;; This is needed because EFS installs (efs-dired-before-readin) into
7356 ;; ;; 'dired-before-readin-hook'. This prevents EFS from opening an FTP
7357 ;; ;; connection to help it's dired process. Not that I have any real
7358 ;; ;; idea *why* this is helpful to dired.
7360 ;; ;; Anyway, this advice fixes the problem (with a sledgehammer :)
7362 ;; ;; Daniel Pittman <daniel@danann.net>
7364 ;; ;; CCC: when the other defadvice calls have disappeared, make sure
7365 ;; ;; not to call defadvice unless it's necessary. How do we find out whether
7366 ;; ;; it is necessary? (featurep 'efs) is surely the wrong way --
7367 ;; ;; EFS might nicht be loaded yet.
7368 ;; (defadvice efs-ftp-path (around dont-match-tramp-localname activate protect)
7369 ;; "Cause efs-ftp-path to fail when the path is a TRAMP localname."
7370 ;; (if (tramp-tramp-file-p (ad-get-arg 0))
7374 ;; We currently (sometimes) use "[" and "]" in the filename format.
7375 ;; This means that Emacs wants to expand wildcards if
7376 ;; `find-file-wildcards' is non-nil, and then barfs because no
7377 ;; expansion could be found. We detect this situation and do
7378 ;; something really awful: we have `file-expand-wildcards' return the
7379 ;; original filename if it can't expand anything. Let's just hope
7380 ;; that this doesn't break anything else.
7381 ;; CCC: This check is now also really awful; we should search all
7382 ;; of the filename format, not just the prefix.
7383 (when (string-match "\\[" tramp-prefix-format)
7384 (defadvice file-expand-wildcards (around tramp-fix activate)
7385 (let ((name (ad-get-arg 0)))
7386 (if (tramp-tramp-file-p name)
7387 ;; If it's a Tramp file, dissect it and look if wildcards
7388 ;; need to be expanded at all.
7389 (let ((v (tramp-dissect-file-name name)))
7390 (if (string-match "[[*?]" (tramp-file-name-localname v))
7391 (let ((res ad-do-it))
7392 (setq ad-return-value (or res (list name))))
7393 (setq ad-return-value (list name))))
7394 ;; If it is not a Tramp file, just run the original function.
7395 (let ((res ad-do-it))
7396 (setq ad-return-value (or res (list name)))))))
7397 (add-hook 'tramp-unload-hook
7398 '(lambda () (ad-unadvise 'file-expand-wildcards))))
7400 ;; Tramp version is useful in a number of situations.
7402 (defun tramp-version (arg)
7403 "Print version number of tramp.el in minibuffer or current buffer."
7405 (if arg (insert tramp-version) (message tramp-version)))
7407 ;; Make the `reporter` functionality available for making bug reports about
7408 ;; the package. A most useful piece of code.
7410 (unless (fboundp 'reporter-submit-bug-report)
7411 (autoload 'reporter-submit-bug-report "reporter"))
7414 "Submit a bug report to the TRAMP developers."
7418 (let ((reporter-prompt-for-summary-p t))
7419 (reporter-submit-bug-report
7420 tramp-bug-report-address ; to-address
7421 (format "tramp (%s)" tramp-version) ; package name and version
7426 tramp-file-exists-command
7427 tramp-current-multi-method
7428 tramp-current-method
7433 tramp-auto-save-directory ; vars to dump
7434 tramp-default-method
7435 tramp-rsh-end-of-line
7436 tramp-default-password-end-of-line
7438 tramp-login-prompt-regexp
7439 ;; Mask non-7bit characters
7440 (tramp-password-prompt-regexp . tramp-reporter-dump-variable)
7441 tramp-wrong-passwd-regexp
7442 tramp-yesno-prompt-regexp
7443 tramp-yn-prompt-regexp
7444 tramp-terminal-prompt-regexp
7445 tramp-temp-name-prefix
7446 tramp-file-name-structure
7447 tramp-file-name-regexp
7448 tramp-multi-file-name-structure
7449 tramp-multi-file-name-hop-structure
7451 tramp-multi-connection-function-alist
7454 tramp-coding-commands
7455 tramp-actions-before-shell
7456 tramp-actions-copy-out-of-band
7459 ;; Mask non-7bit characters
7460 (tramp-shell-prompt-pattern . tramp-reporter-dump-variable)
7462 ,(when (boundp 'tramp-backup-directory-alist)
7463 'tramp-backup-directory-alist)
7464 ,(when (boundp 'tramp-bkup-backup-directory-info)
7465 'tramp-bkup-backup-directory-info)
7467 ;; Non-tramp variables of interest
7468 ;; Mask non-7bit characters
7469 (shell-prompt-pattern . tramp-reporter-dump-variable)
7471 backup-by-copying-when-linked
7472 backup-by-copying-when-mismatch
7473 ,(when (boundp 'backup-by-copying-when-privileged-mismatch)
7474 'backup-by-copying-when-privileged-mismatch)
7475 ,(when (boundp 'password-cache)
7477 ,(when (boundp 'password-cache-expiry)
7478 'password-cache-expiry)
7479 ,(when (boundp 'backup-directory-alist)
7480 'backup-directory-alist)
7481 ,(when (boundp 'bkup-backup-directory-info)
7482 'bkup-backup-directory-info)
7483 file-name-handler-alist))
7485 'tramp-load-report-modules ; pre-hook
7486 'tramp-append-tramp-buffers ; post-hook
7488 Enter your bug report in this message, including as much detail as you
7489 possibly can about the problem, what you did to cause it and what the
7490 local and remote machines are.
7492 If you can give a simple set of instructions to make this bug happen
7493 reliably, please include those. Thank you for helping kill bugs in
7496 Another useful thing to do is to put (setq tramp-debug-buffer t) in
7497 the ~/.emacs file and to repeat the bug. Then, include the contents
7498 of the *tramp/foo* buffer and the *debug tramp/foo* buffer in your bug
7501 --bug report follows this line--
7504 (defun tramp-reporter-dump-variable (varsym mailbuf)
7505 "Pretty-print the value of the variable in symbol VARSYM.
7506 Used for non-7bit chars in strings."
7507 (let* ((reporter-eval-buffer (symbol-value 'reporter-eval-buffer))
7508 (val (with-current-buffer reporter-eval-buffer
7509 (symbol-value varsym))))
7511 ;; There are characters to be masked.
7512 (when (and (boundp 'mm-7bit-chars)
7514 (concat "[^" (symbol-value 'mm-7bit-chars) "]") val))
7515 (with-current-buffer reporter-eval-buffer
7516 (set varsym (concat "(base64-decode-string \""
7517 (base64-encode-string val)
7521 (funcall (symbol-function 'reporter-dump-variable) varsym mailbuf)
7523 ;; Remove string quotation.
7526 (concat "\\(^.*\\)" "\"" ;; \1 "
7527 "\\((base64-decode-string \\)" "\\\\" ;; \2 \
7528 "\\(\".*\\)" "\\\\" ;; \3 \
7529 "\\(\")\\)" "\"$")) ;; \4 "
7530 (replace-match "\\1\\2\\3\\4")
7532 (insert " ;; variable encoded due to non-printable characters\n"))
7535 ;; Reset VARSYM to old value.
7536 (with-current-buffer reporter-eval-buffer
7539 (defun tramp-load-report-modules ()
7540 "Load needed modules for reporting."
7542 ;; We load message.el and mml.el from Gnus.
7543 (if (featurep 'xemacs)
7545 (load "message" 'noerror)
7546 (load "mml" 'noerror))
7547 (require 'message nil 'noerror)
7548 (require 'mml nil 'noerror))
7549 (when (functionp 'message-mode)
7550 (funcall (symbol-function 'message-mode)))
7551 (when (functionp 'mml-mode)
7552 (funcall (symbol-function 'mml-mode) t)))
7554 (defun tramp-append-tramp-buffers ()
7555 "Append Tramp buffers into the bug report."
7558 (eq major-mode 'message-mode)
7560 (symbol-value 'mml-mode))
7562 (let* ((tramp-buf-regexp "\\*\\(debug \\)?tramp/")
7565 (mapcar '(lambda (b)
7566 (when (string-match tramp-buf-regexp (buffer-name b)) b))
7568 (curbuf (current-buffer)))
7570 ;; There is at least one Tramp buffer.
7572 (switch-to-buffer (list-buffers-noselect nil))
7573 (delete-other-windows)
7574 (setq buffer-read-only nil)
7575 (goto-char (point-min))
7577 (if (re-search-forward tramp-buf-regexp (tramp-point-at-eol) t)
7580 (let ((start (point)))
7582 (kill-region start (point)))))
7584 The buffer(s) above will be appended to this message. If you don't want
7585 to append a buffer because it contains sensible data, or because the buffer
7586 is too large, you should delete the respective buffer. The buffer(s) will
7587 contain user and host names. Passwords will never be included there.")
7589 (when (and tramp-debug-buffer (> tramp-verbose 9))
7591 (let ((start (point)))
7593 Please note that you have set `tramp-verbose' to a value greater than 9.
7594 Therefore, the contents of files might be included in the debug buffer(s).")
7595 (add-text-properties start (point) (list 'face 'italic))))
7597 (set-buffer-modified-p nil)
7598 (setq buffer-read-only t)
7599 (goto-char (point-min))
7601 (if (y-or-n-p "Do you want to append the buffer(s)? ")
7602 ;; OK, let's send. First we delete the buffer list.
7605 (switch-to-buffer curbuf)
7606 (goto-char (point-max))
7608 (dolist (buffer buffer-list)
7609 (funcall (symbol-function 'mml-insert-empty-tag)
7610 'part 'type "text/plain" 'encoding "base64"
7611 'disposition "attachment" 'buffer (buffer-name buffer)
7612 'description (buffer-name buffer)))
7613 (set-buffer-modified-p nil))
7615 ;; Don't send. Delete the message buffer.
7617 (set-buffer-modified-p nil)
7619 (throw 'dont-send nil))))))
7621 (defalias 'tramp-submit-bug 'tramp-bug)
7623 ;; Checklist for `tramp-unload-hook'
7624 ;; - Unload all `tramp-*' packages
7625 ;; - Reset `file-name-handler-alist'
7626 ;; - Cleanup hooks where Tramp functions are in
7627 ;; - Cleanup advised functions
7628 ;; - Cleanup autoloads
7630 (defun tramp-unload-tramp ()
7632 ;; When Tramp is not loaded yet, its autoloads are still active.
7633 (tramp-unload-file-name-handler-alist)
7634 ;; ange-ftp settings must be enabled.
7635 (when (functionp 'tramp-ftp-enable-ange-ftp)
7636 (funcall (symbol-function 'tramp-ftp-enable-ange-ftp)))
7637 ;; `tramp-util' unloads also `tramp'.
7638 (condition-case nil ;; maybe its not loaded yet.
7639 (unload-feature (if (featurep 'tramp-util) 'tramp-util 'tramp) 'force)
7644 ;; Make sure that we get integration with the VC package.
7645 ;; When it is loaded, we need to pull in the integration module.
7646 ;; This must come after (provide 'tramp) because tramp-vc.el
7648 (eval-after-load "vc"
7651 (add-hook 'tramp-unload-hook
7653 (when (featurep 'tramp-vc)
7654 (unload-feature 'tramp-vc 'force))))))
7658 ;; * Allow putting passwords in the filename.
7659 ;; This should be implemented via a general mechanism to add
7660 ;; parameters in filenames. There is currently a kludge for
7661 ;; putting the port number into the filename for ssh and ftp
7662 ;; files. This could be subsumed by the new mechanism as well.
7663 ;; Another approach is to read a netrc file like ~/.authinfo
7665 ;; * Handle nonlocal exits such as C-g.
7666 ;; * Autodetect if remote `ls' groks the "--dired" switch.
7667 ;; * Add fallback for inline encodings. This should be used
7668 ;; if the remote end doesn't support mimencode or a similar program.
7669 ;; For reading files from the remote host, we can just parse the output
7670 ;; of `od -b'. For writing files to the remote host, we construct
7671 ;; a shell program which contains only "safe" ascii characters
7672 ;; and which writes the right bytes to the file. We can use printf(1)
7673 ;; or "echo -e" or the printf function in awk and use octal escapes
7674 ;; for the "dangerous" characters. The null byte might be a problem.
7675 ;; On some systems, the octal escape doesn't work. So we try the following
7676 ;; two commands to write a null byte:
7677 ;; dd if=/dev/zero bs=1 count=1
7678 ;; echo | tr '\n' '\000'
7679 ;; * Separate local `tramp-coding-commands' from remote ones. Connect
7680 ;; the two via a format which can be `uu' or `b64'. Then we can search
7681 ;; for the right local commands and the right remote commands separately.
7682 ;; * Cooperate with PCL-CVS. It uses start-process, which doesn't
7683 ;; work for remote files.
7684 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
7685 ;; `shell-quote-argument'.
7686 ;; * Completion gets confused when you leave out the method name.
7687 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
7688 ;; by the files in that directory. Add this here.
7689 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
7690 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
7691 ;; * When logging in, keep looking for questions according to an alist
7692 ;; and then invoke the right function.
7693 ;; * Case-insensitive filename completion. (Norbert Goevert.)
7694 ;; * Running CVS remotely doesn't appear to work right. It thinks
7695 ;; files are locked by somebody else even if I'm the locking user.
7696 ;; Sometimes, one gets `No CVSROOT specified' errors from CVS.
7698 ;; * Don't use globbing for directories with many files, as this is
7699 ;; likely to produce long command lines, and some shells choke on
7700 ;; long command lines.
7701 ;; * Find out about the new auto-save mechanism in Emacs 21 and
7702 ;; do the right thing.
7703 ;; * `vc-directory' does not work. It never displays any files, even
7704 ;; if it does show files when run locally.
7705 ;; * Allow correction of passwords, if the remote end allows this.
7706 ;; (Mark Hershberger)
7707 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
7708 ;; * Do asynchronous `shell-command's.
7709 ;; * Grok `append' parameter for `write-region'.
7710 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
7711 ;; * abbreviate-file-name
7712 ;; * grok ~ in tramp-remote-path (Henrik Holm <henrikh@tele.ntnu.no>)
7713 ;; * Also allow to omit user names when doing multi-hop. Not sure yet
7714 ;; what the user names should default to, though.
7715 ;; * better error checking. At least whenever we see something
7716 ;; strange when doing zerop, we should kill the process and start
7717 ;; again. (Greg Stark)
7718 ;; * Add caching for filename completion. (Greg Stark)
7719 ;; Of course, this has issues with usability (stale cache bites)
7720 ;; -- <daniel@danann.net>
7721 ;; * Provide a local cache of old versions of remote files for the rsync
7722 ;; transfer method to use. (Greg Stark)
7723 ;; * Remove unneeded parameters from methods.
7724 ;; * Invoke rsync once for copying a whole directory hierarchy.
7725 ;; (Francesco Potort
\e,Al
\e(B)
7726 ;; * Should we set PATH ourselves or should we rely on the remote end
7728 ;; * Make it work for XEmacs 20, which is missing `with-timeout'.
7729 ;; * Make it work for different encodings, and for different file name
7730 ;; encodings, too. (Daniel Pittman)
7731 ;; * Change applicable functions to pass a struct tramp-file-name rather
7732 ;; than the individual items MULTI-METHOD, METHOD, USER, HOST, LOCALNAME.
7733 ;; * Implement asynchronous shell commands.
7734 ;; * Clean up unused *tramp/foo* buffers after a while. (Pete Forman)
7735 ;; * Progress reports while copying files. (Michael Kifer)
7736 ;; * `Smart' connection method that uses inline for small and out of
7737 ;; band for large files. (Michael Kifer)
7738 ;; * Don't search for perl5 and perl. Instead, only search for perl and
7739 ;; then look if it's the right version (with `perl -v').
7740 ;; * When editing a remote CVS controlled file as a different user, VC
7741 ;; gets confused about the file locking status. Try to find out why
7742 ;; the workaround doesn't work.
7743 ;; * Change `copy-file' to grok the case where the filename handler
7744 ;; for the source and the target file are different. Right now,
7745 ;; it looks at the source file and then calls that handler, if
7746 ;; there is one. But since ange-ftp, for instance, does not know
7747 ;; about Tramp, it does not do the right thing if the target file
7748 ;; name is a Tramp name.
7749 ;; * Username and hostname completion.
7750 ;; ** If `partial-completion-mode' isn't loaded, "/foo:bla" tries to
7751 ;; connect to host "blabla" already if that host is unique. No idea
7752 ;; how to suppress. Maybe not an essential problem.
7753 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode'.
7754 ;; ** Extend `tramp-get-completion-su' for NIS and shadow passwords.
7755 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
7756 ;; Code is nearly identical.
7757 ;; ** Decide whiche files to take for searching user/host names depending on
7758 ;; operating system (windows-nt) in `tramp-completion-function-alist'.
7759 ;; ** Enhance variables for debug.
7760 ;; ** Implement "/multi:" completion.
7761 ;; ** Add a learning mode for completion. Make results persistent.
7762 ;; * Allow out-of-band methods as _last_ multi-hop.
7764 ;; Functions for file-name-handler-alist:
7765 ;; diff-latest-backup-file -- in diff.el
7766 ;; dired-uncache -- this will be needed when we do insert-directory caching
7767 ;; file-name-as-directory -- use primitive?
7768 ;; file-name-sans-versions -- use primitive?
7769 ;; get-file-buffer -- use primitive
7772 ;;; arch-tag: 3a21a994-182b-48fa-b0cd-c1d9fede424a
7773 ;;; tramp.el ends here