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/>.
29 (eval-when-compile (require 'cl
)) ; ignore-errors
32 ;; Pacify byte-compiler. The function is needed on XEmacs only. I'm
33 ;; not sure at all that this is the right way to do it, but let's hope
34 ;; it works for now, and wait for a guru to point out the Right Way to
37 ;; (unless (fboundp 'dired-insert-set-properties)
38 ;; (fset 'dired-insert-set-properties 'ignore)))
39 ;; Gerd suggests this:
40 (eval-when-compile (require 'dired
))
41 ;; Note that dired is required at run-time, too, when it is needed.
42 ;; It is only needed on XEmacs for the function
43 ;; `dired-insert-set-properties'.
45 (defcustom tramp-inline-compress-start-size
4096
46 "The minimum size of compressing where inline transfer.
47 When inline transfer, compress transferred data of file
48 whose size is this value or above (up to `tramp-copy-size-limit').
49 If it is nil, no compression at all will be applied."
51 :type
'(choice (const nil
) integer
))
53 (defcustom tramp-copy-size-limit
10240
54 "The maximum file size where inline copying is preferred over an \
56 If it is nil, out-of-the-band copy will be used without a check."
58 :type
'(choice (const nil
) integer
))
61 (defcustom tramp-terminal-type
"dumb"
62 "Value of TERM environment variable for logging in to remote host.
63 Because Tramp wants to parse the output of the remote shell, it is easily
64 confused by ANSI color escape sequences and suchlike. Often, shell init
65 files conditionalize this setup based on the TERM environment variable."
69 (defconst tramp-color-escape-sequence-regexp
"\e[[;0-9]+m"
70 "Escape sequences produced by the \"ls\" command.")
72 ;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
73 ;; root users. It uses the `$' character for other users. In order
74 ;; to guarantee a proper prompt, we use "#$ " for the prompt.
76 (defvar tramp-end-of-output
79 (md5 (concat (prin1-to-string process-environment
) (current-time-string))))
80 "String used to recognize end of output.
81 The '$' character at the end is quoted; the string cannot be
82 detected as prompt when being sent on echoing hosts, therefore.")
85 (defconst tramp-initial-end-of-output
"#$ "
86 "Prompt when establishing a connection.")
88 ;; Initialize `tramp-methods' with the supported methods.
90 (add-to-list 'tramp-methods
92 (tramp-login-program "rsh")
93 (tramp-login-args (("%h") ("-l" "%u")))
94 (tramp-remote-shell "/bin/sh")
95 (tramp-remote-shell-args ("-c"))
96 (tramp-copy-program "rcp")
97 (tramp-copy-args (("-p" "%k") ("-r")))
98 (tramp-copy-keep-date t
)
99 (tramp-copy-recursive t
)))
101 (add-to-list 'tramp-methods
103 (tramp-login-program "remsh")
104 (tramp-login-args (("%h") ("-l" "%u")))
105 (tramp-remote-shell "/bin/sh")
106 (tramp-remote-shell-args ("-c"))
107 (tramp-copy-program "rcp")
108 (tramp-copy-args (("-p" "%k")))
109 (tramp-copy-keep-date t
)))
111 (add-to-list 'tramp-methods
113 (tramp-login-program "ssh")
114 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
115 (tramp-async-args (("-q")))
116 (tramp-remote-shell "/bin/sh")
117 (tramp-remote-shell-args ("-c"))
118 (tramp-copy-program "scp")
119 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")))
120 (tramp-copy-keep-date t
)
121 (tramp-copy-recursive t
)
122 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
123 ("-o" "UserKnownHostsFile=/dev/null")
124 ("-o" "StrictHostKeyChecking=no")))
125 (tramp-default-port 22)))
127 (add-to-list 'tramp-methods
129 (tramp-login-program "ssh")
130 (tramp-login-args (("-l" "%u") ("-p" "%p")
131 ("-1") ("-e" "none") ("%h")))
132 (tramp-async-args (("-q")))
133 (tramp-remote-shell "/bin/sh")
134 (tramp-remote-shell-args ("-c"))
135 (tramp-copy-program "scp")
136 (tramp-copy-args (("-1") ("-P" "%p") ("-p" "%k") ("-q") ("-r")))
137 (tramp-copy-keep-date t
)
138 (tramp-copy-recursive t
)
139 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
140 ("-o" "UserKnownHostsFile=/dev/null")
141 ("-o" "StrictHostKeyChecking=no")))
142 (tramp-default-port 22)))
144 (add-to-list 'tramp-methods
146 (tramp-login-program "ssh")
147 (tramp-login-args (("-l" "%u") ("-p" "%p")
148 ("-2") ("-e" "none") ("%h")))
149 (tramp-async-args (("-q")))
150 (tramp-remote-shell "/bin/sh")
151 (tramp-remote-shell-args ("-c"))
152 (tramp-copy-program "scp")
153 (tramp-copy-args (("-2") ("-P" "%p") ("-p" "%k") ("-q") ("-r")))
154 (tramp-copy-keep-date t
)
155 (tramp-copy-recursive t
)
156 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
157 ("-o" "UserKnownHostsFile=/dev/null")
158 ("-o" "StrictHostKeyChecking=no")))
159 (tramp-default-port 22)))
161 (add-to-list 'tramp-methods
163 (tramp-login-program "ssh")
164 (tramp-login-args (("-l" "%u") ("-p" "%p")
165 ("-o" "ControlPath=%t.%%r@%%h:%%p")
166 ("-o" "ControlMaster=yes")
167 ("-e" "none") ("%h")))
168 (tramp-async-args (("-q")))
169 (tramp-remote-shell "/bin/sh")
170 (tramp-remote-shell-args ("-c"))
171 (tramp-copy-program "scp")
172 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")
173 ("-o" "ControlPath=%t.%%r@%%h:%%p")
174 ("-o" "ControlMaster=auto")))
175 (tramp-copy-keep-date t
)
176 (tramp-copy-recursive t
)
177 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
178 ("-o" "UserKnownHostsFile=/dev/null")
179 ("-o" "StrictHostKeyChecking=no")))
180 (tramp-default-port 22)))
182 (add-to-list 'tramp-methods
184 (tramp-login-program "ssh")
185 (tramp-login-args (("-l" "%u") ("-p" "%p")
186 ("-e" "none") ("-t" "-t")
188 (tramp-async-args (("-q")))
189 (tramp-remote-shell "/bin/sh")
190 (tramp-remote-shell-args ("-c"))
191 (tramp-copy-program "scp")
192 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")))
193 (tramp-copy-keep-date t
)
194 (tramp-copy-recursive t
)
195 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
196 ("-o" "UserKnownHostsFile=/dev/null")
197 ("-o" "StrictHostKeyChecking=no")))
198 (tramp-default-port 22)))
200 (add-to-list 'tramp-methods
202 (tramp-login-program "ssh")
203 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
204 (tramp-async-args (("-q")))
205 (tramp-remote-shell "/bin/sh")
206 (tramp-remote-shell-args ("-c"))
207 (tramp-copy-program "sftp")))
209 (add-to-list 'tramp-methods
211 (tramp-login-program "ssh")
212 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
213 (tramp-async-args (("-q")))
214 (tramp-remote-shell "/bin/sh")
215 (tramp-remote-shell-args ("-c"))
216 (tramp-copy-program "rsync")
217 (tramp-copy-args (("-e" "ssh") ("-t" "%k") ("-r")))
218 (tramp-copy-keep-date t
)
219 (tramp-copy-keep-tmpfile t
)
220 (tramp-copy-recursive t
)))
222 (add-to-list 'tramp-methods
224 (tramp-login-program "ssh")
225 (tramp-login-args (("-l" "%u") ("-p" "%p")
226 ("-o" "ControlPath=%t.%%r@%%h:%%p")
227 ("-o" "ControlMaster=yes")
228 ("-e" "none") ("%h")))
229 (tramp-async-args (("-q")))
230 (tramp-remote-shell "/bin/sh")
231 (tramp-remote-shell-args ("-c"))
232 (tramp-copy-program "rsync")
233 (tramp-copy-args (("-t" "%k") ("-r")))
234 (tramp-copy-env (("RSYNC_RSH")
237 " -o ControlPath=%t.%%r@%%h:%%p"
238 " -o ControlMaster=auto"))))
239 (tramp-copy-keep-date t
)
240 (tramp-copy-keep-tmpfile t
)
241 (tramp-copy-recursive t
)))
243 (add-to-list 'tramp-methods
245 (tramp-login-program "rsh")
246 (tramp-login-args (("%h") ("-l" "%u")))
247 (tramp-remote-shell "/bin/sh")
248 (tramp-remote-shell-args ("-c"))))
250 (add-to-list 'tramp-methods
252 (tramp-login-program "remsh")
253 (tramp-login-args (("%h") ("-l" "%u")))
254 (tramp-remote-shell "/bin/sh")
255 (tramp-remote-shell-args ("-c"))))
257 (add-to-list 'tramp-methods
259 (tramp-login-program "ssh")
260 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
261 (tramp-async-args (("-q")))
262 (tramp-remote-shell "/bin/sh")
263 (tramp-remote-shell-args ("-c"))
264 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
265 ("-o" "UserKnownHostsFile=/dev/null")
266 ("-o" "StrictHostKeyChecking=no")))
267 (tramp-default-port 22)))
269 (add-to-list 'tramp-methods
271 (tramp-login-program "ssh")
272 (tramp-login-args (("-l" "%u") ("-p" "%p")
273 ("-1") ("-e" "none") ("%h")))
274 (tramp-async-args (("-q")))
275 (tramp-remote-shell "/bin/sh")
276 (tramp-remote-shell-args ("-c"))
277 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
278 ("-o" "UserKnownHostsFile=/dev/null")
279 ("-o" "StrictHostKeyChecking=no")))
280 (tramp-default-port 22)))
282 (add-to-list 'tramp-methods
284 (tramp-login-program "ssh")
285 (tramp-login-args (("-l" "%u") ("-p" "%p")
286 ("-2") ("-e" "none") ("%h")))
287 (tramp-async-args (("-q")))
288 (tramp-remote-shell "/bin/sh")
289 (tramp-remote-shell-args ("-c"))
290 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
291 ("-o" "UserKnownHostsFile=/dev/null")
292 ("-o" "StrictHostKeyChecking=no")))
293 (tramp-default-port 22)))
295 (add-to-list 'tramp-methods
297 (tramp-login-program "ssh")
298 (tramp-login-args (("-l" "%u") ("-p" "%p")
299 ("-e" "none") ("-t" "-t")
301 (tramp-async-args (("-q")))
302 (tramp-remote-shell "/bin/sh")
303 (tramp-remote-shell-args ("-c"))
304 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
305 ("-o" "UserKnownHostsFile=/dev/null")
306 ("-o" "StrictHostKeyChecking=no")))
307 (tramp-default-port 22)))
309 (add-to-list 'tramp-methods
311 (tramp-login-program "telnet")
312 (tramp-login-args (("%h") ("%p")))
313 (tramp-remote-shell "/bin/sh")
314 (tramp-remote-shell-args ("-c"))
315 (tramp-default-port 23)))
317 (add-to-list 'tramp-methods
319 (tramp-login-program "su")
320 (tramp-login-args (("-") ("%u")))
321 (tramp-remote-shell "/bin/sh")
322 (tramp-remote-shell-args ("-c"))))
324 (add-to-list 'tramp-methods
326 (tramp-login-program "sudo")
327 (tramp-login-args (("-u" "%u") ("-s") ("-H") ("-p" "Password:")))
328 (tramp-remote-shell "/bin/sh")
329 (tramp-remote-shell-args ("-c"))))
331 (add-to-list 'tramp-methods
333 (tramp-login-program "ksu")
334 (tramp-login-args (("%u") ("-q")))
335 (tramp-remote-shell "/bin/sh")
336 (tramp-remote-shell-args ("-c"))))
338 (add-to-list 'tramp-methods
340 (tramp-login-program "krlogin")
341 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
342 (tramp-remote-shell "/bin/sh")
343 (tramp-remote-shell-args ("-c"))))
345 (add-to-list 'tramp-methods
347 (tramp-login-program "plink")
348 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
349 (tramp-remote-shell "/bin/sh")
350 (tramp-remote-shell-args ("-c"))
351 (tramp-default-port 22)))
353 (add-to-list 'tramp-methods
355 (tramp-login-program "plink")
356 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-1" "-ssh") ("%h")))
357 (tramp-remote-shell "/bin/sh")
358 (tramp-remote-shell-args ("-c"))
359 (tramp-default-port 22)))
361 (add-to-list 'tramp-methods
363 (tramp-login-program "plink")
364 ;; ("%h") must be a single element, see
365 ;; `tramp-compute-multi-hops'.
366 (tramp-login-args (("-load") ("%h") ("-t")
368 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
370 tramp-initial-end-of-output
))
372 (tramp-remote-shell "/bin/sh")
373 (tramp-remote-shell-args ("-c"))))
375 (add-to-list 'tramp-methods
377 (tramp-login-program "plink")
378 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
379 (tramp-remote-shell "/bin/sh")
380 (tramp-remote-shell-args ("-c"))
381 (tramp-copy-program "pscp")
382 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-scp") ("-p" "%k")
384 (tramp-copy-keep-date t
)
385 (tramp-copy-recursive t
)
386 (tramp-default-port 22)))
388 (add-to-list 'tramp-methods
390 (tramp-login-program "plink")
391 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
392 (tramp-remote-shell "/bin/sh")
393 (tramp-remote-shell-args ("-c"))
394 (tramp-copy-program "pscp")
395 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-sftp") ("-p" "%k")
397 (tramp-copy-keep-date t
)
398 (tramp-copy-recursive t
)))
400 (add-to-list 'tramp-methods
402 (tramp-login-program "fsh")
403 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
404 (tramp-remote-shell "/bin/sh")
405 (tramp-remote-shell-args ("-i") ("-c"))
406 (tramp-copy-program "fcp")
407 (tramp-copy-args (("-p" "%k")))
408 (tramp-copy-keep-date t
)))
411 (add-to-list 'tramp-default-method-alist
412 `(,tramp-local-host-regexp
"\\`root\\'" "su"))
415 (add-to-list 'tramp-default-user-alist
416 `(,(concat "\\`" (regexp-opt '("su" "sudo" "ksu")) "\\'")
418 ;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
419 ;; Do not add "plink" based methods, they ask interactively for the user.
421 (add-to-list 'tramp-default-user-alist
424 (regexp-opt '("rcp" "remcp" "rsh" "telnet" "krlogin" "fcp"))
426 nil
,(user-login-name)))
429 (defconst tramp-completion-function-alist-rsh
430 '((tramp-parse-rhosts "/etc/hosts.equiv")
431 (tramp-parse-rhosts "~/.rhosts"))
432 "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")
435 (defconst tramp-completion-function-alist-ssh
436 '((tramp-parse-rhosts "/etc/hosts.equiv")
437 (tramp-parse-rhosts "/etc/shosts.equiv")
438 (tramp-parse-shosts "/etc/ssh_known_hosts")
439 (tramp-parse-sconfig "/etc/ssh_config")
440 (tramp-parse-shostkeys "/etc/ssh2/hostkeys")
441 (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
442 (tramp-parse-rhosts "~/.rhosts")
443 (tramp-parse-rhosts "~/.shosts")
444 (tramp-parse-shosts "~/.ssh/known_hosts")
445 (tramp-parse-sconfig "~/.ssh/config")
446 (tramp-parse-shostkeys "~/.ssh2/hostkeys")
447 (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
448 "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")
451 (defconst tramp-completion-function-alist-telnet
452 '((tramp-parse-hosts "/etc/hosts"))
453 "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")
456 (defconst tramp-completion-function-alist-su
457 '((tramp-parse-passwd "/etc/passwd"))
458 "Default list of (FUNCTION FILE) pairs to be examined for su methods.")
461 (defconst tramp-completion-function-alist-putty
463 ,(if (memq system-type
'(windows-nt))
464 "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"
465 "~/.putty/sessions")))
466 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty sessions.")
469 (eval-after-load 'tramp
471 (tramp-set-completion-function "rcp" tramp-completion-function-alist-rsh
)
472 (tramp-set-completion-function "remcp" tramp-completion-function-alist-rsh
)
473 (tramp-set-completion-function "scp" tramp-completion-function-alist-ssh
)
474 (tramp-set-completion-function "scp1" tramp-completion-function-alist-ssh
)
475 (tramp-set-completion-function "scp2" tramp-completion-function-alist-ssh
)
476 (tramp-set-completion-function "scpc" tramp-completion-function-alist-ssh
)
477 (tramp-set-completion-function "scpx" tramp-completion-function-alist-ssh
)
478 (tramp-set-completion-function "sftp" tramp-completion-function-alist-ssh
)
479 (tramp-set-completion-function "rsync" tramp-completion-function-alist-ssh
)
480 (tramp-set-completion-function
481 "rsyncc" tramp-completion-function-alist-ssh
)
482 (tramp-set-completion-function "rsh" tramp-completion-function-alist-rsh
)
483 (tramp-set-completion-function "remsh" tramp-completion-function-alist-rsh
)
484 (tramp-set-completion-function "ssh" tramp-completion-function-alist-ssh
)
485 (tramp-set-completion-function "ssh1" tramp-completion-function-alist-ssh
)
486 (tramp-set-completion-function "ssh2" tramp-completion-function-alist-ssh
)
487 (tramp-set-completion-function
488 "ssh1_old" tramp-completion-function-alist-ssh
)
489 (tramp-set-completion-function
490 "ssh2_old" tramp-completion-function-alist-ssh
)
491 (tramp-set-completion-function "sshx" tramp-completion-function-alist-ssh
)
492 (tramp-set-completion-function
493 "telnet" tramp-completion-function-alist-telnet
)
494 (tramp-set-completion-function "su" tramp-completion-function-alist-su
)
495 (tramp-set-completion-function "sudo" tramp-completion-function-alist-su
)
496 (tramp-set-completion-function "ksu" tramp-completion-function-alist-su
)
497 (tramp-set-completion-function
498 "krlogin" tramp-completion-function-alist-rsh
)
499 (tramp-set-completion-function "plink" tramp-completion-function-alist-ssh
)
500 (tramp-set-completion-function
501 "plink1" tramp-completion-function-alist-ssh
)
502 (tramp-set-completion-function
503 "plinkx" tramp-completion-function-alist-putty
)
504 (tramp-set-completion-function "pscp" tramp-completion-function-alist-ssh
)
505 (tramp-set-completion-function "fcp" tramp-completion-function-alist-ssh
)))
507 ;; "getconf PATH" yields:
508 ;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
509 ;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
510 ;; GNU/Linux (Debian, Suse): /bin:/usr/bin
511 ;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
514 (defcustom tramp-remote-path
515 '(tramp-default-remote-path "/bin" "/usr/bin" "/sbin" "/usr/sbin"
516 "/usr/local/bin" "/usr/local/sbin" "/local/bin" "/local/freeware/bin"
517 "/local/gnu/bin" "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin"
518 "/opt/bin" "/opt/sbin" "/opt/local/bin")
519 "List of directories to search for executables on remote host.
520 For every remote host, this variable will be set buffer local,
521 keeping the list of existing directories on that host.
523 You can use `~' in this list, but when searching for a shell which groks
524 tilde expansion, all directory names starting with `~' will be ignored.
526 `Default Directories' represent the list of directories given by
527 the command \"getconf PATH\". It is recommended to use this
528 entry on top of this list, because these are the default
529 directories for POSIX compatible commands. On remote hosts which
530 do not offer the getconf command (like cygwin), the value
531 \"/bin:/usr/bin\" is used instead of.
533 `Private Directories' are the settings of the $PATH environment,
534 as given in your `~/.profile'."
536 :type
'(repeat (choice
537 (const :tag
"Default Directories" tramp-default-remote-path
)
538 (const :tag
"Private Directories" tramp-own-remote-path
)
539 (string :tag
"Directory"))))
541 (defcustom tramp-remote-process-environment
542 `("HISTFILE=$HOME/.tramp_history" "HISTSIZE=1" "LC_ALL=C"
543 ,(format "TERM=%s" tramp-terminal-type
)
544 "EMACS=t" ;; Deprecated.
545 ,(format "INSIDE_EMACS='%s,tramp:%s'" emacs-version tramp-version
)
546 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH=" "PAGER=\"\""
547 "autocorrect=" "correct=")
548 "List of environment variables to be set on the remote host.
550 Each element should be a string of the form ENVVARNAME=VALUE. An
551 entry ENVVARNAME= disables the corresponding environment variable,
552 which might have been set in the init files like ~/.profile.
554 Special handling is applied to the PATH environment, which should
555 not be set here. Instead, it should be set via `tramp-remote-path'."
557 :type
'(repeat string
))
559 (defcustom tramp-sh-extra-args
'(("/bash\\'" .
"-norc -noprofile"))
560 "Alist specifying extra arguments to pass to the remote shell.
561 Entries are (REGEXP . ARGS) where REGEXP is a regular expression
562 matching the shell file name and ARGS is a string specifying the
565 This variable is only used when Tramp needs to start up another shell
566 for tilde expansion. The extra arguments should typically prevent the
567 shell from reading its init file."
569 ;; This might be the wrong way to test whether the widget type
570 ;; `alist' is available. Who knows the right way to test it?
571 :type
(if (get 'alist
'widget-type
)
572 '(alist :key-type string
:value-type string
)
573 '(repeat (cons string string
))))
575 (defconst tramp-actions-before-shell
576 '((tramp-login-prompt-regexp tramp-action-login
)
577 (tramp-password-prompt-regexp tramp-action-password
)
578 (tramp-wrong-passwd-regexp tramp-action-permission-denied
)
579 (shell-prompt-pattern tramp-action-succeed
)
580 (tramp-shell-prompt-pattern tramp-action-succeed
)
581 (tramp-yesno-prompt-regexp tramp-action-yesno
)
582 (tramp-yn-prompt-regexp tramp-action-yn
)
583 (tramp-terminal-prompt-regexp tramp-action-terminal
)
584 (tramp-process-alive-regexp tramp-action-process-alive
))
585 "List of pattern/action pairs.
586 Whenever a pattern matches, the corresponding action is performed.
587 Each item looks like (PATTERN ACTION).
589 The PATTERN should be a symbol, a variable. The value of this
590 variable gives the regular expression to search for. Note that the
591 regexp must match at the end of the buffer, \"\\'\" is implicitly
594 The ACTION should also be a symbol, but a function. When the
595 corresponding PATTERN matches, the ACTION function is called.")
597 (defconst tramp-actions-copy-out-of-band
598 '((tramp-password-prompt-regexp tramp-action-password
)
599 (tramp-wrong-passwd-regexp tramp-action-permission-denied
)
600 (tramp-copy-failed-regexp tramp-action-permission-denied
)
601 (tramp-process-alive-regexp tramp-action-out-of-band
))
602 "List of pattern/action pairs.
603 This list is used for copying/renaming with out-of-band methods.
605 See `tramp-actions-before-shell' for more info.")
607 (defconst tramp-uudecode
608 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
611 "Shell function to implement `uudecode' to standard output.
612 Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
613 for this or `uudecode -p', but some systems don't, and for them
614 we have this shell function.")
616 (defconst tramp-perl-file-truename
619 use Cwd \"realpath\";
622 my ($volume, @dirs) = @_;
623 my $real = realpath(File::Spec->catpath(
624 $volume, File::Spec->catdir(@dirs), \"\"));
626 my ($vol, $dir) = File::Spec->splitpath($real, 1);
627 return ($vol, File::Spec->splitdir($dir));
630 my $last = pop(@dirs);
631 ($volume, @dirs) = recursive($volume, @dirs);
633 return ($volume, @dirs);
637 $result = realpath($ARGV[0]);
639 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
640 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
642 $result = File::Spec->catpath($vol, File::Spec->catdir(@dirs), \"\");
645 if ($ARGV[0] =~ /\\/$/) {
646 $result = $result . \"/\";
649 print \"\\\"$result\\\"\\n\";
650 ' \"$1\" 2>/dev/null"
651 "Perl script to produce output suitable for use with `file-truename'
652 on the remote file system.
653 Escape sequence %s is replaced with name of Perl binary.
654 This string is passed to `format', so percent characters need to be doubled.")
656 (defconst tramp-perl-file-name-all-completions
666 opendir(d, $ARGV[0]) || die(\"$ARGV[0]: $!\\nfail\\n\");
667 @files = readdir(d); closedir(d);
668 foreach $f (@files) {
669 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
670 if (-d \"$ARGV[0]/$f\") {
679 ' \"$1\" \"$2\" \"$3\" 2>/dev/null"
680 "Perl script to produce output suitable for use with
681 `file-name-all-completions' on the remote file system. Escape
682 sequence %s is replaced with name of Perl binary. This string is
683 passed to `format', so percent characters need to be doubled.")
685 ;; Perl script to implement `file-attributes' in a Lisp `read'able
686 ;; output. If you are hacking on this, note that you get *no* output
687 ;; unless this spits out a complete line, including the '\n' at the
689 ;; The device number is returned as "-1", because there will be a virtual
690 ;; device number set in `tramp-sh-handle-file-attributes'.
691 (defconst tramp-perl-file-attributes
693 @stat = lstat($ARGV[0]);
698 if (($stat[2] & 0170000) == 0120000)
700 $type = readlink($ARGV[0]);
701 $type = \"\\\"$type\\\"\";
703 elsif (($stat[2] & 0170000) == 040000)
711 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
712 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
714 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
719 $stat[8] >> 16 & 0xffff,
721 $stat[9] >> 16 & 0xffff,
723 $stat[10] >> 16 & 0xffff,
727 $stat[1] >> 16 & 0xffff,
729 );' \"$1\" \"$2\" 2>/dev/null"
730 "Perl script to produce output suitable for use with `file-attributes'
731 on the remote file system.
732 Escape sequence %s is replaced with name of Perl binary.
733 This string is passed to `format', so percent characters need to be doubled.")
735 (defconst tramp-perl-directory-files-and-attributes
737 chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
738 opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
739 @list = readdir(DIR);
743 for($i = 0; $i < $n; $i++)
745 $filename = $list[$i];
746 @stat = lstat($filename);
747 if (($stat[2] & 0170000) == 0120000)
749 $type = readlink($filename);
750 $type = \"\\\"$type\\\"\";
752 elsif (($stat[2] & 0170000) == 040000)
760 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
761 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
763 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
769 $stat[8] >> 16 & 0xffff,
771 $stat[9] >> 16 & 0xffff,
773 $stat[10] >> 16 & 0xffff,
777 $stat[1] >> 16 & 0xffff,
779 $stat[0] >> 16 & 0xffff,
782 printf(\")\\n\");' \"$1\" \"$2\" 2>/dev/null"
783 "Perl script implementing `directory-files-attributes' as Lisp `read'able
785 Escape sequence %s is replaced with name of Perl binary.
786 This string is passed to `format', so percent characters need to be doubled.")
788 ;; These two use base64 encoding.
789 (defconst tramp-perl-encode-with-module
790 "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
791 "Perl program to use for encoding a file.
792 Escape sequence %s is replaced with name of Perl binary.
793 This string is passed to `format', so percent characters need to be doubled.
794 This implementation requires the MIME::Base64 Perl module to be installed
795 on the remote host.")
797 (defconst tramp-perl-decode-with-module
798 "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
799 "Perl program to use for decoding a file.
800 Escape sequence %s is replaced with name of Perl binary.
801 This string is passed to `format', so percent characters need to be doubled.
802 This implementation requires the MIME::Base64 Perl module to be installed
803 on the remote host.")
805 (defconst tramp-perl-encode
807 # This script contributed by Juanma Barranquero <lektu@terra.es>.
808 # Copyright (C) 2002-2013 Free Software Foundation, Inc.
813 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
814 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
818 # We read in chunks of 54 bytes, to generate output lines
819 # of 72 chars (plus end of line)
820 while (read STDIN, $data, 54) {
823 # Only for the last chunk, and only if did not fill the last three-byte packet
825 my $mod = length($data) %% 3;
826 $pad = q(=) x (3 - $mod) if $mod;
829 # Not the fastest method, but it is simple: unpack to binary string, split
830 # by groups of 6 bits and convert back from binary to byte; then map into
831 # the translation table
835 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
839 "Perl program to use for encoding a file.
840 Escape sequence %s is replaced with name of Perl binary.
841 This string is passed to `format', so percent characters need to be doubled.")
843 (defconst tramp-perl-decode
845 # This script contributed by Juanma Barranquero <lektu@terra.es>.
846 # Copyright (C) 2002-2013 Free Software Foundation, Inc.
851 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
852 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
855 my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
859 # We are going to accumulate into $pending to accept any line length
860 # (we do not check they are <= 76 chars as the RFC says)
863 while (my $data = <STDIN>) {
866 # If we find one or two =, we have reached the end and
867 # any following data is to be discarded
868 my $finished = $data =~ s/(==?).*/$1/;
871 my $len = length($pending);
872 my $chunk = substr($pending, 0, $len & ~3);
873 $pending = substr($pending, $len & ~3 + 1);
875 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
876 # split in 8-bit chunks and convert back to char.
879 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
883 "Perl program to use for decoding a file.
884 Escape sequence %s is replaced with name of Perl binary.
885 This string is passed to `format', so percent characters need to be doubled.")
887 (defconst tramp-vc-registered-read-file-names
890 if %s \"$file\"; then
891 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" t)\"
893 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" nil)\"
895 if %s \"$file\"; then
896 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" t)\"
898 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" nil)\"
902 "Script to check existence of VC related files.
903 It must be send formatted with two strings; the tests for file
904 existence, and file readability. Input shall be read via
905 here-document, otherwise the command could exceed maximum length
908 (defconst tramp-file-mode-type-map
909 '((0 .
"-") ; Normal file (SVID-v2 and XPG2)
911 (2 .
"c") ; character device
912 (3 .
"m") ; multiplexed character device (v7)
913 (4 .
"d") ; directory
914 (5 .
"?") ; Named special file (XENIX)
915 (6 .
"b") ; block device
916 (7 .
"?") ; multiplexed block device (v7)
917 (8 .
"-") ; regular file
918 (9 .
"n") ; network special file (HP-UX)
920 (11 .
"?") ; ACL shadow inode (Solaris, not userspace)
922 (13 .
"D") ; door special (Solaris)
923 (14 .
"w")) ; whiteout (BSD)
924 "A list of file types returned from the `stat' system call.
925 This is used to map a mode number to a permission string.")
927 ;; New handlers should be added here. The following operations can be
928 ;; handled using the normal primitives: file-name-sans-versions,
930 (defconst tramp-sh-file-name-handler-alist
931 '((load . tramp-handle-load
)
932 (make-symbolic-link . tramp-sh-handle-make-symbolic-link
)
933 (file-name-as-directory . tramp-handle-file-name-as-directory
)
934 (file-name-directory . tramp-handle-file-name-directory
)
935 (file-name-nondirectory . tramp-handle-file-name-nondirectory
)
936 (file-truename . tramp-sh-handle-file-truename
)
937 (file-exists-p . tramp-sh-handle-file-exists-p
)
938 (file-accessible-directory-p . tramp-handle-file-accessible-directory-p
)
939 (file-directory-p . tramp-sh-handle-file-directory-p
)
940 (file-executable-p . tramp-sh-handle-file-executable-p
)
941 (file-readable-p . tramp-sh-handle-file-readable-p
)
942 (file-regular-p . tramp-handle-file-regular-p
)
943 (file-symlink-p . tramp-handle-file-symlink-p
)
944 (file-writable-p . tramp-sh-handle-file-writable-p
)
945 (file-ownership-preserved-p . tramp-sh-handle-file-ownership-preserved-p
)
946 (file-newer-than-file-p . tramp-sh-handle-file-newer-than-file-p
)
947 (file-attributes . tramp-sh-handle-file-attributes
)
948 (file-modes . tramp-handle-file-modes
)
949 (directory-files . tramp-handle-directory-files
)
950 (directory-files-and-attributes
951 . tramp-sh-handle-directory-files-and-attributes
)
952 (file-name-all-completions . tramp-sh-handle-file-name-all-completions
)
953 (file-name-completion . tramp-handle-file-name-completion
)
954 (add-name-to-file . tramp-sh-handle-add-name-to-file
)
955 (copy-file . tramp-sh-handle-copy-file
)
956 (copy-directory . tramp-sh-handle-copy-directory
)
957 (rename-file . tramp-sh-handle-rename-file
)
958 (set-file-modes . tramp-sh-handle-set-file-modes
)
959 (set-file-times . tramp-sh-handle-set-file-times
)
960 (make-directory . tramp-sh-handle-make-directory
)
961 (delete-directory . tramp-sh-handle-delete-directory
)
962 (delete-file . tramp-sh-handle-delete-file
)
963 (directory-file-name . tramp-handle-directory-file-name
)
964 ;; `executable-find' is not official yet.
965 (executable-find . tramp-sh-handle-executable-find
)
966 (start-file-process . tramp-sh-handle-start-file-process
)
967 (process-file . tramp-sh-handle-process-file
)
968 (shell-command . tramp-handle-shell-command
)
969 (insert-directory . tramp-sh-handle-insert-directory
)
970 (expand-file-name . tramp-sh-handle-expand-file-name
)
971 (substitute-in-file-name . tramp-handle-substitute-in-file-name
)
972 (file-local-copy . tramp-sh-handle-file-local-copy
)
973 (file-remote-p . tramp-handle-file-remote-p
)
974 (insert-file-contents . tramp-handle-insert-file-contents
)
975 (insert-file-contents-literally
976 . tramp-sh-handle-insert-file-contents-literally
)
977 (write-region . tramp-sh-handle-write-region
)
978 (find-backup-file-name . tramp-handle-find-backup-file-name
)
979 (make-auto-save-file-name . tramp-sh-handle-make-auto-save-file-name
)
980 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory
)
981 (dired-compress-file . tramp-sh-handle-dired-compress-file
)
982 (dired-recursive-delete-directory
983 . tramp-sh-handle-dired-recursive-delete-directory
)
984 (dired-uncache . tramp-handle-dired-uncache
)
985 (set-visited-file-modtime . tramp-sh-handle-set-visited-file-modtime
)
986 (verify-visited-file-modtime . tramp-sh-handle-verify-visited-file-modtime
)
987 (file-selinux-context . tramp-sh-handle-file-selinux-context
)
988 (set-file-selinux-context . tramp-sh-handle-set-file-selinux-context
)
989 (file-acl . tramp-sh-handle-file-acl
)
990 (set-file-acl . tramp-sh-handle-set-file-acl
)
991 (vc-registered . tramp-sh-handle-vc-registered
))
992 "Alist of handler functions.
993 Operations not mentioned here will be handled by the normal Emacs functions.")
995 ;; This must be the last entry, because `identity' always matches.
997 (add-to-list 'tramp-foreign-file-name-handler-alist
998 '(identity . tramp-sh-file-name-handler
) 'append
)
1000 ;;; File Name Handler Functions:
1002 (defun tramp-sh-handle-make-symbolic-link
1003 (filename linkname
&optional ok-if-already-exists
)
1004 "Like `make-symbolic-link' for Tramp files.
1005 If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1006 the symlink. If LINKNAME is a Tramp file, only the localname component is
1007 used as the target of the symlink.
1009 If LINKNAME is a Tramp file and the localname component is relative, then
1010 it is expanded first, before the localname component is taken. Note that
1011 this can give surprising results if the user/host for the source and
1012 target of the symlink differ."
1013 (with-parsed-tramp-file-name linkname l
1014 (let ((ln (tramp-get-remote-ln l
))
1015 (cwd (tramp-run-real-handler
1016 'file-name-directory
(list l-localname
))))
1020 "Making a symbolic link. ln(1) does not exist on the remote host."))
1022 ;; Do the 'confirm if exists' thing.
1023 (when (file-exists-p linkname
)
1025 (if (or (null ok-if-already-exists
) ; not allowed to exist
1026 (and (numberp ok-if-already-exists
)
1029 "File %s already exists; make it a link anyway? "
1032 l
'file-already-exists
"File %s already exists" l-localname
)
1033 (delete-file linkname
)))
1035 ;; If FILENAME is a Tramp name, use just the localname component.
1036 (when (tramp-tramp-file-p filename
)
1038 (tramp-file-name-localname
1039 (tramp-dissect-file-name (expand-file-name filename
)))))
1041 (tramp-flush-file-property l
(file-name-directory l-localname
))
1042 (tramp-flush-file-property l l-localname
)
1044 ;; Right, they are on the same host, regardless of user, method,
1045 ;; etc. We now make the link on the remote machine. This will
1046 ;; occur as the user that FILENAME belongs to.
1047 (tramp-send-command-and-check
1050 "cd %s && %s -sf %s %s"
1051 (tramp-shell-quote-argument cwd
)
1053 (tramp-shell-quote-argument filename
)
1054 (tramp-shell-quote-argument l-localname
))
1057 (defun tramp-sh-handle-file-truename (filename &optional counter prev-dirs
)
1058 "Like `file-truename' for Tramp files."
1059 (with-parsed-tramp-file-name (expand-file-name filename
) nil
1060 (tramp-make-tramp-file-name method user host
1061 (with-tramp-file-property v localname
"file-truename"
1062 (let ((result nil
)) ; result steps in reverse order
1063 (tramp-message v
4 "Finding true name for `%s'" filename
)
1065 ;; Use GNU readlink --canonicalize-missing where available.
1066 ((tramp-get-remote-readlink v
)
1068 (tramp-send-command-and-read
1070 (format "echo \"\\\"`%s --canonicalize-missing %s`\\\"\""
1071 (tramp-get-remote-readlink v
)
1072 (tramp-shell-quote-argument localname
)))))
1074 ;; Use Perl implementation.
1075 ((and (tramp-get-remote-perl v
)
1076 (tramp-get-connection-property v
"perl-file-spec" nil
)
1077 (tramp-get-connection-property v
"perl-cwd-realpath" nil
))
1078 (tramp-maybe-send-script
1079 v tramp-perl-file-truename
"tramp_perl_file_truename")
1081 (tramp-send-command-and-read
1083 (format "tramp_perl_file_truename %s"
1084 (tramp-shell-quote-argument localname
)))))
1086 ;; Do it yourself. We bind `directory-sep-char' here for
1087 ;; XEmacs on Windows, which would otherwise use backslash.
1088 (t (let* ((directory-sep-char ?
/)
1089 (steps (tramp-compat-split-string localname
"/"))
1090 (localnamedir (tramp-run-real-handler
1091 'file-name-as-directory
(list localname
)))
1092 (is-dir (string= localname localnamedir
))
1095 ;; Don't make the following value larger than
1096 ;; necessary. People expect an error message in
1097 ;; a timely fashion when something is wrong;
1098 ;; otherwise they might think that Emacs is hung.
1099 ;; Of course, correctness has to come first.
1102 (while (and steps
(< numchase numchase-limit
))
1103 (setq thisstep
(pop steps
))
1106 (mapconcat 'identity
1107 (append '("") (reverse result
) (list thisstep
))
1109 (setq symlink-target
1110 (nth 0 (file-attributes
1111 (tramp-make-tramp-file-name
1113 (mapconcat 'identity
1118 (cond ((string= "." thisstep
)
1119 (tramp-message v
5 "Ignoring step `.'"))
1120 ((string= ".." thisstep
)
1121 (tramp-message v
5 "Processing step `..'")
1123 ((stringp symlink-target
)
1124 ;; It's a symlink, follow it.
1126 v
5 "Follow symlink to %s" symlink-target
)
1127 (setq numchase
(1+ numchase
))
1128 (when (file-name-absolute-p symlink-target
)
1130 ;; If the symlink was absolute, we'll get a
1131 ;; string like "/user@host:/some/target";
1132 ;; extract the "/some/target" part from it.
1133 (when (tramp-tramp-file-p symlink-target
)
1134 (unless (tramp-equal-remote filename symlink-target
)
1137 "Symlink target `%s' on wrong host"
1139 (setq symlink-target localname
))
1141 (append (tramp-compat-split-string
1146 (setq result
(cons thisstep result
)))))
1147 (when (>= numchase numchase-limit
)
1150 "Maximum number (%d) of symlinks exceeded" numchase-limit
))
1151 (setq result
(reverse result
))
1152 ;; Combine list to form string.
1155 (mapconcat 'identity
(cons "" result
) "/")
1158 (or (string= "" result
)
1159 (not (string= (substring result -
1) "/"))))
1160 (setq result
(concat result
"/"))))))
1162 (tramp-message v
4 "True name of `%s' is `%s'" localname result
)
1167 (defun tramp-sh-handle-file-exists-p (filename)
1168 "Like `file-exists-p' for Tramp files."
1169 (with-parsed-tramp-file-name filename nil
1170 (with-tramp-file-property v localname
"file-exists-p"
1171 (or (not (null (tramp-get-file-property
1172 v localname
"file-attributes-integer" nil
)))
1173 (not (null (tramp-get-file-property
1174 v localname
"file-attributes-string" nil
)))
1175 (tramp-send-command-and-check
1179 (tramp-get-file-exists-command v
)
1180 (tramp-shell-quote-argument localname
)))))))
1182 (defun tramp-sh-handle-file-attributes (filename &optional id-format
)
1183 "Like `file-attributes' for Tramp files."
1184 (unless id-format
(setq id-format
'integer
))
1185 ;; Don't modify `last-coding-system-used' by accident.
1186 (let ((last-coding-system-used last-coding-system-used
))
1187 (with-parsed-tramp-file-name (expand-file-name filename
) nil
1188 (with-tramp-file-property
1189 v localname
(format "file-attributes-%s" id-format
)
1191 (tramp-convert-file-attributes
1195 ((tramp-get-remote-stat v
)
1196 (tramp-do-file-attributes-with-stat v localname id-format
))
1197 ((tramp-get-remote-perl v
)
1198 (tramp-do-file-attributes-with-perl v localname id-format
))
1200 ;; The scripts could fail, for example with huge file size.
1201 (tramp-do-file-attributes-with-ls v localname id-format
))))))))
1203 (defun tramp-do-file-attributes-with-ls (vec localname
&optional id-format
)
1204 "Implement `file-attributes' for Tramp files using the ls(1) command."
1206 res-inode res-filemodes res-numlinks
1207 res-uid res-gid res-size res-symlink-target
)
1208 (tramp-message vec
5 "file attributes with ls: %s" localname
)
1211 (format "(%s %s || %s -h %s) && %s %s %s"
1212 (tramp-get-file-exists-command vec
)
1213 (tramp-shell-quote-argument localname
)
1214 (tramp-get-test-command vec
)
1215 (tramp-shell-quote-argument localname
)
1216 (tramp-get-ls-command vec
)
1217 (if (eq id-format
'integer
) "-ildn" "-ild")
1218 (tramp-shell-quote-argument localname
)))
1219 ;; parse `ls -l' output ...
1220 (with-current-buffer (tramp-get-buffer vec
)
1221 (when (> (buffer-size) 0)
1222 (goto-char (point-min))
1226 (read (current-buffer))
1227 (invalid-read-syntax
1228 (when (and (equal (cadr err
)
1229 "Integer constant overflow in reader")
1231 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
1233 (let* ((big (read (substring (car (cddr err
)) 0
1234 (match-beginning 1))))
1235 (small (read (match-string 1 (car (cddr err
)))))
1236 (twiddle (/ small
65536)))
1237 (cons (+ big twiddle
)
1238 (- small
(* twiddle
65536))))))))
1239 ;; ... file mode flags
1240 (setq res-filemodes
(symbol-name (read (current-buffer))))
1242 (setq res-numlinks
(read (current-buffer)))
1244 (setq res-uid
(read (current-buffer)))
1245 (setq res-gid
(read (current-buffer)))
1246 (if (eq id-format
'integer
)
1248 (unless (numberp res-uid
) (setq res-uid -
1))
1249 (unless (numberp res-gid
) (setq res-gid -
1)))
1251 (unless (stringp res-uid
) (setq res-uid
(symbol-name res-uid
)))
1252 (unless (stringp res-gid
) (setq res-gid
(symbol-name res-gid
)))))
1254 (setq res-size
(read (current-buffer)))
1255 ;; From the file modes, figure out other stuff.
1256 (setq symlinkp
(eq ?l
(aref res-filemodes
0)))
1257 (setq dirp
(eq ?d
(aref res-filemodes
0)))
1258 ;; if symlink, find out file name pointed to
1260 (search-forward "-> ")
1261 (setq res-symlink-target
(buffer-substring (point) (point-at-eol))))
1262 ;; return data gathered
1264 ;; 0. t for directory, string (name linked to) for symbolic
1266 (or dirp res-symlink-target
)
1267 ;; 1. Number of links to file.
1273 ;; 4. Last access time, as a list of integers. Normally this
1274 ;; would be in the same format as `current-time', but the
1275 ;; subseconds part is not currently implemented, and (0 0)
1276 ;; denotes an unknown time.
1277 ;; 5. Last modification time, likewise.
1278 ;; 6. Last status change time, likewise.
1279 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
1280 ;; 7. Size in bytes (-1, if number is out of range).
1282 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1284 ;; 9. t if file's gid would change if file were deleted and
1285 ;; recreated. Will be set in `tramp-convert-file-attributes'
1287 ;; 10. inode number.
1289 ;; 11. Device number. Will be replaced by a virtual device number.
1293 (defun tramp-do-file-attributes-with-perl
1294 (vec localname
&optional id-format
)
1295 "Implement `file-attributes' for Tramp files using a Perl script."
1296 (tramp-message vec
5 "file attributes with perl: %s" localname
)
1297 (tramp-maybe-send-script
1298 vec tramp-perl-file-attributes
"tramp_perl_file_attributes")
1299 (tramp-send-command-and-read
1301 (format "tramp_perl_file_attributes %s %s"
1302 (tramp-shell-quote-argument localname
) id-format
)))
1304 (defun tramp-do-file-attributes-with-stat
1305 (vec localname
&optional id-format
)
1306 "Implement `file-attributes' for Tramp files using stat(1) command."
1307 (tramp-message vec
5 "file attributes with stat: %s" localname
)
1308 (tramp-send-command-and-read
1311 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1312 ;; parse correctly the sequence "((". Therefore, we add a space.
1313 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
1314 (tramp-get-file-exists-command vec
)
1315 (tramp-shell-quote-argument localname
)
1316 (tramp-get-test-command vec
)
1317 (tramp-shell-quote-argument localname
)
1318 (tramp-get-remote-stat vec
)
1319 (if (eq id-format
'integer
) "%ue0" "\"%U\"")
1320 (if (eq id-format
'integer
) "%ge0" "\"%G\"")
1321 (tramp-shell-quote-argument localname
))))
1323 (defun tramp-sh-handle-set-visited-file-modtime (&optional time-list
)
1324 "Like `set-visited-file-modtime' for Tramp files."
1325 (unless (buffer-file-name)
1326 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
1329 (tramp-run-real-handler 'set-visited-file-modtime
(list time-list
))
1330 (let ((f (buffer-file-name))
1332 (with-parsed-tramp-file-name f nil
1333 (let* ((attr (file-attributes f
))
1334 ;; '(-1 65535) means file doesn't exists yet.
1335 (modtime (or (nth 5 attr
) '(-1 65535))))
1336 (when (boundp 'last-coding-system-used
)
1337 (setq coding-system-used
(symbol-value 'last-coding-system-used
)))
1338 ;; We use '(0 0) as a don't-know value. See also
1339 ;; `tramp-do-file-attributes-with-ls'.
1340 (if (not (equal modtime
'(0 0)))
1341 (tramp-run-real-handler 'set-visited-file-modtime
(list modtime
))
1345 (format "%s -ild %s"
1346 (tramp-get-ls-command v
)
1347 (tramp-shell-quote-argument localname
)))
1348 (setq attr
(buffer-substring (point)
1349 (progn (end-of-line) (point)))))
1350 (tramp-set-file-property
1351 v localname
"visited-file-modtime-ild" attr
))
1352 (when (boundp 'last-coding-system-used
)
1353 (set 'last-coding-system-used coding-system-used
))
1356 ;; This function makes the same assumption as
1357 ;; `tramp-sh-handle-set-visited-file-modtime'.
1358 (defun tramp-sh-handle-verify-visited-file-modtime (buf)
1359 "Like `verify-visited-file-modtime' for Tramp files.
1360 At the time `verify-visited-file-modtime' calls this function, we
1361 already know that the buffer is visiting a file and that
1362 `visited-file-modtime' does not return 0. Do not call this
1363 function directly, unless those two cases are already taken care
1365 (with-current-buffer buf
1366 (let ((f (buffer-file-name)))
1367 ;; There is no file visiting the buffer, or the buffer has no
1368 ;; recorded last modification time, or there is no established
1371 (eq (visited-file-modtime) 0)
1372 (not (tramp-file-name-handler 'file-remote-p f nil
'connected
)))
1374 (with-parsed-tramp-file-name f nil
1375 (let* ((remote-file-name-inhibit-cache t
)
1376 (attr (file-attributes f
))
1377 (modtime (nth 5 attr
))
1378 (mt (visited-file-modtime)))
1381 ;; File exists, and has a known modtime.
1382 ((and attr
(not (equal modtime
'(0 0))))
1383 (< (abs (tramp-time-diff
1385 ;; For compatibility, deal with both the old
1386 ;; (HIGH . LOW) and the new (HIGH LOW) return
1387 ;; values of `visited-file-modtime'.
1389 (list (car mt
) (cdr mt
))
1392 ;; Modtime has the don't know value.
1396 (format "%s -ild %s"
1397 (tramp-get-ls-command v
)
1398 (tramp-shell-quote-argument localname
)))
1399 (with-current-buffer (tramp-get-buffer v
)
1400 (setq attr
(buffer-substring
1401 (point) (progn (end-of-line) (point)))))
1404 (tramp-get-file-property
1405 v localname
"visited-file-modtime-ild" "")))
1406 ;; If file does not exist, say it is not modified if and
1407 ;; only if that agrees with the buffer's record.
1408 (t (equal mt
'(-1 65535))))))))))
1410 (defun tramp-sh-handle-set-file-modes (filename mode
)
1411 "Like `set-file-modes' for Tramp files."
1412 (with-parsed-tramp-file-name filename nil
1413 (tramp-flush-file-property v localname
)
1414 ;; FIXME: extract the proper text from chmod's stderr.
1415 (tramp-barf-unless-okay
1417 (format "chmod %s %s"
1418 (tramp-compat-decimal-to-octal mode
)
1419 (tramp-shell-quote-argument localname
))
1420 "Error while changing file's mode %s" filename
)))
1422 (defun tramp-sh-handle-set-file-times (filename &optional time
)
1423 "Like `set-file-times' for Tramp files."
1424 (if (file-remote-p filename
)
1425 (with-parsed-tramp-file-name filename nil
1426 (tramp-flush-file-property v localname
)
1427 (let ((time (if (or (null time
) (equal time
'(0 0)))
1430 ;; With GNU Emacs, `format-time-string' has an optional
1431 ;; parameter UNIVERSAL. This is preferred, because we
1432 ;; could handle the case when the remote host is located
1433 ;; in a different time zone as the local host.
1434 (utc (not (featurep 'xemacs
))))
1435 (tramp-send-command-and-check
1436 v
(format "%s touch -t %s %s"
1437 (if utc
"TZ=UTC; export TZ;" "")
1439 (format-time-string "%Y%m%d%H%M.%S" time t
)
1440 (format-time-string "%Y%m%d%H%M.%S" time
))
1441 (tramp-shell-quote-argument localname
)))))
1443 ;; We handle also the local part, because in older Emacsen,
1444 ;; without `set-file-times', this function is an alias for this.
1445 ;; We are local, so we don't need the UTC settings.
1447 (tramp-compat-call-process
1448 "touch" nil nil nil
"-t"
1449 (format-time-string "%Y%m%d%H%M.%S" time
)
1450 (tramp-shell-quote-argument filename
)))))
1452 (defun tramp-set-file-uid-gid (filename &optional uid gid
)
1453 "Set the ownership for FILENAME.
1454 If UID and GID are provided, these values are used; otherwise uid
1455 and gid of the corresponding user is taken. Both parameters must
1456 be non-negative integers."
1457 ;; Modern Unices allow chown only for root. So we might need
1458 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1459 ;; working with su(do)? when it is needed, so it shall succeed in
1460 ;; the majority of cases.
1461 ;; Don't modify `last-coding-system-used' by accident.
1462 (let ((last-coding-system-used last-coding-system-used
))
1463 (if (file-remote-p filename
)
1464 (with-parsed-tramp-file-name filename nil
1465 (if (and (zerop (user-uid)) (tramp-local-host-p v
))
1466 ;; If we are root on the local host, we can do it directly.
1467 (tramp-set-file-uid-gid localname uid gid
)
1468 (let ((uid (or (and (natnump uid
) uid
)
1469 (tramp-get-remote-uid v
'integer
)))
1470 (gid (or (and (natnump gid
) gid
)
1471 (tramp-get-remote-gid v
'integer
))))
1474 "chown %d:%d %s" uid gid
1475 (tramp-shell-quote-argument localname
))))))
1477 ;; We handle also the local part, because there doesn't exist
1478 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1479 (let ((uid (or (and (natnump uid
) uid
) (tramp-get-local-uid 'integer
)))
1480 (gid (or (and (natnump gid
) gid
) (tramp-get-local-gid 'integer
))))
1481 (tramp-compat-call-process
1483 (format "%d:%d" uid gid
) (tramp-shell-quote-argument filename
))))))
1485 (defun tramp-remote-selinux-p (vec)
1486 "Check, whether SELINUX is enabled on the remote host."
1487 (with-tramp-connection-property
1488 (tramp-get-connection-process vec
) "selinux-p"
1489 (let ((result (tramp-find-executable
1490 vec
"getenforce" (tramp-get-remote-path vec
) t t
)))
1493 (tramp-send-command-and-read
1494 vec
(format "echo \\\"`%S`\\\"" result
))
1497 (defun tramp-sh-handle-file-selinux-context (filename)
1498 "Like `file-selinux-context' for Tramp files."
1499 (with-parsed-tramp-file-name filename nil
1500 (with-tramp-file-property v localname
"file-selinux-context"
1501 (let ((context '(nil nil nil nil
))
1502 (regexp (concat "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\):"
1503 "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\)")))
1504 (when (and (tramp-remote-selinux-p v
)
1505 (tramp-send-command-and-check
1508 (tramp-get-ls-command v
)
1509 (tramp-shell-quote-argument localname
))))
1510 (with-current-buffer (tramp-get-connection-buffer v
)
1511 (goto-char (point-min))
1512 (when (re-search-forward regexp
(point-at-eol) t
)
1513 (setq context
(list (match-string 1) (match-string 2)
1514 (match-string 3) (match-string 4))))))
1515 ;; Return the context.
1518 (defun tramp-sh-handle-set-file-selinux-context (filename context
)
1519 "Like `set-file-selinux-context' for Tramp files."
1520 (with-parsed-tramp-file-name filename nil
1521 (if (and (consp context
)
1522 (tramp-remote-selinux-p v
)
1523 (tramp-send-command-and-check
1524 v
(format "chcon %s %s %s %s %s"
1525 (if (stringp (nth 0 context
))
1526 (format "--user=%s" (nth 0 context
)) "")
1527 (if (stringp (nth 1 context
))
1528 (format "--role=%s" (nth 1 context
)) "")
1529 (if (stringp (nth 2 context
))
1530 (format "--type=%s" (nth 2 context
)) "")
1531 (if (stringp (nth 3 context
))
1532 (format "--range=%s" (nth 3 context
)) "")
1533 (tramp-shell-quote-argument localname
))))
1535 (tramp-set-file-property v localname
"file-selinux-context" context
)
1537 (tramp-set-file-property v localname
"file-selinux-context" 'undef
)
1540 (defun tramp-remote-acl-p (vec)
1541 "Check, whether ACL is enabled on the remote host."
1542 (with-tramp-connection-property (tramp-get-connection-process vec
) "acl-p"
1543 (tramp-send-command-and-check vec
"getfacl /")))
1545 (defun tramp-sh-handle-file-acl (filename)
1546 "Like `file-acl' for Tramp files."
1547 (with-parsed-tramp-file-name filename nil
1548 (with-tramp-file-property v localname
"file-acl"
1549 (when (and (tramp-remote-acl-p v
)
1550 (tramp-send-command-and-check
1552 "getfacl -acs %s 2>/dev/null"
1553 (tramp-shell-quote-argument localname
))))
1554 (with-current-buffer (tramp-get-connection-buffer v
)
1555 (goto-char (point-max))
1556 (delete-blank-lines)
1557 (when (> (point-max) (point-min))
1558 (substring-no-properties (buffer-string))))))))
1560 (defun tramp-sh-handle-set-file-acl (filename acl-string
)
1561 "Like `set-file-acl' for Tramp files."
1562 (with-parsed-tramp-file-name filename nil
1563 (when (tramp-remote-acl-p v
)
1565 (when (stringp acl-string
)
1566 (tramp-set-file-property v localname
"file-acl" acl-string
)
1567 (dolist (line (split-string acl-string nil t
) t
)
1568 (unless (tramp-send-command-and-check
1571 line
(tramp-shell-quote-argument localname
)))
1573 ;; In case of errors, we return `nil'.
1575 (tramp-set-file-property v localname
"file-acl" 'undef
)
1578 ;; Simple functions using the `test' command.
1580 (defun tramp-sh-handle-file-executable-p (filename)
1581 "Like `file-executable-p' for Tramp files."
1582 (with-parsed-tramp-file-name filename nil
1583 (with-tramp-file-property v localname
"file-executable-p"
1584 ;; Examine `file-attributes' cache to see if request can be
1585 ;; satisfied without remote operation.
1586 (or (tramp-check-cached-permissions v ?x
)
1587 (tramp-run-test "-x" filename
)))))
1589 (defun tramp-sh-handle-file-readable-p (filename)
1590 "Like `file-readable-p' for Tramp files."
1591 (with-parsed-tramp-file-name filename nil
1592 (with-tramp-file-property v localname
"file-readable-p"
1593 ;; Examine `file-attributes' cache to see if request can be
1594 ;; satisfied without remote operation.
1595 (or (tramp-check-cached-permissions v ?r
)
1596 (tramp-run-test "-r" filename
)))))
1598 ;; When the remote shell is started, it looks for a shell which groks
1599 ;; tilde expansion. Here, we assume that all shells which grok tilde
1600 ;; expansion will also provide a `test' command which groks `-nt' (for
1601 ;; newer than). If this breaks, tell me about it and I'll try to do
1602 ;; something smarter about it.
1603 (defun tramp-sh-handle-file-newer-than-file-p (file1 file2
)
1604 "Like `file-newer-than-file-p' for Tramp files."
1605 (cond ((not (file-exists-p file1
))
1607 ((not (file-exists-p file2
))
1609 ;; We are sure both files exist at this point.
1612 ;; We try to get the mtime of both files. If they are not
1613 ;; equal to the "dont-know" value, then we subtract the times
1614 ;; and obtain the result.
1615 (let ((fa1 (file-attributes file1
))
1616 (fa2 (file-attributes file2
)))
1617 (if (and (not (equal (nth 5 fa1
) '(0 0)))
1618 (not (equal (nth 5 fa2
) '(0 0))))
1619 (> 0 (tramp-time-diff (nth 5 fa2
) (nth 5 fa1
)))
1620 ;; If one of them is the dont-know value, then we can
1621 ;; still try to run a shell command on the remote host.
1622 ;; However, this only works if both files are Tramp
1623 ;; files and both have the same method, same user, same
1625 (unless (tramp-equal-remote file1 file2
)
1626 (with-parsed-tramp-file-name
1627 (if (tramp-tramp-file-p file1
) file1 file2
) nil
1630 "Files %s and %s must have same method, user, host"
1632 (with-parsed-tramp-file-name file1 nil
1634 (tramp-get-test-nt-command v
) file1 file2
))))))))
1636 ;; Functions implemented using the basic functions above.
1638 (defun tramp-sh-handle-file-directory-p (filename)
1639 "Like `file-directory-p' for Tramp files."
1640 (with-parsed-tramp-file-name filename nil
1641 ;; `file-directory-p' is used as predicate for filename completion.
1642 ;; Sometimes, when a connection is not established yet, it is
1643 ;; desirable to return t immediately for "/method:foo:". It can
1644 ;; be expected that this is always a directory.
1645 (or (zerop (length localname
))
1646 (with-tramp-file-property v localname
"file-directory-p"
1647 (tramp-run-test "-d" filename
)))))
1649 (defun tramp-sh-handle-file-writable-p (filename)
1650 "Like `file-writable-p' for Tramp files."
1651 (with-parsed-tramp-file-name filename nil
1652 (with-tramp-file-property v localname
"file-writable-p"
1653 (if (file-exists-p filename
)
1654 ;; Examine `file-attributes' cache to see if request can be
1655 ;; satisfied without remote operation.
1656 (or (tramp-check-cached-permissions v ?w
)
1657 (tramp-run-test "-w" filename
))
1658 ;; If file doesn't exist, check if directory is writable.
1659 (and (tramp-run-test "-d" (file-name-directory filename
))
1660 (tramp-run-test "-w" (file-name-directory filename
)))))))
1662 (defun tramp-sh-handle-file-ownership-preserved-p (filename &optional group
)
1663 "Like `file-ownership-preserved-p' for Tramp files."
1664 (with-parsed-tramp-file-name filename nil
1665 (with-tramp-file-property v localname
"file-ownership-preserved-p"
1666 (let ((attributes (file-attributes filename
)))
1667 ;; Return t if the file doesn't exist, since it's true that no
1668 ;; information would be lost by an (attempted) delete and create.
1669 (or (null attributes
)
1671 (= (nth 2 attributes
) (tramp-get-remote-uid v
'integer
))
1673 (= (nth 3 attributes
) (tramp-get-remote-gid v
'integer
)))))))))
1675 ;; Directory listings.
1677 (defun tramp-sh-handle-directory-files-and-attributes
1678 (directory &optional full match nosort id-format
)
1679 "Like `directory-files-and-attributes' for Tramp files."
1680 (unless id-format
(setq id-format
'integer
))
1681 (when (file-directory-p directory
)
1682 (setq directory
(expand-file-name directory
))
1685 (with-parsed-tramp-file-name directory nil
1686 (with-tramp-file-property
1688 (format "directory-files-and-attributes-%s" id-format
)
1693 (tramp-convert-file-attributes v
(cdr x
))))
1695 ((tramp-get-remote-stat v
)
1696 (tramp-do-directory-files-and-attributes-with-stat
1697 v localname id-format
))
1698 ((tramp-get-remote-perl v
)
1699 (tramp-do-directory-files-and-attributes-with-perl
1700 v localname id-format
)))))))))
1704 (setq item
(pop temp
))
1705 (when (or (null match
) (string-match match
(car item
)))
1707 (setcar item
(expand-file-name (car item
) directory
)))
1708 (push item result
)))
1712 (sort result
(lambda (x y
) (string< (car x
) (car y
))))))))
1714 (defun tramp-do-directory-files-and-attributes-with-perl
1715 (vec localname
&optional id-format
)
1716 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1717 (tramp-message vec
5 "directory-files-and-attributes with perl: %s" localname
)
1718 (tramp-maybe-send-script
1719 vec tramp-perl-directory-files-and-attributes
1720 "tramp_perl_directory_files_and_attributes")
1722 (tramp-send-command-and-read
1724 (format "tramp_perl_directory_files_and_attributes %s %s"
1725 (tramp-shell-quote-argument localname
) id-format
))))
1726 (when (stringp object
) (tramp-error vec
'file-error object
))
1729 (defun tramp-do-directory-files-and-attributes-with-stat
1730 (vec localname
&optional id-format
)
1731 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1732 (tramp-message vec
5 "directory-files-and-attributes with stat: %s" localname
)
1733 (tramp-send-command-and-read
1737 ;; We must care about filenames with spaces, or starting with
1738 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1739 ;; but it does not work on all remote systems. Therefore, we
1740 ;; quote the filenames via sed.
1741 "cd %s; echo \"(\"; (%s -a | sed -e s/\\$/\\\"/g -e s/^/\\\"/g | "
1743 "'(\"%%n\" (\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)'"
1744 " 2>/dev/null); echo \")\"")
1745 (tramp-shell-quote-argument localname
)
1746 (tramp-get-ls-command vec
)
1747 (tramp-get-remote-stat vec
)
1748 (if (eq id-format
'integer
) "%ue0" "\"%U\"")
1749 (if (eq id-format
'integer
) "%ge0" "\"%G\""))))
1751 ;; This function should return "foo/" for directories and "bar" for
1753 (defun tramp-sh-handle-file-name-all-completions (filename directory
)
1754 "Like `file-name-all-completions' for Tramp files."
1755 (unless (save-match-data (string-match "/" filename
))
1756 (with-parsed-tramp-file-name (expand-file-name directory
) nil
1763 ;; Try cache entries for filename, filename with last
1764 ;; character removed, filename with last two characters
1765 ;; removed, ..., and finally the empty string - all
1766 ;; concatenated to the local directory name.
1767 (let ((remote-file-name-inhibit-cache
1768 (or remote-file-name-inhibit-cache
1769 tramp-completion-reread-directory-timeout
)))
1771 ;; This is inefficient for very long filenames, pity
1772 ;; `reduce' is not available...
1779 (tramp-get-file-property
1781 (concat localname
(substring filename
0 x
))
1782 "file-name-all-completions"
1784 (when cache-hit
(list cache-hit
))))
1785 ;; We cannot use a length of 0, because file properties
1786 ;; for "foo" and "foo/" are identical.
1787 (tramp-compat-number-sequence (length filename
) 1 -
1)))))
1789 ;; Cache expired or no matching cache entry found so we need
1790 ;; to perform a remote operation.
1792 ;; Get a list of directories and files, including reliably
1793 ;; tagging the directories with a trailing '/'. Because I
1794 ;; rock. --daniel@danann.net
1796 ;; Changed to perform `cd' in the same remote op and only
1797 ;; get entries starting with `filename'. Capture any `cd'
1798 ;; error messages. Ensure any `cd' and `echo' aliases are
1802 (if (tramp-get-remote-perl v
)
1804 (tramp-maybe-send-script
1805 v tramp-perl-file-name-all-completions
1806 "tramp_perl_file_name_all_completions")
1807 (format "tramp_perl_file_name_all_completions %s %s %d"
1808 (tramp-shell-quote-argument localname
)
1809 (tramp-shell-quote-argument filename
)
1811 ;; `read-file-name-completion-ignore-case'
1812 ;; is introduced with Emacs 22.1.
1814 'read-file-name-completion-ignore-case
)
1815 'read-file-name-completion-ignore-case
1816 'completion-ignore-case
))
1820 "(\\cd %s 2>&1 && (%s %s -a 2>/dev/null"
1821 ;; `ls' with wildcard might fail with `Argument
1822 ;; list too long' error in some corner cases; if
1823 ;; `ls' fails after `cd' succeeded, chances are
1824 ;; that's the case, so let's retry without
1825 ;; wildcard. This will return "too many" entries
1826 ;; but that isn't harmful.
1827 " || %s -a 2>/dev/null)"
1828 " | while read f; do"
1829 " if %s -d \"$f\" 2>/dev/null;"
1830 " then \\echo \"$f/\"; else \\echo \"$f\"; fi; done"
1831 " && \\echo ok) || \\echo fail")
1832 (tramp-shell-quote-argument localname
)
1833 (tramp-get-ls-command v
)
1834 ;; When `filename' is empty, just `ls' without
1835 ;; filename argument is more efficient than `ls *'
1836 ;; for very large directories and might avoid the
1837 ;; `Argument list too long' error.
1839 ;; With and only with wildcard, we need to add
1840 ;; `-d' to prevent `ls' from descending into
1842 (if (zerop (length filename
))
1844 (concat (tramp-shell-quote-argument filename
) "* -d"))
1845 (tramp-get-ls-command v
)
1846 (tramp-get-test-command v
))))
1848 ;; Now grab the output.
1849 (with-current-buffer (tramp-get-buffer v
)
1850 (goto-char (point-max))
1852 ;; Check result code, found in last line of output.
1854 (if (looking-at "^fail$")
1856 ;; Grab error message from line before last line
1857 ;; (it was put there by `cd 2>&1').
1861 "tramp-sh-handle-file-name-all-completions: %s"
1862 (buffer-substring (point) (point-at-eol))))
1863 ;; For peace of mind, if buffer doesn't end in `fail'
1864 ;; then it should end in `ok'. If neither are in the
1865 ;; buffer something went seriously wrong on the remote
1867 (unless (looking-at "^ok$")
1871 tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
1872 (tramp-shell-quote-argument localname
) (buffer-string))))
1874 (while (zerop (forward-line -
1))
1875 (push (buffer-substring (point) (point-at-eol)) result
)))
1877 ;; Because the remote op went through OK we know the
1878 ;; directory we `cd'-ed to exists.
1879 (tramp-set-file-property v localname
"file-exists-p" t
)
1881 ;; Because the remote op went through OK we know every
1882 ;; file listed by `ls' exists.
1883 (mapc (lambda (entry)
1884 (tramp-set-file-property
1885 v
(concat localname entry
) "file-exists-p" t
))
1888 ;; Store result in the cache.
1889 (tramp-set-file-property
1890 v
(concat localname filename
)
1891 "file-name-all-completions" result
))))))))
1895 (defun tramp-sh-handle-add-name-to-file
1896 (filename newname
&optional ok-if-already-exists
)
1897 "Like `add-name-to-file' for Tramp files."
1898 (unless (tramp-equal-remote filename newname
)
1899 (with-parsed-tramp-file-name
1900 (if (tramp-tramp-file-p filename
) filename newname
) nil
1903 "add-name-to-file: %s"
1904 "only implemented for same method, same user, same host")))
1905 (with-parsed-tramp-file-name filename v1
1906 (with-parsed-tramp-file-name newname v2
1907 (let ((ln (when v1
(tramp-get-remote-ln v1
))))
1908 (when (and (not ok-if-already-exists
)
1909 (file-exists-p newname
)
1910 (not (numberp ok-if-already-exists
))
1913 "File %s already exists; make it a new name anyway? "
1917 "add-name-to-file: file %s already exists" newname
))
1918 (tramp-flush-file-property v2
(file-name-directory v2-localname
))
1919 (tramp-flush-file-property v2 v2-localname
)
1920 (tramp-barf-unless-okay
1922 (format "%s %s %s" ln
(tramp-shell-quote-argument v1-localname
)
1923 (tramp-shell-quote-argument v2-localname
))
1924 "error with add-name-to-file, see buffer `%s' for details"
1927 (defun tramp-sh-handle-copy-file
1928 (filename newname
&optional ok-if-already-exists keep-date
1929 preserve-uid-gid preserve-extended-attributes
)
1930 "Like `copy-file' for Tramp files."
1931 (setq filename
(expand-file-name filename
))
1932 (setq newname
(expand-file-name newname
))
1934 ;; At least one file a Tramp file?
1935 ((or (tramp-tramp-file-p filename
)
1936 (tramp-tramp-file-p newname
))
1937 (tramp-do-copy-or-rename-file
1938 'copy filename newname ok-if-already-exists keep-date
1939 preserve-uid-gid preserve-extended-attributes
))
1941 (preserve-extended-attributes
1942 (tramp-run-real-handler
1944 (list filename newname ok-if-already-exists keep-date
1945 preserve-uid-gid preserve-extended-attributes
)))
1947 (tramp-run-real-handler
1949 (list filename newname ok-if-already-exists keep-date preserve-uid-gid
)))
1951 (tramp-run-real-handler
1952 'copy-file
(list filename newname ok-if-already-exists keep-date
)))))
1954 (defun tramp-sh-handle-copy-directory
1955 (dirname newname
&optional keep-date parents copy-contents
)
1956 "Like `copy-directory' for Tramp files."
1957 (let ((t1 (tramp-tramp-file-p dirname
))
1958 (t2 (tramp-tramp-file-p newname
)))
1959 (with-parsed-tramp-file-name (if t1 dirname newname
) nil
1960 (if (and (tramp-get-method-parameter method
'tramp-copy-recursive
)
1961 ;; When DIRNAME and NEWNAME are remote, they must have
1963 (or (null t1
) (null t2
)
1965 (tramp-file-name-method (tramp-dissect-file-name dirname
))
1966 (tramp-file-name-method (tramp-dissect-file-name newname
)))))
1967 ;; scp or rsync DTRT.
1969 (setq dirname
(directory-file-name (expand-file-name dirname
))
1970 newname
(directory-file-name (expand-file-name newname
)))
1971 (if (and (file-directory-p newname
)
1972 (not (string-equal (file-name-nondirectory dirname
)
1973 (file-name-nondirectory newname
))))
1976 (file-name-nondirectory dirname
) newname
)))
1977 (if (not (file-directory-p (file-name-directory newname
)))
1978 (make-directory (file-name-directory newname
) parents
))
1979 (tramp-do-copy-or-rename-file-out-of-band
1980 'copy dirname newname keep-date
))
1981 ;; We must do it file-wise.
1982 (tramp-run-real-handler
1983 'copy-directory
(list dirname newname keep-date parents
)))
1985 ;; When newname did exist, we have wrong cached values.
1987 (with-parsed-tramp-file-name newname nil
1988 (tramp-flush-file-property v
(file-name-directory localname
))
1989 (tramp-flush-file-property v localname
))))))
1991 (defun tramp-sh-handle-rename-file
1992 (filename newname
&optional ok-if-already-exists
)
1993 "Like `rename-file' for Tramp files."
1994 ;; Check if both files are local -- invoke normal rename-file.
1995 ;; Otherwise, use Tramp from local system.
1996 (setq filename
(expand-file-name filename
))
1997 (setq newname
(expand-file-name newname
))
1998 ;; At least one file a Tramp file?
1999 (if (or (tramp-tramp-file-p filename
)
2000 (tramp-tramp-file-p newname
))
2001 (tramp-do-copy-or-rename-file
2002 'rename filename newname ok-if-already-exists t t
)
2003 (tramp-run-real-handler
2004 'rename-file
(list filename newname ok-if-already-exists
))))
2006 (defun tramp-do-copy-or-rename-file
2007 (op filename newname
&optional ok-if-already-exists keep-date
2008 preserve-uid-gid preserve-extended-attributes
)
2009 "Copy or rename a remote file.
2010 OP must be `copy' or `rename' and indicates the operation to perform.
2011 FILENAME specifies the file to copy or rename, NEWNAME is the name of
2012 the new file (for copy) or the new name of the file (for rename).
2013 OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
2014 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2015 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2016 the uid and gid if both files are on the same host.
2017 PRESERVE-EXTENDED-ATTRIBUTES activates selinux and acl commands.
2019 This function is invoked by `tramp-sh-handle-copy-file' and
2020 `tramp-sh-handle-rename-file'. It is an error if OP is neither
2021 of `copy' and `rename'. FILENAME and NEWNAME must be absolute
2023 (unless (memq op
'(copy rename
))
2024 (error "Unknown operation `%s', must be `copy' or `rename'" op
))
2025 (let ((t1 (tramp-tramp-file-p filename
))
2026 (t2 (tramp-tramp-file-p newname
))
2027 (length (nth 7 (file-attributes (file-truename filename
))))
2028 (attributes (and preserve-extended-attributes
2029 (apply 'file-extended-attributes
(list filename
))))
2032 (with-parsed-tramp-file-name (if t1 filename newname
) nil
2033 (when (and (not ok-if-already-exists
) (file-exists-p newname
))
2035 v
'file-already-exists
"File %s already exists" newname
))
2037 (with-tramp-progress-reporter
2038 v
0 (format "%s %s to %s"
2039 (if (eq op
'copy
) "Copying" "Renaming")
2043 ;; Both are Tramp files.
2045 (with-parsed-tramp-file-name filename v1
2046 (with-parsed-tramp-file-name newname v2
2048 ;; Shortcut: if method, host, user are the same for
2049 ;; both files, we invoke `cp' or `mv' on the remote
2051 ((tramp-equal-remote filename newname
)
2052 (tramp-do-copy-or-rename-file-directly
2054 ok-if-already-exists keep-date preserve-uid-gid
))
2056 ;; Try out-of-band operation.
2058 (tramp-method-out-of-band-p v1 length
)
2059 (tramp-method-out-of-band-p v2 length
))
2060 (tramp-do-copy-or-rename-file-out-of-band
2061 op filename newname keep-date
))
2063 ;; No shortcut was possible. So we copy the file
2064 ;; first. If the operation was `rename', we go back
2065 ;; and delete the original file (if the copy was
2066 ;; successful). The approach is simple-minded: we
2067 ;; create a new buffer, insert the contents of the
2068 ;; source file into it, then write out the buffer to
2069 ;; the target file. The advantage is that it doesn't
2070 ;; matter which filename handlers are used for the
2071 ;; source and target file.
2073 (tramp-do-copy-or-rename-file-via-buffer
2074 op filename newname keep-date
))))))
2076 ;; One file is a Tramp file, the other one is local.
2079 ;; Fast track on local machine.
2080 ((tramp-local-host-p v
)
2081 (tramp-do-copy-or-rename-file-directly
2083 ok-if-already-exists keep-date preserve-uid-gid
))
2085 ;; If the Tramp file has an out-of-band method, the
2086 ;; corresponding copy-program can be invoked.
2087 ((tramp-method-out-of-band-p v length
)
2088 (tramp-do-copy-or-rename-file-out-of-band
2089 op filename newname keep-date
))
2091 ;; Use the inline method via a Tramp buffer.
2092 (t (tramp-do-copy-or-rename-file-via-buffer
2093 op filename newname keep-date
))))
2096 ;; One of them must be a Tramp file.
2097 (error "Tramp implementation says this cannot happen")))
2099 ;; Handle `preserve-extended-attributes'. We ignore possible
2100 ;; errors, because ACL strings could be incompatible.
2103 (apply 'set-file-extended-attributes
(list newname attributes
))))
2105 ;; In case of `rename', we must flush the cache of the source file.
2106 (when (and t1
(eq op
'rename
))
2107 (with-parsed-tramp-file-name filename v1
2108 (tramp-flush-file-property v1
(file-name-directory localname
))
2109 (tramp-flush-file-property v1 localname
)))
2111 ;; When newname did exist, we have wrong cached values.
2113 (with-parsed-tramp-file-name newname v2
2114 (tramp-flush-file-property v2
(file-name-directory localname
))
2115 (tramp-flush-file-property v2 localname
)))))))
2117 (defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date
)
2118 "Use an Emacs buffer to copy or rename a file.
2119 First arg OP is either `copy' or `rename' and indicates the operation.
2120 FILENAME is the source file, NEWNAME the target file.
2121 KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2123 ;; We must disable multibyte, because binary data shall not be
2125 (set-buffer-multibyte nil
)
2126 (let ((coding-system-for-read 'binary
)
2127 (jka-compr-inhibit t
))
2128 (insert-file-contents-literally filename
))
2129 ;; We don't want the target file to be compressed, so we let-bind
2130 ;; `jka-compr-inhibit' to t.
2131 (let ((coding-system-for-write 'binary
)
2132 (jka-compr-inhibit t
))
2133 (write-region (point-min) (point-max) newname
)))
2134 ;; KEEP-DATE handling.
2135 (when keep-date
(set-file-times newname
(nth 5 (file-attributes filename
))))
2137 (set-file-modes newname
(tramp-default-file-modes filename
))
2138 ;; If the operation was `rename', delete the original file.
2139 (unless (eq op
'copy
) (delete-file filename
)))
2141 (defun tramp-do-copy-or-rename-file-directly
2142 (op filename newname ok-if-already-exists keep-date preserve-uid-gid
)
2143 "Invokes `cp' or `mv' on the remote system.
2144 OP must be one of `copy' or `rename', indicating `cp' or `mv',
2145 respectively. FILENAME specifies the file to copy or rename,
2146 NEWNAME is the name of the new file (for copy) or the new name of
2147 the file (for rename). Both files must reside on the same host.
2148 KEEP-DATE means to make sure that NEWNAME has the same timestamp
2149 as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2150 the uid and gid from FILENAME."
2151 (let ((t1 (tramp-tramp-file-p filename
))
2152 (t2 (tramp-tramp-file-p newname
))
2153 (file-times (nth 5 (file-attributes filename
)))
2154 (file-modes (tramp-default-file-modes filename
)))
2155 (with-parsed-tramp-file-name (if t1 filename newname
) nil
2156 (let* ((cmd (cond ((and (eq op
'copy
) preserve-uid-gid
) "cp -f -p")
2157 ((eq op
'copy
) "cp -f")
2158 ((eq op
'rename
) "mv -f")
2161 "Unknown operation `%s', must be `copy' or `rename'"
2165 (tramp-file-name-handler 'file-remote-p filename
'localname
)
2169 (tramp-file-name-handler 'file-remote-p newname
'localname
)
2171 (prefix (file-remote-p (if t1 filename newname
)))
2175 ;; Both files are on a remote host, with same user.
2178 (tramp-send-command-and-check
2179 v
(format "%s %s %s" cmd
2180 (tramp-shell-quote-argument localname1
)
2181 (tramp-shell-quote-argument localname2
))))
2182 (with-current-buffer (tramp-get-buffer v
)
2183 (goto-char (point-min))
2187 ;; Mask cp -f error.
2189 tramp-operation-not-permitted-regexp nil t
))
2191 (tramp-error-with-buffer
2193 "Copying directly failed, see buffer `%s' for details."
2196 ;; We are on the local host.
2199 ;; We can do it directly.
2200 ((let (file-name-handler-alist)
2201 (and (file-readable-p localname1
)
2202 (file-writable-p (file-name-directory localname2
))
2203 (or (file-directory-p localname2
)
2204 (file-writable-p localname2
))))
2206 (tramp-compat-copy-file
2207 localname1 localname2 ok-if-already-exists
2208 keep-date preserve-uid-gid
)
2209 (tramp-run-real-handler
2210 'rename-file
(list localname1 localname2 ok-if-already-exists
))))
2212 ;; We can do it directly with `tramp-send-command'
2213 ((and (file-readable-p (concat prefix localname1
))
2215 (file-name-directory (concat prefix localname2
)))
2216 (or (file-directory-p (concat prefix localname2
))
2217 (file-writable-p (concat prefix localname2
))))
2218 (tramp-do-copy-or-rename-file-directly
2219 op
(concat prefix localname1
) (concat prefix localname2
)
2220 ok-if-already-exists keep-date t
)
2221 ;; We must change the ownership to the local user.
2222 (tramp-set-file-uid-gid
2223 (concat prefix localname2
)
2224 (tramp-get-local-uid 'integer
)
2225 (tramp-get-local-gid 'integer
)))
2227 ;; We need a temporary file in between.
2229 ;; Create the temporary file.
2230 (let ((tmpfile (tramp-compat-make-temp-file localname1
)))
2235 (tramp-barf-unless-okay
2238 (tramp-shell-quote-argument localname1
)
2239 (tramp-shell-quote-argument tmpfile
))
2240 "Copying directly failed, see buffer `%s' for details."
2241 (tramp-get-buffer v
))
2242 ;; We must change the ownership as remote user.
2243 ;; Since this does not work reliable, we also
2244 ;; give read permissions.
2246 (concat prefix tmpfile
)
2247 (tramp-compat-octal-to-decimal "0777"))
2248 (tramp-set-file-uid-gid
2249 (concat prefix tmpfile
)
2250 (tramp-get-local-uid 'integer
)
2251 (tramp-get-local-gid 'integer
)))
2254 (tramp-compat-copy-file
2255 localname1 tmpfile t
2256 keep-date preserve-uid-gid
)
2257 (tramp-run-real-handler
2259 (list localname1 tmpfile t
)))
2260 ;; We must change the ownership as local user.
2261 ;; Since this does not work reliable, we also
2262 ;; give read permissions.
2264 tmpfile
(tramp-compat-octal-to-decimal "0777"))
2265 (tramp-set-file-uid-gid
2267 (tramp-get-remote-uid v
'integer
)
2268 (tramp-get-remote-gid v
'integer
))))
2270 ;; Move the temporary file to its destination.
2273 (tramp-barf-unless-okay
2276 (tramp-shell-quote-argument tmpfile
)
2277 (tramp-shell-quote-argument localname2
))
2278 "Copying directly failed, see buffer `%s' for details."
2279 (tramp-get-buffer v
)))
2281 (tramp-run-real-handler
2283 (list tmpfile localname2 ok-if-already-exists
)))))
2286 (ignore-errors (delete-file tmpfile
)))))))))
2288 ;; Set the time and mode. Mask possible errors.
2291 (set-file-times newname file-times
)
2292 (set-file-modes newname file-modes
))))))
2294 (defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date
)
2295 "Invoke rcp program to copy.
2296 The method used must be an out-of-band method."
2297 (let* ((t1 (tramp-tramp-file-p filename
))
2298 (t2 (tramp-tramp-file-p newname
))
2299 (orig-vec (tramp-dissect-file-name (if t1 filename newname
)))
2300 copy-program copy-args copy-env copy-keep-date port spec
2303 (with-parsed-tramp-file-name (if t1 filename newname
) nil
2306 ;; Both are Tramp files. We shall optimize it when the
2307 ;; methods for filename and newname are the same.
2308 (let* ((dir-flag (file-directory-p filename
))
2309 (tmpfile (tramp-compat-make-temp-file localname dir-flag
)))
2313 (file-name-nondirectory newname
) tmpfile
)))
2316 (tramp-do-copy-or-rename-file-out-of-band
2317 op filename tmpfile keep-date
)
2318 (tramp-do-copy-or-rename-file-out-of-band
2319 'rename tmpfile newname keep-date
))
2323 (tramp-compat-delete-directory
2324 (expand-file-name ".." tmpfile
) 'recursive
)
2325 (delete-file tmpfile
)))))
2327 ;; Set variables for computing the prompt for reading
2329 (setq tramp-current-method
(tramp-file-name-method v
)
2330 tramp-current-user
(or (tramp-file-name-user v
)
2331 (tramp-get-connection-property
2333 tramp-current-host
(tramp-file-name-real-host v
))
2335 ;; Expand hops. Might be necessary for gateway methods.
2336 (setq v
(car (tramp-compute-multi-hops v
)))
2337 (aset v
3 localname
)
2339 ;; Check which ones of source and target are Tramp files.
2340 (setq source
(if t1
(tramp-make-copy-program-file-name v
) filename
)
2342 (if (and (file-directory-p filename
)
2344 (file-name-nondirectory filename
)
2345 (file-name-nondirectory newname
)))
2346 'file-name-directory
2348 (if t2
(tramp-make-copy-program-file-name v
) newname
)))
2350 ;; Check for host and port number. We cannot use
2351 ;; `tramp-file-name-port', because this returns also
2352 ;; `tramp-default-port', which might clash with settings in
2354 (setq host
(tramp-file-name-host v
)
2356 (when (string-match tramp-host-with-port-regexp host
)
2357 (setq port
(string-to-number (match-string 2 host
))
2358 host
(string-to-number (match-string 1 host
))))
2360 ;; Check for user. There might be an interactive setting.
2361 (setq user
(or (tramp-file-name-user v
)
2362 (tramp-get-connection-property v
"login-as" nil
)))
2364 ;; Compose copy command.
2365 (setq host
(or host
"")
2368 spec
(format-spec-make
2369 ?h host ?u user ?p port
2370 ?t
(tramp-get-connection-property
2371 (tramp-get-connection-process v
) "temp-file" "")
2372 ?k
(if keep-date
" " ""))
2373 copy-program
(tramp-get-method-parameter
2374 method
'tramp-copy-program
)
2375 copy-keep-date
(tramp-get-method-parameter
2376 method
'tramp-copy-keep-date
)
2379 ;; " " has either been a replacement of "%k" (when
2380 ;; keep-date argument is non-nil), or a replacement
2381 ;; for the whole keep-date sublist.
2385 (tramp-get-method-parameter method
'tramp-copy-args
)
2390 (let ((y (mapcar (lambda (z) (format-spec z spec
)) x
)))
2391 (if (member "" y
) '(" ") y
))))))
2397 (setq x
(mapcar (lambda (y) (format-spec y spec
)) x
))
2398 (unless (member "" x
) (mapconcat 'identity x
" ")))
2399 (tramp-get-method-parameter method
'tramp-copy-env
))))
2401 ;; Check for program.
2402 (unless (let ((default-directory
2403 (tramp-compat-temporary-file-directory)))
2404 (executable-find copy-program
))
2406 v
'file-error
"Cannot find copy program: %s" copy-program
))
2410 ;; The default directory must be remote.
2411 (let ((default-directory
2412 (file-name-directory (if t1 filename newname
)))
2413 (process-environment (copy-sequence process-environment
)))
2414 ;; Set the transfer process properties.
2415 (tramp-set-connection-property
2416 v
"process-name" (buffer-name (current-buffer)))
2417 (tramp-set-connection-property
2418 v
"process-buffer" (current-buffer))
2421 orig-vec
5 "%s=\"%s\"" (car copy-env
) (cadr copy-env
))
2422 (setenv (pop copy-env
) (pop copy-env
)))
2424 ;; Use an asynchronous process. By this, password can
2425 ;; be handled. The default directory must be local, in
2426 ;; order to apply the correct `copy-program'. We don't
2427 ;; set a timeout, because the copying of large files can
2428 ;; last longer than 60 secs.
2429 (let ((p (let ((default-directory
2430 (tramp-compat-temporary-file-directory)))
2431 (apply 'start-process-shell-command
2432 (tramp-get-connection-name v
)
2433 (tramp-get-connection-buffer v
)
2438 (shell-quote-argument source
)
2439 (shell-quote-argument target
)
2440 "&&" "echo" "tramp_exit_status" "0"
2441 "||" "echo" "tramp_exit_status" "1"))))))
2444 (mapconcat 'identity
(process-command p
) " "))
2445 (tramp-compat-set-process-query-on-exit-flag p nil
)
2446 (tramp-process-actions
2447 p v nil tramp-actions-copy-out-of-band
)
2449 ;; Check the return code.
2450 (goto-char (point-max))
2452 (re-search-backward "tramp_exit_status [0-9]+" nil t
)
2454 orig-vec
'file-error
2455 "Couldn't find exit status of `%s'" (process-command p
)))
2456 (skip-chars-forward "^ ")
2457 (unless (zerop (read (current-buffer)))
2460 orig-vec
'file-error
2461 "Error copying: `%s'"
2462 (buffer-substring (point-min) (point-at-eol))))))
2464 ;; Reset the transfer process properties.
2465 (tramp-message orig-vec
6 "\n%s" (buffer-string))
2466 (tramp-set-connection-property v
"process-name" nil
)
2467 (tramp-set-connection-property v
"process-buffer" nil
)))
2469 ;; Handle KEEP-DATE argument.
2470 (when (and keep-date
(not copy-keep-date
))
2471 (set-file-times newname
(nth 5 (file-attributes filename
))))
2474 (unless (and keep-date copy-keep-date
)
2476 (set-file-modes newname
(tramp-default-file-modes filename
)))))
2478 ;; If the operation was `rename', delete the original file.
2479 (unless (eq op
'copy
)
2480 (if (file-regular-p filename
)
2481 (delete-file filename
)
2482 (tramp-compat-delete-directory filename
'recursive
))))))
2484 (defun tramp-sh-handle-make-directory (dir &optional parents
)
2485 "Like `make-directory' for Tramp files."
2486 (setq dir
(expand-file-name dir
))
2487 (with-parsed-tramp-file-name dir nil
2488 (tramp-flush-directory-property v
(file-name-directory localname
))
2490 (tramp-barf-unless-okay
2492 (if parents
"mkdir -p" "mkdir")
2493 (tramp-shell-quote-argument localname
))
2494 "Couldn't make directory %s" dir
))))
2496 (defun tramp-sh-handle-delete-directory (directory &optional recursive
)
2497 "Like `delete-directory' for Tramp files."
2498 (setq directory
(expand-file-name directory
))
2499 (with-parsed-tramp-file-name directory nil
2500 (tramp-flush-file-property v
(file-name-directory localname
))
2501 (tramp-flush-directory-property v localname
)
2502 (tramp-barf-unless-okay
2504 (if recursive
"rm -rf" "rmdir")
2505 (tramp-shell-quote-argument localname
))
2506 "Couldn't delete %s" directory
)))
2508 (defun tramp-sh-handle-delete-file (filename &optional trash
)
2509 "Like `delete-file' for Tramp files."
2510 (setq filename
(expand-file-name filename
))
2511 (with-parsed-tramp-file-name filename nil
2512 (tramp-flush-file-property v
(file-name-directory localname
))
2513 (tramp-flush-file-property v localname
)
2514 (tramp-barf-unless-okay
2516 (or (and trash
(tramp-get-remote-trash v
)) "rm -f")
2517 (tramp-shell-quote-argument localname
))
2518 "Couldn't delete %s" filename
)))
2522 ;; CCC: This does not seem to be enough. Something dies when
2523 ;; we try and delete two directories under Tramp :/
2524 (defun tramp-sh-handle-dired-recursive-delete-directory (filename)
2525 "Recursively delete the directory given.
2526 This is like `dired-recursive-delete-directory' for Tramp files."
2527 (with-parsed-tramp-file-name filename nil
2528 ;; Run a shell command 'rm -r <localname>'.
2529 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2530 (unless (file-exists-p filename
)
2531 (tramp-error v
'file-error
"No such directory: %s" filename
))
2532 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
2535 (format "rm -rf %s" (tramp-shell-quote-argument localname
))
2536 ;; Don't read the output, do it explicitly.
2538 ;; Wait for the remote system to return to us...
2539 ;; This might take a while, allow it plenty of time.
2540 (tramp-wait-for-output (tramp-get-connection-process v
) 120)
2541 ;; Make sure that it worked...
2542 (tramp-flush-file-property v
(file-name-directory localname
))
2543 (tramp-flush-directory-property v localname
)
2544 (and (file-exists-p filename
)
2546 v
'file-error
"Failed to recursively delete %s" filename
))))
2548 (defun tramp-sh-handle-dired-compress-file (file &rest ok-flag
)
2549 "Like `dired-compress-file' for Tramp files."
2550 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2551 ;; Code stolen mainly from dired-aux.el.
2552 (with-parsed-tramp-file-name file nil
2553 (tramp-flush-file-property v localname
)
2556 (if (not (featurep 'xemacs
))
2558 (symbol-value 'dired-compress-file-suffixes
)
2559 ;; XEmacs has `dired-compression-method-alist', which is
2560 ;; transformed into `dired-compress-file-suffixes' structure.
2563 (list (concat (regexp-quote (nth 1 x
)) "\\'")
2565 (mapconcat 'identity
(nth 3 x
) " ")))
2566 (symbol-value 'dired-compression-method-alist
))))
2568 ;; See if any suffix rule matches this file name.
2570 (let (case-fold-search)
2571 (if (string-match (car (car suffixes
)) localname
)
2572 (setq suffix
(car suffixes
) suffixes nil
))
2573 (setq suffixes
(cdr suffixes
))))
2575 (cond ((file-symlink-p file
)
2577 ((and suffix
(nth 2 suffix
))
2578 ;; We found an uncompression rule.
2579 (with-tramp-progress-reporter
2580 v
0 (format "Uncompressing %s" file
)
2581 (when (tramp-send-command-and-check
2582 v
(concat (nth 2 suffix
) " "
2583 (tramp-shell-quote-argument localname
)))
2584 ;; `dired-remove-file' is not defined in XEmacs.
2585 (tramp-compat-funcall 'dired-remove-file file
)
2586 (string-match (car suffix
) file
)
2587 (concat (substring file
0 (match-beginning 0))))))
2589 ;; We don't recognize the file as compressed, so compress it.
2591 (with-tramp-progress-reporter v
0 (format "Compressing %s" file
)
2592 (when (tramp-send-command-and-check
2593 v
(concat "gzip -f "
2594 (tramp-shell-quote-argument localname
)))
2595 ;; `dired-remove-file' is not defined in XEmacs.
2596 (tramp-compat-funcall 'dired-remove-file file
)
2597 (cond ((file-exists-p (concat file
".gz"))
2598 (concat file
".gz"))
2599 ((file-exists-p (concat file
".z"))
2603 (defun tramp-sh-handle-insert-directory
2604 (filename switches
&optional wildcard full-directory-p
)
2605 "Like `insert-directory' for Tramp files."
2606 (setq filename
(expand-file-name filename
))
2607 (with-parsed-tramp-file-name filename nil
2608 (if (and (featurep 'ls-lisp
)
2609 (not (symbol-value 'ls-lisp-use-insert-directory-program
)))
2610 (tramp-run-real-handler
2611 'insert-directory
(list filename switches wildcard full-directory-p
))
2612 (when (stringp switches
)
2613 (setq switches
(split-string switches
)))
2614 (when (and (member "--dired" switches
)
2615 (not (tramp-get-ls-command-with-dired v
)))
2616 (setq switches
(delete "--dired" switches
)))
2618 (setq wildcard
(tramp-run-real-handler
2619 'file-name-nondirectory
(list localname
)))
2620 (setq localname
(tramp-run-real-handler
2621 'file-name-directory
(list localname
))))
2622 (unless full-directory-p
2623 (setq switches
(add-to-list 'switches
"-d" 'append
)))
2624 (setq switches
(mapconcat 'tramp-shell-quote-argument switches
" "))
2626 (setq switches
(concat switches
" " wildcard
)))
2628 v
4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
2629 switches filename
(if wildcard
"yes" "no")
2630 (if full-directory-p
"yes" "no"))
2631 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2632 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2633 (if full-directory-p
2636 (format "%s %s %s 2>/dev/null"
2637 (tramp-get-ls-command v
)
2641 (tramp-shell-quote-argument (concat localname
".")))))
2642 (tramp-barf-unless-okay
2644 (format "cd %s" (tramp-shell-quote-argument
2645 (tramp-run-real-handler
2646 'file-name-directory
(list localname
))))
2648 (tramp-shell-quote-argument
2649 (tramp-run-real-handler 'file-name-directory
(list localname
))))
2653 (tramp-get-ls-command v
)
2657 (tramp-run-real-handler
2658 'file-name-nondirectory
(list localname
)))))
2660 (tramp-shell-quote-argument
2661 (tramp-run-real-handler
2662 'file-name-nondirectory
(list localname
)))))))
2663 (let ((beg (point)))
2664 ;; We cannot use `insert-buffer-substring' because the Tramp
2665 ;; buffer changes its contents before insertion due to calling
2666 ;; `expand-file' and alike.
2668 (with-current-buffer (tramp-get-buffer v
)
2671 ;; Check for "--dired" output.
2673 (when (looking-at "//SUBDIRED//")
2675 (when (looking-at "//DIRED//\\s-+")
2676 (let ((databeg (match-end 0))
2677 (end (point-at-eol)))
2678 ;; Now read the numeric positions of file names.
2680 (while (< (point) end
)
2681 (let ((start (+ beg
(read (current-buffer))))
2682 (end (+ beg
(read (current-buffer)))))
2683 (if (memq (char-after end
) '(?
\n ?\
))
2684 ;; End is followed by \n or by " -> ".
2685 (put-text-property start end
'dired-filename t
))))))
2686 ;; Remove trailing lines.
2687 (goto-char (point-at-bol))
2688 (while (looking-at "//")
2690 (delete-region (match-beginning 0) (point)))
2692 ;; Some busyboxes are reluctant to discard colors.
2693 (unless (string-match "color" (tramp-get-connection-property v
"ls" ""))
2695 (while (re-search-forward tramp-color-escape-sequence-regexp nil t
)
2696 (replace-match "")))
2698 ;; The inserted file could be from somewhere else.
2699 (when (and (not wildcard
) (not full-directory-p
))
2700 (goto-char (point-max))
2701 (when (file-symlink-p filename
)
2702 (goto-char (search-backward "->" beg
'noerror
)))
2704 (if (zerop (length (file-name-nondirectory filename
)))
2706 (file-name-nondirectory filename
))
2708 (replace-match (file-relative-name filename
) t
))
2710 (goto-char (point-max))))))
2712 ;; Canonicalization of file names.
2714 (defun tramp-sh-handle-expand-file-name (name &optional dir
)
2715 "Like `expand-file-name' for Tramp files.
2716 If the localname part of the given filename starts with \"/../\" then
2717 the result will be a local, non-Tramp, filename."
2718 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2719 (setq dir
(or dir default-directory
"/"))
2720 ;; Unless NAME is absolute, concat DIR and NAME.
2721 (unless (file-name-absolute-p name
)
2722 (setq name
(concat (file-name-as-directory dir
) name
)))
2723 ;; If NAME is not a Tramp file, run the real handler.
2724 (if (not (tramp-connectable-p name
))
2725 (tramp-run-real-handler 'expand-file-name
(list name nil
))
2727 (with-parsed-tramp-file-name name nil
2728 (unless (tramp-run-real-handler 'file-name-absolute-p
(list localname
))
2729 (setq localname
(concat "~/" localname
)))
2730 ;; Tilde expansion if necessary. This needs a shell which
2731 ;; groks tilde expansion! The function `tramp-find-shell' is
2732 ;; supposed to find such a shell on the remote host. Please
2733 ;; tell me about it when this doesn't work on your system.
2734 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname
)
2735 (let ((uname (match-string 1 localname
))
2736 (fname (match-string 2 localname
)))
2737 ;; We cannot simply apply "~/", because under sudo "~/" is
2738 ;; expanded to the local user home directory but to the
2739 ;; root home directory. On the other hand, using always
2740 ;; the default user name for tilde expansion is not
2741 ;; appropriate either, because ssh and companions might
2742 ;; use a user name from the config file.
2743 (when (and (string-equal uname
"~")
2744 (string-match "\\`su\\(do\\)?\\'" method
))
2745 (setq uname
(concat uname user
)))
2747 (with-tramp-connection-property v uname
2749 v
(format "cd %s; pwd" (tramp-shell-quote-argument uname
)))
2750 (with-current-buffer (tramp-get-buffer v
)
2751 (goto-char (point-min))
2752 (buffer-substring (point) (point-at-eol)))))
2753 (setq localname
(concat uname fname
))))
2754 ;; There might be a double slash, for example when "~/"
2755 ;; expands to "/". Remove this.
2756 (while (string-match "//" localname
)
2757 (setq localname
(replace-match "/" t t localname
)))
2758 ;; No tilde characters in file name, do normal
2759 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2760 ;; `directory-sep-char' here for XEmacs on Windows, which would
2761 ;; otherwise use backslash. `default-directory' is bound,
2762 ;; because on Windows there would be problems with UNC shares or
2764 (let ((directory-sep-char ?
/)
2765 (default-directory (tramp-compat-temporary-file-directory)))
2766 (tramp-make-tramp-file-name
2768 (tramp-drop-volume-letter
2769 (tramp-run-real-handler
2770 'expand-file-name
(list localname
)))
2773 ;;; Remote commands:
2775 (defun tramp-sh-handle-executable-find (command)
2776 "Like `executable-find' for Tramp files."
2777 (with-parsed-tramp-file-name default-directory nil
2778 (tramp-find-executable v command
(tramp-get-remote-path v
) t
)))
2780 (defun tramp-process-sentinel (proc event
)
2781 "Flush file caches."
2782 (unless (memq (process-status proc
) '(run open
))
2783 (let ((vec (tramp-get-connection-property proc
"vector" nil
)))
2785 (tramp-message vec
5 "Sentinel called: `%s' `%s'" proc event
)
2786 (tramp-flush-connection-property proc
)
2787 (tramp-flush-directory-property vec
"")))))
2789 ;; We use BUFFER also as connection buffer during setup. Because of
2790 ;; this, its original contents must be saved, and restored once
2791 ;; connection has been setup.
2792 (defun tramp-sh-handle-start-file-process (name buffer program
&rest args
)
2793 "Like `start-file-process' for Tramp files."
2794 (with-parsed-tramp-file-name default-directory nil
2795 ;; When PROGRAM is nil, we just provide a tty.
2797 (when (stringp program
)
2798 (format "cd %s; exec env PS1=%s %s"
2799 (tramp-shell-quote-argument localname
)
2800 ;; Use a human-friendly prompt, for example for `shell'.
2801 (tramp-shell-quote-argument
2803 (file-remote-p default-directory
)
2804 tramp-initial-end-of-output
))
2805 (mapconcat 'tramp-shell-quote-argument
2806 (cons program args
) " "))))
2807 (tramp-process-connection-type
2808 (or (null program
) tramp-process-connection-type
))
2809 (bmp (and (buffer-live-p buffer
) (buffer-modified-p buffer
)))
2814 ;; BUFFER can be nil. We use a temporary buffer.
2815 (setq buffer
(generate-new-buffer tramp-temp-buffer-name
)))
2816 (while (get-process name1
)
2817 ;; NAME must be unique as process name.
2819 name1
(format "%s<%d>" name i
)))
2821 ;; Set the new process properties.
2822 (tramp-set-connection-property v
"process-name" name
)
2823 (tramp-set-connection-property v
"process-buffer" buffer
)
2825 (with-current-buffer (tramp-get-connection-buffer v
)
2829 ;; Activate narrowing in order to save BUFFER
2830 ;; contents. Clear also the modification time;
2831 ;; otherwise we might be interrupted by
2832 ;; `verify-visited-file-modtime'.
2833 (let ((buffer-undo-list t
)
2834 (buffer-read-only nil
)
2836 (clear-visited-file-modtime)
2837 (narrow-to-region (point-max) (point-max))
2838 ;; We call `tramp-maybe-open-connection', in order
2839 ;; to cleanup the prompt afterwards.
2840 (tramp-maybe-open-connection v
)
2842 (delete-region mark
(point))
2843 (narrow-to-region (point-max) (point-max))
2846 ;; Send the command.
2847 (tramp-send-command v command nil t
) ; nooutput
2848 ;; Check, whether a pty is associated.
2849 (unless (tramp-compat-process-get
2850 (tramp-get-connection-process v
) 'remote-tty
)
2853 "pty association is not supported for `%s'" name
))))
2854 (let ((p (tramp-get-connection-process v
)))
2855 ;; Set query flag for this process. We ignore errors,
2856 ;; because the process could have finished already.
2858 (tramp-compat-set-process-query-on-exit-flag p t
))
2863 (if (string-match tramp-temp-buffer-name
(buffer-name))
2865 (set-process-buffer (tramp-get-connection-process v
) nil
)
2866 (kill-buffer (current-buffer)))
2867 (set-buffer-modified-p bmp
))
2868 (tramp-set-connection-property v
"process-name" nil
)
2869 (tramp-set-connection-property v
"process-buffer" nil
))))))
2871 (defun tramp-sh-handle-process-file
2872 (program &optional infile destination display
&rest args
)
2873 "Like `process-file' for Tramp files."
2874 ;; The implementation is not complete yet.
2875 (when (and (numberp destination
) (zerop destination
))
2876 (error "Implementation does not handle immediate return"))
2878 (with-parsed-tramp-file-name default-directory nil
2879 (let (command input tmpinput stderr tmpstderr outbuf ret
)
2881 (setq command
(mapconcat 'tramp-shell-quote-argument
2882 (cons program args
) " "))
2885 (setq input
"/dev/null")
2886 (setq infile
(expand-file-name infile
))
2887 (if (tramp-equal-remote default-directory infile
)
2888 ;; INFILE is on the same remote host.
2889 (setq input
(with-parsed-tramp-file-name infile nil localname
))
2890 ;; INFILE must be copied to remote host.
2891 (setq input
(tramp-make-tramp-temp-file v
)
2892 tmpinput
(tramp-make-tramp-file-name method user host input
))
2893 (copy-file infile tmpinput t
)))
2894 (when input
(setq command
(format "%s <%s" command input
)))
2896 ;; Determine output.
2899 ((bufferp destination
)
2900 (setq outbuf destination
))
2902 ((stringp destination
)
2903 (setq outbuf
(get-buffer-create destination
)))
2904 ;; (REAL-DESTINATION ERROR-DESTINATION)
2905 ((consp destination
)
2908 ((bufferp (car destination
))
2909 (setq outbuf
(car destination
)))
2910 ((stringp (car destination
))
2911 (setq outbuf
(get-buffer-create (car destination
))))
2913 (setq outbuf
(current-buffer))))
2916 ((stringp (cadr destination
))
2917 (setcar (cdr destination
) (expand-file-name (cadr destination
)))
2918 (if (tramp-equal-remote default-directory
(cadr destination
))
2919 ;; stderr is on the same remote host.
2920 (setq stderr
(with-parsed-tramp-file-name
2921 (cadr destination
) nil localname
))
2922 ;; stderr must be copied to remote host. The temporary
2923 ;; file must be deleted after execution.
2924 (setq stderr
(tramp-make-tramp-temp-file v
)
2925 tmpstderr
(tramp-make-tramp-file-name
2926 method user host stderr
))))
2927 ;; stderr to be discarded.
2928 ((null (cadr destination
))
2929 (setq stderr
"/dev/null"))))
2932 (setq outbuf
(current-buffer))))
2933 (when stderr
(setq command
(format "%s 2>%s" command stderr
)))
2935 ;; Send the command. It might not return in time, so we protect
2936 ;; it. Call it in a subshell, in order to preserve working
2941 (if (tramp-send-command-and-check
2942 v
(format "\\cd %s; %s"
2943 (tramp-shell-quote-argument localname
)
2947 ;; We should show the output anyway.
2949 (with-current-buffer outbuf
2951 (with-current-buffer (tramp-get-connection-buffer v
)
2953 (when display
(display-buffer outbuf
))))
2954 ;; When the user did interrupt, we should do it also. We use
2955 ;; return code -1 as marker.
2957 (kill-buffer (tramp-get-connection-buffer v
))
2961 (kill-buffer (tramp-get-connection-buffer v
))
2964 ;; Provide error file.
2965 (when tmpstderr
(rename-file tmpstderr
(cadr destination
) t
))
2967 ;; Cleanup. We remove all file cache values for the connection,
2968 ;; because the remote process could have changed them.
2969 (when tmpinput
(delete-file tmpinput
))
2971 ;; `process-file-side-effects' has been introduced with GNU
2972 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2973 ;; by `program'. If it doesn't exist, we assume its default
2975 (unless (and (boundp 'process-file-side-effects
)
2976 (not (symbol-value 'process-file-side-effects
)))
2977 (tramp-flush-directory-property v
""))
2979 ;; Return exit status.
2984 (defun tramp-sh-handle-file-local-copy (filename)
2985 "Like `file-local-copy' for Tramp files."
2986 (with-parsed-tramp-file-name filename nil
2987 (unless (file-exists-p filename
)
2990 "Cannot make local copy of non-existing file `%s'" filename
))
2992 (let* ((size (nth 7 (file-attributes (file-truename filename
))))
2993 (rem-enc (tramp-get-inline-coding v
"remote-encoding" size
))
2994 (loc-dec (tramp-get-inline-coding v
"local-decoding" size
))
2995 (tmpfile (tramp-compat-make-temp-file filename
)))
2999 ;; `copy-file' handles direct copy and out-of-band methods.
3000 ((or (tramp-local-host-p v
)
3001 (tramp-method-out-of-band-p v size
))
3002 (copy-file filename tmpfile t t
))
3004 ;; Use inline encoding for file transfer.
3007 (with-tramp-progress-reporter
3008 v
3 (format "Encoding remote file %s" filename
)
3009 (tramp-barf-unless-okay
3010 v
(format rem-enc
(tramp-shell-quote-argument localname
))
3011 "Encoding remote file failed"))
3013 (if (functionp loc-dec
)
3014 ;; If local decoding is a function, we call it. We
3015 ;; must disable multibyte, because
3016 ;; `uudecode-decode-region' doesn't handle it
3019 (set-buffer-multibyte nil
)
3020 (insert-buffer-substring (tramp-get-buffer v
))
3021 (with-tramp-progress-reporter
3022 v
3 (format "Decoding remote file %s with function %s"
3024 (funcall loc-dec
(point-min) (point-max))
3025 ;; Unset `file-name-handler-alist'. Otherwise,
3026 ;; epa-file gets confused.
3027 (let (file-name-handler-alist
3028 (coding-system-for-write 'binary
))
3029 (write-region (point-min) (point-max) tmpfile
))))
3031 ;; If tramp-decoding-function is not defined for this
3032 ;; method, we invoke tramp-decoding-command instead.
3033 (let ((tmpfile2 (tramp-compat-make-temp-file filename
)))
3034 ;; Unset `file-name-handler-alist'. Otherwise,
3035 ;; epa-file gets confused.
3036 (let (file-name-handler-alist
3037 (coding-system-for-write 'binary
))
3038 (write-region (point-min) (point-max) tmpfile2
))
3039 (with-tramp-progress-reporter
3040 v
3 (format "Decoding remote file %s with command %s"
3043 (tramp-call-local-coding-command
3044 loc-dec tmpfile2 tmpfile
)
3045 (delete-file tmpfile2
)))))
3047 ;; Set proper permissions.
3048 (set-file-modes tmpfile
(tramp-default-file-modes filename
))
3049 ;; Set local user ownership.
3050 (tramp-set-file-uid-gid tmpfile
)))
3052 ;; Oops, I don't know what to do.
3054 v
'file-error
"Wrong method specification for `%s'" method
)))
3058 (delete-file tmpfile
)
3059 (signal (car err
) (cdr err
))))
3061 (run-hooks 'tramp-handle-file-local-copy-hook
)
3064 ;; This is needed for XEmacs only. Code stolen from files.el.
3065 (defun tramp-sh-handle-insert-file-contents-literally
3066 (filename &optional visit beg end replace
)
3067 "Like `insert-file-contents-literally' for Tramp files."
3068 (let ((format-alist nil
)
3069 (after-insert-file-functions nil
)
3070 (coding-system-for-read 'no-conversion
)
3071 (coding-system-for-write 'no-conversion
)
3072 (find-buffer-file-type-function
3073 (if (fboundp 'find-buffer-file-type
)
3074 (symbol-function 'find-buffer-file-type
)
3076 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler
))
3077 (inhibit-file-name-operation 'insert-file-contents
))
3080 (fset 'find-buffer-file-type
(lambda (filename) t
))
3081 (insert-file-contents filename visit beg end replace
))
3083 (if find-buffer-file-type-function
3084 (fset 'find-buffer-file-type find-buffer-file-type-function
)
3085 (fmakunbound 'find-buffer-file-type
)))))
3087 (defun tramp-sh-handle-make-auto-save-file-name ()
3088 "Like `make-auto-save-file-name' for Tramp files.
3089 Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3090 (let ((tramp-auto-save-directory tramp-auto-save-directory
)
3092 (tramp-subst-strs-in-string
3099 (buffer-file-name))))
3100 ;; File name must be unique. This is ensured with Emacs 22 (see
3101 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3102 ;; all other cases we must do it ourselves.
3103 (when (boundp 'auto-save-file-name-transforms
)
3106 (when (and (string-match (car x
) buffer-file-name
)
3107 (not (car (cddr x
))))
3108 (setq tramp-auto-save-directory
3109 (or tramp-auto-save-directory
3110 (tramp-compat-temporary-file-directory)))))
3111 (symbol-value 'auto-save-file-name-transforms
)))
3112 ;; Create directory.
3113 (when tramp-auto-save-directory
3114 (setq buffer-file-name
3115 (expand-file-name buffer-file-name tramp-auto-save-directory
))
3116 (unless (file-exists-p tramp-auto-save-directory
)
3117 (make-directory tramp-auto-save-directory t
)))
3118 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3119 ;; it is not a magic file name operation (since Emacs 22).
3120 ;; We must deactivate it temporarily.
3121 (if (not (ad-is-active 'make-auto-save-file-name
))
3122 (tramp-run-real-handler 'make-auto-save-file-name nil
)
3124 (ad-deactivate 'make-auto-save-file-name
)
3126 (tramp-run-real-handler 'make-auto-save-file-name nil
)
3127 (ad-activate 'make-auto-save-file-name
)))))
3129 ;; CCC grok LOCKNAME
3130 (defun tramp-sh-handle-write-region
3131 (start end filename
&optional append visit lockname confirm
)
3132 "Like `write-region' for Tramp files."
3133 (setq filename
(expand-file-name filename
))
3134 (with-parsed-tramp-file-name filename nil
3135 ;; Following part commented out because we don't know what to do about
3136 ;; file locking, and it does not appear to be a problem to ignore it.
3137 ;; Ange-ftp ignores it, too.
3138 ;; (when (and lockname (stringp lockname))
3139 ;; (setq lockname (expand-file-name lockname)))
3140 ;; (unless (or (eq lockname nil)
3141 ;; (string= lockname filename))
3143 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
3145 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3146 (when (and (not (featurep 'xemacs
)) confirm
(file-exists-p filename
))
3147 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename
))
3148 (tramp-error v
'file-error
"File not overwritten")))
3150 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename
'integer
))
3151 (tramp-get-remote-uid v
'integer
)))
3152 (gid (or (nth 3 (tramp-compat-file-attributes filename
'integer
))
3153 (tramp-get-remote-gid v
'integer
))))
3155 (if (and (tramp-local-host-p v
)
3156 ;; `file-writable-p' calls `file-expand-file-name'. We
3157 ;; cannot use `tramp-run-real-handler' therefore.
3158 (let (file-name-handler-alist)
3160 (file-writable-p (file-name-directory localname
))
3161 (or (file-directory-p localname
)
3162 (file-writable-p localname
)))))
3163 ;; Short track: if we are on the local host, we can run directly.
3164 (tramp-run-real-handler
3166 (list start end localname append
'no-message lockname confirm
))
3168 (let* ((modes (save-excursion (tramp-default-file-modes filename
)))
3169 ;; We use this to save the value of
3170 ;; `last-coding-system-used' after writing the tmp
3171 ;; file. At the end of the function, we set
3172 ;; `last-coding-system-used' to this saved value. This
3173 ;; way, any intermediary coding systems used while
3174 ;; talking to the remote shell or suchlike won't hose
3175 ;; this variable. This approach was snarfed from
3178 ;; Write region into a tmp file. This isn't really
3179 ;; needed if we use an encoding function, but currently
3180 ;; we use it always because this makes the logic
3181 ;; simpler. We must also set `temporary-file-directory',
3182 ;; because it could point to a remote directory.
3183 (temporary-file-directory
3184 (tramp-compat-temporary-file-directory))
3185 (tmpfile (or tramp-temp-buffer-file-name
3186 (tramp-compat-make-temp-file filename
))))
3188 ;; If `append' is non-nil, we copy the file locally, and let
3189 ;; the native `write-region' implementation do the job.
3190 (when append
(copy-file filename tmpfile
'ok
))
3192 ;; We say `no-message' here because we don't want the
3193 ;; visited file modtime data to be clobbered from the temp
3194 ;; file. We call `set-visited-file-modtime' ourselves later
3195 ;; on. We must ensure that `file-coding-system-alist'
3196 ;; matches `tmpfile'.
3197 (let (file-name-handler-alist
3198 (file-coding-system-alist
3199 (tramp-find-file-name-coding-system-alist filename tmpfile
)))
3201 (tramp-run-real-handler
3203 (list start end tmpfile append
'no-message lockname confirm
))
3205 (setq tramp-temp-buffer-file-name nil
)
3206 (delete-file tmpfile
)
3207 (signal (car err
) (cdr err
))))
3209 ;; Now, `last-coding-system-used' has the right value. Remember it.
3210 (when (boundp 'last-coding-system-used
)
3211 (setq coding-system-used
3212 (symbol-value 'last-coding-system-used
))))
3214 ;; The permissions of the temporary file should be set. If
3215 ;; filename does not exist (eq modes nil) it has been
3216 ;; renamed to the backup file. This case `save-buffer'
3217 ;; handles permissions.
3218 ;; Ensure that it is still readable.
3222 (logior (or modes
0) (tramp-compat-octal-to-decimal "0400"))))
3224 ;; This is a bit lengthy due to the different methods
3225 ;; possible for file transfer. First, we check whether the
3226 ;; method uses an rcp program. If so, we call it.
3227 ;; Otherwise, both encoding and decoding command must be
3228 ;; specified. However, if the method _also_ specifies an
3229 ;; encoding function, then that is used for encoding the
3230 ;; contents of the tmp file.
3231 (let* ((size (nth 7 (file-attributes tmpfile
)))
3232 (rem-dec (tramp-get-inline-coding v
"remote-decoding" size
))
3233 (loc-enc (tramp-get-inline-coding v
"local-encoding" size
)))
3235 ;; `copy-file' handles direct copy and out-of-band methods.
3236 ((or (tramp-local-host-p v
)
3237 (tramp-method-out-of-band-p v size
))
3238 (if (and (not (stringp start
))
3239 (= (or end
(point-max)) (point-max))
3240 (= (or start
(point-min)) (point-min))
3241 (tramp-get-method-parameter
3242 method
'tramp-copy-keep-tmpfile
))
3244 (setq tramp-temp-buffer-file-name tmpfile
)
3246 ;; We keep the local file for performance
3247 ;; reasons, useful for "rsync".
3248 (copy-file tmpfile filename t
)
3250 (setq tramp-temp-buffer-file-name nil
)
3251 (delete-file tmpfile
)
3252 (signal (car err
) (cdr err
)))))
3253 (setq tramp-temp-buffer-file-name nil
)
3254 ;; Don't rename, in order to keep context in SELinux.
3256 (copy-file tmpfile filename t
)
3257 (delete-file tmpfile
))))
3259 ;; Use inline file transfer.
3264 (set-buffer-multibyte nil
)
3265 ;; Use encoding function or command.
3266 (if (functionp loc-enc
)
3267 (with-tramp-progress-reporter
3268 v
3 (format "Encoding region using function `%s'"
3270 (let ((coding-system-for-read 'binary
))
3271 (insert-file-contents-literally tmpfile
))
3272 ;; The following `let' is a workaround for the
3273 ;; base64.el that comes with pgnus-0.84. If
3274 ;; both of the following conditions are
3275 ;; satisfied, it tries to write to a local
3276 ;; file in default-directory, but at this
3277 ;; point, default-directory is remote.
3278 ;; (`call-process-region' can't write to
3279 ;; remote files, it seems.) The file in
3280 ;; question is a tmp file anyway.
3281 (let ((default-directory
3282 (tramp-compat-temporary-file-directory)))
3283 (funcall loc-enc
(point-min) (point-max))))
3285 (with-tramp-progress-reporter
3286 v
3 (format "Encoding region using command `%s'"
3288 (unless (zerop (tramp-call-local-coding-command
3292 (concat "Cannot write to `%s', "
3293 "local encoding command `%s' failed")
3294 filename loc-enc
))))
3296 ;; Send buffer into remote decoding command which
3297 ;; writes to remote file. Because this happens on
3298 ;; the remote host, we cannot use the function.
3299 (with-tramp-progress-reporter
3301 (format "Decoding region into remote file %s" filename
)
3302 (goto-char (point-max))
3303 (unless (bolp) (newline))
3307 (concat rem-dec
" <<'EOF'\n%sEOF")
3308 (tramp-shell-quote-argument localname
)
3310 (tramp-barf-unless-okay
3312 "Couldn't write region to `%s', decode using `%s' failed"
3314 ;; When `file-precious-flag' is set, the region is
3315 ;; written to a temporary file. Check that the
3316 ;; checksum is equal to that from the local tmpfile.
3317 (when file-precious-flag
3320 ;; cksum runs locally, if possible.
3321 (zerop (tramp-compat-call-process "cksum" tmpfile t
))
3322 ;; cksum runs remotely.
3323 (tramp-send-command-and-check
3326 "cksum <%s" (tramp-shell-quote-argument localname
)))
3327 ;; ... they are different.
3331 (with-current-buffer (tramp-get-buffer v
)
3335 (concat "Couldn't write region to `%s',"
3336 " decode using `%s' failed")
3337 filename rem-dec
)))))
3340 (delete-file tmpfile
)))
3342 ;; That's not expected.
3346 (concat "Method `%s' should specify both encoding and "
3347 "decoding command or an rcp program")
3350 ;; Make `last-coding-system-used' have the right value.
3351 (when coding-system-used
3352 (set 'last-coding-system-used coding-system-used
))))
3354 (tramp-flush-file-property v
(file-name-directory localname
))
3355 (tramp-flush-file-property v localname
)
3357 ;; We must protect `last-coding-system-used', now we have set it
3358 ;; to its correct value.
3359 (let (last-coding-system-used (need-chown t
))
3360 ;; Set file modification time.
3361 (when (or (eq visit t
) (stringp visit
))
3362 (let ((file-attr (tramp-compat-file-attributes filename
'integer
)))
3363 (set-visited-file-modtime
3364 ;; We must pass modtime explicitly, because filename can
3365 ;; be different from (buffer-file-name), f.e. if
3366 ;; `file-precious-flag' is set.
3368 (when (and (= (nth 2 file-attr
) uid
)
3369 (= (nth 3 file-attr
) gid
))
3370 (setq need-chown nil
))))
3372 ;; Set the ownership.
3374 (tramp-set-file-uid-gid filename uid gid
))
3375 (when (or (eq visit t
) (null visit
) (stringp visit
))
3376 (tramp-message v
0 "Wrote %s" filename
))
3377 (run-hooks 'tramp-handle-write-region-hook
)))))
3379 (defvar tramp-vc-registered-file-names nil
3380 "List used to collect file names, which are checked during `vc-registered'.")
3382 ;; VC backends check for the existence of various different special
3383 ;; files. This is very time consuming, because every single check
3384 ;; requires a remote command (the file cache must be invalidated).
3385 ;; Therefore, we apply a kind of optimization. We install the file
3386 ;; name handler `tramp-vc-file-name-handler', which does nothing but
3387 ;; remembers all file names for which `file-exists-p' or
3388 ;; `file-readable-p' has been applied. A first run of `vc-registered'
3389 ;; is performed. Afterwards, a script is applied for all collected
3390 ;; file names, using just one remote command. The result of this
3391 ;; script is used to fill the file cache with actual values. Now we
3392 ;; can reset the file name handlers, and we make a second run of
3393 ;; `vc-registered', which returns the expected result without sending
3394 ;; any other remote command.
3395 (defun tramp-sh-handle-vc-registered (file)
3396 "Like `vc-registered' for Tramp files."
3397 (tramp-compat-with-temp-message ""
3398 (with-parsed-tramp-file-name file nil
3399 (with-tramp-progress-reporter
3400 v
3 (format "Checking `vc-registered' for %s" file
)
3402 ;; There could be new files, created by the vc backend. We
3403 ;; cannot reuse the old cache entries, therefore.
3404 (let (tramp-vc-registered-file-names
3405 (remote-file-name-inhibit-cache (current-time))
3406 (file-name-handler-alist
3407 `((,tramp-file-name-regexp . tramp-vc-file-name-handler
))))
3409 ;; Here we collect only file names, which need an operation.
3410 (ignore-errors (tramp-run-real-handler 'vc-registered
(list file
)))
3411 (tramp-message v
10 "\n%s" tramp-vc-registered-file-names
)
3413 ;; Send just one command, in order to fill the cache.
3414 (when tramp-vc-registered-file-names
3415 (tramp-maybe-send-script
3417 (format tramp-vc-registered-read-file-names
3418 (tramp-get-file-exists-command v
)
3419 (format "%s -r" (tramp-get-test-command v
)))
3420 "tramp_vc_registered_read_file_names")
3424 (tramp-send-command-and-read
3427 "tramp_vc_registered_read_file_names <<'EOF'\n%s\nEOF\n"
3428 (mapconcat 'tramp-shell-quote-argument
3429 tramp-vc-registered-file-names
3432 (tramp-set-file-property
3433 v
(car elt
) (cadr elt
) (cadr (cdr elt
))))))
3435 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3436 ;; calls shall be answered from the file cache. We unset
3437 ;; `process-file-side-effects' in order to keep the cache when
3438 ;; `process-file' calls appear.
3439 (let (process-file-side-effects)
3440 (tramp-run-real-handler 'vc-registered
(list file
)))))))
3442 ;;;###tramp-autoload
3443 (defun tramp-sh-file-name-handler (operation &rest args
)
3444 "Invoke remote-shell Tramp file name handler.
3445 Fall back to normal file name handler if no Tramp handler exists."
3446 (when (and tramp-locked
(not tramp-locker
))
3447 (setq tramp-locked nil
)
3448 (signal 'file-error
(list "Forbidden reentrant call of Tramp")))
3449 (let ((tl tramp-locked
))
3452 (setq tramp-locked t
)
3453 (let ((tramp-locker t
))
3455 (let ((fn (assoc operation tramp-sh-file-name-handler-alist
)))
3457 (apply (cdr fn
) args
)
3458 (tramp-run-real-handler operation args
))))))
3459 (setq tramp-locked tl
))))
3461 (defun tramp-vc-file-name-handler (operation &rest args
)
3462 "Invoke special file name handler, which collects files to be handled."
3465 (tramp-replace-environment-variables
3466 (apply 'tramp-file-name-for-operation operation args
)))
3467 (fn (assoc operation tramp-sh-file-name-handler-alist
)))
3468 (with-parsed-tramp-file-name filename nil
3470 ;; That's what we want: file names, for which checks are
3471 ;; applied. We assume that VC uses only `file-exists-p' and
3472 ;; `file-readable-p' checks; otherwise we must extend the
3473 ;; list. We do not perform any action, but return nil, in
3474 ;; order to keep `vc-registered' running.
3475 ((and fn
(memq operation
'(file-exists-p file-readable-p
)))
3476 (add-to-list 'tramp-vc-registered-file-names localname
'append
)
3478 ;; `process-file' and `start-file-process' shall be ignored.
3479 ((and fn
(eq operation
'process-file
) 0))
3480 ((and fn
(eq operation
'start-file-process
) nil
))
3481 ;; Tramp file name handlers like `expand-file-name'. They
3483 (fn (save-match-data (apply (cdr fn
) args
)))
3484 ;; Default file name handlers, we don't care.
3485 (t (tramp-run-real-handler operation args
)))))))
3487 ;;; Internal Functions:
3489 (defun tramp-maybe-send-script (vec script name
)
3490 "Define in remote shell function NAME implemented as SCRIPT.
3491 Only send the definition if it has not already been done."
3492 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3494 (let ((scripts (tramp-get-connection-property
3495 (tramp-get-connection-process vec
) "scripts" nil
)))
3496 (unless (member name scripts
)
3497 (with-tramp-progress-reporter vec
5 (format "Sending script `%s'" name
)
3498 ;; The script could contain a call of Perl. This is masked with `%s'.
3499 (tramp-barf-unless-okay
3501 (format "%s () {\n%s\n}" name
3502 (format script
(tramp-get-remote-perl vec
)))
3503 "Script %s sending failed" name
)
3504 (tramp-set-connection-property
3505 (tramp-get-connection-process vec
) "scripts" (cons name scripts
))))))
3507 (defun tramp-set-auto-save ()
3508 (when (and ;; ange-ftp has its own auto-save mechanism
3509 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
3510 'tramp-sh-file-name-handler
)
3512 (auto-save-mode 1)))
3513 (add-hook 'find-file-hooks
'tramp-set-auto-save t
)
3514 (add-hook 'tramp-unload-hook
3516 (remove-hook 'find-file-hooks
'tramp-set-auto-save
)))
3518 (defun tramp-run-test (switch filename
)
3519 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3520 Returns the exit code of the `test' program."
3521 (with-parsed-tramp-file-name filename nil
3522 (tramp-send-command-and-check
3526 (tramp-get-test-command v
)
3528 (tramp-shell-quote-argument localname
)))))
3530 (defun tramp-run-test2 (format-string file1 file2
)
3531 "Run `test'-like program on the remote system, given FILE1, FILE2.
3532 FORMAT-STRING contains the program name, switches, and place holders.
3533 Returns the exit code of the `test' program. Barfs if the methods,
3534 hosts, or files, disagree."
3535 (unless (tramp-equal-remote file1 file2
)
3536 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1
) file1 file2
) nil
3539 "tramp-run-test2 only implemented for same method, user, host")))
3540 (with-parsed-tramp-file-name file1 v1
3541 (with-parsed-tramp-file-name file1 v2
3542 (tramp-send-command-and-check
3544 (format format-string
3545 (tramp-shell-quote-argument v1-localname
)
3546 (tramp-shell-quote-argument v2-localname
))))))
3548 (defun tramp-find-executable
3549 (vec progname dirlist
&optional ignore-tilde ignore-path
)
3550 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3551 First arg VEC specifies the connection, PROGNAME is the program
3552 to search for, and DIRLIST gives the list of directories to
3553 search. If IGNORE-TILDE is non-nil, directory names starting
3554 with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3557 Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3559 This function expects to be in the right *tramp* buffer."
3560 (with-current-buffer (tramp-get-connection-buffer vec
)
3562 ;; Check whether the executable is in $PATH. "which(1)" does not
3563 ;; report always a correct error code; therefore we check the
3564 ;; number of words it returns.
3566 (tramp-send-command vec
(format "which \\%s | wc -w" progname
))
3567 (goto-char (point-min))
3568 (if (looking-at "^\\s-*1$")
3569 (setq result
(concat "\\" progname
))))
3572 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3573 ;; `remove' is in CL, and we want to avoid CL dependencies.
3576 (setq d
(car dirlist
))
3577 (setq dirlist
(cdr dirlist
))
3578 (unless (char-equal ?~
(aref d
0))
3579 (setq newdl
(cons d newdl
))))
3580 (setq dirlist
(nreverse newdl
))))
3583 (format (concat "while read d; "
3584 "do if test -x $d/%s -a -f $d/%s; "
3585 "then echo tramp_executable $d/%s; "
3586 "break; fi; done <<'EOF'\n"
3588 progname progname progname
(mapconcat 'identity dirlist
"\n")))
3589 (goto-char (point-max))
3590 (when (search-backward "tramp_executable " nil t
)
3591 (skip-chars-forward "^ ")
3592 (skip-chars-forward " ")
3593 (setq result
(buffer-substring (point) (point-at-eol)))))
3596 (defun tramp-set-remote-path (vec)
3597 "Sets the remote environment PATH to existing directories.
3598 I.e., for each directory in `tramp-remote-path', it is tested
3599 whether it exists and if so, it is added to the environment
3601 (tramp-message vec
5 (format "Setting $PATH environment variable"))
3603 vec
(format "PATH=%s; export PATH"
3604 (mapconcat 'identity
(tramp-get-remote-path vec
) ":"))))
3606 ;; ------------------------------------------------------------
3607 ;; -- Communication with external shell --
3608 ;; ------------------------------------------------------------
3610 (defun tramp-find-file-exists-command (vec)
3611 "Find a command on the remote host for checking if a file exists.
3612 Here, we are looking for a command which has zero exit status if the
3613 file exists and nonzero exit status otherwise."
3614 (let ((existing "/")
3616 (tramp-shell-quote-argument "/ this file does not exist "))
3618 ;; The algorithm is as follows: we try a list of several commands.
3619 ;; For each command, we first run `$cmd /' -- this should return
3620 ;; true, as the root directory always exists. And then we run
3621 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3622 ;; does not exist. This should return false. We use the first
3623 ;; command we find that seems to work.
3624 ;; The list of commands to try is as follows:
3625 ;; `ls -d' This works on most systems, but NetBSD 1.4
3626 ;; has a bug: `ls' always returns zero exit
3627 ;; status, even for files which don't exist.
3628 ;; `test -e' Some Bourne shells have a `test' builtin
3629 ;; which does not know the `-e' option.
3630 ;; `/bin/test -e' For those, the `test' binary on disk normally
3631 ;; provides the option. Alas, the binary
3632 ;; is sometimes `/bin/test' and sometimes it's
3634 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3637 (and (setq result
(format "%s -e" (tramp-get-test-command vec
)))
3638 (tramp-send-command-and-check
3639 vec
(format "%s %s" result existing
))
3640 (not (tramp-send-command-and-check
3641 vec
(format "%s %s" result nonexistent
)))))
3643 (and (setq result
"/bin/test -e")
3644 (tramp-send-command-and-check
3645 vec
(format "%s %s" result existing
))
3646 (not (tramp-send-command-and-check
3647 vec
(format "%s %s" result nonexistent
)))))
3649 (and (setq result
"/usr/bin/test -e")
3650 (tramp-send-command-and-check
3651 vec
(format "%s %s" result existing
))
3652 (not (tramp-send-command-and-check
3653 vec
(format "%s %s" result nonexistent
)))))
3655 (and (setq result
(format "%s -d" (tramp-get-ls-command vec
)))
3656 (tramp-send-command-and-check
3657 vec
(format "%s %s" result existing
))
3658 (not (tramp-send-command-and-check
3659 vec
(format "%s %s" result nonexistent
))))))
3661 vec
'file-error
"Couldn't find command to check if file exists"))
3664 (defun tramp-open-shell (vec shell
)
3665 "Opens shell SHELL."
3666 (with-tramp-progress-reporter
3667 vec
5 (format "Opening remote shell `%s'" shell
)
3668 ;; Find arguments for this shell.
3669 (let ((tramp-end-of-output tramp-initial-end-of-output
)
3670 (alist tramp-sh-extra-args
)
3672 (while (and alist
(null extra-args
))
3673 (setq item
(pop alist
))
3674 (when (string-match (car item
) shell
)
3675 (setq extra-args
(cdr item
))))
3678 "exec env ENV='' PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s %s"
3679 (tramp-shell-quote-argument tramp-end-of-output
)
3680 shell
(or extra-args
""))
3682 (tramp-set-connection-property
3683 (tramp-get-connection-process vec
) "remote-shell" shell
)
3686 vec
(format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output
)) t
)
3687 (tramp-send-command vec
"PS2=''" t
)
3688 (tramp-send-command vec
"PS3=''" t
)
3689 (tramp-send-command vec
"PROMPT_COMMAND=''" t
)))
3691 (defun tramp-find-shell (vec)
3692 "Opens a shell on the remote host which groks tilde expansion."
3693 (with-current-buffer (tramp-get-buffer vec
)
3694 (let ((default-shell
3696 (tramp-get-connection-property
3697 (tramp-get-connection-process vec
) "remote-shell" nil
)
3698 (tramp-get-method-parameter
3699 (tramp-file-name-method vec
) 'tramp-remote-shell
)))
3702 (with-tramp-connection-property vec
"remote-shell"
3703 ;; CCC: "root" does not exist always, see QNAP 459.
3704 ;; Which check could we apply instead?
3705 (tramp-send-command vec
"echo ~root" t
)
3706 (if (or (string-match "^~root$" (buffer-string))
3707 ;; The default shell (ksh93) of OpenSolaris and
3708 ;; Solaris is buggy. We've got reports for
3709 ;; "SunOS 5.10" and "SunOS 5.11" so far.
3710 (string-match (regexp-opt '("SunOS 5.10" "SunOS 5.11"))
3711 (tramp-get-connection-property
3714 (or (tramp-find-executable
3715 vec
"bash" (tramp-get-remote-path vec
) t t
)
3716 (tramp-find-executable
3717 vec
"ksh" (tramp-get-remote-path vec
) t t
)
3718 ;; Maybe it works at least for some other commands.
3724 "Couldn't find a remote shell which groks tilde "
3725 "expansion, using `%s'")
3730 ;; Open a new shell if needed.
3731 (unless (string-equal shell default-shell
)
3733 vec
5 "Starting remote shell `%s' for tilde expansion" shell
)
3734 (tramp-open-shell vec shell
))
3736 ;; Busyboxes tend to behave strange. We check for the existence.
3737 (with-tramp-connection-property vec
"busybox"
3738 (tramp-send-command vec
(format "%s --version" shell
) t
)
3739 (let ((case-fold-search t
))
3740 (and (string-match "busybox" (buffer-string)) t
))))))
3742 ;; Utility functions.
3744 (defun tramp-barf-if-no-shell-prompt (proc timeout
&rest error-args
)
3745 "Wait for shell prompt and barf if none appears.
3746 Looks at process PROC to see if a shell prompt appears in TIMEOUT
3747 seconds. If not, it produces an error message with the given ERROR-ARGS."
3749 (tramp-wait-for-regexp
3752 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern
))
3753 (apply 'tramp-error-with-buffer nil proc
'file-error error-args
)))
3755 (defun tramp-open-connection-setup-interactive-shell (proc vec
)
3756 "Set up an interactive shell.
3757 Mainly sets the prompt and the echo correctly. PROC is the shell
3758 process to set up. VEC specifies the connection."
3759 (let ((tramp-end-of-output tramp-initial-end-of-output
))
3760 ;; It is useful to set the prompt in the following command because
3761 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3762 ;; about and thus /bin/sh will display a strange prompt. For
3763 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3764 ;; display the current working directory but /bin/sh will display
3765 ;; a dollar sign. The following command line sets $PS1 to a sane
3766 ;; value, and works under Bourne-ish shells as well as csh-like
3767 ;; shells. Daniel Pittman reports that the unusual positioning of
3768 ;; the single quotes makes it work under `rc', too. We also unset
3769 ;; the variable $ENV because that is read by some sh
3770 ;; implementations (eg, bash when called as sh) on startup; this
3771 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
3772 ;; is another way to set the prompt in /bin/bash, it must be
3773 ;; discarded as well.
3776 (or (tramp-get-connection-property vec
"remote-shell" nil
)
3777 (tramp-get-method-parameter
3778 (tramp-file-name-method vec
) 'tramp-remote-shell
)))
3781 (tramp-message vec
5 "Setting up remote shell environment")
3782 (tramp-send-command vec
"stty -inlcr -echo kill '^U' erase '^H'" t
)
3783 ;; Check whether the echo has really been disabled. Some
3784 ;; implementations, like busybox of embedded GNU/Linux, don't
3785 ;; support disabling.
3786 (tramp-send-command vec
"echo foo" t
)
3787 (with-current-buffer (process-buffer proc
)
3788 (goto-char (point-min))
3789 (when (looking-at "echo foo")
3790 (tramp-set-connection-property proc
"remote-echo" t
)
3791 (tramp-message vec
5 "Remote echo still on. Ok.")
3792 ;; Make sure backspaces and their echo are enabled and no line
3793 ;; width magic interferes with them.
3794 (tramp-send-command vec
"stty icanon erase ^H cols 32767" t
))))
3796 (tramp-message vec
5 "Setting shell prompt")
3798 vec
(format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output
)) t
)
3799 (tramp-send-command vec
"PS2=''" t
)
3800 (tramp-send-command vec
"PS3=''" t
)
3801 (tramp-send-command vec
"PROMPT_COMMAND=''" t
)
3803 ;; Try to set up the coding system correctly.
3804 ;; CCC this can't be the right way to do it. Hm.
3805 (tramp-message vec
5 "Determining coding system")
3806 (tramp-send-command vec
"echo foo ; echo bar" t
)
3807 (with-current-buffer (process-buffer proc
)
3808 (goto-char (point-min))
3809 (if (featurep 'mule
)
3810 ;; Use MULE to select the right EOL convention for communicating
3811 ;; with the process.
3812 (let* ((cs (or (tramp-compat-funcall 'process-coding-system proc
)
3813 (cons 'undecided
'undecided
)))
3814 cs-decode cs-encode
)
3815 (when (symbolp cs
) (setq cs
(cons cs cs
)))
3816 (setq cs-decode
(car cs
))
3817 (setq cs-encode
(cdr cs
))
3818 (unless cs-decode
(setq cs-decode
'undecided
))
3819 (unless cs-encode
(setq cs-encode
'undecided
))
3820 (setq cs-encode
(tramp-compat-coding-system-change-eol-conversion
3822 (when (search-forward "\r" nil t
)
3823 (setq cs-decode
(tramp-compat-coding-system-change-eol-conversion
3825 (tramp-compat-funcall
3826 'set-buffer-process-coding-system cs-decode cs-encode
)
3828 vec
5 "Setting coding system to `%s' and `%s'" cs-decode cs-encode
))
3829 ;; Look for ^M and do something useful if found.
3830 (when (search-forward "\r" nil t
)
3831 ;; We have found a ^M but cannot frob the process coding system
3832 ;; because we're running on a non-MULE Emacs. Let's try
3834 (tramp-send-command vec
"stty -onlcr" t
))))
3836 (tramp-send-command vec
"set +o vi +o emacs" t
)
3838 ;; Check whether the output of "uname -sr" has been changed. If
3839 ;; yes, this is a strong indication that we must expire all
3840 ;; connection properties. We start again with
3841 ;; `tramp-maybe-open-connection', it will be caught there.
3842 (tramp-message vec
5 "Checking system information")
3843 (let ((old-uname (tramp-get-connection-property vec
"uname" nil
))
3845 (tramp-set-connection-property
3847 (tramp-send-command-and-read vec
"echo \\\"`uname -sr`\\\""))))
3848 (when (and (stringp old-uname
) (not (string-equal old-uname new-uname
)))
3852 "Connection reset, because remote host changed from `%s' to `%s'"
3853 old-uname new-uname
)
3854 (throw 'uname-changed
(tramp-maybe-open-connection vec
))))
3856 ;; Check whether the remote host suffers from buggy
3857 ;; `send-process-string'. This is known for FreeBSD (see comment in
3858 ;; `send_process', file process.c). I've tested sending 624 bytes
3859 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3860 ;; this host type is detected locally. It cannot handle remote
3862 (with-tramp-connection-property proc
"chunksize"
3864 ((and (integerp tramp-chunksize
) (> tramp-chunksize
0))
3868 vec
5 "Checking remote host type for `send-process-string' bug")
3870 "^FreeBSD" (tramp-get-connection-property vec
"uname" ""))
3873 ;; Set remote PATH variable.
3874 (tramp-set-remote-path vec
)
3876 ;; Search for a good shell before searching for a command which
3877 ;; checks if a file exists. This is done because Tramp wants to use
3878 ;; "test foo; echo $?" to check if various conditions hold, and
3879 ;; there are buggy /bin/sh implementations which don't execute the
3880 ;; "echo $?" part if the "test" part has an error. In particular,
3881 ;; the OpenSolaris /bin/sh is a problem. There are also other
3882 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3883 ;; in function declarations, or changing HISTFILE in place.
3884 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3886 (tramp-find-shell vec
)
3888 ;; Disable unexpected output.
3889 (tramp-send-command vec
"mesg n; biff n" t
)
3891 ;; IRIX64 bash expands "!" even when in single quotes. This
3892 ;; destroys our shell functions, we must disable it. See
3893 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3894 (when (string-match "^IRIX64" (tramp-get-connection-property vec
"uname" ""))
3895 (tramp-send-command vec
"set +H" t
))
3897 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3898 (when (string-match "BSD\\|Darwin"
3899 (tramp-get-connection-property vec
"uname" ""))
3900 (tramp-send-command vec
"stty -oxtabs" t
))
3902 ;; Set `remote-tty' process property.
3903 (let ((tty (tramp-send-command-and-read vec
"echo \\\"`tty`\\\"" 'noerror
)))
3904 (unless (zerop (length tty
))
3905 (tramp-compat-process-put proc
'remote-tty tty
)))
3907 ;; Dump stty settings in the traces.
3908 (when (>= tramp-verbose
9)
3909 (tramp-send-command vec
"stty -a" t
))
3911 ;; Set the environment.
3912 (tramp-message vec
5 "Setting default environment")
3914 (let ((env (copy-sequence tramp-remote-process-environment
))
3917 (setq item
(tramp-compat-split-string (car env
) "="))
3918 (setcdr item
(mapconcat 'identity
(cdr item
) "="))
3919 (if (and (stringp (cdr item
)) (not (string-equal (cdr item
) "")))
3921 vec
(format "%s=%s; export %s" (car item
) (cdr item
) (car item
)) t
)
3922 (push (car item
) unset
))
3923 (setq env
(cdr env
)))
3926 vec
(format "unset %s" (mapconcat 'identity unset
" ")) t
))))
3928 ;; CCC: We should either implement a Perl version of base64 encoding
3929 ;; and decoding. Then we just use that in the last item. The other
3930 ;; alternative is to use the Perl version of UU encoding. But then
3931 ;; we need a Lisp version of uuencode.
3933 ;; Old text from documentation of tramp-methods:
3934 ;; Using a uuencode/uudecode inline method is discouraged, please use one
3935 ;; of the base64 methods instead since base64 encoding is much more
3936 ;; reliable and the commands are more standardized between the different
3937 ;; Unix versions. But if you can't use base64 for some reason, please
3938 ;; note that the default uudecode command does not work well for some
3939 ;; Unices, in particular AIX and Irix. For AIX, you might want to use
3940 ;; the following command for uudecode:
3942 ;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3944 ;; For Irix, no solution is known yet.
3946 (autoload 'uudecode-decode-region
"uudecode")
3948 (defconst tramp-local-coding-commands
3949 '((b64 base64-encode-region base64-decode-region
)
3950 (uu tramp-uuencode-region uudecode-decode-region
)
3952 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3953 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
3954 "List of local coding commands for inline transfer.
3955 Each item is a list that looks like this:
3957 \(FORMAT ENCODING DECODING\)
3959 FORMAT is symbol describing the encoding/decoding format. It can be
3960 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3962 ENCODING and DECODING can be strings, giving commands, or symbols,
3963 giving functions. If they are strings, then they can contain
3964 the \"%s\" format specifier. If that specifier is present, the input
3965 filename will be put into the command line at that spot. If the
3966 specifier is not present, the input should be read from standard
3969 If they are functions, they will be called with two arguments, start
3970 and end of region, and are expected to replace the region contents
3971 with the encoded or decoded results, respectively.")
3973 (defconst tramp-remote-coding-commands
3974 '((b64 "base64" "base64 -d -i")
3975 ;; "-i" is more robust with older base64 from GNU coreutils.
3976 ;; However, I don't know whether all base64 versions do supports
3978 (b64 "base64" "base64 -d")
3979 (b64 "mimencode -b" "mimencode -u -b")
3980 (b64 "mmencode -b" "mmencode -u -b")
3981 (b64 "recode data..base64" "recode base64..data")
3982 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module
)
3983 (b64 tramp-perl-encode tramp-perl-decode
)
3984 (uu "uuencode xxx" "uudecode -o /dev/stdout" "test -c /dev/stdout")
3985 (uu "uuencode xxx" "uudecode -o -")
3986 (uu "uuencode xxx" "uudecode -p")
3987 (uu "uuencode xxx" tramp-uudecode
)
3989 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3990 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
3991 "List of remote coding commands for inline transfer.
3992 Each item is a list that looks like this:
3994 \(FORMAT ENCODING DECODING [TEST]\)
3996 FORMAT is symbol describing the encoding/decoding format. It can be
3997 `b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3999 ENCODING and DECODING can be strings, giving commands, or symbols,
4000 giving variables. If they are strings, then they can contain
4001 the \"%s\" format specifier. If that specifier is present, the input
4002 filename will be put into the command line at that spot. If the
4003 specifier is not present, the input should be read from standard
4006 If they are variables, this variable is a string containing a Perl
4007 implementation for this functionality. This Perl program will be transferred
4008 to the remote host, and it is available as shell function with the same name.
4010 The optional TEST command can be used for further tests, whether
4011 ENCODING and DECODING are applicable.")
4013 (defun tramp-find-inline-encoding (vec)
4014 "Find an inline transfer encoding that works.
4015 Goes through the list `tramp-local-coding-commands' and
4016 `tramp-remote-coding-commands'."
4018 (let ((local-commands tramp-local-coding-commands
)
4020 (p (tramp-get-connection-process vec
))
4021 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found
)
4022 (while (and local-commands
(not found
))
4023 (setq litem
(pop local-commands
))
4024 (catch 'wont-work-local
4025 (let ((format (nth 0 litem
))
4026 (remote-commands tramp-remote-coding-commands
))
4027 (setq loc-enc
(nth 1 litem
))
4028 (setq loc-dec
(nth 2 litem
))
4029 ;; If the local encoder or decoder is a string, the
4030 ;; corresponding command has to work locally.
4031 (if (not (stringp loc-enc
))
4033 vec
5 "Checking local encoding function `%s'" loc-enc
)
4035 vec
5 "Checking local encoding command `%s' for sanity" loc-enc
)
4036 (unless (zerop (tramp-call-local-coding-command
4038 (throw 'wont-work-local nil
)))
4039 (if (not (stringp loc-dec
))
4041 vec
5 "Checking local decoding function `%s'" loc-dec
)
4043 vec
5 "Checking local decoding command `%s' for sanity" loc-dec
)
4044 (unless (zerop (tramp-call-local-coding-command
4046 (throw 'wont-work-local nil
)))
4047 ;; Search for remote coding commands with the same format
4048 (while (and remote-commands
(not found
))
4049 (setq ritem
(pop remote-commands
))
4050 (catch 'wont-work-remote
4051 (when (equal format
(nth 0 ritem
))
4052 (setq rem-enc
(nth 1 ritem
))
4053 (setq rem-dec
(nth 2 ritem
))
4054 (setq rem-test
(nth 3 ritem
))
4055 ;; Check the remote test command if exists.
4056 (when (stringp rem-test
)
4058 vec
5 "Checking remote test command `%s'" rem-test
)
4059 (unless (tramp-send-command-and-check vec rem-test t
)
4060 (throw 'wont-work-remote nil
)))
4061 ;; Check if remote encoding and decoding commands can be
4062 ;; called remotely with null input and output. This makes
4063 ;; sure there are no syntax errors and the command is really
4064 ;; found. Note that we do not redirect stdout to /dev/null,
4065 ;; for two reasons: when checking the decoding command, we
4066 ;; actually check the output it gives. And also, when
4067 ;; redirecting "mimencode" output to /dev/null, then as root
4068 ;; it might change the permissions of /dev/null!
4069 (when (not (stringp rem-enc
))
4070 (let ((name (symbol-name rem-enc
)))
4071 (while (string-match (regexp-quote "-") name
)
4072 (setq name
(replace-match "_" nil t name
)))
4073 (tramp-maybe-send-script vec
(symbol-value rem-enc
) name
)
4074 (setq rem-enc name
)))
4077 "Checking remote encoding command `%s' for sanity" rem-enc
)
4078 (unless (tramp-send-command-and-check
4079 vec
(format "%s </dev/null" rem-enc
) t
)
4080 (throw 'wont-work-remote nil
))
4082 (when (not (stringp rem-dec
))
4083 (let ((name (symbol-name rem-dec
)))
4084 (while (string-match (regexp-quote "-") name
)
4085 (setq name
(replace-match "_" nil t name
)))
4086 (tramp-maybe-send-script vec
(symbol-value rem-dec
) name
)
4087 (setq rem-dec name
)))
4090 "Checking remote decoding command `%s' for sanity" rem-dec
)
4091 (unless (tramp-send-command-and-check
4093 (format "echo %s | %s | %s" magic rem-enc rem-dec
)
4095 (throw 'wont-work-remote nil
))
4097 (with-current-buffer (tramp-get-buffer vec
)
4098 (goto-char (point-min))
4099 (unless (looking-at (regexp-quote magic
))
4100 (throw 'wont-work-remote nil
)))
4102 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4103 (setq rem-enc
(nth 1 ritem
))
4104 (setq rem-dec
(nth 2 ritem
))
4105 (setq found t
)))))))
4107 ;; Did we find something?
4110 vec
'file-error
"Couldn't find an inline transfer encoding"))
4112 ;; Set connection properties. Since the commands are risky (due
4113 ;; to output direction), we cache them in the process cache.
4114 (tramp-message vec
5 "Using local encoding `%s'" loc-enc
)
4115 (tramp-set-connection-property p
"local-encoding" loc-enc
)
4116 (tramp-message vec
5 "Using local decoding `%s'" loc-dec
)
4117 (tramp-set-connection-property p
"local-decoding" loc-dec
)
4118 (tramp-message vec
5 "Using remote encoding `%s'" rem-enc
)
4119 (tramp-set-connection-property p
"remote-encoding" rem-enc
)
4120 (tramp-message vec
5 "Using remote decoding `%s'" rem-dec
)
4121 (tramp-set-connection-property p
"remote-decoding" rem-dec
))))
4123 (defun tramp-call-local-coding-command (cmd input output
)
4124 "Call the local encoding or decoding command.
4125 If CMD contains \"%s\", provide input file INPUT there in command.
4126 Otherwise, INPUT is passed via standard input.
4127 INPUT can also be nil which means `/dev/null'.
4128 OUTPUT can be a string (which specifies a filename), or t (which
4129 means standard output and thus the current buffer), or nil (which
4131 (tramp-compat-call-process
4132 tramp-encoding-shell
4133 (when (and input
(not (string-match "%s" cmd
))) input
)
4134 (if (eq output t
) t nil
)
4136 tramp-encoding-command-switch
4138 (if (string-match "%s" cmd
) (format cmd input
) cmd
)
4139 (if (stringp output
) (concat "> " output
) ""))))
4141 (defconst tramp-inline-compress-commands
4142 '(("gzip" "gzip -d")
4143 ("bzip2" "bzip2 -d")
4145 ("compress" "compress -d"))
4146 "List of compress and decompress commands for inline transfer.
4147 Each item is a list that looks like this:
4149 \(COMPRESS DECOMPRESS\)
4151 COMPRESS or DECOMPRESS are strings with the respective commands.")
4153 (defun tramp-find-inline-compress (vec)
4154 "Find an inline transfer compress command that works.
4155 Goes through the list `tramp-inline-compress-commands'."
4157 (let ((commands tramp-inline-compress-commands
)
4159 (p (tramp-get-connection-process vec
))
4160 item compress decompress found
)
4161 (while (and commands
(not found
))
4163 (setq item
(pop commands
)
4164 compress
(nth 0 item
)
4165 decompress
(nth 1 item
))
4168 "Checking local compress command `%s', `%s' for sanity"
4169 compress decompress
)
4172 (tramp-call-local-coding-command
4174 ;; Windows shells need the program file name after
4175 ;; the pipe symbol be quoted if they use forward
4176 ;; slashes as directory separators.
4177 (if (memq system-type
'(windows-nt))
4178 "echo %s | \"%s\" | \"%s\""
4179 "echo %s | %s | %s")
4180 magic compress decompress
) nil nil
))
4184 "Checking remote compress command `%s', `%s' for sanity"
4185 compress decompress
)
4186 (unless (tramp-send-command-and-check
4187 vec
(format "echo %s | %s | %s" magic compress decompress
) t
)
4191 ;; Did we find something?
4194 ;; Set connection properties. Since the commands are
4195 ;; risky (due to output direction), we cache them in the
4198 vec
5 "Using inline transfer compress command `%s'" compress
)
4199 (tramp-set-connection-property p
"inline-compress" compress
)
4201 vec
5 "Using inline transfer decompress command `%s'" decompress
)
4202 (tramp-set-connection-property p
"inline-decompress" decompress
))
4204 (tramp-set-connection-property p
"inline-compress" nil
)
4205 (tramp-set-connection-property p
"inline-decompress" nil
)
4207 vec
2 "Couldn't find an inline transfer compress command")))))
4209 (defun tramp-compute-multi-hops (vec)
4210 "Expands VEC according to `tramp-default-proxies-alist'.
4211 Gateway hops are already opened."
4212 (let ((target-alist `(,vec
))
4213 (hops (or (tramp-file-name-hop vec
) ""))
4217 ;; Ad-hoc proxy definitions.
4218 (dolist (proxy (reverse (split-string hops tramp-postfix-hop-regexp
'omit
)))
4219 (let ((user (tramp-file-name-user item
))
4220 (host (tramp-file-name-host item
))
4222 tramp-prefix-format proxy tramp-postfix-host-format
)))
4224 vec
5 "Add proxy (\"%s\" \"%s\" \"%s\")"
4225 (and (stringp host
) (regexp-quote host
))
4226 (and (stringp user
) (regexp-quote user
))
4230 'tramp-default-proxies-alist
4231 (list (and (stringp host
) (regexp-quote host
))
4232 (and (stringp user
) (regexp-quote user
))
4234 (setq item
(tramp-dissect-file-name proxy
))))
4235 ;; Save the new value.
4236 (when (and hops tramp-save-ad-hoc-proxies
)
4237 (customize-save-variable
4238 'tramp-default-proxies-alist tramp-default-proxies-alist
))
4240 ;; Look for proxy hosts to be passed.
4241 (setq choices tramp-default-proxies-alist
)
4243 (setq item
(pop choices
)
4244 proxy
(eval (nth 2 item
)))
4247 (string-match (or (eval (nth 0 item
)) "")
4248 (or (tramp-file-name-host (car target-alist
)) ""))
4250 (string-match (or (eval (nth 1 item
)) "")
4251 (or (tramp-file-name-user (car target-alist
)) "")))
4253 ;; No more hops needed.
4255 ;; Replace placeholders.
4260 ?u
(or (tramp-file-name-user (car target-alist
)) "")
4261 ?h
(or (tramp-file-name-host (car target-alist
)) ""))))
4262 (with-parsed-tramp-file-name proxy l
4264 (add-to-list 'target-alist l
)
4265 ;; Start next search.
4266 (setq choices tramp-default-proxies-alist
)))))
4271 "^\\(%s\\|%s\\)$" tramp-gw-tunnel-method tramp-gw-socks-method
)
4272 (tramp-file-name-method (car target-alist
)))
4273 (let ((gw (pop target-alist
))
4274 (hop (pop target-alist
)))
4275 ;; Is the method prepared for gateways?
4276 (unless (tramp-file-name-port hop
)
4279 "Connection `%s' is not supported for gateway access." hop
))
4280 ;; Open the gateway connection.
4284 (tramp-file-name-method hop
) (tramp-file-name-user hop
)
4285 (tramp-compat-funcall 'tramp-gw-open-connection vec gw hop
) nil nil
))
4286 ;; For the password prompt, we need the correct values.
4287 ;; Therefore, we must remember the gateway vector. But we
4288 ;; cannot do it as connection property, because it shouldn't
4289 ;; be persistent. And we have no started process yet either.
4290 (tramp-set-file-property (car target-alist
) "" "gateway" hop
)))
4292 ;; Foreign and out-of-band methods are not supported for multi-hops.
4293 (when (cdr target-alist
)
4294 (setq choices target-alist
)
4296 (setq item
(pop choices
))
4300 (tramp-get-method-parameter
4301 (tramp-file-name-method item
) 'tramp-login-program
))
4302 (tramp-get-method-parameter
4303 (tramp-file-name-method item
) 'tramp-copy-program
))
4306 "Method `%s' is not supported for multi-hops."
4307 (tramp-file-name-method item
)))))
4309 ;; In case the host name is not used for the remote shell
4310 ;; command, the user could be misguided by applying a random
4312 (let* ((v (car target-alist
))
4313 (method (tramp-file-name-method v
))
4314 (host (tramp-file-name-host v
)))
4317 ;; There are multi-hops.
4319 ;; The host name is used for the remote shell command.
4321 '("%h") (tramp-get-method-parameter method
'tramp-login-args
))
4322 ;; The host is local. We cannot use `tramp-local-host-p'
4323 ;; here, because it opens a connection as well.
4324 (string-match tramp-local-host-regexp host
))
4327 "Host `%s' looks like a remote host, `%s' can only use the local host"
4333 (defvar tramp-current-connection nil
4334 "Last connection timestamp.")
4336 (defun tramp-maybe-open-connection (vec)
4337 "Maybe open a connection VEC.
4338 Does not do anything if a connection is already open, but re-opens the
4339 connection if a previous connection has died for some reason."
4340 (catch 'uname-changed
4341 (let ((p (tramp-get-connection-process vec
))
4342 (process-name (tramp-get-connection-property vec
"process-name" nil
))
4343 (process-environment (copy-sequence process-environment
))
4344 (pos (with-current-buffer (tramp-get-connection-buffer vec
) (point))))
4346 ;; If Tramp opens the same connection within a short time frame,
4347 ;; there is a problem. We shall signal this.
4348 (unless (or (and p
(processp p
) (memq (process-status p
) '(run open
)))
4349 (not (equal (butlast (append vec nil
))
4350 (car tramp-current-connection
)))
4352 (current-time) (cdr tramp-current-connection
))
4354 (throw 'suppress
'suppress
))
4356 ;; If too much time has passed since last command was sent, look
4357 ;; whether process is still alive. If it isn't, kill it. When
4358 ;; using ssh, it can sometimes happen that the remote end has
4359 ;; hung up but the local ssh client doesn't recognize this until
4360 ;; it tries to send some data to the remote end. So that's why
4361 ;; we try to send a command from time to time, then look again
4362 ;; whether the process is really alive.
4364 (when (and (> (tramp-time-diff
4366 (tramp-get-connection-property
4367 p
"last-cmd-time" '(0 0 0)))
4369 p
(processp p
) (memq (process-status p
) '(run open
)))
4370 (tramp-send-command vec
"echo are you awake" t t
)
4371 (unless (and (memq (process-status p
) '(run open
))
4372 (tramp-wait-for-output p
10))
4373 ;; The error will be caught locally.
4374 (tramp-error vec
'file-error
"Awake did fail")))
4379 ;; New connection must be opened.
4381 (unless (and p
(processp p
) (memq (process-status p
) '(run open
)))
4383 ;; We call `tramp-get-buffer' in order to get a debug
4384 ;; buffer for messages from the beginning.
4385 (tramp-get-buffer vec
)
4387 ;; If `non-essential' is non-nil, don't reopen a new connection.
4388 (when (and (boundp 'non-essential
) (symbol-value 'non-essential
))
4389 (throw 'non-essential
'non-essential
))
4391 (with-tramp-progress-reporter
4393 (if (zerop (length (tramp-file-name-user vec
)))
4394 (format "Opening connection for %s using %s"
4395 (tramp-file-name-host vec
)
4396 (tramp-file-name-method vec
))
4397 (format "Opening connection for %s@%s using %s"
4398 (tramp-file-name-user vec
)
4399 (tramp-file-name-host vec
)
4400 (tramp-file-name-method vec
)))
4402 ;; Start new process.
4403 (when (and p
(processp p
))
4405 (setenv "TERM" tramp-terminal-type
)
4406 (setenv "LC_ALL" "C")
4407 (setenv "PROMPT_COMMAND")
4408 (setenv "PS1" tramp-initial-end-of-output
)
4409 (let* ((target-alist (tramp-compute-multi-hops vec
))
4410 (process-connection-type tramp-process-connection-type
)
4411 (process-adaptive-read-buffering nil
)
4412 (coding-system-for-read nil
)
4413 ;; This must be done in order to avoid our file
4415 (p (let ((default-directory
4416 (tramp-compat-temporary-file-directory)))
4419 (tramp-get-connection-name vec
)
4420 (tramp-get-connection-buffer vec
)
4421 (if tramp-encoding-command-interactive
4422 (list tramp-encoding-shell
4423 tramp-encoding-command-interactive
)
4424 (list tramp-encoding-shell
))))))
4426 ;; Set sentinel and query flag.
4427 (tramp-set-connection-property p
"vector" vec
)
4428 (set-process-sentinel p
'tramp-process-sentinel
)
4429 (tramp-compat-set-process-query-on-exit-flag p nil
)
4430 (setq tramp-current-connection
4431 (cons (butlast (append vec nil
)) (current-time))
4432 tramp-current-host
(system-name))
4435 vec
6 "%s" (mapconcat 'identity
(process-command p
) " "))
4437 ;; Check whether process is alive.
4438 (tramp-barf-if-no-shell-prompt
4440 "Couldn't find local shell prompt %s" tramp-encoding-shell
)
4442 ;; Now do all the connections as specified.
4444 (let* ((hop (car target-alist
))
4445 (l-method (tramp-file-name-method hop
))
4446 (l-user (tramp-file-name-user hop
))
4447 (l-host (tramp-file-name-host hop
))
4450 (tramp-get-method-parameter
4451 l-method
'tramp-login-program
))
4453 (tramp-get-method-parameter
4454 l-method
'tramp-login-args
))
4456 (tramp-get-method-parameter
4457 l-method
'tramp-async-args
))
4459 (tramp-get-method-parameter l-method
'tramp-gw-args
))
4460 (gw (tramp-get-file-property hop
"" "gateway" nil
))
4461 (g-method (and gw
(tramp-file-name-method gw
)))
4462 (g-user (and gw
(tramp-file-name-user gw
)))
4463 (g-host (and gw
(tramp-file-name-real-host gw
)))
4464 (command login-program
)
4465 ;; We don't create the temporary file. In
4466 ;; fact, it is just a prefix for the
4467 ;; ControlPath option of ssh; the real
4468 ;; temporary file has another name, and it is
4469 ;; created and protected by ssh. It is also
4470 ;; removed by ssh when the connection is
4473 (tramp-set-connection-property
4477 tramp-temp-name-prefix
4478 (tramp-compat-temporary-file-directory)))))
4481 ;; Add arguments for asynchronous processes.
4482 (when (and process-name async-args
)
4483 (setq login-args
(append async-args login-args
)))
4485 ;; Add gateway arguments if necessary.
4486 (when (and gw gw-args
)
4487 (setq login-args
(append gw-args login-args
)))
4489 ;; Check for port number. Until now, there's no
4490 ;; need for handling like method, user, host.
4491 (when (string-match tramp-host-with-port-regexp l-host
)
4492 (setq l-port
(match-string 2 l-host
)
4493 l-host
(match-string 1 l-host
)))
4495 ;; Check, whether there is a restricted shell.
4496 (dolist (elt tramp-restricted-shell-hosts-alist
)
4497 (when (string-match elt tramp-current-host
)
4500 ;; Set variables for computing the prompt for
4501 ;; reading password. They can also be derived
4503 (setq tramp-current-method
(or g-method l-method
)
4504 tramp-current-user
(or g-user l-user
)
4505 tramp-current-host
(or g-host l-host
))
4507 ;; Replace login-args place holders.
4509 l-host
(or l-host
"")
4510 l-user
(or l-user
"")
4511 l-port
(or l-port
"")
4512 spec
(format-spec-make
4513 ?h l-host ?u l-user ?p l-port ?t tmpfile
)
4516 ;; We do not want to see the trailing local
4517 ;; prompt in `start-file-process'.
4518 (unless r-shell
"exec ")
4522 (setq x
(mapcar (lambda (y) (format-spec y spec
)) x
))
4523 (unless (member "" x
) (mapconcat 'identity x
" ")))
4525 ;; Local shell could be a Windows COMSPEC. It
4526 ;; doesn't know the ";" syntax, but we must exit
4527 ;; always for `start-file-process'. It could
4528 ;; also be a restricted shell, which does not
4530 (when r-shell
" && exit || exit")))
4532 ;; Send the command.
4533 (tramp-message vec
3 "Sending command `%s'" command
)
4534 (tramp-send-command vec command t t
)
4535 (tramp-process-actions
4536 p vec pos tramp-actions-before-shell
60)
4538 vec
3 "Found remote shell prompt on `%s'" l-host
))
4540 (setq target-alist
(cdr target-alist
)))
4542 ;; Make initial shell settings.
4543 (tramp-open-connection-setup-interactive-shell p vec
))))
4545 ;; When the user did interrupt, we must cleanup.
4548 ;; Propagate the quit signal.
4549 (signal (car err
) (cdr err
)))))))
4551 (defun tramp-send-command (vec command
&optional neveropen nooutput
)
4552 "Send the COMMAND to connection VEC.
4553 Erases temporary buffer before sending the command. If optional
4554 arg NEVEROPEN is non-nil, never try to open the connection. This
4555 is meant to be used from `tramp-maybe-open-connection' only. The
4556 function waits for output unless NOOUTPUT is set."
4557 (unless neveropen
(tramp-maybe-open-connection vec
))
4558 (let ((p (tramp-get-connection-process vec
)))
4559 (when (tramp-get-connection-property p
"remote-echo" nil
)
4560 ;; We mark the command string that it can be erased in the output buffer.
4561 (tramp-set-connection-property p
"check-remote-echo" t
)
4562 (setq command
(format "%s%s%s" tramp-echo-mark command tramp-echo-mark
)))
4563 (when (and (string-match "<<'EOF'" command
)
4564 (not (tramp-get-connection-property vec
"busybox" nil
)))
4565 ;; Unset $PS1 when using here documents, in order to avoid
4566 ;; multiple prompts.
4567 (setq command
(concat "(PS1= ; " command
"\n)")))
4568 ;; Send the command.
4569 (tramp-message vec
6 "%s" command
)
4570 (tramp-send-string vec command
)
4571 (unless nooutput
(tramp-wait-for-output p
))))
4573 (defun tramp-wait-for-output (proc &optional timeout
)
4574 "Wait for output from remote command."
4575 (unless (buffer-live-p (process-buffer proc
))
4576 (delete-process proc
)
4577 (tramp-error proc
'file-error
"Process `%s' not available, try again" proc
))
4578 (with-current-buffer (process-buffer proc
)
4579 (let* (;; Initially, `tramp-end-of-output' is "#$ ". There might
4580 ;; be leading escape sequences, which must be ignored.
4581 (regexp (format "[^#$\n]*%s\r?$" (regexp-quote tramp-end-of-output
)))
4582 ;; Sometimes, the commands do not return a newline but a
4583 ;; null byte before the shell prompt, for example "git
4584 ;; ls-files -c -z ...".
4585 (regexp1 (format "\\(^\\|\000\\)%s" regexp
))
4586 (found (tramp-wait-for-regexp proc timeout regexp1
)))
4588 (let (buffer-read-only)
4589 ;; A simple-minded busybox has sent " ^H" sequences.
4591 (goto-char (point-min))
4592 (when (re-search-forward "^\\(.\b\\)+$" (point-at-eol) t
)
4594 (delete-region (point-min) (point)))
4595 ;; Delete the prompt.
4596 (goto-char (point-max))
4597 (re-search-backward regexp nil t
)
4598 (delete-region (point) (point-max)))
4602 "[[Remote prompt `%s' not found in %d secs]]"
4603 tramp-end-of-output timeout
)
4606 "[[Remote prompt `%s' not found]]" tramp-end-of-output
)))
4607 ;; Return value is whether end-of-output sentinel was found.
4610 (defun tramp-send-command-and-check
4611 (vec command
&optional subshell dont-suppress-err
)
4612 "Run COMMAND and check its exit status.
4613 Sends `echo $?' along with the COMMAND for checking the exit status. If
4614 COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4616 If the optional argument SUBSHELL is non-nil, the command is
4617 executed in a subshell, ie surrounded by parentheses. If
4618 DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4621 (concat (if subshell
"( " "")
4623 (if command
(if dont-suppress-err
"; " " 2>/dev/null; ") "")
4624 "echo tramp_exit_status $?"
4625 (if subshell
" )" "")))
4626 (with-current-buffer (tramp-get-connection-buffer vec
)
4627 (goto-char (point-max))
4628 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t
)
4630 vec
'file-error
"Couldn't find exit status of `%s'" command
))
4631 (skip-chars-forward "^ ")
4633 (zerop (read (current-buffer)))
4634 (let (buffer-read-only)
4635 (delete-region (match-beginning 0) (point-max))))))
4637 (defun tramp-barf-unless-okay (vec command fmt
&rest args
)
4638 "Run COMMAND, check exit status, throw error if exit status not okay.
4639 Similar to `tramp-send-command-and-check' but accepts two more arguments
4640 FMT and ARGS which are passed to `error'."
4641 (or (tramp-send-command-and-check vec command
)
4642 (apply 'tramp-error vec
'file-error fmt args
)))
4644 (defun tramp-send-command-and-read (vec command
&optional noerror
)
4645 "Run COMMAND and return the output, which must be a Lisp expression.
4646 In case there is no valid Lisp expression and NOERROR is nil, it
4649 (tramp-send-command-and-check vec command
)
4650 (tramp-barf-unless-okay
4651 vec command
"`%s' returns with error" command
))
4652 (with-current-buffer (tramp-get-connection-buffer vec
)
4653 ;; Read the expression.
4654 (goto-char (point-min))
4656 (prog1 (read (current-buffer))
4658 (when (re-search-forward "\\S-" (point-at-eol) t
)
4660 (error (unless noerror
4663 "`%s' does not return a valid Lisp expression: `%s'"
4664 command
(buffer-string))))))))
4666 (defun tramp-convert-file-attributes (vec attr
)
4667 "Convert `file-attributes' ATTR generated by perl script, stat or ls.
4668 Convert file mode bits to string and set virtual device number.
4671 ;; Remove color escape sequences from symlink.
4672 (when (stringp (car attr
))
4673 (while (string-match tramp-color-escape-sequence-regexp
(car attr
))
4674 (setcar attr
(replace-match "" nil nil
(car attr
)))))
4675 ;; Convert uid and gid. Use -1 as indication of unusable value.
4676 (when (and (numberp (nth 2 attr
)) (< (nth 2 attr
) 0))
4677 (setcar (nthcdr 2 attr
) -
1))
4678 (when (and (floatp (nth 2 attr
))
4679 (<= (nth 2 attr
) (tramp-compat-most-positive-fixnum)))
4680 (setcar (nthcdr 2 attr
) (round (nth 2 attr
))))
4681 (when (and (numberp (nth 3 attr
)) (< (nth 3 attr
) 0))
4682 (setcar (nthcdr 3 attr
) -
1))
4683 (when (and (floatp (nth 3 attr
))
4684 (<= (nth 3 attr
) (tramp-compat-most-positive-fixnum)))
4685 (setcar (nthcdr 3 attr
) (round (nth 3 attr
))))
4686 ;; Convert last access time.
4687 (unless (listp (nth 4 attr
))
4688 (setcar (nthcdr 4 attr
)
4689 (list (floor (nth 4 attr
) 65536)
4690 (floor (mod (nth 4 attr
) 65536)))))
4691 ;; Convert last modification time.
4692 (unless (listp (nth 5 attr
))
4693 (setcar (nthcdr 5 attr
)
4694 (list (floor (nth 5 attr
) 65536)
4695 (floor (mod (nth 5 attr
) 65536)))))
4696 ;; Convert last status change time.
4697 (unless (listp (nth 6 attr
))
4698 (setcar (nthcdr 6 attr
)
4699 (list (floor (nth 6 attr
) 65536)
4700 (floor (mod (nth 6 attr
) 65536)))))
4701 ;; Convert file size.
4702 (when (< (nth 7 attr
) 0)
4703 (setcar (nthcdr 7 attr
) -
1))
4704 (when (and (floatp (nth 7 attr
))
4705 (<= (nth 7 attr
) (tramp-compat-most-positive-fixnum)))
4706 (setcar (nthcdr 7 attr
) (round (nth 7 attr
))))
4707 ;; Convert file mode bits to string.
4708 (unless (stringp (nth 8 attr
))
4709 (setcar (nthcdr 8 attr
) (tramp-file-mode-from-int (nth 8 attr
)))
4710 (when (stringp (car attr
))
4711 (aset (nth 8 attr
) 0 ?l
)))
4712 ;; Convert directory indication bit.
4713 (when (string-match "^d" (nth 8 attr
))
4715 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4716 (when (consp (car attr
))
4717 (if (and (stringp (caar attr
))
4718 (string-match ".+ -> .\\(.+\\)." (caar attr
)))
4719 (setcar attr
(match-string 1 (caar attr
)))
4721 ;; Set file's gid change bit.
4722 (setcar (nthcdr 9 attr
)
4723 (if (numberp (nth 3 attr
))
4724 (not (= (nth 3 attr
)
4725 (tramp-get-remote-gid vec
'integer
)))
4728 (tramp-get-remote-gid vec
'string
)))))
4730 (unless (listp (nth 10 attr
))
4731 (setcar (nthcdr 10 attr
)
4733 (cons (floor (nth 10 attr
) 65536)
4734 (floor (mod (nth 10 attr
) 65536)))
4735 ;; Inodes can be incredible huge. We must hide this.
4736 (error (tramp-get-inode vec
)))))
4737 ;; Set virtual device number.
4738 (setcar (nthcdr 11 attr
)
4739 (tramp-get-device vec
))
4742 (defun tramp-check-cached-permissions (vec access
)
4743 "Check `file-attributes' caches for VEC.
4744 Return t if according to the cache access type ACCESS is known to
4750 ((eq ?x access
) 3))))
4751 (dolist (suffix '("string" "integer") result
)
4757 (tramp-get-file-property
4758 vec
(tramp-file-name-localname vec
)
4759 (concat "file-attributes-" suffix
) nil
))
4761 (tramp-get-connection-property
4762 vec
(concat "uid-" suffix
) nil
))
4764 (tramp-get-connection-property
4765 vec
(concat "gid-" suffix
) nil
)))
4770 (eq t
(car file-attr
))
4771 (null (car file-attr
)))
4773 ;; World accessible.
4774 (eq access
(aref (nth 8 file-attr
) (+ offset
6)))
4775 ;; User accessible and owned by user.
4777 (eq access
(aref (nth 8 file-attr
) offset
))
4778 (equal remote-uid
(nth 2 file-attr
)))
4779 ;; Group accessible and owned by user's
4782 (eq access
(aref (nth 8 file-attr
) (+ offset
3)))
4783 (equal remote-gid
(nth 3 file-attr
)))))))))))
4785 (defun tramp-file-mode-from-int (mode)
4786 "Turn an integer representing a file mode into an ls(1)-like string."
4788 (assoc (logand (lsh mode -
12) 15) tramp-file-mode-type-map
)))
4789 (user (logand (lsh mode -
6) 7))
4790 (group (logand (lsh mode -
3) 7))
4791 (other (logand (lsh mode -
0) 7))
4792 (suid (> (logand (lsh mode -
9) 4) 0))
4793 (sgid (> (logand (lsh mode -
9) 2) 0))
4794 (sticky (> (logand (lsh mode -
9) 1) 0)))
4795 (setq user
(tramp-file-mode-permissions user suid
"s"))
4796 (setq group
(tramp-file-mode-permissions group sgid
"s"))
4797 (setq other
(tramp-file-mode-permissions other sticky
"t"))
4798 (concat type user group other
)))
4800 (defun tramp-file-mode-permissions (perm suid suid-text
)
4801 "Convert a permission bitset into a string.
4802 This is used internally by `tramp-file-mode-from-int'."
4803 (let ((r (> (logand perm
4) 0))
4804 (w (> (logand perm
2) 0))
4805 (x (> (logand perm
1) 0)))
4806 (concat (or (and r
"r") "-")
4807 (or (and w
"w") "-")
4808 (or (and suid x suid-text
) ; suid, execute
4809 (and suid
(upcase suid-text
)) ; suid, !execute
4810 (and x
"x") "-")))) ; !suid
4812 (defun tramp-shell-case-fold (string)
4813 "Converts STRING to shell glob pattern which ignores case."
4816 (if (equal (downcase c
) (upcase c
))
4818 (format "[%c%c]" (downcase c
) (upcase c
))))
4822 (defun tramp-make-copy-program-file-name (vec)
4823 "Create a file name suitable to be passed to `rcp' and workalikes."
4824 (let ((user (tramp-file-name-user vec
))
4825 (host (tramp-file-name-real-host vec
))
4826 (localname (tramp-shell-quote-argument
4827 (tramp-file-name-localname vec
))))
4828 (if (not (zerop (length user
)))
4829 (format "%s@%s:%s" user host localname
)
4830 (format "%s:%s" host localname
))))
4832 (defun tramp-method-out-of-band-p (vec size
)
4833 "Return t if this is an out-of-band method, nil otherwise."
4835 ;; It shall be an out-of-band method.
4836 (tramp-get-method-parameter (tramp-file-name-method vec
) 'tramp-copy-program
)
4837 ;; There must be a size, otherwise the file doesn't exist.
4839 ;; Either the file size is large enough, or (in rare cases) there
4840 ;; does not exist a remote encoding.
4841 (or (null tramp-copy-size-limit
)
4842 (> size tramp-copy-size-limit
)
4843 (null (tramp-get-inline-coding vec
"remote-encoding" size
)))))
4845 ;; Variables local to connection.
4847 (defun tramp-get-remote-path (vec)
4848 (with-tramp-connection-property
4849 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4850 ;; cache the result for the session only. Otherwise, the result
4851 ;; is cached persistently.
4852 (if (memq 'tramp-own-remote-path tramp-remote-path
)
4853 (tramp-get-connection-process vec
)
4856 (let* ((remote-path (copy-tree tramp-remote-path
))
4857 (elt1 (memq 'tramp-default-remote-path remote-path
))
4858 (elt2 (memq 'tramp-own-remote-path remote-path
))
4859 (default-remote-path
4862 (tramp-send-command-and-read
4863 vec
"echo \\\"`getconf PATH 2>/dev/null`\\\"" 'noerror
)
4864 ;; Default if "getconf" is not available.
4868 "`getconf PATH' not successful, using default value \"%s\"."
4874 (tramp-send-command-and-read vec
"echo \\\"$PATH\\\"")
4877 vec
3 "$PATH not set, ignoring `tramp-own-remote-path'.")
4880 ;; Replace place holder `tramp-default-remote-path'.
4884 (tramp-compat-split-string default-remote-path
":")
4886 (setq remote-path
(delq 'tramp-default-remote-path remote-path
)))
4888 ;; Replace place holder `tramp-own-remote-path'.
4892 (tramp-compat-split-string own-remote-path
":")
4894 (setq remote-path
(delq 'tramp-own-remote-path remote-path
)))
4896 ;; Remove double entries.
4897 (setq elt1 remote-path
)
4899 (while (and (car elt1
) (setq elt2
(member (car elt1
) (cdr elt1
))))
4901 (setq elt1
(cdr elt1
)))
4903 ;; Remove non-existing directories.
4911 (tramp-make-tramp-file-name
4912 (tramp-file-name-method vec
)
4913 (tramp-file-name-user vec
)
4914 (tramp-file-name-host vec
)
4919 (defun tramp-get-ls-command (vec)
4920 (with-tramp-connection-property vec
"ls"
4921 (tramp-message vec
5 "Finding a suitable `ls' command")
4924 (dolist (cmd '("ls" "gnuls" "gls"))
4925 (let ((dl (tramp-get-remote-path vec
))
4927 (while (and dl
(setq result
(tramp-find-executable vec cmd dl t t
)))
4928 ;; Check parameters. On busybox, "ls" output coloring is
4929 ;; enabled by default sometimes. So we try to disable it
4930 ;; when possible. $LS_COLORING is not supported there.
4931 ;; Some "ls" versions are sensible wrt the order of
4932 ;; arguments, they fail when "-al" is after the
4933 ;; "--color=never" argument (for example on FreeBSD).
4934 (when (tramp-send-command-and-check
4935 vec
(format "%s -lnd /" result
))
4936 (when (tramp-send-command-and-check
4938 "%s --color=never -al /dev/null" result
))
4939 (setq result
(concat result
" --color=never")))
4940 (throw 'ls-found result
))
4941 (setq dl
(cdr dl
))))))
4942 (tramp-error vec
'file-error
"Couldn't find a proper `ls' command"))))
4944 (defun tramp-get-ls-command-with-dired (vec)
4946 (with-tramp-connection-property vec
"ls-dired"
4947 (tramp-message vec
5 "Checking, whether `ls --dired' works")
4948 ;; Some "ls" versions are sensible wrt the order of arguments,
4949 ;; they fail when "-al" is after the "--dired" argument (for
4950 ;; example on FreeBSD).
4951 (tramp-send-command-and-check
4952 vec
(format "%s --dired -al /dev/null" (tramp-get-ls-command vec
))))))
4954 (defun tramp-get-test-command (vec)
4955 (with-tramp-connection-property vec
"test"
4956 (tramp-message vec
5 "Finding a suitable `test' command")
4957 (if (tramp-send-command-and-check vec
"test 0")
4959 (tramp-find-executable vec
"test" (tramp-get-remote-path vec
)))))
4961 (defun tramp-get-test-nt-command (vec)
4962 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4963 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4964 ;; for otherwise the shell crashes.
4965 (with-tramp-connection-property vec
"test-nt"
4969 vec
(format "( %s / -nt / )" (tramp-get-test-command vec
)))
4970 (with-current-buffer (tramp-get-buffer vec
)
4971 (goto-char (point-min))
4972 (when (looking-at (regexp-quote tramp-end-of-output
))
4973 (format "%s %%s -nt %%s" (tramp-get-test-command vec
)))))
4978 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
4979 (tramp-get-test-command vec
)))
4980 "tramp_test_nt %s %s"))))
4982 (defun tramp-get-file-exists-command (vec)
4983 (with-tramp-connection-property vec
"file-exists"
4984 (tramp-message vec
5 "Finding command to check if file exists")
4985 (tramp-find-file-exists-command vec
)))
4987 (defun tramp-get-remote-ln (vec)
4988 (with-tramp-connection-property vec
"ln"
4989 (tramp-message vec
5 "Finding a suitable `ln' command")
4990 (tramp-find-executable vec
"ln" (tramp-get-remote-path vec
))))
4992 (defun tramp-get-remote-perl (vec)
4993 (with-tramp-connection-property vec
"perl"
4994 (tramp-message vec
5 "Finding a suitable `perl' command")
4996 (or (tramp-find-executable vec
"perl5" (tramp-get-remote-path vec
))
4997 (tramp-find-executable
4998 vec
"perl" (tramp-get-remote-path vec
)))))
4999 ;; We must check also for some Perl modules.
5001 (with-tramp-connection-property vec
"perl-file-spec"
5002 (tramp-send-command-and-check
5003 vec
(format "%s -e 'use File::Spec;'" result
)))
5004 (with-tramp-connection-property vec
"perl-cwd-realpath"
5005 (tramp-send-command-and-check
5006 vec
(format "%s -e 'use Cwd \"realpath\";'" result
))))
5009 (defun tramp-get-remote-stat (vec)
5010 (with-tramp-connection-property vec
"stat"
5011 (tramp-message vec
5 "Finding a suitable `stat' command")
5012 (let ((result (tramp-find-executable
5013 vec
"stat" (tramp-get-remote-path vec
)))
5015 ;; Check whether stat(1) returns usable syntax. "%s" does not
5016 ;; work on older AIX systems.
5019 (tramp-send-command-and-read
5020 vec
(format "%s -c '(\"%%N\" %%s)' /" result
) 'noerror
))
5021 (unless (and (listp tmp
) (stringp (car tmp
))
5022 (string-match "^./.$" (car tmp
))
5023 (integerp (cadr tmp
)))
5027 (defun tramp-get-remote-readlink (vec)
5028 (with-tramp-connection-property vec
"readlink"
5029 (tramp-message vec
5 "Finding a suitable `readlink' command")
5030 (let ((result (tramp-find-executable
5031 vec
"readlink" (tramp-get-remote-path vec
))))
5033 (tramp-send-command-and-check
5034 vec
(format "%s --canonicalize-missing /" result
)))
5037 (defun tramp-get-remote-trash (vec)
5038 (with-tramp-connection-property vec
"trash"
5039 (tramp-message vec
5 "Finding a suitable `trash' command")
5040 (tramp-find-executable vec
"trash" (tramp-get-remote-path vec
))))
5042 (defun tramp-get-remote-id (vec)
5043 (with-tramp-connection-property vec
"id"
5044 (tramp-message vec
5 "Finding POSIX `id' command")
5047 (let ((dl (tramp-get-remote-path vec
))
5049 (while (and dl
(setq result
(tramp-find-executable vec
"id" dl t t
)))
5050 ;; Check POSIX parameter.
5051 (when (tramp-send-command-and-check vec
(format "%s -u" result
))
5052 (throw 'id-found result
))
5053 (setq dl
(cdr dl
)))))
5054 (tramp-error vec
'file-error
"Couldn't find a POSIX `id' command"))))
5056 (defun tramp-get-remote-uid (vec id-format
)
5057 (with-tramp-connection-property vec
(format "uid-%s" id-format
)
5058 (let ((res (tramp-send-command-and-read
5060 (format "%s -u%s %s"
5061 (tramp-get-remote-id vec
)
5062 (if (equal id-format
'integer
) "" "n")
5063 (if (equal id-format
'integer
)
5064 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
5065 ;; The command might not always return a number.
5066 (if (and (equal id-format
'integer
) (not (integerp res
))) -
1 res
))))
5068 (defun tramp-get-remote-gid (vec id-format
)
5069 (with-tramp-connection-property vec
(format "gid-%s" id-format
)
5070 (let ((res (tramp-send-command-and-read
5072 (format "%s -g%s %s"
5073 (tramp-get-remote-id vec
)
5074 (if (equal id-format
'integer
) "" "n")
5075 (if (equal id-format
'integer
)
5076 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
5077 ;; The command might not always return a number.
5078 (if (and (equal id-format
'integer
) (not (integerp res
))) -
1 res
))))
5080 (defun tramp-get-local-uid (id-format)
5081 (if (equal id-format
'integer
) (user-uid) (user-login-name)))
5083 (defun tramp-get-local-gid (id-format)
5084 (if (and (fboundp 'group-gid
) (equal id-format
'integer
))
5085 (tramp-compat-funcall 'group-gid
)
5086 (nth 3 (tramp-compat-file-attributes "~/" id-format
))))
5088 ;; Some predefined connection properties.
5089 (defun tramp-get-inline-compress (vec prop size
)
5090 "Return the compress command related to PROP.
5091 PROP is either `inline-compress' or `inline-decompress'. SIZE is
5092 the length of the file to be compressed.
5094 If no corresponding command is found, nil is returned."
5095 (when (and (integerp tramp-inline-compress-start-size
)
5096 (> size tramp-inline-compress-start-size
))
5097 (with-tramp-connection-property (tramp-get-connection-process vec
) prop
5098 (tramp-find-inline-compress vec
)
5099 (tramp-get-connection-property
5100 (tramp-get-connection-process vec
) prop nil
))))
5102 (defun tramp-get-inline-coding (vec prop size
)
5103 "Return the coding command related to PROP.
5104 PROP is either `remote-encoding', `remote-decoding',
5105 `local-encoding' or `local-decoding'.
5107 SIZE is the length of the file to be coded. Depending on SIZE,
5108 compression might be applied.
5110 If no corresponding command is found, nil is returned.
5111 Otherwise, either a string is returned which contains a `%s' mark
5112 to be used for the respective input or output file; or a Lisp
5113 function cell is returned to be applied on a buffer."
5114 ;; We must catch the errors, because we want to return `nil', when
5115 ;; no inline coding is found.
5118 (with-tramp-connection-property
5119 (tramp-get-connection-process vec
) prop
5120 (tramp-find-inline-encoding vec
)
5121 (tramp-get-connection-property
5122 (tramp-get-connection-process vec
) prop nil
)))
5123 (prop1 (if (string-match "encoding" prop
)
5124 "inline-compress" "inline-decompress"))
5126 ;; The connection property might have been cached. So we must
5127 ;; send the script to the remote side - maybe.
5128 (when (and coding
(symbolp coding
) (string-match "remote" prop
))
5129 (let ((name (symbol-name coding
)))
5130 (while (string-match (regexp-quote "-") name
)
5131 (setq name
(replace-match "_" nil t name
)))
5132 (tramp-maybe-send-script vec
(symbol-value coding
) name
)
5133 (setq coding name
)))
5135 ;; Check for the `compress' command.
5136 (setq compress
(tramp-get-inline-compress vec prop1 size
))
5137 ;; Return the value.
5139 ((and compress
(symbolp coding
))
5140 (if (string-match "decompress" prop1
)
5143 (let ((coding-system-for-write 'binary
)
5144 (coding-system-for-read 'binary
))
5146 'call-process-region
(point-min) (point-max)
5147 (car (split-string ,compress
)) t t nil
5148 (cdr (split-string ,compress
)))))
5150 (let ((coding-system-for-write 'binary
)
5151 (coding-system-for-read 'binary
))
5153 'call-process-region beg end
5154 (car (split-string ,compress
)) t t nil
5155 (cdr (split-string ,compress
))))
5156 (,coding
(point-min) (point-max)))))
5159 ((and compress
(string-match "decoding" prop
))
5161 ;; Windows shells need the program file name after
5162 ;; the pipe symbol be quoted if they use forward
5163 ;; slashes as directory separators.
5164 (if (and (string-match "local" prop
)
5165 (memq system-type
'(windows-nt)))
5166 "(%s | \"%s\" >%%s)"
5171 ;; Windows shells need the program file name after
5172 ;; the pipe symbol be quoted if they use forward
5173 ;; slashes as directory separators.
5174 (if (and (string-match "local" prop
)
5175 (memq system-type
'(windows-nt)))
5176 "(%s <%%s | \"%s\")"
5179 ((string-match "decoding" prop
)
5180 (format "%s >%%s" coding
))
5182 (format "%s <%%s" coding
)))))))
5184 ;;; Integration of eshell.el:
5187 (defvar eshell-path-env
))
5189 ;; eshell.el keeps the path in `eshell-path-env'. We must change it
5190 ;; when `default-directory' points to another host.
5191 (defun tramp-eshell-directory-change ()
5192 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
5193 (setq eshell-path-env
5194 (if (file-remote-p default-directory
)
5195 (with-parsed-tramp-file-name default-directory nil
5198 (tramp-get-remote-path v
)
5202 (eval-after-load "esh-util"
5204 (tramp-eshell-directory-change)
5205 (add-hook 'eshell-directory-change-hook
5206 'tramp-eshell-directory-change
)
5207 (add-hook 'tramp-unload-hook
5209 (remove-hook 'eshell-directory-change-hook
5210 'tramp-eshell-directory-change
)))))
5212 (add-hook 'tramp-unload-hook
5214 (unload-feature 'tramp-sh
'force
)))
5220 ;; * Don't use globbing for directories with many files, as this is
5221 ;; likely to produce long command lines, and some shells choke on
5222 ;; long command lines.
5223 ;; * Make it work for different encodings, and for different file name
5224 ;; encodings, too. (Daniel Pittman)
5225 ;; * Don't search for perl5 and perl. Instead, only search for perl and
5226 ;; then look if it's the right version (with `perl -v').
5227 ;; * When editing a remote CVS controlled file as a different user, VC
5228 ;; gets confused about the file locking status. Try to find out why
5229 ;; the workaround doesn't work.
5230 ;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5231 ;; until the last but one hop via `start-file-process'. Apply it
5232 ;; also for ftp and smb.
5233 ;; * WIBNI if we had a command "trampclient"? If I was editing in
5234 ;; some shell with root privileges, it would be nice if I could
5236 ;; trampclient filename.c
5237 ;; as an editor, and the _current_ shell would connect to an Emacs
5238 ;; server and would be used in an existing non-privileged Emacs
5239 ;; session for doing the editing in question.
5240 ;; That way, I need not tell Emacs my password again and be afraid
5241 ;; that it makes it into core dumps or other ugly stuff (I had Emacs
5242 ;; once display a just typed password in the context of a keyboard
5243 ;; sequence prompt for a question immediately following in a shell
5244 ;; script run within Emacs -- nasty).
5245 ;; And if I have some ssh session running to a different computer,
5246 ;; having the possibility of passing a local file there to a local
5247 ;; Emacs session (in case I can arrange for a connection back) would
5249 ;; Likely the corresponding Tramp server should not allow the
5250 ;; equivalent of the emacsclient -eval option in order to make this
5251 ;; reasonably unproblematic. And maybe trampclient should have some
5252 ;; way of passing credentials, like by using an SSL socket or
5253 ;; something. (David Kastrup)
5254 ;; * Reconnect directly to a compliant shell without first going
5255 ;; through the user's default shell. (Pete Forman)
5256 ;; * How can I interrupt the remote process with a signal
5257 ;; (interrupt-process seems not to work)? (Markus Triska)
5258 ;; * Avoid the local shell entirely for starting remote processes. If
5259 ;; so, I think even a signal, when delivered directly to the local
5260 ;; SSH instance, would correctly be propagated to the remote process
5261 ;; automatically; possibly SSH would have to be started with
5262 ;; "-t". (Markus Triska)
5263 ;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5264 ;; isn't on the remote host. (Mark A. Hershberger)
5265 ;; * Use lsh instead of ssh. (Alfred M. Szmidt)
5266 ;; * Optimize out-of-band copying when both methods are scp-like (not
5268 ;; * Keep a second connection open for out-of-band methods like scp or
5270 ;; * Try telnet+curl as new method. It might be useful for busybox,
5271 ;; without built-in uuencode/uudecode.
5273 ;;; tramp-sh.el ends here