ChangeLog date fixes
[bpt/emacs.git] / lisp / net / tramp-sh.el
CommitLineData
03c1ad43
MA
1;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections
2
acaf905b 3;; Copyright (C) 1998-2012 Free Software Foundation, Inc.
03c1ad43
MA
4
5;; (copyright statements below in code to be updated with the above notice)
6
7;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
8;; Michael Albinus <michael.albinus@gmx.de>
9;; Keywords: comm, processes
10;; Package: tramp
11
12;; This file is part of GNU Emacs.
13
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.
18
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.
23
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/>.
26
27;;; Code:
28
6139f995 29(eval-when-compile (require 'cl)) ; ignore-errors
03c1ad43 30(require 'tramp)
03c1ad43
MA
31
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
35;; achieve this.
36;;(eval-when-compile
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'.
44
45(defcustom tramp-inline-compress-start-size 4096
fb7ada5f 46 "The minimum size of compressing where inline transfer.
333f9019 47When inline transfer, compress transferred data of file
03c1ad43
MA
48whose size is this value or above (up to `tramp-copy-size-limit').
49If it is nil, no compression at all will be applied."
50 :group 'tramp
51 :type '(choice (const nil) integer))
52
53(defcustom tramp-copy-size-limit 10240
2fe4b125
MA
54 "The maximum file size where inline copying is preferred over an \
55out-of-the-band copy.
56If it is nil, out-of-the-band copy will be used without a check."
03c1ad43
MA
57 :group 'tramp
58 :type '(choice (const nil) integer))
59
60;;;###tramp-autoload
61(defcustom tramp-terminal-type "dumb"
fb7ada5f 62 "Value of TERM environment variable for logging in to remote host.
03c1ad43
MA
63Because Tramp wants to parse the output of the remote shell, it is easily
64confused by ANSI color escape sequences and suchlike. Often, shell init
65files conditionalize this setup based on the TERM environment variable."
66 :group 'tramp
67 :type 'string)
68
6d95bd46
MA
69(defconst tramp-color-escape-sequence-regexp "\e[[;0-9]+m"
70 "Escape sequences produced by the \"ls\" command.")
71
2c68ca0e 72;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
03c1ad43 73;; root users. It uses the `$' character for other users. In order
a857d3c7 74;; to guarantee a proper prompt, we use "#$ " for the prompt.
03c1ad43
MA
75
76(defvar tramp-end-of-output
77 (format
78 "///%s#$"
79 (md5 (concat (prin1-to-string process-environment) (current-time-string))))
80 "String used to recognize end of output.
81The '$' character at the end is quoted; the string cannot be
82detected as prompt when being sent on echoing hosts, therefore.")
83
84;;;###tramp-autoload
85(defconst tramp-initial-end-of-output "#$ "
86 "Prompt when establishing a connection.")
87
88;; Initialize `tramp-methods' with the supported methods.
89;;;###tramp-autoload
90(add-to-list 'tramp-methods
91 '("rcp"
92 (tramp-login-program "rsh")
93 (tramp-login-args (("%h") ("-l" "%u")))
f5e29b9b
MA
94 (tramp-remote-shell "/bin/sh")
95 (tramp-remote-shell-args ("-c"))
03c1ad43 96 (tramp-copy-program "rcp")
f3afd36b 97 (tramp-copy-args (("-p" "%k") ("-r")))
03c1ad43
MA
98 (tramp-copy-keep-date t)
99 (tramp-copy-recursive t)))
100;;;###tramp-autoload
101(add-to-list 'tramp-methods
102 '("remcp"
103 (tramp-login-program "remsh")
104 (tramp-login-args (("%h") ("-l" "%u")))
f5e29b9b
MA
105 (tramp-remote-shell "/bin/sh")
106 (tramp-remote-shell-args ("-c"))
03c1ad43 107 (tramp-copy-program "rcp")
f3afd36b 108 (tramp-copy-args (("-p" "%k")))
03c1ad43
MA
109 (tramp-copy-keep-date t)))
110;;;###tramp-autoload
66feec8b 111(add-to-list 'tramp-methods
7398933f
MA
112 '("scp"
113 (tramp-login-program "ssh")
03c1ad43
MA
114 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
115 (tramp-async-args (("-q")))
f5e29b9b
MA
116 (tramp-remote-shell "/bin/sh")
117 (tramp-remote-shell-args ("-c"))
03c1ad43 118 (tramp-copy-program "scp")
f3afd36b 119 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")))
03c1ad43
MA
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)))
126;;;###tramp-autoload
127(add-to-list 'tramp-methods
128 '("scp1"
129 (tramp-login-program "ssh")
130 (tramp-login-args (("-l" "%u") ("-p" "%p")
131 ("-1") ("-e" "none") ("%h")))
132 (tramp-async-args (("-q")))
f5e29b9b
MA
133 (tramp-remote-shell "/bin/sh")
134 (tramp-remote-shell-args ("-c"))
03c1ad43 135 (tramp-copy-program "scp")
f3afd36b 136 (tramp-copy-args (("-1") ("-P" "%p") ("-p" "%k") ("-q") ("-r")))
03c1ad43
MA
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)))
143;;;###tramp-autoload
144(add-to-list 'tramp-methods
145 '("scp2"
146 (tramp-login-program "ssh")
147 (tramp-login-args (("-l" "%u") ("-p" "%p")
148 ("-2") ("-e" "none") ("%h")))
149 (tramp-async-args (("-q")))
f5e29b9b
MA
150 (tramp-remote-shell "/bin/sh")
151 (tramp-remote-shell-args ("-c"))
03c1ad43 152 (tramp-copy-program "scp")
f3afd36b 153 (tramp-copy-args (("-2") ("-P" "%p") ("-p" "%k") ("-q") ("-r")))
03c1ad43
MA
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)))
160;;;###tramp-autoload
161(add-to-list 'tramp-methods
162 '("scpc"
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")))
f5e29b9b
MA
169 (tramp-remote-shell "/bin/sh")
170 (tramp-remote-shell-args ("-c"))
03c1ad43 171 (tramp-copy-program "scp")
f3afd36b 172 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")
03c1ad43
MA
173 ("-o" "ControlPath=%t.%%r@%%h:%%p")
174 ("-o" "ControlMaster=auto")))
175 (tramp-copy-keep-date t)
8d68c659 176 (tramp-copy-recursive t)
03c1ad43
MA
177 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
178 ("-o" "UserKnownHostsFile=/dev/null")
179 ("-o" "StrictHostKeyChecking=no")))
180 (tramp-default-port 22)))
181;;;###tramp-autoload
182(add-to-list 'tramp-methods
183 '("scpx"
184 (tramp-login-program "ssh")
185 (tramp-login-args (("-l" "%u") ("-p" "%p")
186 ("-e" "none") ("-t" "-t")
187 ("%h") ("/bin/sh")))
188 (tramp-async-args (("-q")))
f5e29b9b
MA
189 (tramp-remote-shell "/bin/sh")
190 (tramp-remote-shell-args ("-c"))
03c1ad43 191 (tramp-copy-program "scp")
f3afd36b 192 (tramp-copy-args (("-P" "%p") ("-p" "%k") ("-q") ("-r")))
03c1ad43 193 (tramp-copy-keep-date t)
8d68c659 194 (tramp-copy-recursive t)
03c1ad43
MA
195 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
196 ("-o" "UserKnownHostsFile=/dev/null")
197 ("-o" "StrictHostKeyChecking=no")))
198 (tramp-default-port 22)))
199;;;###tramp-autoload
200(add-to-list 'tramp-methods
201 '("sftp"
202 (tramp-login-program "ssh")
203 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
204 (tramp-async-args (("-q")))
f5e29b9b
MA
205 (tramp-remote-shell "/bin/sh")
206 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
207 (tramp-copy-program "sftp")))
208;;;###tramp-autoload
209(add-to-list 'tramp-methods
210 '("rsync"
211 (tramp-login-program "ssh")
212 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
213 (tramp-async-args (("-q")))
f5e29b9b
MA
214 (tramp-remote-shell "/bin/sh")
215 (tramp-remote-shell-args ("-c"))
03c1ad43 216 (tramp-copy-program "rsync")
f3afd36b 217 (tramp-copy-args (("-e" "ssh") ("-t" "%k") ("-r")))
03c1ad43
MA
218 (tramp-copy-keep-date t)
219 (tramp-copy-keep-tmpfile t)
220 (tramp-copy-recursive t)))
221;;;###tramp-autoload
222(add-to-list 'tramp-methods
223 `("rsyncc"
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")))
f5e29b9b
MA
230 (tramp-remote-shell "/bin/sh")
231 (tramp-remote-shell-args ("-c"))
03c1ad43 232 (tramp-copy-program "rsync")
f3afd36b 233 (tramp-copy-args (("-t" "%k") ("-r")))
03c1ad43
MA
234 (tramp-copy-env (("RSYNC_RSH")
235 (,(concat
236 "ssh"
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)))
242;;;###tramp-autoload
243(add-to-list 'tramp-methods
244 '("rsh"
245 (tramp-login-program "rsh")
246 (tramp-login-args (("%h") ("-l" "%u")))
f5e29b9b
MA
247 (tramp-remote-shell "/bin/sh")
248 (tramp-remote-shell-args ("-c"))))
03c1ad43
MA
249;;;###tramp-autoload
250(add-to-list 'tramp-methods
251 '("remsh"
252 (tramp-login-program "remsh")
253 (tramp-login-args (("%h") ("-l" "%u")))
f5e29b9b
MA
254 (tramp-remote-shell "/bin/sh")
255 (tramp-remote-shell-args ("-c"))))
03c1ad43
MA
256;;;###tramp-autoload
257(add-to-list 'tramp-methods
258 '("ssh"
259 (tramp-login-program "ssh")
260 (tramp-login-args (("-l" "%u") ("-p" "%p") ("-e" "none") ("%h")))
261 (tramp-async-args (("-q")))
f5e29b9b
MA
262 (tramp-remote-shell "/bin/sh")
263 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
264 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
265 ("-o" "UserKnownHostsFile=/dev/null")
266 ("-o" "StrictHostKeyChecking=no")))
267 (tramp-default-port 22)))
268;;;###tramp-autoload
269(add-to-list 'tramp-methods
270 '("ssh1"
271 (tramp-login-program "ssh")
272 (tramp-login-args (("-l" "%u") ("-p" "%p")
273 ("-1") ("-e" "none") ("%h")))
274 (tramp-async-args (("-q")))
f5e29b9b
MA
275 (tramp-remote-shell "/bin/sh")
276 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
277 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
278 ("-o" "UserKnownHostsFile=/dev/null")
279 ("-o" "StrictHostKeyChecking=no")))
280 (tramp-default-port 22)))
281;;;###tramp-autoload
282(add-to-list 'tramp-methods
283 '("ssh2"
284 (tramp-login-program "ssh")
285 (tramp-login-args (("-l" "%u") ("-p" "%p")
286 ("-2") ("-e" "none") ("%h")))
287 (tramp-async-args (("-q")))
f5e29b9b
MA
288 (tramp-remote-shell "/bin/sh")
289 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
290 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
291 ("-o" "UserKnownHostsFile=/dev/null")
292 ("-o" "StrictHostKeyChecking=no")))
293 (tramp-default-port 22)))
294;;;###tramp-autoload
295(add-to-list 'tramp-methods
296 '("sshx"
297 (tramp-login-program "ssh")
298 (tramp-login-args (("-l" "%u") ("-p" "%p")
299 ("-e" "none") ("-t" "-t")
300 ("%h") ("/bin/sh")))
301 (tramp-async-args (("-q")))
f5e29b9b
MA
302 (tramp-remote-shell "/bin/sh")
303 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
304 (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
305 ("-o" "UserKnownHostsFile=/dev/null")
306 ("-o" "StrictHostKeyChecking=no")))
307 (tramp-default-port 22)))
308;;;###tramp-autoload
309(add-to-list 'tramp-methods
310 '("telnet"
311 (tramp-login-program "telnet")
312 (tramp-login-args (("%h") ("%p")))
f5e29b9b
MA
313 (tramp-remote-shell "/bin/sh")
314 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
315 (tramp-default-port 23)))
316;;;###tramp-autoload
317(add-to-list 'tramp-methods
318 '("su"
319 (tramp-login-program "su")
320 (tramp-login-args (("-") ("%u")))
f5e29b9b
MA
321 (tramp-remote-shell "/bin/sh")
322 (tramp-remote-shell-args ("-c"))))
03c1ad43
MA
323;;;###tramp-autoload
324(add-to-list 'tramp-methods
325 '("sudo"
326 (tramp-login-program "sudo")
327 (tramp-login-args (("-u" "%u") ("-s") ("-H") ("-p" "Password:")))
f5e29b9b
MA
328 (tramp-remote-shell "/bin/sh")
329 (tramp-remote-shell-args ("-c"))))
03c1ad43 330;;;###tramp-autoload
d68b0220
MA
331(add-to-list 'tramp-methods
332 '("ksu"
333 (tramp-login-program "ksu")
334 (tramp-login-args (("%u") ("-q")))
f5e29b9b
MA
335 (tramp-remote-shell "/bin/sh")
336 (tramp-remote-shell-args ("-c"))))
d68b0220 337;;;###tramp-autoload
03c1ad43
MA
338(add-to-list 'tramp-methods
339 '("krlogin"
340 (tramp-login-program "krlogin")
341 (tramp-login-args (("%h") ("-l" "%u") ("-x")))
f5e29b9b
MA
342 (tramp-remote-shell "/bin/sh")
343 (tramp-remote-shell-args ("-c"))))
03c1ad43
MA
344;;;###tramp-autoload
345(add-to-list 'tramp-methods
346 '("plink"
347 (tramp-login-program "plink")
348 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
f5e29b9b
MA
349 (tramp-remote-shell "/bin/sh")
350 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
351 (tramp-default-port 22)))
352;;;###tramp-autoload
353(add-to-list 'tramp-methods
354 '("plink1"
355 (tramp-login-program "plink")
356 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-1" "-ssh") ("%h")))
f5e29b9b
MA
357 (tramp-remote-shell "/bin/sh")
358 (tramp-remote-shell-args ("-c"))
03c1ad43
MA
359 (tramp-default-port 22)))
360;;;###tramp-autoload
361(add-to-list 'tramp-methods
362 `("plinkx"
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")
367 (,(format
368 "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
369 tramp-terminal-type
370 tramp-initial-end-of-output))
371 ("/bin/sh")))
f5e29b9b
MA
372 (tramp-remote-shell "/bin/sh")
373 (tramp-remote-shell-args ("-c"))))
03c1ad43
MA
374;;;###tramp-autoload
375(add-to-list 'tramp-methods
376 '("pscp"
377 (tramp-login-program "plink")
378 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
f5e29b9b
MA
379 (tramp-remote-shell "/bin/sh")
380 (tramp-remote-shell-args ("-c"))
03c1ad43 381 (tramp-copy-program "pscp")
a5509865 382 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-scp") ("-p" "%k")
66feec8b 383 ("-q") ("-r")))
03c1ad43 384 (tramp-copy-keep-date t)
66feec8b 385 (tramp-copy-recursive t)
03c1ad43
MA
386 (tramp-default-port 22)))
387;;;###tramp-autoload
388(add-to-list 'tramp-methods
389 '("psftp"
390 (tramp-login-program "plink")
391 (tramp-login-args (("-l" "%u") ("-P" "%p") ("-ssh") ("%h")))
f5e29b9b
MA
392 (tramp-remote-shell "/bin/sh")
393 (tramp-remote-shell-args ("-c"))
03c1ad43 394 (tramp-copy-program "pscp")
a5509865 395 (tramp-copy-args (("-l" "%u") ("-P" "%p") ("-sftp") ("-p" "%k")
66feec8b 396 ("-q") ("-r")))
03c1ad43 397 (tramp-copy-keep-date t)
2fe4b125 398 (tramp-copy-recursive t)))
03c1ad43
MA
399;;;###tramp-autoload
400(add-to-list 'tramp-methods
401 '("fcp"
402 (tramp-login-program "fsh")
403 (tramp-login-args (("%h") ("-l" "%u") ("sh" "-i")))
f5e29b9b
MA
404 (tramp-remote-shell "/bin/sh")
405 (tramp-remote-shell-args ("-i") ("-c"))
03c1ad43 406 (tramp-copy-program "fcp")
f3afd36b 407 (tramp-copy-args (("-p" "%k")))
03c1ad43
MA
408 (tramp-copy-keep-date t)))
409
b191c9d9 410;;;###tramp-autoload
03c1ad43
MA
411(add-to-list 'tramp-default-method-alist
412 `(,tramp-local-host-regexp "\\`root\\'" "su"))
413
b191c9d9 414;;;###tramp-autoload
03c1ad43 415(add-to-list 'tramp-default-user-alist
d68b0220
MA
416 `(,(concat "\\`" (regexp-opt '("su" "sudo" "ksu")) "\\'")
417 nil "root"))
fe99f704 418;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
a5509865 419;; Do not add "plink" based methods, they ask interactively for the user.
b191c9d9 420;;;###tramp-autoload
03c1ad43 421(add-to-list 'tramp-default-user-alist
d68b0220
MA
422 `(,(concat
423 "\\`"
a5509865 424 (regexp-opt '("rcp" "remcp" "rsh" "telnet" "krlogin" "fcp"))
d68b0220 425 "\\'")
03c1ad43
MA
426 nil ,(user-login-name)))
427
f8f91c2b 428;;;###tramp-autoload
03c1ad43
MA
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.")
433
f8f91c2b 434;;;###tramp-autoload
03c1ad43
MA
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.")
449
f8f91c2b 450;;;###tramp-autoload
03c1ad43
MA
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.")
454
f8f91c2b 455;;;###tramp-autoload
03c1ad43
MA
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.")
459
f8f91c2b 460;;;###tramp-autoload
03c1ad43 461(defconst tramp-completion-function-alist-putty
2fe4b125
MA
462 `((tramp-parse-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.")
03c1ad43 467
f8f91c2b
MA
468;;;###tramp-autoload
469(eval-after-load 'tramp
470 '(progn
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)))
03c1ad43
MA
506
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 ":"!
512;; IRIX64: /usr/bin
97912def 513;;;###tramp-autoload
03c1ad43 514(defcustom tramp-remote-path
2fe4b125
MA
515 '(tramp-default-remote-path "/bin" "/usr/bin" "/usr/sbin"
516 "/usr/local/bin" "/local/bin" "/local/freeware/bin" "/local/gnu/bin"
517 "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin"
518 "/opt/bin" "/opt/sbin" "/opt/local/bin")
fb7ada5f 519 "List of directories to search for executables on remote host.
03c1ad43
MA
520For every remote host, this variable will be set buffer local,
521keeping the list of existing directories on that host.
522
523You can use `~' in this list, but when searching for a shell which groks
524tilde expansion, all directory names starting with `~' will be ignored.
525
526`Default Directories' represent the list of directories given by
527the command \"getconf PATH\". It is recommended to use this
528entry on top of this list, because these are the default
a857d3c7
MA
529directories for POSIX compatible commands. On remote hosts which
530do not offer the getconf command (like cygwin), the value
531\"/bin:/usr/bin\" is used instead of.
03c1ad43
MA
532
533`Private Directories' are the settings of the $PATH environment,
534as given in your `~/.profile'."
535 :group 'tramp
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"))))
540
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)
99a54f21 546 "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH=" "PAGER=\"\""
03c1ad43 547 "autocorrect=" "correct=")
fb7ada5f 548 "List of environment variables to be set on the remote host.
03c1ad43
MA
549
550Each element should be a string of the form ENVVARNAME=VALUE. An
4c36be58 551entry ENVVARNAME= disables the corresponding environment variable,
03c1ad43
MA
552which might have been set in the init files like ~/.profile.
553
554Special handling is applied to the PATH environment, which should
2c68ca0e 555not be set here. Instead, it should be set via `tramp-remote-path'."
03c1ad43
MA
556 :group 'tramp
557 :type '(repeat string))
558
559(defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
fb7ada5f 560 "Alist specifying extra arguments to pass to the remote shell.
03c1ad43
MA
561Entries are (REGEXP . ARGS) where REGEXP is a regular expression
562matching the shell file name and ARGS is a string specifying the
563arguments.
564
565This variable is only used when Tramp needs to start up another shell
566for tilde expansion. The extra arguments should typically prevent the
567shell from reading its init file."
568 :group 'tramp
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))))
574
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.
586Whenever a pattern matches, the corresponding action is performed.
587Each item looks like (PATTERN ACTION).
588
589The PATTERN should be a symbol, a variable. The value of this
590variable gives the regular expression to search for. Note that the
591regexp must match at the end of the buffer, \"\\'\" is implicitly
592appended to it.
593
594The ACTION should also be a symbol, but a function. When the
595corresponding PATTERN matches, the ACTION function is called.")
596
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.
603This list is used for copying/renaming with out-of-band methods.
604
605See `tramp-actions-before-shell' for more info.")
606
607(defconst tramp-uudecode
608 "(echo begin 600 /tmp/tramp.$$; tail +2) | uudecode
609cat /tmp/tramp.$$
610rm -f /tmp/tramp.$$"
611 "Shell function to implement `uudecode' to standard output.
612Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
613for this or `uudecode -p', but some systems don't, and for them
614we have this shell function.")
615
616(defconst tramp-perl-file-truename
617 "%s -e '
618use File::Spec;
619use Cwd \"realpath\";
620
621sub recursive {
622 my ($volume, @dirs) = @_;
623 my $real = realpath(File::Spec->catpath(
624 $volume, File::Spec->catdir(@dirs), \"\"));
625 if ($real) {
626 my ($vol, $dir) = File::Spec->splitpath($real, 1);
627 return ($vol, File::Spec->splitdir($dir));
628 }
629 else {
630 my $last = pop(@dirs);
631 ($volume, @dirs) = recursive($volume, @dirs);
632 push(@dirs, $last);
633 return ($volume, @dirs);
634 }
635}
636
637$result = realpath($ARGV[0]);
638if (!$result) {
639 my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
640 ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));
641
642 $result = File::Spec->catpath($vol, File::Spec->catdir(@dirs), \"\");
643}
644
645if ($ARGV[0] =~ /\\/$/) {
646 $result = $result . \"/\";
647}
648
649print \"\\\"$result\\\"\\n\";
650' \"$1\" 2>/dev/null"
651 "Perl script to produce output suitable for use with `file-truename'
652on the remote file system.
653Escape sequence %s is replaced with name of Perl binary.
654This string is passed to `format', so percent characters need to be doubled.")
655
656(defconst tramp-perl-file-name-all-completions
657 "%s -e 'sub case {
658 my $str = shift;
659 if ($ARGV[2]) {
660 return lc($str);
661 }
662 else {
663 return $str;
664 }
665}
666opendir(d, $ARGV[0]) || die(\"$ARGV[0]: $!\\nfail\\n\");
667@files = readdir(d); closedir(d);
668foreach $f (@files) {
669 if (case(substr($f, 0, length($ARGV[1]))) eq case($ARGV[1])) {
670 if (-d \"$ARGV[0]/$f\") {
671 print \"$f/\\n\";
672 }
673 else {
674 print \"$f\\n\";
675 }
676 }
677}
678print \"ok\\n\"
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
682sequence %s is replaced with name of Perl binary. This string is
683passed to `format', so percent characters need to be doubled.")
684
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
688;; end.
689;; The device number is returned as "-1", because there will be a virtual
4a93e698 690;; device number set in `tramp-sh-handle-file-attributes'.
03c1ad43
MA
691(defconst tramp-perl-file-attributes
692 "%s -e '
693@stat = lstat($ARGV[0]);
694if (!@stat) {
695 print \"nil\\n\";
696 exit 0;
697}
698if (($stat[2] & 0170000) == 0120000)
699{
700 $type = readlink($ARGV[0]);
701 $type = \"\\\"$type\\\"\";
702}
703elsif (($stat[2] & 0170000) == 040000)
704{
705 $type = \"t\";
706}
707else
708{
709 $type = \"nil\"
710};
711$uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
712$gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
713printf(
714 \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) -1)\\n\",
715 $type,
716 $stat[3],
717 $uid,
718 $gid,
719 $stat[8] >> 16 & 0xffff,
720 $stat[8] & 0xffff,
721 $stat[9] >> 16 & 0xffff,
722 $stat[9] & 0xffff,
723 $stat[10] >> 16 & 0xffff,
724 $stat[10] & 0xffff,
725 $stat[7],
726 $stat[2],
727 $stat[1] >> 16 & 0xffff,
728 $stat[1] & 0xffff
729);' \"$1\" \"$2\" 2>/dev/null"
730 "Perl script to produce output suitable for use with `file-attributes'
731on the remote file system.
732Escape sequence %s is replaced with name of Perl binary.
733This string is passed to `format', so percent characters need to be doubled.")
734
735(defconst tramp-perl-directory-files-and-attributes
736 "%s -e '
737chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
738opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
739@list = readdir(DIR);
740closedir(DIR);
741$n = scalar(@list);
742printf(\"(\\n\");
743for($i = 0; $i < $n; $i++)
744{
745 $filename = $list[$i];
746 @stat = lstat($filename);
747 if (($stat[2] & 0170000) == 0120000)
748 {
749 $type = readlink($filename);
750 $type = \"\\\"$type\\\"\";
751 }
752 elsif (($stat[2] & 0170000) == 040000)
753 {
754 $type = \"t\";
755 }
756 else
757 {
758 $type = \"nil\"
759 };
760 $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
761 $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
762 printf(
763 \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
764 $filename,
765 $type,
766 $stat[3],
767 $uid,
768 $gid,
769 $stat[8] >> 16 & 0xffff,
770 $stat[8] & 0xffff,
771 $stat[9] >> 16 & 0xffff,
772 $stat[9] & 0xffff,
773 $stat[10] >> 16 & 0xffff,
774 $stat[10] & 0xffff,
775 $stat[7],
776 $stat[2],
777 $stat[1] >> 16 & 0xffff,
778 $stat[1] & 0xffff,
779 $stat[0] >> 16 & 0xffff,
780 $stat[0] & 0xffff);
781}
782printf(\")\\n\");' \"$1\" \"$2\" 2>/dev/null"
783 "Perl script implementing `directory-files-attributes' as Lisp `read'able
784output.
785Escape sequence %s is replaced with name of Perl binary.
786This string is passed to `format', so percent characters need to be doubled.")
787
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.
792Escape sequence %s is replaced with name of Perl binary.
793This string is passed to `format', so percent characters need to be doubled.
794This implementation requires the MIME::Base64 Perl module to be installed
795on the remote host.")
796
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.
800Escape sequence %s is replaced with name of Perl binary.
801This string is passed to `format', so percent characters need to be doubled.
802This implementation requires the MIME::Base64 Perl module to be installed
803on the remote host.")
804
805(defconst tramp-perl-encode
806 "%s -e '
807# This script contributed by Juanma Barranquero <lektu@terra.es>.
acaf905b 808# Copyright (C) 2002-2012 Free Software Foundation, Inc.
03c1ad43
MA
809use strict;
810
811my %%trans = do {
812 my $i = 0;
813 map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
814 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
815};
816
817binmode(\\*STDIN);
818
819# We read in chunks of 54 bytes, to generate output lines
820# of 72 chars (plus end of line)
821$/ = \\54;
822
823while (my $data = <STDIN>) {
824 my $pad = q();
825
826 # Only for the last chunk, and only if did not fill the last three-byte packet
827 if (eof) {
828 my $mod = length($data) %% 3;
829 $pad = q(=) x (3 - $mod) if $mod;
830 }
831
832 # Not the fastest method, but it is simple: unpack to binary string, split
833 # by groups of 6 bits and convert back from binary to byte; then map into
834 # the translation table
835 print
836 join q(),
837 map($trans{$_},
838 (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
839 $pad,
840 qq(\\n);
841}' 2>/dev/null"
842 "Perl program to use for encoding a file.
843Escape sequence %s is replaced with name of Perl binary.
844This string is passed to `format', so percent characters need to be doubled.")
845
846(defconst tramp-perl-decode
847 "%s -e '
848# This script contributed by Juanma Barranquero <lektu@terra.es>.
acaf905b 849# Copyright (C) 2002-2012 Free Software Foundation, Inc.
03c1ad43
MA
850use strict;
851
852my %%trans = do {
853 my $i = 0;
854 map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
855 split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
856};
857
858my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;
859
860binmode(\\*STDOUT);
861
862# We are going to accumulate into $pending to accept any line length
863# (we do not check they are <= 76 chars as the RFC says)
864my $pending = q();
865
866while (my $data = <STDIN>) {
867 chomp $data;
868
869 # If we find one or two =, we have reached the end and
870 # any following data is to be discarded
871 my $finished = $data =~ s/(==?).*/$1/;
872 $pending .= $data;
873
874 my $len = length($pending);
875 my $chunk = substr($pending, 0, $len & ~3);
876 $pending = substr($pending, $len & ~3 + 1);
877
878 # Easy method: translate from chars to (pregenerated) six-bit packets, join,
879 # split in 8-bit chunks and convert back to char.
880 print join q(),
881 map $bytes{$_},
882 ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);
883
884 last if $finished;
885}' 2>/dev/null"
886 "Perl program to use for decoding a file.
887Escape sequence %s is replaced with name of Perl binary.
888This string is passed to `format', so percent characters need to be doubled.")
889
890(defconst tramp-vc-registered-read-file-names
891 "echo \"(\"
892while read file; do
893 if %s \"$file\"; then
894 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" t)\"
895 else
896 echo \"(\\\"$file\\\" \\\"file-exists-p\\\" nil)\"
897 fi
898 if %s \"$file\"; then
899 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" t)\"
900 else
901 echo \"(\\\"$file\\\" \\\"file-readable-p\\\" nil)\"
902 fi
903done
904echo \")\""
905 "Script to check existence of VC related files.
906It must be send formatted with two strings; the tests for file
907existence, and file readability. Input shall be read via
908here-document, otherwise the command could exceed maximum length
909of command line.")
910
911(defconst tramp-file-mode-type-map
912 '((0 . "-") ; Normal file (SVID-v2 and XPG2)
913 (1 . "p") ; fifo
914 (2 . "c") ; character device
915 (3 . "m") ; multiplexed character device (v7)
916 (4 . "d") ; directory
917 (5 . "?") ; Named special file (XENIX)
918 (6 . "b") ; block device
919 (7 . "?") ; multiplexed block device (v7)
920 (8 . "-") ; regular file
921 (9 . "n") ; network special file (HP-UX)
922 (10 . "l") ; symlink
923 (11 . "?") ; ACL shadow inode (Solaris, not userspace)
924 (12 . "s") ; socket
925 (13 . "D") ; door special (Solaris)
926 (14 . "w")) ; whiteout (BSD)
927 "A list of file types returned from the `stat' system call.
928This is used to map a mode number to a permission string.")
929
930;; New handlers should be added here. The following operations can be
931;; handled using the normal primitives: file-name-sans-versions,
932;; get-file-buffer.
933(defconst tramp-sh-file-name-handler-alist
934 '((load . tramp-handle-load)
4a93e698 935 (make-symbolic-link . tramp-sh-handle-make-symbolic-link)
03c1ad43
MA
936 (file-name-as-directory . tramp-handle-file-name-as-directory)
937 (file-name-directory . tramp-handle-file-name-directory)
938 (file-name-nondirectory . tramp-handle-file-name-nondirectory)
4a93e698
MA
939 (file-truename . tramp-sh-handle-file-truename)
940 (file-exists-p . tramp-sh-handle-file-exists-p)
941 (file-directory-p . tramp-sh-handle-file-directory-p)
942 (file-executable-p . tramp-sh-handle-file-executable-p)
943 (file-readable-p . tramp-sh-handle-file-readable-p)
03c1ad43
MA
944 (file-regular-p . tramp-handle-file-regular-p)
945 (file-symlink-p . tramp-handle-file-symlink-p)
4a93e698
MA
946 (file-writable-p . tramp-sh-handle-file-writable-p)
947 (file-ownership-preserved-p . tramp-sh-handle-file-ownership-preserved-p)
948 (file-newer-than-file-p . tramp-sh-handle-file-newer-than-file-p)
949 (file-attributes . tramp-sh-handle-file-attributes)
03c1ad43
MA
950 (file-modes . tramp-handle-file-modes)
951 (directory-files . tramp-handle-directory-files)
4a93e698
MA
952 (directory-files-and-attributes
953 . tramp-sh-handle-directory-files-and-attributes)
954 (file-name-all-completions . tramp-sh-handle-file-name-all-completions)
03c1ad43 955 (file-name-completion . tramp-handle-file-name-completion)
4a93e698
MA
956 (add-name-to-file . tramp-sh-handle-add-name-to-file)
957 (copy-file . tramp-sh-handle-copy-file)
958 (copy-directory . tramp-sh-handle-copy-directory)
959 (rename-file . tramp-sh-handle-rename-file)
960 (set-file-modes . tramp-sh-handle-set-file-modes)
961 (set-file-times . tramp-sh-handle-set-file-times)
962 (make-directory . tramp-sh-handle-make-directory)
963 (delete-directory . tramp-sh-handle-delete-directory)
964 (delete-file . tramp-sh-handle-delete-file)
03c1ad43
MA
965 (directory-file-name . tramp-handle-directory-file-name)
966 ;; `executable-find' is not official yet.
4a93e698
MA
967 (executable-find . tramp-sh-handle-executable-find)
968 (start-file-process . tramp-sh-handle-start-file-process)
969 (process-file . tramp-sh-handle-process-file)
f5e29b9b 970 (shell-command . tramp-handle-shell-command)
4a93e698
MA
971 (insert-directory . tramp-sh-handle-insert-directory)
972 (expand-file-name . tramp-sh-handle-expand-file-name)
03c1ad43 973 (substitute-in-file-name . tramp-handle-substitute-in-file-name)
4a93e698 974 (file-local-copy . tramp-sh-handle-file-local-copy)
03c1ad43
MA
975 (file-remote-p . tramp-handle-file-remote-p)
976 (insert-file-contents . tramp-handle-insert-file-contents)
977 (insert-file-contents-literally
4a93e698
MA
978 . tramp-sh-handle-insert-file-contents-literally)
979 (write-region . tramp-sh-handle-write-region)
e44eccd7 980 (find-backup-file-name . tramp-handle-find-backup-file-name)
4a93e698 981 (make-auto-save-file-name . tramp-sh-handle-make-auto-save-file-name)
03c1ad43 982 (unhandled-file-name-directory . tramp-handle-unhandled-file-name-directory)
4a93e698 983 (dired-compress-file . tramp-sh-handle-dired-compress-file)
03c1ad43 984 (dired-recursive-delete-directory
4a93e698 985 . tramp-sh-handle-dired-recursive-delete-directory)
03c1ad43 986 (dired-uncache . tramp-handle-dired-uncache)
4a93e698
MA
987 (set-visited-file-modtime . tramp-sh-handle-set-visited-file-modtime)
988 (verify-visited-file-modtime . tramp-sh-handle-verify-visited-file-modtime)
989 (file-selinux-context . tramp-sh-handle-file-selinux-context)
990 (set-file-selinux-context . tramp-sh-handle-set-file-selinux-context)
991 (vc-registered . tramp-sh-handle-vc-registered))
03c1ad43
MA
992 "Alist of handler functions.
993Operations not mentioned here will be handled by the normal Emacs functions.")
994
995;; This must be the last entry, because `identity' always matches.
996;;;###tramp-autoload
997(add-to-list 'tramp-foreign-file-name-handler-alist
998 '(identity . tramp-sh-file-name-handler) 'append)
999
1000;;; File Name Handler Functions:
1001
4a93e698 1002(defun tramp-sh-handle-make-symbolic-link
03c1ad43
MA
1003 (filename linkname &optional ok-if-already-exists)
1004 "Like `make-symbolic-link' for Tramp files.
1005If LINKNAME is a non-Tramp file, it is used verbatim as the target of
1006the symlink. If LINKNAME is a Tramp file, only the localname component is
1007used as the target of the symlink.
1008
1009If LINKNAME is a Tramp file and the localname component is relative, then
1010it is expanded first, before the localname component is taken. Note that
1011this can give surprising results if the user/host for the source and
1012target 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))))
1017 (unless ln
1018 (tramp-error
1019 l 'file-error
1020 "Making a symbolic link. ln(1) does not exist on the remote host."))
1021
1022 ;; Do the 'confirm if exists' thing.
1023 (when (file-exists-p linkname)
1024 ;; What to do?
1025 (if (or (null ok-if-already-exists) ; not allowed to exist
1026 (and (numberp ok-if-already-exists)
1027 (not (yes-or-no-p
1028 (format
1029 "File %s already exists; make it a link anyway? "
1030 l-localname)))))
1031 (tramp-error
1032 l 'file-already-exists "File %s already exists" l-localname)
1033 (delete-file linkname)))
1034
1035 ;; If FILENAME is a Tramp name, use just the localname component.
1036 (when (tramp-tramp-file-p filename)
1037 (setq filename
1038 (tramp-file-name-localname
1039 (tramp-dissect-file-name (expand-file-name filename)))))
1040
1041 (tramp-flush-file-property l (file-name-directory l-localname))
1042 (tramp-flush-file-property l l-localname)
1043
6bdac736
MA
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.
03c1ad43
MA
1047 (tramp-send-command-and-check
1048 l
1049 (format
1050 "cd %s && %s -sf %s %s"
1051 (tramp-shell-quote-argument cwd)
1052 ln
1053 (tramp-shell-quote-argument filename)
1054 (tramp-shell-quote-argument l-localname))
1055 t))))
1056
4a93e698 1057(defun tramp-sh-handle-file-truename (filename &optional counter prev-dirs)
03c1ad43
MA
1058 "Like `file-truename' for Tramp files."
1059 (with-parsed-tramp-file-name (expand-file-name filename) nil
d0c8fc8a
MA
1060 (tramp-make-tramp-file-name method user host
1061 (with-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)
1064 (cond
1065 ;; Use GNU readlink --canonicalize-missing where available.
1066 ((tramp-get-remote-readlink v)
1067 (setq result
1068 (tramp-send-command-and-read
1069 v
1070 (format "echo \"\\\"`%s --canonicalize-missing %s`\\\"\""
1071 (tramp-get-remote-readlink v)
1072 (tramp-shell-quote-argument localname)))))
1073
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")
1080 (setq result
1081 (tramp-send-command-and-read
1082 v
1083 (format "tramp_perl_file_truename %s"
1084 (tramp-shell-quote-argument localname)))))
1085
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))
1093 (thisstep nil)
1094 (numchase 0)
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.
1100 (numchase-limit 20)
1101 symlink-target)
1102 (while (and steps (< numchase numchase-limit))
1103 (setq thisstep (pop steps))
1104 (tramp-message
1105 v 5 "Check %s"
1106 (mapconcat 'identity
1107 (append '("") (reverse result) (list thisstep))
1108 "/"))
1109 (setq symlink-target
1110 (nth 0 (file-attributes
1111 (tramp-make-tramp-file-name
1112 method user host
1113 (mapconcat 'identity
1114 (append '("")
1115 (reverse result)
1116 (list thisstep))
1117 "/")))))
1118 (cond ((string= "." thisstep)
1119 (tramp-message v 5 "Ignoring step `.'"))
1120 ((string= ".." thisstep)
1121 (tramp-message v 5 "Processing step `..'")
1122 (pop result))
1123 ((stringp symlink-target)
1124 ;; It's a symlink, follow it.
1125 (tramp-message
1126 v 5 "Follow symlink to %s" symlink-target)
1127 (setq numchase (1+ numchase))
1128 (when (file-name-absolute-p symlink-target)
1129 (setq result nil))
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)
1135 (tramp-error
1136 v 'file-error
1137 "Symlink target `%s' on wrong host"
1138 symlink-target))
1139 (setq symlink-target localname))
1140 (setq steps
1141 (append (tramp-compat-split-string
1142 symlink-target "/")
1143 steps)))
1144 (t
1145 ;; It's a file.
1146 (setq result (cons thisstep result)))))
1147 (when (>= numchase numchase-limit)
1148 (tramp-error
1149 v 'file-error
1150 "Maximum number (%d) of symlinks exceeded" numchase-limit))
1151 (setq result (reverse result))
1152 ;; Combine list to form string.
1153 (setq result
1154 (if result
1155 (mapconcat 'identity (cons "" result) "/")
1156 "/"))
1157 (when (and is-dir
1158 (or (string= "" result)
1159 (not (string= (substring result -1) "/"))))
1160 (setq result (concat result "/"))))))
1161
1162 (tramp-message v 4 "True name of `%s' is `%s'" localname result)
1163 result)))))
03c1ad43
MA
1164
1165;; Basic functions.
1166
4a93e698 1167(defun tramp-sh-handle-file-exists-p (filename)
03c1ad43
MA
1168 "Like `file-exists-p' for Tramp files."
1169 (with-parsed-tramp-file-name filename nil
1170 (with-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
1176 v
1177 (format
1178 "%s %s"
1179 (tramp-get-file-exists-command v)
1180 (tramp-shell-quote-argument localname)))))))
1181
4a93e698 1182(defun tramp-sh-handle-file-attributes (filename &optional id-format)
03c1ad43
MA
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-file-property v localname (format "file-attributes-%s" id-format)
1189 (save-excursion
1190 (tramp-convert-file-attributes
1191 v
f42efeb5
MA
1192 (or
1193 (cond
1194 ((tramp-get-remote-stat v)
1195 (tramp-do-file-attributes-with-stat v localname id-format))
1196 ((tramp-get-remote-perl v)
1197 (tramp-do-file-attributes-with-perl v localname id-format))
1198 (t nil))
1199 ;; The scripts could fail, for example with huge file size.
1200 (tramp-do-file-attributes-with-ls v localname id-format))))))))
03c1ad43
MA
1201
1202(defun tramp-do-file-attributes-with-ls (vec localname &optional id-format)
1203 "Implement `file-attributes' for Tramp files using the ls(1) command."
1204 (let (symlinkp dirp
1205 res-inode res-filemodes res-numlinks
1206 res-uid res-gid res-size res-symlink-target)
1207 (tramp-message vec 5 "file attributes with ls: %s" localname)
1208 (tramp-send-command
1209 vec
1210 (format "(%s %s || %s -h %s) && %s %s %s"
1211 (tramp-get-file-exists-command vec)
1212 (tramp-shell-quote-argument localname)
1213 (tramp-get-test-command vec)
1214 (tramp-shell-quote-argument localname)
1215 (tramp-get-ls-command vec)
1216 (if (eq id-format 'integer) "-ildn" "-ild")
1217 (tramp-shell-quote-argument localname)))
1218 ;; parse `ls -l' output ...
1219 (with-current-buffer (tramp-get-buffer vec)
1220 (when (> (buffer-size) 0)
1221 (goto-char (point-min))
1222 ;; ... inode
1223 (setq res-inode
1224 (condition-case err
1225 (read (current-buffer))
1226 (invalid-read-syntax
1227 (when (and (equal (cadr err)
1228 "Integer constant overflow in reader")
1229 (string-match
1230 "^[0-9]+\\([0-9][0-9][0-9][0-9][0-9]\\)\\'"
1231 (car (cddr err))))
1232 (let* ((big (read (substring (car (cddr err)) 0
1233 (match-beginning 1))))
1234 (small (read (match-string 1 (car (cddr err)))))
1235 (twiddle (/ small 65536)))
1236 (cons (+ big twiddle)
1237 (- small (* twiddle 65536))))))))
1238 ;; ... file mode flags
1239 (setq res-filemodes (symbol-name (read (current-buffer))))
1240 ;; ... number links
1241 (setq res-numlinks (read (current-buffer)))
1242 ;; ... uid and gid
1243 (setq res-uid (read (current-buffer)))
1244 (setq res-gid (read (current-buffer)))
1245 (if (eq id-format 'integer)
1246 (progn
1247 (unless (numberp res-uid) (setq res-uid -1))
1248 (unless (numberp res-gid) (setq res-gid -1)))
1249 (progn
1250 (unless (stringp res-uid) (setq res-uid (symbol-name res-uid)))
1251 (unless (stringp res-gid) (setq res-gid (symbol-name res-gid)))))
1252 ;; ... size
1253 (setq res-size (read (current-buffer)))
1254 ;; From the file modes, figure out other stuff.
1255 (setq symlinkp (eq ?l (aref res-filemodes 0)))
1256 (setq dirp (eq ?d (aref res-filemodes 0)))
1257 ;; if symlink, find out file name pointed to
1258 (when symlinkp
1259 (search-forward "-> ")
6e060cee 1260 (setq res-symlink-target (buffer-substring (point) (point-at-eol))))
03c1ad43
MA
1261 ;; return data gathered
1262 (list
1263 ;; 0. t for directory, string (name linked to) for symbolic
1264 ;; link, or nil.
1265 (or dirp res-symlink-target)
1266 ;; 1. Number of links to file.
1267 res-numlinks
1268 ;; 2. File uid.
1269 res-uid
1270 ;; 3. File gid.
1271 res-gid
1272 ;; 4. Last access time, as a list of two integers. First
1273 ;; integer has high-order 16 bits of time, second has low 16
1274 ;; bits.
1275 ;; 5. Last modification time, likewise.
1276 ;; 6. Last status change time, likewise.
1277 '(0 0) '(0 0) '(0 0) ;CCC how to find out?
1278 ;; 7. Size in bytes (-1, if number is out of range).
1279 res-size
1280 ;; 8. File modes, as a string of ten letters or dashes as in ls -l.
1281 res-filemodes
1282 ;; 9. t if file's gid would change if file were deleted and
1283 ;; recreated. Will be set in `tramp-convert-file-attributes'
1284 t
1285 ;; 10. inode number.
1286 res-inode
1287 ;; 11. Device number. Will be replaced by a virtual device number.
1288 -1
1289 )))))
1290
1291(defun tramp-do-file-attributes-with-perl
1292 (vec localname &optional id-format)
1293 "Implement `file-attributes' for Tramp files using a Perl script."
1294 (tramp-message vec 5 "file attributes with perl: %s" localname)
1295 (tramp-maybe-send-script
1296 vec tramp-perl-file-attributes "tramp_perl_file_attributes")
1297 (tramp-send-command-and-read
1298 vec
1299 (format "tramp_perl_file_attributes %s %s"
1300 (tramp-shell-quote-argument localname) id-format)))
1301
1302(defun tramp-do-file-attributes-with-stat
1303 (vec localname &optional id-format)
1304 "Implement `file-attributes' for Tramp files using stat(1) command."
1305 (tramp-message vec 5 "file attributes with stat: %s" localname)
1306 (tramp-send-command-and-read
1307 vec
1308 (format
1309 ;; On Opsware, pdksh (which is the true name of ksh there) doesn't
1310 ;; parse correctly the sequence "((". Therefore, we add a space.
01d884cf 1311 "( (%s %s || %s -h %s) && %s -c '((\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)' %s || echo nil)"
03c1ad43
MA
1312 (tramp-get-file-exists-command vec)
1313 (tramp-shell-quote-argument localname)
1314 (tramp-get-test-command vec)
1315 (tramp-shell-quote-argument localname)
1316 (tramp-get-remote-stat vec)
2fe4b125
MA
1317 (if (eq id-format 'integer) "%ue0" "\"%U\"")
1318 (if (eq id-format 'integer) "%ge0" "\"%G\"")
03c1ad43
MA
1319 (tramp-shell-quote-argument localname))))
1320
4a93e698 1321(defun tramp-sh-handle-set-visited-file-modtime (&optional time-list)
03c1ad43
MA
1322 "Like `set-visited-file-modtime' for Tramp files."
1323 (unless (buffer-file-name)
1324 (error "Can't set-visited-file-modtime: buffer `%s' not visiting a file"
1325 (buffer-name)))
1326 (if time-list
1327 (tramp-run-real-handler 'set-visited-file-modtime (list time-list))
1328 (let ((f (buffer-file-name))
1329 coding-system-used)
1330 (with-parsed-tramp-file-name f nil
1331 (let* ((attr (file-attributes f))
1332 ;; '(-1 65535) means file doesn't exists yet.
1333 (modtime (or (nth 5 attr) '(-1 65535))))
1334 (when (boundp 'last-coding-system-used)
1335 (setq coding-system-used (symbol-value 'last-coding-system-used)))
1336 ;; We use '(0 0) as a don't-know value. See also
1337 ;; `tramp-do-file-attributes-with-ls'.
1338 (if (not (equal modtime '(0 0)))
1339 (tramp-run-real-handler 'set-visited-file-modtime (list modtime))
1340 (progn
1341 (tramp-send-command
1342 v
1343 (format "%s -ild %s"
1344 (tramp-get-ls-command v)
1345 (tramp-shell-quote-argument localname)))
1346 (setq attr (buffer-substring (point)
1347 (progn (end-of-line) (point)))))
1348 (tramp-set-file-property
1349 v localname "visited-file-modtime-ild" attr))
1350 (when (boundp 'last-coding-system-used)
1351 (set 'last-coding-system-used coding-system-used))
1352 nil)))))
1353
1354;; This function makes the same assumption as
4a93e698
MA
1355;; `tramp-sh-handle-set-visited-file-modtime'.
1356(defun tramp-sh-handle-verify-visited-file-modtime (buf)
03c1ad43
MA
1357 "Like `verify-visited-file-modtime' for Tramp files.
1358At the time `verify-visited-file-modtime' calls this function, we
1359already know that the buffer is visiting a file and that
1360`visited-file-modtime' does not return 0. Do not call this
1361function directly, unless those two cases are already taken care
1362of."
1363 (with-current-buffer buf
1364 (let ((f (buffer-file-name)))
1365 ;; There is no file visiting the buffer, or the buffer has no
1366 ;; recorded last modification time, or there is no established
1367 ;; connection.
1368 (if (or (not f)
1369 (eq (visited-file-modtime) 0)
1370 (not (tramp-file-name-handler 'file-remote-p f nil 'connected)))
1371 t
1372 (with-parsed-tramp-file-name f nil
4bc3c53d
MA
1373 (let* ((remote-file-name-inhibit-cache t)
1374 (attr (file-attributes f))
03c1ad43
MA
1375 (modtime (nth 5 attr))
1376 (mt (visited-file-modtime)))
1377
1378 (cond
1379 ;; File exists, and has a known modtime.
1380 ((and attr (not (equal modtime '(0 0))))
1381 (< (abs (tramp-time-diff
1382 modtime
1383 ;; For compatibility, deal with both the old
1384 ;; (HIGH . LOW) and the new (HIGH LOW) return
1385 ;; values of `visited-file-modtime'.
1386 (if (atom (cdr mt))
1387 (list (car mt) (cdr mt))
1388 mt)))
1389 2))
1390 ;; Modtime has the don't know value.
1391 (attr
1392 (tramp-send-command
1393 v
1394 (format "%s -ild %s"
1395 (tramp-get-ls-command v)
1396 (tramp-shell-quote-argument localname)))
1397 (with-current-buffer (tramp-get-buffer v)
1398 (setq attr (buffer-substring
1399 (point) (progn (end-of-line) (point)))))
1400 (equal
1401 attr
1402 (tramp-get-file-property
1403 v localname "visited-file-modtime-ild" "")))
1404 ;; If file does not exist, say it is not modified if and
1405 ;; only if that agrees with the buffer's record.
1406 (t (equal mt '(-1 65535))))))))))
1407
4a93e698 1408(defun tramp-sh-handle-set-file-modes (filename mode)
03c1ad43
MA
1409 "Like `set-file-modes' for Tramp files."
1410 (with-parsed-tramp-file-name filename nil
1411 (tramp-flush-file-property v localname)
1412 ;; FIXME: extract the proper text from chmod's stderr.
1413 (tramp-barf-unless-okay
1414 v
1415 (format "chmod %s %s"
1416 (tramp-compat-decimal-to-octal mode)
1417 (tramp-shell-quote-argument localname))
1418 "Error while changing file's mode %s" filename)))
1419
4a93e698 1420(defun tramp-sh-handle-set-file-times (filename &optional time)
03c1ad43
MA
1421 "Like `set-file-times' for Tramp files."
1422 (if (file-remote-p filename)
1423 (with-parsed-tramp-file-name filename nil
1424 (tramp-flush-file-property v localname)
1425 (let ((time (if (or (null time) (equal time '(0 0)))
1426 (current-time)
1427 time))
1428 ;; With GNU Emacs, `format-time-string' has an optional
1429 ;; parameter UNIVERSAL. This is preferred, because we
1430 ;; could handle the case when the remote host is located
1431 ;; in a different time zone as the local host.
1432 (utc (not (featurep 'xemacs))))
1433 (tramp-send-command-and-check
1434 v (format "%s touch -t %s %s"
1435 (if utc "TZ=UTC; export TZ;" "")
1436 (if utc
1437 (format-time-string "%Y%m%d%H%M.%S" time t)
1438 (format-time-string "%Y%m%d%H%M.%S" time))
1439 (tramp-shell-quote-argument localname)))))
1440
1441 ;; We handle also the local part, because in older Emacsen,
1442 ;; without `set-file-times', this function is an alias for this.
1443 ;; We are local, so we don't need the UTC settings.
1444 (zerop
1445 (tramp-compat-call-process
1446 "touch" nil nil nil "-t"
1447 (format-time-string "%Y%m%d%H%M.%S" time)
1448 (tramp-shell-quote-argument filename)))))
1449
1450(defun tramp-set-file-uid-gid (filename &optional uid gid)
1451 "Set the ownership for FILENAME.
1452If UID and GID are provided, these values are used; otherwise uid
1453and gid of the corresponding user is taken. Both parameters must be integers."
1454 ;; Modern Unices allow chown only for root. So we might need
1455 ;; another implementation, see `dired-do-chown'. OTOH, it is mostly
1456 ;; working with su(do)? when it is needed, so it shall succeed in
1457 ;; the majority of cases.
1458 ;; Don't modify `last-coding-system-used' by accident.
1459 (let ((last-coding-system-used last-coding-system-used))
1460 (if (file-remote-p filename)
1461 (with-parsed-tramp-file-name filename nil
1462 (if (and (zerop (user-uid)) (tramp-local-host-p v))
1463 ;; If we are root on the local host, we can do it directly.
1464 (tramp-set-file-uid-gid localname uid gid)
1465 (let ((uid (or (and (integerp uid) uid)
1466 (tramp-get-remote-uid v 'integer)))
1467 (gid (or (and (integerp gid) gid)
1468 (tramp-get-remote-gid v 'integer))))
1469 (tramp-send-command
1470 v (format
1471 "chown %d:%d %s" uid gid
1472 (tramp-shell-quote-argument localname))))))
1473
1474 ;; We handle also the local part, because there doesn't exist
1475 ;; `set-file-uid-gid'. On W32 "chown" might not work.
1476 (let ((uid (or (and (integerp uid) uid) (tramp-get-local-uid 'integer)))
1477 (gid (or (and (integerp gid) gid) (tramp-get-local-gid 'integer))))
1478 (tramp-compat-call-process
1479 "chown" nil nil nil
1480 (format "%d:%d" uid gid) (tramp-shell-quote-argument filename))))))
1481
1482(defun tramp-remote-selinux-p (vec)
1483 "Check, whether SELINUX is enabled on the remote host."
1484 (with-connection-property (tramp-get-connection-process vec) "selinux-p"
1485 (let ((result (tramp-find-executable
1486 vec "getenforce" (tramp-get-remote-path vec) t t)))
1487 (and result
1488 (string-equal
1489 (tramp-send-command-and-read
1490 vec (format "echo \\\"`%S`\\\"" result))
1491 "Enforcing")))))
1492
4a93e698 1493(defun tramp-sh-handle-file-selinux-context (filename)
03c1ad43
MA
1494 "Like `file-selinux-context' for Tramp files."
1495 (with-parsed-tramp-file-name filename nil
1496 (with-file-property v localname "file-selinux-context"
1497 (let ((context '(nil nil nil nil))
1498 (regexp (concat "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\):"
1499 "\\([a-z0-9_]+\\):" "\\([a-z0-9_]+\\)")))
1500 (when (and (tramp-remote-selinux-p v)
1501 (tramp-send-command-and-check
1502 v (format
1503 "%s -d -Z %s"
1504 (tramp-get-ls-command v)
1505 (tramp-shell-quote-argument localname))))
1506 (with-current-buffer (tramp-get-connection-buffer v)
1507 (goto-char (point-min))
6e060cee 1508 (when (re-search-forward regexp (point-at-eol) t)
03c1ad43
MA
1509 (setq context (list (match-string 1) (match-string 2)
1510 (match-string 3) (match-string 4))))))
1511 ;; Return the context.
1512 context))))
1513
4a93e698 1514(defun tramp-sh-handle-set-file-selinux-context (filename context)
03c1ad43
MA
1515 "Like `set-file-selinux-context' for Tramp files."
1516 (with-parsed-tramp-file-name filename nil
1517 (if (and (consp context)
1518 (tramp-remote-selinux-p v)
1519 (tramp-send-command-and-check
1520 v (format "chcon %s %s %s %s %s"
1521 (if (stringp (nth 0 context))
1522 (format "--user=%s" (nth 0 context)) "")
1523 (if (stringp (nth 1 context))
1524 (format "--role=%s" (nth 1 context)) "")
1525 (if (stringp (nth 2 context))
1526 (format "--type=%s" (nth 2 context)) "")
1527 (if (stringp (nth 3 context))
1528 (format "--range=%s" (nth 3 context)) "")
1529 (tramp-shell-quote-argument localname))))
1530 (tramp-set-file-property v localname "file-selinux-context" context)
1531 (tramp-set-file-property v localname "file-selinux-context" 'undef)))
1532 ;; We always return nil.
1533 nil)
1534
1535;; Simple functions using the `test' command.
1536
4a93e698 1537(defun tramp-sh-handle-file-executable-p (filename)
03c1ad43
MA
1538 "Like `file-executable-p' for Tramp files."
1539 (with-parsed-tramp-file-name filename nil
1540 (with-file-property v localname "file-executable-p"
1541 ;; Examine `file-attributes' cache to see if request can be
1542 ;; satisfied without remote operation.
1543 (or (tramp-check-cached-permissions v ?x)
1544 (tramp-run-test "-x" filename)))))
1545
4a93e698 1546(defun tramp-sh-handle-file-readable-p (filename)
03c1ad43
MA
1547 "Like `file-readable-p' for Tramp files."
1548 (with-parsed-tramp-file-name filename nil
1549 (with-file-property v localname "file-readable-p"
1550 ;; Examine `file-attributes' cache to see if request can be
1551 ;; satisfied without remote operation.
1552 (or (tramp-check-cached-permissions v ?r)
1553 (tramp-run-test "-r" filename)))))
1554
1555;; When the remote shell is started, it looks for a shell which groks
1556;; tilde expansion. Here, we assume that all shells which grok tilde
1557;; expansion will also provide a `test' command which groks `-nt' (for
1558;; newer than). If this breaks, tell me about it and I'll try to do
1559;; something smarter about it.
4a93e698 1560(defun tramp-sh-handle-file-newer-than-file-p (file1 file2)
03c1ad43
MA
1561 "Like `file-newer-than-file-p' for Tramp files."
1562 (cond ((not (file-exists-p file1))
1563 nil)
1564 ((not (file-exists-p file2))
1565 t)
1566 ;; We are sure both files exist at this point.
1567 (t
1568 (save-excursion
1569 ;; We try to get the mtime of both files. If they are not
1570 ;; equal to the "dont-know" value, then we subtract the times
1571 ;; and obtain the result.
1572 (let ((fa1 (file-attributes file1))
1573 (fa2 (file-attributes file2)))
1574 (if (and (not (equal (nth 5 fa1) '(0 0)))
1575 (not (equal (nth 5 fa2) '(0 0))))
1576 (> 0 (tramp-time-diff (nth 5 fa2) (nth 5 fa1)))
1577 ;; If one of them is the dont-know value, then we can
1578 ;; still try to run a shell command on the remote host.
1579 ;; However, this only works if both files are Tramp
1580 ;; files and both have the same method, same user, same
1581 ;; host.
1582 (unless (tramp-equal-remote file1 file2)
1583 (with-parsed-tramp-file-name
1584 (if (tramp-tramp-file-p file1) file1 file2) nil
1585 (tramp-error
1586 v 'file-error
1587 "Files %s and %s must have same method, user, host"
1588 file1 file2)))
1589 (with-parsed-tramp-file-name file1 nil
1590 (tramp-run-test2
1591 (tramp-get-test-nt-command v) file1 file2))))))))
1592
1593;; Functions implemented using the basic functions above.
1594
4a93e698 1595(defun tramp-sh-handle-file-directory-p (filename)
03c1ad43 1596 "Like `file-directory-p' for Tramp files."
03c1ad43 1597 (with-parsed-tramp-file-name filename nil
3f04efd6
MA
1598 ;; `file-directory-p' is used as predicate for filename completion.
1599 ;; Sometimes, when a connection is not established yet, it is
1600 ;; desirable to return t immediately for "/method:foo:". It can
1601 ;; be expected that this is always a directory.
1602 (or (zerop (length localname))
1603 (with-file-property v localname "file-directory-p"
1604 (tramp-run-test "-d" filename)))))
03c1ad43 1605
4a93e698 1606(defun tramp-sh-handle-file-writable-p (filename)
03c1ad43
MA
1607 "Like `file-writable-p' for Tramp files."
1608 (with-parsed-tramp-file-name filename nil
1609 (with-file-property v localname "file-writable-p"
1610 (if (file-exists-p filename)
1611 ;; Examine `file-attributes' cache to see if request can be
1612 ;; satisfied without remote operation.
1613 (or (tramp-check-cached-permissions v ?w)
1614 (tramp-run-test "-w" filename))
1615 ;; If file doesn't exist, check if directory is writable.
1616 (and (tramp-run-test "-d" (file-name-directory filename))
1617 (tramp-run-test "-w" (file-name-directory filename)))))))
1618
4a93e698 1619(defun tramp-sh-handle-file-ownership-preserved-p (filename)
03c1ad43
MA
1620 "Like `file-ownership-preserved-p' for Tramp files."
1621 (with-parsed-tramp-file-name filename nil
1622 (with-file-property v localname "file-ownership-preserved-p"
1623 (let ((attributes (file-attributes filename)))
1624 ;; Return t if the file doesn't exist, since it's true that no
1625 ;; information would be lost by an (attempted) delete and create.
1626 (or (null attributes)
1627 (= (nth 2 attributes) (tramp-get-remote-uid v 'integer)))))))
1628
03c1ad43
MA
1629;; Directory listings.
1630
4a93e698 1631(defun tramp-sh-handle-directory-files-and-attributes
03c1ad43
MA
1632 (directory &optional full match nosort id-format)
1633 "Like `directory-files-and-attributes' for Tramp files."
1634 (unless id-format (setq id-format 'integer))
1635 (when (file-directory-p directory)
1636 (setq directory (expand-file-name directory))
1637 (let* ((temp
1638 (copy-tree
1639 (with-parsed-tramp-file-name directory nil
1640 (with-file-property
1641 v localname
1642 (format "directory-files-and-attributes-%s" id-format)
1643 (save-excursion
1644 (mapcar
1645 (lambda (x)
1646 (cons (car x)
1647 (tramp-convert-file-attributes v (cdr x))))
1648 (cond
1649 ((tramp-get-remote-stat v)
1650 (tramp-do-directory-files-and-attributes-with-stat
1651 v localname id-format))
1652 ((tramp-get-remote-perl v)
1653 (tramp-do-directory-files-and-attributes-with-perl
1654 v localname id-format)))))))))
1655 result item)
1656
1657 (while temp
1658 (setq item (pop temp))
1659 (when (or (null match) (string-match match (car item)))
1660 (when full
1661 (setcar item (expand-file-name (car item) directory)))
1662 (push item result)))
1663
1664 (if nosort
1665 result
1666 (sort result (lambda (x y) (string< (car x) (car y))))))))
1667
1668(defun tramp-do-directory-files-and-attributes-with-perl
1669 (vec localname &optional id-format)
1670 "Implement `directory-files-and-attributes' for Tramp files using a Perl script."
1671 (tramp-message vec 5 "directory-files-and-attributes with perl: %s" localname)
1672 (tramp-maybe-send-script
1673 vec tramp-perl-directory-files-and-attributes
1674 "tramp_perl_directory_files_and_attributes")
1675 (let ((object
1676 (tramp-send-command-and-read
1677 vec
1678 (format "tramp_perl_directory_files_and_attributes %s %s"
1679 (tramp-shell-quote-argument localname) id-format))))
1680 (when (stringp object) (tramp-error vec 'file-error object))
1681 object))
1682
1683(defun tramp-do-directory-files-and-attributes-with-stat
1684 (vec localname &optional id-format)
1685 "Implement `directory-files-and-attributes' for Tramp files using stat(1) command."
1686 (tramp-message vec 5 "directory-files-and-attributes with stat: %s" localname)
1687 (tramp-send-command-and-read
1688 vec
1689 (format
1690 (concat
1691 ;; We must care about filenames with spaces, or starting with
1692 ;; "-"; this would confuse xargs. "ls -aQ" might be a solution,
1693 ;; but it does not work on all remote systems. Therefore, we
1694 ;; quote the filenames via sed.
1695 "cd %s; echo \"(\"; (%s -a | sed -e s/\\$/\\\"/g -e s/^/\\\"/g | xargs "
3224b54d 1696 "%s -c '(\"%%n\" (\"%%N\") %%h %s %s %%Xe0 %%Ye0 %%Ze0 %%se0 \"%%A\" t %%ie0 -1)'); "
03c1ad43
MA
1697 "echo \")\"")
1698 (tramp-shell-quote-argument localname)
1699 (tramp-get-ls-command vec)
1700 (tramp-get-remote-stat vec)
2fe4b125
MA
1701 (if (eq id-format 'integer) "%ue0" "\"%U\"")
1702 (if (eq id-format 'integer) "%ge0" "\"%G\""))))
03c1ad43
MA
1703
1704;; This function should return "foo/" for directories and "bar" for
1705;; files.
4a93e698 1706(defun tramp-sh-handle-file-name-all-completions (filename directory)
03c1ad43
MA
1707 "Like `file-name-all-completions' for Tramp files."
1708 (unless (save-match-data (string-match "/" filename))
1709 (with-parsed-tramp-file-name (expand-file-name directory) nil
1710
1711 (all-completions
1712 filename
1713 (mapcar
1714 'list
1715 (or
4bc3c53d
MA
1716 ;; Try cache entries for filename, filename with last
1717 ;; character removed, filename with last two characters
1718 ;; removed, ..., and finally the empty string - all
1719 ;; concatenated to the local directory name.
1720 (let ((remote-file-name-inhibit-cache
1721 (or remote-file-name-inhibit-cache
1722 tramp-completion-reread-directory-timeout)))
1723
1724 ;; This is inefficient for very long filenames, pity
1725 ;; `reduce' is not available...
1726 (car
1727 (apply
1728 'append
1729 (mapcar
1730 (lambda (x)
1731 (let ((cache-hit
1732 (tramp-get-file-property
1733 v
1734 (concat localname (substring filename 0 x))
1735 "file-name-all-completions"
1736 nil)))
1737 (when cache-hit (list cache-hit))))
91683089
MA
1738 ;; We cannot use a length of 0, because file properties
1739 ;; for "foo" and "foo/" are identical.
1740 (tramp-compat-number-sequence (length filename) 1 -1)))))
03c1ad43
MA
1741
1742 ;; Cache expired or no matching cache entry found so we need
4bc3c53d 1743 ;; to perform a remote operation.
03c1ad43
MA
1744 (let (result)
1745 ;; Get a list of directories and files, including reliably
1746 ;; tagging the directories with a trailing '/'. Because I
1747 ;; rock. --daniel@danann.net
1748
1749 ;; Changed to perform `cd' in the same remote op and only
4bc3c53d 1750 ;; get entries starting with `filename'. Capture any `cd'
03c1ad43
MA
1751 ;; error messages. Ensure any `cd' and `echo' aliases are
1752 ;; ignored.
1753 (tramp-send-command
1754 v
1755 (if (tramp-get-remote-perl v)
1756 (progn
1757 (tramp-maybe-send-script
1758 v tramp-perl-file-name-all-completions
1759 "tramp_perl_file_name_all_completions")
1760 (format "tramp_perl_file_name_all_completions %s %s %d"
1761 (tramp-shell-quote-argument localname)
1762 (tramp-shell-quote-argument filename)
1763 (if (symbol-value
1764 ;; `read-file-name-completion-ignore-case'
1765 ;; is introduced with Emacs 22.1.
1766 (if (boundp
1767 'read-file-name-completion-ignore-case)
1768 'read-file-name-completion-ignore-case
1769 'completion-ignore-case))
1770 1 0)))
1771
1772 (format (concat
1773 "(\\cd %s 2>&1 && (%s %s -a 2>/dev/null"
1774 ;; `ls' with wildcard might fail with `Argument
1775 ;; list too long' error in some corner cases; if
1776 ;; `ls' fails after `cd' succeeded, chances are
1777 ;; that's the case, so let's retry without
1778 ;; wildcard. This will return "too many" entries
1779 ;; but that isn't harmful.
1780 " || %s -a 2>/dev/null)"
1781 " | while read f; do"
1782 " if %s -d \"$f\" 2>/dev/null;"
1783 " then \\echo \"$f/\"; else \\echo \"$f\"; fi; done"
1784 " && \\echo ok) || \\echo fail")
1785 (tramp-shell-quote-argument localname)
1786 (tramp-get-ls-command v)
1787 ;; When `filename' is empty, just `ls' without
1788 ;; filename argument is more efficient than `ls *'
1789 ;; for very large directories and might avoid the
1790 ;; `Argument list too long' error.
1791 ;;
1792 ;; With and only with wildcard, we need to add
1793 ;; `-d' to prevent `ls' from descending into
1794 ;; sub-directories.
1795 (if (zerop (length filename))
1796 "."
1797 (concat (tramp-shell-quote-argument filename) "* -d"))
1798 (tramp-get-ls-command v)
1799 (tramp-get-test-command v))))
1800
1801 ;; Now grab the output.
1802 (with-current-buffer (tramp-get-buffer v)
1803 (goto-char (point-max))
1804
91683089 1805 ;; Check result code, found in last line of output.
03c1ad43
MA
1806 (forward-line -1)
1807 (if (looking-at "^fail$")
1808 (progn
1809 ;; Grab error message from line before last line
91683089 1810 ;; (it was put there by `cd 2>&1').
03c1ad43
MA
1811 (forward-line -1)
1812 (tramp-error
1813 v 'file-error
4a93e698 1814 "tramp-sh-handle-file-name-all-completions: %s"
6e060cee 1815 (buffer-substring (point) (point-at-eol))))
03c1ad43
MA
1816 ;; For peace of mind, if buffer doesn't end in `fail'
1817 ;; then it should end in `ok'. If neither are in the
1818 ;; buffer something went seriously wrong on the remote
1819 ;; side.
1820 (unless (looking-at "^ok$")
1821 (tramp-error
1822 v 'file-error
1823 "\
4a93e698 1824tramp-sh-handle-file-name-all-completions: internal error accessing `%s': `%s'"
03c1ad43
MA
1825 (tramp-shell-quote-argument localname) (buffer-string))))
1826
1827 (while (zerop (forward-line -1))
6e060cee 1828 (push (buffer-substring (point) (point-at-eol)) result)))
03c1ad43
MA
1829
1830 ;; Because the remote op went through OK we know the
91683089
MA
1831 ;; directory we `cd'-ed to exists.
1832 (tramp-set-file-property v localname "file-exists-p" t)
03c1ad43
MA
1833
1834 ;; Because the remote op went through OK we know every
1835 ;; file listed by `ls' exists.
1836 (mapc (lambda (entry)
1837 (tramp-set-file-property
1838 v (concat localname entry) "file-exists-p" t))
1839 result)
1840
91683089 1841 ;; Store result in the cache.
03c1ad43
MA
1842 (tramp-set-file-property
1843 v (concat localname filename)
91683089 1844 "file-name-all-completions" result))))))))
03c1ad43 1845
03c1ad43
MA
1846;; cp, mv and ln
1847
4a93e698 1848(defun tramp-sh-handle-add-name-to-file
03c1ad43
MA
1849 (filename newname &optional ok-if-already-exists)
1850 "Like `add-name-to-file' for Tramp files."
1851 (unless (tramp-equal-remote filename newname)
1852 (with-parsed-tramp-file-name
1853 (if (tramp-tramp-file-p filename) filename newname) nil
1854 (tramp-error
1855 v 'file-error
1856 "add-name-to-file: %s"
1857 "only implemented for same method, same user, same host")))
1858 (with-parsed-tramp-file-name filename v1
1859 (with-parsed-tramp-file-name newname v2
1860 (let ((ln (when v1 (tramp-get-remote-ln v1))))
1861 (when (and (not ok-if-already-exists)
1862 (file-exists-p newname)
1863 (not (numberp ok-if-already-exists))
1864 (y-or-n-p
1865 (format
1866 "File %s already exists; make it a new name anyway? "
1867 newname)))
1868 (tramp-error
1869 v2 'file-error
1870 "add-name-to-file: file %s already exists" newname))
1871 (tramp-flush-file-property v2 (file-name-directory v2-localname))
1872 (tramp-flush-file-property v2 v2-localname)
1873 (tramp-barf-unless-okay
1874 v1
1875 (format "%s %s %s" ln (tramp-shell-quote-argument v1-localname)
1876 (tramp-shell-quote-argument v2-localname))
1877 "error with add-name-to-file, see buffer `%s' for details"
1878 (buffer-name))))))
1879
4a93e698 1880(defun tramp-sh-handle-copy-file
03c1ad43
MA
1881 (filename newname &optional ok-if-already-exists keep-date
1882 preserve-uid-gid preserve-selinux-context)
1883 "Like `copy-file' for Tramp files."
1884 (setq filename (expand-file-name filename))
1885 (setq newname (expand-file-name newname))
1886 (cond
1887 ;; At least one file a Tramp file?
1888 ((or (tramp-tramp-file-p filename)
1889 (tramp-tramp-file-p newname))
1890 (tramp-do-copy-or-rename-file
1891 'copy filename newname ok-if-already-exists keep-date
1892 preserve-uid-gid preserve-selinux-context))
1893 ;; Compat section.
1894 (preserve-selinux-context
1895 (tramp-run-real-handler
1896 'copy-file
1897 (list filename newname ok-if-already-exists keep-date
1898 preserve-uid-gid preserve-selinux-context)))
1899 (preserve-uid-gid
1900 (tramp-run-real-handler
1901 'copy-file
1902 (list filename newname ok-if-already-exists keep-date preserve-uid-gid)))
1903 (t
1904 (tramp-run-real-handler
1905 'copy-file (list filename newname ok-if-already-exists keep-date)))))
1906
4a93e698 1907(defun tramp-sh-handle-copy-directory
a3fcfa99 1908 (dirname newname &optional keep-date parents copy-contents)
03c1ad43
MA
1909 "Like `copy-directory' for Tramp files."
1910 (let ((t1 (tramp-tramp-file-p dirname))
1911 (t2 (tramp-tramp-file-p newname)))
1912 (with-parsed-tramp-file-name (if t1 dirname newname) nil
1913 (if (and (tramp-get-method-parameter method 'tramp-copy-recursive)
1914 ;; When DIRNAME and NEWNAME are remote, they must have
1915 ;; the same method.
1916 (or (null t1) (null t2)
1917 (string-equal
1918 (tramp-file-name-method (tramp-dissect-file-name dirname))
1919 (tramp-file-name-method (tramp-dissect-file-name newname)))))
1920 ;; scp or rsync DTRT.
1921 (progn
1922 (setq dirname (directory-file-name (expand-file-name dirname))
1923 newname (directory-file-name (expand-file-name newname)))
1924 (if (and (file-directory-p newname)
1925 (not (string-equal (file-name-nondirectory dirname)
1926 (file-name-nondirectory newname))))
1927 (setq newname
1928 (expand-file-name
1929 (file-name-nondirectory dirname) newname)))
1930 (if (not (file-directory-p (file-name-directory newname)))
1931 (make-directory (file-name-directory newname) parents))
1932 (tramp-do-copy-or-rename-file-out-of-band
1933 'copy dirname newname keep-date))
1934 ;; We must do it file-wise.
1935 (tramp-run-real-handler
1936 'copy-directory (list dirname newname keep-date parents)))
1937
1938 ;; When newname did exist, we have wrong cached values.
1939 (when t2
1940 (with-parsed-tramp-file-name newname nil
1941 (tramp-flush-file-property v (file-name-directory localname))
1942 (tramp-flush-file-property v localname))))))
1943
4a93e698 1944(defun tramp-sh-handle-rename-file
03c1ad43
MA
1945 (filename newname &optional ok-if-already-exists)
1946 "Like `rename-file' for Tramp files."
1947 ;; Check if both files are local -- invoke normal rename-file.
1948 ;; Otherwise, use Tramp from local system.
1949 (setq filename (expand-file-name filename))
1950 (setq newname (expand-file-name newname))
1951 ;; At least one file a Tramp file?
1952 (if (or (tramp-tramp-file-p filename)
1953 (tramp-tramp-file-p newname))
1954 (tramp-do-copy-or-rename-file
1955 'rename filename newname ok-if-already-exists t t)
1956 (tramp-run-real-handler
1957 'rename-file (list filename newname ok-if-already-exists))))
1958
1959(defun tramp-do-copy-or-rename-file
1960 (op filename newname &optional ok-if-already-exists keep-date
1961 preserve-uid-gid preserve-selinux-context)
1962 "Copy or rename a remote file.
1963OP must be `copy' or `rename' and indicates the operation to perform.
1964FILENAME specifies the file to copy or rename, NEWNAME is the name of
1965the new file (for copy) or the new name of the file (for rename).
1966OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
1967KEEP-DATE means to make sure that NEWNAME has the same timestamp
1968as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
1969the uid and gid if both files are on the same host.
1970PRESERVE-SELINUX-CONTEXT activates selinux commands.
1971
4a93e698
MA
1972This function is invoked by `tramp-sh-handle-copy-file' and
1973`tramp-sh-handle-rename-file'. It is an error if OP is neither
1974of `copy' and `rename'. FILENAME and NEWNAME must be absolute
1975file names."
03c1ad43
MA
1976 (unless (memq op '(copy rename))
1977 (error "Unknown operation `%s', must be `copy' or `rename'" op))
1978 (let ((t1 (tramp-tramp-file-p filename))
1979 (t2 (tramp-tramp-file-p newname))
1980 (context (and preserve-selinux-context
1981 (apply 'file-selinux-context (list filename))))
1982 pr tm)
1983
1984 (with-parsed-tramp-file-name (if t1 filename newname) nil
1985 (when (and (not ok-if-already-exists) (file-exists-p newname))
1986 (tramp-error
1987 v 'file-already-exists "File %s already exists" newname))
1988
7d520089 1989 (tramp-with-progress-reporter
03c1ad43
MA
1990 v 0 (format "%s %s to %s"
1991 (if (eq op 'copy) "Copying" "Renaming")
1992 filename newname)
1993
1994 (cond
1995 ;; Both are Tramp files.
1996 ((and t1 t2)
1997 (with-parsed-tramp-file-name filename v1
1998 (with-parsed-tramp-file-name newname v2
1999 (cond
2000 ;; Shortcut: if method, host, user are the same for
2001 ;; both files, we invoke `cp' or `mv' on the remote
2002 ;; host directly.
2003 ((tramp-equal-remote filename newname)
2004 (tramp-do-copy-or-rename-file-directly
2005 op filename newname
2006 ok-if-already-exists keep-date preserve-uid-gid))
2007
2008 ;; Try out-of-band operation.
2009 ((tramp-method-out-of-band-p
66feec8b 2010 v1 (nth 7 (file-attributes (file-truename filename))))
03c1ad43
MA
2011 (tramp-do-copy-or-rename-file-out-of-band
2012 op filename newname keep-date))
2013
2014 ;; No shortcut was possible. So we copy the file
2015 ;; first. If the operation was `rename', we go back
2016 ;; and delete the original file (if the copy was
2017 ;; successful). The approach is simple-minded: we
2018 ;; create a new buffer, insert the contents of the
2019 ;; source file into it, then write out the buffer to
2020 ;; the target file. The advantage is that it doesn't
2021 ;; matter which filename handlers are used for the
2022 ;; source and target file.
2023 (t
2024 (tramp-do-copy-or-rename-file-via-buffer
2025 op filename newname keep-date))))))
2026
2027 ;; One file is a Tramp file, the other one is local.
2028 ((or t1 t2)
2029 (cond
2030 ;; Fast track on local machine.
2031 ((tramp-local-host-p v)
2032 (tramp-do-copy-or-rename-file-directly
2033 op filename newname
2034 ok-if-already-exists keep-date preserve-uid-gid))
2035
2036 ;; If the Tramp file has an out-of-band method, the
2037 ;; corresponding copy-program can be invoked.
66feec8b
MA
2038 ((tramp-method-out-of-band-p
2039 v (nth 7 (file-attributes (file-truename filename))))
03c1ad43
MA
2040 (tramp-do-copy-or-rename-file-out-of-band
2041 op filename newname keep-date))
2042
2043 ;; Use the inline method via a Tramp buffer.
2044 (t (tramp-do-copy-or-rename-file-via-buffer
2045 op filename newname keep-date))))
2046
2047 (t
2048 ;; One of them must be a Tramp file.
2049 (error "Tramp implementation says this cannot happen")))
2050
2051 ;; Handle `preserve-selinux-context'.
2052 (when context (apply 'set-file-selinux-context (list newname context)))
2053
2054 ;; In case of `rename', we must flush the cache of the source file.
2055 (when (and t1 (eq op 'rename))
2056 (with-parsed-tramp-file-name filename v1
2057 (tramp-flush-file-property v1 (file-name-directory localname))
2058 (tramp-flush-file-property v1 localname)))
2059
2060 ;; When newname did exist, we have wrong cached values.
2061 (when t2
2062 (with-parsed-tramp-file-name newname v2
2063 (tramp-flush-file-property v2 (file-name-directory localname))
2064 (tramp-flush-file-property v2 localname)))))))
2065
2066(defun tramp-do-copy-or-rename-file-via-buffer (op filename newname keep-date)
2067 "Use an Emacs buffer to copy or rename a file.
2068First arg OP is either `copy' or `rename' and indicates the operation.
2069FILENAME is the source file, NEWNAME the target file.
2070KEEP-DATE is non-nil if NEWNAME should have the same timestamp as FILENAME."
2071 (with-temp-buffer
2072 ;; We must disable multibyte, because binary data shall not be
2073 ;; converted.
2074 (set-buffer-multibyte nil)
2075 (let ((coding-system-for-read 'binary)
2076 (jka-compr-inhibit t))
2077 (insert-file-contents-literally filename))
2078 ;; We don't want the target file to be compressed, so we let-bind
2079 ;; `jka-compr-inhibit' to t.
2080 (let ((coding-system-for-write 'binary)
2081 (jka-compr-inhibit t))
2082 (write-region (point-min) (point-max) newname)))
2083 ;; KEEP-DATE handling.
2084 (when keep-date (set-file-times newname (nth 5 (file-attributes filename))))
2085 ;; Set the mode.
2086 (set-file-modes newname (tramp-default-file-modes filename))
2087 ;; If the operation was `rename', delete the original file.
2088 (unless (eq op 'copy) (delete-file filename)))
2089
2090(defun tramp-do-copy-or-rename-file-directly
2091 (op filename newname ok-if-already-exists keep-date preserve-uid-gid)
2092 "Invokes `cp' or `mv' on the remote system.
2093OP must be one of `copy' or `rename', indicating `cp' or `mv',
2094respectively. FILENAME specifies the file to copy or rename,
2095NEWNAME is the name of the new file (for copy) or the new name of
2096the file (for rename). Both files must reside on the same host.
2097KEEP-DATE means to make sure that NEWNAME has the same timestamp
2098as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
2099the uid and gid from FILENAME."
2100 (let ((t1 (tramp-tramp-file-p filename))
2101 (t2 (tramp-tramp-file-p newname))
2102 (file-times (nth 5 (file-attributes filename)))
2103 (file-modes (tramp-default-file-modes filename)))
2104 (with-parsed-tramp-file-name (if t1 filename newname) nil
2105 (let* ((cmd (cond ((and (eq op 'copy) preserve-uid-gid) "cp -f -p")
2106 ((eq op 'copy) "cp -f")
2107 ((eq op 'rename) "mv -f")
2108 (t (tramp-error
2109 v 'file-error
2110 "Unknown operation `%s', must be `copy' or `rename'"
2111 op))))
2112 (localname1
2113 (if t1
2114 (tramp-file-name-handler 'file-remote-p filename 'localname)
2115 filename))
2116 (localname2
2117 (if t2
2118 (tramp-file-name-handler 'file-remote-p newname 'localname)
2119 newname))
2120 (prefix (file-remote-p (if t1 filename newname)))
2121 cmd-result)
2122
2123 (cond
2124 ;; Both files are on a remote host, with same user.
2125 ((and t1 t2)
2126 (setq cmd-result
2127 (tramp-send-command-and-check
2128 v (format "%s %s %s" cmd
2129 (tramp-shell-quote-argument localname1)
2130 (tramp-shell-quote-argument localname2))))
2131 (with-current-buffer (tramp-get-buffer v)
2132 (goto-char (point-min))
2133 (unless
2134 (or
2135 (and keep-date
2136 ;; Mask cp -f error.
2137 (re-search-forward
2138 tramp-operation-not-permitted-regexp nil t))
2139 cmd-result)
2140 (tramp-error-with-buffer
2141 nil v 'file-error
2142 "Copying directly failed, see buffer `%s' for details."
2143 (buffer-name)))))
2144
2145 ;; We are on the local host.
2146 ((or t1 t2)
2147 (cond
2148 ;; We can do it directly.
2149 ((let (file-name-handler-alist)
2150 (and (file-readable-p localname1)
2151 (file-writable-p (file-name-directory localname2))
2152 (or (file-directory-p localname2)
2153 (file-writable-p localname2))))
2154 (if (eq op 'copy)
2155 (tramp-compat-copy-file
2156 localname1 localname2 ok-if-already-exists
2157 keep-date preserve-uid-gid)
2158 (tramp-run-real-handler
2159 'rename-file (list localname1 localname2 ok-if-already-exists))))
2160
2161 ;; We can do it directly with `tramp-send-command'
2162 ((and (file-readable-p (concat prefix localname1))
2163 (file-writable-p
2164 (file-name-directory (concat prefix localname2)))
2165 (or (file-directory-p (concat prefix localname2))
2166 (file-writable-p (concat prefix localname2))))
2167 (tramp-do-copy-or-rename-file-directly
2168 op (concat prefix localname1) (concat prefix localname2)
2169 ok-if-already-exists keep-date t)
2170 ;; We must change the ownership to the local user.
2171 (tramp-set-file-uid-gid
2172 (concat prefix localname2)
2173 (tramp-get-local-uid 'integer)
2174 (tramp-get-local-gid 'integer)))
2175
2176 ;; We need a temporary file in between.
2177 (t
2178 ;; Create the temporary file.
2179 (let ((tmpfile (tramp-compat-make-temp-file localname1)))
2180 (unwind-protect
2181 (progn
2182 (cond
2183 (t1
2184 (tramp-barf-unless-okay
2185 v (format
2186 "%s %s %s" cmd
2187 (tramp-shell-quote-argument localname1)
2188 (tramp-shell-quote-argument tmpfile))
2189 "Copying directly failed, see buffer `%s' for details."
2190 (tramp-get-buffer v))
2191 ;; We must change the ownership as remote user.
2192 ;; Since this does not work reliable, we also
2193 ;; give read permissions.
2194 (set-file-modes
2195 (concat prefix tmpfile)
2196 (tramp-compat-octal-to-decimal "0777"))
2197 (tramp-set-file-uid-gid
2198 (concat prefix tmpfile)
2199 (tramp-get-local-uid 'integer)
2200 (tramp-get-local-gid 'integer)))
2201 (t2
2202 (if (eq op 'copy)
2203 (tramp-compat-copy-file
2204 localname1 tmpfile t
2205 keep-date preserve-uid-gid)
2206 (tramp-run-real-handler
2207 'rename-file
2208 (list localname1 tmpfile t)))
2209 ;; We must change the ownership as local user.
2210 ;; Since this does not work reliable, we also
2211 ;; give read permissions.
2212 (set-file-modes
2213 tmpfile (tramp-compat-octal-to-decimal "0777"))
2214 (tramp-set-file-uid-gid
2215 tmpfile
2216 (tramp-get-remote-uid v 'integer)
2217 (tramp-get-remote-gid v 'integer))))
2218
2219 ;; Move the temporary file to its destination.
2220 (cond
2221 (t2
2222 (tramp-barf-unless-okay
2223 v (format
2224 "cp -f -p %s %s"
2225 (tramp-shell-quote-argument tmpfile)
2226 (tramp-shell-quote-argument localname2))
2227 "Copying directly failed, see buffer `%s' for details."
2228 (tramp-get-buffer v)))
2229 (t1
2230 (tramp-run-real-handler
2231 'rename-file
2232 (list tmpfile localname2 ok-if-already-exists)))))
2233
2234 ;; Save exit.
7398933f 2235 (ignore-errors (delete-file tmpfile)))))))))
03c1ad43
MA
2236
2237 ;; Set the time and mode. Mask possible errors.
7398933f 2238 (ignore-errors
03c1ad43
MA
2239 (when keep-date
2240 (set-file-times newname file-times)
7398933f 2241 (set-file-modes newname file-modes))))))
03c1ad43
MA
2242
2243(defun tramp-do-copy-or-rename-file-out-of-band (op filename newname keep-date)
2244 "Invoke rcp program to copy.
2245The method used must be an out-of-band method."
66feec8b
MA
2246 (let* ((t1 (tramp-tramp-file-p filename))
2247 (t2 (tramp-tramp-file-p newname))
2248 (orig-vec (tramp-dissect-file-name (if t1 filename newname)))
2249 copy-program copy-args copy-env copy-keep-date port spec
2250 source target)
03c1ad43
MA
2251
2252 (with-parsed-tramp-file-name (if t1 filename newname) nil
2253 (if (and t1 t2)
2254
2c68ca0e 2255 ;; Both are Tramp files. We shall optimize it when the
03c1ad43
MA
2256 ;; methods for filename and newname are the same.
2257 (let* ((dir-flag (file-directory-p filename))
2258 (tmpfile (tramp-compat-make-temp-file localname dir-flag)))
2259 (if dir-flag
2260 (setq tmpfile
2261 (expand-file-name
2262 (file-name-nondirectory newname) tmpfile)))
2263 (unwind-protect
2264 (progn
2265 (tramp-do-copy-or-rename-file-out-of-band
2266 op filename tmpfile keep-date)
2267 (tramp-do-copy-or-rename-file-out-of-band
2268 'rename tmpfile newname keep-date))
2269 ;; Save exit.
7398933f
MA
2270 (ignore-errors
2271 (if dir-flag
2272 (tramp-compat-delete-directory
2273 (expand-file-name ".." tmpfile) 'recursive)
2274 (delete-file tmpfile)))))
03c1ad43 2275
66feec8b
MA
2276 ;; Set variables for computing the prompt for reading
2277 ;; password.
2278 (setq tramp-current-method (tramp-file-name-method v)
a5509865
MA
2279 tramp-current-user (or (tramp-file-name-user v)
2280 (tramp-get-connection-property
2281 v "login-as" nil))
2282 tramp-current-host (tramp-file-name-real-host v))
66feec8b 2283
03c1ad43
MA
2284 ;; Expand hops. Might be necessary for gateway methods.
2285 (setq v (car (tramp-compute-multi-hops v)))
2286 (aset v 3 localname)
2287
2288 ;; Check which ones of source and target are Tramp files.
2289 (setq source (if t1 (tramp-make-copy-program-file-name v) filename)
2290 target (funcall
2291 (if (and (file-directory-p filename)
2292 (string-equal
2293 (file-name-nondirectory filename)
2294 (file-name-nondirectory newname)))
2295 'file-name-directory
2296 'identity)
2297 (if t2 (tramp-make-copy-program-file-name v) newname)))
2298
ee545c35
MA
2299 ;; Check for host and port number. We cannot use
2300 ;; `tramp-file-name-port', because this returns also
2301 ;; `tramp-default-port', which might clash with settings in
2302 ;; "~/.ssh/config".
2303 (setq host (tramp-file-name-host v)
2304 port "")
2305 (when (string-match tramp-host-with-port-regexp host)
23c22e9a
MA
2306 (setq port (string-to-number (match-string 2 host))
2307 host (string-to-number (match-string 1 host))))
03c1ad43 2308
a5509865
MA
2309 ;; Check for user. There might be an interactive setting.
2310 (setq user (or (tramp-file-name-user v)
2311 (tramp-get-connection-property v "login-as" nil)))
2312
03c1ad43 2313 ;; Compose copy command.
a5509865
MA
2314 (setq host (or host "")
2315 user (or user "")
2316 port (or port "")
2317 spec (format-spec-make
03c1ad43
MA
2318 ?h host ?u user ?p port
2319 ?t (tramp-get-connection-property
2320 (tramp-get-connection-process v) "temp-file" "")
2321 ?k (if keep-date " " ""))
2322 copy-program (tramp-get-method-parameter
2323 method 'tramp-copy-program)
2324 copy-keep-date (tramp-get-method-parameter
2325 method 'tramp-copy-keep-date)
2326 copy-args
66feec8b
MA
2327 (delete
2328 ;; " " has either been a replacement of "%k" (when
ee545c35 2329 ;; keep-date argument is non-nil), or a replacement
66feec8b
MA
2330 ;; for the whole keep-date sublist.
2331 " "
2332 (dolist
2333 (x
2334 (tramp-get-method-parameter method 'tramp-copy-args)
2335 copy-args)
2336 (setq copy-args
2337 (append
2338 copy-args
2339 (let ((y (mapcar (lambda (z) (format-spec z spec)) x)))
ee545c35 2340 (if (member "" y) '(" ") y))))))
03c1ad43
MA
2341 copy-env
2342 (delq
2343 nil
2344 (mapcar
2345 (lambda (x)
2346 (setq x (mapcar (lambda (y) (format-spec y spec)) x))
2347 (unless (member "" x) (mapconcat 'identity x " ")))
2348 (tramp-get-method-parameter method 'tramp-copy-env))))
2349
2350 ;; Check for program.
f42efeb5
MA
2351 (unless (let ((default-directory
2352 (tramp-compat-temporary-file-directory)))
2353 (executable-find copy-program))
03c1ad43
MA
2354 (tramp-error
2355 v 'file-error "Cannot find copy program: %s" copy-program))
2356
66feec8b
MA
2357 (with-temp-buffer
2358 (unwind-protect
03c1ad43
MA
2359 ;; The default directory must be remote.
2360 (let ((default-directory
2361 (file-name-directory (if t1 filename newname)))
2362 (process-environment (copy-sequence process-environment)))
2363 ;; Set the transfer process properties.
2364 (tramp-set-connection-property
2365 v "process-name" (buffer-name (current-buffer)))
2366 (tramp-set-connection-property
2367 v "process-buffer" (current-buffer))
2368 (while copy-env
66feec8b
MA
2369 (tramp-message
2370 orig-vec 5 "%s=\"%s\"" (car copy-env) (cadr copy-env))
03c1ad43
MA
2371 (setenv (pop copy-env) (pop copy-env)))
2372
2373 ;; Use an asynchronous process. By this, password can
2374 ;; be handled. The default directory must be local, in
2375 ;; order to apply the correct `copy-program'. We don't
2376 ;; set a timeout, because the copying of large files can
2377 ;; last longer than 60 secs.
2378 (let ((p (let ((default-directory
2379 (tramp-compat-temporary-file-directory)))
2380 (apply 'start-process
66feec8b
MA
2381 (tramp-get-connection-name v)
2382 (tramp-get-connection-buffer v)
03c1ad43
MA
2383 copy-program
2384 (append copy-args (list source target))))))
2385 (tramp-message
66feec8b
MA
2386 orig-vec 6 "%s"
2387 (mapconcat 'identity (process-command p) " "))
bd8fadca 2388 (tramp-compat-set-process-query-on-exit-flag p nil)
bfd31217
MA
2389 (tramp-process-actions
2390 p v nil tramp-actions-copy-out-of-band)))
03c1ad43 2391
66feec8b 2392 ;; Reset the transfer process properties.
2fe4b125 2393 (tramp-message orig-vec 6 "\n%s" (buffer-string))
66feec8b
MA
2394 (tramp-set-connection-property v "process-name" nil)
2395 (tramp-set-connection-property v "process-buffer" nil)))
03c1ad43
MA
2396
2397 ;; Handle KEEP-DATE argument.
2398 (when (and keep-date (not copy-keep-date))
2399 (set-file-times newname (nth 5 (file-attributes filename))))
2400
2401 ;; Set the mode.
2402 (unless (and keep-date copy-keep-date)
2403 (ignore-errors
2404 (set-file-modes newname (tramp-default-file-modes filename)))))
2405
2406 ;; If the operation was `rename', delete the original file.
2407 (unless (eq op 'copy)
2408 (if (file-regular-p filename)
2409 (delete-file filename)
2410 (tramp-compat-delete-directory filename 'recursive))))))
2411
4a93e698 2412(defun tramp-sh-handle-make-directory (dir &optional parents)
03c1ad43
MA
2413 "Like `make-directory' for Tramp files."
2414 (setq dir (expand-file-name dir))
2415 (with-parsed-tramp-file-name dir nil
2416 (tramp-flush-directory-property v (file-name-directory localname))
2417 (save-excursion
2418 (tramp-barf-unless-okay
2419 v (format "%s %s"
2420 (if parents "mkdir -p" "mkdir")
2421 (tramp-shell-quote-argument localname))
2422 "Couldn't make directory %s" dir))))
2423
4a93e698 2424(defun tramp-sh-handle-delete-directory (directory &optional recursive)
03c1ad43
MA
2425 "Like `delete-directory' for Tramp files."
2426 (setq directory (expand-file-name directory))
2427 (with-parsed-tramp-file-name directory nil
2428 (tramp-flush-file-property v (file-name-directory localname))
2429 (tramp-flush-directory-property v localname)
2430 (tramp-barf-unless-okay
2431 v (format "%s %s"
2432 (if recursive "rm -rf" "rmdir")
2433 (tramp-shell-quote-argument localname))
2434 "Couldn't delete %s" directory)))
2435
4a93e698 2436(defun tramp-sh-handle-delete-file (filename &optional trash)
03c1ad43
MA
2437 "Like `delete-file' for Tramp files."
2438 (setq filename (expand-file-name filename))
2439 (with-parsed-tramp-file-name filename nil
2440 (tramp-flush-file-property v (file-name-directory localname))
2441 (tramp-flush-file-property v localname)
2442 (tramp-barf-unless-okay
2443 v (format "%s %s"
2444 (or (and trash (tramp-get-remote-trash v)) "rm -f")
2445 (tramp-shell-quote-argument localname))
2446 "Couldn't delete %s" filename)))
2447
2448;; Dired.
2449
2450;; CCC: This does not seem to be enough. Something dies when
2451;; we try and delete two directories under Tramp :/
4a93e698 2452(defun tramp-sh-handle-dired-recursive-delete-directory (filename)
03c1ad43
MA
2453 "Recursively delete the directory given.
2454This is like `dired-recursive-delete-directory' for Tramp files."
2455 (with-parsed-tramp-file-name filename nil
2fe4b125 2456 ;; Run a shell command 'rm -r <localname>'.
03c1ad43
MA
2457 ;; Code shamelessly stolen from the dired implementation and, um, hacked :)
2458 (unless (file-exists-p filename)
2459 (tramp-error v 'file-error "No such directory: %s" filename))
2fe4b125 2460 ;; Which is better, -r or -R? (-r works for me <daniel@danann.net>).
03c1ad43
MA
2461 (tramp-send-command
2462 v
2463 (format "rm -rf %s" (tramp-shell-quote-argument localname))
2c68ca0e 2464 ;; Don't read the output, do it explicitly.
03c1ad43
MA
2465 nil t)
2466 ;; Wait for the remote system to return to us...
2467 ;; This might take a while, allow it plenty of time.
2468 (tramp-wait-for-output (tramp-get-connection-process v) 120)
2469 ;; Make sure that it worked...
2470 (tramp-flush-file-property v (file-name-directory localname))
2471 (tramp-flush-directory-property v localname)
2472 (and (file-exists-p filename)
2473 (tramp-error
2474 v 'file-error "Failed to recursively delete %s" filename))))
2475
4a93e698 2476(defun tramp-sh-handle-dired-compress-file (file &rest ok-flag)
03c1ad43
MA
2477 "Like `dired-compress-file' for Tramp files."
2478 ;; OK-FLAG is valid for XEmacs only, but not implemented.
2479 ;; Code stolen mainly from dired-aux.el.
2480 (with-parsed-tramp-file-name file nil
2481 (tramp-flush-file-property v localname)
2482 (save-excursion
2483 (let ((suffixes
2484 (if (not (featurep 'xemacs))
2485 ;; Emacs case
2486 (symbol-value 'dired-compress-file-suffixes)
2487 ;; XEmacs has `dired-compression-method-alist', which is
2488 ;; transformed into `dired-compress-file-suffixes' structure.
2489 (mapcar
2490 (lambda (x)
2491 (list (concat (regexp-quote (nth 1 x)) "\\'")
2492 nil
2493 (mapconcat 'identity (nth 3 x) " ")))
2494 (symbol-value 'dired-compression-method-alist))))
2495 suffix)
2496 ;; See if any suffix rule matches this file name.
2497 (while suffixes
2498 (let (case-fold-search)
2499 (if (string-match (car (car suffixes)) localname)
2500 (setq suffix (car suffixes) suffixes nil))
2501 (setq suffixes (cdr suffixes))))
2502
2503 (cond ((file-symlink-p file)
2504 nil)
2505 ((and suffix (nth 2 suffix))
2506 ;; We found an uncompression rule.
7d520089
SM
2507 (tramp-with-progress-reporter
2508 v 0 (format "Uncompressing %s" file)
03c1ad43
MA
2509 (when (tramp-send-command-and-check
2510 v (concat (nth 2 suffix) " "
2511 (tramp-shell-quote-argument localname)))
2512 ;; `dired-remove-file' is not defined in XEmacs.
2513 (tramp-compat-funcall 'dired-remove-file file)
2514 (string-match (car suffix) file)
2515 (concat (substring file 0 (match-beginning 0))))))
2516 (t
2517 ;; We don't recognize the file as compressed, so compress it.
2518 ;; Try gzip.
7d520089 2519 (tramp-with-progress-reporter v 0 (format "Compressing %s" file)
03c1ad43
MA
2520 (when (tramp-send-command-and-check
2521 v (concat "gzip -f "
2522 (tramp-shell-quote-argument localname)))
2523 ;; `dired-remove-file' is not defined in XEmacs.
2524 (tramp-compat-funcall 'dired-remove-file file)
2525 (cond ((file-exists-p (concat file ".gz"))
2526 (concat file ".gz"))
2527 ((file-exists-p (concat file ".z"))
2528 (concat file ".z"))
2529 (t nil))))))))))
2530
4a93e698 2531(defun tramp-sh-handle-insert-directory
03c1ad43
MA
2532 (filename switches &optional wildcard full-directory-p)
2533 "Like `insert-directory' for Tramp files."
2534 (setq filename (expand-file-name filename))
2535 (with-parsed-tramp-file-name filename nil
2536 (if (and (featurep 'ls-lisp)
2537 (not (symbol-value 'ls-lisp-use-insert-directory-program)))
2538 (tramp-run-real-handler
2539 'insert-directory (list filename switches wildcard full-directory-p))
2540 (when (stringp switches)
2541 (setq switches (split-string switches)))
2542 (when (and (member "--dired" switches)
2543 (not (tramp-get-ls-command-with-dired v)))
2544 (setq switches (delete "--dired" switches)))
2545 (when wildcard
2546 (setq wildcard (tramp-run-real-handler
2547 'file-name-nondirectory (list localname)))
2548 (setq localname (tramp-run-real-handler
2549 'file-name-directory (list localname))))
2550 (unless full-directory-p
2551 (setq switches (add-to-list 'switches "-d" 'append)))
2552 (setq switches (mapconcat 'tramp-shell-quote-argument switches " "))
2553 (when wildcard
2554 (setq switches (concat switches " " wildcard)))
2555 (tramp-message
2556 v 4 "Inserting directory `ls %s %s', wildcard %s, fulldir %s"
2557 switches filename (if wildcard "yes" "no")
2558 (if full-directory-p "yes" "no"))
2559 ;; If `full-directory-p', we just say `ls -l FILENAME'.
2560 ;; Else we chdir to the parent directory, then say `ls -ld BASENAME'.
2561 (if full-directory-p
2562 (tramp-send-command
2563 v
2564 (format "%s %s %s 2>/dev/null"
2565 (tramp-get-ls-command v)
2566 switches
2567 (if wildcard
2568 localname
2569 (tramp-shell-quote-argument (concat localname ".")))))
2570 (tramp-barf-unless-okay
2571 v
2572 (format "cd %s" (tramp-shell-quote-argument
2573 (tramp-run-real-handler
2574 'file-name-directory (list localname))))
2575 "Couldn't `cd %s'"
2576 (tramp-shell-quote-argument
2577 (tramp-run-real-handler 'file-name-directory (list localname))))
2578 (tramp-send-command
2579 v
2580 (format "%s %s %s"
2581 (tramp-get-ls-command v)
2582 switches
2583 (if (or wildcard
2584 (zerop (length
2585 (tramp-run-real-handler
2586 'file-name-nondirectory (list localname)))))
2587 ""
2588 (tramp-shell-quote-argument
2589 (tramp-run-real-handler
2590 'file-name-nondirectory (list localname)))))))
2591 (let ((beg (point)))
2592 ;; We cannot use `insert-buffer-substring' because the Tramp
2593 ;; buffer changes its contents before insertion due to calling
2594 ;; `expand-file' and alike.
2595 (insert
2596 (with-current-buffer (tramp-get-buffer v)
2597 (buffer-string)))
2598
2599 ;; Check for "--dired" output.
2600 (forward-line -2)
2601 (when (looking-at "//SUBDIRED//")
2602 (forward-line -1))
2603 (when (looking-at "//DIRED//\\s-+")
2604 (let ((databeg (match-end 0))
6e060cee 2605 (end (point-at-eol)))
03c1ad43
MA
2606 ;; Now read the numeric positions of file names.
2607 (goto-char databeg)
2608 (while (< (point) end)
2609 (let ((start (+ beg (read (current-buffer))))
2610 (end (+ beg (read (current-buffer)))))
2611 (if (memq (char-after end) '(?\n ?\ ))
2612 ;; End is followed by \n or by " -> ".
2613 (put-text-property start end 'dired-filename t))))))
2614 ;; Remove trailing lines.
6e060cee 2615 (goto-char (point-at-bol))
03c1ad43
MA
2616 (while (looking-at "//")
2617 (forward-line 1)
2618 (delete-region (match-beginning 0) (point)))
2619
6d95bd46
MA
2620 ;; Some busyboxes are reluctant to discard colors.
2621 (unless (string-match "color" (tramp-get-connection-property v "ls" ""))
2622 (goto-char beg)
2623 (while (re-search-forward tramp-color-escape-sequence-regexp nil t)
2624 (replace-match "")))
2625
03c1ad43
MA
2626 ;; The inserted file could be from somewhere else.
2627 (when (and (not wildcard) (not full-directory-p))
2628 (goto-char (point-max))
2629 (when (file-symlink-p filename)
2630 (goto-char (search-backward "->" beg 'noerror)))
2631 (search-backward
2632 (if (zerop (length (file-name-nondirectory filename)))
2633 "."
2634 (file-name-nondirectory filename))
2635 beg 'noerror)
2636 (replace-match (file-relative-name filename) t))
2637
2638 (goto-char (point-max))))))
2639
03c1ad43
MA
2640;; Canonicalization of file names.
2641
4a93e698 2642(defun tramp-sh-handle-expand-file-name (name &optional dir)
03c1ad43
MA
2643 "Like `expand-file-name' for Tramp files.
2644If the localname part of the given filename starts with \"/../\" then
2645the result will be a local, non-Tramp, filename."
2646 ;; If DIR is not given, use DEFAULT-DIRECTORY or "/".
2647 (setq dir (or dir default-directory "/"))
2648 ;; Unless NAME is absolute, concat DIR and NAME.
2649 (unless (file-name-absolute-p name)
2650 (setq name (concat (file-name-as-directory dir) name)))
2651 ;; If NAME is not a Tramp file, run the real handler.
2652 (if (not (tramp-connectable-p name))
2653 (tramp-run-real-handler 'expand-file-name (list name nil))
2654 ;; Dissect NAME.
2655 (with-parsed-tramp-file-name name nil
2656 (unless (tramp-run-real-handler 'file-name-absolute-p (list localname))
2657 (setq localname (concat "~/" localname)))
2658 ;; Tilde expansion if necessary. This needs a shell which
2659 ;; groks tilde expansion! The function `tramp-find-shell' is
2660 ;; supposed to find such a shell on the remote host. Please
2661 ;; tell me about it when this doesn't work on your system.
2662 (when (string-match "\\`\\(~[^/]*\\)\\(.*\\)\\'" localname)
2663 (let ((uname (match-string 1 localname))
2664 (fname (match-string 2 localname)))
2665 ;; We cannot simply apply "~/", because under sudo "~/" is
2666 ;; expanded to the local user home directory but to the
2667 ;; root home directory. On the other hand, using always
2668 ;; the default user name for tilde expansion is not
2669 ;; appropriate either, because ssh and companions might
2670 ;; use a user name from the config file.
2671 (when (and (string-equal uname "~")
2672 (string-match "\\`su\\(do\\)?\\'" method))
2673 (setq uname (concat uname user)))
2674 (setq uname
2675 (with-connection-property v uname
2676 (tramp-send-command
2677 v (format "cd %s; pwd" (tramp-shell-quote-argument uname)))
2678 (with-current-buffer (tramp-get-buffer v)
2679 (goto-char (point-min))
6e060cee 2680 (buffer-substring (point) (point-at-eol)))))
03c1ad43
MA
2681 (setq localname (concat uname fname))))
2682 ;; There might be a double slash, for example when "~/"
2683 ;; expands to "/". Remove this.
2684 (while (string-match "//" localname)
2685 (setq localname (replace-match "/" t t localname)))
2686 ;; No tilde characters in file name, do normal
2687 ;; `expand-file-name' (this does "/./" and "/../"). We bind
2688 ;; `directory-sep-char' here for XEmacs on Windows, which would
2689 ;; otherwise use backslash. `default-directory' is bound,
2690 ;; because on Windows there would be problems with UNC shares or
2691 ;; Cygwin mounts.
2692 (let ((directory-sep-char ?/)
2693 (default-directory (tramp-compat-temporary-file-directory)))
2694 (tramp-make-tramp-file-name
2695 method user host
2696 (tramp-drop-volume-letter
2697 (tramp-run-real-handler
2fe4b125
MA
2698 'expand-file-name (list localname)))
2699 hop)))))
03c1ad43 2700
03c1ad43
MA
2701;;; Remote commands:
2702
4a93e698 2703(defun tramp-sh-handle-executable-find (command)
03c1ad43
MA
2704 "Like `executable-find' for Tramp files."
2705 (with-parsed-tramp-file-name default-directory nil
2706 (tramp-find-executable v command (tramp-get-remote-path v) t)))
2707
2708(defun tramp-process-sentinel (proc event)
2709 "Flush file caches."
2710 (unless (memq (process-status proc) '(run open))
2711 (let ((vec (tramp-get-connection-property proc "vector" nil)))
2712 (when vec
2713 (tramp-message vec 5 "Sentinel called: `%s' `%s'" proc event)
6d95bd46 2714 (tramp-flush-connection-property proc)
03c1ad43
MA
2715 (tramp-flush-directory-property vec "")))))
2716
2717;; We use BUFFER also as connection buffer during setup. Because of
2718;; this, its original contents must be saved, and restored once
2719;; connection has been setup.
4a93e698 2720(defun tramp-sh-handle-start-file-process (name buffer program &rest args)
03c1ad43
MA
2721 "Like `start-file-process' for Tramp files."
2722 (with-parsed-tramp-file-name default-directory nil
f49d1f52
SM
2723 ;; When PROGRAM is nil, we just provide a tty.
2724 (let ((command
2725 (when (stringp program)
afae1d68 2726 (format "cd %s; exec env PS1=%s %s"
f49d1f52 2727 (tramp-shell-quote-argument localname)
afae1d68
MA
2728 ;; Use a human-friendly prompt, for example for `shell'.
2729 (tramp-shell-quote-argument
2730 (format "%s %s"
2731 (file-remote-p default-directory)
2732 tramp-initial-end-of-output))
f49d1f52
SM
2733 (mapconcat 'tramp-shell-quote-argument
2734 (cons program args) " "))))
2735 (tramp-process-connection-type
2736 (or (null program) tramp-process-connection-type))
2737 (bmp (and (buffer-live-p buffer) (buffer-modified-p buffer)))
2738 (name1 name)
2739 (i 0))
2740 (unwind-protect
2741 (save-excursion
2742 (save-restriction
2743 (unless buffer
2744 ;; BUFFER can be nil. We use a temporary buffer.
2745 (setq buffer (generate-new-buffer tramp-temp-buffer-name)))
2746 (while (get-process name1)
2747 ;; NAME must be unique as process name.
2748 (setq i (1+ i)
2749 name1 (format "%s<%d>" name i)))
2750 (setq name name1)
2751 ;; Set the new process properties.
2752 (tramp-set-connection-property v "process-name" name)
2753 (tramp-set-connection-property v "process-buffer" buffer)
2754 ;; Activate narrowing in order to save BUFFER contents.
2755 ;; Clear also the modification time; otherwise we might
2756 ;; be interrupted by `verify-visited-file-modtime'.
2757 (with-current-buffer (tramp-get-connection-buffer v)
2758 (let ((buffer-undo-list t))
2759 (clear-visited-file-modtime)
2760 (narrow-to-region (point-max) (point-max))
2761 (if command
2762 ;; Send the command.
d68b0220
MA
2763 (tramp-send-command v command nil t) ; nooutput
2764 ;; Check, whether a pty is associated.
2765 (tramp-maybe-open-connection v)
2766 (unless (tramp-compat-process-get
2767 (tramp-get-connection-process v) 'remote-tty)
2768 (tramp-error
f49d1f52
SM
2769 v 'file-error
2770 "pty association is not supported for `%s'" name)))))
d68b0220 2771 (let ((p (tramp-get-connection-process v)))
6d95bd46 2772 ;; Set query flag for this process.
d68b0220
MA
2773 (tramp-compat-set-process-query-on-exit-flag p t)
2774 ;; Return process.
f49d1f52
SM
2775 p)))
2776 ;; Save exit.
2777 (with-current-buffer (tramp-get-connection-buffer v)
2778 (if (string-match tramp-temp-buffer-name (buffer-name))
2779 (progn
2780 (set-process-buffer (tramp-get-connection-process v) nil)
2781 (kill-buffer (current-buffer)))
2782 (set-buffer-modified-p bmp)))
2783 (tramp-set-connection-property v "process-name" nil)
2784 (tramp-set-connection-property v "process-buffer" nil)))))
03c1ad43 2785
4a93e698 2786(defun tramp-sh-handle-process-file
03c1ad43
MA
2787 (program &optional infile destination display &rest args)
2788 "Like `process-file' for Tramp files."
2789 ;; The implementation is not complete yet.
2790 (when (and (numberp destination) (zerop destination))
2791 (error "Implementation does not handle immediate return"))
2792
2793 (with-parsed-tramp-file-name default-directory nil
2794 (let (command input tmpinput stderr tmpstderr outbuf ret)
2795 ;; Compute command.
2796 (setq command (mapconcat 'tramp-shell-quote-argument
2797 (cons program args) " "))
2798 ;; Determine input.
2799 (if (null infile)
2800 (setq input "/dev/null")
2801 (setq infile (expand-file-name infile))
2802 (if (tramp-equal-remote default-directory infile)
2803 ;; INFILE is on the same remote host.
2804 (setq input (with-parsed-tramp-file-name infile nil localname))
2805 ;; INFILE must be copied to remote host.
2806 (setq input (tramp-make-tramp-temp-file v)
2807 tmpinput (tramp-make-tramp-file-name method user host input))
2808 (copy-file infile tmpinput t)))
2809 (when input (setq command (format "%s <%s" command input)))
2810
2811 ;; Determine output.
2812 (cond
2813 ;; Just a buffer.
2814 ((bufferp destination)
2815 (setq outbuf destination))
2816 ;; A buffer name.
2817 ((stringp destination)
2818 (setq outbuf (get-buffer-create destination)))
2819 ;; (REAL-DESTINATION ERROR-DESTINATION)
2820 ((consp destination)
2821 ;; output.
2822 (cond
2823 ((bufferp (car destination))
2824 (setq outbuf (car destination)))
2825 ((stringp (car destination))
2826 (setq outbuf (get-buffer-create (car destination))))
2827 ((car destination)
2828 (setq outbuf (current-buffer))))
2829 ;; stderr.
2830 (cond
2831 ((stringp (cadr destination))
2832 (setcar (cdr destination) (expand-file-name (cadr destination)))
2833 (if (tramp-equal-remote default-directory (cadr destination))
2834 ;; stderr is on the same remote host.
2835 (setq stderr (with-parsed-tramp-file-name
2836 (cadr destination) nil localname))
2837 ;; stderr must be copied to remote host. The temporary
2838 ;; file must be deleted after execution.
2839 (setq stderr (tramp-make-tramp-temp-file v)
2840 tmpstderr (tramp-make-tramp-file-name
2841 method user host stderr))))
2842 ;; stderr to be discarded.
2843 ((null (cadr destination))
2844 (setq stderr "/dev/null"))))
2845 ;; 't
2846 (destination
2847 (setq outbuf (current-buffer))))
2848 (when stderr (setq command (format "%s 2>%s" command stderr)))
2849
2850 ;; Send the command. It might not return in time, so we protect
2851 ;; it. Call it in a subshell, in order to preserve working
2852 ;; directory.
2853 (condition-case nil
2854 (unwind-protect
2855 (setq ret
2856 (if (tramp-send-command-and-check
2857 v (format "\\cd %s; %s"
2858 (tramp-shell-quote-argument localname)
2859 command)
2860 t t)
2861 0 1))
2862 ;; We should show the output anyway.
2863 (when outbuf
2864 (with-current-buffer outbuf
2865 (insert
2866 (with-current-buffer (tramp-get-connection-buffer v)
2867 (buffer-string))))
2868 (when display (display-buffer outbuf))))
2869 ;; When the user did interrupt, we should do it also. We use
2870 ;; return code -1 as marker.
2871 (quit
2872 (kill-buffer (tramp-get-connection-buffer v))
2873 (setq ret -1))
2874 ;; Handle errors.
2875 (error
2876 (kill-buffer (tramp-get-connection-buffer v))
2877 (setq ret 1)))
2878
2879 ;; Provide error file.
2880 (when tmpstderr (rename-file tmpstderr (cadr destination) t))
2881
2882 ;; Cleanup. We remove all file cache values for the connection,
2883 ;; because the remote process could have changed them.
2884 (when tmpinput (delete-file tmpinput))
2885
2886 ;; `process-file-side-effects' has been introduced with GNU
2887 ;; Emacs 23.2. If set to `nil', no remote file will be changed
2888 ;; by `program'. If it doesn't exist, we assume its default
f5e29b9b 2889 ;; value `t'.
03c1ad43
MA
2890 (unless (and (boundp 'process-file-side-effects)
2891 (not (symbol-value 'process-file-side-effects)))
2892 (tramp-flush-directory-property v ""))
2893
2894 ;; Return exit status.
2895 (if (equal ret -1)
2896 (keyboard-quit)
2897 ret))))
2898
4a93e698 2899(defun tramp-sh-handle-call-process-region
03c1ad43
MA
2900 (start end program &optional delete buffer display &rest args)
2901 "Like `call-process-region' for Tramp files."
2902 (let ((tmpfile (tramp-compat-make-temp-file "")))
2903 (write-region start end tmpfile)
2904 (when delete (delete-region start end))
2905 (unwind-protect
2906 (apply 'call-process program tmpfile buffer display args)
2907 (delete-file tmpfile))))
2908
4a93e698 2909(defun tramp-sh-handle-file-local-copy (filename)
03c1ad43 2910 "Like `file-local-copy' for Tramp files."
03c1ad43
MA
2911 (with-parsed-tramp-file-name filename nil
2912 (unless (file-exists-p filename)
2913 (tramp-error
2914 v 'file-error
2915 "Cannot make local copy of non-existing file `%s'" filename))
2916
66feec8b 2917 (let* ((size (nth 7 (file-attributes (file-truename filename))))
03c1ad43
MA
2918 (rem-enc (tramp-get-inline-coding v "remote-encoding" size))
2919 (loc-dec (tramp-get-inline-coding v "local-decoding" size))
2920 (tmpfile (tramp-compat-make-temp-file filename)))
2921
2922 (condition-case err
2923 (cond
2924 ;; `copy-file' handles direct copy and out-of-band methods.
2925 ((or (tramp-local-host-p v)
2926 (tramp-method-out-of-band-p v size))
2927 (copy-file filename tmpfile t t))
2928
2929 ;; Use inline encoding for file transfer.
2930 (rem-enc
2931 (save-excursion
7d520089 2932 (tramp-with-progress-reporter
03c1ad43
MA
2933 v 3 (format "Encoding remote file %s" filename)
2934 (tramp-barf-unless-okay
2935 v (format rem-enc (tramp-shell-quote-argument localname))
2936 "Encoding remote file failed"))
2937
2938 (if (functionp loc-dec)
2939 ;; If local decoding is a function, we call it. We
2940 ;; must disable multibyte, because
2941 ;; `uudecode-decode-region' doesn't handle it
2942 ;; correctly.
2943 (with-temp-buffer
2944 (set-buffer-multibyte nil)
2945 (insert-buffer-substring (tramp-get-buffer v))
7d520089 2946 (tramp-with-progress-reporter
03c1ad43
MA
2947 v 3 (format "Decoding remote file %s with function %s"
2948 filename loc-dec)
2949 (funcall loc-dec (point-min) (point-max))
2950 ;; Unset `file-name-handler-alist'. Otherwise,
2951 ;; epa-file gets confused.
2952 (let (file-name-handler-alist
2953 (coding-system-for-write 'binary))
2954 (write-region (point-min) (point-max) tmpfile))))
2955
2956 ;; If tramp-decoding-function is not defined for this
2957 ;; method, we invoke tramp-decoding-command instead.
2958 (let ((tmpfile2 (tramp-compat-make-temp-file filename)))
2959 ;; Unset `file-name-handler-alist'. Otherwise,
2960 ;; epa-file gets confused.
2961 (let (file-name-handler-alist
2962 (coding-system-for-write 'binary))
2963 (write-region (point-min) (point-max) tmpfile2))
7d520089 2964 (tramp-with-progress-reporter
03c1ad43
MA
2965 v 3 (format "Decoding remote file %s with command %s"
2966 filename loc-dec)
2967 (unwind-protect
2968 (tramp-call-local-coding-command
2969 loc-dec tmpfile2 tmpfile)
2970 (delete-file tmpfile2)))))
2971
2972 ;; Set proper permissions.
2973 (set-file-modes tmpfile (tramp-default-file-modes filename))
2974 ;; Set local user ownership.
2975 (tramp-set-file-uid-gid tmpfile)))
2976
2977 ;; Oops, I don't know what to do.
2978 (t (tramp-error
2979 v 'file-error "Wrong method specification for `%s'" method)))
2980
2981 ;; Error handling.
2982 ((error quit)
2983 (delete-file tmpfile)
2984 (signal (car err) (cdr err))))
2985
2986 (run-hooks 'tramp-handle-file-local-copy-hook)
2987 tmpfile)))
2988
03c1ad43 2989;; This is needed for XEmacs only. Code stolen from files.el.
4a93e698 2990(defun tramp-sh-handle-insert-file-contents-literally
03c1ad43
MA
2991 (filename &optional visit beg end replace)
2992 "Like `insert-file-contents-literally' for Tramp files."
2993 (let ((format-alist nil)
2994 (after-insert-file-functions nil)
2995 (coding-system-for-read 'no-conversion)
2996 (coding-system-for-write 'no-conversion)
2997 (find-buffer-file-type-function
2998 (if (fboundp 'find-buffer-file-type)
2999 (symbol-function 'find-buffer-file-type)
3000 nil))
3001 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
3002 (inhibit-file-name-operation 'insert-file-contents))
3003 (unwind-protect
3004 (progn
3005 (fset 'find-buffer-file-type (lambda (filename) t))
3006 (insert-file-contents filename visit beg end replace))
3007 ;; Save exit.
3008 (if find-buffer-file-type-function
3009 (fset 'find-buffer-file-type find-buffer-file-type-function)
3010 (fmakunbound 'find-buffer-file-type)))))
3011
4a93e698 3012(defun tramp-sh-handle-make-auto-save-file-name ()
03c1ad43
MA
3013 "Like `make-auto-save-file-name' for Tramp files.
3014Returns a file name in `tramp-auto-save-directory' for autosaving this file."
3015 (let ((tramp-auto-save-directory tramp-auto-save-directory)
3016 (buffer-file-name
3017 (tramp-subst-strs-in-string
3018 '(("_" . "|")
3019 ("/" . "_a")
3020 (":" . "_b")
3021 ("|" . "__")
3022 ("[" . "_l")
3023 ("]" . "_r"))
3024 (buffer-file-name))))
3025 ;; File name must be unique. This is ensured with Emacs 22 (see
3026 ;; UNIQUIFY element of `auto-save-file-name-transforms'); but for
3027 ;; all other cases we must do it ourselves.
3028 (when (boundp 'auto-save-file-name-transforms)
3029 (mapc
3030 (lambda (x)
3031 (when (and (string-match (car x) buffer-file-name)
3032 (not (car (cddr x))))
3033 (setq tramp-auto-save-directory
3034 (or tramp-auto-save-directory
3035 (tramp-compat-temporary-file-directory)))))
3036 (symbol-value 'auto-save-file-name-transforms)))
3037 ;; Create directory.
3038 (when tramp-auto-save-directory
3039 (setq buffer-file-name
3040 (expand-file-name buffer-file-name tramp-auto-save-directory))
3041 (unless (file-exists-p tramp-auto-save-directory)
3042 (make-directory tramp-auto-save-directory t)))
3043 ;; Run plain `make-auto-save-file-name'. There might be an advice when
3044 ;; it is not a magic file name operation (since Emacs 22).
3045 ;; We must deactivate it temporarily.
3046 (if (not (ad-is-active 'make-auto-save-file-name))
3047 (tramp-run-real-handler 'make-auto-save-file-name nil)
3048 ;; else
3049 (ad-deactivate 'make-auto-save-file-name)
3050 (prog1
3051 (tramp-run-real-handler 'make-auto-save-file-name nil)
3052 (ad-activate 'make-auto-save-file-name)))))
3053
03c1ad43 3054;; CCC grok LOCKNAME
4a93e698 3055(defun tramp-sh-handle-write-region
03c1ad43
MA
3056 (start end filename &optional append visit lockname confirm)
3057 "Like `write-region' for Tramp files."
3058 (setq filename (expand-file-name filename))
3059 (with-parsed-tramp-file-name filename nil
3060 ;; Following part commented out because we don't know what to do about
3061 ;; file locking, and it does not appear to be a problem to ignore it.
3062 ;; Ange-ftp ignores it, too.
3063 ;; (when (and lockname (stringp lockname))
3064 ;; (setq lockname (expand-file-name lockname)))
3065 ;; (unless (or (eq lockname nil)
3066 ;; (string= lockname filename))
3067 ;; (error
4a93e698 3068 ;; "tramp-sh-handle-write-region: LOCKNAME must be nil or equal FILENAME"))
03c1ad43
MA
3069
3070 ;; XEmacs takes a coding system as the seventh argument, not `confirm'.
3071 (when (and (not (featurep 'xemacs)) confirm (file-exists-p filename))
3072 (unless (y-or-n-p (format "File %s exists; overwrite anyway? " filename))
3073 (tramp-error v 'file-error "File not overwritten")))
3074
3075 (let ((uid (or (nth 2 (tramp-compat-file-attributes filename 'integer))
3076 (tramp-get-remote-uid v 'integer)))
3077 (gid (or (nth 3 (tramp-compat-file-attributes filename 'integer))
3078 (tramp-get-remote-gid v 'integer))))
3079
3080 (if (and (tramp-local-host-p v)
3081 ;; `file-writable-p' calls `file-expand-file-name'. We
3082 ;; cannot use `tramp-run-real-handler' therefore.
3083 (let (file-name-handler-alist)
3084 (and
3085 (file-writable-p (file-name-directory localname))
3086 (or (file-directory-p localname)
3087 (file-writable-p localname)))))
3088 ;; Short track: if we are on the local host, we can run directly.
3089 (tramp-run-real-handler
3090 'write-region
3091 (list start end localname append 'no-message lockname confirm))
3092
0372ee92
MA
3093 (let* ((modes (save-excursion (tramp-default-file-modes filename)))
3094 ;; We use this to save the value of
3095 ;; `last-coding-system-used' after writing the tmp
3096 ;; file. At the end of the function, we set
3097 ;; `last-coding-system-used' to this saved value. This
3098 ;; way, any intermediary coding systems used while
3099 ;; talking to the remote shell or suchlike won't hose
3100 ;; this variable. This approach was snarfed from
3101 ;; ange-ftp.el.
3102 coding-system-used
3103 ;; Write region into a tmp file. This isn't really
3104 ;; needed if we use an encoding function, but currently
3105 ;; we use it always because this makes the logic
3106 ;; simpler. We must also set `temporary-file-directory',
3107 ;; because it could point to a remote directory.
3108 (temporary-file-directory
3109 (tramp-compat-temporary-file-directory))
3110 (tmpfile (or tramp-temp-buffer-file-name
3111 (tramp-compat-make-temp-file filename))))
03c1ad43
MA
3112
3113 ;; If `append' is non-nil, we copy the file locally, and let
3114 ;; the native `write-region' implementation do the job.
3115 (when append (copy-file filename tmpfile 'ok))
3116
3117 ;; We say `no-message' here because we don't want the
3118 ;; visited file modtime data to be clobbered from the temp
3119 ;; file. We call `set-visited-file-modtime' ourselves later
3120 ;; on. We must ensure that `file-coding-system-alist'
3121 ;; matches `tmpfile'.
3122 (let (file-name-handler-alist
3123 (file-coding-system-alist
3124 (tramp-find-file-name-coding-system-alist filename tmpfile)))
3125 (condition-case err
3126 (tramp-run-real-handler
3127 'write-region
3128 (list start end tmpfile append 'no-message lockname confirm))
3129 ((error quit)
3130 (setq tramp-temp-buffer-file-name nil)
3131 (delete-file tmpfile)
3132 (signal (car err) (cdr err))))
3133
3134 ;; Now, `last-coding-system-used' has the right value. Remember it.
3135 (when (boundp 'last-coding-system-used)
3136 (setq coding-system-used
3137 (symbol-value 'last-coding-system-used))))
3138
3139 ;; The permissions of the temporary file should be set. If
3140 ;; filename does not exist (eq modes nil) it has been
3141 ;; renamed to the backup file. This case `save-buffer'
3142 ;; handles permissions.
2c68ca0e 3143 ;; Ensure that it is still readable.
03c1ad43
MA
3144 (when modes
3145 (set-file-modes
3146 tmpfile
3147 (logior (or modes 0) (tramp-compat-octal-to-decimal "0400"))))
3148
3149 ;; This is a bit lengthy due to the different methods
3150 ;; possible for file transfer. First, we check whether the
3151 ;; method uses an rcp program. If so, we call it.
3152 ;; Otherwise, both encoding and decoding command must be
3153 ;; specified. However, if the method _also_ specifies an
3154 ;; encoding function, then that is used for encoding the
3155 ;; contents of the tmp file.
3156 (let* ((size (nth 7 (file-attributes tmpfile)))
3157 (rem-dec (tramp-get-inline-coding v "remote-decoding" size))
3158 (loc-enc (tramp-get-inline-coding v "local-encoding" size)))
3159 (cond
3160 ;; `copy-file' handles direct copy and out-of-band methods.
3161 ((or (tramp-local-host-p v)
3162 (tramp-method-out-of-band-p v size))
3163 (if (and (not (stringp start))
3164 (= (or end (point-max)) (point-max))
3165 (= (or start (point-min)) (point-min))
3166 (tramp-get-method-parameter
3167 method 'tramp-copy-keep-tmpfile))
3168 (progn
3169 (setq tramp-temp-buffer-file-name tmpfile)
3170 (condition-case err
3171 ;; We keep the local file for performance
3172 ;; reasons, useful for "rsync".
3173 (copy-file tmpfile filename t)
3174 ((error quit)
3175 (setq tramp-temp-buffer-file-name nil)
3176 (delete-file tmpfile)
3177 (signal (car err) (cdr err)))))
3178 (setq tramp-temp-buffer-file-name nil)
3179 ;; Don't rename, in order to keep context in SELinux.
3180 (unwind-protect
3181 (copy-file tmpfile filename t)
3182 (delete-file tmpfile))))
3183
3184 ;; Use inline file transfer.
3185 (rem-dec
3186 ;; Encode tmpfile.
3187 (unwind-protect
3188 (with-temp-buffer
3189 (set-buffer-multibyte nil)
3190 ;; Use encoding function or command.
3191 (if (functionp loc-enc)
7d520089 3192 (tramp-with-progress-reporter
03c1ad43
MA
3193 v 3 (format "Encoding region using function `%s'"
3194 loc-enc)
3195 (let ((coding-system-for-read 'binary))
3196 (insert-file-contents-literally tmpfile))
3197 ;; The following `let' is a workaround for the
3198 ;; base64.el that comes with pgnus-0.84. If
3199 ;; both of the following conditions are
3200 ;; satisfied, it tries to write to a local
3201 ;; file in default-directory, but at this
3202 ;; point, default-directory is remote.
3203 ;; (`call-process-region' can't write to
3204 ;; remote files, it seems.) The file in
3205 ;; question is a tmp file anyway.
3206 (let ((default-directory
3207 (tramp-compat-temporary-file-directory)))
3208 (funcall loc-enc (point-min) (point-max))))
3209
7d520089 3210 (tramp-with-progress-reporter
03c1ad43
MA
3211 v 3 (format "Encoding region using command `%s'"
3212 loc-enc)
3213 (unless (zerop (tramp-call-local-coding-command
3214 loc-enc tmpfile t))
3215 (tramp-error
3216 v 'file-error
3217 (concat "Cannot write to `%s', "
3218 "local encoding command `%s' failed")
3219 filename loc-enc))))
3220
3221 ;; Send buffer into remote decoding command which
3222 ;; writes to remote file. Because this happens on
3223 ;; the remote host, we cannot use the function.
7d520089 3224 (tramp-with-progress-reporter
03c1ad43
MA
3225 v 3
3226 (format "Decoding region into remote file %s" filename)
3227 (goto-char (point-max))
3228 (unless (bolp) (newline))
3229 (tramp-send-command
3230 v
3231 (format
3232 (concat rem-dec " <<'EOF'\n%sEOF")
3233 (tramp-shell-quote-argument localname)
3234 (buffer-string)))
3235 (tramp-barf-unless-okay
3236 v nil
3237 "Couldn't write region to `%s', decode using `%s' failed"
3238 filename rem-dec)
3239 ;; When `file-precious-flag' is set, the region is
3240 ;; written to a temporary file. Check that the
3241 ;; checksum is equal to that from the local tmpfile.
3242 (when file-precious-flag
3243 (erase-buffer)
3244 (and
3245 ;; cksum runs locally, if possible.
3246 (zerop (tramp-compat-call-process "cksum" tmpfile t))
3247 ;; cksum runs remotely.
3248 (tramp-send-command-and-check
3249 v
3250 (format
3251 "cksum <%s" (tramp-shell-quote-argument localname)))
3252 ;; ... they are different.
3253 (not
3254 (string-equal
3255 (buffer-string)
3256 (with-current-buffer (tramp-get-buffer v)
3257 (buffer-string))))
3258 (tramp-error
3259 v 'file-error
3260 (concat "Couldn't write region to `%s',"
3261 " decode using `%s' failed")
3262 filename rem-dec)))))
3263
3264 ;; Save exit.
3265 (delete-file tmpfile)))
3266
3267 ;; That's not expected.
3268 (t
3269 (tramp-error
3270 v 'file-error
3271 (concat "Method `%s' should specify both encoding and "
3272 "decoding command or an rcp program")
3273 method))))
3274
3275 ;; Make `last-coding-system-used' have the right value.
3276 (when coding-system-used
3277 (set 'last-coding-system-used coding-system-used))))
3278
3279 (tramp-flush-file-property v (file-name-directory localname))
3280 (tramp-flush-file-property v localname)
3281
3282 ;; We must protect `last-coding-system-used', now we have set it
3283 ;; to its correct value.
3284 (let (last-coding-system-used (need-chown t))
3285 ;; Set file modification time.
3286 (when (or (eq visit t) (stringp visit))
3287 (let ((file-attr (file-attributes filename)))
3288 (set-visited-file-modtime
2c68ca0e 3289 ;; We must pass modtime explicitly, because filename can
03c1ad43
MA
3290 ;; be different from (buffer-file-name), f.e. if
3291 ;; `file-precious-flag' is set.
3292 (nth 5 file-attr))
3293 (when (and (eq (nth 2 file-attr) uid)
3294 (eq (nth 3 file-attr) gid))
3295 (setq need-chown nil))))
3296
3297 ;; Set the ownership.
3298 (when need-chown
3299 (tramp-set-file-uid-gid filename uid gid))
3300 (when (or (eq visit t) (null visit) (stringp visit))
3301 (tramp-message v 0 "Wrote %s" filename))
3302 (run-hooks 'tramp-handle-write-region-hook)))))
3303
3304(defvar tramp-vc-registered-file-names nil
3305 "List used to collect file names, which are checked during `vc-registered'.")
3306
3307;; VC backends check for the existence of various different special
3308;; files. This is very time consuming, because every single check
3309;; requires a remote command (the file cache must be invalidated).
3310;; Therefore, we apply a kind of optimization. We install the file
3311;; name handler `tramp-vc-file-name-handler', which does nothing but
3312;; remembers all file names for which `file-exists-p' or
3313;; `file-readable-p' has been applied. A first run of `vc-registered'
3314;; is performed. Afterwards, a script is applied for all collected
3315;; file names, using just one remote command. The result of this
3316;; script is used to fill the file cache with actual values. Now we
3317;; can reset the file name handlers, and we make a second run of
3318;; `vc-registered', which returns the expected result without sending
3319;; any other remote command.
4a93e698 3320(defun tramp-sh-handle-vc-registered (file)
03c1ad43 3321 "Like `vc-registered' for Tramp files."
6139f995 3322 (tramp-compat-with-temp-message ""
03c1ad43 3323 (with-parsed-tramp-file-name file nil
7d520089 3324 (tramp-with-progress-reporter
03c1ad43
MA
3325 v 3 (format "Checking `vc-registered' for %s" file)
3326
3327 ;; There could be new files, created by the vc backend. We
3328 ;; cannot reuse the old cache entries, therefore.
3329 (let (tramp-vc-registered-file-names
4bc3c53d 3330 (remote-file-name-inhibit-cache (current-time))
03c1ad43
MA
3331 (file-name-handler-alist
3332 `((,tramp-file-name-regexp . tramp-vc-file-name-handler))))
3333
3334 ;; Here we collect only file names, which need an operation.
3335 (tramp-run-real-handler 'vc-registered (list file))
3336 (tramp-message v 10 "\n%s" tramp-vc-registered-file-names)
3337
3338 ;; Send just one command, in order to fill the cache.
3339 (when tramp-vc-registered-file-names
3340 (tramp-maybe-send-script
3341 v
3342 (format tramp-vc-registered-read-file-names
3343 (tramp-get-file-exists-command v)
3344 (format "%s -r" (tramp-get-test-command v)))
3345 "tramp_vc_registered_read_file_names")
3346
3347 (dolist
3348 (elt
3349 (tramp-send-command-and-read
3350 v
3351 (format
3352 "tramp_vc_registered_read_file_names <<'EOF'\n%s\nEOF\n"
3353 (mapconcat 'tramp-shell-quote-argument
3354 tramp-vc-registered-file-names
3355 "\n"))))
3356
3357 (tramp-set-file-property
3358 v (car elt) (cadr elt) (cadr (cdr elt))))))
3359
3360 ;; Second run. Now all `file-exists-p' or `file-readable-p'
3361 ;; calls shall be answered from the file cache. We unset
3362 ;; `process-file-side-effects' in order to keep the cache when
3363 ;; `process-file' calls appear.
3364 (let (process-file-side-effects)
3365 (tramp-run-real-handler 'vc-registered (list file)))))))
3366
3367;;;###tramp-autoload
3368(defun tramp-sh-file-name-handler (operation &rest args)
3369 "Invoke remote-shell Tramp file name handler.
3370Fall back to normal file name handler if no Tramp handler exists."
3371 (when (and tramp-locked (not tramp-locker))
3372 (setq tramp-locked nil)
3373 (signal 'file-error (list "Forbidden reentrant call of Tramp")))
3374 (let ((tl tramp-locked))
3375 (unwind-protect
3376 (progn
3377 (setq tramp-locked t)
3378 (let ((tramp-locker t))
3379 (save-match-data
3380 (let ((fn (assoc operation tramp-sh-file-name-handler-alist)))
3381 (if fn
3382 (apply (cdr fn) args)
3383 (tramp-run-real-handler operation args))))))
3384 (setq tramp-locked tl))))
3385
3386(defun tramp-vc-file-name-handler (operation &rest args)
3387 "Invoke special file name handler, which collects files to be handled."
3388 (save-match-data
3389 (let ((filename
3390 (tramp-replace-environment-variables
3391 (apply 'tramp-file-name-for-operation operation args)))
3392 (fn (assoc operation tramp-sh-file-name-handler-alist)))
3393 (with-parsed-tramp-file-name filename nil
3394 (cond
3395 ;; That's what we want: file names, for which checks are
2c68ca0e 3396 ;; applied. We assume that VC uses only `file-exists-p' and
03c1ad43
MA
3397 ;; `file-readable-p' checks; otherwise we must extend the
3398 ;; list. We do not perform any action, but return nil, in
3399 ;; order to keep `vc-registered' running.
3400 ((and fn (memq operation '(file-exists-p file-readable-p)))
3401 (add-to-list 'tramp-vc-registered-file-names localname 'append)
3402 nil)
3403 ;; Tramp file name handlers like `expand-file-name'. They
3404 ;; must still work.
3405 (fn
3406 (save-match-data (apply (cdr fn) args)))
3407 ;; Default file name handlers, we don't care.
3408 (t (tramp-run-real-handler operation args)))))))
3409
3410;;; Internal Functions:
3411
3412(defun tramp-maybe-send-script (vec script name)
3413 "Define in remote shell function NAME implemented as SCRIPT.
3414Only send the definition if it has not already been done."
8a7eddd7
MA
3415 ;; We cannot let-bind (tramp-get-connection-process vec) because it
3416 ;; might be nil.
3417 (let ((scripts (tramp-get-connection-property
3418 (tramp-get-connection-process vec) "scripts" nil)))
03c1ad43 3419 (unless (member name scripts)
7d520089 3420 (tramp-with-progress-reporter vec 5 (format "Sending script `%s'" name)
03c1ad43
MA
3421 ;; The script could contain a call of Perl. This is masked with `%s'.
3422 (tramp-barf-unless-okay
3423 vec
3424 (format "%s () {\n%s\n}" name
3425 (format script (tramp-get-remote-perl vec)))
3426 "Script %s sending failed" name)
8a7eddd7
MA
3427 (tramp-set-connection-property
3428 (tramp-get-connection-process vec) "scripts" (cons name scripts))))))
03c1ad43
MA
3429
3430(defun tramp-set-auto-save ()
3431 (when (and ;; ange-ftp has its own auto-save mechanism
3432 (eq (tramp-find-foreign-file-name-handler (buffer-file-name))
3433 'tramp-sh-file-name-handler)
3434 auto-save-default)
3435 (auto-save-mode 1)))
3436(add-hook 'find-file-hooks 'tramp-set-auto-save t)
3437(add-hook 'tramp-unload-hook
3438 (lambda ()
3439 (remove-hook 'find-file-hooks 'tramp-set-auto-save)))
3440
3441(defun tramp-run-test (switch filename)
3442 "Run `test' on the remote system, given a SWITCH and a FILENAME.
3443Returns the exit code of the `test' program."
3444 (with-parsed-tramp-file-name filename nil
3445 (tramp-send-command-and-check
3446 v
3447 (format
3448 "%s %s %s"
3449 (tramp-get-test-command v)
3450 switch
3451 (tramp-shell-quote-argument localname)))))
3452
3453(defun tramp-run-test2 (format-string file1 file2)
3454 "Run `test'-like program on the remote system, given FILE1, FILE2.
3455FORMAT-STRING contains the program name, switches, and place holders.
3456Returns the exit code of the `test' program. Barfs if the methods,
3457hosts, or files, disagree."
3458 (unless (tramp-equal-remote file1 file2)
3459 (with-parsed-tramp-file-name (if (tramp-tramp-file-p file1) file1 file2) nil
3460 (tramp-error
3461 v 'file-error
3462 "tramp-run-test2 only implemented for same method, user, host")))
3463 (with-parsed-tramp-file-name file1 v1
3464 (with-parsed-tramp-file-name file1 v2
3465 (tramp-send-command-and-check
3466 v1
3467 (format format-string
3468 (tramp-shell-quote-argument v1-localname)
3469 (tramp-shell-quote-argument v2-localname))))))
3470
3471(defun tramp-find-executable
3472 (vec progname dirlist &optional ignore-tilde ignore-path)
3473 "Searches for PROGNAME in $PATH and all directories mentioned in DIRLIST.
3474First arg VEC specifies the connection, PROGNAME is the program
3475to search for, and DIRLIST gives the list of directories to
3476search. If IGNORE-TILDE is non-nil, directory names starting
3477with `~' will be ignored. If IGNORE-PATH is non-nil, searches
3478only in DIRLIST.
3479
3480Returns the absolute file name of PROGNAME, if found, and nil otherwise.
3481
3482This function expects to be in the right *tramp* buffer."
3483 (with-current-buffer (tramp-get-connection-buffer vec)
3484 (let (result)
3485 ;; Check whether the executable is in $PATH. "which(1)" does not
3486 ;; report always a correct error code; therefore we check the
3487 ;; number of words it returns.
3488 (unless ignore-path
3489 (tramp-send-command vec (format "which \\%s | wc -w" progname))
3490 (goto-char (point-min))
3491 (if (looking-at "^\\s-*1$")
3492 (setq result (concat "\\" progname))))
3493 (unless result
3494 (when ignore-tilde
3495 ;; Remove all ~/foo directories from dirlist. In XEmacs,
3496 ;; `remove' is in CL, and we want to avoid CL dependencies.
3497 (let (newdl d)
3498 (while dirlist
3499 (setq d (car dirlist))
3500 (setq dirlist (cdr dirlist))
3501 (unless (char-equal ?~ (aref d 0))
3502 (setq newdl (cons d newdl))))
3503 (setq dirlist (nreverse newdl))))
3504 (tramp-send-command
3505 vec
3506 (format (concat "while read d; "
3507 "do if test -x $d/%s -a -f $d/%s; "
3508 "then echo tramp_executable $d/%s; "
3509 "break; fi; done <<'EOF'\n"
3510 "%s\nEOF")
3511 progname progname progname (mapconcat 'identity dirlist "\n")))
3512 (goto-char (point-max))
3513 (when (search-backward "tramp_executable " nil t)
3514 (skip-chars-forward "^ ")
3515 (skip-chars-forward " ")
6e060cee 3516 (setq result (buffer-substring (point) (point-at-eol)))))
03c1ad43
MA
3517 result)))
3518
3519(defun tramp-set-remote-path (vec)
3520 "Sets the remote environment PATH to existing directories.
3521I.e., for each directory in `tramp-remote-path', it is tested
3522whether it exists and if so, it is added to the environment
3523variable PATH."
3524 (tramp-message vec 5 (format "Setting $PATH environment variable"))
3525 (tramp-send-command
3526 vec (format "PATH=%s; export PATH"
3527 (mapconcat 'identity (tramp-get-remote-path vec) ":"))))
3528
3529;; ------------------------------------------------------------
3530;; -- Communication with external shell --
3531;; ------------------------------------------------------------
3532
3533(defun tramp-find-file-exists-command (vec)
3534 "Find a command on the remote host for checking if a file exists.
3535Here, we are looking for a command which has zero exit status if the
3536file exists and nonzero exit status otherwise."
3537 (let ((existing "/")
fac916bf 3538 (nonexistent
03c1ad43
MA
3539 (tramp-shell-quote-argument "/ this file does not exist "))
3540 result)
3541 ;; The algorithm is as follows: we try a list of several commands.
3542 ;; For each command, we first run `$cmd /' -- this should return
3543 ;; true, as the root directory always exists. And then we run
3544 ;; `$cmd /this\ file\ does\ not\ exist ', hoping that the file indeed
3545 ;; does not exist. This should return false. We use the first
3546 ;; command we find that seems to work.
3547 ;; The list of commands to try is as follows:
3548 ;; `ls -d' This works on most systems, but NetBSD 1.4
3549 ;; has a bug: `ls' always returns zero exit
3550 ;; status, even for files which don't exist.
3551 ;; `test -e' Some Bourne shells have a `test' builtin
3552 ;; which does not know the `-e' option.
3553 ;; `/bin/test -e' For those, the `test' binary on disk normally
3554 ;; provides the option. Alas, the binary
3555 ;; is sometimes `/bin/test' and sometimes it's
3556 ;; `/usr/bin/test'.
3557 ;; `/usr/bin/test -e' In case `/bin/test' does not exist.
3558 (unless (or
3559 (and (setq result (format "%s -e" (tramp-get-test-command vec)))
3560 (tramp-send-command-and-check
3561 vec (format "%s %s" result existing))
3562 (not (tramp-send-command-and-check
fac916bf 3563 vec (format "%s %s" result nonexistent))))
03c1ad43
MA
3564 (and (setq result "/bin/test -e")
3565 (tramp-send-command-and-check
3566 vec (format "%s %s" result existing))
3567 (not (tramp-send-command-and-check
fac916bf 3568 vec (format "%s %s" result nonexistent))))
03c1ad43
MA
3569 (and (setq result "/usr/bin/test -e")
3570 (tramp-send-command-and-check
3571 vec (format "%s %s" result existing))
3572 (not (tramp-send-command-and-check
fac916bf 3573 vec (format "%s %s" result nonexistent))))
03c1ad43
MA
3574 (and (setq result (format "%s -d" (tramp-get-ls-command vec)))
3575 (tramp-send-command-and-check
3576 vec (format "%s %s" result existing))
3577 (not (tramp-send-command-and-check
fac916bf 3578 vec (format "%s %s" result nonexistent)))))
03c1ad43
MA
3579 (tramp-error
3580 vec 'file-error "Couldn't find command to check if file exists"))
3581 result))
3582
3583(defun tramp-open-shell (vec shell)
3584 "Opens shell SHELL."
7d520089
SM
3585 (tramp-with-progress-reporter
3586 vec 5 (format "Opening remote shell `%s'" shell)
03c1ad43
MA
3587 ;; Find arguments for this shell.
3588 (let ((tramp-end-of-output tramp-initial-end-of-output)
3589 (alist tramp-sh-extra-args)
3590 item extra-args)
3591 (while (and alist (null extra-args))
3592 (setq item (pop alist))
3593 (when (string-match (car item) shell)
3594 (setq extra-args (cdr item))))
3595 (when extra-args (setq shell (concat shell " " extra-args)))
3596 (tramp-send-command
3597 vec (format "exec env ENV='' PROMPT_COMMAND='' PS1=%s PS2='' PS3='' %s"
63648a95 3598 (tramp-shell-quote-argument tramp-end-of-output) shell)
03c1ad43
MA
3599 t))
3600 ;; Setting prompts.
3601 (tramp-send-command
63648a95 3602 vec (format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output)) t)
03c1ad43
MA
3603 (tramp-send-command vec "PS2=''" t)
3604 (tramp-send-command vec "PS3=''" t)
3605 (tramp-send-command vec "PROMPT_COMMAND=''" t)))
3606
3607(defun tramp-find-shell (vec)
3608 "Opens a shell on the remote host which groks tilde expansion."
2fe4b125
MA
3609 (with-connection-property vec "remote-shell"
3610 (let ((shell (tramp-get-method-parameter
3611 (tramp-file-name-method vec) 'tramp-remote-shell)))
03c1ad43 3612 (with-current-buffer (tramp-get-buffer vec)
2fe4b125
MA
3613 ;; CCC: "root" does not exist always, see QNAP 459. Which
3614 ;; check could we apply instead?
03c1ad43 3615 (tramp-send-command vec "echo ~root" t)
2fe4b125
MA
3616 (when (or (string-match "^~root$" (buffer-string))
3617 ;; The default shell (ksh93) of OpenSolaris and
3618 ;; Solaris is buggy. We've got reports for "SunOS
3619 ;; 5.10" and "SunOS 5.11" so far.
3620 (string-match (regexp-opt '("SunOS 5.10" "SunOS 5.11"))
3621 (tramp-get-connection-property vec "uname" "")))
3622 (if (setq shell
3623 (or (tramp-find-executable
3624 vec "bash" (tramp-get-remote-path vec) t t)
3625 (tramp-find-executable
3626 vec "ksh" (tramp-get-remote-path vec) t t)))
3627 (progn
3628 (tramp-message
3629 vec 5 "Starting remote shell `%s' for tilde expansion" shell)
3630 (tramp-open-shell vec shell))
3631
3632 ;; Maybe it works at least for some other commands.
3633 (setq shell
3634 (tramp-get-method-parameter
3635 (tramp-file-name-method vec) 'tramp-remote-shell))
3636 (tramp-message
3637 vec 2
3638 (concat
3639 "Couldn't find a remote shell which groks tilde expansion, "
3640 "using `%s'")
3641 shell)))
3642
3643 ;; Busyboxes tend to behave strange. We check for the existence.
3644 (with-connection-property vec "busybox"
3645 (tramp-send-command vec (format "%s --version" shell) t)
3646 (let ((case-fold-search t))
3647 (and (string-match "busybox" (buffer-string)) t)))
3648
3649 ;; Return the shell.
3650 shell))))
03c1ad43
MA
3651
3652;; Utility functions.
3653
3654(defun tramp-barf-if-no-shell-prompt (proc timeout &rest error-args)
3655 "Wait for shell prompt and barf if none appears.
3656Looks at process PROC to see if a shell prompt appears in TIMEOUT
3657seconds. If not, it produces an error message with the given ERROR-ARGS."
3658 (unless
3659 (tramp-wait-for-regexp
3660 proc timeout
3661 (format
3662 "\\(%s\\|%s\\)\\'" shell-prompt-pattern tramp-shell-prompt-pattern))
3663 (apply 'tramp-error-with-buffer nil proc 'file-error error-args)))
3664
3665(defun tramp-open-connection-setup-interactive-shell (proc vec)
3666 "Set up an interactive shell.
3667Mainly sets the prompt and the echo correctly. PROC is the shell
3668process to set up. VEC specifies the connection."
3669 (let ((tramp-end-of-output tramp-initial-end-of-output))
3670 ;; It is useful to set the prompt in the following command because
3671 ;; some people have a setting for $PS1 which /bin/sh doesn't know
3672 ;; about and thus /bin/sh will display a strange prompt. For
3673 ;; example, if $PS1 has "${CWD}" in the value, then ksh will
3674 ;; display the current working directory but /bin/sh will display
3675 ;; a dollar sign. The following command line sets $PS1 to a sane
3676 ;; value, and works under Bourne-ish shells as well as csh-like
3677 ;; shells. Daniel Pittman reports that the unusual positioning of
3678 ;; the single quotes makes it work under `rc', too. We also unset
3679 ;; the variable $ENV because that is read by some sh
3680 ;; implementations (eg, bash when called as sh) on startup; this
6e060cee 3681 ;; way, we avoid the startup file clobbering $PS1. $PROMPT_COMMAND
03c1ad43
MA
3682 ;; is another way to set the prompt in /bin/bash, it must be
3683 ;; discarded as well.
3684 (tramp-open-shell
3685 vec
f5e29b9b
MA
3686 (tramp-get-method-parameter
3687 (tramp-file-name-method vec) 'tramp-remote-shell))
03c1ad43
MA
3688
3689 ;; Disable echo.
3690 (tramp-message vec 5 "Setting up remote shell environment")
3691 (tramp-send-command vec "stty -inlcr -echo kill '^U' erase '^H'" t)
3692 ;; Check whether the echo has really been disabled. Some
3693 ;; implementations, like busybox of embedded GNU/Linux, don't
3694 ;; support disabling.
3695 (tramp-send-command vec "echo foo" t)
3696 (with-current-buffer (process-buffer proc)
3697 (goto-char (point-min))
3698 (when (looking-at "echo foo")
3699 (tramp-set-connection-property proc "remote-echo" t)
3700 (tramp-message vec 5 "Remote echo still on. Ok.")
3701 ;; Make sure backspaces and their echo are enabled and no line
3702 ;; width magic interferes with them.
3703 (tramp-send-command vec "stty icanon erase ^H cols 32767" t))))
3704
3705 (tramp-message vec 5 "Setting shell prompt")
3706 (tramp-send-command
63648a95 3707 vec (format "PS1=%s" (tramp-shell-quote-argument tramp-end-of-output)) t)
03c1ad43
MA
3708 (tramp-send-command vec "PS2=''" t)
3709 (tramp-send-command vec "PS3=''" t)
3710 (tramp-send-command vec "PROMPT_COMMAND=''" t)
3711
3712 ;; Try to set up the coding system correctly.
3713 ;; CCC this can't be the right way to do it. Hm.
3714 (tramp-message vec 5 "Determining coding system")
3715 (tramp-send-command vec "echo foo ; echo bar" t)
3716 (with-current-buffer (process-buffer proc)
3717 (goto-char (point-min))
3718 (if (featurep 'mule)
3719 ;; Use MULE to select the right EOL convention for communicating
3720 ;; with the process.
3721 (let* ((cs (or (tramp-compat-funcall 'process-coding-system proc)
3722 (cons 'undecided 'undecided)))
3723 cs-decode cs-encode)
3724 (when (symbolp cs) (setq cs (cons cs cs)))
3725 (setq cs-decode (car cs))
3726 (setq cs-encode (cdr cs))
3727 (unless cs-decode (setq cs-decode 'undecided))
3728 (unless cs-encode (setq cs-encode 'undecided))
bd8fadca 3729 (setq cs-encode (tramp-compat-coding-system-change-eol-conversion
03c1ad43
MA
3730 cs-encode 'unix))
3731 (when (search-forward "\r" nil t)
bd8fadca 3732 (setq cs-decode (tramp-compat-coding-system-change-eol-conversion
03c1ad43
MA
3733 cs-decode 'dos)))
3734 (tramp-compat-funcall
3735 'set-buffer-process-coding-system cs-decode cs-encode)
3736 (tramp-message
3737 vec 5 "Setting coding system to `%s' and `%s'" cs-decode cs-encode))
3738 ;; Look for ^M and do something useful if found.
3739 (when (search-forward "\r" nil t)
3740 ;; We have found a ^M but cannot frob the process coding system
3741 ;; because we're running on a non-MULE Emacs. Let's try
3742 ;; stty, instead.
3743 (tramp-send-command vec "stty -onlcr" t))))
aa095b2d 3744
03c1ad43
MA
3745 (tramp-send-command vec "set +o vi +o emacs" t)
3746
3747 ;; Check whether the output of "uname -sr" has been changed. If
3748 ;; yes, this is a strong indication that we must expire all
3749 ;; connection properties. We start again with
333f9019 3750 ;; `tramp-maybe-open-connection', it will be caught there.
03c1ad43
MA
3751 (tramp-message vec 5 "Checking system information")
3752 (let ((old-uname (tramp-get-connection-property vec "uname" nil))
3753 (new-uname
3754 (tramp-set-connection-property
3755 vec "uname"
3756 (tramp-send-command-and-read vec "echo \\\"`uname -sr`\\\""))))
3757 (when (and (stringp old-uname) (not (string-equal old-uname new-uname)))
2fe4b125
MA
3758 (tramp-cleanup vec)
3759 (tramp-message
3760 vec 3
3761 "Connection reset, because remote host changed from `%s' to `%s'"
3762 old-uname new-uname)
3763 (throw 'uname-changed (tramp-maybe-open-connection vec))))
03c1ad43
MA
3764
3765 ;; Check whether the remote host suffers from buggy
3766 ;; `send-process-string'. This is known for FreeBSD (see comment in
3767 ;; `send_process', file process.c). I've tested sending 624 bytes
3768 ;; successfully, sending 625 bytes failed. Emacs makes a hack when
3769 ;; this host type is detected locally. It cannot handle remote
3770 ;; hosts, though.
3771 (with-connection-property proc "chunksize"
3772 (cond
3773 ((and (integerp tramp-chunksize) (> tramp-chunksize 0))
3774 tramp-chunksize)
3775 (t
3776 (tramp-message
3777 vec 5 "Checking remote host type for `send-process-string' bug")
3778 (if (string-match
3779 "^FreeBSD" (tramp-get-connection-property vec "uname" ""))
3780 500 0))))
3781
3782 ;; Set remote PATH variable.
3783 (tramp-set-remote-path vec)
3784
3785 ;; Search for a good shell before searching for a command which
3786 ;; checks if a file exists. This is done because Tramp wants to use
3787 ;; "test foo; echo $?" to check if various conditions hold, and
3788 ;; there are buggy /bin/sh implementations which don't execute the
3789 ;; "echo $?" part if the "test" part has an error. In particular,
3790 ;; the OpenSolaris /bin/sh is a problem. There are also other
3791 ;; problems with /bin/sh of OpenSolaris, like redirection of stderr
3792 ;; in function declarations, or changing HISTFILE in place.
3793 ;; Therefore, OpenSolaris' /bin/sh is replaced by bash, when
3794 ;; detected.
3795 (tramp-find-shell vec)
3796
3797 ;; Disable unexpected output.
3798 (tramp-send-command vec "mesg n; biff n" t)
3799
3800 ;; IRIX64 bash expands "!" even when in single quotes. This
3801 ;; destroys our shell functions, we must disable it. See
3802 ;; <http://stackoverflow.com/questions/3291692/irix-bash-shell-expands-expression-in-single-quotes-yet-shouldnt>.
3803 (when (string-match "^IRIX64" (tramp-get-connection-property vec "uname" ""))
3804 (tramp-send-command vec "set +H" t))
3805
aa095b2d
MA
3806 ;; On BSD-like systems, ?\t is expanded to spaces. Suppress this.
3807 (when (string-match "BSD\\|Darwin"
3808 (tramp-get-connection-property vec "uname" ""))
3809 (tramp-send-command vec "stty -oxtabs" t))
3810
03c1ad43 3811 ;; Set `remote-tty' process property.
6d95bd46
MA
3812 (let ((tty (tramp-send-command-and-read vec "echo \\\"`tty`\\\"" 'noerror)))
3813 (unless (zerop (length tty))
3814 (tramp-compat-process-put proc 'remote-tty tty)))
03c1ad43 3815
aa095b2d
MA
3816 ;; Dump stty settings in the traces.
3817 (when (>= tramp-verbose 9)
3818 (tramp-send-command vec "stty -a" t))
3819
03c1ad43
MA
3820 ;; Set the environment.
3821 (tramp-message vec 5 "Setting default environment")
3822
3823 (let ((env (copy-sequence tramp-remote-process-environment))
3824 unset item)
3825 (while env
3826 (setq item (tramp-compat-split-string (car env) "="))
3827 (setcdr item (mapconcat 'identity (cdr item) "="))
3828 (if (and (stringp (cdr item)) (not (string-equal (cdr item) "")))
3829 (tramp-send-command
3830 vec (format "%s=%s; export %s" (car item) (cdr item) (car item)) t)
3831 (push (car item) unset))
3832 (setq env (cdr env)))
3833 (when unset
3834 (tramp-send-command
3835 vec (format "unset %s" (mapconcat 'identity unset " ")) t))))
3836
3837;; CCC: We should either implement a Perl version of base64 encoding
3838;; and decoding. Then we just use that in the last item. The other
3839;; alternative is to use the Perl version of UU encoding. But then
3840;; we need a Lisp version of uuencode.
3841;;
3842;; Old text from documentation of tramp-methods:
3843;; Using a uuencode/uudecode inline method is discouraged, please use one
3844;; of the base64 methods instead since base64 encoding is much more
3845;; reliable and the commands are more standardized between the different
3846;; Unix versions. But if you can't use base64 for some reason, please
3847;; note that the default uudecode command does not work well for some
3848;; Unices, in particular AIX and Irix. For AIX, you might want to use
3849;; the following command for uudecode:
3850;;
3851;; sed '/^begin/d;/^[` ]$/d;/^end/d' | iconv -f uucode -t ISO8859-1
3852;;
3853;; For Irix, no solution is known yet.
3854
3855(autoload 'uudecode-decode-region "uudecode")
3856
3857(defconst tramp-local-coding-commands
3858 '((b64 base64-encode-region base64-decode-region)
3859 (uu tramp-uuencode-region uudecode-decode-region)
3860 (pack
3861 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3862 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
3863 "List of local coding commands for inline transfer.
3864Each item is a list that looks like this:
3865
3866\(FORMAT ENCODING DECODING\)
3867
3868FORMAT is symbol describing the encoding/decoding format. It can be
3869`b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3870
3871ENCODING and DECODING can be strings, giving commands, or symbols,
3872giving functions. If they are strings, then they can contain
3873the \"%s\" format specifier. If that specifier is present, the input
3874filename will be put into the command line at that spot. If the
3875specifier is not present, the input should be read from standard
3876input.
3877
3878If they are functions, they will be called with two arguments, start
3879and end of region, and are expected to replace the region contents
3880with the encoded or decoded results, respectively.")
3881
3882(defconst tramp-remote-coding-commands
6e060cee
MA
3883 '((b64 "base64" "base64 -d -i")
3884 ;; "-i" is more robust with older base64 from GNU coreutils.
3885 ;; However, I don't know whether all base64 versions do supports
3886 ;; this option.
3887 (b64 "base64" "base64 -d")
03c1ad43
MA
3888 (b64 "mimencode -b" "mimencode -u -b")
3889 (b64 "mmencode -b" "mmencode -u -b")
3890 (b64 "recode data..base64" "recode base64..data")
3891 (b64 tramp-perl-encode-with-module tramp-perl-decode-with-module)
3892 (b64 tramp-perl-encode tramp-perl-decode)
2fe4b125 3893 (uu "uuencode xxx" "uudecode -o /dev/stdout" "test -c /dev/stdout")
03c1ad43
MA
3894 (uu "uuencode xxx" "uudecode -o -")
3895 (uu "uuencode xxx" "uudecode -p")
3896 (uu "uuencode xxx" tramp-uudecode)
3897 (pack
3898 "perl -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
3899 "perl -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"))
3900 "List of remote coding commands for inline transfer.
3901Each item is a list that looks like this:
3902
2fe4b125 3903\(FORMAT ENCODING DECODING [TEST]\)
03c1ad43
MA
3904
3905FORMAT is symbol describing the encoding/decoding format. It can be
3906`b64' for base64 encoding, `uu' for uu encoding, or `pack' for simple packing.
3907
3908ENCODING and DECODING can be strings, giving commands, or symbols,
3909giving variables. If they are strings, then they can contain
3910the \"%s\" format specifier. If that specifier is present, the input
3911filename will be put into the command line at that spot. If the
3912specifier is not present, the input should be read from standard
3913input.
3914
3915If they are variables, this variable is a string containing a Perl
3916implementation for this functionality. This Perl program will be transferred
2fe4b125
MA
3917to the remote host, and it is available as shell function with the same name.
3918
3919The optional TEST command can be used for further tests, whether
3920ENCODING and DECODING are applicable.")
03c1ad43
MA
3921
3922(defun tramp-find-inline-encoding (vec)
3923 "Find an inline transfer encoding that works.
3924Goes through the list `tramp-local-coding-commands' and
3925`tramp-remote-coding-commands'."
3926 (save-excursion
3927 (let ((local-commands tramp-local-coding-commands)
3928 (magic "xyzzy")
2fe4b125
MA
3929 (p (tramp-get-connection-process vec))
3930 loc-enc loc-dec rem-enc rem-dec rem-test litem ritem found)
03c1ad43
MA
3931 (while (and local-commands (not found))
3932 (setq litem (pop local-commands))
3933 (catch 'wont-work-local
3934 (let ((format (nth 0 litem))
3935 (remote-commands tramp-remote-coding-commands))
3936 (setq loc-enc (nth 1 litem))
3937 (setq loc-dec (nth 2 litem))
3938 ;; If the local encoder or decoder is a string, the
3939 ;; corresponding command has to work locally.
3940 (if (not (stringp loc-enc))
3941 (tramp-message
3942 vec 5 "Checking local encoding function `%s'" loc-enc)
3943 (tramp-message
3944 vec 5 "Checking local encoding command `%s' for sanity" loc-enc)
3945 (unless (zerop (tramp-call-local-coding-command
3946 loc-enc nil nil))
3947 (throw 'wont-work-local nil)))
3948 (if (not (stringp loc-dec))
3949 (tramp-message
3950 vec 5 "Checking local decoding function `%s'" loc-dec)
3951 (tramp-message
3952 vec 5 "Checking local decoding command `%s' for sanity" loc-dec)
3953 (unless (zerop (tramp-call-local-coding-command
3954 loc-dec nil nil))
3955 (throw 'wont-work-local nil)))
3956 ;; Search for remote coding commands with the same format
3957 (while (and remote-commands (not found))
3958 (setq ritem (pop remote-commands))
3959 (catch 'wont-work-remote
3960 (when (equal format (nth 0 ritem))
3961 (setq rem-enc (nth 1 ritem))
3962 (setq rem-dec (nth 2 ritem))
2fe4b125
MA
3963 (setq rem-test (nth 3 ritem))
3964 ;; Check the remote test command if exists.
3965 (when (stringp rem-test)
3966 (tramp-message
3967 vec 5 "Checking remote test command `%s'" rem-test)
3968 (unless (tramp-send-command-and-check vec rem-test t)
3969 (throw 'wont-work-remote nil)))
03c1ad43
MA
3970 ;; Check if remote encoding and decoding commands can be
3971 ;; called remotely with null input and output. This makes
3972 ;; sure there are no syntax errors and the command is really
3973 ;; found. Note that we do not redirect stdout to /dev/null,
3974 ;; for two reasons: when checking the decoding command, we
3975 ;; actually check the output it gives. And also, when
3976 ;; redirecting "mimencode" output to /dev/null, then as root
3977 ;; it might change the permissions of /dev/null!
3978 (when (not (stringp rem-enc))
3979 (let ((name (symbol-name rem-enc)))
3980 (while (string-match (regexp-quote "-") name)
3981 (setq name (replace-match "_" nil t name)))
3982 (tramp-maybe-send-script vec (symbol-value rem-enc) name)
3983 (setq rem-enc name)))
3984 (tramp-message
3985 vec 5
3986 "Checking remote encoding command `%s' for sanity" rem-enc)
3987 (unless (tramp-send-command-and-check
3988 vec (format "%s </dev/null" rem-enc) t)
3989 (throw 'wont-work-remote nil))
3990
3991 (when (not (stringp rem-dec))
3992 (let ((name (symbol-name rem-dec)))
3993 (while (string-match (regexp-quote "-") name)
3994 (setq name (replace-match "_" nil t name)))
3995 (tramp-maybe-send-script vec (symbol-value rem-dec) name)
3996 (setq rem-dec name)))
3997 (tramp-message
3998 vec 5
3999 "Checking remote decoding command `%s' for sanity" rem-dec)
4000 (unless (tramp-send-command-and-check
4001 vec
4002 (format "echo %s | %s | %s" magic rem-enc rem-dec)
4003 t)
4004 (throw 'wont-work-remote nil))
4005
4006 (with-current-buffer (tramp-get-buffer vec)
4007 (goto-char (point-min))
4008 (unless (looking-at (regexp-quote magic))
4009 (throw 'wont-work-remote nil)))
4010
4011 ;; `rem-enc' and `rem-dec' could be a string meanwhile.
4012 (setq rem-enc (nth 1 ritem))
4013 (setq rem-dec (nth 2 ritem))
4014 (setq found t)))))))
4015
4016 ;; Did we find something?
4017 (unless found
4018 (tramp-error
4019 vec 'file-error "Couldn't find an inline transfer encoding"))
4020
2fe4b125
MA
4021 ;; Set connection properties. Since the commands are risky (due
4022 ;; to output direction), we cache them in the process cache.
03c1ad43 4023 (tramp-message vec 5 "Using local encoding `%s'" loc-enc)
2fe4b125 4024 (tramp-set-connection-property p "local-encoding" loc-enc)
03c1ad43 4025 (tramp-message vec 5 "Using local decoding `%s'" loc-dec)
2fe4b125 4026 (tramp-set-connection-property p "local-decoding" loc-dec)
03c1ad43 4027 (tramp-message vec 5 "Using remote encoding `%s'" rem-enc)
2fe4b125 4028 (tramp-set-connection-property p "remote-encoding" rem-enc)
03c1ad43 4029 (tramp-message vec 5 "Using remote decoding `%s'" rem-dec)
2fe4b125 4030 (tramp-set-connection-property p "remote-decoding" rem-dec))))
03c1ad43
MA
4031
4032(defun tramp-call-local-coding-command (cmd input output)
4033 "Call the local encoding or decoding command.
4034If CMD contains \"%s\", provide input file INPUT there in command.
4035Otherwise, INPUT is passed via standard input.
4036INPUT can also be nil which means `/dev/null'.
4037OUTPUT can be a string (which specifies a filename), or t (which
4038means standard output and thus the current buffer), or nil (which
4039means discard it)."
4040 (tramp-compat-call-process
4041 tramp-encoding-shell
4042 (when (and input (not (string-match "%s" cmd))) input)
4043 (if (eq output t) t nil)
4044 nil
4045 tramp-encoding-command-switch
4046 (concat
4047 (if (string-match "%s" cmd) (format cmd input) cmd)
4048 (if (stringp output) (concat "> " output) ""))))
4049
4050(defconst tramp-inline-compress-commands
4051 '(("gzip" "gzip -d")
4052 ("bzip2" "bzip2 -d")
443d6696 4053 ("xz" "xz -d")
03c1ad43
MA
4054 ("compress" "compress -d"))
4055 "List of compress and decompress commands for inline transfer.
4056Each item is a list that looks like this:
4057
4058\(COMPRESS DECOMPRESS\)
4059
4060COMPRESS or DECOMPRESS are strings with the respective commands.")
4061
4062(defun tramp-find-inline-compress (vec)
4063 "Find an inline transfer compress command that works.
4064Goes through the list `tramp-inline-compress-commands'."
4065 (save-excursion
4066 (let ((commands tramp-inline-compress-commands)
4067 (magic "xyzzy")
2fe4b125
MA
4068 (p (tramp-get-connection-process vec))
4069 item compress decompress found)
03c1ad43
MA
4070 (while (and commands (not found))
4071 (catch 'next
4072 (setq item (pop commands)
4073 compress (nth 0 item)
4074 decompress (nth 1 item))
4075 (tramp-message
4076 vec 5
4077 "Checking local compress command `%s', `%s' for sanity"
4078 compress decompress)
362b9d48
GM
4079 (unless
4080 (zerop
4081 (tramp-call-local-coding-command
4082 (format
4083 ;; Windows shells need the program file name after
4084 ;; the pipe symbol be quoted if they use forward
4085 ;; slashes as directory separators.
4086 (if (memq system-type '(windows-nt))
4087 "echo %s | \"%s\" | \"%s\""
4088 "echo %s | %s | %s")
4089 magic compress decompress) nil nil))
03c1ad43
MA
4090 (throw 'next nil))
4091 (tramp-message
4092 vec 5
4093 "Checking remote compress command `%s', `%s' for sanity"
4094 compress decompress)
4095 (unless (tramp-send-command-and-check
4096 vec (format "echo %s | %s | %s" magic compress decompress) t)
4097 (throw 'next nil))
4098 (setq found t)))
4099
4100 ;; Did we find something?
4101 (if found
4102 (progn
2fe4b125
MA
4103 ;; Set connection properties. Since the commands are
4104 ;; risky (due to output direction), we cache them in the
4105 ;; process cache.
03c1ad43
MA
4106 (tramp-message
4107 vec 5 "Using inline transfer compress command `%s'" compress)
2fe4b125 4108 (tramp-set-connection-property p "inline-compress" compress)
03c1ad43
MA
4109 (tramp-message
4110 vec 5 "Using inline transfer decompress command `%s'" decompress)
2fe4b125 4111 (tramp-set-connection-property p "inline-decompress" decompress))
03c1ad43 4112
2fe4b125
MA
4113 (tramp-set-connection-property p "inline-compress" nil)
4114 (tramp-set-connection-property p "inline-decompress" nil)
03c1ad43
MA
4115 (tramp-message
4116 vec 2 "Couldn't find an inline transfer compress command")))))
4117
4118(defun tramp-compute-multi-hops (vec)
4119 "Expands VEC according to `tramp-default-proxies-alist'.
4120Gateway hops are already opened."
4121 (let ((target-alist `(,vec))
2fe4b125
MA
4122 (hops (or (tramp-file-name-hop vec) ""))
4123 (item vec)
4124 choices proxy)
4125
4126 ;; Ad-hoc proxy definitions.
4127 (dolist (proxy (reverse (split-string hops tramp-postfix-hop-regexp 'omit)))
4128 (let ((user (tramp-file-name-user item))
4129 (host (tramp-file-name-host item))
4130 (proxy (concat
4131 tramp-prefix-format proxy tramp-postfix-host-format)))
4132 (tramp-message
4133 vec 5 "Add proxy (\"%s\" \"%s\" \"%s\")"
4134 (and (stringp host) (regexp-quote host))
4135 (and (stringp user) (regexp-quote user))
4136 proxy)
4137 ;; Add the hop.
4138 (add-to-list
4139 'tramp-default-proxies-alist
4140 (list (and (stringp host) (regexp-quote host))
4141 (and (stringp user) (regexp-quote user))
4142 proxy))
4143 (setq item (tramp-dissect-file-name proxy))))
4144 ;; Save the new value.
4145 (when (and hops tramp-save-ad-hoc-proxies)
4146 (customize-save-variable
4147 'tramp-default-proxies-alist tramp-default-proxies-alist))
03c1ad43
MA
4148
4149 ;; Look for proxy hosts to be passed.
2fe4b125 4150 (setq choices tramp-default-proxies-alist)
03c1ad43
MA
4151 (while choices
4152 (setq item (pop choices)
4153 proxy (eval (nth 2 item)))
4154 (when (and
2fe4b125 4155 ;; Host.
03c1ad43
MA
4156 (string-match (or (eval (nth 0 item)) "")
4157 (or (tramp-file-name-host (car target-alist)) ""))
2fe4b125 4158 ;; User.
03c1ad43
MA
4159 (string-match (or (eval (nth 1 item)) "")
4160 (or (tramp-file-name-user (car target-alist)) "")))
4161 (if (null proxy)
4162 ;; No more hops needed.
4163 (setq choices nil)
4164 ;; Replace placeholders.
4165 (setq proxy
4166 (format-spec
4167 proxy
4168 (format-spec-make
4169 ?u (or (tramp-file-name-user (car target-alist)) "")
4170 ?h (or (tramp-file-name-host (car target-alist)) ""))))
4171 (with-parsed-tramp-file-name proxy l
4172 ;; Add the hop.
4173 (add-to-list 'target-alist l)
4174 ;; Start next search.
4175 (setq choices tramp-default-proxies-alist)))))
4176
4177 ;; Handle gateways.
4178 (when (string-match
4179 (format
4180 "^\\(%s\\|%s\\)$" tramp-gw-tunnel-method tramp-gw-socks-method)
4181 (tramp-file-name-method (car target-alist)))
4182 (let ((gw (pop target-alist))
4183 (hop (pop target-alist)))
4184 ;; Is the method prepared for gateways?
66feec8b 4185 (unless (tramp-file-name-port hop)
03c1ad43
MA
4186 (tramp-error
4187 vec 'file-error
66feec8b 4188 "Connection `%s' is not supported for gateway access." hop))
03c1ad43
MA
4189 ;; Open the gateway connection.
4190 (add-to-list
4191 'target-alist
4192 (vector
4193 (tramp-file-name-method hop) (tramp-file-name-user hop)
2fe4b125 4194 (tramp-compat-funcall 'tramp-gw-open-connection vec gw hop) nil nil))
03c1ad43
MA
4195 ;; For the password prompt, we need the correct values.
4196 ;; Therefore, we must remember the gateway vector. But we
4197 ;; cannot do it as connection property, because it shouldn't
4198 ;; be persistent. And we have no started process yet either.
4199 (tramp-set-file-property (car target-alist) "" "gateway" hop)))
4200
4201 ;; Foreign and out-of-band methods are not supported for multi-hops.
4202 (when (cdr target-alist)
4203 (setq choices target-alist)
4204 (while choices
4205 (setq item (pop choices))
4206 (when
4207 (or
4208 (not
4209 (tramp-get-method-parameter
4210 (tramp-file-name-method item) 'tramp-login-program))
4211 (tramp-get-method-parameter
4212 (tramp-file-name-method item) 'tramp-copy-program))
4213 (tramp-error
4214 vec 'file-error
4215 "Method `%s' is not supported for multi-hops."
4216 (tramp-file-name-method item)))))
4217
4218 ;; In case the host name is not used for the remote shell
4219 ;; command, the user could be misguided by applying a random
4220 ;; hostname.
4221 (let* ((v (car target-alist))
4222 (method (tramp-file-name-method v))
4223 (host (tramp-file-name-host v)))
4224 (unless
4225 (or
4226 ;; There are multi-hops.
4227 (cdr target-alist)
4228 ;; The host name is used for the remote shell command.
4229 (member
4230 '("%h") (tramp-get-method-parameter method 'tramp-login-args))
4231 ;; The host is local. We cannot use `tramp-local-host-p'
4232 ;; here, because it opens a connection as well.
4233 (string-match tramp-local-host-regexp host))
4234 (tramp-error
4235 v 'file-error
4236 "Host `%s' looks like a remote host, `%s' can only use the local host"
4237 host method)))
4238
4239 ;; Result.
4240 target-alist))
4241
2fe4b125
MA
4242(defvar tramp-current-connection nil
4243 "Last connection timestamp.")
4244
03c1ad43
MA
4245(defun tramp-maybe-open-connection (vec)
4246 "Maybe open a connection VEC.
4247Does not do anything if a connection is already open, but re-opens the
4248connection if a previous connection has died for some reason."
4249 (catch 'uname-changed
4250 (let ((p (tramp-get-connection-process vec))
4251 (process-name (tramp-get-connection-property vec "process-name" nil))
bfd31217
MA
4252 (process-environment (copy-sequence process-environment))
4253 (pos (with-current-buffer (tramp-get-connection-buffer vec) (point))))
03c1ad43 4254
2fe4b125
MA
4255 ;; If Tramp opens the same connection within a short time frame,
4256 ;; there is a problem. We shall signal this.
4257 (unless (or (and p (processp p) (memq (process-status p) '(run open)))
4258 (not (equal (butlast (append vec nil))
4259 (car tramp-current-connection)))
4260 (> (tramp-time-diff
4261 (current-time) (cdr tramp-current-connection))
4262 5))
4263 (throw 'suppress 'suppress))
4264
03c1ad43
MA
4265 ;; If too much time has passed since last command was sent, look
4266 ;; whether process is still alive. If it isn't, kill it. When
4267 ;; using ssh, it can sometimes happen that the remote end has
4268 ;; hung up but the local ssh client doesn't recognize this until
4269 ;; it tries to send some data to the remote end. So that's why
4270 ;; we try to send a command from time to time, then look again
4271 ;; whether the process is really alive.
4272 (condition-case nil
4273 (when (and (> (tramp-time-diff
4274 (current-time)
4275 (tramp-get-connection-property
4276 p "last-cmd-time" '(0 0 0)))
4277 60)
4278 p (processp p) (memq (process-status p) '(run open)))
4279 (tramp-send-command vec "echo are you awake" t t)
4280 (unless (and (memq (process-status p) '(run open))
4281 (tramp-wait-for-output p 10))
333f9019 4282 ;; The error will be caught locally.
03c1ad43
MA
4283 (tramp-error vec 'file-error "Awake did fail")))
4284 (file-error
2fe4b125 4285 (tramp-cleanup vec)
03c1ad43
MA
4286 (setq p nil)))
4287
4288 ;; New connection must be opened.
6bdac736
MA
4289 (condition-case err
4290 (unless (and p (processp p) (memq (process-status p) '(run open)))
4291
4292 ;; We call `tramp-get-buffer' in order to get a debug
4293 ;; buffer for messages from the beginning.
4294 (tramp-get-buffer vec)
4295 (tramp-with-progress-reporter
4296 vec 3
4297 (if (zerop (length (tramp-file-name-user vec)))
4298 (format "Opening connection for %s using %s"
4299 (tramp-file-name-host vec)
4300 (tramp-file-name-method vec))
4301 (format "Opening connection for %s@%s using %s"
4302 (tramp-file-name-user vec)
4303 (tramp-file-name-host vec)
4304 (tramp-file-name-method vec)))
4305
4306 ;; Start new process.
4307 (when (and p (processp p))
4308 (delete-process p))
4309 (setenv "TERM" tramp-terminal-type)
4310 (setenv "LC_ALL" "C")
4311 (setenv "PROMPT_COMMAND")
4312 (setenv "PS1" tramp-initial-end-of-output)
4313 (let* ((target-alist (tramp-compute-multi-hops vec))
4314 (process-connection-type tramp-process-connection-type)
4315 (process-adaptive-read-buffering nil)
4316 (coding-system-for-read nil)
4317 ;; This must be done in order to avoid our file
4318 ;; name handler.
4319 (p (let ((default-directory
4320 (tramp-compat-temporary-file-directory)))
4321 (apply
4322 'start-process
4323 (tramp-get-connection-name vec)
4324 (tramp-get-connection-buffer vec)
4325 (if tramp-encoding-command-interactive
4326 (list tramp-encoding-shell
4327 tramp-encoding-command-interactive)
4328 (list tramp-encoding-shell))))))
4329
4330 ;; Set sentinel and query flag.
4331 (tramp-set-connection-property p "vector" vec)
4332 (set-process-sentinel p 'tramp-process-sentinel)
4333 (tramp-compat-set-process-query-on-exit-flag p nil)
2fe4b125
MA
4334 (setq tramp-current-connection
4335 (cons (butlast (append vec nil)) (current-time)))
6d95bd46 4336
03c1ad43 4337 (tramp-message
6bdac736
MA
4338 vec 6 "%s" (mapconcat 'identity (process-command p) " "))
4339
4340 ;; Check whether process is alive.
4341 (tramp-barf-if-no-shell-prompt
4342 p 60
4343 "Couldn't find local shell prompt %s" tramp-encoding-shell)
4344
4345 ;; Now do all the connections as specified.
4346 (while target-alist
4347 (let* ((hop (car target-alist))
4348 (l-method (tramp-file-name-method hop))
4349 (l-user (tramp-file-name-user hop))
4350 (l-host (tramp-file-name-host hop))
4351 (l-port nil)
4352 (login-program
4353 (tramp-get-method-parameter
4354 l-method 'tramp-login-program))
4355 (login-args
4356 (tramp-get-method-parameter
4357 l-method 'tramp-login-args))
4358 (async-args
4359 (tramp-get-method-parameter
4360 l-method 'tramp-async-args))
4361 (gw-args
4362 (tramp-get-method-parameter l-method 'tramp-gw-args))
4363 (gw (tramp-get-file-property hop "" "gateway" nil))
4364 (g-method (and gw (tramp-file-name-method gw)))
4365 (g-user (and gw (tramp-file-name-user gw)))
4366 (g-host (and gw (tramp-file-name-real-host gw)))
4367 (command login-program)
4368 ;; We don't create the temporary file. In
4369 ;; fact, it is just a prefix for the
4370 ;; ControlPath option of ssh; the real
4371 ;; temporary file has another name, and it is
4372 ;; created and protected by ssh. It is also
4373 ;; removed by ssh when the connection is
4374 ;; closed.
4375 (tmpfile
4376 (tramp-set-connection-property
4377 p "temp-file"
4378 (make-temp-name
4379 (expand-file-name
4380 tramp-temp-name-prefix
4381 (tramp-compat-temporary-file-directory)))))
4382 spec)
4383
4384 ;; Add arguments for asynchronous processes.
4385 (when (and process-name async-args)
4386 (setq login-args (append async-args login-args)))
4387
4388 ;; Add gateway arguments if necessary.
4389 (when (and gw gw-args)
4390 (setq login-args (append gw-args login-args)))
4391
4392 ;; Check for port number. Until now, there's no
4393 ;; need for handling like method, user, host.
4394 (when (string-match tramp-host-with-port-regexp l-host)
4395 (setq l-port (match-string 2 l-host)
4396 l-host (match-string 1 l-host)))
4397
4398 ;; Set variables for computing the prompt for
4399 ;; reading password. They can also be derived
4400 ;; from a gateway.
4401 (setq tramp-current-method (or g-method l-method)
4402 tramp-current-user (or g-user l-user)
4403 tramp-current-host (or g-host l-host))
4404
4405 ;; Replace login-args place holders.
4406 (setq
4407 l-host (or l-host "")
4408 l-user (or l-user "")
4409 l-port (or l-port "")
4410 spec (format-spec-make
4411 ?h l-host ?u l-user ?p l-port ?t tmpfile)
4412 command
4413 (concat
4414 ;; We do not want to see the trailing local
4415 ;; prompt in `start-file-process'.
4416 (unless (memq system-type '(windows-nt)) "exec ")
4417 command " "
4418 (mapconcat
4419 (lambda (x)
4420 (setq x (mapcar (lambda (y) (format-spec y spec)) x))
4421 (unless (member "" x) (mapconcat 'identity x " ")))
4422 login-args " ")
4423 ;; Local shell could be a Windows COMSPEC. It
4424 ;; doesn't know the ";" syntax, but we must exit
4425 ;; always for `start-file-process'. "exec" does
4426 ;; not work either.
4427 (if (memq system-type '(windows-nt)) " && exit || exit")))
4428
4429 ;; Send the command.
4430 (tramp-message vec 3 "Sending command `%s'" command)
4431 (tramp-send-command vec command t t)
4432 (tramp-process-actions
4433 p vec pos tramp-actions-before-shell 60)
4434 (tramp-message
4435 vec 3 "Found remote shell prompt on `%s'" l-host))
4436 ;; Next hop.
4437 (setq target-alist (cdr target-alist)))
4438
4439 ;; Make initial shell settings.
4440 (tramp-open-connection-setup-interactive-shell p vec))))
4441
4442 ;; When the user did interrupt, we must cleanup.
4443 (quit
2fe4b125 4444 (tramp-cleanup vec)
6bdac736
MA
4445 ;; Propagate the quit signal.
4446 (signal (car err) (cdr err)))))))
03c1ad43
MA
4447
4448(defun tramp-send-command (vec command &optional neveropen nooutput)
4449 "Send the COMMAND to connection VEC.
4450Erases temporary buffer before sending the command. If optional
4451arg NEVEROPEN is non-nil, never try to open the connection. This
4452is meant to be used from `tramp-maybe-open-connection' only. The
4453function waits for output unless NOOUTPUT is set."
4454 (unless neveropen (tramp-maybe-open-connection vec))
4455 (let ((p (tramp-get-connection-process vec)))
4456 (when (tramp-get-connection-property p "remote-echo" nil)
4457 ;; We mark the command string that it can be erased in the output buffer.
4458 (tramp-set-connection-property p "check-remote-echo" t)
4459 (setq command (format "%s%s%s" tramp-echo-mark command tramp-echo-mark)))
98c8795a
MA
4460 (when (and (string-match "<<'EOF'" command)
4461 (not (tramp-get-connection-property vec "busybox" nil)))
6e060cee
MA
4462 ;; Unset $PS1 when using here documents, in order to avoid
4463 ;; multiple prompts.
01d884cf
MA
4464 (setq command (concat "(PS1= ; " command "\n)")))
4465 ;; Send the command.
03c1ad43
MA
4466 (tramp-message vec 6 "%s" command)
4467 (tramp-send-string vec command)
4468 (unless nooutput (tramp-wait-for-output p))))
4469
4470(defun tramp-wait-for-output (proc &optional timeout)
4471 "Wait for output from remote command."
4472 (unless (buffer-live-p (process-buffer proc))
4473 (delete-process proc)
4474 (tramp-error proc 'file-error "Process `%s' not available, try again" proc))
4475 (with-current-buffer (process-buffer proc)
4476 (let* (;; Initially, `tramp-end-of-output' is "#$ ". There might
4477 ;; be leading escape sequences, which must be ignored.
4478 (regexp (format "[^#$\n]*%s\r?$" (regexp-quote tramp-end-of-output)))
4479 ;; Sometimes, the commands do not return a newline but a
4480 ;; null byte before the shell prompt, for example "git
4481 ;; ls-files -c -z ...".
4482 (regexp1 (format "\\(^\\|\000\\)%s" regexp))
4483 (found (tramp-wait-for-regexp proc timeout regexp1)))
4484 (if found
4485 (let (buffer-read-only)
4486 ;; A simple-minded busybox has sent " ^H" sequences.
4487 ;; Delete them.
4488 (goto-char (point-min))
6e060cee 4489 (when (re-search-forward "^\\(.\b\\)+$" (point-at-eol) t)
03c1ad43
MA
4490 (forward-line 1)
4491 (delete-region (point-min) (point)))
4492 ;; Delete the prompt.
4493 (goto-char (point-max))
4494 (re-search-backward regexp nil t)
4495 (delete-region (point) (point-max)))
4496 (if timeout
4497 (tramp-error
4498 proc 'file-error
4499 "[[Remote prompt `%s' not found in %d secs]]"
4500 tramp-end-of-output timeout)
4501 (tramp-error
4502 proc 'file-error
4503 "[[Remote prompt `%s' not found]]" tramp-end-of-output)))
4504 ;; Return value is whether end-of-output sentinel was found.
4505 found)))
4506
4507(defun tramp-send-command-and-check
4508 (vec command &optional subshell dont-suppress-err)
4509 "Run COMMAND and check its exit status.
4510Sends `echo $?' along with the COMMAND for checking the exit status. If
4511COMMAND is nil, just sends `echo $?'. Returns the exit status found.
4512
4513If the optional argument SUBSHELL is non-nil, the command is
4514executed in a subshell, ie surrounded by parentheses. If
4515DONT-SUPPRESS-ERR is non-nil, stderr won't be sent to /dev/null."
4516 (tramp-send-command
4517 vec
4518 (concat (if subshell "( " "")
4519 command
4520 (if command (if dont-suppress-err "; " " 2>/dev/null; ") "")
4521 "echo tramp_exit_status $?"
4522 (if subshell " )" "")))
4523 (with-current-buffer (tramp-get-connection-buffer vec)
4524 (goto-char (point-max))
4525 (unless (re-search-backward "tramp_exit_status [0-9]+" nil t)
4526 (tramp-error
4527 vec 'file-error "Couldn't find exit status of `%s'" command))
4528 (skip-chars-forward "^ ")
4529 (prog1
4530 (zerop (read (current-buffer)))
4531 (let (buffer-read-only)
4532 (delete-region (match-beginning 0) (point-max))))))
4533
4534(defun tramp-barf-unless-okay (vec command fmt &rest args)
4535 "Run COMMAND, check exit status, throw error if exit status not okay.
4536Similar to `tramp-send-command-and-check' but accepts two more arguments
4537FMT and ARGS which are passed to `error'."
0b3f36df
MA
4538 (or (tramp-send-command-and-check vec command)
4539 (apply 'tramp-error vec 'file-error fmt args)))
03c1ad43 4540
6d95bd46 4541(defun tramp-send-command-and-read (vec command &optional noerror)
03c1ad43 4542 "Run COMMAND and return the output, which must be a Lisp expression.
6d95bd46
MA
4543In case there is no valid Lisp expression and NOERROR is nil, it
4544raises an error."
0b3f36df
MA
4545 (when (if noerror
4546 (tramp-send-command-and-check vec command)
4547 (tramp-barf-unless-okay
4548 vec command "`%s' returns with error" command))
4549 (with-current-buffer (tramp-get-connection-buffer vec)
4550 ;; Read the expression.
4551 (goto-char (point-min))
4552 (condition-case nil
4553 (prog1 (read (current-buffer))
4554 ;; Error handling.
4555 (when (re-search-forward "\\S-" (point-at-eol) t)
4556 (error nil)))
4557 (error (unless noerror
4558 (tramp-error
4559 vec 'file-error
4560 "`%s' does not return a valid Lisp expression: `%s'"
4561 command (buffer-string))))))))
03c1ad43 4562
03c1ad43
MA
4563(defun tramp-convert-file-attributes (vec attr)
4564 "Convert file-attributes ATTR generated by perl script, stat or ls.
4565Convert file mode bits to string and set virtual device number.
4566Return ATTR."
4567 (when attr
6d95bd46
MA
4568 ;; Remove color escape sequences from symlink.
4569 (when (stringp (car attr))
4570 (while (string-match tramp-color-escape-sequence-regexp (car attr))
4571 (setcar attr (replace-match "" nil nil (car attr)))))
03c1ad43
MA
4572 ;; Convert last access time.
4573 (unless (listp (nth 4 attr))
4574 (setcar (nthcdr 4 attr)
4575 (list (floor (nth 4 attr) 65536)
4576 (floor (mod (nth 4 attr) 65536)))))
4577 ;; Convert last modification time.
4578 (unless (listp (nth 5 attr))
4579 (setcar (nthcdr 5 attr)
4580 (list (floor (nth 5 attr) 65536)
4581 (floor (mod (nth 5 attr) 65536)))))
4582 ;; Convert last status change time.
4583 (unless (listp (nth 6 attr))
4584 (setcar (nthcdr 6 attr)
4585 (list (floor (nth 6 attr) 65536)
4586 (floor (mod (nth 6 attr) 65536)))))
4587 ;; Convert file size.
4588 (when (< (nth 7 attr) 0)
4589 (setcar (nthcdr 7 attr) -1))
4590 (when (and (floatp (nth 7 attr))
4591 (<= (nth 7 attr) (tramp-compat-most-positive-fixnum)))
4592 (setcar (nthcdr 7 attr) (round (nth 7 attr))))
4593 ;; Convert file mode bits to string.
4594 (unless (stringp (nth 8 attr))
4595 (setcar (nthcdr 8 attr) (tramp-file-mode-from-int (nth 8 attr)))
4596 (when (stringp (car attr))
4597 (aset (nth 8 attr) 0 ?l)))
4598 ;; Convert directory indication bit.
4599 (when (string-match "^d" (nth 8 attr))
4600 (setcar attr t))
4601 ;; Convert symlink from `tramp-do-file-attributes-with-stat'.
4602 (when (consp (car attr))
4603 (if (and (stringp (caar attr))
4604 (string-match ".+ -> .\\(.+\\)." (caar attr)))
4605 (setcar attr (match-string 1 (caar attr)))
4606 (setcar attr nil)))
4607 ;; Set file's gid change bit.
4608 (setcar (nthcdr 9 attr)
4609 (if (numberp (nth 3 attr))
4610 (not (= (nth 3 attr)
4611 (tramp-get-remote-gid vec 'integer)))
4612 (not (string-equal
4613 (nth 3 attr)
4614 (tramp-get-remote-gid vec 'string)))))
4615 ;; Convert inode.
4616 (unless (listp (nth 10 attr))
4617 (setcar (nthcdr 10 attr)
4618 (condition-case nil
4619 (cons (floor (nth 10 attr) 65536)
4620 (floor (mod (nth 10 attr) 65536)))
4621 ;; Inodes can be incredible huge. We must hide this.
4622 (error (tramp-get-inode vec)))))
4623 ;; Set virtual device number.
4624 (setcar (nthcdr 11 attr)
4625 (tramp-get-device vec))
4626 attr))
4627
4628(defun tramp-check-cached-permissions (vec access)
4629 "Check `file-attributes' caches for VEC.
4630Return t if according to the cache access type ACCESS is known to
4631be granted."
4632 (let ((result nil)
4633 (offset (cond
4634 ((eq ?r access) 1)
4635 ((eq ?w access) 2)
4636 ((eq ?x access) 3))))
4637 (dolist (suffix '("string" "integer") result)
4638 (setq
4639 result
4640 (or
4641 result
4642 (let ((file-attr
4643 (tramp-get-file-property
4644 vec (tramp-file-name-localname vec)
4645 (concat "file-attributes-" suffix) nil))
4646 (remote-uid
4647 (tramp-get-connection-property
4648 vec (concat "uid-" suffix) nil))
4649 (remote-gid
4650 (tramp-get-connection-property
4651 vec (concat "gid-" suffix) nil)))
4652 (and
4653 file-attr
4654 (or
4655 ;; Not a symlink
4656 (eq t (car file-attr))
4657 (null (car file-attr)))
4658 (or
4659 ;; World accessible.
4660 (eq access (aref (nth 8 file-attr) (+ offset 6)))
4661 ;; User accessible and owned by user.
4662 (and
4663 (eq access (aref (nth 8 file-attr) offset))
4664 (equal remote-uid (nth 2 file-attr)))
4665 ;; Group accessible and owned by user's
4666 ;; principal group.
4667 (and
4668 (eq access (aref (nth 8 file-attr) (+ offset 3)))
4669 (equal remote-gid (nth 3 file-attr)))))))))))
4670
4671(defun tramp-file-mode-from-int (mode)
4672 "Turn an integer representing a file mode into an ls(1)-like string."
4673 (let ((type (cdr
4674 (assoc (logand (lsh mode -12) 15) tramp-file-mode-type-map)))
4675 (user (logand (lsh mode -6) 7))
4676 (group (logand (lsh mode -3) 7))
4677 (other (logand (lsh mode -0) 7))
4678 (suid (> (logand (lsh mode -9) 4) 0))
4679 (sgid (> (logand (lsh mode -9) 2) 0))
4680 (sticky (> (logand (lsh mode -9) 1) 0)))
4681 (setq user (tramp-file-mode-permissions user suid "s"))
4682 (setq group (tramp-file-mode-permissions group sgid "s"))
4683 (setq other (tramp-file-mode-permissions other sticky "t"))
4684 (concat type user group other)))
4685
4686(defun tramp-file-mode-permissions (perm suid suid-text)
4687 "Convert a permission bitset into a string.
4688This is used internally by `tramp-file-mode-from-int'."
4689 (let ((r (> (logand perm 4) 0))
4690 (w (> (logand perm 2) 0))
4691 (x (> (logand perm 1) 0)))
4692 (concat (or (and r "r") "-")
4693 (or (and w "w") "-")
4694 (or (and suid x suid-text) ; suid, execute
4695 (and suid (upcase suid-text)) ; suid, !execute
4696 (and x "x") "-")))) ; !suid
4697
4698(defun tramp-shell-case-fold (string)
4699 "Converts STRING to shell glob pattern which ignores case."
4700 (mapconcat
4701 (lambda (c)
4702 (if (equal (downcase c) (upcase c))
4703 (vector c)
4704 (format "[%c%c]" (downcase c) (upcase c))))
4705 string
4706 ""))
4707
4708(defun tramp-make-copy-program-file-name (vec)
4709 "Create a file name suitable to be passed to `rcp' and workalikes."
4710 (let ((user (tramp-file-name-user vec))
4711 (host (tramp-file-name-real-host vec))
4712 (localname (tramp-shell-quote-argument
4713 (tramp-file-name-localname vec))))
4714 (if (not (zerop (length user)))
4715 (format "%s@%s:%s" user host localname)
4716 (format "%s:%s" host localname))))
4717
4718(defun tramp-method-out-of-band-p (vec size)
4719 "Return t if this is an out-of-band method, nil otherwise."
4720 (and
4721 ;; It shall be an out-of-band method.
4722 (tramp-get-method-parameter (tramp-file-name-method vec) 'tramp-copy-program)
d59eb518
MA
4723 ;; There must be a size, otherwise the file doesn't exist.
4724 (numberp size)
03c1ad43
MA
4725 ;; Either the file size is large enough, or (in rare cases) there
4726 ;; does not exist a remote encoding.
4727 (or (null tramp-copy-size-limit)
4728 (> size tramp-copy-size-limit)
4729 (null (tramp-get-inline-coding vec "remote-encoding" size)))))
4730
03c1ad43
MA
4731;; Variables local to connection.
4732
4733(defun tramp-get-remote-path (vec)
4734 (with-connection-property
4735 ;; When `tramp-own-remote-path' is in `tramp-remote-path', we
4736 ;; cache the result for the session only. Otherwise, the result
4737 ;; is cached persistently.
4738 (if (memq 'tramp-own-remote-path tramp-remote-path)
4739 (tramp-get-connection-process vec)
4740 vec)
4741 "remote-path"
4742 (let* ((remote-path (copy-tree tramp-remote-path))
4743 (elt1 (memq 'tramp-default-remote-path remote-path))
4744 (elt2 (memq 'tramp-own-remote-path remote-path))
4745 (default-remote-path
4746 (when elt1
a857d3c7
MA
4747 (or
4748 (tramp-send-command-and-read
6d95bd46 4749 vec "echo \\\"`getconf PATH 2>/dev/null`\\\"" 'noerror)
a857d3c7
MA
4750 ;; Default if "getconf" is not available.
4751 (progn
03c1ad43
MA
4752 (tramp-message
4753 vec 3
4754 "`getconf PATH' not successful, using default value \"%s\"."
4755 "/bin:/usr/bin")
4756 "/bin:/usr/bin"))))
4757 (own-remote-path
4758 (when elt2
4759 (condition-case nil
4760 (tramp-send-command-and-read vec "echo \\\"$PATH\\\"")
03c1ad43
MA
4761 (error
4762 (tramp-message
4763 vec 3 "$PATH not set, ignoring `tramp-own-remote-path'.")
4764 nil)))))
4765
4766 ;; Replace place holder `tramp-default-remote-path'.
4767 (when elt1
4768 (setcdr elt1
4769 (append
4770 (tramp-compat-split-string default-remote-path ":")
4771 (cdr elt1)))
4772 (setq remote-path (delq 'tramp-default-remote-path remote-path)))
4773
4774 ;; Replace place holder `tramp-own-remote-path'.
4775 (when elt2
4776 (setcdr elt2
4777 (append
4778 (tramp-compat-split-string own-remote-path ":")
4779 (cdr elt2)))
4780 (setq remote-path (delq 'tramp-own-remote-path remote-path)))
4781
4782 ;; Remove double entries.
4783 (setq elt1 remote-path)
4784 (while (consp elt1)
4785 (while (and (car elt1) (setq elt2 (member (car elt1) (cdr elt1))))
4786 (setcar elt2 nil))
4787 (setq elt1 (cdr elt1)))
4788
4789 ;; Remove non-existing directories.
4790 (delq
4791 nil
4792 (mapcar
4793 (lambda (x)
4794 (and
4795 (stringp x)
4796 (file-directory-p
4797 (tramp-make-tramp-file-name
4798 (tramp-file-name-method vec)
4799 (tramp-file-name-user vec)
4800 (tramp-file-name-host vec)
4801 x))
4802 x))
4803 remote-path)))))
4804
03c1ad43
MA
4805(defun tramp-get-ls-command (vec)
4806 (with-connection-property vec "ls"
4807 (tramp-message vec 5 "Finding a suitable `ls' command")
4808 (or
4809 (catch 'ls-found
4810 (dolist (cmd '("ls" "gnuls" "gls"))
4811 (let ((dl (tramp-get-remote-path vec))
4812 result)
4813 (while (and dl (setq result (tramp-find-executable vec cmd dl t t)))
4814 ;; Check parameters. On busybox, "ls" output coloring is
4815 ;; enabled by default sometimes. So we try to disable it
4816 ;; when possible. $LS_COLORING is not supported there.
4817 ;; Some "ls" versions are sensible wrt the order of
4818 ;; arguments, they fail when "-al" is after the
4819 ;; "--color=never" argument (for example on FreeBSD).
4820 (when (tramp-send-command-and-check
4821 vec (format "%s -lnd /" result))
4822 (when (tramp-send-command-and-check
4823 vec (format
4824 "%s --color=never -al /dev/null" result))
4825 (setq result (concat result " --color=never")))
4826 (throw 'ls-found result))
4827 (setq dl (cdr dl))))))
4828 (tramp-error vec 'file-error "Couldn't find a proper `ls' command"))))
4829
4830(defun tramp-get-ls-command-with-dired (vec)
4831 (save-match-data
4832 (with-connection-property vec "ls-dired"
4833 (tramp-message vec 5 "Checking, whether `ls --dired' works")
4834 ;; Some "ls" versions are sensible wrt the order of arguments,
4835 ;; they fail when "-al" is after the "--dired" argument (for
4836 ;; example on FreeBSD).
4837 (tramp-send-command-and-check
4838 vec (format "%s --dired -al /dev/null" (tramp-get-ls-command vec))))))
4839
4840(defun tramp-get-test-command (vec)
4841 (with-connection-property vec "test"
4842 (tramp-message vec 5 "Finding a suitable `test' command")
4843 (if (tramp-send-command-and-check vec "test 0")
4844 "test"
4845 (tramp-find-executable vec "test" (tramp-get-remote-path vec)))))
4846
4847(defun tramp-get-test-nt-command (vec)
4848 ;; Does `test A -nt B' work? Use abominable `find' construct if it
4849 ;; doesn't. BSD/OS 4.0 wants the parentheses around the command,
4850 ;; for otherwise the shell crashes.
4851 (with-connection-property vec "test-nt"
4852 (or
4853 (progn
4854 (tramp-send-command
4855 vec (format "( %s / -nt / )" (tramp-get-test-command vec)))
4856 (with-current-buffer (tramp-get-buffer vec)
4857 (goto-char (point-min))
4858 (when (looking-at (regexp-quote tramp-end-of-output))
4859 (format "%s %%s -nt %%s" (tramp-get-test-command vec)))))
4860 (progn
4861 (tramp-send-command
4862 vec
4863 (format
4864 "tramp_test_nt () {\n%s -n \"`find $1 -prune -newer $2 -print`\"\n}"
4865 (tramp-get-test-command vec)))
4866 "tramp_test_nt %s %s"))))
4867
4868(defun tramp-get-file-exists-command (vec)
4869 (with-connection-property vec "file-exists"
4870 (tramp-message vec 5 "Finding command to check if file exists")
4871 (tramp-find-file-exists-command vec)))
4872
4873(defun tramp-get-remote-ln (vec)
4874 (with-connection-property vec "ln"
4875 (tramp-message vec 5 "Finding a suitable `ln' command")
4876 (tramp-find-executable vec "ln" (tramp-get-remote-path vec))))
4877
4878(defun tramp-get-remote-perl (vec)
4879 (with-connection-property vec "perl"
4880 (tramp-message vec 5 "Finding a suitable `perl' command")
4881 (let ((result
4882 (or (tramp-find-executable vec "perl5" (tramp-get-remote-path vec))
4883 (tramp-find-executable
4884 vec "perl" (tramp-get-remote-path vec)))))
4885 ;; We must check also for some Perl modules.
4886 (when result
4887 (with-connection-property vec "perl-file-spec"
4888 (tramp-send-command-and-check
4889 vec (format "%s -e 'use File::Spec;'" result)))
4890 (with-connection-property vec "perl-cwd-realpath"
4891 (tramp-send-command-and-check
4892 vec (format "%s -e 'use Cwd \"realpath\";'" result))))
4893 result)))
4894
4895(defun tramp-get-remote-stat (vec)
4896 (with-connection-property vec "stat"
4897 (tramp-message vec 5 "Finding a suitable `stat' command")
4898 (let ((result (tramp-find-executable
4899 vec "stat" (tramp-get-remote-path vec)))
4900 tmp)
6d95bd46 4901 ;; Check whether stat(1) returns usable syntax. "%s" does not
03c1ad43
MA
4902 ;; work on older AIX systems.
4903 (when result
4904 (setq tmp
6d95bd46
MA
4905 (tramp-send-command-and-read
4906 vec (format "%s -c '(\"%%N\" %%s)' /" result) 'noerror))
03c1ad43
MA
4907 (unless (and (listp tmp) (stringp (car tmp))
4908 (string-match "^./.$" (car tmp))
4909 (integerp (cadr tmp)))
4910 (setq result nil)))
4911 result)))
4912
4913(defun tramp-get-remote-readlink (vec)
4914 (with-connection-property vec "readlink"
4915 (tramp-message vec 5 "Finding a suitable `readlink' command")
4916 (let ((result (tramp-find-executable
4917 vec "readlink" (tramp-get-remote-path vec))))
4918 (when (and result
6d95bd46
MA
4919 (tramp-send-command-and-check
4920 vec (format "%s --canonicalize-missing /" result)))
03c1ad43
MA
4921 result))))
4922
4923(defun tramp-get-remote-trash (vec)
4924 (with-connection-property vec "trash"
4925 (tramp-message vec 5 "Finding a suitable `trash' command")
4926 (tramp-find-executable vec "trash" (tramp-get-remote-path vec))))
4927
4928(defun tramp-get-remote-id (vec)
4929 (with-connection-property vec "id"
4930 (tramp-message vec 5 "Finding POSIX `id' command")
4931 (or
4932 (catch 'id-found
4933 (let ((dl (tramp-get-remote-path vec))
4934 result)
4935 (while (and dl (setq result (tramp-find-executable vec "id" dl t t)))
4936 ;; Check POSIX parameter.
4937 (when (tramp-send-command-and-check vec (format "%s -u" result))
4938 (throw 'id-found result))
4939 (setq dl (cdr dl)))))
4940 (tramp-error vec 'file-error "Couldn't find a POSIX `id' command"))))
4941
4942(defun tramp-get-remote-uid (vec id-format)
4943 (with-connection-property vec (format "uid-%s" id-format)
4944 (let ((res (tramp-send-command-and-read
4945 vec
4946 (format "%s -u%s %s"
4947 (tramp-get-remote-id vec)
4948 (if (equal id-format 'integer) "" "n")
4949 (if (equal id-format 'integer)
4950 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
4951 ;; The command might not always return a number.
4952 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
4953
4954(defun tramp-get-remote-gid (vec id-format)
4955 (with-connection-property vec (format "gid-%s" id-format)
4956 (let ((res (tramp-send-command-and-read
4957 vec
4958 (format "%s -g%s %s"
4959 (tramp-get-remote-id vec)
4960 (if (equal id-format 'integer) "" "n")
4961 (if (equal id-format 'integer)
4962 "" "| sed -e s/^/\\\"/ -e s/\$/\\\"/")))))
4963 ;; The command might not always return a number.
4964 (if (and (equal id-format 'integer) (not (integerp res))) -1 res))))
4965
4966(defun tramp-get-local-uid (id-format)
4967 (if (equal id-format 'integer) (user-uid) (user-login-name)))
4968
4969(defun tramp-get-local-gid (id-format)
4970 (nth 3 (tramp-compat-file-attributes "~/" id-format)))
4971
4972;; Some predefined connection properties.
4973(defun tramp-get-inline-compress (vec prop size)
4974 "Return the compress command related to PROP.
4975PROP is either `inline-compress' or `inline-decompress'. SIZE is
4976the length of the file to be compressed.
4977
4978If no corresponding command is found, nil is returned."
4979 (when (and (integerp tramp-inline-compress-start-size)
4980 (> size tramp-inline-compress-start-size))
2fe4b125 4981 (with-connection-property (tramp-get-connection-process vec) prop
03c1ad43 4982 (tramp-find-inline-compress vec)
2fe4b125
MA
4983 (tramp-get-connection-property
4984 (tramp-get-connection-process vec) prop nil))))
03c1ad43
MA
4985
4986(defun tramp-get-inline-coding (vec prop size)
4987 "Return the coding command related to PROP.
40ba43b4 4988PROP is either `remote-encoding', `remote-decoding',
03c1ad43
MA
4989`local-encoding' or `local-decoding'.
4990
4991SIZE is the length of the file to be coded. Depending on SIZE,
4992compression might be applied.
4993
4994If no corresponding command is found, nil is returned.
4995Otherwise, either a string is returned which contains a `%s' mark
4996to be used for the respective input or output file; or a Lisp
4997function cell is returned to be applied on a buffer."
01d884cf
MA
4998 ;; We must catch the errors, because we want to return `nil', when
4999 ;; no inline coding is found.
5000 (ignore-errors
5001 (let ((coding
2fe4b125 5002 (with-connection-property (tramp-get-connection-process vec) prop
01d884cf 5003 (tramp-find-inline-encoding vec)
2fe4b125
MA
5004 (tramp-get-connection-property
5005 (tramp-get-connection-process vec) prop nil)))
01d884cf
MA
5006 (prop1 (if (string-match "encoding" prop)
5007 "inline-compress" "inline-decompress"))
5008 compress)
5009 ;; The connection property might have been cached. So we must
5010 ;; send the script to the remote side - maybe.
5011 (when (and coding (symbolp coding) (string-match "remote" prop))
5012 (let ((name (symbol-name coding)))
5013 (while (string-match (regexp-quote "-") name)
5014 (setq name (replace-match "_" nil t name)))
5015 (tramp-maybe-send-script vec (symbol-value coding) name)
5016 (setq coding name)))
5017 (when coding
5018 ;; Check for the `compress' command.
5019 (setq compress (tramp-get-inline-compress vec prop1 size))
5020 ;; Return the value.
5021 (cond
5022 ((and compress (symbolp coding))
5023 (if (string-match "decompress" prop1)
5024 `(lambda (beg end)
5025 (,coding beg end)
5026 (let ((coding-system-for-write 'binary)
5027 (coding-system-for-read 'binary))
5028 (apply
5029 'call-process-region (point-min) (point-max)
5030 (car (split-string ,compress)) t t nil
5031 (cdr (split-string ,compress)))))
03c1ad43 5032 `(lambda (beg end)
03c1ad43
MA
5033 (let ((coding-system-for-write 'binary)
5034 (coding-system-for-read 'binary))
5035 (apply
01d884cf 5036 'call-process-region beg end
03c1ad43 5037 (car (split-string ,compress)) t t nil
01d884cf
MA
5038 (cdr (split-string ,compress))))
5039 (,coding (point-min) (point-max)))))
5040 ((symbolp coding)
5041 coding)
5042 ((and compress (string-match "decoding" prop))
362b9d48
GM
5043 (format
5044 ;; Windows shells need the program file name after
5045 ;; the pipe symbol be quoted if they use forward
5046 ;; slashes as directory separators.
5047 (if (and (string-match "local" prop)
5048 (memq system-type '(windows-nt)))
5049 "(%s | \"%s\" >%%s)"
5050 "(%s | %s >%%s)")
5051 coding compress))
01d884cf 5052 (compress
362b9d48
GM
5053 (format
5054 ;; Windows shells need the program file name after
5055 ;; the pipe symbol be quoted if they use forward
5056 ;; slashes as directory separators.
5057 (if (and (string-match "local" prop)
5058 (memq system-type '(windows-nt)))
5059 "(%s <%%s | \"%s\")"
5060 "(%s <%%s | %s)")
5061 compress coding))
01d884cf
MA
5062 ((string-match "decoding" prop)
5063 (format "%s >%%s" coding))
5064 (t
5065 (format "%s <%%s" coding)))))))
03c1ad43
MA
5066
5067;;; Integration of eshell.el:
5068
5069(eval-when-compile
5070 (defvar eshell-path-env))
5071
5072;; eshell.el keeps the path in `eshell-path-env'. We must change it
5073;; when `default-directory' points to another host.
5074(defun tramp-eshell-directory-change ()
5075 "Set `eshell-path-env' to $PATH of the host related to `default-directory'."
5076 (setq eshell-path-env
5077 (if (file-remote-p default-directory)
5078 (with-parsed-tramp-file-name default-directory nil
5079 (mapconcat
5080 'identity
5081 (tramp-get-remote-path v)
5082 ":"))
5083 (getenv "PATH"))))
5084
5085(eval-after-load "esh-util"
5086 '(progn
5087 (tramp-eshell-directory-change)
5088 (add-hook 'eshell-directory-change-hook
5089 'tramp-eshell-directory-change)
5090 (add-hook 'tramp-unload-hook
5091 (lambda ()
5092 (remove-hook 'eshell-directory-change-hook
5093 'tramp-eshell-directory-change)))))
5094
5095(add-hook 'tramp-unload-hook
5096 (lambda ()
5097 (unload-feature 'tramp-sh 'force)))
5098
5099(provide 'tramp-sh)
5100
5101;;; TODO:
5102
5103;; * Don't use globbing for directories with many files, as this is
5104;; likely to produce long command lines, and some shells choke on
5105;; long command lines.
5106;; * Make it work for different encodings, and for different file name
5107;; encodings, too. (Daniel Pittman)
5108;; * Don't search for perl5 and perl. Instead, only search for perl and
5109;; then look if it's the right version (with `perl -v').
5110;; * When editing a remote CVS controlled file as a different user, VC
5111;; gets confused about the file locking status. Try to find out why
5112;; the workaround doesn't work.
5113;; * Allow out-of-band methods as _last_ multi-hop. Open a connection
5114;; until the last but one hop via `start-file-process'. Apply it
5115;; also for ftp and smb.
5116;; * WIBNI if we had a command "trampclient"? If I was editing in
e1dbe924 5117;; some shell with root privileges, it would be nice if I could
03c1ad43
MA
5118;; just call
5119;; trampclient filename.c
5120;; as an editor, and the _current_ shell would connect to an Emacs
e1dbe924 5121;; server and would be used in an existing non-privileged Emacs
03c1ad43
MA
5122;; session for doing the editing in question.
5123;; That way, I need not tell Emacs my password again and be afraid
5124;; that it makes it into core dumps or other ugly stuff (I had Emacs
5125;; once display a just typed password in the context of a keyboard
5126;; sequence prompt for a question immediately following in a shell
5127;; script run within Emacs -- nasty).
5128;; And if I have some ssh session running to a different computer,
5129;; having the possibility of passing a local file there to a local
5130;; Emacs session (in case I can arrange for a connection back) would
5131;; be nice.
5132;; Likely the corresponding Tramp server should not allow the
5133;; equivalent of the emacsclient -eval option in order to make this
5134;; reasonably unproblematic. And maybe trampclient should have some
5135;; way of passing credentials, like by using an SSL socket or
5136;; something. (David Kastrup)
5137;; * Reconnect directly to a compliant shell without first going
5138;; through the user's default shell. (Pete Forman)
5139;; * How can I interrupt the remote process with a signal
5140;; (interrupt-process seems not to work)? (Markus Triska)
5141;; * Avoid the local shell entirely for starting remote processes. If
5142;; so, I think even a signal, when delivered directly to the local
5143;; SSH instance, would correctly be propagated to the remote process
5144;; automatically; possibly SSH would have to be started with
5145;; "-t". (Markus Triska)
5146;; * It makes me wonder if tramp couldn't fall back to ssh when scp
5147;; isn't on the remote host. (Mark A. Hershberger)
5148;; * Use lsh instead of ssh. (Alfred M. Szmidt)
2c68ca0e 5149;; * Optimize out-of-band copying when both methods are scp-like (not
03c1ad43
MA
5150;; rsync).
5151;; * Keep a second connection open for out-of-band methods like scp or
5152;; rsync.
5153;; * Try telnet+curl as new method. It might be useful for busybox,
5154;; without built-in uuencode/uudecode.
5155
5156;;; tramp-sh.el ends here