1 ;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
3 ;; Copyright (C) 1998-2013 Free Software Foundation, Inc.
5 ;; (copyright statements below in code to be updated with the above notice)
7 ;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8 ;; Michael Albinus <michael.albinus@gmx.de>
9 ;; Keywords: comm, processes
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 ;; Pacify byte-compiler.
35 (defvar directory-sep-char
)
36 (defvar tramp-gw-tunnel-method
)
37 (defvar tramp-gw-socks-method
)
39 (defcustom tramp-inline-compress-start-size
4096
40 "The minimum size of compressing where inline transfer.
41 When inline transfer, compress transferred data of file
42 whose size is this value or above (up to `tramp-copy-size-limit').
43 If it is nil, no compression at all will be applied."
45 :type
'(choice (const nil
) integer
))
47 (defcustom tramp-copy-size-limit
10240
48 "The maximum file size where inline copying is preferred over an \
50 If it is nil, out-of-the-band copy will be used without a check."
52 :type
'(choice (const nil
) integer
))
55 (defcustom tramp-terminal-type
"dumb"
56 "Value of TERM environment variable for logging in to remote host.
57 Because Tramp wants to parse the output of the remote shell, it is easily
58 confused by ANSI color escape sequences and suchlike. Often, shell init
59 files conditionalize this setup based on the TERM environment variable."
63 (defconst tramp-color-escape-sequence-regexp
"\e[[;0-9]+m"
64 "Escape sequences produced by the \"ls\" command.")
66 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
67 ;; root users. It uses the `$' character for other users. In order
68 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
70 (defvar tramp-end-of-output
73 (md5 (concat (prin1-to-string process-environment
) (current-time-string))))
74 "String used to recognize end of output.
75 The '$' character at the end is quoted; the string cannot be
76 detected as prompt when being sent on echoing hosts, therefore.")
79 (defconst tramp-initial-end-of-output
"#$ "
80 "Prompt when establishing a connection.")
82 ;; Initialize `tramp-methods' with the supported methods.
84 (add-to-list 'tramp-methods
86 (tramp-login-program "rsh")
87 (tramp-login-args (("%h") ("-l" "%u")))
88 (tramp-remote-shell "/bin/sh")
89 (tramp-remote-shell-args ("-c"))
90 (tramp-copy-program "rcp")
91 (tramp-copy-args (("-p" "%k") ("-r")))
92 (tramp-copy-keep-date t
)
93 (tramp-copy-recursive t
)))
95 (add-to-list 'tramp-methods
97 (tramp-login-program "remsh")
98 (tramp-login-args (("%h") ("-l" "%u")))
99 (tramp-remote-shell "/bin/sh")
100 (tramp-remote-shell-args ("-c"))
101 (tramp-copy-program "rcp")
102 (tramp-copy-args (("-p" "%k")))
103 (tramp-copy-keep-date t
)))
105 (add-to-list 'tramp-methods
107 (tramp-login-program "ssh")
108 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
109 ("-e" "none") ("%h")))
110 (tramp-async-args (("-q")))
111 (tramp-remote-shell "/bin/sh")
112 (tramp-remote-shell-args ("-c"))
113 (tramp-copy-program "scp")
114 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r") ("%c")))
115 (tramp-copy-keep-date t
)
116 (tramp-copy-recursive t
)
117 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
118 ("-o" "UserKnownHostsFile=/dev/null")
119 ("-o" "StrictHostKeyChecking=no")))
120 (tramp-default-port 22)))
122 (add-to-list 'tramp-methods
124 (tramp-login-program "ssh")
125 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
126 ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh")))
127 (tramp-async-args (("-q")))
128 (tramp-remote-shell "/bin/sh")
129 (tramp-remote-shell-args ("-c"))
130 (tramp-copy-program "scp")
131 (tramp-copy-args (("-P" "%p") ("-p" "%k")
132 ("-q") ("-r") ("%c")))
133 (tramp-copy-keep-date t
)
134 (tramp-copy-recursive t
)
135 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
136 ("-o" "UserKnownHostsFile=/dev/null")
137 ("-o" "StrictHostKeyChecking=no")))
138 (tramp-default-port 22)))
140 (add-to-list 'tramp-methods
142 (tramp-login-program "ssh")
143 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
144 ("-e" "none") ("%h")))
145 (tramp-async-args (("-q")))
146 (tramp-remote-shell "/bin/sh")
147 (tramp-remote-shell-args ("-c"))
148 (tramp-copy-program "sftp")
149 (tramp-copy-args ("%c"))))
151 (add-to-list 'tramp-methods
153 (tramp-login-program "ssh")
154 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
155 ("-e" "none") ("%h")))
156 (tramp-async-args (("-q")))
157 (tramp-remote-shell "/bin/sh")
158 (tramp-remote-shell-args ("-c"))
159 (tramp-copy-program "rsync")
160 (tramp-copy-args (("-t" "%k") ("-r")))
161 (tramp-copy-env (("RSYNC_RSH") ("ssh" "%c")))
162 (tramp-copy-keep-date t
)
163 (tramp-copy-keep-tmpfile t
)
164 (tramp-copy-recursive t
)))
166 (add-to-list 'tramp-methods
168 (tramp-login-program "rsh")
169 (tramp-login-args (("%h") ("-l" "%u")))
170 (tramp-remote-shell "/bin/sh")
171 (tramp-remote-shell-args ("-c"))))
173 (add-to-list 'tramp-methods
175 (tramp-login-program "remsh")
176 (tramp-login-args (("%h") ("-l" "%u")))
177 (tramp-remote-shell "/bin/sh")
178 (tramp-remote-shell-args ("-c"))))
180 (add-to-list 'tramp-methods
182 (tramp-login-program "ssh")
183 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
184 ("-e" "none") ("%h")))
185 (tramp-async-args (("-q")))
186 (tramp-remote-shell "/bin/sh")
187 (tramp-remote-shell-args ("-c"))
188 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
189 ("-o" "UserKnownHostsFile=/dev/null")
190 ("-o" "StrictHostKeyChecking=no")))
191 (tramp-default-port 22)))
193 (add-to-list 'tramp-methods
195 (tramp-login-program "ssh")
196 (tramp-login-args (("-l" "%u") ("-p" "%p") ("%c")
197 ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh")))
198 (tramp-async-args (("-q")))
199 (tramp-remote-shell "/bin/sh")
200 (tramp-remote-shell-args ("-c"))
201 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
202 ("-o" "UserKnownHostsFile=/dev/null")
203 ("-o" "StrictHostKeyChecking=no")))
204 (tramp-default-port 22)))
206 (add-to-list 'tramp-methods
208 (tramp-login-program "telnet")
209 (tramp-login-args (("%h") ("%p")))
210 (tramp-remote-shell "/bin/sh")
211 (tramp-remote-shell-args ("-c"))
212 (tramp-default-port 23)))
214 (add-to-list 'tramp-methods
216 (tramp-login-program "su")
217 (tramp-login-args (("-") ("%u")))
218 (tramp-remote-shell "/bin/sh")
219 (tramp-remote-shell-args ("-c"))
220 (tramp-connection-timeout 10)))
222 (add-to-list 'tramp-methods
224 (tramp-login-program "sudo")
225 (tramp-login-args (("-u" "%u") ("-s") ("-H") ("-p" "Password:")))
226 (tramp-remote-shell "/bin/sh")
227 (tramp-remote-shell-args ("-c"))
228 (tramp-connection-timeout 10)))
230 (add-to-list 'tramp-methods
232 (tramp-login-program "ksu")
233 (tramp-login-args (("%u") ("-q")))
234 (tramp-remote-shell "/bin/sh")
235 (tramp-remote-shell-args ("-c"))
236 (tramp-connection-timeout 10)))
238 (add-to-list 'tramp-methods
240 (tramp-login-program "krlogin")
241 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
242 (tramp-remote-shell "/bin/sh")
243 (tramp-remote-shell-args ("-c"))))
245 (add-to-list 'tramp-methods
247 (tramp-login-program "plink")
248 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
249 (tramp-remote-shell "/bin/sh")
250 (tramp-remote-shell-args ("-c"))
251 (tramp-default-port 22)))
253 (add-to-list 'tramp-methods
255 (tramp-login-program "plink")
256 ;; ("%h") must be a single element, see
257 ;; `tramp-compute-multi-hops'.
258 (tramp-login-args (("-load") ("%h") ("-t")
260 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
262 tramp-initial-end-of-output
))
264 (tramp-remote-shell "/bin/sh")
265 (tramp-remote-shell-args ("-c"))))
267 (add-to-list 'tramp-methods
269 (tramp-login-program "plink")
270 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
271 (tramp-remote-shell "/bin/sh")
272 (tramp-remote-shell-args ("-c"))
273 (tramp-copy-program "pscp")
274 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-scp") ("-p" "%k")
276 (tramp-copy-keep-date t
)
277 (tramp-copy-recursive t
)
278 (tramp-default-port 22)))
280 (add-to-list 'tramp-methods
282 (tramp-login-program "plink")
283 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
284 (tramp-remote-shell "/bin/sh")
285 (tramp-remote-shell-args ("-c"))
286 (tramp-copy-program "pscp")
287 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-sftp") ("-p" "%k")
289 (tramp-copy-keep-date t
)
290 (tramp-copy-recursive t
)))
292 (add-to-list 'tramp-methods
294 (tramp-login-program "fsh")
295 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
296 (tramp-remote-shell "/bin/sh")
297 (tramp-remote-shell-args ("-i") ("-c"))
298 (tramp-copy-program "fcp")
299 (tramp-copy-args (("-p" "%k")))
300 (tramp-copy-keep-date t
)))
303 (add-to-list 'tramp-default-method-alist
304 `(,tramp-local-host-regexp
"\\`root\\'" "su"))
307 (add-to-list 'tramp-default-user-alist
308 `(,(concat "\\`" (regexp-opt '("su" "sudo" "ksu")) "\\'")
310 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
311 ;; Do not add "plink" based methods, they ask interactively for the user.
313 (add-to-list 'tramp-default-user-alist
316 (regexp-opt '("rcp" "remcp" "rsh" "telnet" "krlogin" "fcp"))
318 nil
,(user-login-name)))
321 (defconst tramp-completion-function-alist-rsh
322 '((tramp-parse-rhosts "/etc/hosts.equiv")
323 (tramp-parse-rhosts "~/.rhosts"))
324 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
327 (defconst tramp-completion-function-alist-ssh
328 '((tramp-parse-rhosts "/etc/hosts.equiv")
329 (tramp-parse-rhosts "/etc/shosts.equiv")
330 (tramp-parse-shosts "/etc/ssh_known_hosts")
331 (tramp-parse-sconfig "/etc/ssh_config")
332 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
333 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
334 (tramp-parse-rhosts "~/.rhosts")
335 (tramp-parse-rhosts "~/.shosts")
336 (tramp-parse-shosts "~/.ssh/known_hosts")
337 (tramp-parse-sconfig "~/.ssh/config")
338 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
339 (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
340 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
343 (defconst tramp-completion-function-alist-telnet
344 '((tramp-parse-hosts "/etc/hosts"))
345 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
348 (defconst tramp-completion-function-alist-su
349 '((tramp-parse-passwd "/etc/passwd"))
350 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
353 (defconst tramp-completion-function-alist-putty
355 ,(if (memq system-type
'(windows-nt))
356 "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"
357 "~/.putty/sessions")))
358 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty sessions.")
361 (eval-after-load 'tramp
363 (tramp-set-completion-function "rcp" tramp-completion-function-alist-rsh
)
364 (tramp-set-completion-function "remcp" tramp-completion-function-alist-rsh
)
365 (tramp-set-completion-function "scp" tramp-completion-function-alist-ssh
)
366 (tramp-set-completion-function "scpx" tramp-completion-function-alist-ssh
)
367 (tramp-set-completion-function "sftp" tramp-completion-function-alist-ssh
)
368 (tramp-set-completion-function "rsync" tramp-completion-function-alist-ssh
)
369 (tramp-set-completion-function "rsh" tramp-completion-function-alist-rsh
)
370 (tramp-set-completion-function "remsh" tramp-completion-function-alist-rsh
)
371 (tramp-set-completion-function "ssh" tramp-completion-function-alist-ssh
)
372 (tramp-set-completion-function "sshx" tramp-completion-function-alist-ssh
)
373 (tramp-set-completion-function
374 "telnet" tramp-completion-function-alist-telnet
)
375 (tramp-set-completion-function "su" tramp-completion-function-alist-su
)
376 (tramp-set-completion-function "sudo" tramp-completion-function-alist-su
)
377 (tramp-set-completion-function "ksu" tramp-completion-function-alist-su
)
378 (tramp-set-completion-function
379 "krlogin" tramp-completion-function-alist-rsh
)
380 (tramp-set-completion-function "plink" tramp-completion-function-alist-ssh
)
381 (tramp-set-completion-function
382 "plinkx" tramp-completion-function-alist-putty
)
383 (tramp-set-completion-function "pscp" tramp-completion-function-alist-ssh
)
384 (tramp-set-completion-function "fcp" tramp-completion-function-alist-ssh
)))
386 ;; "getconf PATH" yields:
387 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
388 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
389 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
390 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
393 (defcustom tramp-remote-path
394 '(tramp-default-remote-path "/bin" "/usr/bin" "/sbin" "/usr/sbin"
395 "/usr/local/bin" "/usr/local/sbin" "/local/bin" "/local/freeware/bin"
396 "/local/gnu/bin" "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin"
397 "/opt/bin" "/opt/sbin" "/opt/local/bin")
398 "List of directories to search for executables on remote host.
399 For every remote host, this variable will be set buffer local,
400 keeping the list of existing directories on that host.
402 You can use `~' in this list, but when searching for a shell which groks
403 tilde expansion, all directory names starting with `~' will be ignored.
405 `Default Directories' represent the list of directories given by
406 the command \"getconf PATH\". It is recommended to use this
407 entry on top of this list, because these are the default
408 directories for POSIX compatible commands. On remote hosts which
409 do not offer the getconf command (like cygwin), the value
410 \"/bin:/usr/bin\" is used instead of.
412 `Private Directories' are the settings of the $PATH environment,
413 as given in your `~/.profile'."
415 :type
'(repeat (choice
416 (const :tag
"Default Directories" tramp-default-remote-path
)
417 (const :tag
"Private Directories" tramp-own-remote-path
)
418 (string :tag
"Directory"))))
421 (defcustom tramp-remote-process-environment
422 `("HISTFILE=$HOME/.tramp_history" "HISTSIZE=1" "TMOUT=0" "LC_ALL=C"
423 ,(format "TERM=%s" tramp-terminal-type
)
424 "EMACS=t" ;; Deprecated.
425 ,(format "INSIDE_EMACS='%s,tramp:%s'" emacs-version tramp-version
)
426 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH=" "PAGER=\"\""
427 "autocorrect=" "correct=")
428 "List of environment variables to be set on the remote host.
430 Each element should be a string of the form ENVVARNAME=VALUE. An
431 entry ENVVARNAME= disables the corresponding environment variable,
432 which might have been set in the init files like ~/.profile.
434 Special handling is applied to the PATH environment, which should
435 not be set here. Instead, it should be set via `tramp-remote-path'."
437 :type
'(repeat string
))
439 (defcustom tramp-sh-extra-args
'(("/bash\\'" .
"-norc -noprofile"))
440 "Alist specifying extra arguments to pass to the remote shell.
441 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
442 matching the shell file name and ARGS is a string specifying the
445 This variable is only used when Tramp needs to start up another shell
446 for tilde expansion. The extra arguments should typically prevent the
447 shell from reading its init file."
449 ;; This might be the wrong way to test whether the widget type
450 ;; `alist' is available. Who knows the right way to test it?
451 :type
(if (get 'alist
'widget-type
)
452 '(alist :key-type string
:value-type string
)
453 '(repeat (cons string string
))))
455 (defconst tramp-actions-before-shell
456 '((tramp-login-prompt-regexp tramp-action-login
)
457 (tramp-password-prompt-regexp tramp-action-password
)
458 (tramp-wrong-passwd-regexp tramp-action-permission-denied
)
459 (shell-prompt-pattern tramp-action-succeed
)
460 (tramp-shell-prompt-pattern tramp-action-succeed
)
461 (tramp-yesno-prompt-regexp tramp-action-yesno
)
462 (tramp-yn-prompt-regexp tramp-action-yn
)
463 (tramp-terminal-prompt-regexp tramp-action-terminal
)
464 (tramp-process-alive-regexp tramp-action-process-alive
))
465 "List of pattern/action pairs.
466 Whenever a pattern matches, the corresponding action is performed.
467 Each item looks like (PATTERN ACTION).
469 The PATTERN should be a symbol, a variable. The value of this
470 variable gives the regular expression to search for. Note that the
471 regexp must match at the end of the buffer, \"\\'\" is implicitly
474 The ACTION should also be a symbol, but a function. When the
475 corresponding PATTERN matches, the ACTION function is called.")
477 (defconst tramp-actions-copy-out-of-band
478 '((tramp-password-prompt-regexp tramp-action-password
)
479 (tramp-wrong-passwd-regexp tramp-action-permission-denied
)
480 (tramp-copy-failed-regexp tramp-action-permission-denied
)
481 (tramp-process-alive-regexp tramp-action-out-of-band
))
482 "List of pattern/action pairs.
483 This list is used for copying/renaming with out-of-band methods.
485 See `tramp-actions-before-shell' for more info.")
487 (defconst tramp-uudecode
488 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
491 "Shell function to implement `uudecode' to standard output.
492 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
493 for this or `uudecode -p', but some systems don't, and for them
494 we have this shell function.")
496 (defconst tramp-perl-file-truename
499 use Cwd \"realpath\";
502 my ($volume, @dirs) = @_;
503 my $real = realpath(File::Spec->catpath(
504 $volume, File::Spec->catdir(@dirs), \"\"));
506 my ($vol, $dir) = File::Spec->splitpath($real, 1);
507 return ($vol, File::Spec->splitdir($dir));
510 my $last = pop(@dirs);
511 ($volume, @dirs) = recursive($volume, @dirs);
513 return ($volume, @dirs);
517 $result = realpath($ARGV[0]);
519 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
520 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
522 $result = File::Spec->catpath($vol, File::Spec->catdir(@dirs), \"\");
525 if ($ARGV[0] =~ /\\/$/) {
526 $result = $result . \"/\";
529 print \"\\\"$result\\\"\\n\";
530 ' \"$1\" 2>/dev/null"
531 "Perl script to produce output suitable for use with `file-truename'
532 on the remote file system.
533 Escape sequence %s is replaced with name of Perl binary.
534 This string is passed to `format', so percent characters need to be doubled.")
536 (defconst tramp-perl-file-name-all-completions
546 opendir(d, $ARGV[0]) || die(\"$ARGV[0]: $!\\nfail\\n\");
547 @files = readdir(d); closedir(d);
548 foreach $f (@files) {
549 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
550 if (-d \"$ARGV[0]/$f\") {
559 ' \"$1\" \"$2\" \"$3\" 2>/dev/null"
560 "Perl script to produce output suitable for use with
561 `file-name-all-completions' on the remote file system. Escape
562 sequence %s is replaced with name of Perl binary. This string is
563 passed to `format', so percent characters need to be doubled.")
565 ;; Perl script to implement `file-attributes' in a Lisp `read'able
566 ;; output. If you are hacking on this, note that you get *no* output
567 ;; unless this spits out a complete line, including the '\n' at the
569 ;; The device number is returned as "-1", because there will be a virtual
570 ;; device number set in `tramp-sh-handle-file-attributes'.
571 (defconst tramp-perl-file-attributes
573 @stat = lstat($ARGV[0]);
578 if (($stat[2] & 0170000) == 0120000)
580 $type = readlink($ARGV[0]);
581 $type = \"\\\"$type\\\"\";
583 elsif (($stat[2] & 0170000) == 040000)
591 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
592 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
594 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
599 $stat[8] >> 16 & 0xffff,
601 $stat[9] >> 16 & 0xffff,
603 $stat[10] >> 16 & 0xffff,
607 $stat[1] >> 16 & 0xffff,
609 );' \"$1\" \"$2\" 2>/dev/null"
610 "Perl script to produce output suitable for use with `file-attributes'
611 on the remote file system.
612 Escape sequence %s is replaced with name of Perl binary.
613 This string is passed to `format', so percent characters need to be doubled.")
615 (defconst tramp-perl-directory-files-and-attributes
617 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
618 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
619 @list = readdir(DIR);
623 for($i = 0; $i < $n; $i++)
625 $filename = $list[$i];
626 @stat = lstat($filename);
627 if (($stat[2] & 0170000) == 0120000)
629 $type = readlink($filename);
630 $type = \"\\\"$type\\\"\";
632 elsif (($stat[2] & 0170000) == 040000)
640 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
641 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
643 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
649 $stat[8] >> 16 & 0xffff,
651 $stat[9] >> 16 & 0xffff,
653 $stat[10] >> 16 & 0xffff,
657 $stat[1] >> 16 & 0xffff,
659 $stat[0] >> 16 & 0xffff,
662 printf(\")\\n\");' \"$1\" \"$2\" 2>/dev/null"
663 "Perl script implementing `directory-files-attributes' as Lisp `read'able
665 Escape sequence %s is replaced with name of Perl binary.
666 This string is passed to `format', so percent characters need to be doubled.")
668 ;; These two use base64 encoding.
669 (defconst tramp-perl-encode-with-module
670 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
671 "Perl program to use for encoding a file.
672 Escape sequence %s is replaced with name of Perl binary.
673 This string is passed to `format', so percent characters need to be doubled.
674 This implementation requires the MIME::Base64 Perl module to be installed
675 on the remote host.")
677 (defconst tramp-perl-decode-with-module
678 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
679 "Perl program to use for decoding a file.
680 Escape sequence %s is replaced with name of Perl binary.
681 This string is passed to `format', so percent characters need to be doubled.
682 This implementation requires the MIME::Base64 Perl module to be installed
683 on the remote host.")
685 (defconst tramp-perl-encode
687 # This script contributed by Juanma Barranquero <lektu@terra.es>.
688 # Copyright (C) 2002-2013 Free Software Foundation, Inc.
693 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
694 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
698 # We read in chunks of 54 bytes, to generate output lines
699 # of 72 chars (plus end of line)
700 while (read STDIN, $data, 54) {
703 # Only for the last chunk, and only if did not fill the last three-byte packet
705 my $mod = length($data) %% 3;
706 $pad = q(=) x (3 - $mod) if $mod;
709 # Not the fastest method, but it is simple: unpack to binary string, split
710 # by groups of 6 bits and convert back from binary to byte; then map into
711 # the translation table
715 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
719 "Perl program to use for encoding a file.
720 Escape sequence %s is replaced with name of Perl binary.
721 This string is passed to `format', so percent characters need to be doubled.")
723 (defconst tramp-perl-decode
725 # This script contributed by Juanma Barranquero <lektu@terra.es>.
726 # Copyright (C) 2002-2013 Free Software Foundation, Inc.
731 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
732 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
735 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
739 # We are going to accumulate into $pending to accept any line length
740 # (we do not check they are <= 76 chars as the RFC says)
743 while (my $data = <STDIN>) {
746 # If we find one or two =, we have reached the end and
747 # any following data is to be discarded
748 my $finished = $data =~ s/(==?).*/$1/;
751 my $len = length($pending);
752 my $chunk = substr($pending, 0, $len & ~3);
753 $pending = substr($pending, $len & ~3 + 1);
755 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
756 # split in 8-bit chunks and convert back to char.
759 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
763 "Perl program to use for decoding a file.
764 Escape sequence %s is replaced with name of Perl binary.
765 This string is passed to `format', so percent characters need to be doubled.")
767 (defconst tramp-perl-pack
768 "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
769 "Perl program to use for encoding a file.
770 Escape sequence %s is replaced with name of Perl binary.")
772 (defconst tramp-perl-unpack
773 "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
774 "Perl program to use for decoding a file.
775 Escape sequence %s is replaced with name of Perl binary.")
777 (defconst tramp-vc-registered-read-file-names
780 if %s \"$file\"; then
781 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" t)\"
783 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" nil)\"
785 if %s \"$file\"; then
786 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" t)\"
788 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" nil)\"
792 "Script to check existence of VC related files.
793 It must be send formatted with two strings; the tests for file
794 existence, and file readability. Input shall be read via
795 here-document, otherwise the command could exceed maximum length
798 ;; New handlers should be added here.
799 (defconst tramp-sh-file-name-handler-alist
800 '(;; `access-file' performed by default handler.
801 (add-name-to-file . tramp-sh-handle-add-name-to-file
)
802 ;; `byte-compiler-base-file-name' performed by default handler.
803 (copy-directory . tramp-sh-handle-copy-directory
)
804 (copy-file . tramp-sh-handle-copy-file
)
805 (delete-directory . tramp-sh-handle-delete-directory
)
806 (delete-file . tramp-sh-handle-delete-file
)
807 ;; `diff-latest-backup-file' performed by default handler.
808 (directory-file-name . tramp-handle-directory-file-name
)
809 (directory-files . tramp-handle-directory-files
)
810 (directory-files-and-attributes
811 . tramp-sh-handle-directory-files-and-attributes
)
812 ;; `dired-call-process' performed by default handler.
813 (dired-compress-file . tramp-sh-handle-dired-compress-file
)
814 (dired-recursive-delete-directory
815 . tramp-sh-handle-dired-recursive-delete-directory
)
816 (dired-uncache . tramp-handle-dired-uncache
)
817 (expand-file-name . tramp-sh-handle-expand-file-name
)
818 (file-accessible-directory-p . tramp-handle-file-accessible-directory-p
)
819 (file-acl . tramp-sh-handle-file-acl
)
820 (file-attributes . tramp-sh-handle-file-attributes
)
821 (file-directory-p . tramp-sh-handle-file-directory-p
)
822 ;; `file-equal-p' performed by default handler.
823 (file-executable-p . tramp-sh-handle-file-executable-p
)
824 (file-exists-p . tramp-sh-handle-file-exists-p
)
825 ;; `file-in-directory-p' performed by default handler.
826 (file-local-copy . tramp-sh-handle-file-local-copy
)
827 (file-modes . tramp-handle-file-modes
)
828 (file-name-all-completions . tramp-sh-handle-file-name-all-completions
)
829 (file-name-as-directory . tramp-handle-file-name-as-directory
)
830 (file-name-completion . tramp-handle-file-name-completion
)
831 (file-name-directory . tramp-handle-file-name-directory
)
832 (file-name-nondirectory . tramp-handle-file-name-nondirectory
)
833 ;; `file-name-sans-versions' performed by default handler.
834 (file-newer-than-file-p . tramp-sh-handle-file-newer-than-file-p
)
835 (file-notify-add-watch . tramp-sh-handle-file-notify-add-watch
)
836 (file-notify-rm-watch . tramp-handle-file-notify-rm-watch
)
837 (file-ownership-preserved-p . tramp-sh-handle-file-ownership-preserved-p
)
838 (file-readable-p . tramp-sh-handle-file-readable-p
)
839 (file-regular-p . tramp-handle-file-regular-p
)
840 (file-remote-p . tramp-handle-file-remote-p
)
841 (file-selinux-context . tramp-sh-handle-file-selinux-context
)
842 (file-symlink-p . tramp-handle-file-symlink-p
)
843 (file-truename . tramp-sh-handle-file-truename
)
844 (file-writable-p . tramp-sh-handle-file-writable-p
)
845 (find-backup-file-name . tramp-handle-find-backup-file-name
)
846 ;; `find-file-noselect' performed by default handler.
847 ;; `get-file-buffer' performed by default handler.
848 (insert-directory . tramp-sh-handle-insert-directory
)
849 (insert-file-contents . tramp-handle-insert-file-contents
)
850 (insert-file-contents-literally
851 . tramp-sh-handle-insert-file-contents-literally
)
852 (load . tramp-handle-load
)
853 (make-auto-save-file-name . tramp-handle-make-auto-save-file-name
)
854 (make-directory . tramp-sh-handle-make-directory
)
855 (make-symbolic-link . tramp-sh-handle-make-symbolic-link
)
856 (process-file . tramp-sh-handle-process-file
)
857 (rename-file . tramp-sh-handle-rename-file
)
858 (set-file-acl . tramp-sh-handle-set-file-acl
)
859 (set-file-modes . tramp-sh-handle-set-file-modes
)
860 (set-file-selinux-context . tramp-sh-handle-set-file-selinux-context
)
861 (set-file-times . tramp-sh-handle-set-file-times
)
862 (set-visited-file-modtime . tramp-sh-handle-set-visited-file-modtime
)
863 (shell-command . tramp-handle-shell-command
)
864 (start-file-process . tramp-sh-handle-start-file-process
)
865 (substitute-in-file-name . tramp-handle-substitute-in-file-name
)
866 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory
)
867 (vc-registered . tramp-sh-handle-vc-registered
)
868 (verify-visited-file-modtime . tramp-sh-handle-verify-visited-file-modtime
)
869 (write-region . tramp-sh-handle-write-region
))
870 "Alist of handler functions.
871 Operations not mentioned here will be handled by the normal Emacs functions.")
873 ;; This must be the last entry, because `identity' always matches.
875 (add-to-list 'tramp-foreign-file-name-handler-alist
876 '(identity . tramp-sh-file-name-handler
) 'append
)
878 ;;; File Name Handler Functions:
880 (defun tramp-sh-handle-make-symbolic-link
881 (filename linkname
&optional ok-if-already-exists
)
882 "Like `make-symbolic-link' for Tramp files.
883 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
884 the symlink. If LINKNAME is a Tramp file, only the localname component is
885 used as the target of the symlink.
887 If LINKNAME is a Tramp file and the localname component is relative, then
888 it is expanded first, before the localname component is taken. Note that
889 this can give surprising results if the user/host for the source and
890 target of the symlink differ."
891 (with-parsed-tramp-file-name linkname l
892 (let ((ln (tramp-get-remote-ln l
))
893 (cwd (tramp-run-real-handler
894 'file-name-directory
(list l-localname
))))
898 "Making a symbolic link. ln(1) does not exist on the remote host."))
900 ;; Do the 'confirm if exists' thing.
901 (when (file-exists-p linkname
)
903 (if (or (null ok-if-already-exists
) ; not allowed to exist
904 (and (numberp ok-if-already-exists
)
907 "File %s already exists; make it a link anyway? "
910 l
'file-already-exists
"File %s already exists" l-localname
)
911 (delete-file linkname
)))
913 ;; If FILENAME is a Tramp name, use just the localname component.
914 (when (tramp-tramp-file-p filename
)
916 (tramp-file-name-localname
917 (tramp-dissect-file-name (expand-file-name filename
)))))
919 (tramp-flush-file-property l
(file-name-directory l-localname
))
920 (tramp-flush-file-property l l-localname
)
922 ;; Right, they are on the same host, regardless of user, method,
923 ;; etc. We now make the link on the remote machine. This will
924 ;; occur as the user that FILENAME belongs to.
925 (tramp-send-command-and-check
928 "cd %s && %s -sf %s %s"
929 (tramp-shell-quote-argument cwd
)
931 (tramp-shell-quote-argument filename
)
932 (tramp-shell-quote-argument l-localname
))
935 (defun tramp-sh-handle-file-truename (filename)
936 "Like `file-truename' for Tramp files."
937 (with-parsed-tramp-file-name (expand-file-name filename
) nil
938 (tramp-make-tramp-file-name method user host
939 (with-tramp-file-property v localname
"file-truename"
940 (let ((result nil
)) ; result steps in reverse order
941 (tramp-message v
4 "Finding true name for `%s'" filename
)
943 ;; Use GNU readlink --canonicalize-missing where available.
944 ((tramp-get-remote-readlink v
)
946 (tramp-send-command-and-read
948 (format "echo \"\\\"`%s --canonicalize-missing %s`\\\"\""
949 (tramp-get-remote-readlink v
)
950 (tramp-shell-quote-argument localname
)))))
952 ;; Use Perl implementation.
953 ((and (tramp-get-remote-perl v
)
954 (tramp-get-connection-property v
"perl-file-spec" nil
)
955 (tramp-get-connection-property v
"perl-cwd-realpath" nil
))
956 (tramp-maybe-send-script
957 v tramp-perl-file-truename
"tramp_perl_file_truename")
959 (tramp-send-command-and-read
961 (format "tramp_perl_file_truename %s"
962 (tramp-shell-quote-argument localname
)))))
964 ;; Do it yourself. We bind `directory-sep-char' here for
965 ;; XEmacs on Windows, which would otherwise use backslash.
966 (t (let* ((directory-sep-char ?
/)
967 (steps (tramp-compat-split-string localname
"/"))
968 (localnamedir (tramp-run-real-handler
969 'file-name-as-directory
(list localname
)))
970 (is-dir (string= localname localnamedir
))
973 ;; Don't make the following value larger than
974 ;; necessary. People expect an error message in
975 ;; a timely fashion when something is wrong;
976 ;; otherwise they might think that Emacs is hung.
977 ;; Of course, correctness has to come first.
980 (while (and steps
(< numchase numchase-limit
))
981 (setq thisstep
(pop steps
))
985 (append '("") (reverse result
) (list thisstep
))
988 (nth 0 (file-attributes
989 (tramp-make-tramp-file-name
996 (cond ((string= "." thisstep
)
997 (tramp-message v
5 "Ignoring step `.'"))
998 ((string= ".." thisstep
)
999 (tramp-message v
5 "Processing step `..'")
1001 ((stringp symlink-target
)
1002 ;; It's a symlink, follow it.
1004 v
5 "Follow symlink to %s" symlink-target
)
1005 (setq numchase
(1+ numchase
))
1006 (when (file-name-absolute-p symlink-target
)
1008 ;; If the symlink was absolute, we'll get a
1009 ;; string like "/user@host:/some/target";
1010 ;; extract the "/some/target" part from it.
1011 (when (tramp-tramp-file-p symlink-target
)
1012 (unless (tramp-equal-remote filename symlink-target
)
1015 "Symlink target `%s' on wrong host"
1017 (setq symlink-target localname
))
1019 (append (tramp-compat-split-string
1024 (setq result
(cons thisstep result
)))))
1025 (when (>= numchase numchase-limit
)
1028 "Maximum number (%d) of symlinks exceeded" numchase-limit
))
1029 (setq result
(reverse result
))
1030 ;; Combine list to form string.
1033 (mapconcat 'identity
(cons "" result
) "/")
1036 (or (string= "" result
)
1037 (not (string= (substring result -
1) "/"))))
1038 (setq result
(concat result
"/"))))))
1040 (tramp-message v
4 "True name of `%s' is `%s'" localname result
)
1045 (defun tramp-sh-handle-file-exists-p (filename)
1046 "Like `file-exists-p' for Tramp files."
1047 (with-parsed-tramp-file-name filename nil
1048 (with-tramp-file-property v localname
"file-exists-p"
1049 (or (not (null (tramp-get-file-property
1050 v localname
"file-attributes-integer" nil
)))
1051 (not (null (tramp-get-file-property
1052 v localname
"file-attributes-string" nil
)))
1053 (tramp-send-command-and-check
1057 (tramp-get-file-exists-command v
)
1058 (tramp-shell-quote-argument localname
)))))))
1060 (defun tramp-sh-handle-file-attributes (filename &optional id-format
)
1061 "Like `file-attributes' for Tramp files."
1062 (unless id-format
(setq id-format
'integer
))
1063 ;; Don't modify `last-coding-system-used' by accident.
1064 (let ((last-coding-system-used last-coding-system-used
))
1065 (with-parsed-tramp-file-name (expand-file-name filename
) nil
1066 (with-tramp-file-property
1067 v localname
(format "file-attributes-%s" id-format
)
1069 (tramp-convert-file-attributes
1073 ((tramp-get-remote-stat v
)
1074 (tramp-do-file-attributes-with-stat v localname id-format
))
1075 ((tramp-get-remote-perl v
)
1076 (tramp-do-file-attributes-with-perl v localname id-format
))
1078 ;; The scripts could fail, for example with huge file size.
1079 (tramp-do-file-attributes-with-ls v localname id-format
))))))))
1081 (defun tramp-do-file-attributes-with-ls (vec localname
&optional id-format
)
1082 "Implement `file-attributes' for Tramp files using the ls(1) command."
1084 res-inode res-filemodes res-numlinks
1085 res-uid res-gid res-size res-symlink-target
)
1086 (tramp-message vec
5 "file attributes with ls: %s" localname
)
1089 (format "(%s %s || %s -h %s) && %s %s %s"
1090 (tramp-get-file-exists-command vec
)
1091 (tramp-shell-quote-argument localname
)
1092 (tramp-get-test-command vec
)
1093 (tramp-shell-quote-argument localname
)
1094 (tramp-get-ls-command vec
)
1095 (if (eq id-format
'integer
) "-ildn" "-ild")
1096 (tramp-shell-quote-argument localname
)))
1097 ;; parse `ls -l' output ...
1098 (with-current-buffer (tramp-get-buffer vec
)
1099 (when (> (buffer-size) 0)
1100 (goto-char (point-min))
1104 (read (current-buffer))
1105 (invalid-read-syntax
1106 (when (and (equal (cadr err
)
1107 "Integer constant overflow in reader")
1109 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
1111 (let* ((big (read (substring (car (cddr err
)) 0
1112 (match-beginning 1))))
1113 (small (read (match-string 1 (car (cddr err
)))))
1114 (twiddle (/ small
65536)))
1115 (cons (+ big twiddle
)
1116 (- small
(* twiddle
65536))))))))
1117 ;; ... file mode flags
1118 (setq res-filemodes
(symbol-name (read (current-buffer))))
1120 (setq res-numlinks
(read (current-buffer)))
1122 (setq res-uid
(read (current-buffer)))
1123 (setq res-gid
(read (current-buffer)))
1124 (if (eq id-format
'integer
)
1126 (unless (numberp res-uid
) (setq res-uid -
1))
1127 (unless (numberp res-gid
) (setq res-gid -
1)))
1129 (unless (stringp res-uid
) (setq res-uid
(symbol-name res-uid
)))
1130 (unless (stringp res-gid
) (setq res-gid
(symbol-name res-gid
)))))
1132 (setq res-size
(read (current-buffer)))
1133 ;; From the file modes, figure out other stuff.
1134 (setq symlinkp
(eq ?l
(aref res-filemodes
0)))
1135 (setq dirp
(eq ?d
(aref res-filemodes
0)))
1136 ;; if symlink, find out file name pointed to
1138 (search-forward "-> ")
1139 (setq res-symlink-target
(buffer-substring (point) (point-at-eol))))
1140 ;; return data gathered
1142 ;; 0. t for directory, string (name linked to) for symbolic
1144 (or dirp res-symlink-target
)
1145 ;; 1. Number of links to file.
1151 ;; 4. Last access time, as a list of integers. Normally this
1152 ;; would be in the same format as `current-time', but the
1153 ;; subseconds part is not currently implemented, and (0 0)
1154 ;; denotes an unknown time.
1155 ;; 5. Last modification time, likewise.
1156 ;; 6. Last status change time, likewise.
1157 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
1158 ;; 7. Size in bytes (-1, if number is out of range).
1160 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1162 ;; 9. t if file's gid would change if file were deleted and
1163 ;; recreated. Will be set in `tramp-convert-file-attributes'
1165 ;; 10. inode number.
1167 ;; 11. Device number. Will be replaced by a virtual device number.
1171 (defun tramp-do-file-attributes-with-perl
1172 (vec localname
&optional id-format
)
1173 "Implement `file-attributes' for Tramp files using a Perl script."
1174 (tramp-message vec
5 "file attributes with perl: %s" localname
)
1175 (tramp-maybe-send-script
1176 vec tramp-perl-file-attributes
"tramp_perl_file_attributes")
1177 (tramp-send-command-and-read
1179 (format "tramp_perl_file_attributes %s %s"
1180 (tramp-shell-quote-argument localname
) id-format
)))
1182 (defun tramp-do-file-attributes-with-stat
1183 (vec localname
&optional id-format
)
1184 "Implement `file-attributes' for Tramp files using stat(1) command."
1185 (tramp-message vec
5 "file attributes with stat: %s" localname
)
1186 (tramp-send-command-and-read
1189 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1190 ;; parse correctly the sequence "((". Therefore, we add a space.
1191 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1192 (tramp-get-file-exists-command vec
)
1193 (tramp-shell-quote-argument localname
)
1194 (tramp-get-test-command vec
)
1195 (tramp-shell-quote-argument localname
)
1196 (tramp-get-remote-stat vec
)
1197 (if (eq id-format
'integer
) "%ue0" "\"%U\"")
1198 (if (eq id-format
'integer
) "%ge0" "\"%G\"")
1199 (tramp-shell-quote-argument localname
))))
1201 (defun tramp-sh-handle-set-visited-file-modtime (&optional time-list
)
1202 "Like `set-visited-file-modtime' for Tramp files."
1203 (unless (buffer-file-name)
1204 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
1207 (tramp-run-real-handler 'set-visited-file-modtime
(list time-list
))
1208 (let ((f (buffer-file-name))
1210 (with-parsed-tramp-file-name f nil
1211 (let* ((remote-file-name-inhibit-cache t
)
1212 (attr (file-attributes f
))
1213 ;; '(-1 65535) means file doesn't exists yet.
1214 (modtime (or (nth 5 attr
) '(-1 65535))))
1215 (when (boundp 'last-coding-system-used
)
1216 (setq coding-system-used
(symbol-value 'last-coding-system-used
)))
1217 ;; We use '(0 0) as a don't-know value. See also
1218 ;; `tramp-do-file-attributes-with-ls'.
1219 (if (not (equal modtime
'(0 0)))
1220 (tramp-run-real-handler 'set-visited-file-modtime
(list modtime
))
1224 (format "%s -ild %s"
1225 (tramp-get-ls-command v
)
1226 (tramp-shell-quote-argument localname
)))
1227 (setq attr
(buffer-substring (point)
1228 (progn (end-of-line) (point)))))
1229 (tramp-set-file-property
1230 v localname
"visited-file-modtime-ild" attr
))
1231 (when (boundp 'last-coding-system-used
)
1232 (set 'last-coding-system-used coding-system-used
))
1235 ;; This function makes the same assumption as
1236 ;; `tramp-sh-handle-set-visited-file-modtime'.
1237 (defun tramp-sh-handle-verify-visited-file-modtime (&optional buf
)
1238 "Like `verify-visited-file-modtime' for Tramp files.
1239 At the time `verify-visited-file-modtime' calls this function, we
1240 already know that the buffer is visiting a file and that
1241 `visited-file-modtime' does not return 0. Do not call this
1242 function directly, unless those two cases are already taken care
1244 (with-current-buffer (or buf
(current-buffer))
1245 (let ((f (buffer-file-name)))
1246 ;; There is no file visiting the buffer, or the buffer has no
1247 ;; recorded last modification time, or there is no established
1250 (eq (visited-file-modtime) 0)
1251 (not (tramp-file-name-handler 'file-remote-p f nil
'connected
)))
1253 (with-parsed-tramp-file-name f nil
1254 (let* ((remote-file-name-inhibit-cache t
)
1255 (attr (file-attributes f
))
1256 (modtime (nth 5 attr
))
1257 (mt (visited-file-modtime)))
1260 ;; File exists, and has a known modtime.
1261 ((and attr
(not (equal modtime
'(0 0))))
1262 (< (abs (tramp-time-diff
1264 ;; For compatibility, deal with both the old
1265 ;; (HIGH . LOW) and the new (HIGH LOW) return
1266 ;; values of `visited-file-modtime'.
1268 (list (car mt
) (cdr mt
))
1271 ;; Modtime has the don't know value.
1275 (format "%s -ild %s"
1276 (tramp-get-ls-command v
)
1277 (tramp-shell-quote-argument localname
)))
1278 (with-current-buffer (tramp-get-buffer v
)
1279 (setq attr
(buffer-substring
1280 (point) (progn (end-of-line) (point)))))
1283 (tramp-get-file-property
1284 v localname
"visited-file-modtime-ild" "")))
1285 ;; If file does not exist, say it is not modified if and
1286 ;; only if that agrees with the buffer's record.
1287 (t (equal mt
'(-1 65535))))))))))
1289 (defun tramp-sh-handle-set-file-modes (filename mode
)
1290 "Like `set-file-modes' for Tramp files."
1291 (with-parsed-tramp-file-name filename nil
1292 (tramp-flush-file-property v localname
)
1293 ;; FIXME: extract the proper text from chmod's stderr.
1294 (tramp-barf-unless-okay
1296 (format "chmod %s %s"
1297 (tramp-compat-decimal-to-octal mode
)
1298 (tramp-shell-quote-argument localname
))
1299 "Error while changing file's mode %s" filename
)))
1301 (defun tramp-sh-handle-set-file-times (filename &optional time
)
1302 "Like `set-file-times' for Tramp files."
1303 (if (file-remote-p filename
)
1304 (with-parsed-tramp-file-name filename nil
1305 (tramp-flush-file-property v localname
)
1306 (let ((time (if (or (null time
) (equal time
'(0 0)))
1309 ;; With GNU Emacs, `format-time-string' has an optional
1310 ;; parameter UNIVERSAL. This is preferred, because we
1311 ;; could handle the case when the remote host is located
1312 ;; in a different time zone as the local host.
1313 (utc (not (featurep 'xemacs
))))
1314 (tramp-send-command-and-check
1315 v
(format "%s touch -t %s %s"
1316 (if utc
"env TZ=UTC" "")
1318 (format-time-string "%Y%m%d%H%M.%S" time t
)
1319 (format-time-string "%Y%m%d%H%M.%S" time
))
1320 (tramp-shell-quote-argument localname
)))))
1322 ;; We handle also the local part, because in older Emacsen,
1323 ;; without `set-file-times', this function is an alias for this.
1324 ;; We are local, so we don't need the UTC settings.
1327 "touch" nil nil nil
"-t"
1328 (format-time-string "%Y%m%d%H%M.%S" time
)
1329 (tramp-shell-quote-argument filename
)))))
1331 (defun tramp-set-file-uid-gid (filename &optional uid gid
)
1332 "Set the ownership for FILENAME.
1333 If UID and GID are provided, these values are used; otherwise uid
1334 and gid of the corresponding user is taken. Both parameters must
1335 be non-negative integers."
1336 ;; Modern Unices allow chown only for root. So we might need
1337 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1338 ;; working with su(do)? when it is needed, so it shall succeed in
1339 ;; the majority of cases.
1340 ;; Don't modify `last-coding-system-used' by accident.
1341 (let ((last-coding-system-used last-coding-system-used
))
1342 (if (file-remote-p filename
)
1343 (with-parsed-tramp-file-name filename nil
1344 (if (and (zerop (user-uid)) (tramp-local-host-p v
))
1345 ;; If we are root on the local host, we can do it directly.
1346 (tramp-set-file-uid-gid localname uid gid
)
1347 (let ((uid (or (and (natnump uid
) uid
)
1348 (tramp-get-remote-uid v
'integer
)))
1349 (gid (or (and (natnump gid
) gid
)
1350 (tramp-get-remote-gid v
'integer
))))
1353 "chown %d:%d %s" uid gid
1354 (tramp-shell-quote-argument localname
))))))
1356 ;; We handle also the local part, because there doesn't exist
1357 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1358 (let ((uid (or (and (natnump uid
) uid
) (tramp-get-local-uid 'integer
)))
1359 (gid (or (and (natnump gid
) gid
) (tramp-get-local-gid 'integer
))))
1362 (format "%d:%d" uid gid
) (tramp-shell-quote-argument filename
))))))
1364 (defun tramp-remote-selinux-p (vec)
1365 "Check, whether SELINUX is enabled on the remote host."
1366 (with-tramp-connection-property
1367 (tramp-get-connection-process vec
) "selinux-p"
1368 (let ((result (tramp-find-executable
1369 vec
"getenforce" (tramp-get-remote-path vec
) t t
)))
1372 (tramp-send-command-and-read
1373 vec
(format "echo \\\"`%S`\\\"" result
))
1376 (defun tramp-sh-handle-file-selinux-context (filename)
1377 "Like `file-selinux-context' for Tramp files."
1378 (with-parsed-tramp-file-name filename nil
1379 (with-tramp-file-property v localname
"file-selinux-context"
1380 (let ((context '(nil nil nil nil
))
1381 (regexp (concat "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\):"
1382 "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\)")))
1383 (when (and (tramp-remote-selinux-p v
)
1384 (tramp-send-command-and-check
1387 (tramp-get-ls-command v
)
1388 (tramp-shell-quote-argument localname
))))
1389 (with-current-buffer (tramp-get-connection-buffer v
)
1390 (goto-char (point-min))
1391 (when (re-search-forward regexp
(point-at-eol) t
)
1392 (setq context
(list (match-string 1) (match-string 2)
1393 (match-string 3) (match-string 4))))))
1394 ;; Return the context.
1397 (defun tramp-sh-handle-set-file-selinux-context (filename context
)
1398 "Like `set-file-selinux-context' for Tramp files."
1399 (with-parsed-tramp-file-name filename nil
1400 (if (and (consp context
)
1401 (tramp-remote-selinux-p v
)
1402 (tramp-send-command-and-check
1403 v
(format "chcon %s %s %s %s %s"
1404 (if (stringp (nth 0 context
))
1405 (format "--user=%s" (nth 0 context
)) "")
1406 (if (stringp (nth 1 context
))
1407 (format "--role=%s" (nth 1 context
)) "")
1408 (if (stringp (nth 2 context
))
1409 (format "--type=%s" (nth 2 context
)) "")
1410 (if (stringp (nth 3 context
))
1411 (format "--range=%s" (nth 3 context
)) "")
1412 (tramp-shell-quote-argument localname
))))
1414 (tramp-set-file-property v localname
"file-selinux-context" context
)
1416 (tramp-set-file-property v localname
"file-selinux-context" 'undef
)
1419 (defun tramp-remote-acl-p (vec)
1420 "Check, whether ACL is enabled on the remote host."
1421 (with-tramp-connection-property (tramp-get-connection-process vec
) "acl-p"
1422 (tramp-send-command-and-check vec
"getfacl /")))
1424 (defun tramp-sh-handle-file-acl (filename)
1425 "Like `file-acl' for Tramp files."
1426 (with-parsed-tramp-file-name filename nil
1427 (with-tramp-file-property v localname
"file-acl"
1428 (when (and (tramp-remote-acl-p v
)
1429 (tramp-send-command-and-check
1431 "getfacl -ac %s 2>/dev/null"
1432 (tramp-shell-quote-argument localname
))))
1433 (with-current-buffer (tramp-get-connection-buffer v
)
1434 (goto-char (point-max))
1435 (delete-blank-lines)
1436 (when (> (point-max) (point-min))
1437 (tramp-compat-funcall
1438 'substring-no-properties
(buffer-string))))))))
1440 (defun tramp-sh-handle-set-file-acl (filename acl-string
)
1441 "Like `set-file-acl' for Tramp files."
1442 (with-parsed-tramp-file-name (expand-file-name filename
) nil
1443 (if (and (stringp acl-string
) (tramp-remote-acl-p v
)
1446 v
(format "setfacl --set-file=- %s <<'EOF'\n%s\nEOF\n"
1447 (tramp-shell-quote-argument localname
) acl-string
))
1448 (tramp-send-command-and-check v nil
)))
1451 (tramp-set-file-property v localname
"file-acl" acl-string
)
1453 ;; In case of errors, we return `nil'.
1454 (tramp-set-file-property v localname
"file-acl-string" 'undef
)
1457 ;; Simple functions using the `test' command.
1459 (defun tramp-sh-handle-file-executable-p (filename)
1460 "Like `file-executable-p' for Tramp files."
1461 (with-parsed-tramp-file-name filename nil
1462 (with-tramp-file-property v localname
"file-executable-p"
1463 ;; Examine `file-attributes' cache to see if request can be
1464 ;; satisfied without remote operation.
1465 (or (tramp-check-cached-permissions v ?x
)
1466 (tramp-run-test "-x" filename
)))))
1468 (defun tramp-sh-handle-file-readable-p (filename)
1469 "Like `file-readable-p' for Tramp files."
1470 (with-parsed-tramp-file-name filename nil
1471 (with-tramp-file-property v localname
"file-readable-p"
1472 ;; Examine `file-attributes' cache to see if request can be
1473 ;; satisfied without remote operation.
1474 (or (tramp-check-cached-permissions v ?r
)
1475 (tramp-run-test "-r" filename
)))))
1477 ;; When the remote shell is started, it looks for a shell which groks
1478 ;; tilde expansion. Here, we assume that all shells which grok tilde
1479 ;; expansion will also provide a `test' command which groks `-nt' (for
1480 ;; newer than). If this breaks, tell me about it and I'll try to do
1481 ;; something smarter about it.
1482 (defun tramp-sh-handle-file-newer-than-file-p (file1 file2
)
1483 "Like `file-newer-than-file-p' for Tramp files."
1484 (cond ((not (file-exists-p file1
))
1486 ((not (file-exists-p file2
))
1488 ;; We are sure both files exist at this point.
1491 ;; We try to get the mtime of both files. If they are not
1492 ;; equal to the "dont-know" value, then we subtract the times
1493 ;; and obtain the result.
1494 (let ((fa1 (file-attributes file1
))
1495 (fa2 (file-attributes file2
)))
1496 (if (and (not (equal (nth 5 fa1
) '(0 0)))
1497 (not (equal (nth 5 fa2
) '(0 0))))
1498 (> 0 (tramp-time-diff (nth 5 fa2
) (nth 5 fa1
)))
1499 ;; If one of them is the dont-know value, then we can
1500 ;; still try to run a shell command on the remote host.
1501 ;; However, this only works if both files are Tramp
1502 ;; files and both have the same method, same user, same
1504 (unless (tramp-equal-remote file1 file2
)
1505 (with-parsed-tramp-file-name
1506 (if (tramp-tramp-file-p file1
) file1 file2
) nil
1509 "Files %s and %s must have same method, user, host"
1511 (with-parsed-tramp-file-name file1 nil
1513 (tramp-get-test-nt-command v
) file1 file2
))))))))
1515 ;; Functions implemented using the basic functions above.
1517 (defun tramp-sh-handle-file-directory-p (filename)
1518 "Like `file-directory-p' for Tramp files."
1519 (with-parsed-tramp-file-name filename nil
1520 ;; `file-directory-p' is used as predicate for filename completion.
1521 ;; Sometimes, when a connection is not established yet, it is
1522 ;; desirable to return t immediately for "/method:foo:". It can
1523 ;; be expected that this is always a directory.
1524 (or (zerop (length localname
))
1525 (with-tramp-file-property v localname
"file-directory-p"
1526 (tramp-run-test "-d" filename
)))))
1528 (defun tramp-sh-handle-file-writable-p (filename)
1529 "Like `file-writable-p' for Tramp files."
1530 (with-parsed-tramp-file-name filename nil
1531 (with-tramp-file-property v localname
"file-writable-p"
1532 (if (file-exists-p filename
)
1533 ;; Examine `file-attributes' cache to see if request can be
1534 ;; satisfied without remote operation.
1535 (or (tramp-check-cached-permissions v ?w
)
1536 (tramp-run-test "-w" filename
))
1537 ;; If file doesn't exist, check if directory is writable.
1538 (and (tramp-run-test "-d" (file-name-directory filename
))
1539 (tramp-run-test "-w" (file-name-directory filename
)))))))
1541 (defun tramp-sh-handle-file-ownership-preserved-p (filename &optional group
)
1542 "Like `file-ownership-preserved-p' for Tramp files."
1543 (with-parsed-tramp-file-name filename nil
1544 (with-tramp-file-property v localname
"file-ownership-preserved-p"
1545 (let ((attributes (file-attributes filename
)))
1546 ;; Return t if the file doesn't exist, since it's true that no
1547 ;; information would be lost by an (attempted) delete and create.
1548 (or (null attributes
)
1550 (= (nth 2 attributes
) (tramp-get-remote-uid v
'integer
))
1552 (= (nth 3 attributes
) (tramp-get-remote-gid v
'integer
)))))))))
1554 ;; Directory listings.
1556 (defun tramp-sh-handle-directory-files-and-attributes
1557 (directory &optional full match nosort id-format
)
1558 "Like `directory-files-and-attributes' for Tramp files."
1559 (unless id-format
(setq id-format
'integer
))
1560 (when (file-directory-p directory
)
1561 (setq directory
(expand-file-name directory
))
1564 (with-parsed-tramp-file-name directory nil
1565 (with-tramp-file-property
1567 (format "directory-files-and-attributes-%s" id-format
)
1572 (tramp-convert-file-attributes v
(cdr x
))))
1574 ((tramp-get-remote-stat v
)
1575 (tramp-do-directory-files-and-attributes-with-stat
1576 v localname id-format
))
1577 ((tramp-get-remote-perl v
)
1578 (tramp-do-directory-files-and-attributes-with-perl
1579 v localname id-format
)))))))))
1583 (setq item
(pop temp
))
1584 (when (or (null match
) (string-match match
(car item
)))
1586 (setcar item
(expand-file-name (car item
) directory
)))
1587 (push item result
)))
1591 (sort result
(lambda (x y
) (string< (car x
) (car y
))))))))
1593 (defun tramp-do-directory-files-and-attributes-with-perl
1594 (vec localname
&optional id-format
)
1595 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1596 (tramp-message vec
5 "directory-files-and-attributes with perl: %s" localname
)
1597 (tramp-maybe-send-script
1598 vec tramp-perl-directory-files-and-attributes
1599 "tramp_perl_directory_files_and_attributes")
1601 (tramp-send-command-and-read
1603 (format "tramp_perl_directory_files_and_attributes %s %s"
1604 (tramp-shell-quote-argument localname
) id-format
))))
1605 (when (stringp object
) (tramp-error vec
'file-error object
))
1608 (defun tramp-do-directory-files-and-attributes-with-stat
1609 (vec localname
&optional id-format
)
1610 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1611 (tramp-message vec
5 "directory-files-and-attributes with stat: %s" localname
)
1612 (tramp-send-command-and-read
1616 ;; We must care about filenames with spaces, or starting with
1617 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1618 ;; but it does not work on all remote systems. Therefore, we
1619 ;; quote the filenames via sed.
1620 "cd %s; echo \"(\"; (%s -a | sed -e s/\\$/\\\"/g -e s/^/\\\"/g | "
1622 "'(\"%%n\" (\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)'"
1623 " 2>/dev/null); echo \")\"")
1624 (tramp-shell-quote-argument localname
)
1625 (tramp-get-ls-command vec
)
1626 (tramp-get-remote-stat vec
)
1627 (if (eq id-format
'integer
) "%ue0" "\"%U\"")
1628 (if (eq id-format
'integer
) "%ge0" "\"%G\""))))
1630 ;; This function should return "foo/" for directories and "bar" for
1632 (defun tramp-sh-handle-file-name-all-completions (filename directory
)
1633 "Like `file-name-all-completions' for Tramp files."
1634 (unless (save-match-data (string-match "/" filename
))
1635 (with-parsed-tramp-file-name (expand-file-name directory
) nil
1642 ;; Try cache entries for filename, filename with last
1643 ;; character removed, filename with last two characters
1644 ;; removed, ..., and finally the empty string - all
1645 ;; concatenated to the local directory name.
1646 (let ((remote-file-name-inhibit-cache
1647 (or remote-file-name-inhibit-cache
1648 tramp-completion-reread-directory-timeout
)))
1650 ;; This is inefficient for very long filenames, pity
1651 ;; `reduce' is not available...
1658 (tramp-get-file-property
1660 (concat localname
(substring filename
0 x
))
1661 "file-name-all-completions"
1663 (when cache-hit
(list cache-hit
))))
1664 ;; We cannot use a length of 0, because file properties
1665 ;; for "foo" and "foo/" are identical.
1666 (tramp-compat-number-sequence (length filename
) 1 -
1)))))
1668 ;; Cache expired or no matching cache entry found so we need
1669 ;; to perform a remote operation.
1671 ;; Get a list of directories and files, including reliably
1672 ;; tagging the directories with a trailing '/'. Because I
1673 ;; rock. --daniel@danann.net
1675 ;; Changed to perform `cd' in the same remote op and only
1676 ;; get entries starting with `filename'. Capture any `cd'
1677 ;; error messages. Ensure any `cd' and `echo' aliases are
1681 (if (tramp-get-remote-perl v
)
1683 (tramp-maybe-send-script
1684 v tramp-perl-file-name-all-completions
1685 "tramp_perl_file_name_all_completions")
1686 (format "tramp_perl_file_name_all_completions %s %s %d"
1687 (tramp-shell-quote-argument localname
)
1688 (tramp-shell-quote-argument filename
)
1690 ;; `read-file-name-completion-ignore-case'
1691 ;; is introduced with Emacs 22.1.
1693 'read-file-name-completion-ignore-case
)
1694 'read-file-name-completion-ignore-case
1695 'completion-ignore-case
))
1699 "(\\cd %s 2>&1 && (%s %s -a 2>/dev/null"
1700 ;; `ls' with wildcard might fail with `Argument
1701 ;; list too long' error in some corner cases; if
1702 ;; `ls' fails after `cd' succeeded, chances are
1703 ;; that's the case, so let's retry without
1704 ;; wildcard. This will return "too many" entries
1705 ;; but that isn't harmful.
1706 " || %s -a 2>/dev/null)"
1707 " | while read f; do"
1708 " if %s -d \"$f\" 2>/dev/null;"
1709 " then \\echo \"$f/\"; else \\echo \"$f\"; fi; done"
1710 " && \\echo ok) || \\echo fail")
1711 (tramp-shell-quote-argument localname
)
1712 (tramp-get-ls-command v
)
1713 ;; When `filename' is empty, just `ls' without
1714 ;; filename argument is more efficient than `ls *'
1715 ;; for very large directories and might avoid the
1716 ;; `Argument list too long' error.
1718 ;; With and only with wildcard, we need to add
1719 ;; `-d' to prevent `ls' from descending into
1721 (if (zerop (length filename
))
1723 (concat (tramp-shell-quote-argument filename
) "* -d"))
1724 (tramp-get-ls-command v
)
1725 (tramp-get-test-command v
))))
1727 ;; Now grab the output.
1728 (with-current-buffer (tramp-get-buffer v
)
1729 (goto-char (point-max))
1731 ;; Check result code, found in last line of output.
1733 (if (looking-at "^fail$")
1735 ;; Grab error message from line before last line
1736 ;; (it was put there by `cd 2>&1').
1740 "tramp-sh-handle-file-name-all-completions: %s"
1741 (buffer-substring (point) (point-at-eol))))
1742 ;; For peace of mind, if buffer doesn't end in `fail'
1743 ;; then it should end in `ok'. If neither are in the
1744 ;; buffer something went seriously wrong on the remote
1746 (unless (looking-at "^ok$")
1750 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1751 (tramp-shell-quote-argument localname
) (buffer-string))))
1753 (while (zerop (forward-line -
1))
1754 (push (buffer-substring (point) (point-at-eol)) result
)))
1756 ;; Because the remote op went through OK we know the
1757 ;; directory we `cd'-ed to exists.
1758 (tramp-set-file-property v localname
"file-exists-p" t
)
1760 ;; Because the remote op went through OK we know every
1761 ;; file listed by `ls' exists.
1762 (mapc (lambda (entry)
1763 (tramp-set-file-property
1764 v
(concat localname entry
) "file-exists-p" t
))
1767 ;; Store result in the cache.
1768 (tramp-set-file-property
1769 v
(concat localname filename
)
1770 "file-name-all-completions" result
))))))))
1774 (defun tramp-sh-handle-add-name-to-file
1775 (filename newname
&optional ok-if-already-exists
)
1776 "Like `add-name-to-file' for Tramp files."
1777 (unless (tramp-equal-remote filename newname
)
1778 (with-parsed-tramp-file-name
1779 (if (tramp-tramp-file-p filename
) filename newname
) nil
1782 "add-name-to-file: %s"
1783 "only implemented for same method, same user, same host")))
1784 (with-parsed-tramp-file-name filename v1
1785 (with-parsed-tramp-file-name newname v2
1786 (let ((ln (when v1
(tramp-get-remote-ln v1
))))
1787 (when (and (not ok-if-already-exists
)
1788 (file-exists-p newname
)
1789 (not (numberp ok-if-already-exists
))
1792 "File %s already exists; make it a new name anyway? "
1796 "add-name-to-file: file %s already exists" newname
))
1797 (tramp-flush-file-property v2
(file-name-directory v2-localname
))
1798 (tramp-flush-file-property v2 v2-localname
)
1799 (tramp-barf-unless-okay
1801 (format "%s %s %s" ln
(tramp-shell-quote-argument v1-localname
)
1802 (tramp-shell-quote-argument v2-localname
))
1803 "error with add-name-to-file, see buffer `%s' for details"
1806 (defun tramp-sh-handle-copy-file
1807 (filename newname
&optional ok-if-already-exists keep-date
1808 preserve-uid-gid preserve-extended-attributes
)
1809 "Like `copy-file' for Tramp files."
1810 (setq filename
(expand-file-name filename
))
1811 (setq newname
(expand-file-name newname
))
1813 ;; At least one file a Tramp file?
1814 ((or (tramp-tramp-file-p filename
)
1815 (tramp-tramp-file-p newname
))
1816 (tramp-do-copy-or-rename-file
1817 'copy filename newname ok-if-already-exists keep-date
1818 preserve-uid-gid preserve-extended-attributes
))
1820 (preserve-extended-attributes
1821 (tramp-run-real-handler
1823 (list filename newname ok-if-already-exists keep-date
1824 preserve-uid-gid preserve-extended-attributes
)))
1826 (tramp-run-real-handler
1828 (list filename newname ok-if-already-exists keep-date preserve-uid-gid
)))
1830 (tramp-run-real-handler
1831 'copy-file
(list filename newname ok-if-already-exists keep-date
)))))
1833 (defun tramp-sh-handle-copy-directory
1834 (dirname newname
&optional keep-date parents _copy-contents
)
1835 "Like `copy-directory' for Tramp files."
1836 (let ((t1 (tramp-tramp-file-p dirname
))
1837 (t2 (tramp-tramp-file-p newname
)))
1838 (with-parsed-tramp-file-name (if t1 dirname newname
) nil
1839 (if (and (tramp-get-method-parameter method
'tramp-copy-recursive
)
1840 ;; When DIRNAME and NEWNAME are remote, they must have
1842 (or (null t1
) (null t2
)
1844 (tramp-file-name-method (tramp-dissect-file-name dirname
))
1845 (tramp-file-name-method (tramp-dissect-file-name newname
)))))
1846 ;; scp or rsync DTRT.
1848 (setq dirname
(directory-file-name (expand-file-name dirname
))
1849 newname
(directory-file-name (expand-file-name newname
)))
1850 (if (and (file-directory-p newname
)
1851 (not (string-equal (file-name-nondirectory dirname
)
1852 (file-name-nondirectory newname
))))
1855 (file-name-nondirectory dirname
) newname
)))
1856 (if (not (file-directory-p (file-name-directory newname
)))
1857 (make-directory (file-name-directory newname
) parents
))
1858 (tramp-do-copy-or-rename-file-out-of-band
1859 'copy dirname newname keep-date
))
1860 ;; We must do it file-wise.
1861 (tramp-run-real-handler
1862 'copy-directory
(list dirname newname keep-date parents
)))
1864 ;; When newname did exist, we have wrong cached values.
1866 (with-parsed-tramp-file-name newname nil
1867 (tramp-flush-file-property v
(file-name-directory localname
))
1868 (tramp-flush-file-property v localname
))))))
1870 (defun tramp-sh-handle-rename-file
1871 (filename newname
&optional ok-if-already-exists
)
1872 "Like `rename-file' for Tramp files."
1873 ;; Check if both files are local -- invoke normal rename-file.
1874 ;; Otherwise, use Tramp from local system.
1875 (setq filename
(expand-file-name filename
))
1876 (setq newname
(expand-file-name newname
))
1877 ;; At least one file a Tramp file?
1878 (if (or (tramp-tramp-file-p filename
)
1879 (tramp-tramp-file-p newname
))
1880 (tramp-do-copy-or-rename-file
1881 'rename filename newname ok-if-already-exists t t
)
1882 (tramp-run-real-handler
1883 'rename-file
(list filename newname ok-if-already-exists
))))
1885 (defun tramp-do-copy-or-rename-file
1886 (op filename newname
&optional ok-if-already-exists keep-date
1887 preserve-uid-gid preserve-extended-attributes
)
1888 "Copy or rename a remote file.
1889 OP must be `copy' or `rename' and indicates the operation to perform.
1890 FILENAME specifies the file to copy or rename, NEWNAME is the name of
1891 the new file (for copy) or the new name of the file (for rename).
1892 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1893 KEEP-DATE means to make sure that NEWNAME has the same timestamp
1894 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1895 the uid and gid if both files are on the same host.
1896 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
1898 This function is invoked by `tramp-sh-handle-copy-file' and
1899 `tramp-sh-handle-rename-file'. It is an error if OP is neither
1900 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1902 (unless (memq op
'(copy rename
))
1903 (error "Unknown operation `%s', must be `copy' or `rename'" op
))
1904 (let ((t1 (tramp-tramp-file-p filename
))
1905 (t2 (tramp-tramp-file-p newname
))
1906 (length (nth 7 (file-attributes (file-truename filename
))))
1907 (attributes (and preserve-extended-attributes
1908 (apply 'file-extended-attributes
(list filename
)))))
1910 (with-parsed-tramp-file-name (if t1 filename newname
) nil
1911 (when (and (not ok-if-already-exists
) (file-exists-p newname
))
1913 v
'file-already-exists
"File %s already exists" newname
))
1915 (with-tramp-progress-reporter
1916 v
0 (format "%s %s to %s"
1917 (if (eq op
'copy
) "Copying" "Renaming")
1921 ;; Both are Tramp files.
1923 (with-parsed-tramp-file-name filename v1
1924 (with-parsed-tramp-file-name newname v2
1926 ;; Shortcut: if method, host, user are the same for
1927 ;; both files, we invoke `cp' or `mv' on the remote
1929 ((tramp-equal-remote filename newname
)
1930 (tramp-do-copy-or-rename-file-directly
1932 ok-if-already-exists keep-date preserve-uid-gid
))
1934 ;; Try out-of-band operation.
1936 (tramp-method-out-of-band-p v1 length
)
1937 (tramp-method-out-of-band-p v2 length
))
1938 (tramp-do-copy-or-rename-file-out-of-band
1939 op filename newname keep-date
))
1941 ;; No shortcut was possible. So we copy the file
1942 ;; first. If the operation was `rename', we go back
1943 ;; and delete the original file (if the copy was
1944 ;; successful). The approach is simple-minded: we
1945 ;; create a new buffer, insert the contents of the
1946 ;; source file into it, then write out the buffer to
1947 ;; the target file. The advantage is that it doesn't
1948 ;; matter which filename handlers are used for the
1949 ;; source and target file.
1951 (tramp-do-copy-or-rename-file-via-buffer
1952 op filename newname keep-date
))))))
1954 ;; One file is a Tramp file, the other one is local.
1957 ;; Fast track on local machine.
1958 ((tramp-local-host-p v
)
1959 (tramp-do-copy-or-rename-file-directly
1961 ok-if-already-exists keep-date preserve-uid-gid
))
1963 ;; If the Tramp file has an out-of-band method, the
1964 ;; corresponding copy-program can be invoked.
1965 ((tramp-method-out-of-band-p v length
)
1966 (tramp-do-copy-or-rename-file-out-of-band
1967 op filename newname keep-date
))
1969 ;; Use the inline method via a Tramp buffer.
1970 (t (tramp-do-copy-or-rename-file-via-buffer
1971 op filename newname keep-date
))))
1974 ;; One of them must be a Tramp file.
1975 (error "Tramp implementation says this cannot happen")))
1977 ;; Handle `preserve-extended-attributes'. We ignore possible
1978 ;; errors, because ACL strings could be incompatible.
1981 (apply 'set-file-extended-attributes
(list newname attributes
))))
1983 ;; In case of `rename', we must flush the cache of the source file.
1984 (when (and t1
(eq op
'rename
))
1985 (with-parsed-tramp-file-name filename v1
1986 (tramp-flush-file-property v1
(file-name-directory localname
))
1987 (tramp-flush-file-property v1 localname
)))
1989 ;; When newname did exist, we have wrong cached values.
1991 (with-parsed-tramp-file-name newname v2
1992 (tramp-flush-file-property v2
(file-name-directory localname
))
1993 (tramp-flush-file-property v2 localname
)))))))
1995 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date
)
1996 "Use an Emacs buffer to copy or rename a file.
1997 First arg OP is either `copy' or `rename' and indicates the operation.
1998 FILENAME is the source file, NEWNAME the target file.
1999 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2001 ;; We must disable multibyte, because binary data shall not be
2003 (set-buffer-multibyte nil
)
2004 (let ((coding-system-for-read 'binary
)
2005 (jka-compr-inhibit t
))
2006 (insert-file-contents-literally filename
))
2007 ;; We don't want the target file to be compressed, so we let-bind
2008 ;; `jka-compr-inhibit' to t.
2009 (let ((coding-system-for-write 'binary
)
2010 (jka-compr-inhibit t
))
2011 (write-region (point-min) (point-max) newname
)))
2012 ;; KEEP-DATE handling.
2013 (when keep-date
(set-file-times newname
(nth 5 (file-attributes filename
))))
2015 (set-file-modes newname
(tramp-default-file-modes filename
))
2016 ;; If the operation was `rename', delete the original file.
2017 (unless (eq op
'copy
) (delete-file filename
)))
2019 (defun tramp-do-copy-or-rename-file-directly
2020 (op filename newname ok-if-already-exists keep-date preserve-uid-gid
)
2021 "Invokes `cp' or `mv' on the remote system.
2022 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2023 respectively. FILENAME specifies the file to copy or rename,
2024 NEWNAME is the name of the new file (for copy) or the new name of
2025 the file (for rename). Both files must reside on the same host.
2026 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2027 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2028 the uid and gid from FILENAME."
2029 (let ((t1 (tramp-tramp-file-p filename
))
2030 (t2 (tramp-tramp-file-p newname
))
2031 (file-times (nth 5 (file-attributes filename
)))
2032 (file-modes (tramp-default-file-modes filename
)))
2033 (with-parsed-tramp-file-name (if t1 filename newname
) nil
2034 (let* ((cmd (cond ((and (eq op
'copy
) preserve-uid-gid
) "cp -f -p")
2035 ((eq op
'copy
) "cp -f")
2036 ((eq op
'rename
) "mv -f")
2039 "Unknown operation `%s', must be `copy' or `rename'"
2043 (tramp-file-name-handler 'file-remote-p filename
'localname
)
2047 (tramp-file-name-handler 'file-remote-p newname
'localname
)
2049 (prefix (file-remote-p (if t1 filename newname
)))
2053 ;; Both files are on a remote host, with same user.
2056 (tramp-send-command-and-check
2057 v
(format "%s %s %s" cmd
2058 (tramp-shell-quote-argument localname1
)
2059 (tramp-shell-quote-argument localname2
))))
2060 (with-current-buffer (tramp-get-buffer v
)
2061 (goto-char (point-min))
2065 ;; Mask cp -f error.
2067 tramp-operation-not-permitted-regexp nil t
))
2069 (tramp-error-with-buffer
2071 "Copying directly failed, see buffer `%s' for details."
2074 ;; We are on the local host.
2077 ;; We can do it directly.
2078 ((let (file-name-handler-alist)
2079 (and (file-readable-p localname1
)
2080 (file-writable-p (file-name-directory localname2
))
2081 (or (file-directory-p localname2
)
2082 (file-writable-p localname2
))))
2084 (tramp-compat-copy-file
2085 localname1 localname2 ok-if-already-exists
2086 keep-date preserve-uid-gid
)
2087 (tramp-run-real-handler
2088 'rename-file
(list localname1 localname2 ok-if-already-exists
))))
2090 ;; We can do it directly with `tramp-send-command'
2091 ((and (file-readable-p (concat prefix localname1
))
2093 (file-name-directory (concat prefix localname2
)))
2094 (or (file-directory-p (concat prefix localname2
))
2095 (file-writable-p (concat prefix localname2
))))
2096 (tramp-do-copy-or-rename-file-directly
2097 op
(concat prefix localname1
) (concat prefix localname2
)
2098 ok-if-already-exists keep-date t
)
2099 ;; We must change the ownership to the local user.
2100 (tramp-set-file-uid-gid
2101 (concat prefix localname2
)
2102 (tramp-get-local-uid 'integer
)
2103 (tramp-get-local-gid 'integer
)))
2105 ;; We need a temporary file in between.
2107 ;; Create the temporary file.
2108 (let ((tmpfile (tramp-compat-make-temp-file localname1
)))
2113 (tramp-barf-unless-okay
2116 (tramp-shell-quote-argument localname1
)
2117 (tramp-shell-quote-argument tmpfile
))
2118 "Copying directly failed, see buffer `%s' for details."
2119 (tramp-get-buffer v
))
2120 ;; We must change the ownership as remote user.
2121 ;; Since this does not work reliable, we also
2122 ;; give read permissions.
2124 (concat prefix tmpfile
)
2125 (tramp-compat-octal-to-decimal "0777"))
2126 (tramp-set-file-uid-gid
2127 (concat prefix tmpfile
)
2128 (tramp-get-local-uid 'integer
)
2129 (tramp-get-local-gid 'integer
)))
2132 (tramp-compat-copy-file
2133 localname1 tmpfile t
2134 keep-date preserve-uid-gid
)
2135 (tramp-run-real-handler
2137 (list localname1 tmpfile t
)))
2138 ;; We must change the ownership as local user.
2139 ;; Since this does not work reliable, we also
2140 ;; give read permissions.
2142 tmpfile
(tramp-compat-octal-to-decimal "0777"))
2143 (tramp-set-file-uid-gid
2145 (tramp-get-remote-uid v
'integer
)
2146 (tramp-get-remote-gid v
'integer
))))
2148 ;; Move the temporary file to its destination.
2151 (tramp-barf-unless-okay
2154 (tramp-shell-quote-argument tmpfile
)
2155 (tramp-shell-quote-argument localname2
))
2156 "Copying directly failed, see buffer `%s' for details."
2157 (tramp-get-buffer v
)))
2159 (tramp-run-real-handler
2161 (list tmpfile localname2 ok-if-already-exists
)))))
2164 (ignore-errors (delete-file tmpfile
)))))))))
2166 ;; Set the time and mode. Mask possible errors.
2169 (set-file-times newname file-times
)
2170 (set-file-modes newname file-modes
))))))
2172 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date
)
2173 "Invoke rcp program to copy.
2174 The method used must be an out-of-band method."
2175 (let* ((t1 (tramp-tramp-file-p filename
))
2176 (t2 (tramp-tramp-file-p newname
))
2177 (orig-vec (tramp-dissect-file-name (if t1 filename newname
)))
2178 copy-program copy-args copy-env copy-keep-date port spec
2179 options source target
)
2181 (with-parsed-tramp-file-name (if t1 filename newname
) nil
2184 ;; Both are Tramp files. We shall optimize it when the
2185 ;; methods for filename and newname are the same.
2186 (let* ((dir-flag (file-directory-p filename
))
2187 (tmpfile (tramp-compat-make-temp-file localname dir-flag
)))
2191 (file-name-nondirectory newname
) tmpfile
)))
2194 (tramp-do-copy-or-rename-file-out-of-band
2195 op filename tmpfile keep-date
)
2196 (tramp-do-copy-or-rename-file-out-of-band
2197 'rename tmpfile newname keep-date
))
2201 (tramp-compat-delete-directory
2202 (expand-file-name ".." tmpfile
) 'recursive
)
2203 (delete-file tmpfile
)))))
2205 ;; Set variables for computing the prompt for reading
2207 (setq tramp-current-method
(tramp-file-name-method v
)
2208 tramp-current-user
(or (tramp-file-name-user v
)
2209 (tramp-get-connection-property
2211 tramp-current-host
(tramp-file-name-real-host v
))
2213 ;; Expand hops. Might be necessary for gateway methods.
2214 (setq v
(car (tramp-compute-multi-hops v
)))
2215 (aset v
3 localname
)
2217 ;; Check which ones of source and target are Tramp files.
2218 (setq source
(if t1
(tramp-make-copy-program-file-name v
) filename
)
2220 (if (and (file-directory-p filename
)
2222 (file-name-nondirectory filename
)
2223 (file-name-nondirectory newname
)))
2224 'file-name-directory
2226 (if t2
(tramp-make-copy-program-file-name v
) newname
)))
2228 ;; Check for host and port number. We cannot use
2229 ;; `tramp-file-name-port', because this returns also
2230 ;; `tramp-default-port', which might clash with settings in
2232 (setq host
(tramp-file-name-host v
)
2234 (when (string-match tramp-host-with-port-regexp host
)
2235 (setq port
(string-to-number (match-string 2 host
))
2236 host
(string-to-number (match-string 1 host
))))
2238 ;; Check for user. There might be an interactive setting.
2239 (setq user
(or (tramp-file-name-user v
)
2240 (tramp-get-connection-property v
"login-as" nil
)))
2242 ;; Compose copy command.
2243 (setq host
(or host
"")
2246 spec
(format-spec-make
2247 ?t
(tramp-get-connection-property
2248 (tramp-get-connection-process v
) "temp-file" ""))
2249 options
(format-spec
2250 (if tramp-use-ssh-controlmaster-options
2251 tramp-ssh-controlmaster-options
"")
2253 spec
(format-spec-make
2254 ?h host ?u user ?p port ?c options
2255 ?k
(if keep-date
" " ""))
2256 copy-program
(tramp-get-method-parameter
2257 method
'tramp-copy-program
)
2258 copy-keep-date
(tramp-get-method-parameter
2259 method
'tramp-copy-keep-date
)
2262 ;; " " has either been a replacement of "%k" (when
2263 ;; keep-date argument is non-nil), or a replacement
2264 ;; for the whole keep-date sublist.
2268 (tramp-get-method-parameter method
'tramp-copy-args
)
2273 (let ((y (mapcar (lambda (z) (format-spec z spec
)) x
)))
2274 (if (member "" y
) '(" ") y
))))))
2280 (setq x
(mapcar (lambda (y) (format-spec y spec
)) x
))
2281 (unless (member "" x
) (mapconcat 'identity x
" ")))
2282 (tramp-get-method-parameter method
'tramp-copy-env
))))
2284 ;; Check for program.
2285 (unless (executable-find copy-program
)
2287 v
'file-error
"Cannot find copy program: %s" copy-program
))
2291 ;; The default directory must be remote.
2292 (let ((default-directory
2293 (file-name-directory (if t1 filename newname
)))
2294 (process-environment (copy-sequence process-environment
)))
2295 ;; Set the transfer process properties.
2296 (tramp-set-connection-property
2297 v
"process-name" (buffer-name (current-buffer)))
2298 (tramp-set-connection-property
2299 v
"process-buffer" (current-buffer))
2302 orig-vec
6 "%s=\"%s\"" (car copy-env
) (cadr copy-env
))
2303 (setenv (pop copy-env
) (pop copy-env
)))
2305 ;; Use an asynchronous process. By this, password can
2306 ;; be handled. The default directory must be local, in
2307 ;; order to apply the correct `copy-program'. We don't
2308 ;; set a timeout, because the copying of large files can
2309 ;; last longer than 60 secs.
2310 (let ((p (let ((default-directory
2311 (tramp-compat-temporary-file-directory)))
2312 (apply 'start-process-shell-command
2313 (tramp-get-connection-name v
)
2314 (tramp-get-connection-buffer v
)
2319 (shell-quote-argument source
)
2320 (shell-quote-argument target
)
2321 "&&" "echo" "tramp_exit_status" "0"
2322 "||" "echo" "tramp_exit_status" "1"))))))
2325 (mapconcat 'identity
(process-command p
) " "))
2326 (tramp-compat-set-process-query-on-exit-flag p nil
)
2327 (tramp-process-actions
2328 p v nil tramp-actions-copy-out-of-band
)
2330 ;; Check the return code.
2331 (goto-char (point-max))
2333 (re-search-backward "tramp_exit_status [0-9]+" nil t
)
2335 orig-vec
'file-error
2336 "Couldn't find exit status of `%s'" (process-command p
)))
2337 (skip-chars-forward "^ ")
2338 (unless (zerop (read (current-buffer)))
2341 orig-vec
'file-error
2342 "Error copying: `%s'"
2343 (buffer-substring (point-min) (point-at-eol))))))
2345 ;; Reset the transfer process properties.
2346 (tramp-message orig-vec
6 "\n%s" (buffer-string))
2347 (tramp-set-connection-property v
"process-name" nil
)
2348 (tramp-set-connection-property v
"process-buffer" nil
)))
2350 ;; Handle KEEP-DATE argument.
2351 (when (and keep-date
(not copy-keep-date
))
2352 (set-file-times newname
(nth 5 (file-attributes filename
))))
2355 (unless (and keep-date copy-keep-date
)
2357 (set-file-modes newname
(tramp-default-file-modes filename
)))))
2359 ;; If the operation was `rename', delete the original file.
2360 (unless (eq op
'copy
)
2361 (if (file-regular-p filename
)
2362 (delete-file filename
)
2363 (tramp-compat-delete-directory filename
'recursive
))))))
2365 (defun tramp-sh-handle-make-directory (dir &optional parents
)
2366 "Like `make-directory' for Tramp files."
2367 (setq dir
(expand-file-name dir
))
2368 (with-parsed-tramp-file-name dir nil
2369 (tramp-flush-directory-property v
(file-name-directory localname
))
2371 (tramp-barf-unless-okay
2373 (if parents
"mkdir -p" "mkdir")
2374 (tramp-shell-quote-argument localname
))
2375 "Couldn't make directory %s" dir
))))
2377 (defun tramp-sh-handle-delete-directory (directory &optional recursive
)
2378 "Like `delete-directory' for Tramp files."
2379 (setq directory
(expand-file-name directory
))
2380 (with-parsed-tramp-file-name directory nil
2381 (tramp-flush-file-property v
(file-name-directory localname
))
2382 (tramp-flush-directory-property v localname
)
2383 (tramp-barf-unless-okay
2385 (if recursive
"rm -rf" "rmdir")
2386 (tramp-shell-quote-argument localname
))
2387 "Couldn't delete %s" directory
)))
2389 (defun tramp-sh-handle-delete-file (filename &optional trash
)
2390 "Like `delete-file' for Tramp files."
2391 (setq filename
(expand-file-name filename
))
2392 (with-parsed-tramp-file-name filename nil
2393 (tramp-flush-file-property v
(file-name-directory localname
))
2394 (tramp-flush-file-property v localname
)
2395 (tramp-barf-unless-okay
2397 (or (and trash
(tramp-get-remote-trash v
)) "rm -f")
2398 (tramp-shell-quote-argument localname
))
2399 "Couldn't delete %s" filename
)))
2403 ;; CCC: This does not seem to be enough. Something dies when
2404 ;; we try and delete two directories under Tramp :/
2405 (defun tramp-sh-handle-dired-recursive-delete-directory (filename)
2406 "Recursively delete the directory given.
2407 This is like `dired-recursive-delete-directory' for Tramp files."
2408 (with-parsed-tramp-file-name filename nil
2409 ;; Run a shell command 'rm -r <localname>'.
2410 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2411 (unless (file-exists-p filename
)
2412 (tramp-error v
'file-error
"No such directory: %s" filename
))
2413 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2416 (format "rm -rf %s" (tramp-shell-quote-argument localname
))
2417 ;; Don't read the output, do it explicitly.
2419 ;; Wait for the remote system to return to us...
2420 ;; This might take a while, allow it plenty of time.
2421 (tramp-wait-for-output (tramp-get-connection-process v
) 120)
2422 ;; Make sure that it worked...
2423 (tramp-flush-file-property v
(file-name-directory localname
))
2424 (tramp-flush-directory-property v localname
)
2425 (and (file-exists-p filename
)
2427 v
'file-error
"Failed to recursively delete %s" filename
))))
2429 (defun tramp-sh-handle-dired-compress-file (file &rest _ok-flag
)
2430 "Like `dired-compress-file' for Tramp files."
2431 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2432 ;; Code stolen mainly from dired-aux.el.
2433 (with-parsed-tramp-file-name file nil
2434 (tramp-flush-file-property v localname
)
2437 (if (not (featurep 'xemacs
))
2439 (symbol-value 'dired-compress-file-suffixes
)
2440 ;; XEmacs has `dired-compression-method-alist', which is
2441 ;; transformed into `dired-compress-file-suffixes' structure.
2444 (list (concat (regexp-quote (nth 1 x
)) "\\'")
2446 (mapconcat 'identity
(nth 3 x
) " ")))
2447 (symbol-value 'dired-compression-method-alist
))))
2449 ;; See if any suffix rule matches this file name.
2451 (let (case-fold-search)
2452 (if (string-match (car (car suffixes
)) localname
)
2453 (setq suffix
(car suffixes
) suffixes nil
))
2454 (setq suffixes
(cdr suffixes
))))
2456 (cond ((file-symlink-p file
)
2458 ((and suffix
(nth 2 suffix
))
2459 ;; We found an uncompression rule.
2460 (with-tramp-progress-reporter
2461 v
0 (format "Uncompressing %s" file
)
2462 (when (tramp-send-command-and-check
2463 v
(concat (nth 2 suffix
) " "
2464 (tramp-shell-quote-argument localname
)))
2465 ;; `dired-remove-file' is not defined in XEmacs.
2466 (tramp-compat-funcall 'dired-remove-file file
)
2467 (string-match (car suffix
) file
)
2468 (concat (substring file
0 (match-beginning 0))))))
2470 ;; We don't recognize the file as compressed, so compress it.
2472 (with-tramp-progress-reporter v
0 (format "Compressing %s" file
)
2473 (when (tramp-send-command-and-check
2474 v
(concat "gzip -f "
2475 (tramp-shell-quote-argument localname
)))
2476 ;; `dired-remove-file' is not defined in XEmacs.
2477 (tramp-compat-funcall 'dired-remove-file file
)
2478 (cond ((file-exists-p (concat file
".gz"))
2479 (concat file
".gz"))
2480 ((file-exists-p (concat file
".z"))
2484 (defun tramp-sh-handle-insert-directory
2485 (filename switches
&optional wildcard full-directory-p
)
2486 "Like `insert-directory' for Tramp files."
2487 (setq filename
(expand-file-name filename
))
2488 (with-parsed-tramp-file-name filename nil
2489 (if (and (featurep 'ls-lisp
)
2490 (not (symbol-value 'ls-lisp-use-insert-directory-program
)))
2491 (tramp-run-real-handler
2492 'insert-directory
(list filename switches wildcard full-directory-p
))
2493 (when (stringp switches
)
2494 (setq switches
(split-string switches
)))
2495 (when (and (member "--dired" switches
)
2496 (not (tramp-get-ls-command-with-dired v
)))
2497 (setq switches
(delete "--dired" switches
)))
2499 (setq wildcard
(tramp-run-real-handler
2500 'file-name-nondirectory
(list localname
)))
2501 (setq localname
(tramp-run-real-handler
2502 'file-name-directory
(list localname
))))
2503 (unless (or full-directory-p
(member "-d" switches
))
2504 (setq switches
(append switches
'("-d"))))
2505 (setq switches
(mapconcat 'tramp-shell-quote-argument switches
" "))
2507 (setq switches
(concat switches
" " wildcard
)))
2509 v
4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
2510 switches filename
(if wildcard
"yes" "no")
2511 (if full-directory-p
"yes" "no"))
2512 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2513 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2514 ;; "--dired" returns byte positions. Therefore, the file names
2515 ;; must be encoded, which is guaranteed by "LC_ALL=en_US.utf8
2517 (if full-directory-p
2520 (format "env LC_ALL=en_US.utf8 LC_CTYPE='' %s %s %s 2>/dev/null"
2521 (tramp-get-ls-command v
)
2525 (tramp-shell-quote-argument (concat localname
".")))))
2526 (tramp-barf-unless-okay
2528 (format "cd %s" (tramp-shell-quote-argument
2529 (tramp-run-real-handler
2530 'file-name-directory
(list localname
))))
2532 (tramp-shell-quote-argument
2533 (tramp-run-real-handler 'file-name-directory
(list localname
))))
2536 (format "env LC_ALL=en_US.utf8 LC_CTYPE='' %s %s %s 2>/dev/null"
2537 (tramp-get-ls-command v
)
2541 (tramp-run-real-handler
2542 'file-name-nondirectory
(list localname
)))))
2544 (tramp-shell-quote-argument
2545 (tramp-run-real-handler
2546 'file-name-nondirectory
(list localname
)))))))
2547 (let ((beg (point)))
2548 ;; We cannot use `insert-buffer-substring' because the Tramp
2549 ;; buffer changes its contents before insertion due to calling
2550 ;; `expand-file' and alike.
2552 (with-current-buffer (tramp-get-buffer v
)
2555 ;; Check for "--dired" output.
2557 (when (looking-at "//SUBDIRED//")
2559 (when (looking-at "//DIRED//\\s-+")
2560 (let ((databeg (match-end 0))
2561 (end (point-at-eol)))
2562 ;; Now read the numeric positions of file names.
2564 (while (< (point) end
)
2565 (let ((start (+ beg
(read (current-buffer))))
2566 (end (+ beg
(read (current-buffer)))))
2567 (if (memq (char-after end
) '(?
\n ?\
))
2568 ;; End is followed by \n or by " -> ".
2569 (put-text-property start end
'dired-filename t
))))))
2570 ;; Remove trailing lines.
2571 (goto-char (point-at-bol))
2572 (while (looking-at "//")
2574 (delete-region (match-beginning 0) (point)))
2576 ;; Some busyboxes are reluctant to discard colors.
2577 (unless (string-match "color" (tramp-get-connection-property v
"ls" ""))
2579 (while (re-search-forward tramp-color-escape-sequence-regexp nil t
)
2580 (replace-match "")))
2582 ;; Decode the output, it could be multibyte.
2583 (decode-coding-region
2585 (or file-name-coding-system
2586 (and (boundp 'default-file-name-coding-system
)
2587 (symbol-value 'default-file-name-coding-system
))))
2589 ;; The inserted file could be from somewhere else.
2590 (when (and (not wildcard
) (not full-directory-p
))
2591 (goto-char (point-max))
2592 (when (file-symlink-p filename
)
2593 (goto-char (search-backward "->" beg
'noerror
)))
2595 (if (zerop (length (file-name-nondirectory filename
)))
2597 (file-name-nondirectory filename
))
2599 (replace-match (file-relative-name filename
) t
))
2601 (goto-char (point-max))))))
2603 ;; Canonicalization of file names.
2605 (defun tramp-sh-handle-expand-file-name (name &optional dir
)
2606 "Like `expand-file-name' for Tramp files.
2607 If the localname part of the given filename starts with \"/../\" then
2608 the result will be a local, non-Tramp, filename."
2609 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2610 (setq dir
(or dir default-directory
"/"))
2611 ;; Unless NAME is absolute, concat DIR and NAME.
2612 (unless (file-name-absolute-p name
)
2613 (setq name
(concat (file-name-as-directory dir
) name
)))
2614 ;; If NAME is not a Tramp file, run the real handler.
2615 (if (not (tramp-connectable-p name
))
2616 (tramp-run-real-handler 'expand-file-name
(list name nil
))
2618 (with-parsed-tramp-file-name name nil
2619 (unless (tramp-run-real-handler 'file-name-absolute-p
(list localname
))
2620 (setq localname
(concat "~/" localname
)))
2621 ;; Tilde expansion if necessary. This needs a shell which
2622 ;; groks tilde expansion! The function `tramp-find-shell' is
2623 ;; supposed to find such a shell on the remote host. Please
2624 ;; tell me about it when this doesn't work on your system.
2625 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname
)
2626 (let ((uname (match-string 1 localname
))
2627 (fname (match-string 2 localname
)))
2628 ;; We cannot simply apply "~/", because under sudo "~/" is
2629 ;; expanded to the local user home directory but to the
2630 ;; root home directory. On the other hand, using always
2631 ;; the default user name for tilde expansion is not
2632 ;; appropriate either, because ssh and companions might
2633 ;; use a user name from the config file.
2634 (when (and (string-equal uname
"~")
2635 (string-match "\\`su\\(do\\)?\\'" method
))
2636 (setq uname
(concat uname user
)))
2638 (with-tramp-connection-property v uname
2640 v
(format "cd %s; pwd" (tramp-shell-quote-argument uname
)))
2641 (with-current-buffer (tramp-get-buffer v
)
2642 (goto-char (point-min))
2643 (buffer-substring (point) (point-at-eol)))))
2644 (setq localname
(concat uname fname
))))
2645 ;; There might be a double slash, for example when "~/"
2646 ;; expands to "/". Remove this.
2647 (while (string-match "//" localname
)
2648 (setq localname
(replace-match "/" t t localname
)))
2649 ;; No tilde characters in file name, do normal
2650 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2651 ;; `directory-sep-char' here for XEmacs on Windows, which would
2652 ;; otherwise use backslash. `default-directory' is bound,
2653 ;; because on Windows there would be problems with UNC shares or
2655 (let ((directory-sep-char ?
/)
2656 (default-directory (tramp-compat-temporary-file-directory)))
2657 (tramp-make-tramp-file-name
2659 (tramp-drop-volume-letter
2660 (tramp-run-real-handler
2661 'expand-file-name
(list localname
)))
2664 ;;; Remote commands:
2666 (defun tramp-process-sentinel (proc event
)
2667 "Flush file caches."
2668 (unless (memq (process-status proc
) '(run open
))
2669 (let ((vec (tramp-get-connection-property proc
"vector" nil
)))
2671 (tramp-message vec
5 "Sentinel called: `%S' `%s'" proc event
)
2672 (tramp-flush-connection-property proc
)
2673 (tramp-flush-directory-property vec
"")))))
2675 ;; We use BUFFER also as connection buffer during setup. Because of
2676 ;; this, its original contents must be saved, and restored once
2677 ;; connection has been setup.
2678 (defun tramp-sh-handle-start-file-process (name buffer program
&rest args
)
2679 "Like `start-file-process' for Tramp files."
2680 (with-parsed-tramp-file-name default-directory nil
2681 ;; When PROGRAM is nil, we just provide a tty.
2683 (when (stringp program
)
2684 (format "cd %s; exec env PS1=%s %s"
2685 (tramp-shell-quote-argument localname
)
2686 ;; Use a human-friendly prompt, for example for `shell'.
2687 (tramp-shell-quote-argument
2689 (file-remote-p default-directory
)
2690 tramp-initial-end-of-output
))
2691 (mapconcat 'tramp-shell-quote-argument
2692 (cons program args
) " "))))
2693 (tramp-process-connection-type
2694 (or (null program
) tramp-process-connection-type
))
2695 (bmp (and (buffer-live-p buffer
) (buffer-modified-p buffer
)))
2698 ;; We do not want to raise an error when
2699 ;; `start-file-process' has been started several time in
2700 ;; `eshell' and friends.
2701 (tramp-current-connection nil
))
2704 ;; BUFFER can be nil. We use a temporary buffer.
2705 (setq buffer
(generate-new-buffer tramp-temp-buffer-name
)))
2706 (while (get-process name1
)
2707 ;; NAME must be unique as process name.
2709 name1
(format "%s<%d>" name i
)))
2711 ;; Set the new process properties.
2712 (tramp-set-connection-property v
"process-name" name
)
2713 (tramp-set-connection-property v
"process-buffer" buffer
)
2715 (with-current-buffer (tramp-get-connection-buffer v
)
2717 ;; We catch this event. Otherwise, `start-process' could
2718 ;; be called on the local host.
2721 ;; Activate narrowing in order to save BUFFER
2722 ;; contents. Clear also the modification time;
2723 ;; otherwise we might be interrupted by
2724 ;; `verify-visited-file-modtime'.
2725 (let ((buffer-undo-list t
)
2726 (buffer-read-only nil
)
2728 (clear-visited-file-modtime)
2729 (narrow-to-region (point-max) (point-max))
2730 ;; We call `tramp-maybe-open-connection', in order
2731 ;; to cleanup the prompt afterwards.
2733 (tramp-maybe-open-connection v
)
2735 (delete-region mark
(point))
2736 (narrow-to-region (point-max) (point-max))
2739 ;; Send the command.
2740 (tramp-send-command v command nil t
) ; nooutput
2741 ;; Check, whether a pty is associated.
2742 (unless (tramp-compat-process-get
2743 (tramp-get-connection-process v
) 'remote-tty
)
2746 "pty association is not supported for `%s'" name
))))
2747 (let ((p (tramp-get-connection-process v
)))
2748 ;; Set query flag and process marker for this
2749 ;; process. We ignore errors, because the process
2750 ;; could have finished already.
2752 (tramp-compat-set-process-query-on-exit-flag p t
)
2753 (set-marker (process-mark p
) (point)))
2758 (if (string-match tramp-temp-buffer-name
(buffer-name))
2760 (set-process-buffer (tramp-get-connection-process v
) nil
)
2761 (kill-buffer (current-buffer)))
2762 (set-buffer-modified-p bmp
))
2763 (tramp-set-connection-property v
"process-name" nil
)
2764 (tramp-set-connection-property v
"process-buffer" nil
))))))
2766 (defun tramp-sh-handle-process-file
2767 (program &optional infile destination display
&rest args
)
2768 "Like `process-file' for Tramp files."
2769 ;; The implementation is not complete yet.
2770 (when (and (numberp destination
) (zerop destination
))
2771 (error "Implementation does not handle immediate return"))
2773 (with-parsed-tramp-file-name default-directory nil
2774 (let (command input tmpinput stderr tmpstderr outbuf ret
)
2776 (setq command
(mapconcat 'tramp-shell-quote-argument
2777 (cons program args
) " "))
2780 (setq input
"/dev/null")
2781 (setq infile
(expand-file-name infile
))
2782 (if (tramp-equal-remote default-directory infile
)
2783 ;; INFILE is on the same remote host.
2784 (setq input
(with-parsed-tramp-file-name infile nil localname
))
2785 ;; INFILE must be copied to remote host.
2786 (setq input
(tramp-make-tramp-temp-file v
)
2787 tmpinput
(tramp-make-tramp-file-name method user host input
))
2788 (copy-file infile tmpinput t
)))
2789 (when input
(setq command
(format "%s <%s" command input
)))
2791 ;; Determine output.
2794 ((bufferp destination
)
2795 (setq outbuf destination
))
2797 ((stringp destination
)
2798 (setq outbuf
(get-buffer-create destination
)))
2799 ;; (REAL-DESTINATION ERROR-DESTINATION)
2800 ((consp destination
)
2803 ((bufferp (car destination
))
2804 (setq outbuf
(car destination
)))
2805 ((stringp (car destination
))
2806 (setq outbuf
(get-buffer-create (car destination
))))
2808 (setq outbuf
(current-buffer))))
2811 ((stringp (cadr destination
))
2812 (setcar (cdr destination
) (expand-file-name (cadr destination
)))
2813 (if (tramp-equal-remote default-directory
(cadr destination
))
2814 ;; stderr is on the same remote host.
2815 (setq stderr
(with-parsed-tramp-file-name
2816 (cadr destination
) nil localname
))
2817 ;; stderr must be copied to remote host. The temporary
2818 ;; file must be deleted after execution.
2819 (setq stderr
(tramp-make-tramp-temp-file v
)
2820 tmpstderr
(tramp-make-tramp-file-name
2821 method user host stderr
))))
2822 ;; stderr to be discarded.
2823 ((null (cadr destination
))
2824 (setq stderr
"/dev/null"))))
2827 (setq outbuf
(current-buffer))))
2828 (when stderr
(setq command
(format "%s 2>%s" command stderr
)))
2830 ;; Send the command. It might not return in time, so we protect
2831 ;; it. Call it in a subshell, in order to preserve working
2836 (if (tramp-send-command-and-check
2837 v
(format "\\cd %s; %s"
2838 (tramp-shell-quote-argument localname
)
2842 ;; We should show the output anyway.
2844 (with-current-buffer outbuf
2846 (with-current-buffer (tramp-get-connection-buffer v
)
2848 (when display
(display-buffer outbuf
))))
2849 ;; When the user did interrupt, we should do it also. We use
2850 ;; return code -1 as marker.
2852 (kill-buffer (tramp-get-connection-buffer v
))
2856 (kill-buffer (tramp-get-connection-buffer v
))
2859 ;; Provide error file.
2860 (when tmpstderr
(rename-file tmpstderr
(cadr destination
) t
))
2862 ;; Cleanup. We remove all file cache values for the connection,
2863 ;; because the remote process could have changed them.
2864 (when tmpinput
(delete-file tmpinput
))
2866 ;; `process-file-side-effects' has been introduced with GNU
2867 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2868 ;; by `program'. If it doesn't exist, we assume its default
2870 (unless (and (boundp 'process-file-side-effects
)
2871 (not (symbol-value 'process-file-side-effects
)))
2872 (tramp-flush-directory-property v
""))
2874 ;; Return exit status.
2879 (defun tramp-sh-handle-file-local-copy (filename)
2880 "Like `file-local-copy' for Tramp files."
2881 (with-parsed-tramp-file-name filename nil
2882 (unless (file-exists-p filename
)
2885 "Cannot make local copy of non-existing file `%s'" filename
))
2887 (let* ((size (nth 7 (file-attributes (file-truename filename
))))
2888 (rem-enc (tramp-get-inline-coding v
"remote-encoding" size
))
2889 (loc-dec (tramp-get-inline-coding v
"local-decoding" size
))
2890 (tmpfile (tramp-compat-make-temp-file filename
)))
2894 ;; `copy-file' handles direct copy and out-of-band methods.
2895 ((or (tramp-local-host-p v
)
2896 (tramp-method-out-of-band-p v size
))
2897 (copy-file filename tmpfile t t
))
2899 ;; Use inline encoding for file transfer.
2902 (with-tramp-progress-reporter
2904 (format "Encoding remote file `%s' with `%s'" filename rem-enc
)
2905 (tramp-barf-unless-okay
2906 v
(format rem-enc
(tramp-shell-quote-argument localname
))
2907 "Encoding remote file failed"))
2909 (with-tramp-progress-reporter
2910 v
3 (format "Decoding local file `%s' with `%s'"
2912 (if (functionp loc-dec
)
2913 ;; If local decoding is a function, we call it.
2914 ;; We must disable multibyte, because
2915 ;; `uudecode-decode-region' doesn't handle it
2918 (set-buffer-multibyte nil
)
2919 (insert-buffer-substring (tramp-get-buffer v
))
2920 (funcall loc-dec
(point-min) (point-max))
2921 ;; Unset `file-name-handler-alist'. Otherwise,
2922 ;; epa-file gets confused.
2923 (let (file-name-handler-alist
2924 (coding-system-for-write 'binary
))
2925 (write-region (point-min) (point-max) tmpfile
)))
2927 ;; If tramp-decoding-function is not defined for this
2928 ;; method, we invoke tramp-decoding-command instead.
2929 (let ((tmpfile2 (tramp-compat-make-temp-file filename
)))
2930 ;; Unset `file-name-handler-alist'. Otherwise,
2931 ;; epa-file gets confused.
2932 (let (file-name-handler-alist
2933 (coding-system-for-write 'binary
))
2934 (with-current-buffer (tramp-get-buffer v
)
2935 (write-region (point-min) (point-max) tmpfile2
)))
2937 (tramp-call-local-coding-command
2938 loc-dec tmpfile2 tmpfile
)
2939 (delete-file tmpfile2
)))))
2941 ;; Set proper permissions.
2942 (set-file-modes tmpfile
(tramp-default-file-modes filename
))
2943 ;; Set local user ownership.
2944 (tramp-set-file-uid-gid tmpfile
)))
2946 ;; Oops, I don't know what to do.
2948 v
'file-error
"Wrong method specification for `%s'" method
)))
2952 (delete-file tmpfile
)
2953 (signal (car err
) (cdr err
))))
2955 (run-hooks 'tramp-handle-file-local-copy-hook
)
2958 ;; This is needed for XEmacs only. Code stolen from files.el.
2959 (defun tramp-sh-handle-insert-file-contents-literally
2960 (filename &optional visit beg end replace
)
2961 "Like `insert-file-contents-literally' for Tramp files."
2962 (let ((format-alist nil
)
2963 (after-insert-file-functions nil
)
2964 (coding-system-for-read 'no-conversion
)
2965 (coding-system-for-write 'no-conversion
)
2966 (find-buffer-file-type-function
2967 (if (fboundp 'find-buffer-file-type
)
2968 (symbol-function 'find-buffer-file-type
)
2970 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler
))
2971 (inhibit-file-name-operation 'insert-file-contents
))
2974 (fset 'find-buffer-file-type
(lambda (_filename) t
))
2975 (insert-file-contents filename visit beg end replace
))
2977 (if find-buffer-file-type-function
2978 (fset 'find-buffer-file-type find-buffer-file-type-function
)
2979 (fmakunbound 'find-buffer-file-type
)))))
2981 ;; CCC grok LOCKNAME
2982 (defun tramp-sh-handle-write-region
2983 (start end filename
&optional append visit lockname confirm
)
2984 "Like `write-region' for Tramp files."
2985 (setq filename
(expand-file-name filename
))
2986 (with-parsed-tramp-file-name filename nil
2987 ;; Following part commented out because we don't know what to do about
2988 ;; file locking, and it does not appear to be a problem to ignore it.
2989 ;; Ange-ftp ignores it, too.
2990 ;; (when (and lockname (stringp lockname))
2991 ;; (setq lockname (expand-file-name lockname)))
2992 ;; (unless (or (eq lockname nil)
2993 ;; (string= lockname filename))
2995 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
2997 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
2998 (when (and (not (featurep 'xemacs
)) confirm
(file-exists-p filename
))
2999 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename
))
3000 (tramp-error v
'file-error
"File not overwritten")))
3002 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename
'integer
))
3003 (tramp-get-remote-uid v
'integer
)))
3004 (gid (or (nth 3 (tramp-compat-file-attributes filename
'integer
))
3005 (tramp-get-remote-gid v
'integer
))))
3007 (if (and (tramp-local-host-p v
)
3008 ;; `file-writable-p' calls `file-expand-file-name'. We
3009 ;; cannot use `tramp-run-real-handler' therefore.
3010 (let (file-name-handler-alist)
3012 (file-writable-p (file-name-directory localname
))
3013 (or (file-directory-p localname
)
3014 (file-writable-p localname
)))))
3015 ;; Short track: if we are on the local host, we can run directly.
3016 (tramp-run-real-handler
3018 (list start end localname append
'no-message lockname confirm
))
3020 (let* ((modes (save-excursion (tramp-default-file-modes filename
)))
3021 ;; We use this to save the value of
3022 ;; `last-coding-system-used' after writing the tmp
3023 ;; file. At the end of the function, we set
3024 ;; `last-coding-system-used' to this saved value. This
3025 ;; way, any intermediary coding systems used while
3026 ;; talking to the remote shell or suchlike won't hose
3027 ;; this variable. This approach was snarfed from
3030 ;; Write region into a tmp file. This isn't really
3031 ;; needed if we use an encoding function, but currently
3032 ;; we use it always because this makes the logic
3033 ;; simpler. We must also set `temporary-file-directory',
3034 ;; because it could point to a remote directory.
3035 (temporary-file-directory
3036 (tramp-compat-temporary-file-directory))
3037 (tmpfile (or tramp-temp-buffer-file-name
3038 (tramp-compat-make-temp-file filename
))))
3040 ;; If `append' is non-nil, we copy the file locally, and let
3041 ;; the native `write-region' implementation do the job.
3042 (when append
(copy-file filename tmpfile
'ok
))
3044 ;; We say `no-message' here because we don't want the
3045 ;; visited file modtime data to be clobbered from the temp
3046 ;; file. We call `set-visited-file-modtime' ourselves later
3047 ;; on. We must ensure that `file-coding-system-alist'
3048 ;; matches `tmpfile'.
3049 (let (file-name-handler-alist
3050 (file-coding-system-alist
3051 (tramp-find-file-name-coding-system-alist filename tmpfile
)))
3053 (tramp-run-real-handler
3055 (list start end tmpfile append
'no-message lockname confirm
))
3057 (setq tramp-temp-buffer-file-name nil
)
3058 (delete-file tmpfile
)
3059 (signal (car err
) (cdr err
))))
3061 ;; Now, `last-coding-system-used' has the right value. Remember it.
3062 (when (boundp 'last-coding-system-used
)
3063 (setq coding-system-used
3064 (symbol-value 'last-coding-system-used
))))
3066 ;; The permissions of the temporary file should be set. If
3067 ;; filename does not exist (eq modes nil) it has been
3068 ;; renamed to the backup file. This case `save-buffer'
3069 ;; handles permissions.
3070 ;; Ensure that it is still readable.
3074 (logior (or modes
0) (tramp-compat-octal-to-decimal "0400"))))
3076 ;; This is a bit lengthy due to the different methods
3077 ;; possible for file transfer. First, we check whether the
3078 ;; method uses an rcp program. If so, we call it.
3079 ;; Otherwise, both encoding and decoding command must be
3080 ;; specified. However, if the method _also_ specifies an
3081 ;; encoding function, then that is used for encoding the
3082 ;; contents of the tmp file.
3083 (let* ((size (nth 7 (file-attributes tmpfile
)))
3084 (rem-dec (tramp-get-inline-coding v
"remote-decoding" size
))
3085 (loc-enc (tramp-get-inline-coding v
"local-encoding" size
)))
3087 ;; `copy-file' handles direct copy and out-of-band methods.
3088 ((or (tramp-local-host-p v
)
3089 (tramp-method-out-of-band-p v size
))
3090 (if (and (not (stringp start
))
3091 (= (or end
(point-max)) (point-max))
3092 (= (or start
(point-min)) (point-min))
3093 (tramp-get-method-parameter
3094 method
'tramp-copy-keep-tmpfile
))
3096 (setq tramp-temp-buffer-file-name tmpfile
)
3098 ;; We keep the local file for performance
3099 ;; reasons, useful for "rsync".
3100 (copy-file tmpfile filename t
)
3102 (setq tramp-temp-buffer-file-name nil
)
3103 (delete-file tmpfile
)
3104 (signal (car err
) (cdr err
)))))
3105 (setq tramp-temp-buffer-file-name nil
)
3106 ;; Don't rename, in order to keep context in SELinux.
3108 (copy-file tmpfile filename t
)
3109 (delete-file tmpfile
))))
3111 ;; Use inline file transfer.
3116 (set-buffer-multibyte nil
)
3117 ;; Use encoding function or command.
3118 (with-tramp-progress-reporter
3119 v
3 (format "Encoding local file `%s' using `%s'"
3121 (if (functionp loc-enc
)
3122 ;; The following `let' is a workaround for
3123 ;; the base64.el that comes with pgnus-0.84.
3124 ;; If both of the following conditions are
3125 ;; satisfied, it tries to write to a local
3126 ;; file in default-directory, but at this
3127 ;; point, default-directory is remote.
3128 ;; (`call-process-region' can't write to
3129 ;; remote files, it seems.) The file in
3130 ;; question is a tmp file anyway.
3131 (let ((coding-system-for-read 'binary
)
3133 (tramp-compat-temporary-file-directory)))
3134 (insert-file-contents-literally tmpfile
)
3135 (funcall loc-enc
(point-min) (point-max)))
3137 (unless (zerop (tramp-call-local-coding-command
3141 (concat "Cannot write to `%s', "
3142 "local encoding command `%s' failed")
3143 filename loc-enc
))))
3145 ;; Send buffer into remote decoding command which
3146 ;; writes to remote file. Because this happens on
3147 ;; the remote host, we cannot use the function.
3148 (with-tramp-progress-reporter
3149 v
3 (format "Decoding remote file `%s' using `%s'"
3151 (goto-char (point-max))
3152 (unless (bolp) (newline))
3156 (concat rem-dec
" <<'EOF'\n%sEOF")
3157 (tramp-shell-quote-argument localname
)
3159 (tramp-barf-unless-okay
3161 "Couldn't write region to `%s', decode using `%s' failed"
3163 ;; When `file-precious-flag' is set, the region is
3164 ;; written to a temporary file. Check that the
3165 ;; checksum is equal to that from the local tmpfile.
3166 (when file-precious-flag
3169 ;; cksum runs locally, if possible.
3170 (zerop (tramp-call-process "cksum" tmpfile t
))
3171 ;; cksum runs remotely.
3172 (tramp-send-command-and-check
3175 "cksum <%s" (tramp-shell-quote-argument localname
)))
3176 ;; ... they are different.
3180 (with-current-buffer (tramp-get-buffer v
)
3184 (concat "Couldn't write region to `%s',"
3185 " decode using `%s' failed")
3186 filename rem-dec
)))))
3189 (delete-file tmpfile
)))
3191 ;; That's not expected.
3195 (concat "Method `%s' should specify both encoding and "
3196 "decoding command or an rcp program")
3199 ;; Make `last-coding-system-used' have the right value.
3200 (when coding-system-used
3201 (set 'last-coding-system-used coding-system-used
))))
3203 (tramp-flush-file-property v
(file-name-directory localname
))
3204 (tramp-flush-file-property v localname
)
3206 ;; We must protect `last-coding-system-used', now we have set it
3207 ;; to its correct value.
3208 (let (last-coding-system-used (need-chown t
))
3209 ;; Set file modification time.
3210 (when (or (eq visit t
) (stringp visit
))
3211 (let ((file-attr (tramp-compat-file-attributes filename
'integer
)))
3212 (set-visited-file-modtime
3213 ;; We must pass modtime explicitly, because filename can
3214 ;; be different from (buffer-file-name), f.e. if
3215 ;; `file-precious-flag' is set.
3217 (when (and (= (nth 2 file-attr
) uid
)
3218 (= (nth 3 file-attr
) gid
))
3219 (setq need-chown nil
))))
3221 ;; Set the ownership.
3223 (tramp-set-file-uid-gid filename uid gid
))
3224 (when (or (eq visit t
) (null visit
) (stringp visit
))
3225 (tramp-message v
0 "Wrote %s" filename
))
3226 (run-hooks 'tramp-handle-write-region-hook
)))))
3228 (defvar tramp-vc-registered-file-names nil
3229 "List used to collect file names, which are checked during `vc-registered'.")
3231 ;; VC backends check for the existence of various different special
3232 ;; files. This is very time consuming, because every single check
3233 ;; requires a remote command (the file cache must be invalidated).
3234 ;; Therefore, we apply a kind of optimization. We install the file
3235 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3236 ;; remembers all file names for which `file-exists-p' or
3237 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3238 ;; is performed. Afterwards, a script is applied for all collected
3239 ;; file names, using just one remote command. The result of this
3240 ;; script is used to fill the file cache with actual values. Now we
3241 ;; can reset the file name handlers, and we make a second run of
3242 ;; `vc-registered', which returns the expected result without sending
3243 ;; any other remote command.
3244 (defun tramp-sh-handle-vc-registered (file)
3245 "Like `vc-registered' for Tramp files."
3246 (tramp-compat-with-temp-message ""
3247 (with-parsed-tramp-file-name file nil
3248 (with-tramp-progress-reporter
3249 v
3 (format "Checking `vc-registered' for %s" file
)
3251 ;; There could be new files, created by the vc backend. We
3252 ;; cannot reuse the old cache entries, therefore.
3253 (let (tramp-vc-registered-file-names
3254 (remote-file-name-inhibit-cache (current-time))
3255 (file-name-handler-alist
3256 `((,tramp-file-name-regexp . tramp-vc-file-name-handler
))))
3258 ;; Here we collect only file names, which need an operation.
3259 (ignore-errors (tramp-run-real-handler 'vc-registered
(list file
)))
3260 (tramp-message v
10 "\n%s" tramp-vc-registered-file-names
)
3262 ;; Send just one command, in order to fill the cache.
3263 (when tramp-vc-registered-file-names
3264 (tramp-maybe-send-script
3266 (format tramp-vc-registered-read-file-names
3267 (tramp-get-file-exists-command v
)
3268 (format "%s -r" (tramp-get-test-command v
)))
3269 "tramp_vc_registered_read_file_names")
3273 (tramp-send-command-and-read
3276 "tramp_vc_registered_read_file_names <<'EOF'\n%s\nEOF\n"
3277 (mapconcat 'tramp-shell-quote-argument
3278 tramp-vc-registered-file-names
3281 (tramp-set-file-property
3282 v
(car elt
) (cadr elt
) (cadr (cdr elt
))))))
3284 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3285 ;; calls shall be answered from the file cache. We unset
3286 ;; `process-file-side-effects' in order to keep the cache when
3287 ;; `process-file' calls appear.
3288 (let (process-file-side-effects)
3290 (tramp-run-real-handler 'vc-registered
(list file
))))))))
3292 ;;;###tramp-autoload
3293 (defun tramp-sh-file-name-handler (operation &rest args
)
3294 "Invoke remote-shell Tramp file name handler.
3295 Fall back to normal file name handler if no Tramp handler exists."
3296 (when (and tramp-locked
(not tramp-locker
))
3297 (setq tramp-locked nil
)
3298 (signal 'file-error
(list "Forbidden reentrant call of Tramp")))
3299 (let ((tl tramp-locked
))
3302 (setq tramp-locked t
)
3303 (let ((tramp-locker t
))
3305 (let ((fn (assoc operation tramp-sh-file-name-handler-alist
)))
3307 (apply (cdr fn
) args
)
3308 (tramp-run-real-handler operation args
))))))
3309 (setq tramp-locked tl
))))
3311 (defun tramp-vc-file-name-handler (operation &rest args
)
3312 "Invoke special file name handler, which collects files to be handled."
3315 (tramp-replace-environment-variables
3316 (apply 'tramp-file-name-for-operation operation args
)))
3317 (fn (assoc operation tramp-sh-file-name-handler-alist
)))
3318 (with-parsed-tramp-file-name filename nil
3320 ;; That's what we want: file names, for which checks are
3321 ;; applied. We assume that VC uses only `file-exists-p' and
3322 ;; `file-readable-p' checks; otherwise we must extend the
3323 ;; list. We do not perform any action, but return nil, in
3324 ;; order to keep `vc-registered' running.
3325 ((and fn
(memq operation
'(file-exists-p file-readable-p
)))
3326 (add-to-list 'tramp-vc-registered-file-names localname
'append
)
3328 ;; `process-file' and `start-file-process' shall be ignored.
3329 ((and fn
(eq operation
'process-file
) 0))
3330 ((and fn
(eq operation
'start-file-process
) nil
))
3331 ;; Tramp file name handlers like `expand-file-name'. They
3333 (fn (save-match-data (apply (cdr fn
) args
)))
3334 ;; Default file name handlers, we don't care.
3335 (t (tramp-run-real-handler operation args
)))))))
3337 (defun tramp-sh-handle-file-notify-add-watch (file-name flags _callback
)
3338 "Like `file-notify-add-watch' for Tramp files."
3339 (setq file-name
(expand-file-name file-name
))
3340 (with-parsed-tramp-file-name file-name nil
3341 (let* ((default-directory (file-name-directory file-name
))
3342 command events filter p
)
3344 ;; gvfs-monitor-dir.
3345 ((setq command
(tramp-get-remote-gvfs-monitor-dir v
))
3346 (setq filter
'tramp-sh-file-gvfs-monitor-dir-process-filter
3347 p
(start-file-process
3348 "gvfs-monitor-dir" (generate-new-buffer " *gvfs-monitor-dir*")
3349 command localname
)))
3351 ((setq command
(tramp-get-remote-inotifywait v
))
3352 (setq filter
'tramp-sh-file-inotifywait-process-filter
3355 ((and (memq 'change flags
) (memq 'attribute-change flags
))
3356 "create,modify,move,delete,attrib")
3357 ((memq 'change flags
) "create,modify,move,delete")
3358 ((memq 'attribute-change flags
) "attrib"))
3359 p
(start-file-process
3360 "inotifywait" (generate-new-buffer " *inotifywait*")
3361 command
"-mq" "-e" events localname
)))
3364 v
'file-notify-error
3365 "No file notification program found on %s"
3366 (file-remote-p file-name
))))
3367 ;; Return the process object as watch-descriptor.
3368 (if (not (processp p
))
3370 v
'file-notify-error
"`%s' failed to start on remote host" command
)
3371 (tramp-compat-set-process-query-on-exit-flag p nil
)
3372 (set-process-filter p filter
)
3375 (defun tramp-sh-file-gvfs-monitor-dir-process-filter (proc string
)
3376 "Read output from \"gvfs-monitor-dir\" and add corresponding file-notify events."
3377 (let ((remote-prefix
3378 (with-current-buffer (process-buffer proc
)
3379 (file-remote-p default-directory
)))
3380 (rest-string (tramp-compat-process-get proc
'rest-string
)))
3382 (tramp-message proc
10 "Previous string:\n%s" rest-string
))
3383 (tramp-message proc
6 "%S\n%s" proc string
)
3384 (setq string
(concat rest-string string
)
3385 ;; Attribute change is returned in unused wording.
3386 string
(tramp-compat-replace-regexp-in-string
3387 "ATTRIB CHANGED" "ATTRIBUTE_CHANGED" string
))
3389 (while (string-match
3391 "Directory Monitor Event:[\n\r]+"
3392 "Child = \\([^\n\r]+\\)[\n\r]+"
3393 "\\(Other = \\([^\n\r]+\\)[\n\r]+\\)?"
3394 "Event = \\([^[:blank:]]+\\)[\n\r]+")
3400 (tramp-compat-replace-regexp-in-string
3401 "_" "-" (downcase (match-string 4 string
))))
3402 ;; File names are returned as absolute paths. We must
3403 ;; add the remote prefix.
3404 (concat remote-prefix
(match-string 1 string
))
3405 (when (match-string 3 string
)
3406 (concat remote-prefix
(match-string 3 string
))))))
3407 (setq string
(replace-match "" nil nil string
))
3408 ;; Usually, we would add an Emacs event now. Unfortunately,
3409 ;; `unread-command-events' does not accept several events at
3410 ;; once. Therefore, we apply the callback directly.
3411 (tramp-compat-funcall 'file-notify-callback object
)))
3413 ;; Save rest of the string.
3414 (when (zerop (length string
)) (setq string nil
))
3415 (when string
(tramp-message proc
10 "Rest string:\n%s" string
))
3416 (tramp-compat-process-put proc
'rest-string string
)))
3418 (defun tramp-sh-file-inotifywait-process-filter (proc string
)
3419 "Read output from \"inotifywait\" and add corresponding file-notify events."
3420 (tramp-message proc
6 "%S\n%s" proc string
)
3421 (dolist (line (split-string string
"[\n\r]+" 'omit-nulls
))
3422 ;; Check, whether there is a problem.
3425 (concat "^[^[:blank:]]+"
3426 "[[:blank:]]+\\([^[:blank:]]+\\)+"
3427 "\\([[:blank:]]+\\([^\n\r]+\\)\\)?")
3429 (tramp-error proc
'file-notify-error
"%s" line
))
3437 (tramp-compat-replace-regexp-in-string "_" "-" (downcase x
))))
3438 (split-string (match-string 1 line
) "," 'omit-nulls
))
3439 (match-string 3 line
))))
3440 ;; Usually, we would add an Emacs event now. Unfortunately,
3441 ;; `unread-command-events' does not accept several events at
3442 ;; once. Therefore, we apply the callback directly.
3443 (tramp-compat-funcall 'file-notify-callback object
))))
3445 ;;; Internal Functions:
3447 (defun tramp-maybe-send-script (vec script name
)
3448 "Define in remote shell function NAME implemented as SCRIPT.
3449 Only send the definition if it has not already been done."
3450 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3452 (let ((scripts (tramp-get-connection-property
3453 (tramp-get-connection-process vec
) "scripts" nil
)))
3454 (unless (member name scripts
)
3455 (with-tramp-progress-reporter vec
5 (format "Sending script `%s'" name
)
3456 ;; The script could contain a call of Perl. This is masked with `%s'.
3457 (when (and (string-match "%s" script
)
3458 (not (tramp-get-remote-perl vec
)))
3459 (tramp-error vec
'file-error
"No Perl available on remote host"))
3460 (tramp-barf-unless-okay
3462 (format "%s () {\n%s\n}" name
3463 (format script
(tramp-get-remote-perl vec
)))
3464 "Script %s sending failed" name
)
3465 (tramp-set-connection-property
3466 (tramp-get-connection-process vec
) "scripts" (cons name scripts
))))))
3468 (defun tramp-set-auto-save ()
3469 (when (and ;; ange-ftp has its own auto-save mechanism
3470 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
3471 'tramp-sh-file-name-handler
)
3473 (auto-save-mode 1)))
3474 (add-hook 'find-file-hooks
'tramp-set-auto-save t
)
3475 (add-hook 'tramp-unload-hook
3477 (remove-hook 'find-file-hooks
'tramp-set-auto-save
)))
3479 (defun tramp-run-test (switch filename
)
3480 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3481 Returns the exit code of the `test' program."
3482 (with-parsed-tramp-file-name filename nil
3483 (tramp-send-command-and-check
3487 (tramp-get-test-command v
)
3489 (tramp-shell-quote-argument localname
)))))
3491 (defun tramp-run-test2 (format-string file1 file2
)
3492 "Run `test'-like program on the remote system, given FILE1, FILE2.
3493 FORMAT-STRING contains the program name, switches, and place holders.
3494 Returns the exit code of the `test' program. Barfs if the methods,
3495 hosts, or files, disagree."
3496 (unless (tramp-equal-remote file1 file2
)
3497 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1
) file1 file2
) nil
3500 "tramp-run-test2 only implemented for same method, user, host")))
3501 (with-parsed-tramp-file-name file1 v1
3502 (with-parsed-tramp-file-name file1 v2
3503 (tramp-send-command-and-check
3505 (format format-string
3506 (tramp-shell-quote-argument v1-localname
)
3507 (tramp-shell-quote-argument v2-localname
))))))
3509 (defun tramp-find-executable
3510 (vec progname dirlist
&optional ignore-tilde ignore-path
)
3511 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3512 First arg VEC specifies the connection, PROGNAME is the program
3513 to search for, and DIRLIST gives the list of directories to
3514 search. If IGNORE-TILDE is non-nil, directory names starting
3515 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3518 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3520 This function expects to be in the right *tramp* buffer."
3521 (with-current-buffer (tramp-get-connection-buffer vec
)
3523 ;; Check whether the executable is in $PATH. "which(1)" does not
3524 ;; report always a correct error code; therefore we check the
3525 ;; number of words it returns.
3527 (tramp-send-command vec
(format "which \\%s | wc -w" progname
))
3528 (goto-char (point-min))
3529 (if (looking-at "^\\s-*1$")
3530 (setq result
(concat "\\" progname
))))
3533 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3534 ;; `remove' is in CL, and we want to avoid CL dependencies.
3537 (setq d
(car dirlist
))
3538 (setq dirlist
(cdr dirlist
))
3539 (unless (char-equal ?~
(aref d
0))
3540 (setq newdl
(cons d newdl
))))
3541 (setq dirlist
(nreverse newdl
))))
3544 (format (concat "while read d; "
3545 "do if test -x $d/%s -a -f $d/%s; "
3546 "then echo tramp_executable $d/%s; "
3547 "break; fi; done <<'EOF'\n"
3549 progname progname progname
(mapconcat 'identity dirlist
"\n")))
3550 (goto-char (point-max))
3551 (when (search-backward "tramp_executable " nil t
)
3552 (skip-chars-forward "^ ")
3553 (skip-chars-forward " ")
3554 (setq result
(buffer-substring (point) (point-at-eol)))))
3557 (defun tramp-set-remote-path (vec)
3558 "Sets the remote environment PATH to existing directories.
3559 I.e., for each directory in `tramp-remote-path', it is tested
3560 whether it exists and if so, it is added to the environment
3562 (tramp-message vec
5 "Setting $PATH environment variable")
3564 vec
(format "PATH=%s; export PATH"
3565 (mapconcat 'identity
(tramp-get-remote-path vec
) ":"))))
3567 ;; ------------------------------------------------------------
3568 ;; -- Communication with external shell --
3569 ;; ------------------------------------------------------------
3571 (defun tramp-find-file-exists-command (vec)
3572 "Find a command on the remote host for checking if a file exists.
3573 Here, we are looking for a command which has zero exit status if the
3574 file exists and nonzero exit status otherwise."
3575 (let ((existing "/")
3577 (tramp-shell-quote-argument "/ this file does not exist "))
3579 ;; The algorithm is as follows: we try a list of several commands.
3580 ;; For each command, we first run `$cmd /' -- this should return
3581 ;; true, as the root directory always exists. And then we run
3582 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3583 ;; does not exist. This should return false. We use the first
3584 ;; command we find that seems to work.
3585 ;; The list of commands to try is as follows:
3586 ;; `ls -d' This works on most systems, but NetBSD 1.4
3587 ;; has a bug: `ls' always returns zero exit
3588 ;; status, even for files which don't exist.
3589 ;; `test -e' Some Bourne shells have a `test' builtin
3590 ;; which does not know the `-e' option.
3591 ;; `/bin/test -e' For those, the `test' binary on disk normally
3592 ;; provides the option. Alas, the binary
3593 ;; is sometimes `/bin/test' and sometimes it's
3595 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3598 (and (setq result
(format "%s -e" (tramp-get-test-command vec
)))
3599 (tramp-send-command-and-check
3600 vec
(format "%s %s" result existing
))
3601 (not (tramp-send-command-and-check
3602 vec
(format "%s %s" result nonexistent
)))))
3604 (and (setq result
"/bin/test -e")
3605 (tramp-send-command-and-check
3606 vec
(format "%s %s" result existing
))
3607 (not (tramp-send-command-and-check
3608 vec
(format "%s %s" result nonexistent
)))))
3610 (and (setq result
"/usr/bin/test -e")
3611 (tramp-send-command-and-check
3612 vec
(format "%s %s" result existing
))
3613 (not (tramp-send-command-and-check
3614 vec
(format "%s %s" result nonexistent
)))))
3616 (and (setq result
(format "%s -d" (tramp-get-ls-command vec
)))
3617 (tramp-send-command-and-check
3618 vec
(format "%s %s" result existing
))
3619 (not (tramp-send-command-and-check
3620 vec
(format "%s %s" result nonexistent
))))))
3622 vec
'file-error
"Couldn't find command to check if file exists"))
3625 (defun tramp-open-shell (vec shell
)
3626 "Opens shell SHELL."
3627 (with-tramp-progress-reporter
3628 vec
5 (format "Opening remote shell `%s'" shell
)
3629 ;; Find arguments for this shell.
3630 (let ((tramp-end-of-output tramp-initial-end-of-output
)
3631 (alist tramp-sh-extra-args
)
3633 (while (and alist
(null extra-args
))
3634 (setq item
(pop alist
))
3635 (when (string-match (car item
) shell
)
3636 (setq extra-args
(cdr item
))))
3639 "exec env ENV='' PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3640 (tramp-shell-quote-argument tramp-end-of-output
)
3641 shell
(or extra-args
""))
3643 (tramp-set-connection-property
3644 (tramp-get-connection-process vec
) "remote-shell" shell
)
3647 vec
(format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output
)) t
)
3648 (tramp-send-command vec
"PS2=''" t
)
3649 (tramp-send-command vec
"PS3=''" t
)
3650 (tramp-send-command vec
"PROMPT_COMMAND=''" t
)))
3652 (defun tramp-find-shell (vec)
3653 "Opens a shell on the remote host which groks tilde expansion."
3654 (with-current-buffer (tramp-get-buffer vec
)
3655 (let ((default-shell
3657 (tramp-get-connection-property
3658 (tramp-get-connection-process vec
) "remote-shell" nil
)
3659 (tramp-get-method-parameter
3660 (tramp-file-name-method vec
) 'tramp-remote-shell
)))
3663 (with-tramp-connection-property vec
"remote-shell"
3664 ;; CCC: "root" does not exist always, see QNAP 459.
3665 ;; Which check could we apply instead?
3666 (tramp-send-command vec
"echo ~root" t
)
3667 (if (or (string-match "^~root$" (buffer-string))
3668 ;; The default shell (ksh93) of OpenSolaris and
3669 ;; Solaris is buggy. We've got reports for
3670 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3671 (string-match (regexp-opt '("SunOS 5.10" "SunOS 5.11"))
3672 (tramp-get-connection-property
3675 (or (tramp-find-executable
3676 vec
"bash" (tramp-get-remote-path vec
) t t
)
3677 (tramp-find-executable
3678 vec
"ksh" (tramp-get-remote-path vec
) t t
)
3679 ;; Maybe it works at least for some other commands.
3685 "Couldn't find a remote shell which groks tilde "
3686 "expansion, using `%s'")
3691 ;; Open a new shell if needed.
3692 (unless (string-equal shell default-shell
)
3694 vec
5 "Starting remote shell `%s' for tilde expansion" shell
)
3695 (tramp-open-shell vec shell
)))))
3697 ;; Utility functions.
3699 (defun tramp-barf-if-no-shell-prompt (proc timeout
&rest error-args
)
3700 "Wait for shell prompt and barf if none appears.
3701 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3702 seconds. If not, it produces an error message with the given ERROR-ARGS."
3703 (let ((vec (tramp-get-connection-property proc
"vector" nil
)))
3705 (tramp-wait-for-regexp
3708 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern
))
3710 (delete-process proc
)
3711 (apply 'tramp-error-with-buffer
3712 (tramp-get-connection-buffer vec
) vec
'file-error error-args
)))))
3714 (defun tramp-open-connection-setup-interactive-shell (proc vec
)
3715 "Set up an interactive shell.
3716 Mainly sets the prompt and the echo correctly. PROC is the shell
3717 process to set up. VEC specifies the connection."
3718 (let ((tramp-end-of-output tramp-initial-end-of-output
))
3719 ;; It is useful to set the prompt in the following command because
3720 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3721 ;; about and thus /bin/sh will display a strange prompt. For
3722 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3723 ;; display the current working directory but /bin/sh will display
3724 ;; a dollar sign. The following command line sets $PS1 to a sane
3725 ;; value, and works under Bourne-ish shells as well as csh-like
3726 ;; shells. Daniel Pittman reports that the unusual positioning of
3727 ;; the single quotes makes it work under `rc', too. We also unset
3728 ;; the variable $ENV because that is read by some sh
3729 ;; implementations (eg, bash when called as sh) on startup; this
3730 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3731 ;; is another way to set the prompt in /bin/bash, it must be
3732 ;; discarded as well.
3735 (or (tramp-get-connection-property vec
"remote-shell" nil
)
3736 (tramp-get-method-parameter
3737 (tramp-file-name-method vec
) 'tramp-remote-shell
)))
3740 (tramp-message vec
5 "Setting up remote shell environment")
3741 (tramp-send-command vec
"stty -inlcr -echo kill '^U' erase '^H'" t
)
3742 ;; Check whether the echo has really been disabled. Some
3743 ;; implementations, like busybox of embedded GNU/Linux, don't
3744 ;; support disabling.
3745 (tramp-send-command vec
"echo foo" t
)
3746 (with-current-buffer (process-buffer proc
)
3747 (goto-char (point-min))
3748 (when (looking-at "echo foo")
3749 (tramp-set-connection-property proc
"remote-echo" t
)
3750 (tramp-message vec
5 "Remote echo still on. Ok.")
3751 ;; Make sure backspaces and their echo are enabled and no line
3752 ;; width magic interferes with them.
3753 (tramp-send-command vec
"stty icanon erase ^H cols 32767" t
))))
3755 (tramp-message vec
5 "Setting shell prompt")
3757 vec
(format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output
)) t
)
3758 (tramp-send-command vec
"PS2=''" t
)
3759 (tramp-send-command vec
"PS3=''" t
)
3760 (tramp-send-command vec
"PROMPT_COMMAND=''" t
)
3762 ;; Try to set up the coding system correctly.
3763 ;; CCC this can't be the right way to do it. Hm.
3764 (tramp-message vec
5 "Determining coding system")
3765 (tramp-send-command vec
"echo foo ; echo bar" t
)
3766 (with-current-buffer (process-buffer proc
)
3767 (goto-char (point-min))
3768 (if (featurep 'mule
)
3769 ;; Use MULE to select the right EOL convention for communicating
3770 ;; with the process.
3771 (let* ((cs (or (tramp-compat-funcall 'process-coding-system proc
)
3772 (cons 'undecided
'undecided
)))
3773 cs-decode cs-encode
)
3774 (when (symbolp cs
) (setq cs
(cons cs cs
)))
3775 (setq cs-decode
(car cs
))
3776 (setq cs-encode
(cdr cs
))
3777 (unless cs-decode
(setq cs-decode
'undecided
))
3778 (unless cs-encode
(setq cs-encode
'undecided
))
3779 (setq cs-encode
(tramp-compat-coding-system-change-eol-conversion
3781 (when (search-forward "\r" nil t
)
3782 (setq cs-decode
(tramp-compat-coding-system-change-eol-conversion
3784 (tramp-compat-funcall
3785 'set-buffer-process-coding-system cs-decode cs-encode
)
3787 vec
5 "Setting coding system to `%s' and `%s'" cs-decode cs-encode
))
3788 ;; Look for ^M and do something useful if found.
3789 (when (search-forward "\r" nil t
)
3790 ;; We have found a ^M but cannot frob the process coding system
3791 ;; because we're running on a non-MULE Emacs. Let's try
3793 (tramp-send-command vec
"stty -onlcr" t
))))
3795 (tramp-send-command vec
"set +o vi +o emacs" t
)
3797 ;; Check whether the output of "uname -sr" has been changed. If
3798 ;; yes, this is a strong indication that we must expire all
3799 ;; connection properties. We start again with
3800 ;; `tramp-maybe-open-connection', it will be caught there.
3801 (tramp-message vec
5 "Checking system information")
3802 (let ((old-uname (tramp-get-connection-property vec
"uname" nil
))
3804 (tramp-set-connection-property
3806 (tramp-send-command-and-read vec
"echo \\\"`uname -sr`\\\""))))
3807 (when (and (stringp old-uname
) (not (string-equal old-uname new-uname
)))
3810 "Connection reset, because remote host changed from `%s' to `%s'"
3811 old-uname new-uname
)
3812 ;; We want to keep the password.
3813 (tramp-cleanup-connection vec t t
)
3814 (throw 'uname-changed
(tramp-maybe-open-connection vec
))))
3816 ;; Check whether the remote host suffers from buggy
3817 ;; `send-process-string'. This is known for FreeBSD (see comment in
3818 ;; `send_process', file process.c). I've tested sending 624 bytes
3819 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3820 ;; this host type is detected locally. It cannot handle remote
3822 (with-tramp-connection-property proc
"chunksize"
3824 ((and (integerp tramp-chunksize
) (> tramp-chunksize
0))
3828 vec
5 "Checking remote host type for `send-process-string' bug")
3830 "^FreeBSD" (tramp-get-connection-property vec
"uname" ""))
3833 ;; Set remote PATH variable.
3834 (tramp-set-remote-path vec
)
3836 ;; Search for a good shell before searching for a command which
3837 ;; checks if a file exists. This is done because Tramp wants to use
3838 ;; "test foo; echo $?" to check if various conditions hold, and
3839 ;; there are buggy /bin/sh implementations which don't execute the
3840 ;; "echo $?" part if the "test" part has an error. In particular,
3841 ;; the OpenSolaris /bin/sh is a problem. There are also other
3842 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3843 ;; in function declarations, or changing HISTFILE in place.
3844 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3846 (tramp-find-shell vec
)
3848 ;; Disable unexpected output.
3849 (tramp-send-command vec
"mesg n; biff n" t
)
3851 ;; IRIX64 bash expands "!" even when in single quotes. This
3852 ;; destroys our shell functions, we must disable it. See
3853 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3854 (when (string-match "^IRIX64" (tramp-get-connection-property vec
"uname" ""))
3855 (tramp-send-command vec
"set +H" t
))
3857 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3858 (when (string-match "BSD\\|Darwin"
3859 (tramp-get-connection-property vec
"uname" ""))
3860 (tramp-send-command vec
"stty -oxtabs" t
))
3862 ;; Set `remote-tty' process property.
3863 (let ((tty (tramp-send-command-and-read vec
"echo \\\"`tty`\\\"" 'noerror
)))
3864 (unless (zerop (length tty
))
3865 (tramp-compat-process-put proc
'remote-tty tty
)))
3867 ;; Dump stty settings in the traces.
3868 (when (>= tramp-verbose
9)
3869 (tramp-send-command vec
"stty -a" t
))
3871 ;; Set the environment.
3872 (tramp-message vec
5 "Setting default environment")
3874 (let ((env (copy-sequence tramp-remote-process-environment
))
3877 (setq item
(tramp-compat-split-string (car env
) "="))
3878 (setcdr item
(mapconcat 'identity
(cdr item
) "="))
3879 (if (and (stringp (cdr item
)) (not (string-equal (cdr item
) "")))
3881 vec
(format "%s=%s; export %s" (car item
) (cdr item
) (car item
)) t
)
3882 (push (car item
) unset
))
3883 (setq env
(cdr env
)))
3886 vec
(format "unset %s" (mapconcat 'identity unset
" ")) t
))))
3888 ;; Old text from documentation of tramp-methods:
3889 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3890 ;; of the base64 methods instead since base64 encoding is much more
3891 ;; reliable and the commands are more standardized between the different
3892 ;; Unix versions. But if you can't use base64 for some reason, please
3893 ;; note that the default uudecode command does not work well for some
3894 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3895 ;; the following command for uudecode:
3897 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3899 ;; For Irix, no solution is known yet.
3901 (autoload 'uudecode-decode-region
"uudecode")
3903 (defconst tramp-local-coding-commands
3904 `((b64 base64-encode-region base64-decode-region
)
3905 (uu tramp-uuencode-region uudecode-decode-region
)
3906 (pack ,(format tramp-perl-pack
"perl") ,(format tramp-perl-unpack
"perl")))
3907 "List of local coding commands for inline transfer.
3908 Each item is a list that looks like this:
3910 \(FORMAT ENCODING DECODING\)
3912 FORMAT is symbol describing the encoding/decoding format. It can be
3913 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3915 ENCODING and DECODING can be strings, giving commands, or symbols,
3916 giving functions. If they are strings, then they can contain
3917 the \"%s\" format specifier. If that specifier is present, the input
3918 filename will be put into the command line at that spot. If the
3919 specifier is not present, the input should be read from standard
3922 If they are functions, they will be called with two arguments, start
3923 and end of region, and are expected to replace the region contents
3924 with the encoded or decoded results, respectively.")
3926 (defconst tramp-remote-coding-commands
3927 '((b64 "base64" "base64 -d -i")
3928 ;; "-i" is more robust with older base64 from GNU coreutils.
3929 ;; However, I don't know whether all base64 versions do supports
3931 (b64 "base64" "base64 -d")
3932 (b64 "mimencode -b" "mimencode -u -b")
3933 (b64 "mmencode -b" "mmencode -u -b")
3934 (b64 "recode data..base64" "recode base64..data")
3935 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module
)
3936 (b64 tramp-perl-encode tramp-perl-decode
)
3937 (uu "uuencode xxx" "uudecode -o /dev/stdout" "test -c /dev/stdout")
3938 (uu "uuencode xxx" "uudecode -o -")
3939 (uu "uuencode xxx" "uudecode -p")
3940 (uu "uuencode xxx" tramp-uudecode
)
3941 (pack tramp-perl-pack tramp-perl-unpack
))
3942 "List of remote coding commands for inline transfer.
3943 Each item is a list that looks like this:
3945 \(FORMAT ENCODING DECODING [TEST]\)
3947 FORMAT is symbol describing the encoding/decoding format. It can be
3948 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3950 ENCODING and DECODING can be strings, giving commands, or symbols,
3951 giving variables. If they are strings, then they can contain
3952 the \"%s\" format specifier. If that specifier is present, the input
3953 filename will be put into the command line at that spot. If the
3954 specifier is not present, the input should be read from standard
3957 If they are variables, this variable is a string containing a Perl
3958 implementation for this functionality. This Perl program will be transferred
3959 to the remote host, and it is available as shell function with the same name.
3961 The optional TEST command can be used for further tests, whether
3962 ENCODING and DECODING are applicable.")
3964 (defun tramp-find-inline-encoding (vec)
3965 "Find an inline transfer encoding that works.
3966 Goes through the list `tramp-local-coding-commands' and
3967 `tramp-remote-coding-commands'."
3969 (let ((local-commands tramp-local-coding-commands
)
3971 (p (tramp-get-connection-process vec
))
3972 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found
)
3973 (while (and local-commands
(not found
))
3974 (setq litem
(pop local-commands
))
3975 (catch 'wont-work-local
3976 (let ((format (nth 0 litem
))
3977 (remote-commands tramp-remote-coding-commands
))
3978 (setq loc-enc
(nth 1 litem
))
3979 (setq loc-dec
(nth 2 litem
))
3980 ;; If the local encoder or decoder is a string, the
3981 ;; corresponding command has to work locally.
3982 (if (not (stringp loc-enc
))
3984 vec
5 "Checking local encoding function `%s'" loc-enc
)
3986 vec
5 "Checking local encoding command `%s' for sanity" loc-enc
)
3987 (unless (zerop (tramp-call-local-coding-command
3989 (throw 'wont-work-local nil
)))
3990 (if (not (stringp loc-dec
))
3992 vec
5 "Checking local decoding function `%s'" loc-dec
)
3994 vec
5 "Checking local decoding command `%s' for sanity" loc-dec
)
3995 (unless (zerop (tramp-call-local-coding-command
3997 (throw 'wont-work-local nil
)))
3998 ;; Search for remote coding commands with the same format
3999 (while (and remote-commands
(not found
))
4000 (setq ritem
(pop remote-commands
))
4001 (catch 'wont-work-remote
4002 (when (equal format
(nth 0 ritem
))
4003 (setq rem-enc
(nth 1 ritem
))
4004 (setq rem-dec
(nth 2 ritem
))
4005 (setq rem-test
(nth 3 ritem
))
4006 ;; Check the remote test command if exists.
4007 (when (stringp rem-test
)
4009 vec
5 "Checking remote test command `%s'" rem-test
)
4010 (unless (tramp-send-command-and-check vec rem-test t
)
4011 (throw 'wont-work-remote nil
)))
4012 ;; Check if remote encoding and decoding commands can be
4013 ;; called remotely with null input and output. This makes
4014 ;; sure there are no syntax errors and the command is really
4015 ;; found. Note that we do not redirect stdout to /dev/null,
4016 ;; for two reasons: when checking the decoding command, we
4017 ;; actually check the output it gives. And also, when
4018 ;; redirecting "mimencode" output to /dev/null, then as root
4019 ;; it might change the permissions of /dev/null!
4020 (when (not (stringp rem-enc
))
4021 (let ((name (symbol-name rem-enc
)))
4022 (while (string-match (regexp-quote "-") name
)
4023 (setq name
(replace-match "_" nil t name
)))
4024 (tramp-maybe-send-script vec
(symbol-value rem-enc
) name
)
4025 (setq rem-enc name
)))
4028 "Checking remote encoding command `%s' for sanity" rem-enc
)
4029 (unless (tramp-send-command-and-check
4030 vec
(format "%s </dev/null" rem-enc
) t
)
4031 (throw 'wont-work-remote nil
))
4033 (when (not (stringp rem-dec
))
4034 (let ((name (symbol-name rem-dec
)))
4035 (while (string-match (regexp-quote "-") name
)
4036 (setq name
(replace-match "_" nil t name
)))
4037 (tramp-maybe-send-script vec
(symbol-value rem-dec
) name
)
4038 (setq rem-dec name
)))
4041 "Checking remote decoding command `%s' for sanity" rem-dec
)
4042 (unless (tramp-send-command-and-check
4044 (format "echo %s | %s | %s" magic rem-enc rem-dec
)
4046 (throw 'wont-work-remote nil
))
4048 (with-current-buffer (tramp-get-buffer vec
)
4049 (goto-char (point-min))
4050 (unless (looking-at (regexp-quote magic
))
4051 (throw 'wont-work-remote nil
)))
4053 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4054 (setq rem-enc
(nth 1 ritem
))
4055 (setq rem-dec
(nth 2 ritem
))
4056 (setq found t
)))))))
4058 ;; Did we find something?
4061 vec
'file-error
"Couldn't find an inline transfer encoding"))
4063 ;; Set connection properties. Since the commands are risky (due
4064 ;; to output direction), we cache them in the process cache.
4065 (tramp-message vec
5 "Using local encoding `%s'" loc-enc
)
4066 (tramp-set-connection-property p
"local-encoding" loc-enc
)
4067 (tramp-message vec
5 "Using local decoding `%s'" loc-dec
)
4068 (tramp-set-connection-property p
"local-decoding" loc-dec
)
4069 (tramp-message vec
5 "Using remote encoding `%s'" rem-enc
)
4070 (tramp-set-connection-property p
"remote-encoding" rem-enc
)
4071 (tramp-message vec
5 "Using remote decoding `%s'" rem-dec
)
4072 (tramp-set-connection-property p
"remote-decoding" rem-dec
))))
4074 (defun tramp-call-local-coding-command (cmd input output
)
4075 "Call the local encoding or decoding command.
4076 If CMD contains \"%s\", provide input file INPUT there in command.
4077 Otherwise, INPUT is passed via standard input.
4078 INPUT can also be nil which means `/dev/null'.
4079 OUTPUT can be a string (which specifies a filename), or t (which
4080 means standard output and thus the current buffer), or nil (which
4083 tramp-encoding-shell
4084 (when (and input
(not (string-match "%s" cmd
))) input
)
4085 (if (eq output t
) t nil
)
4087 tramp-encoding-command-switch
4089 (if (string-match "%s" cmd
) (format cmd input
) cmd
)
4090 (if (stringp output
) (concat " >" output
) ""))))
4092 (defconst tramp-inline-compress-commands
4093 '(("gzip" "gzip -d")
4094 ("bzip2" "bzip2 -d")
4096 ("compress" "compress -d"))
4097 "List of compress and decompress commands for inline transfer.
4098 Each item is a list that looks like this:
4100 \(COMPRESS DECOMPRESS\)
4102 COMPRESS or DECOMPRESS are strings with the respective commands.")
4104 (defun tramp-find-inline-compress (vec)
4105 "Find an inline transfer compress command that works.
4106 Goes through the list `tramp-inline-compress-commands'."
4108 (let ((commands tramp-inline-compress-commands
)
4110 (p (tramp-get-connection-process vec
))
4111 item compress decompress found
)
4112 (while (and commands
(not found
))
4114 (setq item
(pop commands
)
4115 compress
(nth 0 item
)
4116 decompress
(nth 1 item
))
4119 "Checking local compress commands `%s', `%s' for sanity"
4120 compress decompress
)
4123 (tramp-call-local-coding-command
4125 ;; Windows shells need the program file name after
4126 ;; the pipe symbol be quoted if they use forward
4127 ;; slashes as directory separators.
4128 (if (memq system-type
'(windows-nt))
4129 "echo %s | \"%s\" | \"%s\""
4130 "echo %s | %s | %s")
4131 magic compress decompress
) nil nil
))
4135 "Checking remote compress commands `%s', `%s' for sanity"
4136 compress decompress
)
4137 (unless (tramp-send-command-and-check
4138 vec
(format "echo %s | %s | %s" magic compress decompress
) t
)
4142 ;; Did we find something?
4145 ;; Set connection properties. Since the commands are
4146 ;; risky (due to output direction), we cache them in the
4149 vec
5 "Using inline transfer compress command `%s'" compress
)
4150 (tramp-set-connection-property p
"inline-compress" compress
)
4152 vec
5 "Using inline transfer decompress command `%s'" decompress
)
4153 (tramp-set-connection-property p
"inline-decompress" decompress
))
4155 (tramp-set-connection-property p
"inline-compress" nil
)
4156 (tramp-set-connection-property p
"inline-decompress" nil
)
4158 vec
2 "Couldn't find an inline transfer compress command")))))
4160 (defun tramp-compute-multi-hops (vec)
4161 "Expands VEC according to `tramp-default-proxies-alist'.
4162 Gateway hops are already opened."
4163 (let ((target-alist `(,vec
))
4164 (hops (or (tramp-file-name-hop vec
) ""))
4168 ;; Ad-hoc proxy definitions.
4169 (dolist (proxy (reverse (split-string hops tramp-postfix-hop-regexp
'omit
)))
4170 (let ((user (tramp-file-name-user item
))
4171 (host (tramp-file-name-host item
))
4173 tramp-prefix-format proxy tramp-postfix-host-format
)))
4175 vec
5 "Add proxy (\"%s\" \"%s\" \"%s\")"
4176 (and (stringp host
) (regexp-quote host
))
4177 (and (stringp user
) (regexp-quote user
))
4181 'tramp-default-proxies-alist
4182 (list (and (stringp host
) (regexp-quote host
))
4183 (and (stringp user
) (regexp-quote user
))
4185 (setq item
(tramp-dissect-file-name proxy
))))
4186 ;; Save the new value.
4187 (when (and hops tramp-save-ad-hoc-proxies
)
4188 (customize-save-variable
4189 'tramp-default-proxies-alist tramp-default-proxies-alist
))
4191 ;; Look for proxy hosts to be passed.
4192 (setq choices tramp-default-proxies-alist
)
4194 (setq item
(pop choices
)
4195 proxy
(eval (nth 2 item
)))
4198 (string-match (or (eval (nth 0 item
)) "")
4199 (or (tramp-file-name-host (car target-alist
)) ""))
4201 (string-match (or (eval (nth 1 item
)) "")
4202 (or (tramp-file-name-user (car target-alist
)) "")))
4204 ;; No more hops needed.
4206 ;; Replace placeholders.
4211 ?u
(or (tramp-file-name-user (car target-alist
)) "")
4212 ?h
(or (tramp-file-name-host (car target-alist
)) ""))))
4213 (with-parsed-tramp-file-name proxy l
4215 (push l target-alist
)
4216 ;; Start next search.
4217 (setq choices tramp-default-proxies-alist
)))))
4220 (when (and (boundp 'tramp-gw-tunnel-method
) (boundp 'tramp-gw-socks-method
)
4223 "^\\(%s\\|%s\\)$" tramp-gw-tunnel-method tramp-gw-socks-method
)
4224 (tramp-file-name-method (car target-alist
))))
4225 (let ((gw (pop target-alist
))
4226 (hop (pop target-alist
)))
4227 ;; Is the method prepared for gateways?
4228 (unless (tramp-file-name-port hop
)
4231 "Connection `%s' is not supported for gateway access." hop
))
4232 ;; Open the gateway connection.
4235 (tramp-file-name-method hop
) (tramp-file-name-user hop
)
4236 (tramp-compat-funcall 'tramp-gw-open-connection vec gw hop
) nil nil
)
4238 ;; For the password prompt, we need the correct values.
4239 ;; Therefore, we must remember the gateway vector. But we
4240 ;; cannot do it as connection property, because it shouldn't
4241 ;; be persistent. And we have no started process yet either.
4242 (tramp-set-file-property (car target-alist
) "" "gateway" hop
)))
4244 ;; Foreign and out-of-band methods are not supported for multi-hops.
4245 (when (cdr target-alist
)
4246 (setq choices target-alist
)
4248 (setq item
(pop choices
))
4252 (tramp-get-method-parameter
4253 (tramp-file-name-method item
) 'tramp-login-program
))
4254 (tramp-get-method-parameter
4255 (tramp-file-name-method item
) 'tramp-copy-program
))
4258 "Method `%s' is not supported for multi-hops."
4259 (tramp-file-name-method item
)))))
4261 ;; In case the host name is not used for the remote shell
4262 ;; command, the user could be misguided by applying a random
4264 (let* ((v (car target-alist
))
4265 (method (tramp-file-name-method v
))
4266 (host (tramp-file-name-host v
)))
4269 ;; There are multi-hops.
4271 ;; The host name is used for the remote shell command.
4273 '("%h") (tramp-get-method-parameter method
'tramp-login-args
))
4274 ;; The host is local. We cannot use `tramp-local-host-p'
4275 ;; here, because it opens a connection as well.
4276 (string-match tramp-local-host-regexp host
))
4279 "Host `%s' looks like a remote host, `%s' can only use the local host"
4285 (defun tramp-maybe-open-connection (vec)
4286 "Maybe open a connection VEC.
4287 Does not do anything if a connection is already open, but re-opens the
4288 connection if a previous connection has died for some reason."
4289 (tramp-check-proper-host vec
)
4291 (let ((p (tramp-get-connection-process vec
))
4292 (process-name (tramp-get-connection-property vec
"process-name" nil
))
4293 (process-environment (copy-sequence process-environment
))
4294 (pos (with-current-buffer (tramp-get-connection-buffer vec
) (point))))
4296 ;; If Tramp opens the same connection within a short time frame,
4297 ;; there is a problem. We shall signal this.
4298 (unless (or (and p
(processp p
) (memq (process-status p
) '(run open
)))
4299 (not (equal (butlast (append vec nil
) 2)
4300 (car tramp-current-connection
)))
4302 (current-time) (cdr tramp-current-connection
))
4303 (or tramp-connection-min-time-diff
0)))
4304 (throw 'suppress
'suppress
))
4306 ;; If too much time has passed since last command was sent, look
4307 ;; whether process is still alive. If it isn't, kill it. When
4308 ;; using ssh, it can sometimes happen that the remote end has hung
4309 ;; up but the local ssh client doesn't recognize this until it
4310 ;; tries to send some data to the remote end. So that's why we
4311 ;; try to send a command from time to time, then look again
4312 ;; whether the process is really alive.
4314 (when (and (> (tramp-time-diff
4316 (tramp-get-connection-property
4317 p
"last-cmd-time" '(0 0 0)))
4319 p
(processp p
) (memq (process-status p
) '(run open
)))
4320 (tramp-send-command vec
"echo are you awake" t t
)
4321 (unless (and (memq (process-status p
) '(run open
))
4322 (tramp-wait-for-output p
10))
4323 ;; The error will be caught locally.
4324 (tramp-error vec
'file-error
"Awake did fail")))
4326 (tramp-cleanup-connection vec t
)
4329 ;; New connection must be opened.
4331 (unless (and p
(processp p
) (memq (process-status p
) '(run open
)))
4333 ;; We call `tramp-get-buffer' in order to get a debug buffer
4334 ;; for messages from the beginning.
4335 (tramp-get-buffer vec
)
4337 ;; If `non-essential' is non-nil, don't reopen a new connection.
4338 (when (and (boundp 'non-essential
) (symbol-value 'non-essential
))
4339 (throw 'non-essential
'non-essential
))
4341 (with-tramp-progress-reporter
4343 (if (zerop (length (tramp-file-name-user vec
)))
4344 (format "Opening connection for %s using %s"
4345 (tramp-file-name-host vec
)
4346 (tramp-file-name-method vec
))
4347 (format "Opening connection for %s@%s using %s"
4348 (tramp-file-name-user vec
)
4349 (tramp-file-name-host vec
)
4350 (tramp-file-name-method vec
)))
4352 (catch 'uname-changed
4353 ;; Start new process.
4354 (when (and p
(processp p
))
4356 (setenv "TERM" tramp-terminal-type
)
4357 (setenv "LC_ALL" "C")
4358 (setenv "PROMPT_COMMAND")
4359 (setenv "PS1" tramp-initial-end-of-output
)
4360 (let* ((target-alist (tramp-compute-multi-hops vec
))
4361 ;; We will apply `tramp-ssh-controlmaster-options'
4362 ;; only for the first hop.
4363 (options (if tramp-use-ssh-controlmaster-options
4364 tramp-ssh-controlmaster-options
""))
4365 (process-connection-type tramp-process-connection-type
)
4366 (process-adaptive-read-buffering nil
)
4367 (coding-system-for-read nil
)
4368 ;; This must be done in order to avoid our file
4370 (p (let ((default-directory
4371 (tramp-compat-temporary-file-directory)))
4374 (tramp-get-connection-name vec
)
4375 (tramp-get-connection-buffer vec
)
4376 (if tramp-encoding-command-interactive
4377 (list tramp-encoding-shell
4378 tramp-encoding-command-interactive
)
4379 (list tramp-encoding-shell
))))))
4381 ;; Set sentinel and query flag.
4382 (tramp-set-connection-property p
"vector" vec
)
4383 (set-process-sentinel p
'tramp-process-sentinel
)
4384 (tramp-compat-set-process-query-on-exit-flag p nil
)
4385 (setq tramp-current-connection
4386 (cons (butlast (append vec nil
) 2) (current-time))
4387 tramp-current-host
(system-name))
4390 vec
6 "%s" (mapconcat 'identity
(process-command p
) " "))
4392 ;; Check whether process is alive.
4393 (tramp-barf-if-no-shell-prompt
4395 "Couldn't find local shell prompt for %s" tramp-encoding-shell
)
4397 ;; Now do all the connections as specified.
4399 (let* ((hop (car target-alist
))
4400 (l-method (tramp-file-name-method hop
))
4401 (l-user (tramp-file-name-user hop
))
4402 (l-host (tramp-file-name-host hop
))
4405 (tramp-get-method-parameter
4406 l-method
'tramp-login-program
))
4408 (tramp-get-method-parameter
4409 l-method
'tramp-login-args
))
4411 (tramp-get-method-parameter
4412 l-method
'tramp-async-args
))
4414 (tramp-get-method-parameter
4415 l-method
'tramp-connection-timeout
))
4417 (tramp-get-method-parameter l-method
'tramp-gw-args
))
4418 (gw (tramp-get-file-property hop
"" "gateway" nil
))
4419 (g-method (and gw
(tramp-file-name-method gw
)))
4420 (g-user (and gw
(tramp-file-name-user gw
)))
4421 (g-host (and gw
(tramp-file-name-real-host gw
)))
4422 (command login-program
)
4423 ;; We don't create the temporary file. In
4424 ;; fact, it is just a prefix for the
4425 ;; ControlPath option of ssh; the real
4426 ;; temporary file has another name, and it is
4427 ;; created and protected by ssh. It is also
4428 ;; removed by ssh when the connection is
4429 ;; closed. The temporary file name is cached
4430 ;; in the main connection process, therefore
4431 ;; we cannot use `tramp-get-connection-process'.
4433 (with-tramp-connection-property
4434 (get-process (tramp-buffer-name vec
)) "temp-file"
4437 tramp-temp-name-prefix
4438 (tramp-compat-temporary-file-directory)))))
4441 ;; Add arguments for asynchronous processes.
4442 (when (and process-name async-args
)
4443 (setq login-args
(append async-args login-args
)))
4445 ;; Add gateway arguments if necessary.
4446 (when (and gw gw-args
)
4447 (setq login-args
(append gw-args login-args
)))
4449 ;; Check for port number. Until now, there's no
4450 ;; need for handling like method, user, host.
4451 (when (string-match tramp-host-with-port-regexp l-host
)
4452 (setq l-port
(match-string 2 l-host
)
4453 l-host
(match-string 1 l-host
)))
4455 ;; Check, whether there is a restricted shell.
4456 (dolist (elt tramp-restricted-shell-hosts-alist
)
4457 (when (string-match elt tramp-current-host
)
4460 ;; Set variables for computing the prompt for
4461 ;; reading password. They can also be derived
4463 (setq tramp-current-method
(or g-method l-method
)
4464 tramp-current-user
(or g-user l-user
)
4465 tramp-current-host
(or g-host l-host
))
4467 ;; Replace login-args place holders.
4469 l-host
(or l-host
"")
4470 l-user
(or l-user
"")
4471 l-port
(or l-port
"")
4472 spec
(format-spec-make ?t tmpfile
)
4473 options
(format-spec options spec
)
4474 spec
(format-spec-make
4475 ?h l-host ?u l-user ?p l-port ?c options
)
4478 ;; We do not want to see the trailing local
4479 ;; prompt in `start-file-process'.
4480 (unless r-shell
"exec ")
4484 (setq x
(mapcar (lambda (y) (format-spec y spec
)) x
))
4485 (unless (member "" x
) (mapconcat 'identity x
" ")))
4487 ;; Local shell could be a Windows COMSPEC. It
4488 ;; doesn't know the ";" syntax, but we must exit
4489 ;; always for `start-file-process'. It could
4490 ;; also be a restricted shell, which does not
4492 (when r-shell
" && exit || exit")))
4494 ;; Send the command.
4495 (tramp-message vec
3 "Sending command `%s'" command
)
4496 (tramp-send-command vec command t t
)
4497 (tramp-process-actions
4498 p vec pos tramp-actions-before-shell
4499 (or connection-timeout tramp-connection-timeout
))
4501 vec
3 "Found remote shell prompt on `%s'" l-host
))
4504 target-alist
(cdr target-alist
)))
4506 ;; Make initial shell settings.
4507 (tramp-open-connection-setup-interactive-shell p vec
)))))
4509 ;; When the user did interrupt, we must cleanup.
4511 (tramp-cleanup-connection vec t
)
4512 ;; Propagate the quit signal.
4513 (signal (car err
) (cdr err
))))))
4515 (defun tramp-send-command (vec command
&optional neveropen nooutput
)
4516 "Send the COMMAND to connection VEC.
4517 Erases temporary buffer before sending the command. If optional
4518 arg NEVEROPEN is non-nil, never try to open the connection. This
4519 is meant to be used from `tramp-maybe-open-connection' only. The
4520 function waits for output unless NOOUTPUT is set."
4521 (unless neveropen
(tramp-maybe-open-connection vec
))
4522 (let ((p (tramp-get-connection-process vec
)))
4523 (when (tramp-get-connection-property p
"remote-echo" nil
)
4524 ;; We mark the command string that it can be erased in the output buffer.
4525 (tramp-set-connection-property p
"check-remote-echo" t
)
4526 (setq command
(format "%s%s%s" tramp-echo-mark command tramp-echo-mark
)))
4527 ;; Some busyboxes tend to close the connection when we use the
4528 ;; following syntax for here-documents. This we cannot test; it
4529 ;; shall be set via `tramp-connection-properties'.
4530 (when (and (string-match "<<'EOF'" command
)
4531 (not (tramp-get-connection-property vec
"busybox" nil
)))
4532 ;; Unset $PS1 when using here documents, in order to avoid
4533 ;; multiple prompts.
4534 (setq command
(concat "(PS1= ; " command
"\n)")))
4535 ;; Send the command.
4536 (tramp-message vec
6 "%s" command
)
4537 (tramp-send-string vec command
)
4538 (unless nooutput
(tramp-wait-for-output p
))))
4540 (defun tramp-wait-for-output (proc &optional timeout
)
4541 "Wait for output from remote command."
4542 (unless (buffer-live-p (process-buffer proc
))
4543 (delete-process proc
)
4544 (tramp-error proc
'file-error
"Process `%s' not available, try again" proc
))
4545 (with-current-buffer (process-buffer proc
)
4546 (let* (;; Initially, `tramp-end-of-output' is "#$ ". There might
4547 ;; be leading escape sequences, which must be ignored.
4548 (regexp (format "[^#$\n]*%s\r?$" (regexp-quote tramp-end-of-output
)))
4549 ;; Sometimes, the commands do not return a newline but a
4550 ;; null byte before the shell prompt, for example "git
4551 ;; ls-files -c -z ...".
4552 (regexp1 (format "\\(^\\|\000\\)%s" regexp
))
4553 (found (tramp-wait-for-regexp proc timeout regexp1
)))
4555 (let (buffer-read-only)
4556 ;; A simple-minded busybox has sent " ^H" sequences.
4558 (goto-char (point-min))
4559 (when (re-search-forward "^\\(.\b\\)+$" (point-at-eol) t
)
4561 (delete-region (point-min) (point)))
4562 ;; Delete the prompt.
4563 (goto-char (point-max))
4564 (re-search-backward regexp nil t
)
4565 (delete-region (point) (point-max)))
4569 "[[Remote prompt `%s' not found in %d secs]]"
4570 tramp-end-of-output timeout
)
4573 "[[Remote prompt `%s' not found]]" tramp-end-of-output
)))
4574 ;; Return value is whether end-of-output sentinel was found.
4577 (defun tramp-send-command-and-check
4578 (vec command
&optional subshell dont-suppress-err
)
4579 "Run COMMAND and check its exit status.
4580 Sends `echo $?' along with the COMMAND for checking the exit status. If
4581 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4583 If the optional argument SUBSHELL is non-nil, the command is
4584 executed in a subshell, ie surrounded by parentheses. If
4585 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4588 (concat (if subshell
"( " "")
4590 (if command
(if dont-suppress-err
"; " " 2>/dev/null; ") "")
4591 "echo tramp_exit_status $?"
4592 (if subshell
" )" "")))
4593 (with-current-buffer (tramp-get-connection-buffer vec
)
4594 (goto-char (point-max))
4595 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t
)
4597 vec
'file-error
"Couldn't find exit status of `%s'" command
))
4598 (skip-chars-forward "^ ")
4600 (zerop (read (current-buffer)))
4601 (let (buffer-read-only)
4602 (delete-region (match-beginning 0) (point-max))))))
4604 (defun tramp-barf-unless-okay (vec command fmt
&rest args
)
4605 "Run COMMAND, check exit status, throw error if exit status not okay.
4606 Similar to `tramp-send-command-and-check' but accepts two more arguments
4607 FMT and ARGS which are passed to `error'."
4608 (or (tramp-send-command-and-check vec command
)
4609 (apply 'tramp-error vec
'file-error fmt args
)))
4611 (defun tramp-send-command-and-read (vec command
&optional noerror
)
4612 "Run COMMAND and return the output, which must be a Lisp expression.
4613 In case there is no valid Lisp expression and NOERROR is nil, it
4616 (tramp-send-command-and-check vec command
)
4617 (tramp-barf-unless-okay
4618 vec command
"`%s' returns with error" command
))
4619 (with-current-buffer (tramp-get-connection-buffer vec
)
4620 ;; Read the expression.
4621 (goto-char (point-min))
4623 (prog1 (read (current-buffer))
4625 (when (re-search-forward "\\S-" (point-at-eol) t
)
4627 (error (unless noerror
4630 "`%s' does not return a valid Lisp expression: `%s'"
4631 command
(buffer-string))))))))
4633 (defun tramp-convert-file-attributes (vec attr
)
4634 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4635 Convert file mode bits to string and set virtual device number.
4638 ;; Remove color escape sequences from symlink.
4639 (when (stringp (car attr
))
4640 (while (string-match tramp-color-escape-sequence-regexp
(car attr
))
4641 (setcar attr
(replace-match "" nil nil
(car attr
)))))
4642 ;; Convert uid and gid. Use -1 as indication of unusable value.
4643 (when (and (numberp (nth 2 attr
)) (< (nth 2 attr
) 0))
4644 (setcar (nthcdr 2 attr
) -
1))
4645 (when (and (floatp (nth 2 attr
))
4646 (<= (nth 2 attr
) (tramp-compat-most-positive-fixnum)))
4647 (setcar (nthcdr 2 attr
) (round (nth 2 attr
))))
4648 (when (and (numberp (nth 3 attr
)) (< (nth 3 attr
) 0))
4649 (setcar (nthcdr 3 attr
) -
1))
4650 (when (and (floatp (nth 3 attr
))
4651 (<= (nth 3 attr
) (tramp-compat-most-positive-fixnum)))
4652 (setcar (nthcdr 3 attr
) (round (nth 3 attr
))))
4653 ;; Convert last access time.
4654 (unless (listp (nth 4 attr
))
4655 (setcar (nthcdr 4 attr
)
4656 (list (floor (nth 4 attr
) 65536)
4657 (floor (mod (nth 4 attr
) 65536)))))
4658 ;; Convert last modification time.
4659 (unless (listp (nth 5 attr
))
4660 (setcar (nthcdr 5 attr
)
4661 (list (floor (nth 5 attr
) 65536)
4662 (floor (mod (nth 5 attr
) 65536)))))
4663 ;; Convert last status change time.
4664 (unless (listp (nth 6 attr
))
4665 (setcar (nthcdr 6 attr
)
4666 (list (floor (nth 6 attr
) 65536)
4667 (floor (mod (nth 6 attr
) 65536)))))
4668 ;; Convert file size.
4669 (when (< (nth 7 attr
) 0)
4670 (setcar (nthcdr 7 attr
) -
1))
4671 (when (and (floatp (nth 7 attr
))
4672 (<= (nth 7 attr
) (tramp-compat-most-positive-fixnum)))
4673 (setcar (nthcdr 7 attr
) (round (nth 7 attr
))))
4674 ;; Convert file mode bits to string.
4675 (unless (stringp (nth 8 attr
))
4676 (setcar (nthcdr 8 attr
) (tramp-file-mode-from-int (nth 8 attr
)))
4677 (when (stringp (car attr
))
4678 (aset (nth 8 attr
) 0 ?l
)))
4679 ;; Convert directory indication bit.
4680 (when (string-match "^d" (nth 8 attr
))
4682 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4683 (when (consp (car attr
))
4684 (if (and (stringp (caar attr
))
4685 (string-match ".+ -> .\\(.+\\)." (caar attr
)))
4686 (setcar attr
(match-string 1 (caar attr
)))
4688 ;; Set file's gid change bit.
4689 (setcar (nthcdr 9 attr
)
4690 (if (numberp (nth 3 attr
))
4691 (not (= (nth 3 attr
)
4692 (tramp-get-remote-gid vec
'integer
)))
4695 (tramp-get-remote-gid vec
'string
)))))
4697 (unless (listp (nth 10 attr
))
4698 (setcar (nthcdr 10 attr
)
4700 (cons (floor (nth 10 attr
) 65536)
4701 (floor (mod (nth 10 attr
) 65536)))
4702 ;; Inodes can be incredible huge. We must hide this.
4703 (error (tramp-get-inode vec
)))))
4704 ;; Set virtual device number.
4705 (setcar (nthcdr 11 attr
)
4706 (tramp-get-device vec
))
4709 (defun tramp-shell-case-fold (string)
4710 "Converts STRING to shell glob pattern which ignores case."
4713 (if (equal (downcase c
) (upcase c
))
4715 (format "[%c%c]" (downcase c
) (upcase c
))))
4719 (defun tramp-make-copy-program-file-name (vec)
4720 "Create a file name suitable to be passed to `rcp' and workalikes."
4721 (let ((user (tramp-file-name-user vec
))
4722 (host (tramp-file-name-real-host vec
))
4723 (localname (tramp-shell-quote-argument
4724 (tramp-file-name-localname vec
))))
4725 (if (not (zerop (length user
)))
4726 (format "%s@%s:%s" user host localname
)
4727 (format "%s:%s" host localname
))))
4729 (defun tramp-method-out-of-band-p (vec size
)
4730 "Return t if this is an out-of-band method, nil otherwise."
4732 ;; It shall be an out-of-band method.
4733 (tramp-get-method-parameter (tramp-file-name-method vec
) 'tramp-copy-program
)
4734 ;; There must be a size, otherwise the file doesn't exist.
4736 ;; Either the file size is large enough, or (in rare cases) there
4737 ;; does not exist a remote encoding.
4738 (or (null tramp-copy-size-limit
)
4739 (> size tramp-copy-size-limit
)
4740 (null (tramp-get-inline-coding vec
"remote-encoding" size
)))))
4742 ;; Variables local to connection.
4744 (defun tramp-get-remote-path (vec)
4745 (with-tramp-connection-property
4746 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4747 ;; cache the result for the session only. Otherwise, the result
4748 ;; is cached persistently.
4749 (if (memq 'tramp-own-remote-path tramp-remote-path
)
4750 (tramp-get-connection-process vec
)
4753 (let* ((remote-path (copy-tree tramp-remote-path
))
4754 (elt1 (memq 'tramp-default-remote-path remote-path
))
4755 (elt2 (memq 'tramp-own-remote-path remote-path
))
4756 (default-remote-path
4759 (tramp-send-command-and-read
4760 vec
"echo \\\"`getconf PATH 2>/dev/null`\\\"" 'noerror
)
4761 ;; Default if "getconf" is not available.
4765 "`getconf PATH' not successful, using default value \"%s\"."
4771 (tramp-send-command-and-read vec
"echo \\\"$PATH\\\"")
4774 vec
3 "$PATH not set, ignoring `tramp-own-remote-path'.")
4777 ;; Replace place holder `tramp-default-remote-path'.
4781 (tramp-compat-split-string default-remote-path
":")
4783 (setq remote-path
(delq 'tramp-default-remote-path remote-path
)))
4785 ;; Replace place holder `tramp-own-remote-path'.
4789 (tramp-compat-split-string own-remote-path
":")
4791 (setq remote-path
(delq 'tramp-own-remote-path remote-path
)))
4793 ;; Remove double entries.
4794 (setq elt1 remote-path
)
4796 (while (and (car elt1
) (setq elt2
(member (car elt1
) (cdr elt1
))))
4798 (setq elt1
(cdr elt1
)))
4800 ;; Remove non-existing directories.
4808 (tramp-make-tramp-file-name
4809 (tramp-file-name-method vec
)
4810 (tramp-file-name-user vec
)
4811 (tramp-file-name-host vec
)
4816 (defun tramp-get-ls-command (vec)
4817 (with-tramp-connection-property vec
"ls"
4818 (tramp-message vec
5 "Finding a suitable `ls' command")
4821 (dolist (cmd '("ls" "gnuls" "gls"))
4822 (let ((dl (tramp-get-remote-path vec
))
4824 (while (and dl
(setq result
(tramp-find-executable vec cmd dl t t
)))
4825 ;; Check parameters. On busybox, "ls" output coloring is
4826 ;; enabled by default sometimes. So we try to disable it
4827 ;; when possible. $LS_COLORING is not supported there.
4828 ;; Some "ls" versions are sensible wrt the order of
4829 ;; arguments, they fail when "-al" is after the
4830 ;; "--color=never" argument (for example on FreeBSD).
4831 (when (tramp-send-command-and-check
4832 vec
(format "%s -lnd /" result
))
4833 (when (tramp-send-command-and-check
4835 "%s --color=never -al /dev/null" result
))
4836 (setq result
(concat result
" --color=never")))
4837 (throw 'ls-found result
))
4838 (setq dl
(cdr dl
))))))
4839 (tramp-error vec
'file-error
"Couldn't find a proper `ls' command"))))
4841 (defun tramp-get-ls-command-with-dired (vec)
4843 (with-tramp-connection-property vec
"ls-dired"
4844 (tramp-message vec
5 "Checking, whether `ls --dired' works")
4845 ;; Some "ls" versions are sensible wrt the order of arguments,
4846 ;; they fail when "-al" is after the "--dired" argument (for
4847 ;; example on FreeBSD).
4848 (tramp-send-command-and-check
4849 vec
(format "%s --dired -al /dev/null" (tramp-get-ls-command vec
))))))
4851 (defun tramp-get-test-command (vec)
4852 (with-tramp-connection-property vec
"test"
4853 (tramp-message vec
5 "Finding a suitable `test' command")
4854 (if (tramp-send-command-and-check vec
"test 0")
4856 (tramp-find-executable vec
"test" (tramp-get-remote-path vec
)))))
4858 (defun tramp-get-test-nt-command (vec)
4859 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4860 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4861 ;; for otherwise the shell crashes.
4862 (with-tramp-connection-property vec
"test-nt"
4866 vec
(format "( %s / -nt / )" (tramp-get-test-command vec
)))
4867 (with-current-buffer (tramp-get-buffer vec
)
4868 (goto-char (point-min))
4869 (when (looking-at (regexp-quote tramp-end-of-output
))
4870 (format "%s %%s -nt %%s" (tramp-get-test-command vec
)))))
4875 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
4876 (tramp-get-test-command vec
)))
4877 "tramp_test_nt %s %s"))))
4879 (defun tramp-get-file-exists-command (vec)
4880 (with-tramp-connection-property vec
"file-exists"
4881 (tramp-message vec
5 "Finding command to check if file exists")
4882 (tramp-find-file-exists-command vec
)))
4884 (defun tramp-get-remote-ln (vec)
4885 (with-tramp-connection-property vec
"ln"
4886 (tramp-message vec
5 "Finding a suitable `ln' command")
4887 (tramp-find-executable vec
"ln" (tramp-get-remote-path vec
))))
4889 (defun tramp-get-remote-perl (vec)
4890 (with-tramp-connection-property vec
"perl"
4891 (tramp-message vec
5 "Finding a suitable `perl' command")
4893 (or (tramp-find-executable vec
"perl5" (tramp-get-remote-path vec
))
4894 (tramp-find-executable
4895 vec
"perl" (tramp-get-remote-path vec
)))))
4896 ;; We must check also for some Perl modules.
4898 (with-tramp-connection-property vec
"perl-file-spec"
4899 (tramp-send-command-and-check
4900 vec
(format "%s -e 'use File::Spec;'" result
)))
4901 (with-tramp-connection-property vec
"perl-cwd-realpath"
4902 (tramp-send-command-and-check
4903 vec
(format "%s -e 'use Cwd \"realpath\";'" result
))))
4906 (defun tramp-get-remote-stat (vec)
4907 (with-tramp-connection-property vec
"stat"
4908 (tramp-message vec
5 "Finding a suitable `stat' command")
4909 (let ((result (tramp-find-executable
4910 vec
"stat" (tramp-get-remote-path vec
)))
4912 ;; Check whether stat(1) returns usable syntax. "%s" does not
4913 ;; work on older AIX systems.
4916 (tramp-send-command-and-read
4917 vec
(format "%s -c '(\"%%N\" %%s)' /" result
) 'noerror
))
4918 (unless (and (listp tmp
) (stringp (car tmp
))
4919 (string-match "^./.$" (car tmp
))
4920 (integerp (cadr tmp
)))
4924 (defun tramp-get-remote-readlink (vec)
4925 (with-tramp-connection-property vec
"readlink"
4926 (tramp-message vec
5 "Finding a suitable `readlink' command")
4927 (let ((result (tramp-find-executable
4928 vec
"readlink" (tramp-get-remote-path vec
))))
4930 (tramp-send-command-and-check
4931 vec
(format "%s --canonicalize-missing /" result
)))
4934 (defun tramp-get-remote-trash (vec)
4935 (with-tramp-connection-property vec
"trash"
4936 (tramp-message vec
5 "Finding a suitable `trash' command")
4937 (tramp-find-executable vec
"trash" (tramp-get-remote-path vec
))))
4939 (defun tramp-get-remote-gvfs-monitor-dir (vec)
4940 (with-tramp-connection-property vec
"gvfs-monitor-dir"
4941 (tramp-message vec
5 "Finding a suitable `gvfs-monitor-dir' command")
4942 (tramp-find-executable
4943 vec
"gvfs-monitor-dir" (tramp-get-remote-path vec
) t t
)))
4945 (defun tramp-get-remote-inotifywait (vec)
4946 (with-tramp-connection-property vec
"inotifywait"
4947 (tramp-message vec
5 "Finding a suitable `inotifywait' command")
4948 (tramp-find-executable vec
"inotifywait" (tramp-get-remote-path vec
) t t
)))
4950 (defun tramp-get-remote-id (vec)
4951 (with-tramp-connection-property vec
"id"
4952 (tramp-message vec
5 "Finding POSIX `id' command")
4955 (let ((dl (tramp-get-remote-path vec
))
4957 (while (and dl
(setq result
(tramp-find-executable vec
"id" dl t t
)))
4958 ;; Check POSIX parameter.
4959 (when (tramp-send-command-and-check vec
(format "%s -u" result
))
4960 (throw 'id-found result
))
4961 (setq dl
(cdr dl
)))))
4962 (tramp-error vec
'file-error
"Couldn't find a POSIX `id' command"))))
4964 (defun tramp-get-remote-uid (vec id-format
)
4965 (with-tramp-connection-property vec
(format "uid-%s" id-format
)
4966 (let ((res (tramp-send-command-and-read
4968 (format "%s -u%s %s"
4969 (tramp-get-remote-id vec
)
4970 (if (equal id-format
'integer
) "" "n")
4971 (if (equal id-format
'integer
)
4972 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
4973 ;; The command might not always return a number.
4974 (if (and (equal id-format
'integer
) (not (integerp res
))) -
1 res
))))
4976 (defun tramp-get-remote-gid (vec id-format
)
4977 (with-tramp-connection-property vec
(format "gid-%s" id-format
)
4978 (let ((res (tramp-send-command-and-read
4980 (format "%s -g%s %s"
4981 (tramp-get-remote-id vec
)
4982 (if (equal id-format
'integer
) "" "n")
4983 (if (equal id-format
'integer
)
4984 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
4985 ;; The command might not always return a number.
4986 (if (and (equal id-format
'integer
) (not (integerp res
))) -
1 res
))))
4988 ;; Some predefined connection properties.
4989 (defun tramp-get-inline-compress (vec prop size
)
4990 "Return the compress command related to PROP.
4991 PROP is either `inline-compress' or `inline-decompress'. SIZE is
4992 the length of the file to be compressed.
4994 If no corresponding command is found, nil is returned."
4995 (when (and (integerp tramp-inline-compress-start-size
)
4996 (> size tramp-inline-compress-start-size
))
4997 (with-tramp-connection-property (tramp-get-connection-process vec
) prop
4998 (tramp-find-inline-compress vec
)
4999 (tramp-get-connection-property
5000 (tramp-get-connection-process vec
) prop nil
))))
5002 (defun tramp-get-inline-coding (vec prop size
)
5003 "Return the coding command related to PROP.
5004 PROP is either `remote-encoding', `remote-decoding',
5005 `local-encoding' or `local-decoding'.
5007 SIZE is the length of the file to be coded. Depending on SIZE,
5008 compression might be applied.
5010 If no corresponding command is found, nil is returned.
5011 Otherwise, either a string is returned which contains a `%s' mark
5012 to be used for the respective input or output file; or a Lisp
5013 function cell is returned to be applied on a buffer."
5014 ;; We must catch the errors, because we want to return `nil', when
5015 ;; no inline coding is found.
5018 (with-tramp-connection-property
5019 (tramp-get-connection-process vec
) prop
5020 (tramp-find-inline-encoding vec
)
5021 (tramp-get-connection-property
5022 (tramp-get-connection-process vec
) prop nil
)))
5023 (prop1 (if (string-match "encoding" prop
)
5024 "inline-compress" "inline-decompress"))
5026 ;; The connection property might have been cached. So we must
5027 ;; send the script to the remote side - maybe.
5028 (when (and coding
(symbolp coding
) (string-match "remote" prop
))
5029 (let ((name (symbol-name coding
)))
5030 (while (string-match (regexp-quote "-") name
)
5031 (setq name
(replace-match "_" nil t name
)))
5032 (tramp-maybe-send-script vec
(symbol-value coding
) name
)
5033 (setq coding name
)))
5035 ;; Check for the `compress' command.
5036 (setq compress
(tramp-get-inline-compress vec prop1 size
))
5037 ;; Return the value.
5039 ((and compress
(symbolp coding
))
5040 (if (string-match "decompress" prop1
)
5043 (let ((coding-system-for-write 'binary
)
5044 (coding-system-for-read 'binary
))
5046 'call-process-region
(point-min) (point-max)
5047 (car (split-string ,compress
)) t t nil
5048 (cdr (split-string ,compress
)))))
5050 (let ((coding-system-for-write 'binary
)
5051 (coding-system-for-read 'binary
))
5053 'call-process-region beg end
5054 (car (split-string ,compress
)) t t nil
5055 (cdr (split-string ,compress
))))
5056 (,coding
(point-min) (point-max)))))
5059 ((and compress
(string-match "decoding" prop
))
5061 ;; Windows shells need the program file name after
5062 ;; the pipe symbol be quoted if they use forward
5063 ;; slashes as directory separators.
5065 ((and (string-match "local" prop
)
5066 (memq system-type
'(windows-nt)))
5068 ((string-match "local" prop
) "(%s | %s)")
5069 (t "(%s | %s >%%s)"))
5073 ;; Windows shells need the program file name after
5074 ;; the pipe symbol be quoted if they use forward
5075 ;; slashes as directory separators.
5076 (if (and (string-match "local" prop
)
5077 (memq system-type
'(windows-nt)))
5078 "(%s <%%s | \"%s\")"
5081 ((string-match "decoding" prop
)
5083 ((string-match "local" prop
) (format "%s" coding
))
5084 (t (format "%s >%%s" coding
))))
5086 (format "%s <%%s" coding
)))))))
5088 (add-hook 'tramp-unload-hook
5090 (unload-feature 'tramp-sh
'force
)))
5096 ;; * Don't use globbing for directories with many files, as this is
5097 ;; likely to produce long command lines, and some shells choke on
5098 ;; long command lines.
5099 ;; * Make it work for different encodings, and for different file name
5100 ;; encodings, too. (Daniel Pittman)
5101 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5102 ;; then look if it's the right version (with `perl -v').
5103 ;; * When editing a remote CVS controlled file as a different user, VC
5104 ;; gets confused about the file locking status. Try to find out why
5105 ;; the workaround doesn't work.
5106 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5107 ;; until the last but one hop via `start-file-process'. Apply it
5108 ;; also for ftp and smb.
5109 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5110 ;; some shell with root privileges, it would be nice if I could
5112 ;; trampclient filename.c
5113 ;; as an editor, and the _current_ shell would connect to an Emacs
5114 ;; server and would be used in an existing non-privileged Emacs
5115 ;; session for doing the editing in question.
5116 ;; That way, I need not tell Emacs my password again and be afraid
5117 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5118 ;; once display a just typed password in the context of a keyboard
5119 ;; sequence prompt for a question immediately following in a shell
5120 ;; script run within Emacs -- nasty).
5121 ;; And if I have some ssh session running to a different computer,
5122 ;; having the possibility of passing a local file there to a local
5123 ;; Emacs session (in case I can arrange for a connection back) would
5125 ;; Likely the corresponding Tramp server should not allow the
5126 ;; equivalent of the emacsclient -eval option in order to make this
5127 ;; reasonably unproblematic. And maybe trampclient should have some
5128 ;; way of passing credentials, like by using an SSL socket or
5129 ;; something. (David Kastrup)
5130 ;; * Reconnect directly to a compliant shell without first going
5131 ;; through the user's default shell. (Pete Forman)
5132 ;; * How can I interrupt the remote process with a signal
5133 ;; (interrupt-process seems not to work)? (Markus Triska)
5134 ;; * Avoid the local shell entirely for starting remote processes. If
5135 ;; so, I think even a signal, when delivered directly to the local
5136 ;; SSH instance, would correctly be propagated to the remote process
5137 ;; automatically; possibly SSH would have to be started with
5138 ;; "-t". (Markus Triska)
5139 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5140 ;; isn't on the remote host. (Mark A. Hershberger)
5141 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5142 ;; * Optimize out-of-band copying when both methods are scp-like (not
5144 ;; * Keep a second connection open for out-of-band methods like scp or
5146 ;; * Try telnet+curl as new method. It might be useful for busybox,
5147 ;; without built-in uuencode/uudecode.
5149 ;;; tramp-sh.el ends here