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