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, 2007, 2008 Free Software Foundation, Inc.
7 ;; (copyright statements below in code to be updated with the above notice)
9 ;; Author: Kai Gro
\e,A_
\e(Bjohann <kai.grossjohann@gmx.net>
10 ;; Michael Albinus <michael.albinus@gmx.de>
11 ;; Keywords: comm, processes
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 3, or (at your option)
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
28 ;; Boston, MA 02110-1301, USA.
32 ;; This package provides remote file editing, similar to ange-ftp.
33 ;; The difference is that ange-ftp uses FTP to transfer files between
34 ;; the local and the remote host, whereas tramp.el uses a combination
35 ;; of rsh and rcp or other work-alike programs, such as ssh/scp.
37 ;; For more detailed instructions, please see the info file.
42 ;; This package only works for Emacs 20 and higher, and for XEmacs 21
43 ;; and higher. (XEmacs 20 is missing the `with-timeout' macro. Emacs
44 ;; 19 is reported to have other problems. For XEmacs 21, you need the
45 ;; package `fsf-compat' for the `with-timeout' macro.)
47 ;; This version might not work with pre-Emacs 21 VC unless VC is
48 ;; loaded before tramp.el. Could you please test this and tell me about
49 ;; the result? Thanks.
51 ;; Also see the todo list at the bottom of this file.
53 ;; The current version of Tramp can be retrieved from the following URL:
54 ;; http://ftp.gnu.org/gnu/tramp/
56 ;; There's a mailing list for this, as well. Its name is:
57 ;; tramp-devel@gnu.org
58 ;; You can use the Web to subscribe, under the following URL:
59 ;; http://lists.gnu.org/mailman/listinfo/tramp-devel
61 ;; For the adventurous, the current development sources are available
62 ;; via CVS. You can find instructions about this at the following URL:
63 ;; http://savannah.gnu.org/projects/tramp/
64 ;; Click on "CVS" in the navigation bar near the top.
66 ;; Don't forget to put on your asbestos longjohns, first!
70 ;; The Tramp version number and bug report address, as prepared by configure.
72 (add-hook 'tramp-unload-hook
74 (when (featurep 'trampver)
75 (unload-feature 'trampver 'force))))
77 (if (featurep 'xemacs)
78 (require 'timer-funcs)
81 (require 'format-spec) ;from Gnus 5.8, also in tar ball
82 ;; As long as password.el is not part of (X)Emacs, it shouldn't
84 (if (featurep 'xemacs)
85 (load "password" 'noerror)
86 (require 'password nil 'noerror)) ;from No Gnus, also in tar ball
88 ;; The explicit check is not necessary in Emacs, which provides the
89 ;; feature even if implemented in C, but it appears to be necessary
91 (unless (and (fboundp 'base64-encode-region)
92 (fboundp 'base64-decode-region))
93 (require 'base64)) ;for the mimencode methods
97 ;; `copy-tree' is part of subr.el since Emacs 22.
99 (unless (functionp 'copy-tree)
102 (autoload 'tramp-uuencode-region "tramp-uu"
103 "Implementation of `uuencode' in Lisp.")
104 (add-hook 'tramp-unload-hook
106 (when (featurep 'tramp-uu)
107 (unload-feature 'tramp-uu 'force))))
109 (unless (fboundp 'uudecode-decode-region)
110 (autoload 'uudecode-decode-region "uudecode"))
112 ;; XEmacs is distributed with few Lisp packages. Further packages are
113 ;; installed using EFS. If we use a unified filename format, then
114 ;; Tramp is required in addition to EFS. (But why can't Tramp just
115 ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS
116 ;; just like before.) Another reason for using a separate filename
117 ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
118 ;; Tramp only knows how to deal with `file-name-handler-alist', not
121 (defvar tramp-unified-filenames (not (featurep 'xemacs))
122 "Non-nil means to use unified Ange-FTP/Tramp filename syntax.
123 Otherwise, use a separate filename syntax for Tramp.")
125 ;; Load foreign methods. Because they do require Tramp internally, this
126 ;; must be done with the `eval-after-load' trick.
128 ;; tramp-ftp supports Ange-FTP only. Not suited for XEmacs therefore.
129 (unless (featurep 'xemacs)
130 (eval-after-load "tramp"
133 (add-hook 'tramp-unload-hook
135 (when (featurep 'tramp-ftp)
136 (unload-feature 'tramp-ftp 'force)))))))
137 (when (and tramp-unified-filenames (featurep 'xemacs))
138 (eval-after-load "tramp"
141 (add-hook 'tramp-unload-hook
143 (when (featurep 'tramp-efs)
144 (unload-feature 'tramp-efs 'force)))))))
146 ;; tramp-smb uses "smbclient" from Samba.
147 ;; Not available under Cygwin and Windows, because they don't offer
148 ;; "smbclient". And even not necessary there, because Emacs supports
149 ;; UNC file names like "//host/share/localname".
150 (unless (memq system-type '(cygwin windows-nt))
151 (eval-after-load "tramp"
154 (add-hook 'tramp-unload-hook
156 (when (featurep 'tramp-smb)
157 (unload-feature 'tramp-smb 'force)))))))
161 (unless (boundp 'custom-print-functions)
162 (defvar custom-print-functions nil)) ; not autoloaded before Emacs 20.4
164 ;; Avoid byte-compiler warnings if the byte-compiler supports this.
165 ;; Currently, XEmacs supports this.
167 (when (featurep 'xemacs)
168 (let (unused-vars) ; Pacify Emacs byte-compiler
169 (defalias 'warnings 'identity) ; Pacify Emacs byte-compiler
170 (byte-compiler-options (warnings (- unused-vars))))))
172 ;; `directory-sep-char' is an obsolete variable in Emacs. But it is
173 ;; used in XEmacs, so we set it here and there. The following is needed
174 ;; to pacify Emacs byte-compiler.
176 (when (boundp 'byte-compile-not-obsolete-var)
177 (setq byte-compile-not-obsolete-var 'directory-sep-char)))
179 ;; `set-buffer-multibyte' comes from Emacs Leim.
181 (unless (fboundp 'set-buffer-multibyte)
182 (defalias 'set-buffer-multibyte 'ignore)))
184 ;;; User Customizable Internal Variables:
187 "Edit remote files with a combination of rsh and rcp or similar programs."
191 (defcustom tramp-verbose 9
192 "*Verbosity level for tramp.el. 0 means be silent, 10 is most verbose."
196 (defcustom tramp-debug-buffer nil
197 "*Whether to send all commands and responses to a debug buffer."
203 (when (boundp 'backup-directory-alist)
204 (defcustom tramp-backup-directory-alist nil
205 "Alist of filename patterns and backup directory names.
206 Each element looks like (REGEXP . DIRECTORY), with the same meaning like
207 in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY
208 is a local file name, the backup directory is prepended with Tramp file
209 name prefix \(multi-method, method, user, host\) of file.
211 \(setq tramp-backup-directory-alist backup-directory-alist\)
213 gives the same backup policy for Tramp files on their hosts like the
214 policy for local files."
216 :type '(repeat (cons (regexp :tag "Regexp matching filename")
217 (directory :tag "Backup directory name"))))))
219 ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because
220 ;; the package "backup-dir" might not be loaded yet.
222 (when (featurep 'xemacs)
223 (defcustom tramp-bkup-backup-directory-info nil
224 "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
225 It has the same meaning like `bkup-backup-directory-info' from package
226 `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local
227 file name, the backup directory is prepended with Tramp file name prefix
228 \(multi-method, method, user, host\) of file.
230 \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\)
232 gives the same backup policy for Tramp files on their hosts like the
233 policy for local files."
235 (list (regexp :tag "File regexp")
236 (string :tag "Backup Dir")
241 (const search-upward))))
244 (defcustom tramp-auto-save-directory nil
245 "*Put auto-save files in this directory, if set.
246 The idea is to use a local directory so that auto-saving is faster."
248 :type '(choice (const nil)
251 (defcustom tramp-encoding-shell
252 (if (memq system-type '(windows-nt))
255 "*Use this program for encoding and decoding commands on the local host.
256 This shell is used to execute the encoding and decoding command on the
257 local host, so if you want to use `~' in those commands, you should
258 choose a shell here which groks tilde expansion. `/bin/sh' normally
259 does not understand tilde expansion.
261 For encoding and deocding, commands like the following are executed:
263 /bin/sh -c COMMAND < INPUT > OUTPUT
265 This variable can be used to change the \"/bin/sh\" part. See the
266 variable `tramp-encoding-command-switch' for the \"-c\" part. Also, see the
267 variable `tramp-encoding-reads-stdin' to specify whether the commands read
268 standard input or a file.
270 Note that this variable is not used for remote commands. There are
271 mechanisms in tramp.el which automatically determine the right shell to
272 use for the remote host."
274 :type '(file :must-match t))
276 (defcustom tramp-encoding-command-switch
277 (if (string-match "cmd\\.exe" tramp-encoding-shell)
280 "*Use this switch together with `tramp-encoding-shell' for local commands.
281 See the variable `tramp-encoding-shell' for more information."
285 (defcustom tramp-encoding-reads-stdin t
286 "*If non-nil, encoding commands read from standard input.
287 If nil, the filename is the last argument.
289 Note that the commands always must write to standard output."
293 (defcustom tramp-multi-sh-program
295 "*Use this program for bootstrapping multi-hop connections.
296 This variable is similar to `tramp-encoding-shell', but it is only used
297 when initializing a multi-hop connection. Therefore, the set of
298 commands sent to this shell is quite restricted, and if you are
299 careful it works to use CMD.EXE under Windows (instead of a Bourne-ish
300 shell which does not normally exist on Windows anyway).
302 To use multi-hop methods from Windows, you also need suitable entries
303 in `tramp-multi-connection-function-alist' for the first hop.
305 This variable defaults to the value of `tramp-encoding-shell'."
307 :type '(file :must-match t))
309 ;; CCC I have changed all occurrences of comint-quote-filename with
310 ;; tramp-shell-quote-argument, except in tramp-handle-expand-many-files.
311 ;; There, comint-quote-filename was removed altogether. If it turns
312 ;; out to be necessary there, something will need to be done.
313 ;;-(defcustom tramp-file-name-quote-list
314 ;;- '(?] ?[ ?\| ?& ?< ?> ?\( ?\) ?\; ?\ ?\* ?\? ?\! ?\" ?\' ?\` ?# ?\@ ?\+ )
315 ;;- "*Protect these characters from the remote shell.
316 ;;-Any character in this list is quoted (preceded with a backslash)
317 ;;-because it means something special to the shell. This takes effect
318 ;;-when sending file and directory names to the remote shell.
320 ;;-See `comint-file-name-quote-list' for details."
322 ;;- :type '(repeat character))
324 (defcustom tramp-methods
325 '( ("rcp" (tramp-connection-function tramp-open-connection-rsh)
326 (tramp-login-program "rsh")
327 (tramp-copy-program "rcp")
328 (tramp-remote-sh "/bin/sh")
329 (tramp-login-args nil)
330 (tramp-copy-args nil)
331 (tramp-copy-keep-date-arg "-p")
332 (tramp-password-end-of-line nil))
333 ("scp" (tramp-connection-function tramp-open-connection-rsh)
334 (tramp-login-program "ssh")
335 (tramp-copy-program "scp")
336 (tramp-remote-sh "/bin/sh")
337 (tramp-login-args ("-e" "none"))
338 (tramp-copy-args nil)
339 (tramp-copy-keep-date-arg "-p")
340 (tramp-password-end-of-line nil))
341 ("scp1" (tramp-connection-function tramp-open-connection-rsh)
342 (tramp-login-program "ssh")
343 (tramp-copy-program "scp")
344 (tramp-remote-sh "/bin/sh")
345 (tramp-login-args ("-1" "-e" "none"))
346 (tramp-copy-args ("-1"))
347 (tramp-copy-keep-date-arg "-p")
348 (tramp-password-end-of-line nil))
349 ("scp2" (tramp-connection-function tramp-open-connection-rsh)
350 (tramp-login-program "ssh")
351 (tramp-copy-program "scp")
352 (tramp-remote-sh "/bin/sh")
353 (tramp-login-args ("-2" "-e" "none"))
354 (tramp-copy-args ("-2"))
355 (tramp-copy-keep-date-arg "-p")
356 (tramp-password-end-of-line nil))
358 (tramp-connection-function tramp-open-connection-rsh)
359 (tramp-login-program "ssh1")
360 (tramp-copy-program "scp1")
361 (tramp-remote-sh "/bin/sh")
362 (tramp-login-args ("-e" "none"))
363 (tramp-copy-args nil)
364 (tramp-copy-keep-date-arg "-p")
365 (tramp-password-end-of-line nil))
367 (tramp-connection-function tramp-open-connection-rsh)
368 (tramp-login-program "ssh2")
369 (tramp-copy-program "scp2")
370 (tramp-remote-sh "/bin/sh")
371 (tramp-login-args ("-e" "none"))
372 (tramp-copy-args nil)
373 (tramp-copy-keep-date-arg "-p")
374 (tramp-password-end-of-line nil))
375 ("rsync" (tramp-connection-function tramp-open-connection-rsh)
376 (tramp-login-program "ssh")
377 (tramp-copy-program "rsync")
378 (tramp-remote-sh "/bin/sh")
379 (tramp-login-args ("-e" "none"))
380 (tramp-copy-args ("-e" "ssh"))
381 (tramp-copy-keep-date-arg "-t")
382 (tramp-password-end-of-line nil))
383 ("remcp" (tramp-connection-function tramp-open-connection-rsh)
384 (tramp-login-program "remsh")
385 (tramp-copy-program "rcp")
386 (tramp-remote-sh "/bin/sh")
387 (tramp-login-args nil)
388 (tramp-copy-args nil)
389 (tramp-copy-keep-date-arg "-p")
390 (tramp-password-end-of-line nil))
391 ("rsh" (tramp-connection-function tramp-open-connection-rsh)
392 (tramp-login-program "rsh")
393 (tramp-copy-program nil)
394 (tramp-remote-sh "/bin/sh")
395 (tramp-login-args nil)
396 (tramp-copy-args nil)
397 (tramp-copy-keep-date-arg nil)
398 (tramp-password-end-of-line nil))
399 ("ssh" (tramp-connection-function tramp-open-connection-rsh)
400 (tramp-login-program "ssh")
401 (tramp-copy-program nil)
402 (tramp-remote-sh "/bin/sh")
403 (tramp-login-args ("-e" "none"))
404 (tramp-copy-args nil)
405 (tramp-copy-keep-date-arg nil)
406 (tramp-password-end-of-line nil))
407 ("ssh1" (tramp-connection-function tramp-open-connection-rsh)
408 (tramp-login-program "ssh")
409 (tramp-copy-program nil)
410 (tramp-remote-sh "/bin/sh")
411 (tramp-login-args ("-1" "-e" "none"))
412 (tramp-copy-args ("-1"))
413 (tramp-copy-keep-date-arg nil)
414 (tramp-password-end-of-line nil))
415 ("ssh2" (tramp-connection-function tramp-open-connection-rsh)
416 (tramp-login-program "ssh")
417 (tramp-copy-program nil)
418 (tramp-remote-sh "/bin/sh")
419 (tramp-login-args ("-2" "-e" "none"))
420 (tramp-copy-args ("-2"))
421 (tramp-copy-keep-date-arg nil)
422 (tramp-password-end-of-line nil))
424 (tramp-connection-function tramp-open-connection-rsh)
425 (tramp-login-program "ssh1")
426 (tramp-copy-program nil)
427 (tramp-remote-sh "/bin/sh")
428 (tramp-login-args ("-e" "none"))
429 (tramp-copy-args nil)
430 (tramp-copy-keep-date-arg nil)
431 (tramp-password-end-of-line nil))
433 (tramp-connection-function tramp-open-connection-rsh)
434 (tramp-login-program "ssh2")
435 (tramp-copy-program nil)
436 (tramp-remote-sh "/bin/sh")
437 (tramp-login-args ("-e" "none"))
438 (tramp-copy-args nil)
439 (tramp-copy-keep-date-arg nil)
440 (tramp-password-end-of-line nil))
441 ("remsh" (tramp-connection-function tramp-open-connection-rsh)
442 (tramp-login-program "remsh")
443 (tramp-copy-program nil)
444 (tramp-remote-sh "/bin/sh")
445 (tramp-login-args nil)
446 (tramp-copy-args nil)
447 (tramp-copy-keep-date-arg nil)
448 (tramp-password-end-of-line nil))
450 (tramp-connection-function tramp-open-connection-telnet)
451 (tramp-login-program "telnet")
452 (tramp-copy-program nil)
453 (tramp-remote-sh "/bin/sh")
454 (tramp-login-args nil)
455 (tramp-copy-args nil)
456 (tramp-copy-keep-date-arg nil)
457 (tramp-password-end-of-line nil))
458 ("su" (tramp-connection-function tramp-open-connection-su)
459 (tramp-login-program "su")
460 (tramp-copy-program nil)
461 (tramp-remote-sh "/bin/sh")
462 (tramp-login-args ("-" "%u"))
463 (tramp-copy-args nil)
464 (tramp-copy-keep-date-arg nil)
465 (tramp-password-end-of-line nil))
466 ("sudo" (tramp-connection-function tramp-open-connection-su)
467 (tramp-login-program "sudo")
468 (tramp-copy-program nil)
469 (tramp-remote-sh "/bin/sh")
470 (tramp-login-args ("-u" "%u" "-s"
472 (tramp-copy-args nil)
473 (tramp-copy-keep-date-arg nil)
474 (tramp-password-end-of-line nil))
475 ("multi" (tramp-connection-function tramp-open-connection-multi)
476 (tramp-login-program nil)
477 (tramp-copy-program nil)
478 (tramp-remote-sh "/bin/sh")
479 (tramp-login-args nil)
480 (tramp-copy-args nil)
481 (tramp-copy-keep-date-arg nil)
482 (tramp-password-end-of-line nil))
483 ("scpc" (tramp-connection-function tramp-open-connection-rsh)
484 (tramp-login-program "ssh")
485 (tramp-copy-program "scp")
486 (tramp-remote-sh "/bin/sh")
487 (tramp-login-args ("-o" "ControlPath=%t.%%r@%%h:%%p"
488 "-o" "ControlMaster=yes"
490 (tramp-copy-args ("-o" "ControlPath=%t.%%r@%%h:%%p"
491 "-o" "ControlMaster=auto"))
492 (tramp-copy-keep-date-arg "-p")
493 (tramp-password-end-of-line nil))
494 ("scpx" (tramp-connection-function tramp-open-connection-rsh)
495 (tramp-login-program "ssh")
496 (tramp-copy-program "scp")
497 (tramp-remote-sh "/bin/sh")
498 (tramp-login-args ("-e" "none" "-t" "-t" "/bin/sh"))
499 (tramp-copy-args nil)
500 (tramp-copy-keep-date-arg "-p")
501 (tramp-password-end-of-line nil))
502 ("sshx" (tramp-connection-function tramp-open-connection-rsh)
503 (tramp-login-program "ssh")
504 (tramp-copy-program nil)
505 (tramp-remote-sh "/bin/sh")
506 (tramp-login-args ("-e" "none" "-t" "-t" "/bin/sh"))
507 (tramp-copy-args nil)
508 (tramp-copy-keep-date-arg nil)
509 (tramp-password-end-of-line nil))
511 (tramp-connection-function tramp-open-connection-rsh)
512 (tramp-login-program "krlogin")
513 (tramp-copy-program nil)
514 (tramp-remote-sh "/bin/sh")
515 (tramp-login-args ("-x"))
516 (tramp-copy-args nil)
517 (tramp-copy-keep-date-arg nil)
518 (tramp-password-end-of-line nil))
520 (tramp-connection-function tramp-open-connection-rsh)
521 (tramp-login-program "plink")
522 (tramp-copy-program nil)
523 (tramp-remote-sh "/bin/sh")
524 (tramp-login-args ("-ssh")) ;optionally add "-v"
525 (tramp-copy-args nil)
526 (tramp-copy-keep-date-arg nil)
527 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
529 (tramp-connection-function tramp-open-connection-rsh)
530 (tramp-login-program "plink")
531 (tramp-copy-program nil)
532 (tramp-remote-sh "/bin/sh")
533 (tramp-login-args ("-1" "-ssh")) ;optionally add "-v"
534 (tramp-copy-args nil)
535 (tramp-copy-keep-date-arg nil)
536 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
538 (tramp-connection-function tramp-open-connection-rsh)
539 (tramp-login-program "plink")
540 (tramp-copy-program "pscp")
541 (tramp-remote-sh "/bin/sh")
542 (tramp-login-args ("-ssh"))
543 (tramp-copy-args nil)
544 (tramp-copy-keep-date-arg "-p")
545 (tramp-password-end-of-line "xy")) ;see docstring for "xy"
547 (tramp-connection-function tramp-open-connection-rsh)
548 (tramp-login-program "fsh")
549 (tramp-copy-program "fcp")
550 (tramp-remote-sh "/bin/sh -i")
551 (tramp-login-args ("sh" "-i"))
552 (tramp-copy-args nil)
553 (tramp-copy-keep-date-arg "-p")
554 (tramp-password-end-of-line nil))
556 "*Alist of methods for remote files.
557 This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
558 Each NAME stands for a remote access method. Each PARAM is a
559 pair of the form (KEY VALUE). The following KEYs are defined:
560 * `tramp-connection-function'
561 This specifies the function to use to connect to the remote host.
562 Currently, `tramp-open-connection-rsh', `tramp-open-connection-telnet'
563 and `tramp-open-connection-su' are defined. See the documentation
564 of these functions for more details.
566 This specifies the Bourne shell to use on the remote host. This
567 MUST be a Bourne-like shell. It is normally not necessary to set
568 this to any value other than \"/bin/sh\": tramp wants to use a shell
569 which groks tilde expansion, but it can search for it. Also note
570 that \"/bin/sh\" exists on all Unixen, this might not be true for
571 the value that you decide to use. You Have Been Warned.
572 * `tramp-login-program'
573 This specifies the name of the program to use for logging in to the
574 remote host. Depending on `tramp-connection-function', this may be
575 the name of rsh or a workalike program (when
576 `tramp-connection-function' is `tramp-open-connection-rsh'), or the
577 name of telnet or a workalike (for `tramp-open-connection-telnet'),
578 or the name of su or a workalike (for `tramp-open-connection-su').
580 This specifies the list of arguments to pass to the above
581 mentioned program. Please note that this is a list of arguments,
582 that is, normally you don't want to put \"-a -b\" or \"-f foo\"
583 here. Instead, you want two list elements, one for \"-a\" and one
584 for \"-b\", or one for \"-f\" and one for \"foo\".
585 If `tramp-connection-function' is `tramp-open-connection-su', then
586 \"%u\" in this list is replaced by the user name, and \"%%\" can
587 be used to obtain a literal percent character.
588 \"%t\" is replaced by the temporary file name for `scp'-like methods.
589 * `tramp-copy-program'
590 This specifies the name of the program to use for remotely copying
591 the file; this might be the absolute filename of rcp or the name of
594 This specifies the list of parameters to pass to the above mentioned
595 program, the hints for `tramp-login-args' also apply here.
596 * `tramp-copy-keep-date-arg'
597 This specifies the parameter to use for the copying program when the
598 timestamp of the original file should be kept. For `rcp', use `-p', for
600 * `tramp-password-end-of-line'
601 This specifies the string to use for terminating the line after
602 submitting the password. If this method parameter is nil, then the
603 value of the normal variable `tramp-default-password-end-of-line'
604 is used. This parameter is necessary because the \"plink\" program
605 requires any two characters after sending the password. These do
606 not have to be newline or carriage return characters. Other login
607 programs are happy with just one character, the newline character.
608 We use \"xy\" as the value for methods using \"plink\".
610 What does all this mean? Well, you should specify `tramp-login-program'
611 for all methods; this program is used to log in to the remote site. Then,
612 there are two ways to actually transfer the files between the local and the
613 remote side. One way is using an additional rcp-like program. If you want
614 to do this, set `tramp-copy-program' in the method.
616 Another possibility for file transfer is inline transfer, i.e. the
617 file is passed through the same buffer used by `tramp-login-program'. In
618 this case, the file contents need to be protected since the
619 `tramp-login-program' might use escape codes or the connection might not
620 be eight-bit clean. Therefore, file contents are encoded for transit.
621 See the variable `tramp-coding-commands' for details.
623 So, to summarize: if the method is an out-of-band method, then you
624 must specify `tramp-copy-program' and `tramp-copy-args'. If it is an
625 inline method, then these two parameters should be nil. Every method,
626 inline or out of band, must specify `tramp-connection-function' plus
627 the associated arguments (for example, the login program if you chose
628 `tramp-open-connection-telnet').
632 When using `tramp-open-connection-su' the phrase `open connection to a
633 remote host' sounds strange, but it is used nevertheless, for
634 consistency. No connection is opened to a remote host, but `su' is
635 started on the local host. You are not allowed to specify a remote
636 host other than `localhost' or the name of the local host."
640 (set (list (const tramp-connection-function) function)
641 (list (const tramp-login-program)
642 (choice (const nil) string))
643 (list (const tramp-copy-program)
644 (choice (const nil) string))
645 (list (const tramp-remote-sh)
646 (choice (const nil) string))
647 (list (const tramp-login-args) (repeat string))
648 (list (const tramp-copy-args) (repeat string))
649 (list (const tramp-copy-keep-date-arg)
650 (choice (const nil) string))
651 (list (const tramp-encoding-command)
652 (choice (const nil) string))
653 (list (const tramp-decoding-command)
654 (choice (const nil) string))
655 (list (const tramp-encoding-function)
656 (choice (const nil) function))
657 (list (const tramp-decoding-function)
658 (choice (const nil) function))
659 (list (const tramp-password-end-of-line)
660 (choice (const nil) string))))))
662 (defcustom tramp-multi-methods '("multi" "multiu")
663 "*List of multi-hop methods.
664 Each entry in this list should be a method name as mentioned in the
665 variable `tramp-methods'."
667 :type '(repeat string))
669 (defcustom tramp-multi-connection-function-alist
670 '(("telnet" tramp-multi-connect-telnet "telnet %h%n")
671 ("rsh" tramp-multi-connect-rlogin "rsh %h -l %u%n")
672 ("remsh" tramp-multi-connect-rlogin "remsh %h -l %u%n")
673 ("ssh" tramp-multi-connect-rlogin "ssh %h -l %u%n")
674 ("ssht" tramp-multi-connect-rlogin "ssh %h -e none -t -t -l %u%n")
675 ("su" tramp-multi-connect-su "su - %u%n")
676 ("sudo" tramp-multi-connect-su "sudo -u %u -s -p Password:%n"))
677 "*List of connection functions for multi-hop methods.
678 Each list item is a list of three items (METHOD FUNCTION COMMAND),
679 where METHOD is the name as used in the file name, FUNCTION is the
680 function to be executed, and COMMAND is the shell command used for
683 COMMAND may contain percent escapes. `%u' will be replaced with the
684 user name, `%h' will be replaced with the host name, and `%n' will be
685 replaced with an end-of-line character, as specified in the variable
686 `tramp-rsh-end-of-line'. Use `%%' for a literal percent character.
687 Note that the interpretation of the percent escapes also depends on
688 the FUNCTION. For example, the `%u' escape is forbidden with the
689 function `tramp-multi-connect-telnet'. See the documentation of the
690 various functions for details."
692 :type '(repeat (list string function string)))
694 (defcustom tramp-default-method
695 ;; An external copy method seems to be preferred, because it is much
696 ;; more performant for large files, and it hasn't too serious delays
697 ;; for small files. But it must be ensured that there aren't
698 ;; permanent password queries. Either a password agent like
699 ;; "ssh-agent" or "Pageant" shall run, or the optional password.el
700 ;; package shall be active for password caching. "scpc" would be
701 ;; another good choice because of the "ControlMaster" option, but
702 ;; this is a more modern alternative in OpenSSH 4, which cannot be
704 (let ((e-f (fboundp 'executable-find)))
706 ;; PuTTY is installed.
707 ((and e-f (funcall 'executable-find "pscp"))
708 (if (or (fboundp 'password-read)
709 ;; Pageant is running.
710 (and (fboundp 'w32-window-exists-p)
711 (funcall 'w32-window-exists-p "Pageant" "Pageant")))
714 ;; There is an ssh installation.
715 ((and e-f (funcall 'executable-find "scp"))
716 (if (or (fboundp 'password-read)
717 ;; ssh-agent is running.
718 (getenv "SSH_AUTH_SOCK")
719 (getenv "SSH_AGENT_PID"))
722 ;; Under Emacs 20, `executable-find' does not exists. So we
723 ;; couldn't check whether there is an ssh implementation. Let's
728 "*Default method to use for transferring files.
729 See `tramp-methods' for possibilities.
730 Also see `tramp-default-method-alist'."
734 (defcustom tramp-default-method-alist
735 '(("\\`localhost\\'" "\\`root\\'" "su"))
736 "*Default method to use for specific user/host pairs.
737 This is an alist of items (HOST USER METHOD). The first matching item
738 specifies the method to use for a file name which does not specify a
739 method. HOST and USER are regular expressions or nil, which is
740 interpreted as a regular expression which always matches. If no entry
741 matches, the variable `tramp-default-method' takes effect.
743 If the file name does not specify the user, lookup is done using the
744 empty string for the user name.
746 See `tramp-methods' for a list of possibilities for METHOD."
748 :type '(repeat (list (regexp :tag "Host regexp")
749 (regexp :tag "User regexp")
750 (string :tag "Method"))))
752 ;; Default values for non-Unices seeked
753 (defconst tramp-completion-function-alist-rsh
754 (unless (memq system-type '(windows-nt))
755 '((tramp-parse-rhosts "/etc/hosts.equiv")
756 (tramp-parse-rhosts "~/.rhosts")))
757 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
759 ;; Default values for non-Unices seeked
760 (defconst tramp-completion-function-alist-ssh
761 (unless (memq system-type '(windows-nt))
762 '((tramp-parse-rhosts "/etc/hosts.equiv")
763 (tramp-parse-rhosts "/etc/shosts.equiv")
764 (tramp-parse-shosts "/etc/ssh_known_hosts")
765 (tramp-parse-sconfig "/etc/ssh_config")
766 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
767 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
768 (tramp-parse-rhosts "~/.rhosts")
769 (tramp-parse-rhosts "~/.shosts")
770 (tramp-parse-shosts "~/.ssh/known_hosts")
771 (tramp-parse-sconfig "~/.ssh/config")
772 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
773 (tramp-parse-sknownhosts "~/.ssh2/knownhosts")))
774 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
776 ;; Default values for non-Unices seeked
777 (defconst tramp-completion-function-alist-telnet
778 (unless (memq system-type '(windows-nt))
779 '((tramp-parse-hosts "/etc/hosts")))
780 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
782 ;; Default values for non-Unices seeked
783 (defconst tramp-completion-function-alist-su
784 (unless (memq system-type '(windows-nt))
785 '((tramp-parse-passwd "/etc/passwd")))
786 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
788 (defvar tramp-completion-function-alist nil
789 "*Alist of methods for remote files.
790 This is a list of entries of the form (NAME PAIR1 PAIR2 ...).
791 Each NAME stands for a remote access method. Each PAIR is of the form
792 \(FUNCTION FILE). FUNCTION is responsible to extract user names and host
793 names from FILE for completion. The following predefined FUNCTIONs exists:
795 * `tramp-parse-rhosts' for \"~/.rhosts\" like files,
796 * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files,
797 * `tramp-parse-sconfig' for \"~/.ssh/config\" like files,
798 * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files,
799 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
800 * `tramp-parse-hosts' for \"/etc/hosts\" like files,
801 * `tramp-parse-passwd' for \"/etc/passwd\" like files.
802 * `tramp-parse-netrc' for \"~/.netrc\" like files.
804 FUNCTION can also be a customer defined function. For more details see
807 (eval-after-load "tramp"
809 (tramp-set-completion-function
810 "rcp" tramp-completion-function-alist-rsh)
811 (tramp-set-completion-function
812 "scp" tramp-completion-function-alist-ssh)
813 (tramp-set-completion-function
814 "scp1" tramp-completion-function-alist-ssh)
815 (tramp-set-completion-function
816 "scp2" tramp-completion-function-alist-ssh)
817 (tramp-set-completion-function
818 "scp1_old" tramp-completion-function-alist-ssh)
819 (tramp-set-completion-function
820 "scp2_old" tramp-completion-function-alist-ssh)
821 (tramp-set-completion-function
822 "rsync" tramp-completion-function-alist-rsh)
823 (tramp-set-completion-function
824 "remcp" tramp-completion-function-alist-rsh)
825 (tramp-set-completion-function
826 "rsh" tramp-completion-function-alist-rsh)
827 (tramp-set-completion-function
828 "ssh" tramp-completion-function-alist-ssh)
829 (tramp-set-completion-function
830 "ssh1" tramp-completion-function-alist-ssh)
831 (tramp-set-completion-function
832 "ssh2" tramp-completion-function-alist-ssh)
833 (tramp-set-completion-function
834 "ssh1_old" tramp-completion-function-alist-ssh)
835 (tramp-set-completion-function
836 "ssh2_old" tramp-completion-function-alist-ssh)
837 (tramp-set-completion-function
838 "remsh" tramp-completion-function-alist-rsh)
839 (tramp-set-completion-function
840 "telnet" tramp-completion-function-alist-telnet)
841 (tramp-set-completion-function
842 "su" tramp-completion-function-alist-su)
843 (tramp-set-completion-function
844 "sudo" tramp-completion-function-alist-su)
845 (tramp-set-completion-function
847 (tramp-set-completion-function
848 "scpx" tramp-completion-function-alist-ssh)
849 (tramp-set-completion-function
850 "sshx" tramp-completion-function-alist-ssh)
851 (tramp-set-completion-function
852 "krlogin" tramp-completion-function-alist-rsh)
853 (tramp-set-completion-function
854 "plink" tramp-completion-function-alist-ssh)
855 (tramp-set-completion-function
856 "plink1" tramp-completion-function-alist-ssh)
857 (tramp-set-completion-function
858 "pscp" tramp-completion-function-alist-ssh)
859 (tramp-set-completion-function
860 "fcp" tramp-completion-function-alist-ssh)))
862 (defcustom tramp-rsh-end-of-line "\n"
863 "*String used for end of line in rsh connections.
864 I don't think this ever needs to be changed, so please tell me about it
865 if you need to change this.
866 Also see the method parameter `tramp-password-end-of-line' and the normal
867 variable `tramp-default-password-end-of-line'."
871 (defcustom tramp-default-password-end-of-line
872 tramp-rsh-end-of-line
873 "*String used for end of line after sending a password.
874 This variable provides the default value for the method parameter
875 `tramp-password-end-of-line', see `tramp-methods' for more details.
877 It seems that people using plink under Windows need to send
878 \"\\r\\n\" (carriage-return, then newline) after a password, but just
879 \"\\n\" after all other lines. This variable can be used for the
880 password, see `tramp-rsh-end-of-line' for the other cases.
882 The default value is to use the same value as `tramp-rsh-end-of-line'."
886 (defcustom tramp-remote-path
887 ;; "/usr/xpg4/bin" has been placed first, because on Solaris a POSIX
888 ;; compatible "id" is needed.
889 '("/usr/xpg4/bin" "/bin" "/usr/bin" "/usr/sbin" "/usr/local/bin"
890 "/usr/ccs/bin" "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
891 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin")
892 "*List of directories to search for executables on remote host.
893 Please notify me about other semi-standard directories to include here.
895 You can use `~' in this list, but when searching for a shell which groks
896 tilde expansion, all directory names starting with `~' will be ignored."
898 :type '(repeat string))
900 (defcustom tramp-login-prompt-regexp
901 ".*ogin\\( .*\\)?: *"
902 "*Regexp matching login-like prompts.
903 The regexp should match at end of buffer.
905 Sometimes the prompt is reported to look like \"login as:\"."
909 (defcustom tramp-shell-prompt-pattern
910 "^[^#$%>\n]*[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*"
911 "Regexp to match prompts from remote shell.
912 Normally, Tramp expects you to configure `shell-prompt-pattern'
913 correctly, but sometimes it happens that you are connecting to a
914 remote host which sends a different kind of shell prompt. Therefore,
915 Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
916 and also things matched by this variable. The default value of this
917 variable is similar to the default value of `shell-prompt-pattern',
918 which should work well in many cases."
922 (defcustom tramp-password-prompt-regexp
923 "^.*\\([pP]assword\\|passphrase\\).*:\^@? *"
924 "*Regexp matching password-like prompts.
925 The regexp should match at end of buffer.
927 The `sudo' program appears to insert a `^@' character into the prompt."
931 (defcustom tramp-wrong-passwd-regexp
933 ;; These strings should be on the last line
934 (regexp-opt '("Permission denied."
940 "Name or service not known"
941 "Host key verification failed.") t)
945 ;; Here comes a list of regexes, separated by \\|
946 "Received signal [0-9]+"
948 "*Regexp matching a `login failed' message.
949 The regexp should match at end of buffer."
953 (defcustom tramp-yesno-prompt-regexp
955 (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
957 "Regular expression matching all yes/no queries which need to be confirmed.
958 The confirmation should be done with yes or no.
959 The regexp should match at end of buffer.
960 See also `tramp-yn-prompt-regexp'."
964 (defcustom tramp-yn-prompt-regexp
966 (regexp-opt '("Store key in cache? (y/n)"
967 "Update cached key? (y/n, Return cancels connection)") t)
969 "Regular expression matching all y/n queries which need to be confirmed.
970 The confirmation should be done with y or n.
971 The regexp should match at end of buffer.
972 See also `tramp-yesno-prompt-regexp'."
976 (defcustom tramp-terminal-prompt-regexp
980 "Terminal type\\? \\[.*\\]"
982 "Regular expression matching all terminal setting prompts.
983 The regexp should match at end of buffer.
984 The answer will be provided by `tramp-action-terminal', which see."
988 (defcustom tramp-operation-not-permitted-regexp
989 (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
990 (regexp-opt '("Operation not permitted") t))
991 "Regular expression matching keep-date problems in (s)cp operations.
992 Copying has been performed successfully already, so this message can
997 (defcustom tramp-copy-failed-regexp
999 (regexp-opt '("Permission denied"
1000 "not a regular file"
1002 "No such file or directory") t)
1004 "Regular expression matching copy problems in (s)cp operations."
1008 (defcustom tramp-process-alive-regexp
1010 "Regular expression indicating a process has finished.
1011 In fact this expression is empty by intention, it will be used only to
1012 check regularly the status of the associated process.
1013 The answer will be provided by `tramp-action-process-alive',
1014 `tramp-multi-action-process-alive' and`tramp-action-out-of-band', which see."
1018 (defcustom tramp-temp-name-prefix "tramp."
1019 "*Prefix to use for temporary files.
1020 If this is a relative file name (such as \"tramp.\"), it is considered
1021 relative to the directory name returned by the function
1022 `tramp-temporary-file-directory' (which see). It may also be an
1023 absolute file name; don't forget to include a prefix for the filename
1028 (defcustom tramp-discard-garbage nil
1029 "*If non-nil, try to discard garbage sent by remote shell.
1030 Some shells send such garbage upon connection setup."
1034 (defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
1035 "*Alist specifying extra arguments to pass to the remote shell.
1036 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
1037 matching the shell file name and ARGS is a string specifying the
1040 This variable is only used when Tramp needs to start up another shell
1041 for tilde expansion. The extra arguments should typically prevent the
1042 shell from reading its init file."
1044 ;; This might be the wrong way to test whether the widget type
1045 ;; `alist' is available. Who knows the right way to test it?
1046 :type (if (get 'alist 'widget-type)
1047 '(alist :key-type string :value-type string)
1048 '(repeat (cons string string))))
1050 (defcustom tramp-prefix-format
1051 (if tramp-unified-filenames "/" "/[")
1052 "*String matching the very beginning of tramp file names.
1053 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
1057 (defcustom tramp-prefix-regexp
1058 (concat "^" (regexp-quote tramp-prefix-format))
1059 "*Regexp matching the very beginning of tramp file names.
1060 Should always start with \"^\". Derived from `tramp-prefix-format'."
1064 (defcustom tramp-method-regexp
1066 "*Regexp matching methods identifiers."
1070 ;; It is a little bit annoying that in XEmacs case this delimeter is different
1071 ;; for single-hop and multi-hop cases.
1072 (defcustom tramp-postfix-single-method-format
1073 (if tramp-unified-filenames ":" "/")
1074 "*String matching delimeter between method and user or host names.
1075 Applicable for single-hop methods.
1076 Used in `tramp-make-tramp-file-name'."
1080 (defcustom tramp-postfix-single-method-regexp
1081 (regexp-quote tramp-postfix-single-method-format)
1082 "*Regexp matching delimeter between method and user or host names.
1083 Applicable for single-hop methods.
1084 Derived from `tramp-postfix-single-method-format'."
1088 (defcustom tramp-postfix-multi-method-format
1090 "*String matching delimeter between method and user or host names.
1091 Applicable for multi-hop methods.
1092 Used in `tramp-make-tramp-multi-file-name'."
1096 (defcustom tramp-postfix-multi-method-regexp
1097 (regexp-quote tramp-postfix-multi-method-format)
1098 "*Regexp matching delimeter between method and user or host names.
1099 Applicable for multi-hop methods.
1100 Derived from `tramp-postfix-multi-method-format'."
1104 (defcustom tramp-postfix-multi-hop-format
1105 (if tramp-unified-filenames ":" "/")
1106 "*String matching delimeter between host and next method.
1107 Applicable for multi-hop methods.
1108 Used in `tramp-make-tramp-multi-file-name'."
1112 (defcustom tramp-postfix-multi-hop-regexp
1113 (regexp-quote tramp-postfix-multi-hop-format)
1114 "*Regexp matching delimeter between host and next method.
1115 Applicable for multi-hop methods.
1116 Derived from `tramp-postfix-multi-hop-format'."
1120 (defcustom tramp-user-regexp
1122 "*Regexp matching user names."
1126 (defcustom tramp-postfix-user-format
1128 "*String matching delimeter between user and host names.
1129 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
1133 (defcustom tramp-postfix-user-regexp
1134 (regexp-quote tramp-postfix-user-format)
1135 "*Regexp matching delimeter between user and host names.
1136 Derived from `tramp-postfix-user-format'."
1140 (defcustom tramp-host-regexp
1142 "*Regexp matching host names."
1146 (defcustom tramp-host-with-port-regexp
1148 "*Regexp matching host names."
1152 (defcustom tramp-postfix-host-format
1153 (if tramp-unified-filenames ":" "]")
1154 "*String matching delimeter between host names and localnames.
1155 Used in `tramp-make-tramp-file-name' and `tramp-make-tramp-multi-file-name'."
1159 (defcustom tramp-postfix-host-regexp
1160 (regexp-quote tramp-postfix-host-format)
1161 "*Regexp matching delimeter between host names and localnames.
1162 Derived from `tramp-postfix-host-format'."
1166 (defcustom tramp-localname-regexp
1168 "*Regexp matching localnames."
1172 ;; File name format.
1174 (defcustom tramp-file-name-structure
1178 "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp "\\)?"
1179 "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?"
1180 "\\(" tramp-host-with-port-regexp "\\)" tramp-postfix-host-regexp
1181 "\\(" tramp-localname-regexp "\\)")
1184 "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \
1185 the tramp file name structure.
1187 The first element REGEXP is a regular expression matching a tramp file
1188 name. The regex should contain parentheses around the method name,
1189 the user name, the host name, and the file name parts.
1191 The second element METHOD is a number, saying which pair of
1192 parentheses matches the method name. The third element USER is
1193 similar, but for the user name. The fourth element HOST is similar,
1194 but for the host name. The fifth element FILE is for the file name.
1195 These numbers are passed directly to `match-string', which see. That
1196 means the opening parentheses are counted to identify the pair.
1198 See also `tramp-file-name-regexp'."
1200 :type '(list (regexp :tag "File name regexp")
1201 (integer :tag "Paren pair for method name")
1202 (integer :tag "Paren pair for user name ")
1203 (integer :tag "Paren pair for host name ")
1204 (integer :tag "Paren pair for file name ")))
1207 (defconst tramp-file-name-regexp-unified
1209 "Value for `tramp-file-name-regexp' for unified remoting.
1210 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1211 Tramp. See `tramp-file-name-structure-unified' for more explanations.")
1214 (defconst tramp-file-name-regexp-separate
1216 "Value for `tramp-file-name-regexp' for separate remoting.
1217 XEmacs uses a separate filename syntax for Tramp and EFS.
1218 See `tramp-file-name-structure-separate' for more explanations.")
1221 (defcustom tramp-file-name-regexp
1222 (if tramp-unified-filenames
1223 tramp-file-name-regexp-unified
1224 tramp-file-name-regexp-separate)
1225 "*Regular expression matching file names handled by tramp.
1226 This regexp should match tramp file names but no other file names.
1227 \(When tramp.el is loaded, this regular expression is prepended to
1228 `file-name-handler-alist', and that is searched sequentially. Thus,
1229 if the tramp entry appears rather early in the `file-name-handler-alist'
1230 and is a bit too general, then some files might be considered tramp
1231 files which are not really tramp files.
1233 Please note that the entry in `file-name-handler-alist' is made when
1234 this file (tramp.el) is loaded. This means that this variable must be set
1235 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1236 updated after changing this variable.
1238 Also see `tramp-file-name-structure'."
1243 (defconst tramp-completion-file-name-regexp-unified
1244 "^/$\\|^/[^/:][^/]*$"
1245 "Value for `tramp-completion-file-name-regexp' for unified remoting.
1246 Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and
1247 Tramp. See `tramp-file-name-structure-unified' for more explanations.")
1250 (defconst tramp-completion-file-name-regexp-separate
1251 "^/\\([[][^]]*\\)?$"
1252 "Value for `tramp-completion-file-name-regexp' for separate remoting.
1253 XEmacs uses a separate filename syntax for Tramp and EFS.
1254 See `tramp-file-name-structure-separate' for more explanations.")
1257 (defcustom tramp-completion-file-name-regexp
1258 (if tramp-unified-filenames
1259 tramp-completion-file-name-regexp-unified
1260 tramp-completion-file-name-regexp-separate)
1261 "*Regular expression matching file names handled by tramp completion.
1262 This regexp should match partial tramp file names only.
1264 Please note that the entry in `file-name-handler-alist' is made when
1265 this file (tramp.el) is loaded. This means that this variable must be set
1266 before loading tramp.el. Alternatively, `file-name-handler-alist' can be
1267 updated after changing this variable.
1269 Also see `tramp-file-name-structure'."
1273 (defcustom tramp-multi-file-name-structure
1277 "\\(" "\\(" tramp-method-regexp "\\)" "\\)?"
1278 "\\(" "\\(" tramp-postfix-multi-hop-regexp "%s" "\\)+" "\\)?"
1279 tramp-postfix-host-regexp "\\(" tramp-localname-regexp "\\)")
1281 "*Describes the file name structure of `multi' files.
1282 Multi files allow you to contact a remote host in several hops.
1283 This is a list of four elements (REGEXP METHOD HOP LOCALNAME).
1285 The first element, REGEXP, gives a regular expression to match against
1286 the file name. In this regular expression, `%s' is replaced with the
1287 value of `tramp-multi-file-name-hop-structure'. (Note: in order to
1288 allow multiple hops, you normally want to use something like
1289 \"\\\\(\\\\(%s\\\\)+\\\\)\" in the regular expression. The outer pair
1290 of parentheses is used for the HOP element, see below.)
1292 All remaining elements are numbers. METHOD gives the number of the
1293 paren pair which matches the method name. HOP gives the number of the
1294 paren pair which matches the hop sequence. LOCALNAME gives the number of
1295 the paren pair which matches the localname (pathname) on the remote host.
1297 LOCALNAME can also be negative, which means to count from the end. Ie, a
1298 value of -1 means the last paren pair.
1300 I think it would be good if the regexp matches the whole of the
1301 string, but I haven't actually tried what happens if it doesn't..."
1303 :type '(list (regexp :tag "File name regexp")
1304 (integer :tag "Paren pair for method name")
1305 (integer :tag "Paren pair for hops")
1306 (integer :tag "Paren pair to match localname")))
1308 (defcustom tramp-multi-file-name-hop-structure
1311 "\\(" tramp-method-regexp "\\)" tramp-postfix-multi-method-regexp
1312 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
1313 "\\(" tramp-host-with-port-regexp "\\)")
1315 "*Describes the structure of a hop in multi files.
1316 This is a list of four elements (REGEXP METHOD USER HOST). First
1317 element REGEXP is used to match against the hop. Pair number METHOD
1318 matches the method of one hop, pair number USER matches the user of
1319 one hop, pair number HOST matches the host of one hop.
1321 This regular expression should match exactly all of one hop."
1323 :type '(list (regexp :tag "Hop regexp")
1324 (integer :tag "Paren pair for method name")
1325 (integer :tag "Paren pair for user name")
1326 (integer :tag "Paren pair for host name")))
1328 (defcustom tramp-make-multi-tramp-file-format
1330 (concat tramp-prefix-format "%m")
1331 (concat tramp-postfix-multi-hop-format
1332 "%m" tramp-postfix-multi-method-format
1333 "%u" tramp-postfix-user-format
1335 (concat tramp-postfix-host-format "%p"))
1336 "*Describes how to construct a `multi' file name.
1337 This is a list of three elements PREFIX, HOP and LOCALNAME.
1339 The first element PREFIX says how to construct the prefix, the second
1340 element HOP specifies what each hop looks like, and the final element
1341 LOCALNAME says how to construct the localname (pathname).
1343 In PREFIX, `%%' means `%' and `%m' means the method name.
1345 In HOP, `%%' means `%' and `%m', `%u', `%h' mean the hop method, hop
1346 user and hop host, respectively.
1348 In LOCALNAME, `%%' means `%' and `%p' means the localname.
1350 The resulting file name always contains one copy of PREFIX and one
1351 copy of LOCALNAME, but there is one copy of HOP for each hop in the file
1354 Note: the current implementation requires the prefix to contain the
1355 method name, followed by all the hops, and the localname must come
1358 :type '(list string string string))
1360 (defcustom tramp-terminal-type "dumb"
1361 "*Value of TERM environment variable for logging in to remote host.
1362 Because Tramp wants to parse the output of the remote shell, it is easily
1363 confused by ANSI color escape sequences and suchlike. Often, shell init
1364 files conditionalize this setup based on the TERM environment variable."
1368 (defcustom tramp-completion-without-shell-p nil
1369 "*If nil, use shell wildcards for completion, else rely on Lisp only.
1370 Using shell wildcards for completions has the advantage that it can be
1371 fast even in large directories, but completion is always
1372 case-sensitive. Relying on Lisp only means that case-insensitive
1373 completion is possible (subject to the variable `completion-ignore-case'),
1374 but it might be slow on large directories."
1378 (defcustom tramp-actions-before-shell
1379 '((tramp-password-prompt-regexp tramp-action-password)
1380 (tramp-login-prompt-regexp tramp-action-login)
1381 (shell-prompt-pattern tramp-action-succeed)
1382 (tramp-shell-prompt-pattern tramp-action-succeed)
1383 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1384 (tramp-yesno-prompt-regexp tramp-action-yesno)
1385 (tramp-yn-prompt-regexp tramp-action-yn)
1386 (tramp-terminal-prompt-regexp tramp-action-terminal)
1387 (tramp-process-alive-regexp tramp-action-process-alive))
1388 "List of pattern/action pairs.
1389 Whenever a pattern matches, the corresponding action is performed.
1390 Each item looks like (PATTERN ACTION).
1392 The PATTERN should be a symbol, a variable. The value of this
1393 variable gives the regular expression to search for. Note that the
1394 regexp must match at the end of the buffer, \"\\'\" is implicitly
1397 The ACTION should also be a symbol, but a function. When the
1398 corresponding PATTERN matches, the ACTION function is called."
1400 :type '(repeat (list variable function)))
1402 (defcustom tramp-actions-copy-out-of-band
1403 '((tramp-password-prompt-regexp tramp-action-password)
1404 (tramp-wrong-passwd-regexp tramp-action-permission-denied)
1405 (tramp-copy-failed-regexp tramp-action-copy-failed)
1406 (tramp-process-alive-regexp tramp-action-out-of-band))
1407 "List of pattern/action pairs.
1408 This list is used for copying/renaming with out-of-band methods.
1409 See `tramp-actions-before-shell' for more info."
1411 :type '(repeat (list variable function)))
1413 (defcustom tramp-multi-actions
1414 '((tramp-password-prompt-regexp tramp-multi-action-password)
1415 (tramp-login-prompt-regexp tramp-multi-action-login)
1416 (shell-prompt-pattern tramp-multi-action-succeed)
1417 (tramp-shell-prompt-pattern tramp-multi-action-succeed)
1418 (tramp-wrong-passwd-regexp tramp-multi-action-permission-denied)
1419 (tramp-process-alive-regexp tramp-multi-action-process-alive))
1420 "List of pattern/action pairs.
1421 This list is used for each hop in multi-hop connections.
1422 See `tramp-actions-before-shell' for more info."
1424 :type '(repeat (list variable function)))
1426 (defcustom tramp-initial-commands
1429 "unset autocorrect")
1430 "List of commands to send to the first remote shell that we see.
1431 These commands will be sent to any shell, and thus they should be
1432 designed to work in such circumstances. Also, restrict the commands
1433 to the bare necessity for getting the remote shell into a state
1434 where it is possible to execute the Bourne-ish shell.
1436 At the moment, the command to execute the Bourne-ish shell uses strange
1437 quoting which `tcsh' tries to correct, so we send the command \"unset
1438 autocorrect\" to the remote host."
1440 :type '(repeat string))
1442 ;; Chunked sending kluge. We set this to 500 for black-listed constellations
1443 ;; known to have a bug in `process-send-string'; some ssh connections appear
1444 ;; to drop bytes when data is sent too quickly. There is also a connection
1445 ;; buffer local variable, which is computed depending on remote host properties
1446 ;; when `tramp-chunksize' is zero or nil.
1447 (defcustom tramp-chunksize
1448 (when (and (not (featurep 'xemacs))
1449 (memq system-type '(hpux)))
1451 ;; Parentheses in docstring starting at beginning of line are escaped.
1452 ;; Fontification is messed up when
1453 ;; `open-paren-in-column-0-is-defun-start' set to t.
1454 "*If non-nil, chunksize for sending input to local process.
1455 It is necessary only on systems which have a buggy `process-send-string'
1456 implementation. The necessity, whether this variable must be set, can be
1457 checked via the following code:
1460 (let* ((user \"xxx\") (host \"yyy\")
1462 (sent init) (received init))
1463 (while (= sent received)
1464 (setq sent (+ sent step))
1466 (let ((proc (start-process (buffer-name) (current-buffer)
1467 \"ssh\" \"-l\" user host \"wc\" \"-c\")))
1468 (when (memq (process-status proc) '(run open))
1469 (process-send-string proc (make-string sent ?\\ ))
1470 (process-send-eof proc)
1471 (process-send-eof proc))
1472 (while (not (progn (goto-char (point-min))
1473 (re-search-forward \"\\\\w+\" (point-max) t)))
1474 (accept-process-output proc 1))
1475 (when (memq (process-status proc) '(run open))
1476 (setq received (string-to-number (match-string 0)))
1477 (delete-process proc)
1478 (message \"Bytes sent: %s\\tBytes received: %s\" sent received)
1480 (if (> sent (+ init step))
1481 (message \"You should set `tramp-chunksize' to a maximum of %s\"
1483 (message \"Test does not work\")
1484 (display-buffer (current-buffer))
1487 In the Emacs normally running Tramp, evaluate the above code
1488 \(replace \"xxx\" and \"yyy\" by the remote user and host name,
1489 respectively). You can do this, for example, by pasting it into
1490 the `*scratch*' buffer and then hitting C-j with the cursor after the
1491 last closing parenthesis. Note that it works only if you have configured
1492 \"ssh\" to run without password query, see ssh-agent(1).
1494 You will see the number of bytes sent successfully to the remote host.
1495 If that number exceeds 1000, you can stop the execution by hitting
1496 C-g, because your Emacs is likely clean.
1498 If your Emacs is buggy, the code stops and gives you an indication
1499 about the value `tramp-chunksize' should be set. Maybe you could just
1500 experiment a bit, e.g. changing the values of `init' and `step'
1501 in the third line of the code.
1503 When it is necessary to set `tramp-chunksize', you might consider to
1504 use an out-of-the-band method (like \"scp\") instead of an internal one
1505 \(like \"ssh\"), because setting `tramp-chunksize' to non-nil decreases
1508 Please raise a bug report via \"M-x tramp-bug\" if your system needs
1509 this variable to be set as well."
1511 :type '(choice (const nil) integer))
1513 ;; Logging in to a remote host normally requires obtaining a pty. But
1514 ;; Emacs on MacOS X has process-connection-type set to nil by default,
1515 ;; so on those systems Tramp doesn't obtain a pty. Here, we allow
1516 ;; for an override of the system default.
1517 (defcustom tramp-process-connection-type t
1518 "Overrides `process-connection-type' for connections from Tramp.
1519 Tramp binds process-connection-type to the value given here before
1520 opening a connection to a remote host."
1522 :type '(choice (const nil) (const t) (const pty)))
1524 ;;; Internal Variables:
1526 (defvar tramp-buffer-file-attributes nil
1527 "Holds the `ls -ild' output for the current buffer.
1528 This variable is local to each buffer. It is not used if the remote
1529 machine groks Perl. If it is used, it's used as an emulation for
1530 the visited file modtime.")
1531 (make-variable-buffer-local 'tramp-buffer-file-attributes)
1533 (defvar tramp-md5-function
1534 (cond ((and (require 'md5) (fboundp 'md5)) 'md5)
1535 ((fboundp 'md5-encode)
1536 (lambda (x) (base64-encode-string
1537 (funcall (symbol-function 'md5-encode) x))))
1538 (t (error "Couldn't find an `md5' function")))
1539 "Function to call for running the MD5 algorithm.")
1541 (defvar tramp-end-of-output
1543 (funcall tramp-md5-function
1545 (prin1-to-string process-environment)
1546 (current-time-string)
1548 ;; (if (fboundp 'directory-files-and-attributes)
1549 ;; (funcall 'directory-files-and-attributes
1550 ;; (or (getenv "HOME")
1551 ;; (tramp-temporary-file-directory)))
1554 ;; (cons x (file-attributes x)))
1555 ;; (directory-files (or (getenv "HOME")
1556 ;; (tramp-temporary-file-directory))
1559 "String used to recognize end of output.")
1561 (defvar tramp-connection-function nil
1562 "This internal variable holds a parameter for `tramp-methods'.
1563 In the connection buffer, this variable has the value of the like-named
1564 method parameter, as specified in `tramp-methods' (which see).")
1566 (defvar tramp-remote-sh nil
1567 "This internal variable holds a parameter for `tramp-methods'.
1568 In the connection buffer, this variable has the value of the like-named
1569 method parameter, as specified in `tramp-methods' (which see).")
1571 (defvar tramp-login-program nil
1572 "This internal variable holds a parameter for `tramp-methods'.
1573 In the connection buffer, this variable has the value of the like-named
1574 method parameter, as specified in `tramp-methods' (which see).")
1576 (defvar tramp-login-args nil
1577 "This internal variable holds a parameter for `tramp-methods'.
1578 In the connection buffer, this variable has the value of the like-named
1579 method parameter, as specified in `tramp-methods' (which see).")
1581 (defvar tramp-copy-program nil
1582 "This internal variable holds a parameter for `tramp-methods'.
1583 In the connection buffer, this variable has the value of the like-named
1584 method parameter, as specified in `tramp-methods' (which see).")
1586 (defvar tramp-copy-args nil
1587 "This internal variable holds a parameter for `tramp-methods'.
1588 In the connection buffer, this variable has the value of the like-named
1589 method parameter, as specified in `tramp-methods' (which see).")
1591 (defvar tramp-copy-keep-date-arg nil
1592 "This internal variable holds a parameter for `tramp-methods'.
1593 In the connection buffer, this variable has the value of the like-named
1594 method parameter, as specified in `tramp-methods' (which see).")
1596 (defvar tramp-encoding-command nil
1597 "This internal variable holds a parameter for `tramp-methods'.
1598 In the connection buffer, this variable has the value of the like-named
1599 method parameter, as specified in `tramp-methods' (which see).")
1601 (defvar tramp-decoding-command nil
1602 "This internal variable holds a parameter for `tramp-methods'.
1603 In the connection buffer, this variable has the value of the like-named
1604 method parameter, as specified in `tramp-methods' (which see).")
1606 (defvar tramp-encoding-function nil
1607 "This internal variable holds a parameter for `tramp-methods'.
1608 In the connection buffer, this variable has the value of the like-named
1609 method parameter, as specified in `tramp-methods' (which see).")
1611 (defvar tramp-decoding-function nil
1612 "This internal variable holds a parameter for `tramp-methods'.
1613 In the connection buffer, this variable has the value of the like-named
1614 method parameter, as specified in `tramp-methods' (which see).")
1616 (defvar tramp-password-end-of-line nil
1617 "This internal variable holds a parameter for `tramp-methods'.
1618 In the connection buffer, this variable has the value of the like-named
1619 method parameter, as specified in `tramp-methods' (which see).")
1621 ;; CCC `local in each buffer'?
1622 (defvar tramp-ls-command nil
1623 "This command is used to get a long listing with numeric user and group ids.
1624 This variable is automatically made buffer-local to each rsh process buffer
1625 upon opening the connection.")
1627 (defvar tramp-current-multi-method nil
1628 "Name of `multi' connection method for this *tramp* buffer, or nil if not multi.
1629 This variable is automatically made buffer-local to each rsh process buffer
1630 upon opening the connection.")
1632 (defvar tramp-current-method nil
1633 "Connection method for this *tramp* buffer.
1634 This variable is automatically made buffer-local to each rsh process buffer
1635 upon opening the connection.")
1637 (defvar tramp-current-user nil
1638 "Remote login name for this *tramp* buffer.
1639 This variable is automatically made buffer-local to each rsh process buffer
1640 upon opening the connection.")
1642 (defvar tramp-current-host nil
1643 "Remote host for this *tramp* buffer.
1644 This variable is automatically made buffer-local to each rsh process buffer
1645 upon opening the connection.")
1647 (defvar tramp-test-groks-nt nil
1648 "Whether the `test' command groks the `-nt' switch.
1649 \(`test A -nt B' tests if file A is newer than file B.)
1650 This variable is automatically made buffer-local to each rsh process buffer
1651 upon opening the connection.")
1653 (defvar tramp-file-exists-command nil
1654 "Command to use for checking if a file exists.
1655 This variable is automatically made buffer-local to each rsh process buffer
1656 upon opening the connection.")
1658 (defconst tramp-uudecode "\
1660 \(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
1664 "Shell function to implement `uudecode' to standard output.
1665 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
1666 for this or `uudecode -p', but some systems don't, and for them
1667 we have this shell function.")
1669 ;; Perl script to implement `file-attributes' in a Lisp `read'able
1670 ;; output. If you are hacking on this, note that you get *no* output
1671 ;; unless this spits out a complete line, including the '\n' at the
1673 ;; The device number is returned as "-1", because there will be a virtual
1674 ;; device number set in `tramp-handle-file-attributes'
1675 (defconst tramp-perl-file-attributes "\
1676 @stat = lstat($ARGV[0]);
1677 if (($stat[2] & 0170000) == 0120000)
1679 $type = readlink($ARGV[0]);
1680 $type = \"\\\"$type\\\"\";
1682 elsif (($stat[2] & 0170000) == 040000)
1690 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1691 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1693 \"(%s %u %s %s (%u %u) (%u %u) (%u %u) %u %u t (%u . %u) -1)\\n\",
1698 $stat[8] >> 16 & 0xffff,
1700 $stat[9] >> 16 & 0xffff,
1702 $stat[10] >> 16 & 0xffff,
1706 $stat[1] >> 16 & 0xffff,
1709 "Perl script to produce output suitable for use with `file-attributes'
1710 on the remote file system.")
1712 (defconst tramp-perl-directory-files-and-attributes "\
1713 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
1714 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
1715 @list = readdir(DIR);
1719 for($i = 0; $i < $n; $i++)
1721 $filename = $list[$i];
1722 @stat = lstat($filename);
1723 if (($stat[2] & 0170000) == 0120000)
1725 $type = readlink($filename);
1726 $type = \"\\\"$type\\\"\";
1728 elsif (($stat[2] & 0170000) == 040000)
1736 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
1737 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
1739 \"(\\\"%s\\\" %s %u %s %s (%u %u) (%u %u) (%u %u) %u %u t (%u . %u) (%u %u))\\n\",
1745 $stat[8] >> 16 & 0xffff,
1747 $stat[9] >> 16 & 0xffff,
1749 $stat[10] >> 16 & 0xffff,
1753 $stat[1] >> 16 & 0xffff,
1755 $stat[0] >> 16 & 0xffff,
1759 "Perl script implementing `directory-files-attributes' as Lisp `read'able
1762 ;; ;; These two use uu encoding.
1763 ;; (defvar tramp-perl-encode "%s -e'\
1764 ;; print qq(begin 644 xxx\n);
1767 ;; while (read(STDIN, $s, 45)) {
1768 ;; print pack(q(u), $s);
1773 ;; "Perl program to use for encoding a file.
1774 ;; Escape sequence %s is replaced with name of Perl binary.")
1776 ;; (defvar tramp-perl-decode "%s -ne '
1777 ;; print unpack q(u), $_;
1779 ;; "Perl program to use for decoding a file.
1780 ;; Escape sequence %s is replaced with name of Perl binary.")
1782 ;; These two use base64 encoding.
1783 (defvar tramp-perl-encode-with-module
1784 "perl -MMIME::Base64 -0777 -ne 'print encode_base64($_)'"
1785 "Perl program to use for encoding a file.
1786 Escape sequence %s is replaced with name of Perl binary.
1787 This string is passed to `format', so percent characters need to be doubled.
1788 This implementation requires the MIME::Base64 Perl module to be installed
1789 on the remote host.")
1791 (defvar tramp-perl-decode-with-module
1792 "perl -MMIME::Base64 -0777 -ne 'print decode_base64($_)'"
1793 "Perl program to use for decoding a file.
1794 Escape sequence %s is replaced with name of Perl binary.
1795 This string is passed to `format', so percent characters need to be doubled.
1796 This implementation requires the MIME::Base64 Perl module to be installed
1797 on the remote host.")
1799 (defvar tramp-perl-encode
1801 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1802 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
1803 # Free Software Foundation, Inc.
1808 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
1809 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
1814 # We read in chunks of 54 bytes, to generate output lines
1815 # of 72 chars (plus end of line)
1818 while (my $data = <STDIN>) {
1821 # Only for the last chunk, and only if did not fill the last three-byte packet
1823 my $mod = length($data) %% 3;
1824 $pad = q(=) x (3 - $mod) if $mod;
1827 # Not the fastest method, but it is simple: unpack to binary string, split
1828 # by groups of 6 bits and convert back from binary to byte; then map into
1829 # the translation table
1833 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
1838 "Perl program to use for encoding a file.
1839 Escape sequence %s is replaced with name of Perl binary.
1840 This string is passed to `format', so percent characters need to be doubled.")
1842 (defvar tramp-perl-decode
1844 # This script contributed by Juanma Barranquero <lektu@terra.es>.
1845 # Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
1846 # Free Software Foundation, Inc.
1851 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
1852 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
1855 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
1859 # We are going to accumulate into $pending to accept any line length
1860 # (we do not check they are <= 76 chars as the RFC says)
1863 while (my $data = <STDIN>) {
1866 # If we find one or two =, we have reached the end and
1867 # any following data is to be discarded
1868 my $finished = $data =~ s/(==?).*/$1/;
1871 my $len = length($pending);
1872 my $chunk = substr($pending, 0, $len & ~3);
1873 $pending = substr($pending, $len & ~3 + 1);
1875 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
1876 # split in 8-bit chunks and convert back to char.
1879 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
1884 "Perl program to use for decoding a file.
1885 Escape sequence %s is replaced with name of Perl binary.
1886 This string is passed to `format', so percent characters need to be doubled.")
1888 (defconst tramp-file-mode-type-map '((0 . "-") ; Normal file (SVID-v2 and XPG2)
1890 (2 . "c") ; character device
1891 (3 . "m") ; multiplexed character device (v7)
1892 (4 . "d") ; directory
1893 (5 . "?") ; Named special file (XENIX)
1894 (6 . "b") ; block device
1895 (7 . "?") ; multiplexed block device (v7)
1896 (8 . "-") ; regular file
1897 (9 . "n") ; network special file (HP-UX)
1898 (10 . "l") ; symlink
1899 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
1901 (13 . "D") ; door special (Solaris)
1902 (14 . "w")) ; whiteout (BSD)
1903 "A list of file types returned from the `stat' system call.
1904 This is used to map a mode number to a permission string.")
1906 (defvar tramp-dos-coding-system
1907 (if (and (fboundp 'coding-system-p)
1908 (funcall 'coding-system-p '(dos)))
1911 "Some Emacsen know the `dos' coding system, others need `undecided-dos'.")
1913 (defvar tramp-last-cmd nil
1914 "Internal Tramp variable recording the last command sent.
1915 This variable is buffer-local in every buffer.")
1916 (make-variable-buffer-local 'tramp-last-cmd)
1918 (defvar tramp-process-echoes nil
1919 "Whether to process echoes from the remote shell.")
1921 (defvar tramp-last-cmd-time nil
1922 "Internal Tramp variable recording the time when the last cmd was sent.
1923 This variable is buffer-local in every buffer.")
1924 (make-variable-buffer-local 'tramp-last-cmd-time)
1926 ;; This variable does not have the right value in XEmacs. What should
1927 ;; I use instead of find-operation-coding-system in XEmacs?
1928 (defvar tramp-feature-write-region-fix
1929 (when (fboundp 'find-operation-coding-system)
1930 (let ((file-coding-system-alist '(("test" emacs-mule))))
1931 (funcall (symbol-function 'find-operation-coding-system)
1932 'write-region 0 0 "" nil "test")))
1933 "Internal variable to say if `write-region' chooses the right coding.
1934 Older versions of Emacs chose the coding system for `write-region' based
1935 on the FILENAME argument, even if VISIT was a string.")
1937 ;; New handlers should be added here. The following operations can be
1938 ;; handled using the normal primitives: file-name-as-directory,
1939 ;; file-name-directory, file-name-nondirectory,
1940 ;; file-name-sans-versions, get-file-buffer.
1941 (defconst tramp-file-name-handler-alist
1943 (load . tramp-handle-load)
1944 (make-symbolic-link . tramp-handle-make-symbolic-link)
1945 (file-name-directory . tramp-handle-file-name-directory)
1946 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
1947 (file-truename . tramp-handle-file-truename)
1948 (file-exists-p . tramp-handle-file-exists-p)
1949 (file-directory-p . tramp-handle-file-directory-p)
1950 (file-executable-p . tramp-handle-file-executable-p)
1951 (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
1952 (file-readable-p . tramp-handle-file-readable-p)
1953 (file-regular-p . tramp-handle-file-regular-p)
1954 (file-symlink-p . tramp-handle-file-symlink-p)
1955 (file-writable-p . tramp-handle-file-writable-p)
1956 (file-ownership-preserved-p . tramp-handle-file-ownership-preserved-p)
1957 (file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
1958 (file-attributes . tramp-handle-file-attributes)
1959 (file-modes . tramp-handle-file-modes)
1960 (directory-files . tramp-handle-directory-files)
1961 (directory-files-and-attributes . tramp-handle-directory-files-and-attributes)
1962 (file-name-all-completions . tramp-handle-file-name-all-completions)
1963 (file-name-completion . tramp-handle-file-name-completion)
1964 (add-name-to-file . tramp-handle-add-name-to-file)
1965 (copy-file . tramp-handle-copy-file)
1966 (rename-file . tramp-handle-rename-file)
1967 (set-file-modes . tramp-handle-set-file-modes)
1968 (make-directory . tramp-handle-make-directory)
1969 (delete-directory . tramp-handle-delete-directory)
1970 (delete-file . tramp-handle-delete-file)
1971 (directory-file-name . tramp-handle-directory-file-name)
1972 (shell-command . tramp-handle-shell-command)
1973 (process-file . tramp-handle-process-file)
1974 (insert-directory . tramp-handle-insert-directory)
1975 (expand-file-name . tramp-handle-expand-file-name)
1976 (file-local-copy . tramp-handle-file-local-copy)
1977 (file-remote-p . tramp-handle-file-remote-p)
1978 (insert-file-contents . tramp-handle-insert-file-contents)
1979 (write-region . tramp-handle-write-region)
1980 (find-backup-file-name . tramp-handle-find-backup-file-name)
1981 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
1982 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
1983 (dired-compress-file . tramp-handle-dired-compress-file)
1984 (dired-call-process . tramp-handle-dired-call-process)
1985 (dired-recursive-delete-directory
1986 . tramp-handle-dired-recursive-delete-directory)
1987 (set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
1988 (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime))
1989 "Alist of handler functions.
1990 Operations not mentioned here will be handled by the normal Emacs functions.")
1992 ;; Handlers for partial tramp file names. For Emacs just
1993 ;; `file-name-all-completions' is needed.
1995 (defconst tramp-completion-file-name-handler-alist
1996 '((file-name-all-completions . tramp-completion-handle-file-name-all-completions)
1997 (file-name-completion . tramp-completion-handle-file-name-completion))
1998 "Alist of completion handler functions.
1999 Used for file names matching `tramp-file-name-regexp'. Operations not
2000 mentioned here will be handled by `tramp-file-name-handler-alist' or the
2001 normal Emacs functions.")
2003 ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here.
2004 (defvar tramp-foreign-file-name-handler-alist
2005 ;; (identity . tramp-sh-file-name-handler) should always be the last
2006 ;; entry, since `identity' always matches.
2007 '((identity . tramp-sh-file-name-handler))
2008 "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially.
2009 If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by
2012 ;;; Internal functions which must come first.
2014 (defsubst tramp-message (level fmt-string &rest args)
2015 "Emit a message depending on verbosity level.
2016 First arg LEVEL says to be quiet if `tramp-verbose' is less than LEVEL. The
2017 message is emitted only if `tramp-verbose' is greater than or equal to LEVEL.
2018 Calls function `message' with FMT-STRING as control string and the remaining
2019 ARGS to actually emit the message (if applicable).
2021 This function expects to be called from the tramp buffer only!"
2022 (when (<= level tramp-verbose)
2023 (apply #'message (concat "tramp: " fmt-string) args)
2024 (when tramp-debug-buffer
2027 (tramp-get-debug-buffer
2028 tramp-current-multi-method tramp-current-method
2029 tramp-current-user tramp-current-host))
2030 (goto-char (point-max))
2033 (tramp-insert-with-face
2035 (concat "# " (apply #'format fmt-string args) "\n"))))))
2037 (defun tramp-message-for-buffer
2038 (multi-method method user host level fmt-string &rest args)
2039 "Like `tramp-message' but temporarily switches to the tramp buffer.
2040 First three args METHOD, USER, and HOST identify the tramp buffer to use,
2041 remaining args passed to `tramp-message'."
2043 (set-buffer (tramp-get-buffer multi-method method user host))
2044 (apply 'tramp-message level fmt-string args)))
2046 (defsubst tramp-line-end-position nil
2047 "Return point at end of line.
2048 Calls `line-end-position' or `point-at-eol' if defined, else
2049 own implementation."
2051 ((fboundp 'line-end-position) (funcall (symbol-function 'line-end-position)))
2052 ((fboundp 'point-at-eol) (funcall (symbol-function 'point-at-eol)))
2053 (t (save-excursion (end-of-line) (point)))))
2055 (defmacro with-parsed-tramp-file-name (filename var &rest body)
2056 "Parse a Tramp filename and make components available in the body.
2058 First arg FILENAME is evaluated and dissected into its components.
2059 Second arg VAR is a symbol. It is used as a variable name to hold
2060 the filename structure. It is also used as a prefix for the variables
2061 holding the components. For example, if VAR is the symbol `foo', then
2062 `foo' will be bound to the whole structure, `foo-multi-method' will
2063 be bound to the multi-method component, and so on for `foo-method',
2064 `foo-user', `foo-host', `foo-localname'.
2066 Remaining args are Lisp expressions to be evaluated (inside an implicit
2069 If VAR is nil, then we bind `v' to the structure and `multi-method',
2070 `method', `user', `host', `localname' to the components."
2071 `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename))
2072 (,(if var (intern (concat (symbol-name var) "-multi-method")) 'multi-method)
2073 (tramp-file-name-multi-method ,(or var 'v)))
2074 (,(if var (intern (concat (symbol-name var) "-method")) 'method)
2075 (tramp-file-name-method ,(or var 'v)))
2076 (,(if var (intern (concat (symbol-name var) "-user")) 'user)
2077 (tramp-file-name-user ,(or var 'v)))
2078 (,(if var (intern (concat (symbol-name var) "-host")) 'host)
2079 (tramp-file-name-host ,(or var 'v)))
2080 (,(if var (intern (concat (symbol-name var) "-localname")) 'localname)
2081 (tramp-file-name-localname ,(or var 'v))))
2084 (put 'with-parsed-tramp-file-name 'lisp-indent-function 2)
2085 ;; Enable debugging.
2087 (when (featurep 'edebug)
2088 (def-edebug-spec with-parsed-tramp-file-name (form symbolp body))))
2089 ;; Highlight as keyword.
2090 (when (functionp 'font-lock-add-keywords)
2091 (funcall 'font-lock-add-keywords
2092 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>")))
2094 (defmacro tramp-let-maybe (variable value &rest body)
2095 "Let-bind VARIABLE to VALUE in BODY, but only if VARIABLE is not obsolete.
2096 BODY is executed whether or not the variable is obsolete.
2097 The intent is to protect against `obsolete variable' warnings."
2098 `(if (get ',variable 'byte-obsolete-variable)
2100 (let ((,variable ,value))
2102 (put 'tramp-let-maybe 'lisp-indent-function 2)
2103 (put 'tramp-let-maybe 'edebug-form-spec t)
2105 ;;; Config Manipulation Functions:
2107 (defun tramp-set-completion-function (method function-list)
2108 "Sets the list of completion functions for METHOD.
2109 FUNCTION-LIST is a list of entries of the form (FUNCTION FILE).
2110 The FUNCTION is intended to parse FILE according its syntax.
2111 It might be a predefined FUNCTION, or a user defined FUNCTION.
2112 Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts',
2113 `tramp-parse-sconfig',`tramp-parse-hosts', `tramp-parse-passwd',
2114 and `tramp-parse-netrc'.
2118 (tramp-set-completion-function
2120 '((tramp-parse-sconfig \"/etc/ssh_config\")
2121 (tramp-parse-sconfig \"~/.ssh/config\")))"
2123 (let ((r function-list)
2125 (setq tramp-completion-function-alist
2126 (delete (assoc method tramp-completion-function-alist)
2127 tramp-completion-function-alist))
2130 ;; Remove double entries
2131 (when (member (car v) (cdr v))
2132 (setcdr v (delete (car v) (cdr v))))
2133 ;; Check for function and file
2134 (unless (and (functionp (nth 0 (car v)))
2135 (file-exists-p (nth 1 (car v))))
2136 (setq r (delete (car v) r)))
2140 (add-to-list 'tramp-completion-function-alist
2143 (defun tramp-get-completion-function (method)
2144 "Returns list of completion functions for METHOD.
2145 For definition of that list see `tramp-set-completion-function'."
2146 (cdr (assoc method tramp-completion-function-alist)))
2148 ;;; File Name Handler Functions:
2150 (defun tramp-handle-make-symbolic-link
2151 (filename linkname &optional ok-if-already-exists)
2152 "Like `make-symbolic-link' for tramp files.
2153 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
2154 the symlink. If LINKNAME is a Tramp file, only the localname component is
2155 used as the target of the symlink.
2157 If LINKNAME is a Tramp file and the localname component is relative, then
2158 it is expanded first, before the localname component is taken. Note that
2159 this can give surprising results if the user/host for the source and
2160 target of the symlink differ."
2161 (with-parsed-tramp-file-name linkname l
2162 (let ((ln (tramp-get-remote-ln l-multi-method l-method l-user l-host))
2163 (cwd (file-name-directory l-localname)))
2166 (list "Making a symbolic link."
2167 "ln(1) does not exist on the remote host.")))
2169 ;; Do the 'confirm if exists' thing.
2170 (when (file-exists-p linkname)
2172 (if (or (null ok-if-already-exists) ; not allowed to exist
2173 (and (numberp ok-if-already-exists)
2176 "File %s already exists; make it a link anyway? "
2178 (signal 'file-already-exists (list "File already exists" l-localname))
2179 (delete-file linkname)))
2181 ;; If FILENAME is a Tramp name, use just the localname component.
2182 (when (tramp-tramp-file-p filename)
2183 (setq filename (tramp-file-name-localname
2184 (tramp-dissect-file-name
2185 (expand-file-name filename)))))
2187 ;; Right, they are on the same host, regardless of user, method, etc.
2188 ;; We now make the link on the remote machine. This will occur as the user
2189 ;; that FILENAME belongs to.
2191 (tramp-send-command-and-check
2192 l-multi-method l-method l-user l-host
2193 (format "cd %s && %s -sf %s %s"
2200 (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix)
2201 "Like `load' for tramp files. Not implemented!"
2202 (unless (file-name-absolute-p file)
2203 (error "Tramp cannot `load' files without absolute file name"))
2204 (with-parsed-tramp-file-name file nil
2206 (cond ((file-exists-p (concat file ".elc"))
2207 (setq file (concat file ".elc")))
2208 ((file-exists-p (concat file ".el"))
2209 (setq file (concat file ".el")))))
2211 ;; The first condition is always true for absolute file names.
2212 ;; Included for safety's sake.
2213 (unless (or (file-name-directory file)
2214 (string-match "\\.elc?\\'" file))
2215 (error "File `%s' does not include a `.el' or `.elc' suffix"
2218 (when (not (file-exists-p file))
2219 (error "Cannot load nonexistent file `%s'" file)))
2220 (if (not (file-exists-p file))
2223 (message "Loading %s..." file))
2224 (let ((local-copy (file-local-copy file)))
2225 ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil.
2226 (load local-copy noerror t t)
2227 (delete-file local-copy))
2229 (message "Loading %s...done" file))
2232 ;; Localname manipulation functions that grok TRAMP localnames...
2233 (defun tramp-handle-file-name-directory (file)
2234 "Like `file-name-directory' but aware of TRAMP files."
2235 ;; Everything except the last filename thing is the directory.
2236 (with-parsed-tramp-file-name file nil
2237 ;; Run the command on the localname portion only.
2238 (tramp-make-tramp-file-name
2239 multi-method method user host (file-name-directory (or localname "")))))
2241 (defun tramp-handle-file-name-nondirectory (file)
2242 "Like `file-name-nondirectory' but aware of TRAMP files."
2243 (with-parsed-tramp-file-name file nil
2244 (file-name-nondirectory localname)))
2246 (defun tramp-handle-file-truename (filename &optional counter prev-dirs)
2247 "Like `file-truename' for tramp files."
2248 (with-parsed-tramp-file-name (expand-file-name filename) nil
2249 (let* ((steps (tramp-split-string localname "/"))
2250 (localnamedir (tramp-let-maybe directory-sep-char ?/ ;for XEmacs
2251 (file-name-as-directory localname)))
2252 (is-dir (string= localname localnamedir))
2255 ;; Don't make the following value larger than necessary.
2256 ;; People expect an error message in a timely fashion when
2257 ;; something is wrong; otherwise they might think that Emacs
2258 ;; is hung. Of course, correctness has to come first.
2260 (result nil) ;result steps in reverse order
2262 (tramp-message-for-buffer
2263 multi-method method user host
2264 10 "Finding true name for `%s'" filename)
2265 (while (and steps (< numchase numchase-limit))
2266 (setq thisstep (pop steps))
2267 (tramp-message-for-buffer
2268 multi-method method user host
2270 (mapconcat 'identity
2271 (append '("") (reverse result) (list thisstep))
2273 (setq symlink-target
2274 (nth 0 (file-attributes
2275 (tramp-make-tramp-file-name
2276 multi-method method user host
2277 (mapconcat 'identity
2282 (cond ((string= "." thisstep)
2283 (tramp-message-for-buffer multi-method method user host
2284 10 "Ignoring step `.'"))
2285 ((string= ".." thisstep)
2286 (tramp-message-for-buffer multi-method method user host
2287 10 "Processing step `..'")
2289 ((stringp symlink-target)
2290 ;; It's a symlink, follow it.
2291 (tramp-message-for-buffer
2292 multi-method method user host
2293 10 "Follow symlink to %s" symlink-target)
2294 (setq numchase (1+ numchase))
2295 (when (file-name-absolute-p symlink-target)
2297 ;; If the symlink was absolute, we'll get a string like
2298 ;; "/user@host:/some/target"; extract the
2299 ;; "/some/target" part from it.
2300 (when (tramp-tramp-file-p symlink-target)
2301 (with-parsed-tramp-file-name symlink-target sym
2302 (unless (equal (list multi-method method user host)
2303 (list sym-multi-method sym-method
2305 (error "Symlink target `%s' on wrong host"
2307 (setq symlink-target localname)))
2309 (append (tramp-split-string symlink-target "/") steps)))
2312 (setq result (cons thisstep result)))))
2313 (when (>= numchase numchase-limit)
2314 (error "Maximum number (%d) of symlinks exceeded" numchase-limit))
2315 (setq result (reverse result))
2316 ;; Combine list to form string.
2319 (mapconcat 'identity (cons "" result) "/")
2321 (when (and is-dir (or (string= "" result)
2322 (not (string= (substring result -1) "/"))))
2323 (setq result (concat result "/")))
2324 (tramp-message-for-buffer
2325 multi-method method user host
2326 10 "True name of `%s' is `%s'" filename result)
2327 (tramp-make-tramp-file-name
2328 multi-method method user host result))))
2332 (defun tramp-handle-file-exists-p (filename)
2333 "Like `file-exists-p' for tramp files."
2334 (with-parsed-tramp-file-name filename nil
2336 (zerop (tramp-send-command-and-check
2337 multi-method method user host
2339 (tramp-get-file-exists-command multi-method method user host)
2340 (tramp-shell-quote-argument localname)))))))
2342 ;; Devices must distinguish physical file systems. The device numbers
2343 ;; provided by "lstat" aren't unique, because we operate on different hosts.
2344 ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and
2345 ;; EFS use device number "-1". In order to be different, we use device number
2346 ;; (-1 x), whereby "x" is unique for a given (multi-method method user host).
2347 (defvar tramp-devices nil
2348 "Keeps virtual device numbers.")
2350 ;; CCC: This should check for an error condition and signal failure
2351 ;; when something goes wrong.
2352 ;; Daniel Pittman <daniel@danann.net>
2353 (defun tramp-handle-file-attributes (filename &optional id-format)
2354 "Like `file-attributes' for tramp files."
2355 (when (file-exists-p filename)
2356 ;; file exists, find out stuff
2357 (unless id-format (setq id-format 'integer))
2358 (with-parsed-tramp-file-name filename nil
2360 (tramp-convert-file-attributes
2361 multi-method method user host
2362 (if (tramp-get-remote-perl multi-method method user host)
2363 (tramp-handle-file-attributes-with-perl multi-method method user host
2364 localname id-format)
2365 (tramp-handle-file-attributes-with-ls multi-method method user host
2366 localname id-format)))))))
2368 (defun tramp-handle-file-attributes-with-ls
2369 (multi-method method user host localname &optional id-format)
2370 "Implement `file-attributes' for tramp files using the ls(1) command."
2372 res-inode res-filemodes res-numlinks
2373 res-uid res-gid res-size res-symlink-target)
2374 (tramp-message-for-buffer multi-method method user host 10
2375 "file attributes with ls: %s"
2376 (tramp-make-tramp-file-name
2377 multi-method method user host localname))
2379 multi-method method user host
2381 (tramp-get-ls-command multi-method method user host)
2382 (if (eq id-format 'integer) "-ildn" "-ild")
2383 (tramp-shell-quote-argument localname)))
2384 (tramp-wait-for-output)
2385 ;; parse `ls -l' output ...
2389 (read (current-buffer))
2390 (invalid-read-syntax
2391 (when (and (equal (cadr err)
2392 "Integer constant overflow in reader")
2394 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
2396 (let* ((big (read (substring (car (cddr err)) 0
2397 (match-beginning 1))))
2398 (small (read (match-string 1 (car (cddr err)))))
2399 (twiddle (/ small 65536)))
2400 (cons (+ big twiddle)
2401 (- small (* twiddle 65536))))))))
2402 ;; ... file mode flags
2403 (setq res-filemodes (symbol-name (read (current-buffer))))
2405 (setq res-numlinks (read (current-buffer)))
2407 (setq res-uid (read (current-buffer)))
2408 (setq res-gid (read (current-buffer)))
2409 (when (eq id-format 'integer)
2410 (unless (numberp res-uid) (setq res-uid -1))
2411 (unless (numberp res-gid) (setq res-gid -1)))
2413 (setq res-size (read (current-buffer)))
2414 ;; From the file modes, figure out other stuff.
2415 (setq symlinkp (eq ?l (aref res-filemodes 0)))
2416 (setq dirp (eq ?d (aref res-filemodes 0)))
2417 ;; if symlink, find out file name pointed to
2419 (search-forward "-> ")
2420 (setq res-symlink-target
2421 (buffer-substring (point)
2422 (tramp-line-end-position))))
2423 ;; return data gathered
2425 ;; 0. t for directory, string (name linked to) for symbolic
2427 (or dirp res-symlink-target nil)
2428 ;; 1. Number of links to file.
2434 ;; 4. Last access time, as a list of two integers. First
2435 ;; integer has high-order 16 bits of time, second has low 16
2437 ;; 5. Last modification time, likewise.
2438 ;; 6. Last status change time, likewise.
2439 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
2440 ;; 7. Size in bytes (-1, if number is out of range).
2442 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
2444 ;; 9. t if file's gid would change if file were deleted and
2445 ;; recreated. Will be set in `tramp-convert-file-attributes'
2447 ;; 10. inode number.
2449 ;; 11. Device number. Will be replaced by a virtual device number.
2453 (defun tramp-handle-file-attributes-with-perl
2454 (multi-method method user host localname &optional id-format)
2455 "Implement `file-attributes' for tramp files using a Perl script."
2456 (tramp-message-for-buffer multi-method method user host 10
2457 "file attributes with perl: %s"
2458 (tramp-make-tramp-file-name
2459 multi-method method user host localname))
2460 (tramp-maybe-send-perl-script multi-method method user host
2461 tramp-perl-file-attributes
2462 "tramp_file_attributes")
2463 (tramp-send-command multi-method method user host
2464 (format "tramp_file_attributes %s %s"
2465 (tramp-shell-quote-argument localname) id-format))
2466 (tramp-wait-for-output)
2467 (read (current-buffer)))
2469 (defun tramp-handle-set-visited-file-modtime (&optional time-list)
2470 "Like `set-visited-file-modtime' for tramp files."
2471 (unless (buffer-file-name)
2472 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
2475 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
2476 (let ((f (buffer-file-name))
2478 (with-parsed-tramp-file-name f nil
2479 (let* ((attr (file-attributes f))
2480 ;; '(-1 65535) means file doesn't exists yet.
2481 (modtime (or (nth 5 attr) '(-1 65535))))
2482 (when (boundp 'last-coding-system-used)
2483 (setq coding-system-used (symbol-value 'last-coding-system-used)))
2484 ;; We use '(0 0) as a don't-know value. See also
2485 ;; `tramp-handle-file-attributes-with-ls'.
2486 (if (not (equal modtime '(0 0)))
2487 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
2490 multi-method method user host
2491 (format "%s -ild %s"
2492 (tramp-get-ls-command multi-method method user host)
2493 (tramp-shell-quote-argument localname)))
2494 (tramp-wait-for-output)
2495 (setq attr (buffer-substring (point)
2496 (progn (end-of-line) (point)))))
2497 (setq tramp-buffer-file-attributes attr))
2498 (when (boundp 'last-coding-system-used)
2499 (set 'last-coding-system-used coding-system-used))
2502 ;; CCC continue here
2504 ;; This function makes the same assumption as
2505 ;; `tramp-handle-set-visited-file-modtime'.
2506 (defun tramp-handle-verify-visited-file-modtime (buf)
2507 "Like `verify-visited-file-modtime' for tramp files.
2508 At the time `verify-visited-file-modtime' calls this function, we
2509 already know that the buffer is visiting a file and that
2510 `visited-file-modtime' does not return 0. Do not call this
2511 function directly, unless those two cases are already taken care
2513 (with-current-buffer buf
2514 ;; There is no file visiting the buffer, or the buffer has no
2515 ;; recorded last modification time.
2516 (if (or (not (buffer-file-name))
2517 (eq (visited-file-modtime) 0))
2519 (let ((f (buffer-file-name)))
2520 (with-parsed-tramp-file-name f nil
2521 (let* ((attr (file-attributes f))
2522 (modtime (nth 5 attr))
2523 (mt (visited-file-modtime)))
2526 ;; file exists, and has a known modtime.
2527 ((and attr (not (equal modtime '(0 0))))
2528 (< (abs (tramp-time-diff
2530 ;; For compatibility, deal with both the old
2531 ;; (HIGH . LOW) and the new (HIGH LOW)
2532 ;; return values of `visited-file-modtime'.
2534 (list (car mt) (cdr mt))
2537 ;; modtime has the don't know value.
2541 multi-method method user host
2542 (format "%s -ild %s"
2543 (tramp-get-ls-command multi-method method user host)
2544 (tramp-shell-quote-argument localname)))
2545 (tramp-wait-for-output)
2546 (setq attr (buffer-substring
2547 (point) (progn (end-of-line) (point)))))
2548 (equal tramp-buffer-file-attributes attr))
2549 ;; If file does not exist, say it is not modified
2550 ;; if and only if that agrees with the buffer's record.
2551 (t (equal mt '(-1 65535))))))))))
2553 (defun tramp-handle-set-file-modes (filename mode)
2554 "Like `set-file-modes' for tramp files."
2555 (with-parsed-tramp-file-name filename nil
2557 (unless (zerop (tramp-send-command-and-check
2558 multi-method method user host
2559 (format "chmod %s %s"
2560 (tramp-decimal-to-octal mode)
2561 (tramp-shell-quote-argument localname))))
2564 ;; FIXME: extract the proper text from chmod's stderr.
2565 "error while changing file's mode"
2568 ;; Simple functions using the `test' command.
2570 (defun tramp-handle-file-executable-p (filename)
2571 "Like `file-executable-p' for tramp files."
2572 (with-parsed-tramp-file-name filename nil
2573 (zerop (tramp-run-test "-x" filename))))
2575 (defun tramp-handle-file-readable-p (filename)
2576 "Like `file-readable-p' for tramp files."
2577 (with-parsed-tramp-file-name filename nil
2578 (zerop (tramp-run-test "-r" filename))))
2580 (defun tramp-handle-file-accessible-directory-p (filename)
2581 "Like `file-accessible-directory-p' for tramp files."
2582 (with-parsed-tramp-file-name filename nil
2583 (and (zerop (tramp-run-test "-d" filename))
2584 (zerop (tramp-run-test "-r" filename))
2585 (zerop (tramp-run-test "-x" filename)))))
2587 ;; When the remote shell is started, it looks for a shell which groks
2588 ;; tilde expansion. Here, we assume that all shells which grok tilde
2589 ;; expansion will also provide a `test' command which groks `-nt' (for
2590 ;; newer than). If this breaks, tell me about it and I'll try to do
2591 ;; something smarter about it.
2592 (defun tramp-handle-file-newer-than-file-p (file1 file2)
2593 "Like `file-newer-than-file-p' for tramp files."
2594 (cond ((not (file-exists-p file1))
2596 ((not (file-exists-p file2))
2598 ;; We are sure both files exist at this point.
2601 ;; We try to get the mtime of both files. If they are not
2602 ;; equal to the "dont-know" value, then we subtract the times
2603 ;; and obtain the result.
2604 (let ((fa1 (file-attributes file1))
2605 (fa2 (file-attributes file2)))
2606 (if (and (not (equal (nth 5 fa1) '(0 0)))
2607 (not (equal (nth 5 fa2) '(0 0))))
2608 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
2609 ;; If one of them is the dont-know value, then we can
2610 ;; still try to run a shell command on the remote host.
2611 ;; However, this only works if both files are Tramp
2612 ;; files and both have the same method, same user, same
2614 (unless (and (tramp-tramp-file-p file1)
2615 (tramp-tramp-file-p file2))
2619 "Cannot check if Tramp file is newer than non-Tramp file"
2621 (with-parsed-tramp-file-name file1 v1
2622 (with-parsed-tramp-file-name file2 v2
2623 (unless (and (equal v1-multi-method v2-multi-method)
2624 (equal v1-method v2-method)
2625 (equal v1-user v2-user)
2626 (equal v1-host v2-host))
2628 (list "Files must have same method, user, host"
2630 (unless (and (tramp-tramp-file-p file1)
2631 (tramp-tramp-file-p file2))
2633 (list "Files must be tramp files on same host"
2635 (if (tramp-get-test-groks-nt
2636 v1-multi-method v1-method v1-user v1-host)
2637 (zerop (tramp-run-test2 "test" file1 file2 "-nt"))
2638 (zerop (tramp-run-test2
2639 "tramp_test_nt" file1 file2)))))))))))
2641 ;; Functions implemented using the basic functions above.
2643 (defun tramp-handle-file-modes (filename)
2644 "Like `file-modes' for tramp files."
2645 (with-parsed-tramp-file-name filename nil
2646 (when (file-exists-p filename)
2647 (tramp-mode-string-to-int
2648 (nth 8 (file-attributes filename))))))
2650 (defun tramp-handle-file-directory-p (filename)
2651 "Like `file-directory-p' for tramp files."
2652 ;; Care must be taken that this function returns `t' for symlinks
2653 ;; pointing to directories. Surely the most obvious implementation
2654 ;; would be `test -d', but that returns false for such symlinks.
2655 ;; CCC: Stefan Monnier says that `test -d' follows symlinks. And
2656 ;; I now think he's right. So we could be using `test -d', couldn't
2659 ;; Alternatives: `cd %s', `test -d %s'
2660 (with-parsed-tramp-file-name filename nil
2663 (tramp-send-command-and-check
2664 multi-method method user host
2665 (format "test -d %s"
2666 (tramp-shell-quote-argument localname))
2667 t))))) ;run command in subshell
2669 (defun tramp-handle-file-regular-p (filename)
2670 "Like `file-regular-p' for tramp files."
2671 (with-parsed-tramp-file-name filename nil
2672 (and (file-exists-p filename)
2673 (eq ?- (aref (nth 8 (file-attributes filename)) 0)))))
2675 (defun tramp-handle-file-symlink-p (filename)
2676 "Like `file-symlink-p' for tramp files."
2677 (with-parsed-tramp-file-name filename nil
2678 (let ((x (car (file-attributes filename))))
2680 ;; When Tramp is running on VMS, then `file-name-absolute-p'
2681 ;; might do weird things.
2682 (if (file-name-absolute-p x)
2683 (tramp-make-tramp-file-name
2684 multi-method method user host x)
2687 (defun tramp-handle-file-writable-p (filename)
2688 "Like `file-writable-p' for tramp files."
2689 (with-parsed-tramp-file-name filename nil
2690 (if (file-exists-p filename)
2691 ;; Existing files must be writable.
2692 (zerop (tramp-run-test "-w" filename))
2693 ;; If file doesn't exist, check if directory is writable.
2694 (and (zerop (tramp-run-test
2695 "-d" (file-name-directory filename)))
2696 (zerop (tramp-run-test
2697 "-w" (file-name-directory filename)))))))
2699 (defun tramp-handle-file-ownership-preserved-p (filename)
2700 "Like `file-ownership-preserved-p' for tramp files."
2701 (with-parsed-tramp-file-name filename nil
2702 (let ((attributes (file-attributes filename)))
2703 ;; Return t if the file doesn't exist, since it's true that no
2704 ;; information would be lost by an (attempted) delete and create.
2705 (or (null attributes)
2706 (= (nth 2 attributes)
2707 (tramp-get-remote-uid multi-method method user host))))))
2709 ;; Other file name ops.
2711 ;; ;; Matthias K
\e,Av
\e(Bppe <mkoeppe@mail.math.uni-magdeburg.de>
2712 ;; (defun tramp-handle-directory-file-name (directory)
2713 ;; "Like `directory-file-name' for tramp files."
2714 ;; (if (and (eq (aref directory (- (length directory) 1)) ?/)
2715 ;; (not (eq (aref directory (- (length directory) 2)) ?:)))
2716 ;; (substring directory 0 (- (length directory) 1))
2719 ;; ;; Philippe Troin <phil@fifi.org>
2720 ;; (defun tramp-handle-directory-file-name (directory)
2721 ;; "Like `directory-file-name' for tramp files."
2722 ;; (with-parsed-tramp-file-name directory nil
2723 ;; (let ((directory-length-1 (1- (length directory))))
2725 ;; (if (and (eq (aref directory directory-length-1) ?/)
2726 ;; (eq (string-match tramp-file-name-regexp directory) 0)
2727 ;; (/= (match-end 0) directory-length-1))
2728 ;; (substring directory 0 directory-length-1)
2731 (defun tramp-handle-directory-file-name (directory)
2732 "Like `directory-file-name' for tramp files."
2733 ;; If localname component of filename is "/", leave it unchanged.
2734 ;; Otherwise, remove any trailing slash from localname component.
2735 ;; Method, host, etc, are unchanged. Does it make sense to try
2736 ;; to avoid parsing the filename?
2737 (with-parsed-tramp-file-name directory nil
2738 (if (and (not (zerop (length localname)))
2739 (eq (aref localname (1- (length localname))) ?/)
2740 (not (string= localname "/")))
2741 (substring directory 0 -1)
2744 ;; Directory listings.
2746 (defun tramp-handle-directory-files (directory
2747 &optional full match nosort files-only)
2748 "Like `directory-files' for tramp files."
2749 (with-parsed-tramp-file-name directory nil
2752 (tramp-barf-unless-okay
2753 multi-method method user host
2754 (concat "cd " (tramp-shell-quote-argument localname))
2757 "tramp-handle-directory-files: couldn't `cd %s'"
2758 (tramp-shell-quote-argument localname))
2760 multi-method method user host
2761 (concat (tramp-get-ls-command multi-method method user host)
2763 (tramp-wait-for-output)
2764 (goto-char (point-max))
2765 (while (zerop (forward-line -1))
2766 (setq x (buffer-substring (point)
2767 (tramp-line-end-position)))
2768 (when (or (not match) (string-match match x))
2770 (push (concat (file-name-as-directory directory)
2774 (tramp-send-command multi-method method user host "cd")
2775 (tramp-wait-for-output)
2776 ;; Remove non-files or non-directories if necessary. Using
2777 ;; the remote shell for this would probably be way faster.
2778 ;; Maybe something could be adapted from
2779 ;; tramp-handle-file-name-all-completions.
2781 (let ((temp (nreverse result))
2784 (if (equal files-only t)
2787 (setq item (pop temp))
2788 (when (file-regular-p item)
2789 (push item result)))
2792 (setq item (pop temp))
2793 (when (file-directory-p item)
2794 (push item result)))))))
2797 (defun tramp-handle-directory-files-and-attributes
2798 (directory &optional full match nosort id-format)
2799 "Like `directory-files-and-attributes' for tramp files."
2800 (when (tramp-handle-file-exists-p directory)
2802 (setq directory (tramp-handle-expand-file-name directory))
2803 (with-parsed-tramp-file-name directory nil
2804 (tramp-maybe-send-perl-script multi-method method user host
2805 tramp-perl-directory-files-and-attributes
2806 "tramp_directory_files_and_attributes")
2807 (tramp-send-command multi-method method user host
2808 (format "tramp_directory_files_and_attributes %s %s"
2809 (tramp-shell-quote-argument localname)
2810 (or id-format 'integer)))
2811 (tramp-wait-for-output)
2812 (let* ((root (cons nil (let ((object (read (current-buffer))))
2813 (when (stringp object)
2818 (if (and match (not (string-match match (car (cadr cell)))))
2820 (setcdr cell (cddr cell))
2822 (setq cell (cdr cell))
2823 (let ((l (car cell)))
2824 (tramp-convert-file-attributes multi-method method user host
2826 ;; If FULL, make file name absolute
2827 (when full (setcar l (concat directory "/" (car l)))))))
2830 (sort (cdr root) (lambda (x y) (string< (car x) (car y))))))))))
2832 ;; This function should return "foo/" for directories and "bar" for
2833 ;; files. We use `ls -ad' to get a list of files (including
2834 ;; directories), and `find . -type d \! -name . -prune' to get a list
2836 (defun tramp-handle-file-name-all-completions (filename directory)
2837 "Like `file-name-all-completions' for tramp files."
2838 (with-parsed-tramp-file-name directory nil
2839 (unless (save-match-data (string-match "/" filename))
2840 (let* ((nowild tramp-completion-without-shell-p)
2843 (tramp-barf-unless-okay
2844 multi-method method user host
2845 (format "cd %s" (tramp-shell-quote-argument localname))
2847 "tramp-handle-file-name-all-completions: Couldn't `cd %s'"
2848 (tramp-shell-quote-argument localname))
2850 ;; Get a list of directories and files, including reliably
2851 ;; tagging the directories with a trailing '/'. Because I
2852 ;; rock. --daniel@danann.net
2854 multi-method method user host
2855 (format (concat "%s -a %s 2>/dev/null | while read f; do "
2856 "if test -d \"$f\" 2>/dev/null; "
2857 "then echo \"$f/\"; else echo \"$f\"; fi; done")
2858 (tramp-get-ls-command multi-method method user host)
2859 (if (or nowild (zerop (length filename)))
2862 (tramp-shell-quote-argument filename)))))
2864 ;; Now grab the output.
2865 (tramp-wait-for-output)
2866 (goto-char (point-max))
2867 (while (zerop (forward-line -1))
2868 (push (buffer-substring (point)
2869 (tramp-line-end-position))
2872 (tramp-send-command multi-method method user host "cd")
2873 (tramp-wait-for-output)
2877 (all-completions filename (mapcar 'list result))
2881 ;; The following isn't needed for Emacs 20 but for 19.34?
2882 (defun tramp-handle-file-name-completion
2883 (filename directory &optional predicate)
2884 "Like `file-name-completion' for tramp files."
2885 (unless (tramp-tramp-file-p directory)
2887 "tramp-handle-file-name-completion invoked on non-tramp directory `%s'"
2891 (mapcar 'list (file-name-all-completions filename directory))
2893 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
2897 (defun tramp-handle-add-name-to-file
2898 (filename newname &optional ok-if-already-exists)
2899 "Like `add-name-to-file' for tramp files."
2900 (with-parsed-tramp-file-name filename v1
2901 (with-parsed-tramp-file-name newname v2
2902 (let ((ln (when v1 (tramp-get-remote-ln
2903 v1-multi-method v1-method v1-user v1-host))))
2904 (unless (and v1-method v2-method v1-user v2-user v1-host v2-host
2905 (equal v1-multi-method v2-multi-method)
2906 (equal v1-method v2-method)
2907 (equal v1-user v2-user)
2908 (equal v1-host v2-host))
2909 (error "add-name-to-file: %s"
2910 "only implemented for same method, same user, same host"))
2911 (when (and (not ok-if-already-exists)
2912 (file-exists-p newname)
2913 (not (numberp ok-if-already-exists))
2916 "File %s already exists; make it a new name anyway? "
2918 (error "add-name-to-file: file %s already exists" newname))
2919 (tramp-barf-unless-okay
2920 v1-multi-method v1-method v1-user v1-host
2921 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
2922 (tramp-shell-quote-argument v2-localname))
2924 "error with add-name-to-file, see buffer `%s' for details"
2927 (defun tramp-handle-copy-file
2928 (filename newname &optional ok-if-already-exists keep-date)
2929 "Like `copy-file' for tramp files."
2930 ;; Check if both files are local -- invoke normal copy-file.
2931 ;; Otherwise, use tramp from local system.
2932 (setq filename (expand-file-name filename))
2933 (setq newname (expand-file-name newname))
2934 ;; At least one file a tramp file?
2935 (if (or (tramp-tramp-file-p filename)
2936 (tramp-tramp-file-p newname))
2937 (tramp-do-copy-or-rename-file
2938 'copy filename newname ok-if-already-exists keep-date)
2939 (tramp-run-real-handler
2941 (list filename newname ok-if-already-exists keep-date))))
2943 (defun tramp-handle-rename-file
2944 (filename newname &optional ok-if-already-exists)
2945 "Like `rename-file' for tramp files."
2946 ;; Check if both files are local -- invoke normal rename-file.
2947 ;; Otherwise, use tramp from local system.
2948 (setq filename (expand-file-name filename))
2949 (setq newname (expand-file-name newname))
2950 ;; At least one file a tramp file?
2951 (if (or (tramp-tramp-file-p filename)
2952 (tramp-tramp-file-p newname))
2953 (tramp-do-copy-or-rename-file
2954 'rename filename newname ok-if-already-exists)
2955 (tramp-run-real-handler 'rename-file
2956 (list filename newname ok-if-already-exists))))
2958 (defun tramp-do-copy-or-rename-file
2959 (op filename newname &optional ok-if-already-exists keep-date)
2960 "Copy or rename a remote file.
2961 OP must be `copy' or `rename' and indicates the operation to perform.
2962 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2963 the new file (for copy) or the new name of the file (for rename).
2964 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2965 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2968 This function is invoked by `tramp-handle-copy-file' and
2969 `tramp-handle-rename-file'. It is an error if OP is neither of `copy'
2970 and `rename'. FILENAME and NEWNAME must be absolute file names."
2971 (unless (memq op '(copy rename))
2972 (error "Unknown operation `%s', must be `copy' or `rename'" op))
2973 (unless ok-if-already-exists
2974 (when (file-exists-p newname)
2975 (signal 'file-already-exists
2976 (list "File already exists" newname))))
2977 (let ((t1 (tramp-tramp-file-p filename))
2978 (t2 (tramp-tramp-file-p newname))
2979 v1-multi-method v1-method v1-user v1-host v1-localname
2980 v2-multi-method v2-method v2-user v2-host v2-localname)
2982 ;; Check which ones of source and target are Tramp files.
2983 ;; We cannot invoke `with-parsed-tramp-file-name';
2984 ;; it fails if the file isn't a Tramp file name.
2986 (with-parsed-tramp-file-name filename l
2987 (setq v1-multi-method l-multi-method
2991 v1-localname l-localname))
2992 (setq v1-localname filename))
2994 (with-parsed-tramp-file-name newname l
2995 (setq v2-multi-method l-multi-method
2999 v2-localname l-localname))
3000 (setq v2-localname newname))
3003 ;; Both are Tramp files.
3006 ;; Shortcut: if method, host, user are the same for both
3007 ;; files, we invoke `cp' or `mv' on the remote host
3009 ((and (equal v1-multi-method v2-multi-method)
3010 (equal v1-method v2-method)
3011 (equal v1-user v2-user)
3012 (equal v1-host v2-host))
3013 (tramp-do-copy-or-rename-file-directly
3014 op v1-multi-method v1-method v1-user v1-host
3015 v1-localname v2-localname keep-date))
3016 ;; If both source and target are Tramp files,
3017 ;; both are using the same copy-program, then we
3018 ;; can invoke rcp directly. Note that
3019 ;; default-directory should point to a local
3020 ;; directory if we want to invoke rcp.
3021 ((and (not v1-multi-method)
3022 (not v2-multi-method)
3023 (equal v1-method v2-method)
3024 (tramp-method-out-of-band-p
3025 v1-multi-method v1-method v1-user v1-host)
3026 (not (string-match "\\([^#]*\\)#\\(.*\\)" v1-host))
3027 (not (string-match "\\([^#]*\\)#\\(.*\\)" v2-host)))
3028 (tramp-do-copy-or-rename-file-out-of-band
3029 op filename newname keep-date))
3030 ;; No shortcut was possible. So we copy the
3031 ;; file first. If the operation was `rename', we go
3032 ;; back and delete the original file (if the copy was
3033 ;; successful). The approach is simple-minded: we
3034 ;; create a new buffer, insert the contents of the
3035 ;; source file into it, then write out the buffer to
3036 ;; the target file. The advantage is that it doesn't
3037 ;; matter which filename handlers are used for the
3038 ;; source and target file.
3040 (tramp-do-copy-or-rename-file-via-buffer
3041 op filename newname keep-date))))
3043 ;; One file is a Tramp file, the other one is local.
3045 ;; If the Tramp file has an out-of-band method, the corresponding
3046 ;; copy-program can be invoked.
3047 (if (and (not v1-multi-method)
3048 (not v2-multi-method)
3049 (or (and t1 (tramp-method-out-of-band-p
3050 v1-multi-method v1-method v1-user v1-host))
3051 (and t2 (tramp-method-out-of-band-p
3052 v2-multi-method v2-method v2-user v2-host))))
3053 (tramp-do-copy-or-rename-file-out-of-band
3054 op filename newname keep-date)
3055 ;; Use the generic method via a Tramp buffer.
3056 (tramp-do-copy-or-rename-file-via-buffer
3057 op filename newname keep-date)))
3060 ;; One of them must be a Tramp file.
3061 (error "Tramp implementation says this cannot happen")))))
3063 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
3064 "Use an Emacs buffer to copy or rename a file.
3065 First arg OP is either `copy' or `rename' and indicates the operation.
3066 FILENAME is the source file, NEWNAME the target file.
3067 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
3068 (let ((trampbuf (get-buffer-create "*tramp output*"))
3069 (modtime (nth 5 (file-attributes filename))))
3070 (when (and keep-date (or (null modtime) (equal modtime '(0 0))))
3072 1 (concat "Warning: cannot preserve file time stamp"
3073 " with inline copying across machines")))
3075 (set-buffer trampbuf) (erase-buffer)
3076 (insert-file-contents-literally filename)
3077 ;; We don't want the target file to be compressed, so we let-bind
3078 ;; `jka-compr-inhibit' to t.
3079 (let ((coding-system-for-write 'binary)
3080 (jka-compr-inhibit t))
3081 (write-region (point-min) (point-max) newname))
3082 ;; KEEP-DATE handling.
3084 (when (and (not (null modtime))
3085 (not (equal modtime '(0 0))))
3086 (tramp-touch newname modtime)))
3088 (set-file-modes newname (file-modes filename)))
3089 ;; If the operation was `rename', delete the original file.
3090 (unless (eq op 'copy)
3091 (delete-file filename))))
3093 (defun tramp-do-copy-or-rename-file-directly
3094 (op multi-method method user host localname1 localname2 keep-date)
3095 "Invokes `cp' or `mv' on the remote system.
3096 OP must be one of `copy' or `rename', indicating `cp' or `mv',
3097 respectively. METHOD, USER, and HOST specify the connection.
3098 LOCALNAME1 and LOCALNAME2 specify the two arguments of `cp' or `mv'.
3099 If KEEP-DATE is non-nil, preserve the time stamp when copying."
3100 ;; CCC: What happens to the timestamp when renaming?
3101 (let ((cmd (cond ((and (eq op 'copy) keep-date) "cp -f -p")
3102 ((eq op 'copy) "cp -f")
3103 ((eq op 'rename) "mv -f")
3105 "Unknown operation `%s', must be `copy' or `rename'"
3109 multi-method method user host
3112 (tramp-shell-quote-argument localname1)
3113 (tramp-shell-quote-argument localname2)))
3114 (tramp-wait-for-output)
3115 (goto-char (point-min))
3118 (and (eq op 'copy) keep-date
3119 ;; Mask cp -f error.
3120 (re-search-forward tramp-operation-not-permitted-regexp nil t))
3121 (zerop (tramp-send-command-and-check
3122 multi-method method user host nil nil)))
3123 (pop-to-buffer (current-buffer))
3125 (format "Copying directly failed, see buffer `%s' for details."
3128 ;; CCC: Maybe `chmod --reference=localname1 localname2' could be used
3130 (unless (or (eq op 'rename) keep-date)
3132 (tramp-make-tramp-file-name multi-method method user host localname2)
3134 (tramp-make-tramp-file-name
3135 multi-method method user host localname1))))))
3137 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
3138 "Invoke rcp program to copy.
3139 One of FILENAME and NEWNAME must be a Tramp name, the other must
3140 be a local filename. The method used must be an out-of-band method."
3141 (let ((t1 (tramp-tramp-file-p filename))
3142 (t2 (tramp-tramp-file-p newname))
3143 v1-multi-method v1-method v1-user v1-host v1-localname
3144 v2-multi-method v2-method v2-user v2-host v2-localname
3145 multi-method method user host copy-program copy-args
3146 source target trampbuf)
3148 ;; Check which ones of source and target are Tramp files.
3149 ;; We cannot invoke `with-parsed-tramp-file-name';
3150 ;; it fails if the file isn't a Tramp file name.
3152 (with-parsed-tramp-file-name filename l
3153 (setq v1-multi-method l-multi-method
3157 v1-localname l-localname
3158 multi-method l-multi-method
3159 method (tramp-find-method
3160 v1-multi-method v1-method v1-user v1-host)
3163 copy-program (tramp-get-method-parameter
3164 v1-multi-method method
3165 v1-user v1-host 'tramp-copy-program)
3166 copy-args (tramp-get-method-parameter
3167 v1-multi-method method
3168 v1-user v1-host 'tramp-copy-args)))
3169 (setq v1-localname filename))
3172 (with-parsed-tramp-file-name newname l
3173 (setq v2-multi-method l-multi-method
3177 v2-localname l-localname
3178 multi-method l-multi-method
3179 method (tramp-find-method
3180 v2-multi-method v2-method v2-user v2-host)
3183 copy-program (tramp-get-method-parameter
3184 v2-multi-method method
3185 v2-user v2-host 'tramp-copy-program)
3186 copy-args (tramp-get-method-parameter
3187 v2-multi-method method
3188 v2-user v2-host 'tramp-copy-args)))
3189 (setq v2-localname newname))
3191 ;; The following should be changed. We need a more general
3192 ;; mechanism to parse extra host args.
3194 (setq source v1-localname)
3195 (when (string-match "\\([^#]*\\)#\\(.*\\)" v1-host)
3196 (setq copy-args (cons "-P" (cons (match-string 2 v1-host) copy-args)))
3197 (setq v1-host (match-string 1 v1-host)))
3199 (tramp-make-copy-program-file-name
3201 (tramp-shell-quote-argument v1-localname))))
3204 (setq target v2-localname)
3205 (when (string-match "\\([^#]*\\)#\\(.*\\)" v2-host)
3206 (setq copy-args (cons "-P" (cons (match-string 2 v2-host) copy-args)))
3207 (setq v2-host (match-string 1 v2-host)))
3209 (tramp-make-copy-program-file-name
3211 (tramp-shell-quote-argument v2-localname))))
3213 ;; Handle ControlMaster/ControlPath
3218 x `((?t . ,(format "/tmp/%s" tramp-temp-name-prefix)))))
3221 ;; Handle keep-date argument
3225 (cons (tramp-get-method-parameter
3226 v1-multi-method method
3227 v1-user v1-host 'tramp-copy-keep-date-arg)
3230 (cons (tramp-get-method-parameter
3231 v2-multi-method method
3232 v2-user v2-host 'tramp-copy-keep-date-arg)
3235 (setq copy-args (append copy-args (list source target))
3236 trampbuf (generate-new-buffer
3237 (tramp-buffer-name multi-method method user host)))
3239 ;; Use an asynchronous process. By this, password can be handled.
3242 ;; Check for program.
3243 (when (and (fboundp 'executable-find)
3244 (not (executable-find copy-program)))
3245 (error "Cannot find copy program: %s" copy-program))
3247 (set-buffer trampbuf)
3248 (setq tramp-current-multi-method multi-method
3249 tramp-current-method method
3250 tramp-current-user user
3251 tramp-current-host host)
3252 (message "Transferring %s to %s..." filename newname)
3254 ;; Use rcp-like program for file transfer.
3256 (let* ((default-directory
3257 (if (and (stringp default-directory)
3258 (file-accessible-directory-p default-directory))
3260 (tramp-temporary-file-directory)))
3261 (p (apply 'start-process (buffer-name trampbuf) trampbuf
3262 copy-program copy-args)))
3263 (tramp-set-process-query-on-exit-flag p nil)
3264 (tramp-process-actions p multi-method method user host
3265 tramp-actions-copy-out-of-band))
3266 (kill-buffer trampbuf))
3267 (message "Transferring %s to %s...done" filename newname)
3271 (set-file-modes newname (file-modes filename))))
3273 ;; If the operation was `rename', delete the original file.
3274 (unless (eq op 'copy)
3275 (delete-file filename))))
3278 (defun tramp-handle-make-directory (dir &optional parents)
3279 "Like `make-directory' for tramp files."
3280 (setq dir (expand-file-name dir))
3281 (with-parsed-tramp-file-name dir nil
3283 (tramp-barf-unless-okay
3284 multi-method method user host
3286 (if parents "mkdir -p" "mkdir")
3287 (tramp-shell-quote-argument localname))
3289 "Couldn't make directory %s" dir))))
3291 ;; CCC error checking?
3292 (defun tramp-handle-delete-directory (directory)
3293 "Like `delete-directory' for tramp files."
3294 (setq directory (expand-file-name directory))
3295 (with-parsed-tramp-file-name directory nil
3298 multi-method method user host
3299 (format "rmdir %s ; echo ok"
3300 (tramp-shell-quote-argument localname)))
3301 (tramp-wait-for-output))))
3303 (defun tramp-handle-delete-file (filename)
3304 "Like `delete-file' for tramp files."
3305 (setq filename (expand-file-name filename))
3306 (with-parsed-tramp-file-name filename nil
3308 (unless (zerop (tramp-send-command-and-check
3309 multi-method method user host
3311 (tramp-shell-quote-argument localname))))
3312 (signal 'file-error "Couldn't delete Tramp file")))))
3316 ;; CCC: This does not seem to be enough. Something dies when
3317 ;; we try and delete two directories under TRAMP :/
3318 (defun tramp-handle-dired-recursive-delete-directory (filename)
3319 "Recursively delete the directory given.
3320 This is like `dired-recursive-delete-directory' for tramp files."
3321 (with-parsed-tramp-file-name filename nil
3322 ;; run a shell command 'rm -r <localname>'
3323 ;; Code shamelessly stolen for the dired implementation and, um, hacked :)
3324 (or (file-exists-p filename)
3327 (list "Removing old file name" "no such directory" filename)))
3328 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>)
3329 (tramp-send-command multi-method method user host
3330 (format "rm -r %s" (tramp-shell-quote-argument localname)))
3331 ;; Wait for the remote system to return to us...
3332 ;; This might take a while, allow it plenty of time.
3333 (tramp-wait-for-output 120)
3334 ;; Make sure that it worked...
3335 (and (file-exists-p filename)
3336 (error "Failed to recursively delete %s" filename))))
3338 (defun tramp-handle-dired-call-process (program discard &rest arguments)
3339 "Like `dired-call-process' for tramp files."
3340 (with-parsed-tramp-file-name default-directory nil
3342 (tramp-barf-unless-okay
3343 multi-method method user host
3344 (format "cd %s" (tramp-shell-quote-argument localname))
3346 "tramp-handle-dired-call-process: Couldn't `cd %s'"
3347 (tramp-shell-quote-argument localname))
3349 multi-method method user host
3350 (mapconcat #'tramp-shell-quote-argument (cons program arguments) " "))
3351 (tramp-wait-for-output))
3353 ;; We cannot use `insert-buffer' because the tramp buffer
3354 ;; changes its contents before insertion due to calling
3355 ;; `expand-file' and alike.
3357 (with-current-buffer
3358 (tramp-get-buffer multi-method method user host)
3362 (tramp-send-command-and-check multi-method method user host nil)
3363 (tramp-send-command multi-method method user host "cd")
3364 (tramp-wait-for-output)))))
3366 (defun tramp-handle-dired-compress-file (file &rest ok-flag)
3367 "Like `dired-compress-file' for tramp files."
3368 ;; OK-FLAG is valid for XEmacs only, but not implemented.
3369 ;; Code stolen mainly from dired-aux.el.
3370 (with-parsed-tramp-file-name file nil
3373 (if (not (featurep 'xemacs))
3375 (symbol-value 'dired-compress-file-suffixes)
3376 ;; XEmacs has `dired-compression-method-alist', which is
3377 ;; transformed into `dired-compress-file-suffixes' structure.
3380 (list (concat (regexp-quote (nth 1 x)) "\\'")
3382 (mapconcat 'identity (nth 3 x) " ")))
3383 (symbol-value 'dired-compression-method-alist))))
3385 ;; See if any suffix rule matches this file name.
3387 (let (case-fold-search)
3388 (if (string-match (car (car suffixes)) localname)
3389 (setq suffix (car suffixes) suffixes nil))
3390 (setq suffixes (cdr suffixes))))
3392 (cond ((file-symlink-p file)
3394 ((and suffix (nth 2 suffix))
3395 ;; We found an uncompression rule.
3396 (message "Uncompressing %s..." file)
3397 (when (zerop (tramp-send-command-and-check
3398 multi-method method user host
3399 (concat (nth 2 suffix) " " localname)))
3400 (message "Uncompressing %s...done" file)
3401 ;; `dired-remove-file' is not defined in XEmacs
3402 (funcall (symbol-function 'dired-remove-file) file)
3403 (string-match (car suffix) file)
3404 (concat (substring file 0 (match-beginning 0)))))
3406 ;; We don't recognize the file as compressed, so compress it.
3408 (message "Compressing %s..." file)
3409 (when (zerop (tramp-send-command-and-check
3410 multi-method method user host
3411 (concat "gzip -f " localname)))
3412 (message "Compressing %s...done" file)
3413 ;; `dired-remove-file' is not defined in XEmacs
3414 (funcall (symbol-function 'dired-remove-file) file)
3415 (cond ((file-exists-p (concat file ".gz"))
3416 (concat file ".gz"))
3417 ((file-exists-p (concat file ".z"))
3421 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
3422 ;; not sure at all that this is the right way to do it, but let's hope
3423 ;; it works for now, and wait for a guru to point out the Right Way to
3425 ;;(eval-when-compile
3426 ;; (unless (fboundp 'dired-insert-set-properties)
3427 ;; (fset 'dired-insert-set-properties 'ignore)))
3428 ;; Gerd suggests this:
3429 (eval-when-compile (require 'dired))
3430 ;; Note that dired is required at run-time, too, when it is needed.
3431 ;; It is only needed on XEmacs for the function
3432 ;; `dired-insert-set-properties'.
3434 (defun tramp-handle-insert-directory
3435 (filename switches &optional wildcard full-directory-p)
3436 "Like `insert-directory' for tramp files."
3437 (if (and (featurep 'ls-lisp)
3438 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
3439 (tramp-run-real-handler
3440 'insert-directory (list filename switches wildcard full-directory-p))
3441 ;; For the moment, we assume that the remote "ls" program does not
3442 ;; grok "--dired". In the future, we should detect this on
3443 ;; connection setup.
3444 (when (string-match "^--dired\\s-+" switches)
3445 (setq switches (replace-match "" nil t switches)))
3446 (setq filename (expand-file-name filename))
3447 (with-parsed-tramp-file-name filename nil
3448 (tramp-message-for-buffer
3449 multi-method method user host 10
3450 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
3451 switches filename (if wildcard "yes" "no")
3452 (if full-directory-p "yes" "no"))
3454 (setq wildcard (file-name-nondirectory localname))
3455 (setq localname (file-name-directory localname)))
3456 (when (listp switches)
3457 (setq switches (mapconcat 'identity switches " ")))
3458 (unless full-directory-p
3459 (setq switches (concat "-d " switches)))
3461 (setq switches (concat switches " " wildcard)))
3463 ;; If `full-directory-p', we just say `ls -l FILENAME'.
3464 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
3465 (if full-directory-p
3467 multi-method method user host
3469 (tramp-get-ls-command multi-method method user host)
3473 (tramp-shell-quote-argument (concat localname ".")))))
3474 (tramp-barf-unless-okay
3475 multi-method method user host
3476 (format "cd %s" (tramp-shell-quote-argument
3477 (file-name-directory localname)))
3480 (tramp-shell-quote-argument (file-name-directory localname)))
3482 multi-method method user host
3484 (tramp-get-ls-command multi-method method user host)
3488 (if (zerop (length (file-name-nondirectory localname)))
3490 (tramp-shell-quote-argument
3491 (file-name-nondirectory localname)))))))
3492 (sit-for 1) ;needed for rsh but not ssh?
3493 (tramp-wait-for-output))
3494 ;; The following let-binding is used by code that's commented
3495 ;; out. Let's leave the let-binding in for a while to see
3496 ;; that the commented-out code is really not needed. Commenting-out
3497 ;; happened on 2003-03-13.
3498 (let ((old-pos (point)))
3499 ;; We cannot use `insert-buffer' because the tramp buffer
3500 ;; changes its contents before insertion due to calling
3501 ;; `expand-file' and alike.
3503 (with-current-buffer
3504 (tramp-get-buffer multi-method method user host)
3506 ;; On XEmacs, we want to call (exchange-point-and-mark t), but
3507 ;; that doesn't exist on Emacs, so we use this workaround instead.
3508 ;; Since zmacs-region-stays doesn't exist in Emacs, this ought to
3509 ;; be safe. Thanks to Daniel Pittman <daniel@danann.net>.
3510 ;; (let ((zmacs-region-stays t))
3511 ;; (exchange-point-and-mark))
3513 (tramp-send-command multi-method method user host "cd")
3514 (tramp-wait-for-output))
3515 ;; For the time being, the XEmacs kludge is commented out.
3516 ;; Please test it on various XEmacs versions to see if it works.
3517 ;; ;; Another XEmacs specialty follows. What's the right way to do
3519 ;; (when (and (featurep 'xemacs)
3520 ;; (eq major-mode 'dired-mode))
3523 ;; (dired-insert-set-properties old-pos (point))))
3526 ;; Continuation of kluge to pacify byte-compiler.
3527 ;;(eval-when-compile
3528 ;; (when (eq (symbol-function 'dired-insert-set-properties) 'ignore)
3529 ;; (fmakunbound 'dired-insert-set-properties)))
3531 ;; CCC is this the right thing to do?
3532 (defun tramp-handle-unhandled-file-name-directory (filename)
3533 "Like `unhandled-file-name-directory' for tramp files."
3534 (with-parsed-tramp-file-name filename nil
3535 (expand-file-name "~/")))
3537 ;; Canonicalization of file names.
3539 (defun tramp-drop-volume-letter (name)
3540 "Cut off unnecessary drive letter from file NAME.
3541 The function `tramp-handle-expand-file-name' calls `expand-file-name'
3542 locally on a remote file name. When the local system is a W32 system
3543 but the remote system is Unix, this introduces a superfluous drive
3544 letter into the file name. This function removes it.
3546 Doesn't do anything if the NAME does not start with a drive letter."
3547 (if (and (> (length name) 1)
3548 (char-equal (aref name 1) ?:)
3549 (let ((c1 (aref name 0)))
3550 (or (and (>= c1 ?A) (<= c1 ?Z))
3551 (and (>= c1 ?a) (<= c1 ?z)))))
3555 (defun tramp-handle-expand-file-name (name &optional dir)
3556 "Like `expand-file-name' for tramp files.
3557 If the localname part of the given filename starts with \"/../\" then
3558 the result will be a local, non-Tramp, filename."
3559 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
3560 (setq dir (or dir default-directory "/"))
3561 ;; Unless NAME is absolute, concat DIR and NAME.
3562 (unless (file-name-absolute-p name)
3563 (setq name (concat (file-name-as-directory dir) name)))
3564 ;; If NAME is not a tramp file, run the real handler
3565 (if (not (tramp-tramp-file-p name))
3566 (tramp-run-real-handler 'expand-file-name
3569 (with-parsed-tramp-file-name name nil
3570 (unless (file-name-absolute-p localname)
3571 (setq localname (concat "~/" localname)))
3573 ;; Tilde expansion if necessary. This needs a shell which
3574 ;; groks tilde expansion! The function `tramp-find-shell' is
3575 ;; supposed to find such a shell on the remote host. Please
3576 ;; tell me about it when this doesn't work on your system.
3577 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
3578 (let ((uname (match-string 1 localname))
3579 (fname (match-string 2 localname)))
3580 ;; We cannot simply apply "~/", because under sudo "~/" is
3581 ;; expanded to the local user home directory but to the
3582 ;; root home directory. On the other hand, using always
3583 ;; the default user name for tilde expansion is not
3584 ;; appropriate either, because ssh and companions might
3585 ;; use a user name from the config file.
3586 (when (and (string-equal uname "~")
3589 (tramp-find-method multi-method method user host)))
3590 (setq uname (concat uname (or user "root"))))
3591 ;; CCC fanatic error checking?
3592 (set-buffer (tramp-get-buffer multi-method method user host))
3595 multi-method method user host
3596 (format "cd %s; pwd" uname)
3598 (tramp-wait-for-output)
3599 (goto-char (point-min))
3600 (setq uname (buffer-substring (point) (tramp-line-end-position)))
3601 (setq localname (concat uname fname))
3603 ;; There might be a double slash, for example when "~/"
3604 ;; expands to "/". Remove this.
3605 (while (string-match "//" localname)
3606 (setq localname (replace-match "/" t t localname)))
3607 ;; No tilde characters in file name, do normal
3608 ;; expand-file-name (this does "/./" and "/../"). We bind
3609 ;; directory-sep-char here for XEmacs on Windows, which would
3610 ;; otherwise use backslash. `default-directory' is bound to
3611 ;; "/", because on Windows there would be problems with UNC
3612 ;; shares or Cygwin mounts.
3613 (tramp-let-maybe directory-sep-char ?/
3614 (let ((default-directory "/"))
3615 (tramp-make-tramp-file-name
3616 multi-method (or method (tramp-find-default-method user host))
3618 (tramp-drop-volume-letter
3619 (tramp-run-real-handler 'expand-file-name
3620 (list localname))))))))))
3622 ;; old version follows. it uses ".." to cross file handler
3624 ;; ;; Look if localname starts with "/../" construct. If this is
3625 ;; ;; the case, then we return a local name instead of a remote name.
3626 ;; (if (string-match "^/\\.\\./" localname)
3627 ;; (expand-file-name (substring localname 3))
3628 ;; ;; No tilde characters in file name, do normal
3629 ;; ;; expand-file-name (this does "/./" and "/../"). We bind
3630 ;; ;; directory-sep-char here for XEmacs on Windows, which
3631 ;; ;; would otherwise use backslash.
3632 ;; (let ((directory-sep-char ?/))
3633 ;; (tramp-make-tramp-file-name
3634 ;; multi-method method user host
3635 ;; (tramp-drop-volume-letter
3636 ;; (tramp-run-real-handler 'expand-file-name
3637 ;; (list localname))))))))))
3641 (defvar tramp-async-proc nil
3642 "Global variable keeping asynchronous process object.
3643 Used in `tramp-handle-shell-command'")
3645 (defvar tramp-display-shell-command-buffer t
3646 "Whether to display output buffer of `shell-command'.
3647 This is necessary for handling DISPLAY of `process-file'.")
3649 (defun tramp-handle-shell-command (command &optional output-buffer error-buffer)
3650 "Like `shell-command' for tramp files.
3651 This will break if COMMAND prints a newline, followed by the value of
3652 `tramp-end-of-output', followed by another newline."
3653 ;; Asynchronous processes are far from being perfect. But it works at least
3654 ;; for `find-grep-dired' and `find-name-dired' in Emacs 22.
3655 (if (tramp-tramp-file-p default-directory)
3656 (with-parsed-tramp-file-name default-directory nil
3657 (let ((curbuf (current-buffer))
3658 (asynchronous (string-match "[ \t]*&[ \t]*\\'" command))
3660 (unless output-buffer
3664 "*Async Shell Command*"
3665 "*Shell Command Output*")))
3666 (set-buffer output-buffer)
3668 (unless (bufferp output-buffer)
3669 (setq output-buffer (current-buffer)))
3670 (set-buffer output-buffer)
3671 ;; Tramp doesn't handle the asynchronous case by an asynchronous
3672 ;; process. Instead of, another asynchronous process is opened
3673 ;; which gets the output of the (synchronous) Tramp process
3674 ;; via process-filter. ERROR-BUFFER is disabled.
3676 (setq command (substring command 0 (match-beginning 0))
3678 tramp-async-proc (start-process (buffer-name output-buffer)
3679 output-buffer "cat")))
3681 (tramp-barf-unless-okay
3682 multi-method method user host
3683 (format "cd %s" (tramp-shell-quote-argument localname))
3685 "tramp-handle-shell-command: Couldn't `cd %s'"
3686 (tramp-shell-quote-argument localname))
3687 ;; Define the process filter
3691 (tramp-get-buffer multi-method method user host))
3692 '(lambda (process string)
3693 ;; Write the output into the Tramp Process
3694 (save-current-buffer
3695 (set-buffer (process-buffer process))
3696 (goto-char (point-max))
3698 ;; Hand-over output to asynchronous process.
3701 (regexp-quote tramp-end-of-output) string)))
3704 (substring string 0 (1- (match-beginning 0)))))
3705 (process-send-string tramp-async-proc string)
3707 (set-process-filter process nil)
3708 (process-send-eof tramp-async-proc))))))
3711 multi-method method user host
3713 (format "( %s ) 2>/tmp/tramp.$$.err; tramp_old_status=$?"
3715 (format "%s; tramp_old_status=$?" command)))
3716 (unless asynchronous
3717 (tramp-wait-for-output)))
3718 (unless asynchronous
3719 ;; We cannot use `insert-buffer' because the tramp buffer
3720 ;; changes its contents before insertion due to calling
3721 ;; `expand-file' and alike.
3723 (with-current-buffer
3724 (tramp-get-buffer multi-method method user host)
3728 (unless (bufferp error-buffer)
3729 (setq error-buffer (get-buffer-create error-buffer)))
3731 multi-method method user host
3732 "cat /tmp/tramp.$$.err")
3733 (tramp-wait-for-output)
3734 (set-buffer error-buffer)
3735 ;; Same comment as above
3737 (with-current-buffer
3738 (tramp-get-buffer multi-method method user host)
3740 (tramp-send-command-and-check
3741 multi-method method user host "rm -f /tmp/tramp.$$.err")))
3743 (tramp-send-command multi-method method user host "cd")
3744 (unless asynchronous
3745 (tramp-wait-for-output))
3747 multi-method method user host
3748 (concat "tramp_set_exit_status $tramp_old_status;"
3749 " echo tramp_exit_status $?"))
3750 (unless asynchronous
3751 (tramp-wait-for-output)
3752 (goto-char (point-max))
3753 (unless (search-backward "tramp_exit_status " nil t)
3754 (error "Couldn't find exit status of `%s'" command))
3755 (skip-chars-forward "^ ")
3756 (setq status (read (current-buffer)))))
3757 (unless (zerop (buffer-size))
3758 (when tramp-display-shell-command-buffer
3759 (display-buffer output-buffer)))
3762 ;; The following is only executed if something strange was
3763 ;; happening. Emit a helpful message and do it anyway.
3764 (message "tramp-handle-shell-command called with non-tramp directory: `%s'"
3766 (tramp-run-real-handler 'shell-command
3767 (list command output-buffer error-buffer))))
3769 (defun tramp-handle-process-file (program &optional infile buffer display &rest args)
3770 "Like `process-file' for Tramp files."
3771 (when infile (error "Implementation does not handle input from file"))
3772 (when (and (numberp buffer) (zerop buffer))
3773 (error "Implementation does not handle immediate return"))
3774 (when (consp buffer) (error "Implementation does not handle error files"))
3775 (let ((tramp-display-shell-command-buffer display))
3777 (mapconcat 'tramp-shell-quote-argument (cons program args) " ")
3782 (defsubst tramp-make-temp-file (filename)
3784 (funcall (if (fboundp 'make-temp-file) 'make-temp-file 'make-temp-name)
3785 (expand-file-name tramp-temp-name-prefix
3786 (tramp-temporary-file-directory)))
3787 (file-name-extension filename t)))
3789 (defun tramp-handle-file-local-copy (filename)
3790 "Like `file-local-copy' for tramp files."
3791 (with-parsed-tramp-file-name filename nil
3792 (let ((tramp-buf (tramp-get-buffer multi-method method user host))
3793 ;; We used to bind the following as late as possible.
3794 ;; loc-enc and loc-dec were bound directly before the if
3795 ;; statement that checks them. But the functions
3796 ;; tramp-get-* might invoke the "are you awake" check in
3797 ;; tramp-maybe-open-connection, which is an unfortunate time
3798 ;; since we rely on the buffer contents at that spot.
3799 (rem-enc (tramp-get-remote-encoding multi-method method user host))
3800 (rem-dec (tramp-get-remote-decoding multi-method method user host))
3801 (loc-enc (tramp-get-local-encoding multi-method method user host))
3802 (loc-dec (tramp-get-local-decoding multi-method method user host))
3804 (unless (file-exists-p filename)
3805 (error "Cannot make local copy of non-existing file `%s'"
3807 (setq tmpfil (tramp-make-temp-file filename))
3809 (cond ((tramp-method-out-of-band-p multi-method method user host)
3810 ;; `copy-file' handles out-of-band methods
3811 (copy-file filename tmpfil t t))
3813 ((and rem-enc rem-dec)
3814 ;; Use inline encoding for file transfer.
3816 ;; Following line for setting tramp-current-method,
3817 ;; tramp-current-user, tramp-current-host.
3818 (set-buffer tramp-buf)
3819 (tramp-message 5 "Encoding remote file %s..." filename)
3820 (tramp-barf-unless-okay
3821 multi-method method user host
3822 (concat rem-enc " < " (tramp-shell-quote-argument localname))
3824 "Encoding remote file failed, see buffer `%s' for details"
3826 ;; Remove trailing status code
3827 (goto-char (point-max))
3828 (delete-region (point) (progn (forward-line -1) (point)))
3830 (tramp-message 5 "Decoding remote file %s..." filename)
3832 ;; Here is where loc-enc and loc-dec used to be let-bound.
3833 (if (and (symbolp loc-dec) (fboundp loc-dec))
3834 ;; If local decoding is a function, we call it. We
3835 ;; must disable multibyte, because
3836 ;; `uudecode-decode-region' doesn't handle it
3838 (let ((tmpbuf (get-buffer-create " *tramp tmp*")))
3841 (set-buffer-multibyte nil)
3842 (insert-buffer-substring tramp-buf)
3843 (tramp-message-for-buffer
3844 multi-method method user host
3845 6 "Decoding remote file %s with function %s..."
3848 ;; Douglas Gray Stephens <DGrayStephens@slb.com>
3849 ;; says that we need to strip tramp_exit_status
3850 ;; line from the output here. Go to point-max,
3851 ;; search backward for tramp_exit_status, delete
3852 ;; between point and point-max if found.
3853 (let ((coding-system-for-write 'binary))
3854 (funcall loc-dec (point-min) (point-max))
3855 (write-region (point-min) (point-max) tmpfil))
3856 (kill-buffer tmpbuf))
3857 ;; If tramp-decoding-function is not defined for this
3858 ;; method, we invoke tramp-decoding-command instead.
3859 (let ((tmpfil2 (tramp-make-temp-file filename)))
3860 (write-region (point-min) (point-max) tmpfil2)
3862 6 "Decoding remote file %s with command %s..."
3864 (tramp-call-local-coding-command
3865 loc-dec tmpfil2 tmpfil)
3866 (delete-file tmpfil2)))
3867 (tramp-message-for-buffer
3868 multi-method method user host
3869 5 "Decoding remote file %s...done" filename)
3870 ;; Set proper permissions.
3871 (set-file-modes tmpfil (file-modes filename))))
3873 (t (error "Wrong method specification for `%s'" method)))
3876 (defun tramp-handle-file-remote-p (filename &optional identification connected)
3877 "Like `file-remote-p' for Tramp files."
3878 (when (tramp-tramp-file-p filename)
3879 (with-parsed-tramp-file-name filename nil
3880 (and (or (not connected)
3881 (let ((p (get-buffer-process
3882 (tramp-get-buffer multi-method method user host))))
3883 (and p (processp p) (memq (process-status p) '(run open)))))
3885 ((eq identification 'method) method)
3886 ((eq identification 'user) user)
3887 ((eq identification 'host) host)
3888 (t (tramp-make-tramp-file-name
3889 multi-method method user host "")))))))
3891 (defun tramp-handle-insert-file-contents
3892 (filename &optional visit beg end replace)
3893 "Like `insert-file-contents' for tramp files."
3894 (barf-if-buffer-read-only)
3895 (setq filename (expand-file-name filename))
3896 (with-parsed-tramp-file-name filename nil
3897 (if (not (file-exists-p filename))
3900 (setq buffer-file-name filename)
3901 (set-visited-file-modtime)
3902 (set-buffer-modified-p nil))
3904 (format "File `%s' not found on remote host" filename))
3905 (list (expand-file-name filename) 0))
3906 ;; `insert-file-contents-literally' takes care to avoid calling
3907 ;; jka-compr. By let-binding inhibit-file-name-operation, we
3908 ;; propagate that care to the file-local-copy operation.
3910 (let ((inhibit-file-name-operation
3911 (when (eq inhibit-file-name-operation
3912 'insert-file-contents)
3914 (file-local-copy filename)))
3915 coding-system-used result)
3916 (tramp-message-for-buffer
3917 multi-method method user host
3918 9 "Inserting local temp file `%s'..." local-copy)
3919 (setq result (insert-file-contents local-copy nil beg end replace))
3921 (setq buffer-file-name filename)
3922 (set-visited-file-modtime)
3923 (set-buffer-modified-p nil))
3924 ;; Now `last-coding-system-used' has right value. Remember it.
3925 (when (boundp 'last-coding-system-used)
3926 (setq coding-system-used (symbol-value 'last-coding-system-used)))
3927 (tramp-message-for-buffer
3928 multi-method method user host
3929 9 "Inserting local temp file `%s'...done" local-copy)
3930 (delete-file local-copy)
3931 (when (boundp 'last-coding-system-used)
3932 (set 'last-coding-system-used coding-system-used))
3933 (list (expand-file-name filename)
3937 (defun tramp-handle-find-backup-file-name (filename)
3938 "Like `find-backup-file-name' for tramp files."
3939 (with-parsed-tramp-file-name filename nil
3940 ;; We set both variables. It doesn't matter whether it is
3942 (let ((backup-directory-alist
3944 (when (boundp 'backup-directory-alist)
3945 (if (boundp 'tramp-backup-directory-alist)
3950 (if (and (stringp (cdr x))
3951 (file-name-absolute-p (cdr x))
3952 (not (tramp-file-name-p (cdr x))))
3953 (tramp-make-tramp-file-name
3954 multi-method method user host (cdr x))
3956 (symbol-value 'tramp-backup-directory-alist))
3957 (symbol-value 'backup-directory-alist))))
3959 (bkup-backup-directory-info
3961 (when (boundp 'bkup-backup-directory-info)
3962 (if (boundp 'tramp-bkup-backup-directory-info)
3968 (if (and (stringp (car (cdr x)))
3969 (file-name-absolute-p (car (cdr x)))
3970 (not (tramp-file-name-p (car (cdr x)))))
3971 (tramp-make-tramp-file-name
3972 multi-method method user host (car (cdr x)))
3975 (symbol-value 'tramp-bkup-backup-directory-info))
3976 (symbol-value 'bkup-backup-directory-info)))))
3978 (tramp-run-real-handler 'find-backup-file-name (list filename)))))
3980 (defun tramp-handle-make-auto-save-file-name ()
3981 "Like `make-auto-save-file-name' for tramp files.
3982 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3983 (let ((tramp-auto-save-directory tramp-auto-save-directory))
3984 ;; File name must be unique. This is ensured with Emacs 22 (see
3985 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3986 ;; all other cases we must do it ourselves.
3987 (when (boundp 'auto-save-file-name-transforms)
3990 (when (and (string-match (car x) buffer-file-name)
3991 (not (car (cddr x))))
3992 (setq tramp-auto-save-directory
3993 (or tramp-auto-save-directory
3994 (tramp-temporary-file-directory)))))
3995 (symbol-value 'auto-save-file-name-transforms)))
3996 ;; Create directory.
3997 (when tramp-auto-save-directory
3998 (unless (file-exists-p tramp-auto-save-directory)
3999 (make-directory tramp-auto-save-directory t)))
4000 ;; jka-compr doesn't like auto-saving, so by appending "~" to the
4001 ;; file name we make sure that jka-compr isn't used for the
4003 (let ((buffer-file-name
4004 (if tramp-auto-save-directory
4006 (tramp-subst-strs-in-string
4014 tramp-auto-save-directory)
4015 (buffer-file-name))))
4016 ;; Run plain `make-auto-save-file-name'. There might be an advice when
4017 ;; it is not a magic file name operation (since Emacs 22).
4018 ;; We must deactivate it temporarily.
4019 (if (not (ad-is-active 'make-auto-save-file-name))
4020 (tramp-run-real-handler
4021 'make-auto-save-file-name nil)
4023 (ad-deactivate 'make-auto-save-file-name)
4025 (tramp-run-real-handler
4026 'make-auto-save-file-name nil)
4027 (ad-activate 'make-auto-save-file-name))))))
4030 ;; CCC grok APPEND, LOCKNAME, CONFIRM
4031 (defun tramp-handle-write-region
4032 (start end filename &optional append visit lockname confirm)
4033 "Like `write-region' for tramp files."
4034 (unless (eq append nil)
4035 (error "Cannot append to file using tramp (`%s')" filename))
4036 (setq filename (expand-file-name filename))
4037 ;; Following part commented out because we don't know what to do about
4038 ;; file locking, and it does not appear to be a problem to ignore it.
4039 ;; Ange-ftp ignores it, too.
4040 ;; (when (and lockname (stringp lockname))
4041 ;; (setq lockname (expand-file-name lockname)))
4042 ;; (unless (or (eq lockname nil)
4043 ;; (string= lockname filename))
4045 ;; "tramp-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
4046 ;; XEmacs takes a coding system as the seventh argument, not `confirm'
4047 (when (and (not (featurep 'xemacs))
4048 confirm (file-exists-p filename))
4049 (unless (y-or-n-p (format "File %s exists; overwrite anyway? "
4051 (error "File not overwritten")))
4052 (with-parsed-tramp-file-name filename nil
4053 (let ((curbuf (current-buffer))
4054 (rem-enc (tramp-get-remote-encoding multi-method method user host))
4055 (rem-dec (tramp-get-remote-decoding multi-method method user host))
4056 (loc-enc (tramp-get-local-encoding multi-method method user host))
4057 (loc-dec (tramp-get-local-decoding multi-method method user host))
4058 (trampbuf (get-buffer-create "*tramp output*"))
4059 (modes (file-modes filename))
4060 ;; We use this to save the value of `last-coding-system-used'
4061 ;; after writing the tmp file. At the end of the function,
4062 ;; we set `last-coding-system-used' to this saved value.
4063 ;; This way, any intermediary coding systems used while
4064 ;; talking to the remote shell or suchlike won't hose this
4065 ;; variable. This approach was snarfed from ange-ftp.el.
4068 ;; Write region into a tmp file. This isn't really needed if we
4069 ;; use an encoding function, but currently we use it always
4070 ;; because this makes the logic simpler.
4071 (setq tmpfil (tramp-make-temp-file filename))
4072 ;; Set current buffer. If connection wasn't open, `file-modes' has
4073 ;; changed it accidently.
4075 ;; We say `no-message' here because we don't want the visited file
4076 ;; modtime data to be clobbered from the temp file. We call
4077 ;; `set-visited-file-modtime' ourselves later on.
4078 (tramp-run-real-handler
4080 (if confirm ; don't pass this arg unless defined for backward compat.
4081 (list start end tmpfil append 'no-message lockname confirm)
4082 (list start end tmpfil append 'no-message lockname)))
4083 ;; Now, `last-coding-system-used' has the right value. Remember it.
4084 (when (boundp 'last-coding-system-used)
4085 (setq coding-system-used (symbol-value 'last-coding-system-used)))
4086 ;; The permissions of the temporary file should be set. If
4087 ;; filename does not exist (eq modes nil) it has been renamed to
4088 ;; the backup file. This case `save-buffer' handles
4090 (when modes (set-file-modes tmpfil modes))
4091 ;; This is a bit lengthy due to the different methods possible for
4092 ;; file transfer. First, we check whether the method uses an rcp
4093 ;; program. If so, we call it. Otherwise, both encoding and
4094 ;; decoding command must be specified. However, if the method
4095 ;; _also_ specifies an encoding function, then that is used for
4096 ;; encoding the contents of the tmp file.
4097 (cond ((tramp-method-out-of-band-p multi-method method user host)
4098 ;; `copy-file' handles out-of-band methods
4099 (copy-file tmpfil filename t t))
4101 ((and rem-enc rem-dec)
4102 ;; Use inline file transfer
4103 (let ((tmpbuf (get-buffer-create " *tramp file transfer*")))
4105 ;; Encode tmpfil into tmpbuf
4106 (tramp-message-for-buffer multi-method method user host
4107 5 "Encoding region...")
4110 ;; Use encoding function or command.
4111 (if (and (symbolp loc-enc) (fboundp loc-enc))
4113 (tramp-message-for-buffer
4114 multi-method method user host
4115 6 "Encoding region using function `%s'..."
4116 (symbol-name loc-enc))
4117 (insert-file-contents-literally tmpfil)
4118 ;; CCC. The following `let' is a workaround for
4119 ;; the base64.el that comes with pgnus-0.84. If
4120 ;; both of the following conditions are
4121 ;; satisfied, it tries to write to a local file
4122 ;; in default-directory, but at this point,
4123 ;; default-directory is remote.
4124 ;; (CALL-PROCESS-REGION can't write to remote
4125 ;; files, it seems.) The file in question is a
4127 (let ((default-directory
4128 (tramp-temporary-file-directory)))
4129 (funcall loc-enc (point-min) (point-max)))
4130 (goto-char (point-max))
4133 (tramp-message-for-buffer
4134 multi-method method user host
4135 6 "Encoding region using command `%s'..." loc-enc)
4136 (unless (equal 0 (tramp-call-local-coding-command
4138 (pop-to-buffer trampbuf)
4139 (error (concat "Cannot write to `%s', local encoding"
4140 " command `%s' failed")
4142 ;; Send tmpbuf into remote decoding command which
4143 ;; writes to remote file. Because this happens on the
4144 ;; remote host, we cannot use the function.
4145 (tramp-message-for-buffer
4146 multi-method method user host
4147 5 "Decoding region into remote file %s..." filename)
4149 multi-method method user host
4150 (format "%s >%s <<'EOF'"
4152 (tramp-shell-quote-argument localname)))
4154 (tramp-message-for-buffer
4155 multi-method method user host
4156 6 "Sending data to remote host...")
4157 (tramp-send-string multi-method method user host
4159 ;; wait for remote decoding to complete
4160 (tramp-message-for-buffer
4161 multi-method method user host
4162 6 "Sending end of data token...")
4164 multi-method method user host "EOF" nil t)
4165 (tramp-message-for-buffer
4166 multi-method method user host 6
4167 "Waiting for remote host to process data...")
4168 (set-buffer (tramp-get-buffer multi-method method user host))
4169 (tramp-wait-for-output)
4170 (tramp-barf-unless-okay
4171 multi-method method user host nil nil 'file-error
4172 (concat "Couldn't write region to `%s',"
4173 " decode using `%s' failed")
4175 (tramp-message 5 "Decoding region into remote file %s...done"
4177 (kill-buffer tmpbuf))))
4180 (concat "Method `%s' should specify both encoding and "
4181 "decoding command or an rcp program")
4183 (delete-file tmpfil)
4184 (unless (equal curbuf (current-buffer))
4185 (error "Buffer has changed from `%s' to `%s'"
4186 curbuf (current-buffer)))
4187 (when (or (eq visit t) (stringp visit))
4188 (set-visited-file-modtime
4189 ;; We must pass modtime explicitely, because filename can be different
4190 ;; from (buffer-file-name), f.e. if `file-precious-flag' is set.
4191 (nth 5 (file-attributes filename))))
4192 ;; Make `last-coding-system-used' have the right value.
4193 (when (boundp 'last-coding-system-used)
4194 (set 'last-coding-system-used coding-system-used))
4195 (when (or (eq visit t)
4198 (message "Wrote %s" filename)))))
4200 ;; Call down to the real handler.
4201 ;; Because EFS does not play nicely with TRAMP (both systems match a
4202 ;; TRAMP file name) it is needed to disable efs as well as tramp for the
4205 ;; Other than that, this is the canon file-handler code that the doco
4206 ;; says should be used here. Which is nice.
4208 ;; Under XEmacs current, EFS also hooks in as
4209 ;; efs-sifn-handler-function to handle any filename with environment
4210 ;; variables. This has two implications:
4211 ;; 1) That EFS may not be completely dead (yet) for TRAMP filenames
4212 ;; 2) That TRAMP might want to do the same thing.
4213 ;; Details as they come in.
4215 ;; Daniel Pittman <daniel@danann.net>
4217 ;; (defun tramp-run-real-handler (operation args)
4218 ;; "Invoke normal file name handler for OPERATION.
4219 ;; This inhibits EFS and Ange-FTP, too, because they conflict with tramp.
4220 ;; First arg specifies the OPERATION, remaining ARGS are passed to the
4222 ;; (let ((inhibit-file-name-handlers
4223 ;; (list 'tramp-file-name-handler
4224 ;; 'efs-file-handler-function
4225 ;; 'ange-ftp-hook-function
4226 ;; (and (eq inhibit-file-name-operation operation)
4227 ;; inhibit-file-name-handlers)))
4228 ;; (inhibit-file-name-operation operation))
4229 ;; (apply operation args)))
4232 (progn (defun tramp-run-real-handler (operation args)
4233 "Invoke normal file name handler for OPERATION.
4234 First arg specifies the OPERATION, second arg is a list of arguments to
4235 pass to the OPERATION."
4236 (let* ((inhibit-file-name-handlers
4237 `(tramp-file-name-handler
4238 tramp-completion-file-name-handler
4239 cygwin-mount-name-hook-function
4240 cygwin-mount-map-drive-hook-function
4242 ,(and (eq inhibit-file-name-operation operation)
4243 inhibit-file-name-handlers)))
4244 (inhibit-file-name-operation operation))
4245 (apply operation args))))
4247 ;; This function is used from `tramp-completion-file-name-handler'
4248 ;; functions only, if `tramp-completion-mode-p' is true. But this
4249 ;; cannot be checked here because the check is based on a full
4250 ;; filename, not available for all basic I/O operations.
4252 (progn (defun tramp-completion-run-real-handler (operation args)
4253 "Invoke `tramp-file-name-handler' for OPERATION.
4254 First arg specifies the OPERATION, second arg is a list of arguments to
4255 pass to the OPERATION."
4256 (let* ((inhibit-file-name-handlers
4257 `(tramp-completion-file-name-handler
4258 cygwin-mount-name-hook-function
4259 cygwin-mount-map-drive-hook-function
4261 ,(and (eq inhibit-file-name-operation operation)
4262 inhibit-file-name-handlers)))
4263 (inhibit-file-name-operation operation))
4264 (apply operation args))))
4266 ;; We handle here all file primitives. Most of them have the file
4267 ;; name as first parameter; nevertheless we check for them explicitly
4268 ;; in order to be signalled if a new primitive appears. This
4269 ;; scenario is needed because there isn't a way to decide by
4270 ;; syntactical means whether a foreign method must be called. It would
4271 ;; ease the life if `file-name-handler-alist' would support a decision
4272 ;; function as well but regexp only.
4273 (defun tramp-file-name-for-operation (operation &rest args)
4274 "Return file name related to OPERATION file primitive.
4275 ARGS are the arguments OPERATION has been called with."
4277 ; FILE resp DIRECTORY
4279 (list 'access-file 'byte-compiler-base-file-name 'delete-directory
4280 'delete-file 'diff-latest-backup-file 'directory-file-name
4281 'directory-files 'directory-files-and-attributes
4282 'dired-compress-file 'dired-uncache
4283 'file-accessible-directory-p 'file-attributes
4284 'file-directory-p 'file-executable-p 'file-exists-p
4285 'file-local-copy 'file-remote-p 'file-modes
4286 'file-name-as-directory 'file-name-directory
4287 'file-name-nondirectory 'file-name-sans-versions
4288 'file-ownership-preserved-p 'file-readable-p
4289 'file-regular-p 'file-symlink-p 'file-truename
4290 'file-writable-p 'find-backup-file-name 'find-file-noselect
4291 'get-file-buffer 'insert-directory 'insert-file-contents
4292 'load 'make-directory 'make-directory-internal
4293 'set-file-modes 'substitute-in-file-name
4294 'unhandled-file-name-directory 'vc-registered
4296 'abbreviate-file-name 'create-file-buffer
4297 'dired-file-modtime 'dired-make-compressed-filename
4298 'dired-recursive-delete-directory 'dired-set-file-modtime
4299 'dired-shell-unhandle-file-name 'dired-uucode-file
4300 'insert-file-contents-literally 'recover-file
4301 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail))
4302 (if (file-name-absolute-p (nth 0 args))
4304 (expand-file-name (nth 0 args))))
4305 ; FILE DIRECTORY resp FILE1 FILE2
4307 (list 'add-name-to-file 'copy-file 'expand-file-name
4308 'file-name-all-completions 'file-name-completion
4309 'file-newer-than-file-p 'make-symbolic-link 'rename-file
4311 'dired-make-relative-symlink
4312 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail))
4315 ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args))
4316 ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args))
4317 (t (buffer-file-name (current-buffer))))))
4319 ((eq operation 'write-region)
4323 (list 'make-auto-save-file-name
4324 'set-visited-file-modtime 'verify-visited-file-modtime
4328 (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer))))
4331 (list 'dired-call-process
4337 'dired-print-file 'dired-shell-call-process))
4339 ; unknown file primitive
4340 (t (error "unknown file I/O primitive: %s" operation))))
4342 (defun tramp-find-foreign-file-name-handler (filename)
4343 "Return foreign file name handler if exists."
4344 (when (tramp-tramp-file-p filename)
4347 (handler-alist tramp-foreign-file-name-handler-alist))
4348 (while handler-alist
4349 (setq elt (car handler-alist)
4350 handler-alist (cdr handler-alist))
4351 (when (funcall (car elt) filename)
4352 (setq handler-alist nil)
4353 (setq res (cdr elt))))
4358 (defun tramp-file-name-handler (operation &rest args)
4359 "Invoke Tramp file name handler.
4360 Falls back to normal file name handler if no tramp file name handler exists."
4361 ;; (setq edebug-trace t)
4362 ;; (edebug-trace "%s" (with-output-to-string (backtrace)))
4364 (let* ((filename (apply 'tramp-file-name-for-operation operation args))
4365 (completion (tramp-completion-mode-p filename))
4366 (foreign (tramp-find-foreign-file-name-handler filename)))
4367 (with-parsed-tramp-file-name filename nil
4369 ;; When we are in completion mode, some operations shouldn' be
4370 ;; handled by backend.
4371 ((and completion (zerop (length localname))
4372 (memq operation '(file-exists-p file-directory-p)))
4374 ((and completion (zerop (length localname))
4375 (memq operation '(file-name-as-directory)))
4377 ;; Call the backend function.
4378 (foreign (apply foreign operation args))
4379 ;; Nothing to do for us.
4380 (t (tramp-run-real-handler operation args)))))))
4383 ;; In Emacs, there is some concurrency due to timers. If a timer
4384 ;; interrupts Tramp and wishes to use the same connection buffer as
4385 ;; the "main" Emacs, then garbage might occur in the connection
4386 ;; buffer. Therefore, we need to make sure that a timer does not use
4387 ;; the same connection buffer as the "main" Emacs. We implement a
4388 ;; cheap global lock, instead of locking each connection buffer
4389 ;; separately. The global lock is based on two variables,
4390 ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true
4391 ;; (with setq) to indicate a lock. But Tramp also calls itself during
4392 ;; processing of a single file operation, so we need to allow
4393 ;; recursive calls. That's where the `tramp-locker' variable comes in
4394 ;; -- it is let-bound to t during the execution of the current
4395 ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t,
4396 ;; then we should just proceed because we have been called
4397 ;; recursively. But if `tramp-locker' is nil, then we are a timer
4398 ;; interrupting the "main" Emacs, and then we signal an error.
4400 (defvar tramp-locked nil
4401 "If non-nil, then Tramp is currently busy.
4402 Together with `tramp-locker', this implements a locking mechanism
4403 preventing reentrant calls of Tramp.")
4405 (defvar tramp-locker nil
4406 "If non-nil, then a caller has locked Tramp.
4407 Together with `tramp-locked', this implements a locking mechanism
4408 preventing reentrant calls of Tramp.")
4410 (defun tramp-sh-file-name-handler (operation &rest args)
4411 "Invoke remote-shell Tramp file name handler.
4412 Fall back to normal file name handler if no Tramp handler exists."
4413 (when (and tramp-locked (not tramp-locker))
4414 (signal 'file-error "Forbidden reentrant call of Tramp"))
4415 (let ((tl tramp-locked))
4418 (setq tramp-locked t)
4419 (let ((tramp-locker t))
4421 (let ((fn (assoc operation tramp-file-name-handler-alist)))
4423 (apply (cdr fn) args)
4424 (tramp-run-real-handler operation args))))))
4425 (setq tramp-locked tl))))
4428 (progn (defun tramp-completion-file-name-handler (operation &rest args)
4429 "Invoke tramp file name completion handler.
4430 Falls back to normal file name handler if no tramp file name handler exists."
4431 ;; (setq edebug-trace t)
4432 ;; (edebug-trace "%s" (with-output-to-string (backtrace)))
4433 (let ((fn (assoc operation tramp-completion-file-name-handler-alist)))
4435 (save-match-data (apply (cdr fn) args))
4436 (tramp-completion-run-real-handler operation args)))))
4439 (defsubst tramp-register-file-name-handler ()
4440 "Add tramp file name handler to `file-name-handler-alist'."
4441 (add-to-list 'file-name-handler-alist
4442 (cons tramp-file-name-regexp 'tramp-file-name-handler))
4443 ;; If jka-compr is already loaded, move it to the front of
4444 ;; `file-name-handler-alist'.
4445 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4447 (setq file-name-handler-alist
4448 (cons jka (delete jka file-name-handler-alist))))))
4451 (defsubst tramp-register-completion-file-name-handler ()
4452 "Add tramp completion file name handler to `file-name-handler-alist'."
4453 ;; `partial-completion-mode' is unknown in XEmacs. So we should
4454 ;; load it unconditionally there. In the GNU Emacs case, method/
4455 ;; user/host name completion shall be bound to `partial-completion-mode'.
4456 (when (or (not (boundp 'partial-completion-mode))
4457 (symbol-value 'partial-completion-mode)
4459 (add-to-list 'file-name-handler-alist
4460 (cons tramp-completion-file-name-regexp
4461 'tramp-completion-file-name-handler))
4462 (put 'tramp-completion-file-name-handler 'safe-magic t))
4463 ;; If jka-compr is already loaded, move it to the front of
4464 ;; `file-name-handler-alist'.
4465 (let ((jka (rassoc 'jka-compr-handler file-name-handler-alist)))
4467 (setq file-name-handler-alist
4468 (cons jka (delete jka file-name-handler-alist))))))
4470 ;; `tramp-file-name-handler' must be registered before evaluation of
4471 ;; site-start and init files, because there might exist remote files
4472 ;; already, f.e. files kept via recentf-mode.
4473 ;;;###autoload(tramp-register-file-name-handler)
4474 ;; During autoload, it shall be checked whether
4475 ;; `partial-completion-mode' is active. Therefore registering of
4476 ;; `tramp-completion-file-name-handler' will be delayed.
4477 ;;;###autoload(add-hook
4478 ;;;###autoload 'after-init-hook
4479 ;;;###autoload '(lambda () (tramp-register-completion-file-name-handler)))
4480 (tramp-register-file-name-handler)
4481 (tramp-register-completion-file-name-handler)
4484 (defun tramp-unload-file-name-handlers ()
4485 (setq file-name-handler-alist
4486 (delete (rassoc 'tramp-file-name-handler
4487 file-name-handler-alist)
4488 (delete (rassoc 'tramp-completion-file-name-handler
4489 file-name-handler-alist)
4490 file-name-handler-alist))))
4492 (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers)
4495 ;;; Interactions with other packages:
4497 ;; -- complete.el --
4499 ;; This function contributed by Ed Sabol
4500 (defun tramp-handle-expand-many-files (name)
4501 "Like `PC-expand-many-files' for tramp files."
4502 (with-parsed-tramp-file-name name nil
4504 (if (or (string-match "\\*" name)
4505 (string-match "\\?" name)
4506 (string-match "\\[.*\\]" name))
4509 ;; CCC: To do it right, we should quote certain characters
4510 ;; in the file name, but since the echo command is going to
4511 ;; break anyway when there are spaces in the file names, we
4513 ;;-(let ((comint-file-name-quote-list
4514 ;;- (set-difference tramp-file-name-quote-list
4515 ;;- '(?\* ?\? ?[ ?]))))
4516 ;;- (tramp-send-command
4517 ;;- multi-method method user host
4518 ;;- (format "echo %s" (comint-quote-filename localname)))
4519 ;;- (tramp-wait-for-output))
4520 (tramp-send-command multi-method method user host
4521 (format "echo %s" localname))
4522 (tramp-wait-for-output)
4523 (setq bufstr (buffer-substring (point-min)
4524 (tramp-line-end-position)))
4525 (goto-char (point-min))
4526 (if (string-equal localname bufstr)
4529 (while (search-forward " " nil t)
4530 (delete-backward-char 1)
4532 (goto-char (point-max))
4533 (delete-backward-char 1)
4535 (goto-char (point-min))
4537 (function (lambda (x)
4538 (tramp-make-tramp-file-name multi-method method
4540 (read (current-buffer))))))
4541 (list (expand-file-name name))))))
4543 (eval-after-load "complete"
4545 (defadvice PC-expand-many-files
4546 (around tramp-advice-PC-expand-many-files (name) activate)
4547 "Invoke `tramp-handle-expand-many-files' for tramp files."
4548 (if (tramp-tramp-file-p name)
4549 (setq ad-return-value (tramp-handle-expand-many-files name))
4551 (add-hook 'tramp-unload-hook
4552 '(lambda () (ad-unadvise 'PC-expand-many-files)))))
4554 ;;; File name handler functions for completion mode
4556 (defvar tramp-completion-mode nil
4557 "If non-nil, external packages signal that they are in file name completion.
4559 This is necessary, because Tramp uses a heuristic depending on last
4560 input event. This fails when external packages use other characters
4561 but <TAB>, <SPACE> or ?\\? for file name completion. This variable
4562 should never be set globally, the intention is to let-bind it.")
4564 ;; Necessary because `tramp-file-name-regexp-unified' and
4565 ;; `tramp-completion-file-name-regexp-unified' aren't different.
4566 ;; If nil, `tramp-completion-run-real-handler' is called (i.e. forwarding to
4567 ;; `tramp-file-name-handler'). Otherwise, it takes `tramp-run-real-handler'.
4568 ;; Using `last-input-event' is a little bit risky, because completing a file
4569 ;; might require loading other files, like "~/.netrc", and for them it
4570 ;; shouldn't be decided based on that variable. On the other hand, those files
4571 ;; shouldn't have partial tramp file name syntax. Maybe another variable should
4572 ;; be introduced overwriting this check in such cases. Or we change tramp
4573 ;; file name syntax in order to avoid ambiguities, like in XEmacs ...
4574 ;; In case of non unified file names it can be always true (and wouldn't be
4575 ;; necessary, because there are different regexp).
4576 (defun tramp-completion-mode-p (file)
4577 "Checks whether method / user name / host name completion is active."
4579 (tramp-completion-mode t)
4580 ((string-match "^/.*:.*:$" file) nil)
4582 (concat tramp-prefix-regexp
4583 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp "$")
4585 (member (match-string 1 file) (mapcar 'car tramp-methods)))
4588 (equal last-input-event 'tab)
4589 (and (natnump last-input-event)
4591 ;; ?\t has event-modifier 'control
4592 (char-equal last-input-event ?\t)
4593 (and (not (event-modifiers last-input-event))
4594 (or (char-equal last-input-event ?\?)
4595 (char-equal last-input-event ?\ )))))
4597 (and (featurep 'xemacs)
4598 ;; `last-input-event' might be nil.
4599 (not (null last-input-event))
4600 ;; `last-input-event' may have no character approximation.
4601 (funcall (symbol-function 'event-to-character) last-input-event)
4603 ;; ?\t has event-modifier 'control
4605 (funcall (symbol-function 'event-to-character)
4606 last-input-event) ?\t)
4607 (and (not (event-modifiers last-input-event))
4609 (funcall (symbol-function 'event-to-character)
4610 last-input-event) ?\?)
4612 (funcall (symbol-function 'event-to-character)
4613 last-input-event) ?\ ))))))
4616 ;; Method, host name and user name completion.
4617 ;; `tramp-completion-dissect-file-name' returns a list of
4618 ;; tramp-file-name structures. For all of them we return possible completions.
4620 (defun tramp-completion-handle-file-name-all-completions (filename directory)
4621 "Like `file-name-all-completions' for partial tramp files."
4624 ;; We need to reset `tramp-completion-mode'.
4626 (setq tramp-completion-mode t)
4628 ((fullname (concat directory filename))
4629 ;; possible completion structures
4630 (v (tramp-completion-dissect-file-name fullname))
4634 (let* ((car (car v))
4635 (multi-method (tramp-file-name-multi-method car))
4636 (method (tramp-file-name-method car))
4637 (user (tramp-file-name-user car))
4638 (host (tramp-file-name-host car))
4639 (localname (tramp-file-name-localname car))
4640 (m (tramp-find-method multi-method method user host))
4641 (tramp-current-user user) ; see `tramp-parse-passwd'
4644 (unless (or multi-method ;; Not handled (yet).
4645 localname) ;; Nothing to complete
4649 ;; Method dependent user / host combinations
4653 (setq all-user-hosts
4654 (append all-user-hosts
4655 (funcall (nth 0 x) (nth 1 x)))))
4656 (tramp-get-completion-function m))
4658 (setq result (append result
4661 (tramp-get-completion-user-host
4662 method user host (nth 0 x) (nth 1 x)))
4663 (delq nil all-user-hosts)))))
4667 (append result (tramp-get-completion-methods m)))))
4671 ;; unify list, remove nil elements
4673 (let ((car (car result)))
4674 (when car (add-to-list
4675 'result1 (substring car (length directory))))
4676 (setq result (cdr result))))
4678 ;; Complete local parts
4683 ;; "/ssh:" does not need to be expanded as hostname.
4684 (tramp-run-real-handler
4685 'file-name-all-completions (list filename directory))
4686 ;; No method/user/host found to be expanded.
4687 (tramp-completion-run-real-handler
4688 'file-name-all-completions (list filename directory)))
4691 (setq tramp-completion-mode nil)))
4693 ;; Method, host name and user name completion for a file.
4695 (defun tramp-completion-handle-file-name-completion
4696 (filename directory &optional predicate)
4697 "Like `file-name-completion' for tramp files."
4700 (mapcar 'list (file-name-all-completions filename directory))
4702 (lambda (x) (funcall predicate (expand-file-name (car x) directory))))))
4704 ;; I misuse a little bit the tramp-file-name structure in order to handle
4705 ;; completion possibilities for partial methods / user names / host names.
4706 ;; Return value is a list of tramp-file-name structures according to possible
4707 ;; completions. If "multi-method" or "localname" is non-nil it means there
4708 ;; shouldn't be a completion anymore.
4710 ;; Expected results:
4712 ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y"
4713 ;; [nil nil nil "x" nil] [nil nil "x" nil nil] [nil nil "x" "y" nil]
4714 ;; [nil nil "x" nil nil]
4715 ;; [nil "x" nil nil nil]
4717 ;; "/x:" "/x:y" "/x:y:"
4718 ;; [nil nil nil "x" ""] [nil nil nil "x" "y"] [nil "x" nil "y" ""]
4720 ;; [nil "x" nil "" nil] [nil "x" nil "y" nil]
4721 ;; [nil "x" "" nil nil] [nil "x" "y" nil nil]
4723 ;; "/x:y@" "/x:y@z" "/x:y@z:"
4724 ;; [nil nil nil "x" "y@"] [nil nil nil "x" "y@z"] [nil "x" "y" "z" ""]
4725 ;; "/[x/y@" "/[x/y@z"
4726 ;; [nil "x" nil "y" nil] [nil "x" "y" "z" nil]
4727 (defun tramp-completion-dissect-file-name (name)
4728 "Returns a list of `tramp-file-name' structures.
4729 They are collected by `tramp-completion-dissect-file-name1'."
4733 ;; "/method" "/[method"
4734 (tramp-completion-file-name-structure1
4735 (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$")
4738 (tramp-completion-file-name-structure2
4739 (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$")
4742 (tramp-completion-file-name-structure3
4743 (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$")
4745 ;; "/user@host" "/[user@host"
4746 (tramp-completion-file-name-structure4
4747 (list (concat tramp-prefix-regexp
4748 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4749 "\\(" tramp-host-regexp x-nil "\\)$")
4751 ;; "/method:user" "/[method/user"
4752 (tramp-completion-file-name-structure5
4753 (list (concat tramp-prefix-regexp
4754 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4755 "\\(" tramp-user-regexp x-nil "\\)$")
4757 ;; "/method:host" "/[method/host"
4758 (tramp-completion-file-name-structure6
4759 (list (concat tramp-prefix-regexp
4760 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4761 "\\(" tramp-host-regexp x-nil "\\)$")
4763 ;; "/method:user@host" "/[method/user@host"
4764 (tramp-completion-file-name-structure7
4765 (list (concat tramp-prefix-regexp
4766 "\\(" tramp-method-regexp "\\)" tramp-postfix-single-method-regexp
4767 "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp
4768 "\\(" tramp-host-regexp x-nil "\\)$")
4773 (add-to-list 'result (tramp-completion-dissect-file-name1 regexp name)))
4775 tramp-completion-file-name-structure1
4776 tramp-completion-file-name-structure2
4777 tramp-completion-file-name-structure3
4778 tramp-completion-file-name-structure4
4779 tramp-completion-file-name-structure5
4780 tramp-completion-file-name-structure6
4781 tramp-completion-file-name-structure7
4782 tramp-file-name-structure))
4786 (defun tramp-completion-dissect-file-name1 (structure name)
4787 "Returns a `tramp-file-name' structure matching STRUCTURE.
4788 The structure consists of multi-method, remote method, remote user,
4789 remote host and localname (filename on remote host)."
4793 (when (string-match (nth 0 structure) name)
4794 (setq method (and (nth 1 structure)
4795 (match-string (nth 1 structure) name)))
4796 (if (and method (member method tramp-multi-methods))
4797 ;; Not handled (yet).
4798 (vector method nil nil nil nil)
4799 (let ((user (and (nth 2 structure)
4800 (match-string (nth 2 structure) name)))
4801 (host (and (nth 3 structure)
4802 (match-string (nth 3 structure) name)))
4803 (localname (and (nth 4 structure)
4804 (match-string (nth 4 structure) name))))
4805 (vector nil method user host localname)))))))
4807 ;; This function returns all possible method completions, adding the
4808 ;; trailing method delimeter.
4809 (defun tramp-get-completion-methods (partial-method)
4810 "Returns all method completions for PARTIAL-METHOD."
4814 (string-match (concat "^" (regexp-quote partial-method)) method)
4815 (tramp-make-tramp-file-name nil method nil nil nil)))
4816 (delete "multi" (mapcar 'car tramp-methods))))
4818 ;; Compares partial user and host names with possible completions.
4819 (defun tramp-get-completion-user-host (method partial-user partial-host user host)
4820 "Returns the most expanded string for user and host name completion.
4821 PARTIAL-USER must match USER, PARTIAL-HOST must match HOST."
4824 ((and partial-user partial-host)
4826 (string-match (concat "^" (regexp-quote partial-host)) host)
4827 (string-equal partial-user (or user partial-user)))
4828 (setq user partial-user)
4835 (and user (string-match (concat "^" (regexp-quote partial-user)) user))
4841 (and host (string-match (concat "^" (regexp-quote partial-host)) host))
4847 (unless (zerop (+ (length user) (length host)))
4848 (tramp-make-tramp-file-name nil method user host nil)))
4850 (defun tramp-parse-rhosts (filename)
4851 "Return a list of (user host) tuples allowed to access.
4852 Either user or host may be nil."
4855 (when (file-readable-p filename)
4857 (insert-file-contents filename)
4858 (goto-char (point-min))
4860 (push (tramp-parse-rhosts-group) res))))
4863 ;; Taken from gnus/netrc.el
4865 (defalias 'tramp-point-at-eol
4866 (if (fboundp 'point-at-eol)
4868 'line-end-position)))
4870 (defun tramp-parse-rhosts-group ()
4871 "Return a (user host) tuple allowed to access.
4872 Either user or host may be nil."
4877 "^\\(" tramp-host-regexp "\\)"
4878 "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
4880 (narrow-to-region (point) (tramp-point-at-eol))
4881 (when (re-search-forward regexp nil t)
4882 (setq result (append (list (match-string 3) (match-string 1)))))
4887 (defun tramp-parse-shosts (filename)
4888 "Return a list of (user host) tuples allowed to access.
4889 User is always nil."
4892 (when (file-readable-p filename)
4894 (insert-file-contents filename)
4895 (goto-char (point-min))
4897 (push (tramp-parse-shosts-group) res))))
4900 (defun tramp-parse-shosts-group ()
4901 "Return a (user host) tuple allowed to access.
4902 User is always nil."
4905 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
4907 (narrow-to-region (point) (tramp-point-at-eol))
4908 (when (re-search-forward regexp nil t)
4909 (setq result (list nil (match-string 1))))
4912 (> (skip-chars-forward ",") 0)
4916 (defun tramp-parse-sconfig (filename)
4917 "Return a list of (user host) tuples allowed to access.
4918 User is always nil."
4921 (when (file-readable-p filename)
4923 (insert-file-contents filename)
4924 (goto-char (point-min))
4926 (push (tramp-parse-sconfig-group) res))))
4929 (defun tramp-parse-sconfig-group ()
4930 "Return a (user host) tuple allowed to access.
4931 User is always nil."
4934 (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)")))
4936 (narrow-to-region (point) (tramp-point-at-eol))
4937 (when (re-search-forward regexp nil t)
4938 (setq result (list nil (match-string 1))))
4941 (> (skip-chars-forward ",") 0)
4945 (defun tramp-parse-shostkeys (dirname)
4946 "Return a list of (user host) tuples allowed to access.
4947 User is always nil."
4949 (let ((regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$"))
4950 (files (when (file-directory-p dirname) (directory-files dirname)))
4954 (when (string-match regexp (car files))
4955 (push (list nil (match-string 1 (car files))) result))
4956 (setq files (cdr files)))
4959 (defun tramp-parse-sknownhosts (dirname)
4960 "Return a list of (user host) tuples allowed to access.
4961 User is always nil."
4963 (let ((regexp (concat "^\\(" tramp-host-regexp
4964 "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$"))
4965 (files (when (file-directory-p dirname) (directory-files dirname)))
4969 (when (string-match regexp (car files))
4970 (push (list nil (match-string 1 (car files))) result))
4971 (setq files (cdr files)))
4974 (defun tramp-parse-hosts (filename)
4975 "Return a list of (user host) tuples allowed to access.
4976 User is always nil."
4979 (when (file-readable-p filename)
4981 (insert-file-contents filename)
4982 (goto-char (point-min))
4984 (push (tramp-parse-hosts-group) res))))
4987 (defun tramp-parse-hosts-group ()
4988 "Return a (user host) tuple allowed to access.
4989 User is always nil."
4992 (regexp (concat "^\\(" tramp-host-regexp "\\)")))
4994 (narrow-to-region (point) (tramp-point-at-eol))
4995 (when (re-search-forward regexp nil t)
4996 (unless (char-equal (or (char-after) ?\n) ?:) ; no IPv6
4997 (setq result (list nil (match-string 1)))))
5000 (> (skip-chars-forward " \t") 0)
5004 ;; For su-alike methods it would be desirable to return "root@localhost"
5005 ;; as default. Unfortunately, we have no information whether any user name
5006 ;; has been typed already. So we (mis-)use tramp-current-user as indication,
5007 ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'.
5008 (defun tramp-parse-passwd (filename)
5009 "Return a list of (user host) tuples allowed to access.
5010 Host is always \"localhost\"."
5013 (if (zerop (length tramp-current-user))
5015 (when (file-readable-p filename)
5017 (insert-file-contents filename)
5018 (goto-char (point-min))
5020 (push (tramp-parse-passwd-group) res))))
5023 (defun tramp-parse-passwd-group ()
5024 "Return a (user host) tuple allowed to access.
5025 Host is always \"localhost\"."
5028 (regexp (concat "^\\(" tramp-user-regexp "\\):")))
5030 (narrow-to-region (point) (tramp-point-at-eol))
5031 (when (re-search-forward regexp nil t)
5032 (setq result (list (match-string 1) "localhost")))
5037 (defun tramp-parse-netrc (filename)
5038 "Return a list of (user host) tuples allowed to access.
5042 (when (file-readable-p filename)
5044 (insert-file-contents filename)
5045 (goto-char (point-min))
5047 (push (tramp-parse-netrc-group) res))))
5050 (defun tramp-parse-netrc-group ()
5051 "Return a (user host) tuple allowed to access.
5057 "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)"
5058 "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?")))
5060 (narrow-to-region (point) (tramp-point-at-eol))
5061 (when (re-search-forward regexp nil t)
5062 (setq result (list (match-string 3) (match-string 1))))
5067 ;;; Internal Functions:
5069 (defun tramp-maybe-send-perl-script (multi-method method user host script name)
5070 "Define in remote shell function NAME implemented as perl SCRIPT.
5071 Only send the definition if it has not already been done.
5072 Function may have 0-3 parameters."
5073 (let ((remote-perl (tramp-get-remote-perl multi-method method user host)))
5074 (unless remote-perl (error "No remote perl"))
5075 (let ((perl-scripts (tramp-get-connection-property "perl-scripts" nil
5076 multi-method method user host)))
5077 (unless (memq name perl-scripts)
5078 (with-current-buffer (tramp-get-buffer multi-method method user host)
5079 (tramp-message 5 (concat "Sending the Perl script `" name "'..."))
5080 (tramp-send-string multi-method method user host
5086 "' \"$1\" \"$2\" \"$3\" 2>/dev/null\n}"))
5087 (tramp-wait-for-output)
5088 (tramp-set-connection-property "perl-scripts" (cons name perl-scripts)
5089 multi-method method user host)
5090 (tramp-message 5 (concat "Sending the Perl script `" name "'...done.")))))))
5092 (defun tramp-set-auto-save ()
5093 (when (and (buffer-file-name)
5094 (tramp-tramp-file-p (buffer-file-name))
5095 ;; ange-ftp has its own auto-save mechanism
5096 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
5097 'tramp-sh-file-name-handler)
5099 (auto-save-mode 1)))
5100 (add-hook 'find-file-hooks 'tramp-set-auto-save t)
5101 (add-hook 'tramp-unload-hook
5103 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
5105 (defun tramp-run-test (switch filename)
5106 "Run `test' on the remote system, given a SWITCH and a FILENAME.
5107 Returns the exit code of the `test' program."
5108 (let ((v (tramp-dissect-file-name filename)))
5110 (tramp-send-command-and-check
5111 (tramp-file-name-multi-method v) (tramp-file-name-method v)
5112 (tramp-file-name-user v) (tramp-file-name-host v)
5113 (format "test %s %s" switch
5114 (tramp-shell-quote-argument (tramp-file-name-localname v)))))))
5116 (defun tramp-run-test2 (program file1 file2 &optional switch)
5117 "Run `test'-like PROGRAM on the remote system, given FILE1, FILE2.
5118 The optional SWITCH is inserted between the two files.
5119 Returns the exit code of the `test' PROGRAM. Barfs if the methods,
5120 hosts, or files, disagree."
5121 (let* ((v1 (tramp-dissect-file-name file1))
5122 (v2 (tramp-dissect-file-name file2))
5123 (mmethod1 (tramp-file-name-multi-method v1))
5124 (mmethod2 (tramp-file-name-multi-method v2))
5125 (method1 (tramp-file-name-method v1))
5126 (method2 (tramp-file-name-method v2))
5127 (user1 (tramp-file-name-user v1))
5128 (user2 (tramp-file-name-user v2))
5129 (host1 (tramp-file-name-host v1))
5130 (host2 (tramp-file-name-host v2))
5131 (localname1 (tramp-file-name-localname v1))
5132 (localname2 (tramp-file-name-localname v2)))
5133 (unless (and method1 method2 host1 host2
5134 (equal mmethod1 mmethod2)
5135 (equal method1 method2)
5137 (equal host1 host2))
5138 (error "tramp-run-test2: %s"
5139 "only implemented for same method, same user, same host"))
5141 (tramp-send-command-and-check
5142 mmethod1 method1 user1 host1
5143 (format "%s %s %s %s"
5145 (tramp-shell-quote-argument localname1)
5147 (tramp-shell-quote-argument localname2))))))
5149 (defun tramp-touch (file time)
5150 "Set the last-modified timestamp of the given file.
5151 TIME is an Emacs internal time value as returned by `current-time'."
5153 ;; With GNU Emacs, `format-time-string' has an optional
5154 ;; parameter UNIVERSAL. This is preferred.
5155 (and (functionp 'subr-arity)
5156 (= 3 (cdr (funcall (symbol-function 'subr-arity)
5157 (symbol-function 'format-time-string))))))
5160 (format-time-string "%Y%m%d%H%M.%S" time t)
5161 (format-time-string "%Y%m%d%H%M.%S" time))))
5162 (if (tramp-tramp-file-p file)
5163 (with-parsed-tramp-file-name file nil
5164 (let ((buf (tramp-get-buffer multi-method method user host)))
5165 (unless (zerop (tramp-send-command-and-check
5166 multi-method method user host
5167 (format "%s touch -t %s %s"
5168 (if utc "TZ=UTC; export TZ;" "")
5170 (tramp-shell-quote-argument localname))
5173 (error "tramp-touch: touch failed, see buffer `%s' for details"
5175 ;; It's a local file
5177 (unless (zerop (call-process
5178 "touch" nil (current-buffer) nil "-t" touch-time file))
5179 (pop-to-buffer (current-buffer))
5180 (error "tramp-touch: touch failed"))))))
5182 (defun tramp-buffer-name (multi-method method user host)
5183 "A name for the connection buffer for USER at HOST using METHOD."
5185 (tramp-buffer-name-multi-method "tramp" multi-method method user host)
5186 (let ((method (tramp-find-method multi-method method user host)))
5188 (format "*tramp/%s %s@%s*" method user host)
5189 (format "*tramp/%s %s*" method host)))))
5191 (defun tramp-buffer-name-multi-method (prefix multi-method method user host)
5192 "A name for the multi method connection buffer.
5193 MULTI-METHOD gives the multi method, METHOD the array of methods,
5194 USER the array of user names, HOST the array of host names."
5195 (unless (and (= (length method) (length user))
5196 (= (length method) (length host)))
5197 (error "Syntax error in multi method (implementation error)"))
5198 (let ((len (length method))
5203 (cons (if (aref user i)
5204 (format "%s#%s@%s:" (aref method i)
5205 (aref user i) (aref host i))
5206 (format "%s@%s:" (aref method i) (aref host i)))
5209 (format "*%s/%s %s*"
5211 (apply 'concat (reverse string-list)))))
5213 (defun tramp-get-buffer (multi-method method user host)
5214 "Get the connection buffer to be used for USER at HOST using METHOD."
5215 (with-current-buffer
5216 (get-buffer-create (tramp-buffer-name multi-method method user host))
5217 (setq buffer-undo-list t)
5220 (defun tramp-debug-buffer-name (multi-method method user host)
5221 "A name for the debug buffer for USER at HOST using METHOD."
5223 (tramp-buffer-name-multi-method "debug tramp"
5224 multi-method method user host)
5225 (let ((method (tramp-find-method multi-method method user host)))
5227 (format "*debug tramp/%s %s@%s*" method user host)
5228 (format "*debug tramp/%s %s*" method host)))))
5230 (defun tramp-get-debug-buffer (multi-method method user host)
5231 "Get the debug buffer for USER at HOST using METHOD."
5232 (with-current-buffer
5234 (tramp-debug-buffer-name multi-method method user host))
5235 (setq buffer-undo-list t)
5238 (defun tramp-find-executable (multi-method method user host
5239 progname dirlist ignore-tilde)
5240 "Searches for PROGNAME in all directories mentioned in DIRLIST.
5241 First args METHOD, USER and HOST specify the connection, PROGNAME
5242 is the program to search for, and DIRLIST gives the list of directories
5243 to search. If IGNORE-TILDE is non-nil, directory names starting
5244 with `~' will be ignored.
5246 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
5248 This function expects to be in the right *tramp* buffer."
5251 ;; Remove all ~/foo directories from dirlist. In Emacs 20,
5252 ;; `remove' is in CL, and we want to avoid CL dependencies.
5255 (setq d (car dirlist))
5256 (setq dirlist (cdr dirlist))
5257 (unless (char-equal ?~ (aref d 0))
5258 (setq newdl (cons d newdl))))
5259 (setq dirlist (nreverse newdl))))
5261 multi-method method user host
5262 (format (concat "while read d; "
5263 "do if test -x $d/%s -a -f $d/%s; "
5264 "then echo tramp_executable $d/%s; "
5265 "break; fi; done <<'EOF'")
5266 progname progname progname))
5268 (tramp-send-command multi-method method user host d))
5270 (tramp-send-command multi-method method user host "EOF")
5271 (tramp-wait-for-output)
5272 (goto-char (point-max))
5273 (when (search-backward "tramp_executable " nil t)
5274 (skip-chars-forward "^ ")
5275 (skip-chars-forward " ")
5276 (buffer-substring (point) (tramp-line-end-position)))))
5278 (defun tramp-set-remote-path (multi-method method user host var dirlist)
5279 "Sets the remote environment VAR to existing directories from DIRLIST.
5280 I.e., for each directory in DIRLIST, it is tested whether it exists and if
5281 so, it is added to the environment variable VAR."
5282 (let ((existing-dirs
5287 (tramp-make-tramp-file-name multi-method method user host x))
5289 (tramp-make-tramp-file-name multi-method method user host x)))
5293 multi-method method user host
5295 (mapconcat 'identity (delq nil existing-dirs) ":")
5297 (tramp-wait-for-output)))
5299 ;; -- communication with external shell --
5301 (defun tramp-find-file-exists-command (multi-method method user host)
5302 "Find a command on the remote host for checking if a file exists.
5303 Here, we are looking for a command which has zero exit status if the
5304 file exists and nonzero exit status otherwise."
5305 (make-local-variable 'tramp-file-exists-command)
5306 (tramp-message 9 "Finding command to check if file exists")
5308 (tramp-make-tramp-file-name
5309 multi-method method user host
5310 "/")) ;assume this file always exists
5312 (tramp-make-tramp-file-name
5313 multi-method method user host
5314 "/ this file does not exist "))) ;assume this never exists
5315 ;; The algorithm is as follows: we try a list of several commands.
5316 ;; For each command, we first run `$cmd /' -- this should return
5317 ;; true, as the root directory always exists. And then we run
5318 ;; `$cmd /this\ file\ does\ not\ exist', hoping that the file indeed
5319 ;; does not exist. This should return false. We use the first
5320 ;; command we find that seems to work.
5321 ;; The list of commands to try is as follows:
5322 ;; `ls -d' This works on most systems, but NetBSD 1.4
5323 ;; has a bug: `ls' always returns zero exit
5324 ;; status, even for files which don't exist.
5325 ;; `test -e' Some Bourne shells have a `test' builtin
5326 ;; which does not know the `-e' option.
5327 ;; `/bin/test -e' For those, the `test' binary on disk normally
5328 ;; provides the option. Alas, the binary
5329 ;; is sometimes `/bin/test' and sometimes it's
5331 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
5333 (and (setq tramp-file-exists-command "test -e %s")
5334 (file-exists-p existing)
5335 (not (file-exists-p nonexisting)))
5336 (and (setq tramp-file-exists-command "/bin/test -e %s")
5337 (file-exists-p existing)
5338 (not (file-exists-p nonexisting)))
5339 (and (setq tramp-file-exists-command "/usr/bin/test -e %s")
5340 (file-exists-p existing)
5341 (not (file-exists-p nonexisting)))
5342 (and (setq tramp-file-exists-command "ls -d %s")
5343 (file-exists-p existing)
5344 (not (file-exists-p nonexisting))))
5345 (error "Couldn't find command to check if file exists"))))
5348 ;; CCC test ksh or bash found for tilde expansion?
5349 (defun tramp-find-shell (multi-method method user host)
5350 "Find a shell on the remote host which groks tilde expansion."
5352 (tramp-send-command multi-method method user host "echo ~root")
5353 (tramp-wait-for-output)
5355 ((string-match "^~root$" (buffer-string))
5357 (or (tramp-find-executable multi-method method user host
5358 "bash" tramp-remote-path t)
5359 (tramp-find-executable multi-method method user host
5360 "ksh" tramp-remote-path t)))
5362 (error "Couldn't find a shell which groks tilde expansion"))
5363 ;; Find arguments for this shell.
5364 (let ((alist tramp-sh-extra-args)
5366 (while (and alist (null extra-args))
5367 (setq item (pop alist))
5368 (when (string-match (car item) shell)
5369 (setq extra-args (cdr item))))
5370 (when extra-args (setq shell (concat shell " " extra-args))))
5372 5 "Starting remote shell `%s' for tilde expansion..." shell)
5374 multi-method method user host
5375 (concat "PROMPT_COMMAND='' PS1='$ ' exec " shell)) ;
5376 (tramp-barf-if-no-shell-prompt
5377 (get-buffer-process (current-buffer))
5378 60 "Couldn't find remote `%s' prompt" shell)
5380 9 "Setting remote shell prompt...")
5381 ;; Douglas Gray Stephens <DGrayStephens@slb.com> says that we
5382 ;; must use "\n" here, not tramp-rsh-end-of-line. Kai left the
5383 ;; last tramp-rsh-end-of-line, Douglas wanted to replace that,
5385 (process-send-string
5386 nil (format "PROMPT_COMMAND=''; PS1='%s%s%s'; PS2=''; PS3=''%s"
5387 tramp-rsh-end-of-line
5389 tramp-rsh-end-of-line
5390 tramp-rsh-end-of-line))
5391 (tramp-wait-for-output)
5393 9 "Setting remote shell prompt...done")
5395 (t (tramp-message 5 "Remote `%s' groks tilde expansion, good"
5396 (tramp-get-method-parameter
5397 multi-method method user host 'tramp-remote-sh))))))
5399 (defun tramp-check-ls-command (multi-method method user host cmd)
5400 "Checks whether the given `ls' executable groks `-n'.
5401 METHOD, USER and HOST specify the connection, CMD (the absolute file name of)
5402 the `ls' executable. Returns t if CMD supports the `-n' option, nil
5404 (tramp-message 9 "Checking remote `%s' command for `-n' option" cmd)
5405 (when (file-executable-p
5406 (tramp-make-tramp-file-name multi-method method user host cmd))
5408 (tramp-message 7 "Testing remote command `%s' for -n..." cmd)
5410 (tramp-send-command-and-check
5411 multi-method method user host
5412 (format "%s -lnd / >/dev/null"
5414 (tramp-message 7 "Testing remote command `%s' for -n...%s"
5416 (if (zerop result) "okay" "failed"))
5419 (defun tramp-check-ls-commands (multi-method method user host cmd dirlist)
5420 "Checks whether the given `ls' executable in one of the dirs groks `-n'.
5421 Returns nil if none was found, else the command is returned."
5424 (tramp-let-maybe directory-sep-char ?/ ;for XEmacs
5425 ;; It would be better to use the CL function `find', but
5426 ;; we don't want run-time dependencies on CL.
5427 (while (and dl (not result))
5428 (let ((x (concat (file-name-as-directory (car dl)) cmd)))
5429 (when (tramp-check-ls-command multi-method method user host x)
5434 (defun tramp-find-ls-command (multi-method method user host)
5435 "Finds an `ls' command which groks the `-n' option, returning nil if failed.
5436 \(This option prints numeric user and group ids in a long listing.)"
5437 (tramp-message 9 "Finding a suitable `ls' command")
5439 (tramp-check-ls-commands multi-method method user host "ls" tramp-remote-path)
5440 (tramp-check-ls-commands multi-method method user host "gnuls" tramp-remote-path)
5441 (tramp-check-ls-commands multi-method method user host "gls" tramp-remote-path)))
5443 ;; ------------------------------------------------------------
5444 ;; -- Functions for establishing connection --
5445 ;; ------------------------------------------------------------
5447 ;; The following functions are actions to be taken when seeing certain
5448 ;; prompts from the remote host. See the variable
5449 ;; `tramp-actions-before-shell' for usage of these functions.
5451 (defun tramp-action-login (p multi-method method user host)
5452 "Send the login name."
5453 (tramp-message 9 "Sending login name `%s'"
5454 (or user (user-login-name)))
5456 (process-send-string nil (concat (or user (user-login-name))
5457 tramp-rsh-end-of-line)))
5459 (defun tramp-action-password (p multi-method method user host)
5460 "Query the user for a password."
5462 (format "Password for %s "
5463 (tramp-make-tramp-file-name
5464 nil method user host ""))))
5465 (tramp-message 9 "Sending password")
5466 (tramp-enter-password p pw-prompt user host)))
5468 (defun tramp-action-succeed (p multi-method method user host)
5469 "Signal success in finding shell prompt."
5470 (tramp-message 9 "Found remote shell prompt.")
5472 (throw 'tramp-action 'ok))
5474 (defun tramp-action-permission-denied (p multi-method method user host)
5475 "Signal permission denied."
5476 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5477 (tramp-message 9 "Permission denied by remote host.")
5479 (throw 'tramp-action 'permission-denied))
5481 (defun tramp-action-copy-failed (p multi-method method user host)
5482 "Signal copy failed."
5484 (error "%s" (match-string 1)))
5486 (defun tramp-action-yesno (p multi-method method user host)
5487 "Ask the user for confirmation using `yes-or-no-p'.
5488 Send \"yes\" to remote process on confirmation, abort otherwise.
5489 See also `tramp-action-yn'."
5490 (save-window-excursion
5491 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5492 (unless (yes-or-no-p (match-string 0))
5495 (throw 'tramp-action 'permission-denied))
5496 (process-send-string p (concat "yes" tramp-rsh-end-of-line))
5499 (defun tramp-action-yn (p multi-method method user host)
5500 "Ask the user for confirmation using `y-or-n-p'.
5501 Send \"y\" to remote process on confirmation, abort otherwise.
5502 See also `tramp-action-yesno'."
5503 (save-window-excursion
5504 (pop-to-buffer (tramp-get-buffer multi-method method user host))
5505 (unless (y-or-n-p (match-string 0))
5507 (throw 'tramp-action 'permission-denied))
5509 (process-send-string p (concat "y" tramp-rsh-end-of-line))))
5511 (defun tramp-action-terminal (p multi-method method user host)
5512 "Tell the remote host which terminal type to use.
5513 The terminal type can be configured with `tramp-terminal-type'."
5514 (tramp-message 9 "Setting `%s' as terminal type."
5515 tramp-terminal-type)
5517 (process-send-string nil (concat tramp-terminal-type
5518 tramp-rsh-end-of-line)))
5520 (defun tramp-action-process-alive (p multi-method method user host)
5521 "Check whether a process has finished."
5522 (unless (memq (process-status p) '(run open))
5523 (throw 'tramp-action 'process-died)))
5525 (defun tramp-action-out-of-band (p multi-method method user host)
5526 "Check whether an out-of-band copy has finished."
5527 (cond ((and (memq (process-status p) '(stop exit))
5528 (zerop (process-exit-status p)))
5529 (tramp-message 9 "Process has finished.")
5530 (throw 'tramp-action 'ok))
5531 ((or (and (memq (process-status p) '(stop exit))
5532 (not (zerop (process-exit-status p))))
5533 (memq (process-status p) '(signal)))
5534 ;; `scp' could have copied correctly, but set modes could have failed.
5535 ;; This can be ignored.
5536 (goto-char (point-min))
5537 (if (re-search-forward tramp-operation-not-permitted-regexp nil t)
5539 (tramp-message 10 "'set mode' error ignored.")
5540 (tramp-message 9 "Process has finished.")
5541 (throw 'tramp-action 'ok))
5542 (tramp-message 9 "Process has died.")
5543 (throw 'tramp-action 'process-died)))
5546 ;; The following functions are specifically for multi connections.
5548 (defun tramp-multi-action-login (p method user host)
5549 "Send the login name."
5550 (tramp-message 9 "Sending login name `%s'" user)
5552 (process-send-string p (concat user tramp-rsh-end-of-line)))
5554 (defun tramp-multi-action-password (p method user host)
5555 "Query the user for a password."
5557 (format "Password for %s "
5558 (tramp-make-tramp-file-name
5559 nil method user host ""))))
5560 (tramp-message 9 "Sending password")
5561 (tramp-enter-password p pw-prompt user host)))
5563 (defun tramp-multi-action-succeed (p method user host)
5564 "Signal success in finding shell prompt."
5565 (tramp-message 9 "Found shell prompt on `%s'" host)
5567 (throw 'tramp-action 'ok))
5569 (defun tramp-multi-action-permission-denied (p method user host)
5570 "Signal permission denied."
5571 (tramp-message 9 "Permission denied by remote host `%s'" host)
5574 (throw 'tramp-action 'permission-denied))
5576 (defun tramp-multi-action-process-alive (p method user host)
5577 "Check whether a process has finished."
5578 (unless (memq (process-status p) '(run open))
5579 (throw 'tramp-action 'process-died)))
5581 ;; Functions for processing the actions.
5583 (defun tramp-process-one-action (p multi-method method user host actions)
5584 "Wait for output from the shell and perform one action."
5585 (let (found item pattern action todo)
5587 (tramp-message 9 "Waiting 60s for prompt from remote shell")
5589 (tramp-accept-process-output p 1)
5590 (goto-char (point-min))
5593 (goto-char (point-min))
5594 (setq item (pop todo))
5595 (setq pattern (symbol-value (nth 0 item)))
5596 (setq action (nth 1 item))
5597 (tramp-message 10 "Looking for regexp \"%s\" from remote shell"
5599 (when (re-search-forward (concat pattern "\\'") nil t)
5600 (setq found (funcall action p multi-method method user host)))))
5603 (defun tramp-process-actions
5604 (p multi-method method user host actions &optional timeout)
5605 "Perform actions until success or TIMEOUT."
5606 (tramp-message 10 "%s" (mapconcat 'identity (process-command p) " "))
5609 (tramp-message 9 "Waiting for prompts from remote shell")
5611 (catch 'tramp-action
5613 (with-timeout (timeout)
5614 (tramp-process-one-action
5615 p multi-method method user host actions))
5616 (tramp-process-one-action
5617 p multi-method method user host actions))
5619 (unless (eq exit 'ok)
5620 (tramp-clear-passwd user host)
5621 (error "Login failed"))))
5623 ;; For multi-actions.
5625 (defun tramp-process-one-multi-action (p method user host actions)
5626 "Wait for output from the shell and perform one action."
5627 (let (found item pattern action todo)
5629 (tramp-message 9 "Waiting 60s for prompt from remote shell")
5630 (with-timeout (60 (throw 'tramp-action 'timeout))
5632 (tramp-accept-process-output p 1)
5634 (goto-char (point-min))
5636 (goto-char (point-min))
5637 (setq item (pop todo))
5638 (setq pattern (symbol-value (nth 0 item)))
5639 (setq action (nth 1 item))
5640 (tramp-message 10 "Looking for regexp \"%s\" from remote shell"
5642 (when (re-search-forward (concat pattern "\\'") nil t)
5643 (setq found (funcall action p method user host)))))
5646 (defun tramp-process-multi-actions (p method user host actions)
5647 "Perform actions until success."
5650 (tramp-message 9 "Waiting for prompts from remote shell")
5652 (catch 'tramp-action
5653 (tramp-process-one-multi-action p method user host actions)
5655 (unless (eq exit 'ok)
5656 (tramp-clear-passwd user host)
5657 (error "Login failed"))))
5659 ;; Functions to execute when we have seen the remote shell prompt but
5660 ;; before we exec the Bourne-ish shell. Note that these commands
5661 ;; might be sent to any shell, not just a Bourne-ish shell. This
5662 ;; means that the commands need to work in all shells. (It is also
5663 ;; okay for some commands to just fail with an error message, but
5664 ;; please make sure that they at least don't crash the odd shell people
5665 ;; might be running...)
5666 (defun tramp-process-initial-commands (p
5667 multi-method method user host
5669 "Send list of commands to remote host, in order."
5672 (setq cmd (pop commands))
5674 (tramp-message 10 "Sending command to remote shell: %s"
5676 (tramp-send-command multi-method method user host cmd nil t)
5677 (tramp-barf-if-no-shell-prompt
5678 p 60 "Remote shell command failed: %s" cmd))
5681 ;; The actual functions for opening connections.
5683 (defun tramp-open-connection-telnet (multi-method method user host)
5684 "Open a connection using a telnet METHOD.
5685 This starts the command `telnet HOST ARGS'[*], then waits for a remote
5686 login prompt, then sends the user name USER, then waits for a remote
5687 password prompt. It queries the user for the password, then sends the
5688 password to the remote host.
5690 If USER is nil, uses value returned by `(user-login-name)' instead.
5692 Recognition of the remote shell prompt is based on the variables
5693 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5696 Please note that it is NOT possible to use this connection method
5697 together with an out-of-band transfer method! You must use an inline
5700 Maybe the different regular expressions need to be tuned.
5702 * Actually, the telnet program as well as the args to be used can be
5703 specified in the method parameters, see the variable `tramp-methods'."
5705 (when (tramp-method-out-of-band-p multi-method method user host)
5706 (error "Cannot use out-of-band method `%s' with telnet connection method"
5709 (error "Cannot multi-connect using telnet connection method"))
5710 (tramp-pre-connection multi-method method user host tramp-chunksize)
5711 (tramp-message 7 "Opening connection for %s@%s using %s..."
5712 (or user (user-login-name)) host method)
5713 (let ((process-environment (copy-sequence process-environment)))
5714 (setenv "TERM" tramp-terminal-type)
5715 (setenv "LC_ALL" "C")
5716 (setenv "PROMPT_COMMAND")
5718 (let* ((default-directory (tramp-temporary-file-directory))
5719 ;; If we omit the conditional here, then we would use
5720 ;; `undecided-dos' in some cases. With the conditional,
5721 ;; we use nil in these cases. Which one is right?
5722 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5723 (> emacs-major-version 20))
5724 tramp-dos-coding-system))
5725 (p (apply 'start-process
5726 (tramp-buffer-name multi-method method user host)
5727 (tramp-get-buffer multi-method method user host)
5728 (tramp-get-method-parameter
5730 (tramp-find-method multi-method method user host)
5731 user host 'tramp-login-program)
5733 (tramp-get-method-parameter
5735 (tramp-find-method multi-method method user host)
5736 user host 'tramp-login-args)))
5739 (tramp-set-process-query-on-exit-flag p nil)
5740 (set-buffer (tramp-get-buffer multi-method method user host))
5742 (tramp-process-actions p multi-method method user host
5743 tramp-actions-before-shell 60)
5744 (tramp-open-connection-setup-interactive-shell
5745 p multi-method method user host)
5746 (tramp-post-connection multi-method method user host)))))
5749 (defun tramp-open-connection-rsh (multi-method method user host)
5750 "Open a connection using an rsh METHOD.
5751 This starts the command `rsh HOST -l USER'[*], then waits for a remote
5752 password or shell prompt. If a password prompt is seen, the user is
5753 queried for a password, this function sends the password to the remote
5754 host and waits for a shell prompt.
5756 If USER is nil, start the command `rsh HOST'[*] instead
5758 Recognition of the remote shell prompt is based on the variables
5759 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5762 Kludgy feature: if HOST has the form \"xx#yy\", then yy is assumed to
5763 be a port number for ssh, and \"-p yy\" will be added to the list of
5764 arguments, and xx will be used as the host name to connect to.
5766 * Actually, the rsh program to be used can be specified in the
5767 method parameters, see the variable `tramp-methods'."
5770 (error "Cannot multi-connect using rsh connection method"))
5771 (tramp-pre-connection multi-method method user host tramp-chunksize)
5772 (if (and user (not (string= user "")))
5773 (tramp-message 7 "Opening connection for %s@%s using %s..."
5775 (tramp-message 7 "Opening connection at %s using %s..." host method))
5776 (let ((process-environment (copy-sequence process-environment))
5777 (bufnam (tramp-buffer-name multi-method method user host))
5778 (buf (tramp-get-buffer multi-method method user host))
5779 (login-program (tramp-get-method-parameter
5781 (tramp-find-method multi-method method user host)
5782 user host 'tramp-login-program))
5786 x `((?t . ,(format "/tmp/%s" tramp-temp-name-prefix)))))
5787 (tramp-get-method-parameter
5789 (tramp-find-method multi-method method user host)
5790 user host 'tramp-login-args)))
5792 ;; The following should be changed. We need a more general
5793 ;; mechanism to parse extra host args.
5794 (when (string-match "\\([^#]*\\)#\\(.*\\)" host)
5795 (setq login-args (cons "-p" (cons (match-string 2 host) login-args)))
5796 (setq real-host (match-string 1 host)))
5797 (setenv "TERM" tramp-terminal-type)
5798 (setenv "LC_ALL" "C")
5799 (setenv "PROMPT_COMMAND")
5801 (let* ((default-directory (tramp-temporary-file-directory))
5802 ;; If we omit the conditional, we would use
5803 ;; `undecided-dos' in some cases. With the conditional,
5804 ;; we use nil in these cases. Which one is right?
5805 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5806 (> emacs-major-version 20))
5807 tramp-dos-coding-system))
5808 (p (if (and user (not (string= user "")))
5809 (apply #'start-process bufnam buf login-program
5810 real-host "-l" user login-args)
5811 (apply #'start-process bufnam buf login-program
5812 real-host login-args)))
5814 (tramp-set-process-query-on-exit-flag p nil)
5817 (tramp-process-actions p multi-method method user host
5818 tramp-actions-before-shell 60)
5819 (tramp-message 7 "Initializing remote shell")
5820 (tramp-open-connection-setup-interactive-shell
5821 p multi-method method user host)
5822 (tramp-post-connection multi-method method user host)))))
5824 (defun tramp-open-connection-su (multi-method method user host)
5825 "Open a connection using the `su' program with METHOD.
5826 This starts `su - USER', then waits for a password prompt. The HOST
5827 name must be equal to the local host name or to `localhost'.
5829 If USER is nil, uses value returned by user-login-name instead.
5831 Recognition of the remote shell prompt is based on the variables
5832 `shell-prompt-pattern' and `tramp-shell-prompt-pattern' which must be
5833 set up correctly. Note that the other user may have a different shell
5834 prompt than you do, so it is not at all unlikely that the variable
5835 `shell-prompt-pattern' is set up wrongly!"
5837 (when (tramp-method-out-of-band-p multi-method method user host)
5838 (error "Cannot use out-of-band method `%s' with `su' connection method"
5840 (unless (or (string-match (concat "^" (regexp-quote host))
5842 (string= "localhost" host)
5845 "Cannot connect to different host `%s' with `su' connection method"
5847 (tramp-pre-connection multi-method method user host tramp-chunksize)
5848 (tramp-message 7 "Opening connection for `%s' using `%s'..."
5849 (or user "<root>") method)
5850 (let ((process-environment (copy-sequence process-environment)))
5851 (setenv "TERM" tramp-terminal-type)
5852 (setenv "LC_ALL" "C")
5853 (setenv "PROMPT_COMMAND")
5855 (let* ((default-directory (tramp-temporary-file-directory))
5856 ;; If we omit the conditional, we use `undecided-dos' in
5857 ;; some cases. With the conditional, we use nil in these
5858 ;; cases. What's the difference? Which one is right?
5859 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5860 (> emacs-major-version 20))
5861 tramp-dos-coding-system))
5862 (p (apply 'start-process
5863 (tramp-buffer-name multi-method method user host)
5864 (tramp-get-buffer multi-method method user host)
5865 (tramp-get-method-parameter
5867 (tramp-find-method multi-method method user host)
5868 user host 'tramp-login-program)
5871 (format-spec x `((?u . ,(or user "root")))))
5872 (tramp-get-method-parameter
5874 (tramp-find-method multi-method method user host)
5875 user host 'tramp-login-args))))
5878 (tramp-set-process-query-on-exit-flag p nil)
5879 (set-buffer (tramp-get-buffer multi-method method user host))
5880 (tramp-process-actions p multi-method method user host
5881 tramp-actions-before-shell 60)
5882 (tramp-open-connection-setup-interactive-shell
5883 p multi-method method user host)
5884 (tramp-post-connection multi-method method
5887 ;; HHH: Not Changed. Multi method. It is not clear to me how this can
5888 ;; handle not giving a user name in the "file name".
5890 ;; This is more difficult than for the single-hop method. In the
5891 ;; multi-hop-method, the desired behaviour should be that the
5892 ;; user must specify names for the telnet hops of which the user
5893 ;; name is different than the "original" name (or different from
5894 ;; the previous hop.
5895 (defun tramp-open-connection-multi (multi-method method user host)
5896 "Open a multi-hop connection using METHOD.
5897 This uses a slightly changed file name syntax. The idea is to say
5898 [multi/telnet:u1@h1/rsh:u2@h2]/path/to/file
5899 This will use telnet to log in as u1 to h1, then use rsh from there to
5900 log in as u2 to h2."
5902 (unless multi-method
5903 (error "Multi-hop open connection function called on non-multi method"))
5904 (when (tramp-method-out-of-band-p multi-method method user host)
5905 (error "No out of band multi-hop connections"))
5906 (unless (and (arrayp method) (not (stringp method)))
5907 (error "METHOD must be an array of strings for multi methods"))
5908 (unless (and (arrayp user) (not (stringp user)))
5909 (error "USER must be an array of strings for multi methods"))
5910 (unless (and (arrayp host) (not (stringp host)))
5911 (error "HOST must be an array of strings for multi methods"))
5912 (unless (and (= (length method) (length user))
5913 (= (length method) (length host)))
5914 (error "Arrays METHOD, USER, HOST must have equal length"))
5915 (tramp-pre-connection multi-method method user host tramp-chunksize)
5916 (tramp-message 7 "Opening `%s' connection..." multi-method)
5917 (let ((process-environment (copy-sequence process-environment)))
5918 (setenv "TERM" tramp-terminal-type)
5919 (setenv "LC_ALL" "C")
5920 (setenv "PROMPT_COMMAND")
5922 (let* ((default-directory (tramp-temporary-file-directory))
5923 ;; If we omit the conditional, we use `undecided-dos' in
5924 ;; some cases. With the conditional, we use nil in these
5925 ;; cases. What's the difference? Which one is right?
5926 (coding-system-for-read (unless (and (not (featurep 'xemacs))
5927 (> emacs-major-version 20))
5928 tramp-dos-coding-system))
5929 (p (start-process (tramp-buffer-name multi-method method user host)
5930 (tramp-get-buffer multi-method method user host)
5931 tramp-multi-sh-program))
5932 (num-hops (length method))
5934 (tramp-set-process-query-on-exit-flag p nil)
5935 (tramp-message 9 "Waiting 60s for local shell to come up...")
5936 (unless (tramp-wait-for-regexp
5937 p 60 (format "\\(%s\\)\\'\\|\\(%s\\)\\'"
5938 shell-prompt-pattern tramp-shell-prompt-pattern))
5939 (pop-to-buffer (buffer-name))
5941 (error "Couldn't find local shell prompt"))
5942 ;; Now do all the connections as specified.
5943 (while (< i num-hops)
5944 (let* ((m (aref method i))
5947 (entry (assoc m tramp-multi-connection-function-alist))
5948 (multi-func (nth 1 entry))
5949 (command (nth 2 entry)))
5950 ;; The multi-funcs don't need to do save-match-data, as that
5952 (funcall multi-func p m u h command)
5955 (tramp-open-connection-setup-interactive-shell
5956 p multi-method method user host)
5957 (tramp-post-connection multi-method method user host)))))
5959 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
5960 ;; of no user name provided. Hack to make it work as it did before:
5961 ;; changed `user' to `(or user (user-login-name))' in the places where
5962 ;; the value is actually used.
5963 (defun tramp-multi-connect-telnet (p method user host command)
5964 "Issue `telnet' command.
5965 Uses shell COMMAND to issue a `telnet' command to log in as USER to
5966 HOST. You can use percent escapes in COMMAND: `%h' is replaced with
5967 the host name, and `%n' is replaced with an end of line character, as
5968 set in `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
5971 If USER is nil, uses the return value of (user-login-name) instead."
5972 (let ((cmd (format-spec command
5973 `((?h . ,host) (?n . ,tramp-rsh-end-of-line))))
5974 (cmd1 (format-spec command `((?h . ,host) (?n . ""))))
5977 (tramp-message 9 "Sending telnet command `%s'" cmd1)
5978 (process-send-string p cmd)
5979 (tramp-process-multi-actions p method user host
5980 tramp-multi-actions)))
5982 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
5983 ;; of no user name provided. Hack to make it work as it did before:
5984 ;; changed `user' to `(or user (user-login-name))' in the places where
5985 ;; the value is actually used.
5986 (defun tramp-multi-connect-rlogin (p method user host command)
5987 "Issue `rlogin' command.
5988 Uses shell COMMAND to issue an `rlogin' command to log in as USER to
5989 HOST. You can use percent escapes in COMMAND. `%u' will be replaced
5990 with the user name, `%h' will be replaced with the host name, and `%n'
5991 will be replaced with the value of `tramp-rsh-end-of-line'. You can use
5992 `%%' if you want to use a literal percent character.
5994 If USER is nil, uses the return value of (user-login-name) instead."
5995 (let ((cmd (format-spec command `((?h . ,host)
5996 (?u . ,(or user (user-login-name)))
5997 (?n . ,tramp-rsh-end-of-line))))
5998 (cmd1 (format-spec command `((?h . ,host)
5999 (?u . ,(or user (user-login-name)))
6003 (tramp-message 9 "Sending rlogin command `%s'" cmd1)
6004 (process-send-string p cmd)
6005 (tramp-process-multi-actions p method user host
6006 tramp-multi-actions)))
6008 ;; HHH: Changed. Multi method. Don't know how to handle this in the case
6009 ;; of no user name provided. Hack to make it work as it did before:
6010 ;; changed `user' to `(or user (user-login-name))' in the places where
6011 ;; the value is actually used.
6012 (defun tramp-multi-connect-su (p method user host command)
6013 "Issue `su' command.
6014 Uses shell COMMAND to issue a `su' command to log in as USER on
6015 HOST. The HOST name is ignored, this just changes the user id on the
6016 host currently logged in to.
6018 If USER is nil, uses the return value of (user-login-name) instead.
6020 You can use percent escapes in the COMMAND. `%u' is replaced with the
6021 user name, and `%n' is replaced with the value of
6022 `tramp-rsh-end-of-line'. Use `%%' if you want a literal percent
6024 (let ((cmd (format-spec command `((?u . ,(or user (user-login-name)))
6025 (?n . ,tramp-rsh-end-of-line))))
6026 (cmd1 (format-spec command `((?u . ,(or user (user-login-name)))
6030 (tramp-message 9 "Sending su command `%s'" cmd1)
6031 (process-send-string p cmd)
6032 (tramp-process-multi-actions p method user host
6033 tramp-multi-actions)))
6035 ;; Utility functions.
6037 (defun tramp-accept-process-output
6038 (&optional process timeout timeout-msecs)
6039 "Like `accept-process-output' for Tramp processes.
6040 This is needed in order to hide `last-coding-system-used', which is set
6041 for process communication also."
6042 (let (last-coding-system-used)
6043 (accept-process-output process timeout timeout-msecs)))
6045 (defun tramp-wait-for-regexp (proc timeout regexp)
6046 "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds.
6047 Expects the output of PROC to be sent to the current buffer. Returns
6048 the string that matched, or nil. Waits indefinitely if TIMEOUT is
6051 (start-time (current-time)))
6053 ;; Work around a bug in XEmacs 21, where the timeout
6054 ;; expires faster than it should. This degenerates
6055 ;; to polling for buggy XEmacsen, but oh, well.
6056 (while (and (not found)
6057 (< (tramp-time-diff (current-time) start-time)
6059 (with-timeout (timeout)
6061 (tramp-accept-process-output proc 1)
6062 (unless (memq (process-status proc) '(run open))
6063 (error "Process has died"))
6064 (goto-char (point-min))
6065 (setq found (re-search-forward regexp nil t))))))
6068 (tramp-accept-process-output proc 1)
6069 (unless (memq (process-status proc) '(run open))
6070 (error "Process has died"))
6071 (goto-char (point-min))
6072 (setq found (re-search-forward regexp nil t)))))
6073 (when tramp-debug-buffer
6075 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6076 tramp-current-user tramp-current-host)
6077 (point-min) (point-max))
6081 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6082 tramp-current-user tramp-current-host))
6083 (goto-char (point-max))
6084 (insert "[[Regexp `" regexp "' not found"
6085 (if timeout (format " in %d secs" timeout) "")
6089 (defun tramp-wait-for-shell-prompt (proc timeout)
6090 "Wait for the shell prompt to appear from process PROC within TIMEOUT seconds.
6091 See `tramp-wait-for-regexp' for more details.
6092 Shell prompt pattern is determined by variables `shell-prompt-pattern'
6093 and `tramp-shell-prompt-pattern'."
6094 (tramp-wait-for-regexp
6096 (format "\\(%s\\|%s\\)\\'"
6097 shell-prompt-pattern tramp-shell-prompt-pattern)))
6099 (defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
6100 "Wait for shell prompt and barf if none appears.
6101 Looks at process PROC to see if a shell prompt appears in TIMEOUT
6102 seconds. If not, it produces an error message with the given ERROR-ARGS."
6103 (unless (tramp-wait-for-shell-prompt proc timeout)
6104 (pop-to-buffer (buffer-name))
6105 (apply 'error error-args)))
6107 (defun tramp-enter-password (p prompt user host)
6108 "Prompt for a password and send it to the remote end.
6109 Uses PROMPT as a prompt and sends the password to process P."
6110 (let ((pw (tramp-read-passwd user host prompt)))
6112 (process-send-string
6114 (or (tramp-get-method-parameter
6115 tramp-current-multi-method
6116 tramp-current-method
6119 'tramp-password-end-of-line)
6120 tramp-default-password-end-of-line)))))
6122 ;; HHH: Not Changed. This might handle the case where USER is not
6123 ;; given in the "File name" very poorly. Then, the local
6124 ;; variable tramp-current-user will be set to nil.
6125 (defun tramp-pre-connection (multi-method method user host chunksize)
6126 "Do some setup before actually logging in.
6127 METHOD, USER and HOST specify the connection."
6128 (set-buffer (tramp-get-buffer multi-method method user host))
6129 (set (make-local-variable 'tramp-current-multi-method) multi-method)
6130 (set (make-local-variable 'tramp-current-method) method)
6131 (set (make-local-variable 'tramp-current-user) user)
6132 (set (make-local-variable 'tramp-current-host) host)
6133 (set (make-local-variable 'tramp-chunksize) chunksize)
6134 (set (make-local-variable 'inhibit-eol-conversion) nil)
6137 (defun tramp-open-connection-setup-interactive-shell
6138 (p multi-method method user host)
6139 "Set up an interactive shell.
6140 Mainly sets the prompt and the echo correctly. P is the shell process
6141 to set up. METHOD, USER and HOST specify the connection."
6142 ;; Wait a bit in case the remote end feels like sending a little
6143 ;; junk first. It seems that fencepost.gnu.org does this when doing
6144 ;; a Kerberos login.
6146 (tramp-discard-garbage-erase-buffer p multi-method method user host)
6147 (tramp-process-initial-commands p multi-method method user host
6148 tramp-initial-commands)
6149 ;; It is useful to set the prompt in the following command because
6150 ;; some people have a setting for $PS1 which /bin/sh doesn't know
6151 ;; about and thus /bin/sh will display a strange prompt. For
6152 ;; example, if $PS1 has "${CWD}" in the value, then ksh will display
6153 ;; the current working directory but /bin/sh will display a dollar
6154 ;; sign. The following command line sets $PS1 to a sane value, and
6155 ;; works under Bourne-ish shells as well as csh-like shells. Daniel
6156 ;; Pittman reports that the unusual positioning of the single quotes
6157 ;; makes it work under `rc', too. We also unset the variable $ENV
6158 ;; because that is read by some sh implementations (eg, bash when
6159 ;; called as sh) on startup; this way, we avoid the startup file
6160 ;; clobbering $PS1. $PROMP_COMMAND is another way to set the prompt
6161 ;; in /bin/bash, it must be discarded as well.
6162 (tramp-send-command-internal
6163 multi-method method user host
6164 (format "exec env 'ENV=' 'PROMPT_COMMAND=' 'PS1=$ ' %s"
6165 (tramp-get-method-parameter
6166 multi-method method user host 'tramp-remote-sh))
6167 (format "remote `%s' to come up"
6168 (tramp-get-method-parameter
6169 multi-method method user host 'tramp-remote-sh)))
6170 (tramp-barf-if-no-shell-prompt
6172 "Remote `%s' didn't come up. See buffer `%s' for details"
6173 (tramp-get-method-parameter multi-method method user host 'tramp-remote-sh)
6175 (tramp-message 8 "Setting up remote shell environment")
6176 (tramp-discard-garbage-erase-buffer p multi-method method user host)
6177 (tramp-send-command-internal multi-method method user host
6178 "stty -inlcr -echo kill '^U'")
6180 ;; Ignore garbage after stty command.
6181 (tramp-send-command-internal multi-method method user host
6184 (tramp-send-command-internal multi-method method user host
6185 "TERM=dumb; export TERM")
6187 ;; Check whether the remote host suffers from buggy `send-process-string'.
6188 ;; This is known for FreeBSD (see comment in `send_process', file process.c).
6189 ;; I've tested sending 624 bytes successfully, sending 625 bytes failed.
6190 ;; Emacs makes a hack when this host type is detected locally. It cannot
6191 ;; handle remote hosts, though.
6192 (when (or (not tramp-chunksize) (zerop tramp-chunksize))
6193 (tramp-message 9 "Checking remote host type for `send-process-string' bug")
6194 (tramp-send-command-internal multi-method method user host
6195 "(uname -sr) 2>/dev/null")
6196 (goto-char (point-min))
6197 (when (looking-at "FreeBSD")
6198 (setq tramp-chunksize 500)))
6200 ;; Try to set up the coding system correctly.
6201 ;; CCC this can't be the right way to do it. Hm.
6204 (tramp-message 9 "Determining coding system")
6205 (tramp-send-command-internal multi-method method user host
6206 "echo foo ; echo bar")
6207 (goto-char (point-min))
6208 (if (featurep 'mule)
6209 ;; Use MULE to select the right EOL convention for communicating
6210 ;; with the process.
6211 (let* ((cs (or (process-coding-system p) (cons 'undecided 'undecided)))
6212 cs-decode cs-encode)
6213 (when (symbolp cs) (setq cs (cons cs cs)))
6214 (setq cs-decode (car cs))
6215 (setq cs-encode (cdr cs))
6216 (unless cs-decode (setq cs-decode 'undecided))
6217 (unless cs-encode (setq cs-encode 'undecided))
6218 (setq cs-encode (tramp-coding-system-change-eol-conversion
6220 (when (search-forward "\r" nil t)
6221 (setq cs-decode (tramp-coding-system-change-eol-conversion
6223 (set-buffer-process-coding-system cs-decode cs-encode))
6224 ;; Look for ^M and do something useful if found.
6225 (when (search-forward "\r" nil t)
6226 ;; We have found a ^M but cannot frob the process coding system
6227 ;; because we're running on a non-MULE Emacs. Let's try
6230 (tramp-message 9 "Trying `stty -onlcr'")
6231 (tramp-send-command-internal multi-method method user host
6235 9 "Waiting 30s for `HISTFILE=$HOME/.tramp_history; HISTSIZE=1; export HISTFILE; export HISTSIZE'")
6236 (tramp-send-command-internal
6237 multi-method method user host
6238 "HISTFILE=$HOME/.tramp_history; HISTSIZE=1; export HISTFILE; export HISTSIZE")
6240 (tramp-message 9 "Waiting 30s for `set +o vi +o emacs'")
6241 (tramp-send-command-internal multi-method method user host
6242 "set +o vi +o emacs")
6244 (tramp-message 9 "Waiting 30s for `unset MAIL MAILCHECK MAILPATH'")
6245 (tramp-send-command-internal
6246 multi-method method user host
6247 "unset MAIL MAILCHECK MAILPATH 1>/dev/null 2>/dev/null")
6249 (tramp-message 9 "Waiting 30s for `unset CDPATH'")
6250 (tramp-send-command-internal multi-method method user host
6253 (tramp-message 9 "Setting shell prompt")
6254 ;; Douglas Gray Stephens <DGrayStephens@slb.com> says that we must
6255 ;; use "\n" here, not tramp-rsh-end-of-line. We also manually frob
6256 ;; the last time we sent a command, to avoid tramp-send-command to send
6257 ;; "echo are you awake".
6258 (setq tramp-last-cmd-time (current-time))
6259 (tramp-send-command-internal multi-method method user host
6260 "PROMPT_COMMAND=''")
6262 (tramp-send-command-internal multi-method method user host
6265 (tramp-send-command-internal multi-method method user host
6269 multi-method method user host
6270 (format "PS1='%s%s%s'"
6271 tramp-rsh-end-of-line
6273 tramp-rsh-end-of-line))
6274 (tramp-wait-for-output))
6276 (defun tramp-post-connection (multi-method method user host)
6277 "Prepare a remote shell before being able to work on it.
6278 METHOD, USER and HOST specify the connection.
6279 Among other things, this finds a shell which groks tilde expansion,
6280 tries to find an `ls' command which groks the `-n' option, sets the
6281 locale to C and sets up the remote shell search path."
6282 ;; Search for a good shell before searching for a command which
6283 ;; checks if a file exists. This is done because Tramp wants to use
6284 ;; "test foo; echo $?" to check if various conditions hold, and
6285 ;; there are buggy /bin/sh implementations which don't execute the
6286 ;; "echo $?" part if the "test" part has an error. In particular,
6287 ;; the Solaris /bin/sh is a problem. I'm betting that all systems
6288 ;; with buggy /bin/sh implementations will have a working bash or
6290 (tramp-find-shell multi-method method user host)
6291 ;; Without (sit-for 0.1) at least, my machine will almost always blow
6292 ;; up on 'not numberp /root' - a race that causes the 'echo ~root'
6293 ;; output of (tramp-find-shell) to show up along with the output of
6294 ;; (tramp-find-ls-command) testing.
6296 ;; I can't work out why this is a problem though. The (tramp-wait-for-output)
6297 ;; call in (tramp-find-shell) *should* make this not happen, I thought.
6299 ;; After much debugging I couldn't find any problem with the implementation
6300 ;; of that function though. The workaround stays for me at least. :/
6302 ;; Daniel Pittman <daniel@danann.net>
6305 (tramp-find-file-exists-command multi-method method user host)
6306 (make-local-variable 'tramp-ls-command)
6307 (setq tramp-ls-command (tramp-find-ls-command multi-method method user host))
6308 (unless tramp-ls-command
6311 "Danger! Couldn't find ls which groks -n. Muddling through anyway")
6312 (setq tramp-ls-command
6313 (tramp-find-executable multi-method method user host
6314 "ls" tramp-remote-path nil)))
6315 (unless tramp-ls-command
6316 (error "Fatal error: Couldn't find remote executable `ls'"))
6317 (tramp-message 5 "Using remote command `%s' for getting directory listings"
6319 (tramp-send-command multi-method method user host
6320 (concat "tramp_set_exit_status () {" tramp-rsh-end-of-line
6321 "return $1" tramp-rsh-end-of-line
6323 (tramp-wait-for-output)
6324 ;; Set remote PATH variable.
6325 (tramp-set-remote-path multi-method method user host "PATH" tramp-remote-path)
6326 ;; Tell remote shell to use standard time format, needed for
6327 ;; parsing `ls -l' output.
6328 (tramp-send-command multi-method method user host
6329 "LC_TIME=C; export LC_TIME; echo huhu")
6330 (tramp-wait-for-output)
6331 (tramp-send-command multi-method method user host
6332 "mesg n; echo huhu")
6333 (tramp-wait-for-output)
6334 (tramp-send-command multi-method method user host
6335 "biff n ; echo huhu")
6336 (tramp-wait-for-output)
6337 ;; Unalias ls(1) to work around issues with those silly people who make it
6338 ;; spit out ANSI escapes or whatever.
6339 (tramp-send-command multi-method method user host
6340 "unalias ls; echo huhu")
6341 (tramp-wait-for-output)
6342 ;; Does `test A -nt B' work? Use abominable `find' construct if it
6343 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
6344 ;; for otherwise the shell crashes.
6346 (make-local-variable 'tramp-test-groks-nt)
6347 (tramp-send-command multi-method method user host
6349 (tramp-wait-for-output)
6350 (goto-char (point-min))
6351 (setq tramp-test-groks-nt
6352 (looking-at (format "\n%s\r?\n" (regexp-quote tramp-end-of-output))))
6353 (unless tramp-test-groks-nt
6355 multi-method method user host
6356 (concat "tramp_test_nt () {" tramp-rsh-end-of-line
6357 "test -n \"`find $1 -prune -newer $2 -print`\"" tramp-rsh-end-of-line
6359 (tramp-wait-for-output)
6360 ;; Send the fallback `uudecode' script.
6362 (tramp-send-string multi-method method user host tramp-uudecode)
6363 (tramp-wait-for-output)
6366 (tramp-set-connection-property "perl-scripts" nil multi-method method user host)
6367 (let ((tramp-remote-perl
6368 (or (tramp-find-executable multi-method method user host
6369 "perl5" tramp-remote-path nil)
6370 (tramp-find-executable multi-method method user host
6371 "perl" tramp-remote-path nil))))
6372 (when tramp-remote-perl
6373 (tramp-set-connection-property "perl" tramp-remote-perl
6374 multi-method method user host)
6375 (unless (tramp-method-out-of-band-p multi-method method user host)
6376 (tramp-message 5 "Sending the Perl `mime-encode' implementations.")
6378 multi-method method user host
6379 (concat "tramp_encode () {\n"
6380 (format tramp-perl-encode tramp-remote-perl)
6383 (tramp-wait-for-output)
6385 multi-method method user host
6386 (concat "tramp_encode_with_module () {\n"
6387 (format tramp-perl-encode-with-module tramp-remote-perl)
6390 (tramp-wait-for-output)
6391 (tramp-message 5 "Sending the Perl `mime-decode' implementations.")
6393 multi-method method user host
6394 (concat "tramp_decode () {\n"
6395 (format tramp-perl-decode tramp-remote-perl)
6398 (tramp-wait-for-output)
6400 multi-method method user host
6401 (concat "tramp_decode_with_module () {\n"
6402 (format tramp-perl-decode-with-module tramp-remote-perl)
6405 (tramp-wait-for-output))))
6408 (let ((ln (tramp-find-executable multi-method method user host
6409 "ln" tramp-remote-path nil)))
6411 (tramp-set-connection-property "ln" ln multi-method method user host)))
6414 (tramp-send-command multi-method method user host "id -u; id -g")
6415 (tramp-wait-for-output)
6416 (goto-char (point-min))
6417 (tramp-set-connection-property
6418 "uid" (read (current-buffer)) multi-method method user host)
6419 (tramp-set-connection-property
6420 "gid" (read (current-buffer)) multi-method method user host)
6421 ;; Find the right encoding/decoding commands to use.
6423 (unless (tramp-method-out-of-band-p multi-method method user host)
6424 (tramp-find-inline-encoding multi-method method user host))
6425 ;; If encoding/decoding command are given, test to see if they work.
6426 ;; CCC: Maybe it would be useful to run the encoder both locally and
6427 ;; remotely to see if they produce the same result.
6428 (let ((rem-enc (tramp-get-remote-encoding multi-method method user host))
6429 (rem-dec (tramp-get-remote-decoding multi-method method user host))
6430 (magic-string "xyzzy"))
6431 (when (and (or rem-dec rem-enc) (not (and rem-dec rem-enc)))
6432 (tramp-kill-process multi-method method user host)
6433 ;; Improve error message and/or error check.
6435 "Must give both decoding and encoding command in method definition"))
6436 (when (and rem-enc rem-dec)
6439 "Checking to see if encoding/decoding commands work on remote host...")
6441 multi-method method user host
6442 (format "echo %s | %s | %s"
6443 (tramp-shell-quote-argument magic-string) rem-enc rem-dec))
6444 (tramp-wait-for-output)
6445 (unless (looking-at (regexp-quote magic-string))
6446 (tramp-kill-process multi-method method user host)
6447 (error "Remote host cannot execute de/encoding commands. See buffer `%s' for details"
6451 5 "Checking to see if encoding/decoding commands work on remote host...done"))))
6453 ;; CCC: We should either implement a Perl version of base64 encoding
6454 ;; and decoding. Then we just use that in the last item. The other
6455 ;; alternative is to use the Perl version of UU encoding. But then
6456 ;; we need a Lisp version of uuencode.
6458 ;; Old text from documentation of tramp-methods:
6459 ;; Using a uuencode/uudecode inline method is discouraged, please use one
6460 ;; of the base64 methods instead since base64 encoding is much more
6461 ;; reliable and the commands are more standardized between the different
6462 ;; Unix versions. But if you can't use base64 for some reason, please
6463 ;; note that the default uudecode command does not work well for some
6464 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
6465 ;; the following command for uudecode:
6467 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
6469 ;; For Irix, no solution is known yet.
6471 (defvar tramp-coding-commands
6472 '(("mimencode -b" "mimencode -u -b"
6473 base64-encode-region base64-decode-region)
6474 ("mmencode -b" "mmencode -u -b"
6475 base64-encode-region base64-decode-region)
6476 ("recode data..base64" "recode base64..data"
6477 base64-encode-region base64-decode-region)
6478 ("uuencode xxx" "uudecode -o /dev/stdout"
6479 tramp-uuencode-region uudecode-decode-region)
6480 ("uuencode xxx" "uudecode -o -"
6481 tramp-uuencode-region uudecode-decode-region)
6482 ("uuencode xxx" "uudecode -p"
6483 tramp-uuencode-region uudecode-decode-region)
6484 ("uuencode xxx" "tramp_uudecode"
6485 tramp-uuencode-region uudecode-decode-region)
6486 ("tramp_encode_with_module" "tramp_decode_with_module"
6487 base64-encode-region base64-decode-region)
6488 ("tramp_encode" "tramp_decode"
6489 base64-encode-region base64-decode-region))
6490 "List of coding commands for inline transfer.
6491 Each item is a list that looks like this:
6493 \(REMOTE-ENCODING REMOTE-DECODING LOCAL-ENCODING LOCAL-DECODING)
6495 The REMOTE-ENCODING should be a string, giving a command accepting a
6496 plain file on standard input and writing the encoded file to standard
6497 output. The REMOTE-DECODING should also be a string, giving a command
6498 accepting an encoded file on standard input and writing the decoded
6499 file to standard output.
6501 LOCAL-ENCODING and LOCAL-DECODING can be strings, giving commands, or
6502 symbols, giving functions. If they are strings, then they can contain
6503 the \"%s\" format specifier. If that specifier is present, the input
6504 filename will be put into the command line at that spot. If the
6505 specifier is not present, the input should be read from standard
6508 If they are functions, they will be called with two arguments, start
6509 and end of region, and are expected to replace the region contents
6510 with the encoded or decoded results, respectively.")
6512 (defun tramp-find-inline-encoding (multi-method method user host)
6513 "Find an inline transfer encoding that works.
6514 Goes through the list `tramp-coding-commands'."
6515 (let ((commands tramp-coding-commands)
6518 (while (and commands (null found))
6519 (setq item (pop commands))
6521 (let ((rem-enc (nth 0 item))
6522 (rem-dec (nth 1 item))
6523 (loc-enc (nth 2 item))
6524 (loc-dec (nth 3 item)))
6525 ;; Check if remote encoding and decoding commands can be
6526 ;; called remotely with null input and output. This makes
6527 ;; sure there are no syntax errors and the command is really
6528 ;; found. Note that we do not redirect stdout to /dev/null,
6529 ;; for two reaons: when checking the decoding command, we
6530 ;; actually check the output it gives. And also, when
6531 ;; redirecting "mimencode" output to /dev/null, then as root
6532 ;; it might change the permissions of /dev/null!
6533 (tramp-message-for-buffer
6534 multi-method method user host 9
6535 "Checking remote encoding command `%s' for sanity" rem-enc)
6536 (unless (zerop (tramp-send-command-and-check
6537 multi-method method user host
6538 (format "%s </dev/null" rem-enc) t))
6539 (throw 'wont-work nil))
6540 (tramp-message-for-buffer
6541 multi-method method user host 9
6542 "Checking remote decoding command `%s' for sanity" rem-dec)
6543 (unless (zerop (tramp-send-command-and-check
6544 multi-method method user host
6545 (format "echo %s | %s | %s"
6546 magic rem-enc rem-dec) t))
6547 (throw 'wont-work nil))
6549 (goto-char (point-min))
6550 (unless (looking-at (regexp-quote magic))
6551 (throw 'wont-work nil)))
6552 ;; If the local encoder or decoder is a string, the
6553 ;; corresponding command has to work locally.
6554 (when (stringp loc-enc)
6555 (tramp-message-for-buffer
6556 multi-method method user host 9
6557 "Checking local encoding command `%s' for sanity" loc-enc)
6558 (unless (zerop (tramp-call-local-coding-command
6560 (throw 'wont-work nil)))
6561 (when (stringp loc-dec)
6562 (tramp-message-for-buffer
6563 multi-method method user host 9
6564 "Checking local decoding command `%s' for sanity" loc-dec)
6565 (unless (zerop (tramp-call-local-coding-command
6567 (throw 'wont-work nil)))
6568 ;; CCC: At this point, maybe we should check that the output
6569 ;; of the commands is correct. But for the moment we will
6570 ;; assume that commands working on empty input will also
6571 ;; work in practice.
6572 (setq found item))))
6573 ;; Did we find something? If not, issue error. If so,
6574 ;; set connection properties.
6576 (error "Couldn't find an inline transfer encoding"))
6577 (let ((rem-enc (nth 0 found))
6578 (rem-dec (nth 1 found))
6579 (loc-enc (nth 2 found))
6580 (loc-dec (nth 3 found)))
6581 (tramp-message 10 "Using remote encoding %s" rem-enc)
6582 (tramp-set-remote-encoding multi-method method user host rem-enc)
6583 (tramp-message 10 "Using remote decoding %s" rem-dec)
6584 (tramp-set-remote-decoding multi-method method user host rem-dec)
6585 (tramp-message 10 "Using local encoding %s" loc-enc)
6586 (tramp-set-local-encoding multi-method method user host loc-enc)
6587 (tramp-message 10 "Using local decoding %s" loc-dec)
6588 (tramp-set-local-decoding multi-method method user host loc-dec))))
6590 (defun tramp-call-local-coding-command (cmd input output)
6591 "Call the local encoding or decoding command.
6592 If CMD contains \"%s\", provide input file INPUT there in command.
6593 Otherwise, INPUT is passed via standard input.
6594 INPUT can also be nil which means `/dev/null'.
6595 OUTPUT can be a string (which specifies a filename), or t (which
6596 means standard output and thus the current buffer), or nil (which
6599 tramp-encoding-shell ;program
6600 (when (and input (not (string-match "%s" cmd)))
6602 (if (eq output t) t nil) ;output
6604 tramp-encoding-command-switch
6605 ;; actual shell command
6607 (if (string-match "%s" cmd) (format cmd input) cmd)
6608 (if (stringp output) (concat "> " output) ""))))
6610 (defun tramp-maybe-open-connection (multi-method method user host)
6611 "Maybe open a connection to HOST, logging in as USER, using METHOD.
6612 Does not do anything if a connection is already open, but re-opens the
6613 connection if a previous connection has died for some reason."
6614 (let ((p (get-buffer-process
6615 (tramp-get-buffer multi-method method user host)))
6617 ;; If too much time has passed since last command was sent, look
6618 ;; whether process is still alive. If it isn't, kill it. When
6619 ;; using ssh, it can sometimes happen that the remote end has hung
6620 ;; up but the local ssh client doesn't recognize this until it
6621 ;; tries to send some data to the remote end. So that's why we
6622 ;; try to send a command from time to time, then look again
6623 ;; whether the process is really alive.
6625 (set-buffer (tramp-get-buffer multi-method method user host))
6626 (when (and tramp-last-cmd-time
6627 (> (tramp-time-diff (current-time) tramp-last-cmd-time) 60)
6628 p (processp p) (memq (process-status p) '(run open)))
6630 multi-method method user host "echo are you awake" nil t)
6631 (unless (and (memq (process-status p) '(run open))
6632 (tramp-wait-for-output 10))
6636 (unless (and p (processp p) (memq (process-status p) '(run open)))
6637 (when (and p (processp p))
6639 (let ((process-connection-type tramp-process-connection-type))
6640 (funcall (tramp-get-method-parameter
6642 (tramp-find-method multi-method method user host)
6643 user host 'tramp-connection-function)
6644 multi-method method user host)))))
6646 (defun tramp-send-command
6647 (multi-method method user host command &optional noerase neveropen)
6648 "Send the COMMAND to USER at HOST (logged in using METHOD).
6649 Erases temporary buffer before sending the command (unless NOERASE
6651 If optional seventh arg NEVEROPEN is non-nil, never try to open the
6652 connection. This is meant to be used from
6653 `tramp-maybe-open-connection' only."
6655 (tramp-maybe-open-connection multi-method method user host))
6656 (setq tramp-last-cmd-time (current-time))
6657 (setq tramp-last-cmd command)
6658 (when tramp-debug-buffer
6660 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6661 (goto-char (point-max))
6662 (tramp-insert-with-face 'bold (format "$ %s\n" command))))
6664 (set-buffer (tramp-get-buffer multi-method method user host))
6665 (unless noerase (erase-buffer))
6666 (setq proc (get-buffer-process (current-buffer)))
6667 (process-send-string proc
6668 (concat command tramp-rsh-end-of-line))))
6670 (defun tramp-send-command-internal
6671 (multi-method method user host command &optional msg)
6672 "Send command to remote host and wait for success.
6673 Sends COMMAND, then waits 30 seconds for shell prompt."
6674 (tramp-send-command multi-method method user host command t t)
6676 (tramp-message 9 "Waiting 30s for %s..." msg))
6677 (tramp-barf-if-no-shell-prompt
6679 "Couldn't `%s', see buffer `%s'" command (buffer-name)))
6681 (defun tramp-wait-for-output (&optional timeout)
6682 "Wait for output from remote rsh command."
6683 (let ((proc (get-buffer-process (current-buffer)))
6685 (start-time (current-time))
6686 (start-point (point))
6687 (end-of-output (concat "^"
6688 (regexp-quote tramp-end-of-output)
6690 ;; Algorithm: get waiting output. See if last line contains
6691 ;; end-of-output sentinel. If not, wait a bit and again get
6692 ;; waiting output. Repeat until timeout expires or end-of-output
6693 ;; sentinel is seen. Will hang if timeout is nil and
6694 ;; end-of-output sentinel never appears.
6697 ;; Work around an XEmacs bug, where the timeout expires
6698 ;; faster than it should. This degenerates into polling
6699 ;; for buggy XEmacsen, but oh, well.
6700 (while (and (not found)
6701 (< (tramp-time-diff (current-time) start-time)
6703 (with-timeout (timeout)
6705 (tramp-accept-process-output proc 1)
6706 (unless (memq (process-status proc) '(run open))
6707 (error "Process has died"))
6708 (goto-char (point-max))
6710 (setq found (looking-at end-of-output))))))
6713 (tramp-accept-process-output proc 1)
6714 (unless (memq (process-status proc) '(run open))
6715 (error "Process has died"))
6716 (goto-char (point-max))
6718 (setq found (looking-at end-of-output))))))
6719 ;; At this point, either the timeout has expired or we have found
6720 ;; the end-of-output sentinel.
6722 (goto-char (point-max))
6724 (delete-region (point) (point-max)))
6725 ;; If processing echoes, look for it in the first line and delete.
6726 (when tramp-process-echoes
6728 (goto-char start-point)
6729 (when (looking-at (regexp-quote tramp-last-cmd))
6730 (delete-region (point) (progn (forward-line 1) (point))))))
6731 ;; Add output to debug buffer if appropriate.
6732 (when tramp-debug-buffer
6734 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6735 tramp-current-user tramp-current-host)
6736 (point-min) (point-max))
6740 (tramp-get-debug-buffer tramp-current-multi-method tramp-current-method
6741 tramp-current-user tramp-current-host))
6742 (goto-char (point-max))
6743 (insert "[[Remote prompt `" end-of-output "' not found"
6744 (if timeout (format " in %d secs" timeout) "")
6746 (goto-char (point-min))
6747 ;; Return value is whether end-of-output sentinel was found.
6750 (defun tramp-send-command-and-check (multi-method method user host command
6752 "Run COMMAND and check its exit status.
6753 MULTI-METHOD and METHOD specify how to log in (as USER) to the remote HOST.
6754 Sends `echo $?' along with the COMMAND for checking the exit status. If
6755 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
6757 If the optional argument SUBSHELL is non-nil, the command is executed in
6758 a subshell, ie surrounded by parentheses."
6759 (tramp-send-command multi-method method user host
6760 (concat (if subshell "( " "")
6762 (if command " 2>/dev/null; " "")
6763 "echo tramp_exit_status $?"
6764 (if subshell " )" " ")))
6765 (tramp-wait-for-output)
6766 (goto-char (point-max))
6767 (unless (search-backward "tramp_exit_status " nil t)
6768 (error "Couldn't find exit status of `%s'" command))
6769 (skip-chars-forward "^ ")
6770 (read (current-buffer)))
6772 (defun tramp-barf-unless-okay (multi-method method user host command subshell
6773 signal fmt &rest args)
6774 "Run COMMAND, check exit status, throw error if exit status not okay.
6775 Similar to `tramp-send-command-and-check' but accepts two more arguments
6776 FMT and ARGS which are passed to `error'."
6777 (unless (zerop (tramp-send-command-and-check
6778 multi-method method user host command subshell))
6779 ;; CCC: really pop-to-buffer? Maybe it's appropriate to be more
6781 (pop-to-buffer (current-buffer))
6782 (funcall 'signal signal (apply 'format fmt args))))
6784 ;; It seems that Tru64 Unix does not like it if long strings are sent
6785 ;; to it in one go. (This happens when sending the Perl
6786 ;; `file-attributes' implementation, for instance.) Therefore, we
6787 ;; have this function which waits a bit at each line.
6788 (defun tramp-send-string
6789 (multi-method method user host string)
6790 "Send the STRING to USER at HOST using METHOD.
6792 The STRING is expected to use Unix line-endings, but the lines sent to
6793 the remote host use line-endings as defined in the variable
6794 `tramp-rsh-end-of-line'."
6795 (let ((proc (get-buffer-process
6796 (tramp-get-buffer multi-method method user host))))
6798 (error "Can't send string to remote host -- not logged in"))
6800 (when tramp-debug-buffer
6802 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6803 (goto-char (point-max))
6804 (tramp-insert-with-face 'bold (format "$ %s\n" string))))
6805 ;; replace "\n" by `tramp-rsh-end-of-line'
6807 (mapconcat 'identity
6808 (split-string string "\n")
6809 tramp-rsh-end-of-line))
6810 (unless (or (string= string "")
6811 (string-equal (substring string -1) tramp-rsh-end-of-line))
6812 (setq string (concat string tramp-rsh-end-of-line)))
6814 (if (and tramp-chunksize (not (zerop tramp-chunksize)))
6816 (end (length string)))
6818 (tramp-message-for-buffer
6819 multi-method method user host 10
6820 "Sending chunk from %s to %s"
6821 pos (min (+ pos tramp-chunksize) end))
6822 (process-send-string
6823 proc (substring string pos (min (+ pos tramp-chunksize) end)))
6824 (setq pos (+ pos tramp-chunksize))
6826 (process-send-string proc string))))
6828 (defun tramp-send-eof (multi-method method user host)
6829 "Send EOF to the remote end.
6830 METHOD, HOST and USER specify the connection."
6831 (let ((proc (get-buffer-process
6832 (tramp-get-buffer multi-method method user host))))
6834 (error "Can't send EOF to remote host -- not logged in"))
6835 (process-send-eof proc)))
6836 ; (process-send-string proc "\^D")))
6838 (defun tramp-kill-process (multi-method method user host)
6839 "Kill the connection process used by Tramp.
6840 MULTI-METHOD, METHOD, USER, and HOST specify the connection."
6841 (let ((proc (get-buffer-process
6842 (tramp-get-buffer multi-method method user host))))
6843 (kill-process proc)))
6845 (defun tramp-discard-garbage-erase-buffer (p multi-method method user host)
6846 "Erase buffer, then discard subsequent garbage.
6847 If `tramp-discard-garbage' is nil, just erase buffer."
6848 (if (not tramp-discard-garbage)
6850 (while (prog1 (erase-buffer) (tramp-accept-process-output p 0.25))
6851 (when tramp-debug-buffer
6853 (set-buffer (tramp-get-debug-buffer multi-method method user host))
6854 (goto-char (point-max))
6855 (tramp-insert-with-face
6856 'bold (format "Additional characters detected\n")))))))
6858 (defun tramp-mode-string-to-int (mode-string)
6859 "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits."
6860 (let* (case-fold-search
6861 (mode-chars (string-to-vector mode-string))
6862 (owner-read (aref mode-chars 1))
6863 (owner-write (aref mode-chars 2))
6864 (owner-execute-or-setid (aref mode-chars 3))
6865 (group-read (aref mode-chars 4))
6866 (group-write (aref mode-chars 5))
6867 (group-execute-or-setid (aref mode-chars 6))
6868 (other-read (aref mode-chars 7))
6869 (other-write (aref mode-chars 8))
6870 (other-execute-or-sticky (aref mode-chars 9)))
6874 ((char-equal owner-read ?r) (tramp-octal-to-decimal "00400"))
6875 ((char-equal owner-read ?-) 0)
6876 (t (error "Second char `%c' must be one of `r-'" owner-read)))
6878 ((char-equal owner-write ?w) (tramp-octal-to-decimal "00200"))
6879 ((char-equal owner-write ?-) 0)
6880 (t (error "Third char `%c' must be one of `w-'" owner-write)))
6882 ((char-equal owner-execute-or-setid ?x)
6883 (tramp-octal-to-decimal "00100"))
6884 ((char-equal owner-execute-or-setid ?S)
6885 (tramp-octal-to-decimal "04000"))
6886 ((char-equal owner-execute-or-setid ?s)
6887 (tramp-octal-to-decimal "04100"))
6888 ((char-equal owner-execute-or-setid ?-) 0)
6889 (t (error "Fourth char `%c' must be one of `xsS-'"
6890 owner-execute-or-setid)))
6892 ((char-equal group-read ?r) (tramp-octal-to-decimal "00040"))
6893 ((char-equal group-read ?-) 0)
6894 (t (error "Fifth char `%c' must be one of `r-'" group-read)))
6896 ((char-equal group-write ?w) (tramp-octal-to-decimal "00020"))
6897 ((char-equal group-write ?-) 0)
6898 (t (error "Sixth char `%c' must be one of `w-'" group-write)))
6900 ((char-equal group-execute-or-setid ?x)
6901 (tramp-octal-to-decimal "00010"))
6902 ((char-equal group-execute-or-setid ?S)
6903 (tramp-octal-to-decimal "02000"))
6904 ((char-equal group-execute-or-setid ?s)
6905 (tramp-octal-to-decimal "02010"))
6906 ((char-equal group-execute-or-setid ?-) 0)
6907 (t (error "Seventh char `%c' must be one of `xsS-'"
6908 group-execute-or-setid)))
6910 ((char-equal other-read ?r)
6911 (tramp-octal-to-decimal "00004"))
6912 ((char-equal other-read ?-) 0)
6913 (t (error "Eighth char `%c' must be one of `r-'" other-read)))
6915 ((char-equal other-write ?w) (tramp-octal-to-decimal "00002"))
6916 ((char-equal other-write ?-) 0)
6917 (t (error "Nineth char `%c' must be one of `w-'" other-write)))
6919 ((char-equal other-execute-or-sticky ?x)
6920 (tramp-octal-to-decimal "00001"))
6921 ((char-equal other-execute-or-sticky ?T)
6922 (tramp-octal-to-decimal "01000"))
6923 ((char-equal other-execute-or-sticky ?t)
6924 (tramp-octal-to-decimal "01001"))
6925 ((char-equal other-execute-or-sticky ?-) 0)
6926 (t (error "Tenth char `%c' must be one of `xtT-'"
6927 other-execute-or-sticky)))))))
6929 (defun tramp-convert-file-attributes (multi-method method user host attr)
6930 "Convert file-attributes ATTR generated by perl script or ls.
6931 Convert file mode bits to string and set virtual device number.
6933 ;; Convert file mode bits to string.
6934 (unless (stringp (nth 8 attr))
6935 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr))))
6936 ;; Set file's gid change bit. Possible only when id-format is 'integer.
6937 (when (numberp (nth 3 attr))
6938 (setcar (nthcdr 9 attr)
6939 (not (eql (nth 3 attr)
6940 (tramp-get-remote-gid multi-method method user host)))))
6941 ;; Set virtual device number.
6942 (setcar (nthcdr 11 attr)
6943 (tramp-get-device multi-method method user host))
6946 (defun tramp-get-device (multi-method method user host)
6947 "Returns the virtual device number.
6948 If it doesn't exist, generate a new one."
6949 (let ((string (tramp-make-tramp-file-name multi-method method user host "")))
6950 (unless (assoc string tramp-devices)
6951 (add-to-list 'tramp-devices
6952 (list string (length tramp-devices))))
6953 (list -1 (nth 1 (assoc string tramp-devices)))))
6955 (defun tramp-file-mode-from-int (mode)
6956 "Turn an integer representing a file mode into an ls(1)-like string."
6957 (let ((type (cdr (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
6958 (user (logand (lsh mode -6) 7))
6959 (group (logand (lsh mode -3) 7))
6960 (other (logand (lsh mode -0) 7))
6961 (suid (> (logand (lsh mode -9) 4) 0))
6962 (sgid (> (logand (lsh mode -9) 2) 0))
6963 (sticky (> (logand (lsh mode -9) 1) 0)))
6964 (setq user (tramp-file-mode-permissions user suid "s"))
6965 (setq group (tramp-file-mode-permissions group sgid "s"))
6966 (setq other (tramp-file-mode-permissions other sticky "t"))
6967 (concat type user group other)))
6970 (defun tramp-file-mode-permissions (perm suid suid-text)
6971 "Convert a permission bitset into a string.
6972 This is used internally by `tramp-file-mode-from-int'."
6973 (let ((r (> (logand perm 4) 0))
6974 (w (> (logand perm 2) 0))
6975 (x (> (logand perm 1) 0)))
6976 (concat (or (and r "r") "-")
6977 (or (and w "w") "-")
6978 (or (and suid x suid-text) ; suid, execute
6979 (and suid (upcase suid-text)) ; suid, !execute
6980 (and x "x") "-")))) ; !suid
6983 (defun tramp-decimal-to-octal (i)
6984 "Return a string consisting of the octal digits of I.
6985 Not actually used. Use `(format \"%o\" i)' instead?"
6986 (cond ((< i 0) (error "Cannot convert negative number to octal"))
6987 ((not (integerp i)) (error "Cannot convert non-integer to octal"))
6989 (t (concat (tramp-decimal-to-octal (/ i 8))
6990 (number-to-string (% i 8))))))
6993 ;;(defun tramp-octal-to-decimal (ostr)
6994 ;; "Given a string of octal digits, return a decimal number."
6995 ;; (cond ((null ostr) 0)
6996 ;; ((string= "" ostr) 0)
6997 ;; (t (let ((last (aref ostr (1- (length ostr))))
6998 ;; (rest (substring ostr 0 (1- (length ostr)))))
6999 ;; (unless (and (>= last ?0)
7001 ;; (error "Not an octal digit: %c" last))
7002 ;; (+ (- last ?0) (* 8 (tramp-octal-to-decimal rest)))))))
7003 ;; Kudos to Gerd Moellmann for this suggestion.
7004 (defun tramp-octal-to-decimal (ostr)
7005 "Given a string of octal digits, return a decimal number."
7006 (let ((x (or ostr "")))
7007 ;; `save-match' is in `tramp-mode-string-to-int' which calls this.
7008 (unless (string-match "\\`[0-7]*\\'" x)
7009 (error "Non-octal junk in string `%s'" x))
7010 (string-to-number ostr 8)))
7012 (defun tramp-shell-case-fold (string)
7013 "Converts STRING to shell glob pattern which ignores case."
7016 (if (equal (downcase c) (upcase c))
7018 (format "[%c%c]" (downcase c) (upcase c))))
7023 ;; ------------------------------------------------------------
7024 ;; -- TRAMP file names --
7025 ;; ------------------------------------------------------------
7026 ;; Conversion functions between external representation and
7027 ;; internal data structure. Convenience functions for internal
7030 (defun tramp-file-name-p (obj)
7031 "Check whether TRAMP-FILE-NAME is a Tramp object."
7032 (and (vectorp obj) (= 5 (length obj))))
7034 (defun tramp-file-name-multi-method (obj)
7035 "Return MULTI-METHOD component of TRAMP-FILE-NAME."
7036 (and (tramp-file-name-p obj) (aref obj 0)))
7038 (defun tramp-file-name-method (obj)
7039 "Return METHOD component of TRAMP-FILE-NAME."
7040 (and (tramp-file-name-p obj) (aref obj 1)))
7042 (defun tramp-file-name-user (obj)
7043 "Return USER component of TRAMP-FILE-NAME."
7044 (and (tramp-file-name-p obj) (aref obj 2)))
7046 (defun tramp-file-name-host (obj)
7047 "Return HOST component of TRAMP-FILE-NAME."
7048 (and (tramp-file-name-p obj) (aref obj 3)))
7050 (defun tramp-file-name-localname (obj)
7051 "Return LOCALNAME component of TRAMP-FILE-NAME."
7052 (and (tramp-file-name-p obj) (aref obj 4)))
7054 (defun tramp-tramp-file-p (name)
7055 "Return t if NAME is a tramp file."
7057 (string-match tramp-file-name-regexp name)))
7059 ;; HHH: Changed. Used to assign the return value of (user-login-name)
7060 ;; to the `user' part of the structure if a user name was not
7061 ;; provided, now it assigns nil.
7062 (defun tramp-dissect-file-name (name)
7063 "Return an `tramp-file-name' structure.
7064 The structure consists of remote method, remote user, remote host and
7065 localname (file name on remote host)."
7067 (let* ((match (string-match (nth 0 tramp-file-name-structure) name))
7070 (if match (match-string (nth 1 tramp-file-name-structure) name)
7073 (format (nth 0 tramp-multi-file-name-structure)
7074 (nth 0 tramp-multi-file-name-hop-structure)) name)
7075 (match-string (nth 1 tramp-multi-file-name-structure) name))))
7076 (if (and method (member method tramp-multi-methods))
7077 ;; If it's a multi method, the file name structure contains
7078 ;; arrays of method, user and host.
7079 (tramp-dissect-multi-file-name name)
7080 ;; Normal method. First, find out default method.
7081 (unless match (error "Not a tramp file name: %s" name))
7082 (let ((user (match-string (nth 2 tramp-file-name-structure) name))
7083 (host (match-string (nth 3 tramp-file-name-structure) name))
7084 (localname (match-string (nth 4 tramp-file-name-structure) name)))
7085 (vector nil method (or user nil) host localname))))))
7087 (defun tramp-find-default-method (user host)
7088 "Look up the right method to use in `tramp-default-method-alist'."
7089 (let ((choices tramp-default-method-alist)
7090 (method tramp-default-method)
7093 (setq item (pop choices))
7094 (when (and (string-match (or (nth 0 item) "") (or host ""))
7095 (string-match (or (nth 1 item) "") (or user "")))
7096 (setq method (nth 2 item))
7097 (setq choices nil)))
7100 (defun tramp-find-method (multi-method method user host)
7101 "Return the right method string to use.
7102 This is MULTI-METHOD, if non-nil. Otherwise, it is METHOD, if non-nil.
7103 If both MULTI-METHOD and METHOD are nil, do a lookup in
7104 `tramp-default-method-alist'."
7105 (or multi-method method (tramp-find-default-method user host)))
7107 ;; HHH: Not Changed. Multi method. Will probably not handle the case where
7108 ;; a user name is not provided in the "file name" very well.
7109 (defun tramp-dissect-multi-file-name (name)
7110 "Not implemented yet."
7111 (let ((regexp (nth 0 tramp-multi-file-name-structure))
7112 (method-index (nth 1 tramp-multi-file-name-structure))
7113 (hops-index (nth 2 tramp-multi-file-name-structure))
7114 (localname-index (nth 3 tramp-multi-file-name-structure))
7115 (hop-regexp (nth 0 tramp-multi-file-name-hop-structure))
7116 (hop-method-index (nth 1 tramp-multi-file-name-hop-structure))
7117 (hop-user-index (nth 2 tramp-multi-file-name-hop-structure))
7118 (hop-host-index (nth 3 tramp-multi-file-name-hop-structure))
7119 method hops len hop-methods hop-users hop-hosts localname)
7120 (unless (string-match (format regexp hop-regexp) name)
7121 (error "Not a multi tramp file name: %s" name))
7122 (setq method (match-string method-index name))
7123 (setq hops (match-string hops-index name))
7124 (setq len (/ (length (match-data t)) 2))
7125 (when (< localname-index 0) (setq localname-index (+ localname-index len)))
7126 (setq localname (match-string localname-index name))
7128 (while (string-match hop-regexp hops index)
7129 (setq index (match-end 0))
7131 (cons (match-string hop-method-index hops) hop-methods))
7133 (cons (match-string hop-user-index hops) hop-users))
7135 (cons (match-string hop-host-index hops) hop-hosts))))
7138 (apply 'vector (reverse hop-methods))
7139 (apply 'vector (reverse hop-users))
7140 (apply 'vector (reverse hop-hosts))
7143 (defun tramp-make-tramp-file-name (multi-method method user host localname)
7144 "Constructs a tramp file name from METHOD, USER, HOST and LOCALNAME."
7146 (tramp-make-tramp-multi-file-name multi-method method user host localname)
7148 (concat tramp-prefix-format
7149 (when method (concat "%m" tramp-postfix-single-method-format))
7150 (when user (concat "%u" tramp-postfix-user-format))
7151 (when host (concat "%h" tramp-postfix-host-format))
7152 (when localname (concat "%p")))
7153 `((?m . ,method) (?u . ,user) (?h . ,host) (?p . ,localname)))))
7155 ;; CCC: Henrik Holm: Not Changed. Multi Method. What should be done
7156 ;; with this when USER is nil?
7157 (defun tramp-make-tramp-multi-file-name (multi-method method user host localname)
7158 "Constructs a tramp file name for a multi-hop method."
7159 (unless tramp-make-multi-tramp-file-format
7160 (error "`tramp-make-multi-tramp-file-format' is nil"))
7161 (let* ((prefix-format (nth 0 tramp-make-multi-tramp-file-format))
7162 (hop-format (nth 1 tramp-make-multi-tramp-file-format))
7163 (localname-format (nth 2 tramp-make-multi-tramp-file-format))
7164 (prefix (format-spec prefix-format `((?m . ,multi-method))))
7166 (localname (format-spec localname-format `((?p . ,localname))))
7168 (len (length method)))
7170 (let ((m (aref method i)) (u (aref user i)) (h (aref host i)))
7171 (setq hops (concat hops (format-spec hop-format
7172 `((?m . ,m) (?u . ,u) (?h . ,h)))))
7174 (concat prefix hops localname)))
7176 (defun tramp-make-copy-program-file-name (user host localname)
7177 "Create a file name suitable to be passed to `rcp' and workalikes."
7179 (format "%s@%s:%s" user host localname)
7180 (format "%s:%s" host localname)))
7182 (defun tramp-method-out-of-band-p (multi-method method user host)
7183 "Return t if this is an out-of-band method, nil otherwise."
7184 (tramp-get-method-parameter
7186 (tramp-find-method multi-method method user host)
7187 user host 'tramp-copy-program))
7189 ;; Variables local to connection.
7191 (defun tramp-get-ls-command (multi-method method user host)
7194 (tramp-maybe-open-connection multi-method method user host)
7195 (set-buffer (tramp-get-buffer multi-method method user host))
7197 (error "Couldn't find remote `ls' command")))
7199 (defun tramp-get-test-groks-nt (multi-method method user host)
7201 (tramp-maybe-open-connection multi-method method user host)
7202 (set-buffer (tramp-get-buffer multi-method method user host))
7203 tramp-test-groks-nt))
7205 (defun tramp-get-file-exists-command (multi-method method user host)
7208 (tramp-maybe-open-connection multi-method method user host)
7209 (set-buffer (tramp-get-buffer multi-method method user host))
7210 tramp-file-exists-command)
7211 (error "Couldn't find remote `test -e' command")))
7213 (defun tramp-get-remote-perl (multi-method method user host)
7214 (tramp-get-connection-property "perl" nil multi-method method user host))
7216 (defun tramp-get-remote-ln (multi-method method user host)
7218 (tramp-get-connection-property "ln" nil multi-method method user host)
7219 (error "Couldn't find remote `ln' command")))
7221 (defun tramp-get-remote-uid (multi-method method user host)
7222 (tramp-get-connection-property "uid" nil multi-method method user host))
7224 (defun tramp-get-remote-gid (multi-method method user host)
7225 (tramp-get-connection-property "gid" nil multi-method method user host))
7227 ;; Get a property of a TRAMP connection.
7228 (defun tramp-get-connection-property
7229 (property default multi-method method user host)
7230 "Get the named property for the connection.
7231 If the value is not set for the connection, return `default'"
7232 (tramp-maybe-open-connection multi-method method user host)
7233 (with-current-buffer (tramp-get-buffer multi-method method user host)
7236 (symbol-value (intern (concat "tramp-connection-property-" property)))
7239 ;; Set a property of a TRAMP connection.
7240 (defun tramp-set-connection-property
7241 (property value multi-method method user host)
7242 "Set the named property of a TRAMP connection."
7243 (tramp-maybe-open-connection multi-method method user host)
7244 (with-current-buffer (tramp-get-buffer multi-method method user host)
7245 (set (make-local-variable
7246 (intern (concat "tramp-connection-property-" property)))
7249 ;; Some predefined connection properties.
7250 (defun tramp-set-remote-encoding (multi-method method user host rem-enc)
7251 (tramp-set-connection-property "remote-encoding" rem-enc
7252 multi-method method user host))
7253 (defun tramp-get-remote-encoding (multi-method method user host)
7254 (tramp-get-connection-property "remote-encoding" nil
7255 multi-method method user host))
7257 (defun tramp-set-remote-decoding (multi-method method user host rem-dec)
7258 (tramp-set-connection-property "remote-decoding" rem-dec
7259 multi-method method user host))
7260 (defun tramp-get-remote-decoding (multi-method method user host)
7261 (tramp-get-connection-property "remote-decoding" nil
7262 multi-method method user host))
7264 (defun tramp-set-local-encoding (multi-method method user host loc-enc)
7265 (tramp-set-connection-property "local-encoding" loc-enc
7266 multi-method method user host))
7267 (defun tramp-get-local-encoding (multi-method method user host)
7268 (tramp-get-connection-property "local-encoding" nil
7269 multi-method method user host))
7271 (defun tramp-set-local-decoding (multi-method method user host loc-dec)
7272 (tramp-set-connection-property "local-decoding" loc-dec
7273 multi-method method user host))
7274 (defun tramp-get-local-decoding (multi-method method user host)
7275 (tramp-get-connection-property "local-decoding" nil
7276 multi-method method user host))
7278 (defun tramp-get-method-parameter (multi-method method user host param)
7279 "Return the method parameter PARAM.
7280 If the `tramp-methods' entry does not exist, use the variable PARAM
7282 (unless (boundp param)
7283 (error "Non-existing method parameter `%s'" param))
7284 (let ((entry (assoc param
7285 (assoc (tramp-find-method multi-method method user host)
7289 (symbol-value param))))
7292 ;; Auto saving to a special directory.
7294 (defun tramp-exists-file-name-handler (operation &rest args)
7295 (let ((buffer-file-name "/")
7296 (fnha file-name-handler-alist)
7297 (check-file-name-operation operation)
7298 (file-name-handler-alist
7301 '(lambda (operation &rest args)
7302 "Returns OPERATION if it is the one to be checked"
7303 (if (equal check-file-name-operation operation)
7305 (let ((file-name-handler-alist fnha))
7306 (apply operation args))))))))
7307 (eq (apply operation args) operation)))
7309 (unless (tramp-exists-file-name-handler 'make-auto-save-file-name)
7310 (defadvice make-auto-save-file-name
7311 (around tramp-advice-make-auto-save-file-name () activate)
7312 "Invoke `tramp-handle-make-auto-save-file-name' for tramp files."
7313 (if (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))
7314 (setq ad-return-value (tramp-handle-make-auto-save-file-name))
7316 (add-hook 'tramp-unload-hook
7317 '(lambda () (ad-unadvise 'make-auto-save-file-name))))
7319 ;; In Emacs < 22 and XEmacs < 21.5 autosaved remote files have
7320 ;; permission 0666 minus umask. This is a security threat.
7322 (defun tramp-set-auto-save-file-modes ()
7323 "Set permissions of autosaved remote files to the original permissions."
7324 (let ((bfn (buffer-file-name)))
7325 (when (and (stringp bfn)
7326 (tramp-tramp-file-p bfn)
7327 (stringp buffer-auto-save-file-name)
7328 (not (equal bfn buffer-auto-save-file-name)))
7329 (unless (file-exists-p buffer-auto-save-file-name)
7330 (write-region "" nil buffer-auto-save-file-name))
7331 ;; Permissions should be set always, because there might be an old
7332 ;; auto-saved file belonging to another original file. This could
7333 ;; be a security threat.
7334 (set-file-modes buffer-auto-save-file-name
7335 (or (file-modes bfn) (tramp-octal-to-decimal "0600"))))))
7337 (unless (or (> emacs-major-version 21)
7338 (and (featurep 'xemacs)
7339 (= emacs-major-version 21)
7340 (> emacs-minor-version 4)))
7341 (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)
7342 (add-hook 'tramp-unload-hook
7344 (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes))))
7346 (defun tramp-subst-strs-in-string (alist string)
7347 "Replace all occurrences of the string FROM with TO in STRING.
7348 ALIST is of the form ((FROM . TO) ...)."
7351 (let* ((pr (car alist))
7354 (while (string-match (regexp-quote from) string)
7355 (setq string (replace-match to t t string)))
7356 (setq alist (cdr alist))))
7359 (defun tramp-insert-with-face (face string)
7360 "Insert text with a specific face."
7361 (let ((start (point)))
7363 (add-text-properties start (point) (list 'face face))))
7365 ;; ------------------------------------------------------------
7366 ;; -- Compatibility functions section --
7367 ;; ------------------------------------------------------------
7369 (defun tramp-temporary-file-directory ()
7370 "Return name of directory for temporary files (compat function).
7371 For Emacs, this is the variable `temporary-file-directory', for XEmacs
7372 this is the function `temp-directory'."
7373 (cond ((boundp 'temporary-file-directory)
7374 (symbol-value 'temporary-file-directory))
7375 ((fboundp 'temp-directory)
7376 (funcall (symbol-function 'temp-directory))) ;pacify byte-compiler
7377 ((let ((d (getenv "TEMP"))) (and d (file-directory-p d)))
7378 (file-name-as-directory (getenv "TEMP")))
7379 ((let ((d (getenv "TMP"))) (and d (file-directory-p d)))
7380 (file-name-as-directory (getenv "TMP")))
7381 ((let ((d (getenv "TMPDIR"))) (and d (file-directory-p d)))
7382 (file-name-as-directory (getenv "TMPDIR")))
7383 ((file-exists-p "c:/temp") (file-name-as-directory "c:/temp"))
7384 (t (message (concat "Neither `temporary-file-directory' nor "
7385 "`temp-directory' is defined -- using /tmp."))
7386 (file-name-as-directory "/tmp"))))
7388 (defun tramp-read-passwd (user host prompt)
7389 "Read a password from user (compat function).
7390 Invokes `password-read' if available, `read-passwd' else."
7391 (if (functionp 'password-read)
7392 (let* ((key (concat (or user (user-login-name)) "@" host))
7393 (password (apply #'password-read (list prompt key))))
7394 (apply #'password-cache-add (list key password))
7396 (read-passwd prompt)))
7398 (defun tramp-clear-passwd (&optional user host)
7399 "Clear password cache for connection related to current-buffer."
7401 (let ((filename (or buffer-file-name list-buffers-directory "")))
7402 (when (and (functionp 'password-cache-remove)
7403 (or (and user host) (tramp-tramp-file-p filename)))
7404 (let* ((v (when (tramp-tramp-file-p filename)
7405 (tramp-dissect-file-name filename)))
7406 (luser (or user (tramp-file-name-user v) (user-login-name)))
7407 (lhost (or host (tramp-file-name-host v) (system-name)))
7408 (key (concat luser "@" lhost)))
7409 (apply #'password-cache-remove (list key))))))
7411 (defun tramp-time-diff (t1 t2)
7412 "Return the difference between the two times, in seconds.
7413 T1 and T2 are time values (as returned by `current-time' for example)."
7414 ;; Pacify byte-compiler with `symbol-function'.
7415 (cond ((and (fboundp 'subtract-time)
7416 (fboundp 'float-time))
7417 (funcall (symbol-function 'float-time)
7418 (funcall (symbol-function 'subtract-time) t1 t2)))
7419 ((and (fboundp 'subtract-time)
7420 (fboundp 'time-to-seconds))
7421 (funcall (symbol-function 'time-to-seconds)
7422 (funcall (symbol-function 'subtract-time) t1 t2)))
7423 ((fboundp 'itimer-time-difference)
7424 (funcall (symbol-function 'itimer-time-difference)
7425 (if (< (length t1) 3) (append t1 '(0)) t1)
7426 (if (< (length t2) 3) (append t2 '(0)) t2)))
7428 ;; snarfed from Emacs 21 time-date.el; combining
7429 ;; time-to-seconds and subtract-time
7430 (let ((time (let ((borrow (< (cadr t1) (cadr t2))))
7431 (list (- (car t1) (car t2) (if borrow 1 0))
7432 (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2))))))
7433 (+ (* (car time) 65536.0)
7435 (/ (or (nth 2 time) 0) 1000000.0))))))
7437 (defun tramp-coding-system-change-eol-conversion (coding-system eol-type)
7438 "Return a coding system like CODING-SYSTEM but with given EOL-TYPE.
7439 EOL-TYPE can be one of `dos', `unix', or `mac'."
7440 (cond ((fboundp 'coding-system-change-eol-conversion)
7441 (apply #'coding-system-change-eol-conversion
7442 (list coding-system eol-type)))
7443 ((fboundp 'subsidiary-coding-system)
7445 #'subsidiary-coding-system
7447 (cond ((eq eol-type 'dos) 'crlf)
7448 ((eq eol-type 'unix) 'lf)
7449 ((eq eol-type 'mac) 'cr)
7451 (error "Unknown EOL-TYPE `%s', must be %s"
7453 "`dos', `unix', or `mac'"))))))
7454 (t (error "Can't change EOL conversion -- is MULE missing?"))))
7456 (defun tramp-split-string (string pattern)
7457 "Like `split-string' but omit empty strings.
7458 In Emacs, (split-string \"/foo/bar\" \"/\") returns (\"foo\" \"bar\").
7459 This is, the first, empty, element is omitted. In XEmacs, the first
7460 element is not omitted.
7462 Note: this function has been written for `tramp-handle-file-truename'.
7463 If you want to use it for something else, you'll have to check whether
7464 it does the right thing."
7465 (delete "" (split-string string pattern)))
7467 (defun tramp-set-process-query-on-exit-flag (process flag)
7468 "Specify if query is needed for process when Emacs is exited.
7469 If the second argument flag is non-nil, Emacs will query the user before
7470 exiting if process is running."
7472 (if (fboundp 'set-process-query-on-exit-flag)
7473 (symbol-function 'set-process-query-on-exit-flag)
7474 (symbol-function 'process-kill-without-query))
7478 ;; ------------------------------------------------------------
7479 ;; -- Kludges section --
7480 ;; ------------------------------------------------------------
7482 ;; Currently (as of Emacs 20.5), the function `shell-quote-argument'
7483 ;; does not deal well with newline characters. Newline is replaced by
7484 ;; backslash newline. But if, say, the string `a backslash newline b'
7485 ;; is passed to a shell, the shell will expand this into "ab",
7486 ;; completely omitting the newline. This is not what was intended.
7487 ;; It does not appear to be possible to make the function
7488 ;; `shell-quote-argument' work with newlines without making it
7489 ;; dependent on the shell used. But within this package, we know that
7490 ;; we will always use a Bourne-like shell, so we use an approach which
7493 ;; The approach is simple: we call `shell-quote-argument', then
7494 ;; massage the newline part of the result.
7496 ;; This function should produce a string which is grokked by a Unix
7497 ;; shell, even if the Emacs is running on Windows. Since this is the
7498 ;; kludges section, we bind `system-type' in such a way that
7499 ;; `shell-quote-arguments' behaves as if on Unix.
7501 ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this
7502 ;; function to work with Bourne-like shells.
7504 ;; CCC: This function should be rewritten so that
7505 ;; `shell-quote-argument' is not used. This way, we are safe from
7506 ;; changes in `shell-quote-argument'.
7507 (defun tramp-shell-quote-argument (s)
7508 "Similar to `shell-quote-argument', but groks newlines.
7509 Only works for Bourne-like shells."
7510 (let ((system-type 'not-windows))
7512 (let ((result (shell-quote-argument s))
7513 (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line))))
7514 (when (and (>= (length result) 2)
7515 (string= (substring result 0 2) "\\~"))
7516 (setq result (substring result 1)))
7517 (while (string-match nl result)
7518 (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line)
7522 ;; ;; EFS hooks itself into the file name handling stuff in more places
7523 ;; ;; than just `file-name-handler-alist'. The following tells EFS to stay
7524 ;; ;; away from tramp.el file names.
7526 ;; ;; This is needed because EFS installs (efs-dired-before-readin) into
7527 ;; ;; 'dired-before-readin-hook'. This prevents EFS from opening an FTP
7528 ;; ;; connection to help it's dired process. Not that I have any real
7529 ;; ;; idea *why* this is helpful to dired.
7531 ;; ;; Anyway, this advice fixes the problem (with a sledgehammer :)
7533 ;; ;; Daniel Pittman <daniel@danann.net>
7535 ;; ;; CCC: when the other defadvice calls have disappeared, make sure
7536 ;; ;; not to call defadvice unless it's necessary. How do we find out whether
7537 ;; ;; it is necessary? (featurep 'efs) is surely the wrong way --
7538 ;; ;; EFS might nicht be loaded yet.
7539 ;; (defadvice efs-ftp-path (around dont-match-tramp-localname activate protect)
7540 ;; "Cause efs-ftp-path to fail when the path is a TRAMP localname."
7541 ;; (if (tramp-tramp-file-p (ad-get-arg 0))
7545 ;; We currently (sometimes) use "[" and "]" in the filename format.
7546 ;; This means that Emacs wants to expand wildcards if
7547 ;; `find-file-wildcards' is non-nil, and then barfs because no
7548 ;; expansion could be found. We detect this situation and do
7549 ;; something really awful: we have `file-expand-wildcards' return the
7550 ;; original filename if it can't expand anything. Let's just hope
7551 ;; that this doesn't break anything else.
7552 ;; CCC: This check is now also really awful; we should search all
7553 ;; of the filename format, not just the prefix.
7554 (when (string-match "\\[" tramp-prefix-format)
7555 (defadvice file-expand-wildcards (around tramp-fix activate)
7556 (let ((name (ad-get-arg 0)))
7557 (if (tramp-tramp-file-p name)
7558 ;; If it's a Tramp file, dissect it and look if wildcards
7559 ;; need to be expanded at all.
7560 (let ((v (tramp-dissect-file-name name)))
7561 (if (string-match "[[*?]" (tramp-file-name-localname v))
7562 (let ((res ad-do-it))
7563 (setq ad-return-value (or res (list name))))
7564 (setq ad-return-value (list name))))
7565 ;; If it is not a Tramp file, just run the original function.
7566 (let ((res ad-do-it))
7567 (setq ad-return-value (or res (list name)))))))
7568 (add-hook 'tramp-unload-hook
7569 '(lambda () (ad-unadvise 'file-expand-wildcards))))
7571 ;; Tramp version is useful in a number of situations.
7573 (defun tramp-version (arg)
7574 "Print version number of tramp.el in minibuffer or current buffer."
7576 (if arg (insert tramp-version) (message tramp-version)))
7578 ;; Make the `reporter` functionality available for making bug reports about
7579 ;; the package. A most useful piece of code.
7581 (unless (fboundp 'reporter-submit-bug-report)
7582 (autoload 'reporter-submit-bug-report "reporter"))
7585 "Submit a bug report to the TRAMP developers."
7589 (let ((reporter-prompt-for-summary-p t))
7590 (reporter-submit-bug-report
7591 tramp-bug-report-address ; to-address
7592 (format "tramp (%s)" tramp-version) ; package name and version
7597 tramp-file-exists-command
7598 tramp-current-multi-method
7599 tramp-current-method
7604 tramp-auto-save-directory ; vars to dump
7605 tramp-default-method
7606 tramp-rsh-end-of-line
7607 tramp-default-password-end-of-line
7609 tramp-login-prompt-regexp
7610 ;; Mask non-7bit characters
7611 (tramp-password-prompt-regexp . tramp-reporter-dump-variable)
7612 tramp-wrong-passwd-regexp
7613 tramp-yesno-prompt-regexp
7614 tramp-yn-prompt-regexp
7615 tramp-terminal-prompt-regexp
7616 tramp-temp-name-prefix
7617 tramp-file-name-structure
7618 tramp-file-name-regexp
7619 tramp-multi-file-name-structure
7620 tramp-multi-file-name-hop-structure
7622 tramp-multi-connection-function-alist
7625 tramp-coding-commands
7626 tramp-actions-before-shell
7627 tramp-actions-copy-out-of-band
7630 ;; Mask non-7bit characters
7631 (tramp-shell-prompt-pattern . tramp-reporter-dump-variable)
7633 ,(when (boundp 'tramp-backup-directory-alist)
7634 'tramp-backup-directory-alist)
7635 ,(when (boundp 'tramp-bkup-backup-directory-info)
7636 'tramp-bkup-backup-directory-info)
7638 ;; Non-tramp variables of interest
7639 ;; Mask non-7bit characters
7640 (shell-prompt-pattern . tramp-reporter-dump-variable)
7642 backup-by-copying-when-linked
7643 backup-by-copying-when-mismatch
7644 ,(when (boundp 'backup-by-copying-when-privileged-mismatch)
7645 'backup-by-copying-when-privileged-mismatch)
7646 ,(when (boundp 'password-cache)
7648 ,(when (boundp 'password-cache-expiry)
7649 'password-cache-expiry)
7650 ,(when (boundp 'backup-directory-alist)
7651 'backup-directory-alist)
7652 ,(when (boundp 'bkup-backup-directory-info)
7653 'bkup-backup-directory-info)
7654 file-name-handler-alist))
7656 'tramp-load-report-modules ; pre-hook
7657 'tramp-append-tramp-buffers ; post-hook
7659 Enter your bug report in this message, including as much detail as you
7660 possibly can about the problem, what you did to cause it and what the
7661 local and remote machines are.
7663 If you can give a simple set of instructions to make this bug happen
7664 reliably, please include those. Thank you for helping kill bugs in
7667 Another useful thing to do is to put (setq tramp-debug-buffer t) in
7668 the ~/.emacs file and to repeat the bug. Then, include the contents
7669 of the *tramp/foo* buffer and the *debug tramp/foo* buffer in your bug
7672 --bug report follows this line--
7675 (defun tramp-reporter-dump-variable (varsym mailbuf)
7676 "Pretty-print the value of the variable in symbol VARSYM.
7677 Used for non-7bit chars in strings."
7678 (let* ((reporter-eval-buffer (symbol-value 'reporter-eval-buffer))
7679 (val (with-current-buffer reporter-eval-buffer
7680 (symbol-value varsym))))
7682 ;; There are characters to be masked.
7683 (when (and (boundp 'mm-7bit-chars)
7685 (concat "[^" (symbol-value 'mm-7bit-chars) "]") val))
7686 (with-current-buffer reporter-eval-buffer
7687 (set varsym (concat "(base64-decode-string \""
7688 (base64-encode-string val)
7692 (funcall (symbol-function 'reporter-dump-variable) varsym mailbuf)
7694 ;; Remove string quotation.
7697 (concat "\\(^.*\\)" "\"" ;; \1 "
7698 "\\((base64-decode-string \\)" "\\\\" ;; \2 \
7699 "\\(\".*\\)" "\\\\" ;; \3 \
7700 "\\(\")\\)" "\"$")) ;; \4 "
7701 (replace-match "\\1\\2\\3\\4")
7703 (insert " ;; variable encoded due to non-printable characters\n"))
7706 ;; Reset VARSYM to old value.
7707 (with-current-buffer reporter-eval-buffer
7710 (defun tramp-load-report-modules ()
7711 "Load needed modules for reporting."
7713 ;; We load message.el and mml.el from Gnus.
7714 (if (featurep 'xemacs)
7716 (load "message" 'noerror)
7717 (load "mml" 'noerror))
7718 (require 'message nil 'noerror)
7719 (require 'mml nil 'noerror))
7720 (when (functionp 'message-mode)
7721 (funcall (symbol-function 'message-mode)))
7722 (when (functionp 'mml-mode)
7723 (funcall (symbol-function 'mml-mode) t)))
7725 (defun tramp-append-tramp-buffers ()
7726 "Append Tramp buffers into the bug report."
7729 (eq major-mode 'message-mode)
7731 (symbol-value 'mml-mode))
7733 (let* ((tramp-buf-regexp "\\*\\(debug \\)?tramp/")
7736 (mapcar '(lambda (b)
7737 (when (string-match tramp-buf-regexp (buffer-name b)) b))
7739 (curbuf (current-buffer)))
7741 ;; There is at least one Tramp buffer.
7743 (switch-to-buffer (list-buffers-noselect nil))
7744 (delete-other-windows)
7745 (setq buffer-read-only nil)
7746 (goto-char (point-min))
7748 (if (re-search-forward tramp-buf-regexp (tramp-point-at-eol) t)
7751 (let ((start (point)))
7753 (kill-region start (point)))))
7755 The buffer(s) above will be appended to this message. If you don't want
7756 to append a buffer because it contains sensitive data, or because the buffer
7757 is too large, you should delete the respective buffer. The buffer(s) will
7758 contain user and host names. Passwords will never be included there.")
7760 (when (and tramp-debug-buffer (> tramp-verbose 9))
7762 (let ((start (point)))
7764 Please note that you have set `tramp-verbose' to a value greater than 9.
7765 Therefore, the contents of files might be included in the debug buffer(s).")
7766 (add-text-properties start (point) (list 'face 'italic))))
7768 (set-buffer-modified-p nil)
7769 (setq buffer-read-only t)
7770 (goto-char (point-min))
7772 (if (y-or-n-p "Do you want to append the buffer(s)? ")
7773 ;; OK, let's send. First we delete the buffer list.
7776 (switch-to-buffer curbuf)
7777 (goto-char (point-max))
7779 (dolist (buffer buffer-list)
7780 (funcall (symbol-function 'mml-insert-empty-tag)
7781 'part 'type "text/plain" 'encoding "base64"
7782 'disposition "attachment" 'buffer (buffer-name buffer)
7783 'description (buffer-name buffer)))
7784 (set-buffer-modified-p nil))
7786 ;; Don't send. Delete the message buffer.
7788 (set-buffer-modified-p nil)
7790 (throw 'dont-send nil))))))
7792 (defalias 'tramp-submit-bug 'tramp-bug)
7794 ;; Checklist for `tramp-unload-hook'
7795 ;; - Unload all `tramp-*' packages
7796 ;; - Reset `file-name-handler-alist'
7797 ;; - Cleanup hooks where Tramp functions are in
7798 ;; - Cleanup advised functions
7799 ;; - Cleanup autoloads
7801 (defun tramp-unload-tramp ()
7802 "Discard Tramp from loading remote files."
7804 ;; When Tramp is not loaded yet, its autoloads are still active.
7805 (tramp-unload-file-name-handlers)
7806 ;; ange-ftp settings must be enabled.
7807 (when (functionp 'tramp-ftp-enable-ange-ftp)
7808 (funcall (symbol-function 'tramp-ftp-enable-ange-ftp)))
7809 ;; `tramp-util' unloads also `tramp'.
7810 (condition-case nil ;; maybe its not loaded yet.
7811 (unload-feature (if (featurep 'tramp-util) 'tramp-util 'tramp) 'force)
7816 ;; Make sure that we get integration with the VC package.
7817 ;; When it is loaded, we need to pull in the integration module.
7818 ;; This must come after (provide 'tramp) because tramp-vc.el
7820 (eval-after-load "vc"
7823 (add-hook 'tramp-unload-hook
7825 (when (featurep 'tramp-vc)
7826 (unload-feature 'tramp-vc 'force))))))
7830 ;; * Allow putting passwords in the filename.
7831 ;; This should be implemented via a general mechanism to add
7832 ;; parameters in filenames. There is currently a kludge for
7833 ;; putting the port number into the filename for ssh and ftp
7834 ;; files. This could be subsumed by the new mechanism as well.
7835 ;; Another approach is to read a netrc file like ~/.authinfo
7837 ;; * Handle nonlocal exits such as C-g.
7838 ;; * Autodetect if remote `ls' groks the "--dired" switch.
7839 ;; * Add fallback for inline encodings. This should be used
7840 ;; if the remote end doesn't support mimencode or a similar program.
7841 ;; For reading files from the remote host, we can just parse the output
7842 ;; of `od -b'. For writing files to the remote host, we construct
7843 ;; a shell program which contains only "safe" ascii characters
7844 ;; and which writes the right bytes to the file. We can use printf(1)
7845 ;; or "echo -e" or the printf function in awk and use octal escapes
7846 ;; for the "dangerous" characters. The null byte might be a problem.
7847 ;; On some systems, the octal escape doesn't work. So we try the following
7848 ;; two commands to write a null byte:
7849 ;; dd if=/dev/zero bs=1 count=1
7850 ;; echo | tr '\n' '\000'
7851 ;; * Separate local `tramp-coding-commands' from remote ones. Connect
7852 ;; the two via a format which can be `uu' or `b64'. Then we can search
7853 ;; for the right local commands and the right remote commands separately.
7854 ;; * Cooperate with PCL-CVS. It uses start-process, which doesn't
7855 ;; work for remote files.
7856 ;; * Rewrite `tramp-shell-quote-argument' to abstain from using
7857 ;; `shell-quote-argument'.
7858 ;; * Completion gets confused when you leave out the method name.
7859 ;; * In Emacs 21, `insert-directory' shows total number of bytes used
7860 ;; by the files in that directory. Add this here.
7861 ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman)
7862 ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman)
7863 ;; * When logging in, keep looking for questions according to an alist
7864 ;; and then invoke the right function.
7865 ;; * Case-insensitive filename completion. (Norbert Goevert.)
7866 ;; * Running CVS remotely doesn't appear to work right. It thinks
7867 ;; files are locked by somebody else even if I'm the locking user.
7868 ;; Sometimes, one gets `No CVSROOT specified' errors from CVS.
7870 ;; * Don't use globbing for directories with many files, as this is
7871 ;; likely to produce long command lines, and some shells choke on
7872 ;; long command lines.
7873 ;; * Find out about the new auto-save mechanism in Emacs 21 and
7874 ;; do the right thing.
7875 ;; * `vc-directory' does not work. It never displays any files, even
7876 ;; if it does show files when run locally.
7877 ;; * Allow correction of passwords, if the remote end allows this.
7878 ;; (Mark Hershberger)
7879 ;; * How to deal with MULE in `insert-file-contents' and `write-region'?
7880 ;; * Do asynchronous `shell-command's.
7881 ;; * Grok `append' parameter for `write-region'.
7882 ;; * Test remote ksh or bash for tilde expansion in `tramp-find-shell'?
7883 ;; * abbreviate-file-name
7884 ;; * grok ~ in tramp-remote-path (Henrik Holm <henrikh@tele.ntnu.no>)
7885 ;; * Also allow to omit user names when doing multi-hop. Not sure yet
7886 ;; what the user names should default to, though.
7887 ;; * better error checking. At least whenever we see something
7888 ;; strange when doing zerop, we should kill the process and start
7889 ;; again. (Greg Stark)
7890 ;; * Add caching for filename completion. (Greg Stark)
7891 ;; Of course, this has issues with usability (stale cache bites)
7892 ;; -- <daniel@danann.net>
7893 ;; * Provide a local cache of old versions of remote files for the rsync
7894 ;; transfer method to use. (Greg Stark)
7895 ;; * Remove unneeded parameters from methods.
7896 ;; * Invoke rsync once for copying a whole directory hierarchy.
7897 ;; (Francesco Potort
\e,Al
\e(B)
7898 ;; * Should we set PATH ourselves or should we rely on the remote end
7900 ;; * Make it work for XEmacs 20, which is missing `with-timeout'.
7901 ;; * Make it work for different encodings, and for different file name
7902 ;; encodings, too. (Daniel Pittman)
7903 ;; * Change applicable functions to pass a struct tramp-file-name rather
7904 ;; than the individual items MULTI-METHOD, METHOD, USER, HOST, LOCALNAME.
7905 ;; * Implement asynchronous shell commands.
7906 ;; * Clean up unused *tramp/foo* buffers after a while. (Pete Forman)
7907 ;; * Progress reports while copying files. (Michael Kifer)
7908 ;; * `Smart' connection method that uses inline for small and out of
7909 ;; band for large files. (Michael Kifer)
7910 ;; * Don't search for perl5 and perl. Instead, only search for perl and
7911 ;; then look if it's the right version (with `perl -v').
7912 ;; * When editing a remote CVS controlled file as a different user, VC
7913 ;; gets confused about the file locking status. Try to find out why
7914 ;; the workaround doesn't work.
7915 ;; * Change `copy-file' to grok the case where the filename handler
7916 ;; for the source and the target file are different. Right now,
7917 ;; it looks at the source file and then calls that handler, if
7918 ;; there is one. But since ange-ftp, for instance, does not know
7919 ;; about Tramp, it does not do the right thing if the target file
7920 ;; name is a Tramp name.
7921 ;; * Username and hostname completion.
7922 ;; ** If `partial-completion-mode' isn't loaded, "/foo:bla" tries to
7923 ;; connect to host "blabla" already if that host is unique. No idea
7924 ;; how to suppress. Maybe not an essential problem.
7925 ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'.
7926 ;; ** Extend `tramp-get-completion-su' for NIS and shadow passwords.
7927 ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'.
7928 ;; Code is nearly identical.
7929 ;; ** Decide whiche files to take for searching user/host names depending on
7930 ;; operating system (windows-nt) in `tramp-completion-function-alist'.
7931 ;; ** Enhance variables for debug.
7932 ;; ** Implement "/multi:" completion.
7933 ;; ** Add a learning mode for completion. Make results persistent.
7934 ;; * Allow out-of-band methods as _last_ multi-hop.
7936 ;; Functions for file-name-handler-alist:
7937 ;; diff-latest-backup-file -- in diff.el
7938 ;; dired-uncache -- this will be needed when we do insert-directory caching
7939 ;; file-name-as-directory -- use primitive?
7940 ;; file-name-sans-versions -- use primitive?
7941 ;; get-file-buffer -- use primitive
7944 ;;; arch-tag: 3a21a994-182b-48fa-b0cd-c1d9fede424a
7945 ;;; tramp.el ends here