tramp-sh.el 224 KB
Newer Older
Michael Albinus's avatar
Michael Albinus committed
1
;;; tramp-sh.el --- Tramp access functions for (s)sh-like connections  -*- lexical-binding:t -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1998-2018 Free Software Foundation, Inc.
4 5 6 7 8

;; (copyright statements below in code to be updated with the above notice)

;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
;;         Michael Albinus <michael.albinus@gmx.de>
9
;; Maintainer: Michael Albinus <michael.albinus@gmx.de>
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
;; Keywords: comm, processes
;; Package: tramp

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
26
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
27 28 29

;;; Code:

30
(eval-when-compile (require 'cl-lib))
31 32
(require 'tramp)

Michael Albinus's avatar
Michael Albinus committed
33 34
;; Pacify byte-compiler.
(eval-when-compile
Michael Albinus's avatar
Michael Albinus committed
35
  (require 'dired))
Michael Albinus's avatar
Michael Albinus committed
36 37 38

(declare-function dired-remove-file "dired-aux")
(defvar dired-compress-file-suffixes)
39 40 41 42
(defvar vc-handled-backends)
(defvar vc-bzr-program)
(defvar vc-git-program)
(defvar vc-hg-program)
43

44
;;;###tramp-autoload
45
(defcustom tramp-inline-compress-start-size 4096
46
  "The minimum size of compressing where inline transfer.
Paul Eggert's avatar
Paul Eggert committed
47
When inline transfer, compress transferred data of file
48 49 50
whose size is this value or above (up to `tramp-copy-size-limit').
If it is nil, no compression at all will be applied."
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
51
  :type '(choice (const nil) integer))
52

53
;;;###tramp-autoload
54
(defcustom tramp-copy-size-limit 10240
Michael Albinus's avatar
Michael Albinus committed
55 56 57
  "The maximum file size where inline copying is preferred over an \
out-of-the-band copy.
If it is nil, out-of-the-band copy will be used without a check."
58
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
59
  :type '(choice (const nil) integer))
60 61 62

;;;###tramp-autoload
(defcustom tramp-terminal-type "dumb"
63
  "Value of TERM environment variable for logging in to remote host.
64 65 66 67
Because Tramp wants to parse the output of the remote shell, it is easily
confused by ANSI color escape sequences and suchlike.  Often, shell init
files conditionalize this setup based on the TERM environment variable."
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
68
  :type 'string)
69

70
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
71
(defcustom tramp-histfile-override "~/.tramp_history"
72
  "When invoking a shell, override the HISTFILE with this value.
73 74 75
When setting to a string, it redirects the shell history to that
file.  Be careful when setting to \"/dev/null\"; this might
result in undesired results when using \"bash\" as shell.
76

Michael Albinus's avatar
Michael Albinus committed
77 78 79 80
The value t unsets any setting of HISTFILE, and sets both
HISTFILESIZE and HISTSIZE to 0.  If you set this variable to nil,
however, the *override* is disabled, so the history will go to
the default storage location, e.g. \"$HOME/.sh_history\"."
81
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
82
  :version "25.2"
83
  :type '(choice (const :tag "Do not override HISTFILE" nil)
84
                 (const :tag "Unset HISTFILE" t)
Michael Albinus's avatar
Michael Albinus committed
85
                 (string :tag "Redirect to a file")))
86

87
;;;###tramp-autoload
Michael Albinus's avatar
Michael Albinus committed
88 89 90 91 92 93
(defconst tramp-display-escape-sequence-regexp "\e[[;0-9]+m"
  "Terminal control escape sequences for display attributes.")

;;;###tramp-autoload
(defconst tramp-device-escape-sequence-regexp "\e[[0-9]+n"
  "Terminal control escape sequences for device status.")
94

95
;; ksh on OpenBSD 4.5 requires that $PS1 contains a `#' character for
96
;; root users.  It uses the `$' character for other users.  In order
97
;; to guarantee a proper prompt, we use "#$ " for the prompt.
98 99 100 101 102 103

(defvar tramp-end-of-output
  (format
   "///%s#$"
   (md5 (concat (prin1-to-string process-environment) (current-time-string))))
  "String used to recognize end of output.
104
The `$' character at the end is quoted; the string cannot be
105 106 107 108 109 110
detected as prompt when being sent on echoing hosts, therefore.")

;;;###tramp-autoload
(defconst tramp-initial-end-of-output "#$ "
  "Prompt when establishing a connection.")

111 112 113
(defconst tramp-end-of-heredoc (md5 tramp-end-of-output)
  "String used to recognize end of heredoc strings.")

114 115 116 117 118
;;;###tramp-autoload
(defcustom tramp-use-ssh-controlmaster-options t
  "Whether to use `tramp-ssh-controlmaster-options'."
  :group 'tramp
  :version "24.4"
Michael Albinus's avatar
Michael Albinus committed
119
  :type 'boolean)
120 121 122 123 124

(defvar tramp-ssh-controlmaster-options nil
  "Which ssh Control* arguments to use.

If it is a string, it should have the form
125
\"-o ControlMaster=auto -o ControlPath=\\='tramp.%%r@%%h:%%p\\='
126 127 128 129 130 131 132 133 134
-o ControlPersist=no\".  Percent characters in the ControlPath
spec must be doubled, because the string is used as format string.

Otherwise, it will be auto-detected by Tramp, if
`tramp-use-ssh-controlmaster-options' is non-nil.  The value
depends on the installed local ssh version.

The string is used in `tramp-methods'.")

135 136 137 138 139 140
;; Initialize `tramp-methods' with the supported methods.
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("rcp"
    (tramp-login-program        "rsh")
    (tramp-login-args           (("%h") ("-l" "%u")))
141
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
142
    (tramp-remote-shell-login   ("-l"))
143
    (tramp-remote-shell-args    ("-c"))
144
    (tramp-copy-program         "rcp")
Michael Albinus's avatar
Michael Albinus committed
145
    (tramp-copy-args            (("-p" "%k") ("-r")))
146 147 148 149 150 151 152
    (tramp-copy-keep-date       t)
    (tramp-copy-recursive       t)))
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("remcp"
    (tramp-login-program        "remsh")
    (tramp-login-args           (("%h") ("-l" "%u")))
153
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
154
    (tramp-remote-shell-login   ("-l"))
155
    (tramp-remote-shell-args    ("-c"))
156
    (tramp-copy-program         "rcp")
Michael Albinus's avatar
Michael Albinus committed
157
    (tramp-copy-args            (("-p" "%k")))
158 159
    (tramp-copy-keep-date       t)))
;;;###tramp-autoload
160
(add-to-list 'tramp-methods
161
  '("scp"
162
    (tramp-login-program        "ssh")
163
    (tramp-login-args           (("-l" "%u") ("-p" "%p") ("%c")
164
				 ("-e" "none") ("%h")))
165
    (tramp-async-args           (("-q")))
166
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
167
    (tramp-remote-shell-login   ("-l"))
168
    (tramp-remote-shell-args    ("-c"))
169
    (tramp-copy-program         "scp")
170
    (tramp-copy-args            (("-P" "%p") ("-p" "%k") ("-q") ("-r") ("%c")))
171
    (tramp-copy-keep-date       t)
172
    (tramp-copy-recursive       t)))
173 174
;;;###tramp-autoload
(add-to-list 'tramp-methods
175
  '("scpx"
176
    (tramp-login-program        "ssh")
177
    (tramp-login-args           (("-l" "%u") ("-p" "%p") ("%c")
178
				 ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh")))
179
    (tramp-async-args           (("-q")))
180
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
181
    (tramp-remote-shell-login   ("-l"))
182
    (tramp-remote-shell-args    ("-c"))
183
    (tramp-copy-program         "scp")
184 185
    (tramp-copy-args            (("-P" "%p") ("-p" "%k")
				 ("-q") ("-r") ("%c")))
186
    (tramp-copy-keep-date       t)
187
    (tramp-copy-recursive       t)))
188 189
;;;###tramp-autoload
(add-to-list 'tramp-methods
190
  '("rsync"
191
    (tramp-login-program        "ssh")
192
    (tramp-login-args           (("-l" "%u") ("-p" "%p") ("%c")
193 194
				 ("-e" "none") ("%h")))
    (tramp-async-args           (("-q")))
195
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
196
    (tramp-remote-shell-login   ("-l"))
197
    (tramp-remote-shell-args    ("-c"))
198
    (tramp-copy-program         "rsync")
199
    (tramp-copy-args            (("-t" "%k") ("-p") ("-r") ("-s") ("-c")))
200
    (tramp-copy-env             (("RSYNC_RSH") ("ssh" "%c")))
201 202 203 204 205 206 207 208
    (tramp-copy-keep-date       t)
    (tramp-copy-keep-tmpfile    t)
    (tramp-copy-recursive       t)))
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("rsh"
    (tramp-login-program        "rsh")
    (tramp-login-args           (("%h") ("-l" "%u")))
209
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
210
    (tramp-remote-shell-login   ("-l"))
211
    (tramp-remote-shell-args    ("-c"))))
212 213 214 215 216
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("remsh"
    (tramp-login-program        "remsh")
    (tramp-login-args           (("%h") ("-l" "%u")))
217
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
218
    (tramp-remote-shell-login   ("-l"))
219
    (tramp-remote-shell-args    ("-c"))))
220 221
;;;###tramp-autoload
(add-to-list 'tramp-methods
222
  '("ssh"
223
    (tramp-login-program        "ssh")
224
    (tramp-login-args           (("-l" "%u") ("-p" "%p") ("%c")
225
				 ("-e" "none") ("%h")))
226
    (tramp-async-args           (("-q")))
227
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
228
    (tramp-remote-shell-login   ("-l"))
229
    (tramp-remote-shell-args    ("-c"))))
230 231
;;;###tramp-autoload
(add-to-list 'tramp-methods
232
  '("sshx"
233
    (tramp-login-program        "ssh")
234
    (tramp-login-args           (("-l" "%u") ("-p" "%p") ("%c")
235
				 ("-e" "none") ("-t" "-t") ("%h") ("/bin/sh")))
236
    (tramp-async-args           (("-q")))
237
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
238
    (tramp-remote-shell-login   ("-l"))
239
    (tramp-remote-shell-args    ("-c"))))
240 241 242 243
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("telnet"
    (tramp-login-program        "telnet")
244
    (tramp-login-args           (("%h") ("%p") ("2>/dev/null")))
245
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
246
    (tramp-remote-shell-login   ("-l"))
247
    (tramp-remote-shell-args    ("-c"))))
248
;;;###tramp-autoload
249 250 251 252 253
(add-to-list 'tramp-methods
  '("nc"
    (tramp-login-program        "telnet")
    (tramp-login-args           (("%h") ("%p") ("2>/dev/null")))
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
254
    (tramp-remote-shell-login   ("-l"))
255 256 257 258 259 260 261 262
    (tramp-remote-shell-args    ("-c"))
    (tramp-copy-program         "nc")
    ;; We use "-v" for better error tracking.
    (tramp-copy-args            (("-w" "1") ("-v") ("%h") ("%r")))
    (tramp-remote-copy-program  "nc")
    ;; We use "-p" as required for newer busyboxes.  For older
    ;; busybox/nc versions, the value must be (("-l") ("%r")).  This
    ;; can be achieved by tweaking `tramp-connection-properties'.
263
    (tramp-remote-copy-args     (("-l") ("-p" "%r") ("2>/dev/null")))))
264
;;;###tramp-autoload
265 266 267 268
(add-to-list 'tramp-methods
  '("su"
    (tramp-login-program        "su")
    (tramp-login-args           (("-") ("%u")))
269
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
270
    (tramp-remote-shell-login   ("-l"))
271 272
    (tramp-remote-shell-args    ("-c"))
    (tramp-connection-timeout   10)))
273
;;;###tramp-autoload
274 275 276 277 278 279 280
(add-to-list 'tramp-methods
  '("sg"
    (tramp-login-program        "sg")
    (tramp-login-args           (("-") ("%u")))
    (tramp-remote-shell         "/bin/sh")
    (tramp-remote-shell-args    ("-c"))
    (tramp-connection-timeout   10)))
Michael Albinus's avatar
Michael Albinus committed
281
;;;###tramp-autoload
282 283 284
(add-to-list 'tramp-methods
  '("sudo"
    (tramp-login-program        "sudo")
285 286 287 288
    ;; The password template must be masked.  Otherwise, it could be
    ;; interpreted as password prompt if the remote host echoes the command.
    (tramp-login-args           (("-u" "%u") ("-s") ("-H")
				 ("-p" "P\"\"a\"\"s\"\"s\"\"w\"\"o\"\"r\"\"d\"\":")))
289 290
    ;; Local $SHELL could be a nasty one, like zsh or fish.  Let's override it.
    (tramp-login-env            (("SHELL") ("/bin/sh")))
291
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
292
    (tramp-remote-shell-login   ("-l"))
293
    (tramp-remote-shell-args    ("-c"))
294 295
    (tramp-connection-timeout   10)
    (tramp-session-timeout      300)))
296
;;;###tramp-autoload
297 298 299 300 301
(add-to-list 'tramp-methods
  '("doas"
    (tramp-login-program        "doas")
    (tramp-login-args           (("-u" "%u") ("-s")))
    (tramp-remote-shell         "/bin/sh")
302
    (tramp-remote-shell-args    ("-c"))
303 304
    (tramp-connection-timeout   10)
    (tramp-session-timeout      300)))
305
;;;###tramp-autoload
306 307 308 309
(add-to-list 'tramp-methods
  '("ksu"
    (tramp-login-program        "ksu")
    (tramp-login-args           (("%u") ("-q")))
310
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
311
    (tramp-remote-shell-login   ("-l"))
312 313
    (tramp-remote-shell-args    ("-c"))
    (tramp-connection-timeout   10)))
314
;;;###tramp-autoload
315 316 317 318
(add-to-list 'tramp-methods
  '("krlogin"
    (tramp-login-program        "krlogin")
    (tramp-login-args           (("%h") ("-l" "%u") ("-x")))
319
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
320
    (tramp-remote-shell-login   ("-l"))
321
    (tramp-remote-shell-args    ("-c"))))
322 323
;;;###tramp-autoload
(add-to-list 'tramp-methods
324
  `("plink"
325
    (tramp-login-program        "plink")
326 327 328 329 330 331 332
    (tramp-login-args           (("-l" "%u") ("-P" "%p") ("-ssh") ("-t")
				 ("%h") ("\"")
				 (,(format
				    "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
				    tramp-terminal-type
				    tramp-initial-end-of-output))
				 ("/bin/sh") ("\"")))
333
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
334
    (tramp-remote-shell-login   ("-l"))
335
    (tramp-remote-shell-args    ("-c"))))
336 337 338 339
;;;###tramp-autoload
(add-to-list 'tramp-methods
  `("plinkx"
    (tramp-login-program        "plink")
340
    (tramp-login-args           (("-load") ("%h") ("-t") ("\"")
341 342 343 344
				 (,(format
				    "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
				    tramp-terminal-type
				    tramp-initial-end-of-output))
345
				 ("/bin/sh") ("\"")))
346
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
347
    (tramp-remote-shell-login   ("-l"))
348
    (tramp-remote-shell-args    ("-c"))))
349 350
;;;###tramp-autoload
(add-to-list 'tramp-methods
351
  `("pscp"
352
    (tramp-login-program        "plink")
353 354 355 356 357 358 359
    (tramp-login-args           (("-l" "%u") ("-P" "%p") ("-ssh") ("-t")
				 ("%h") ("\"")
				 (,(format
				    "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
				    tramp-terminal-type
				    tramp-initial-end-of-output))
				 ("/bin/sh") ("\"")))
360
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
361
    (tramp-remote-shell-login   ("-l"))
362
    (tramp-remote-shell-args    ("-c"))
363
    (tramp-copy-program         "pscp")
364
    (tramp-copy-args            (("-l" "%u") ("-P" "%p") ("-scp") ("-p" "%k")
365
				 ("-q") ("-r")))
366
    (tramp-copy-keep-date       t)
367
    (tramp-copy-recursive       t)))
368 369
;;;###tramp-autoload
(add-to-list 'tramp-methods
370
  `("psftp"
371
    (tramp-login-program        "plink")
372 373 374 375 376 377 378
    (tramp-login-args           (("-l" "%u") ("-P" "%p") ("-ssh") ("-t")
				 ("%h") ("\"")
				 (,(format
				    "env 'TERM=%s' 'PROMPT_COMMAND=' 'PS1=%s'"
				    tramp-terminal-type
				    tramp-initial-end-of-output))
				 ("/bin/sh") ("\"")))
379
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
380
    (tramp-remote-shell-login   ("-l"))
381
    (tramp-remote-shell-args    ("-c"))
382
    (tramp-copy-program         "pscp")
383
    (tramp-copy-args            (("-l" "%u") ("-P" "%p") ("-sftp") ("-p" "%k")
384 385
				 ("-q")))
    (tramp-copy-keep-date       t)))
386 387 388 389 390
;;;###tramp-autoload
(add-to-list 'tramp-methods
  '("fcp"
    (tramp-login-program        "fsh")
    (tramp-login-args           (("%h") ("-l" "%u") ("sh" "-i")))
391
    (tramp-remote-shell         "/bin/sh")
Michael Albinus's avatar
Michael Albinus committed
392
    (tramp-remote-shell-login   ("-l"))
393
    (tramp-remote-shell-args    ("-i") ("-c"))
394
    (tramp-copy-program         "fcp")
Michael Albinus's avatar
Michael Albinus committed
395
    (tramp-copy-args            (("-p" "%k")))
396 397
    (tramp-copy-keep-date       t)))

398
;;;###tramp-autoload
399 400 401
(add-to-list 'tramp-default-method-alist
	     `(,tramp-local-host-regexp "\\`root\\'" "su"))

402
;;;###tramp-autoload
403
(add-to-list 'tramp-default-user-alist
404
	     `(,(concat "\\`" (regexp-opt '("su" "sudo" "doas" "ksu")) "\\'")
405
	       nil "root"))
406
;; Do not add "ssh" based methods, otherwise ~/.ssh/config would be ignored.
407
;; Do not add "plink" based methods, they ask interactively for the user.
408
;;;###tramp-autoload
409
(add-to-list 'tramp-default-user-alist
410 411
	     `(,(concat
		 "\\`"
412 413
		 (regexp-opt
		  '("rcp" "remcp" "rsh" "telnet" "nc" "krlogin" "fcp"))
414
		 "\\'")
415 416
	       nil ,(user-login-name)))

417
;;;###tramp-autoload
418 419 420 421 422
(defconst tramp-completion-function-alist-rsh
  '((tramp-parse-rhosts "/etc/hosts.equiv")
    (tramp-parse-rhosts "~/.rhosts"))
  "Default list of (FUNCTION FILE) pairs to be examined for rsh methods.")

423
;;;###tramp-autoload
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
(defconst tramp-completion-function-alist-ssh
  '((tramp-parse-rhosts      "/etc/hosts.equiv")
    (tramp-parse-rhosts      "/etc/shosts.equiv")
    (tramp-parse-shosts      "/etc/ssh_known_hosts")
    (tramp-parse-sconfig     "/etc/ssh_config")
    (tramp-parse-shostkeys   "/etc/ssh2/hostkeys")
    (tramp-parse-sknownhosts "/etc/ssh2/knownhosts")
    (tramp-parse-rhosts      "~/.rhosts")
    (tramp-parse-rhosts      "~/.shosts")
    (tramp-parse-shosts      "~/.ssh/known_hosts")
    (tramp-parse-sconfig     "~/.ssh/config")
    (tramp-parse-shostkeys   "~/.ssh2/hostkeys")
    (tramp-parse-sknownhosts "~/.ssh2/knownhosts"))
  "Default list of (FUNCTION FILE) pairs to be examined for ssh methods.")

439
;;;###tramp-autoload
440 441 442 443
(defconst tramp-completion-function-alist-telnet
  '((tramp-parse-hosts "/etc/hosts"))
  "Default list of (FUNCTION FILE) pairs to be examined for telnet methods.")

444
;;;###tramp-autoload
445 446 447 448
(defconst tramp-completion-function-alist-su
  '((tramp-parse-passwd "/etc/passwd"))
  "Default list of (FUNCTION FILE) pairs to be examined for su methods.")

Michael Albinus's avatar
Michael Albinus committed
449 450 451 452 453
;;;###tramp-autoload
(defconst tramp-completion-function-alist-sg
  '((tramp-parse-etc-group "/etc/group"))
  "Default list of (FUNCTION FILE) pairs to be examined for sg methods.")

454
;;;###tramp-autoload
455
(defconst tramp-completion-function-alist-putty
Michael Albinus's avatar
Michael Albinus committed
456 457 458 459
  `((tramp-parse-putty
     ,(if (memq system-type '(windows-nt))
	  "HKEY_CURRENT_USER\\Software\\SimonTatham\\PuTTY\\Sessions"
	"~/.putty/sessions")))
Michael Albinus's avatar
Michael Albinus committed
460
 "Default list of (FUNCTION REGISTRY) pairs to be examined for putty sessions.")
461

462 463 464 465 466 467 468 469 470 471 472 473 474 475
;;;###tramp-autoload
(eval-after-load 'tramp
  '(progn
     (tramp-set-completion-function "rcp" tramp-completion-function-alist-rsh)
     (tramp-set-completion-function "remcp" tramp-completion-function-alist-rsh)
     (tramp-set-completion-function "scp" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function "scpx" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function "rsync" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function "rsh" tramp-completion-function-alist-rsh)
     (tramp-set-completion-function "remsh" tramp-completion-function-alist-rsh)
     (tramp-set-completion-function "ssh" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function "sshx" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function
      "telnet" tramp-completion-function-alist-telnet)
476
     (tramp-set-completion-function "nc" tramp-completion-function-alist-telnet)
477 478
     (tramp-set-completion-function "su" tramp-completion-function-alist-su)
     (tramp-set-completion-function "sudo" tramp-completion-function-alist-su)
479
     (tramp-set-completion-function "doas" tramp-completion-function-alist-su)
480
     (tramp-set-completion-function "ksu" tramp-completion-function-alist-su)
Michael Albinus's avatar
Michael Albinus committed
481
     (tramp-set-completion-function "sg" tramp-completion-function-alist-sg)
482 483 484 485 486 487
     (tramp-set-completion-function
      "krlogin" tramp-completion-function-alist-rsh)
     (tramp-set-completion-function "plink" tramp-completion-function-alist-ssh)
     (tramp-set-completion-function
      "plinkx" tramp-completion-function-alist-putty)
     (tramp-set-completion-function "pscp" tramp-completion-function-alist-ssh)
488
     (tramp-set-completion-function "psftp" tramp-completion-function-alist-ssh)
489
     (tramp-set-completion-function "fcp" tramp-completion-function-alist-ssh)))
490 491 492 493

;; "getconf PATH" yields:
;; HP-UX: /usr/bin:/usr/ccs/bin:/opt/ansic/bin:/opt/langtools/bin:/opt/fortran/bin
;; Solaris: /usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin
Michael Albinus's avatar
Michael Albinus committed
494
;; GNU/Linux (Debian, Suse, RHEL): /bin:/usr/bin
495
;; FreeBSD: /usr/bin:/bin:/usr/sbin:/sbin: - beware trailing ":"!
496
;; Darwin: /usr/bin:/bin:/usr/sbin:/sbin
497
;; IRIX64: /usr/bin
498
;; QNAP QTS: ---
499
;;;###tramp-autoload
500
(defcustom tramp-remote-path
501 502 503
  '(tramp-default-remote-path "/bin" "/usr/bin" "/sbin" "/usr/sbin"
    "/usr/local/bin" "/usr/local/sbin" "/local/bin" "/local/freeware/bin"
    "/local/gnu/bin" "/usr/freeware/bin" "/usr/pkg/bin" "/usr/contrib/bin"
Michael Albinus's avatar
Michael Albinus committed
504
    "/opt/bin" "/opt/sbin" "/opt/local/bin")
505
  "List of directories to search for executables on remote host.
506 507 508 509 510 511 512 513
For every remote host, this variable will be set buffer local,
keeping the list of existing directories on that host.

You can use `~' in this list, but when searching for a shell which groks
tilde expansion, all directory names starting with `~' will be ignored.

`Default Directories' represent the list of directories given by
the command \"getconf PATH\".  It is recommended to use this
514
entry on head of this list, because these are the default
515 516
directories for POSIX compatible commands.  On remote hosts which
do not offer the getconf command (like cygwin), the value
517
\"/bin:/usr/bin\" is used instead.  This entry is represented in
518
the list by the special value `tramp-default-remote-path'.
519 520

`Private Directories' are the settings of the $PATH environment,
521 522
as given in your `~/.profile'.  This entry is represented in
the list by the special value `tramp-own-remote-path'."
523 524 525 526
  :group 'tramp
  :type '(repeat (choice
		  (const :tag "Default Directories" tramp-default-remote-path)
		  (const :tag "Private Directories" tramp-own-remote-path)
Michael Albinus's avatar
Michael Albinus committed
527
		  (string :tag "Directory"))))
528

529
;;;###tramp-autoload
530
(defcustom tramp-remote-process-environment
Daniel Pittman's avatar
Daniel Pittman committed
531
  '("ENV=''" "TMOUT=0" "LC_CTYPE=''"
532
    "CDPATH=" "HISTORY=" "MAIL=" "MAILCHECK=" "MAILPATH=" "PAGER=cat"
533
    "autocorrect=" "correct=")
534
  "List of environment variables to be set on the remote host.
535 536

Each element should be a string of the form ENVVARNAME=VALUE.  An
Paul Eggert's avatar
Paul Eggert committed
537
entry ENVVARNAME= disables the corresponding environment variable,
538 539
which might have been set in the init files like ~/.profile.

Daniel Pittman's avatar
Daniel Pittman committed
540 541 542 543 544 545 546 547
Special handling is applied to some environment variables,
which should not be set here:

The PATH environment variable should be set via `tramp-remote-path'.

The TERM environment variable should be set via `tramp-terminal-type'.

The INSIDE_EMACS environment variable will automatically be set
Michael Albinus's avatar
Michael Albinus committed
548
based on the Tramp and Emacs versions, and should not be set here."
549
  :group 'tramp
550
  :version "26.1"
Michael Albinus's avatar
Michael Albinus committed
551
  :type '(repeat string))
552

553
;;;###tramp-autoload
554
(defcustom tramp-sh-extra-args '(("/bash\\'" . "-norc -noprofile"))
555
  "Alist specifying extra arguments to pass to the remote shell.
556 557 558 559 560 561 562 563
Entries are (REGEXP . ARGS) where REGEXP is a regular expression
matching the shell file name and ARGS is a string specifying the
arguments.

This variable is only used when Tramp needs to start up another shell
for tilde expansion.  The extra arguments should typically prevent the
shell from reading its init file."
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
564
  :type '(alist :key-type regexp :value-type string))
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598

(defconst tramp-actions-before-shell
  '((tramp-login-prompt-regexp tramp-action-login)
    (tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (shell-prompt-pattern tramp-action-succeed)
    (tramp-shell-prompt-pattern tramp-action-succeed)
    (tramp-yesno-prompt-regexp tramp-action-yesno)
    (tramp-yn-prompt-regexp tramp-action-yn)
    (tramp-terminal-prompt-regexp tramp-action-terminal)
    (tramp-process-alive-regexp tramp-action-process-alive))
  "List of pattern/action pairs.
Whenever a pattern matches, the corresponding action is performed.
Each item looks like (PATTERN ACTION).

The PATTERN should be a symbol, a variable.  The value of this
variable gives the regular expression to search for.  Note that the
regexp must match at the end of the buffer, \"\\'\" is implicitly
appended to it.

The ACTION should also be a symbol, but a function.  When the
corresponding PATTERN matches, the ACTION function is called.")

(defconst tramp-actions-copy-out-of-band
  '((tramp-password-prompt-regexp tramp-action-password)
    (tramp-wrong-passwd-regexp tramp-action-permission-denied)
    (tramp-copy-failed-regexp tramp-action-permission-denied)
    (tramp-process-alive-regexp tramp-action-out-of-band))
  "List of pattern/action pairs.
This list is used for copying/renaming with out-of-band methods.

See `tramp-actions-before-shell' for more info.")

(defconst tramp-uudecode
Michael Albinus's avatar
Michael Albinus committed
599 600 601
  "(echo begin 600 %t; tail -n +2) | uudecode
cat %t
rm -f %t"
602 603 604 605 606 607 608 609 610 611
  "Shell function to implement `uudecode' to standard output.
Many systems support `uudecode -o /dev/stdout' or `uudecode -o -'
for this or `uudecode -p', but some systems don't, and for them
we have this shell function.")

(defconst tramp-perl-file-truename
  "%s -e '
use File::Spec;
use Cwd \"realpath\";

612 613
sub myrealpath {
    my ($file) = @_;
614
    return realpath($file) if (-e $file || -l $file);
615 616
}

617 618
sub recursive {
    my ($volume, @dirs) = @_;
619
    my $real = myrealpath(File::Spec->catpath(
620 621 622 623 624 625 626 627 628 629 630 631 632
                   $volume, File::Spec->catdir(@dirs), \"\"));
    if ($real) {
        my ($vol, $dir) = File::Spec->splitpath($real, 1);
        return ($vol, File::Spec->splitdir($dir));
    }
    else {
        my $last = pop(@dirs);
        ($volume, @dirs) = recursive($volume, @dirs);
        push(@dirs, $last);
        return ($volume, @dirs);
    }
}

633
$result = myrealpath($ARGV[0]);
634 635 636 637 638 639 640
if (!$result) {
    my ($vol, $dir) = File::Spec->splitpath($ARGV[0], 1);
    ($vol, @dirs) = recursive($vol, File::Spec->splitdir($dir));

    $result = File::Spec->catpath($vol, File::Spec->catdir(@dirs), \"\");
}

641
$result =~ s/\"/\\\\\"/g;
642 643 644 645 646 647 648 649
print \"\\\"$result\\\"\\n\";
' \"$1\" 2>/dev/null"
  "Perl script to produce output suitable for use with `file-truename'
on the remote file system.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.")

(defconst tramp-perl-file-name-all-completions
Michael Albinus's avatar
Michael Albinus committed
650
  "%s -e '
651 652 653
opendir(d, $ARGV[0]) || die(\"$ARGV[0]: $!\\nfail\\n\");
@files = readdir(d); closedir(d);
foreach $f (@files) {
Michael Albinus's avatar
Michael Albinus committed
654 655 656 657 658
 if (-d \"$ARGV[0]/$f\") {
  print \"$f/\\n\";
 }
 else {
  print \"$f\\n\";
659 660 661
 }
}
print \"ok\\n\"
Michael Albinus's avatar
Michael Albinus committed
662
' \"$1\" 2>/dev/null"
663 664 665 666 667 668 669 670 671 672
  "Perl script to produce output suitable for use with
`file-name-all-completions' on the remote file system.  Escape
sequence %s is replaced with name of Perl binary.  This string is
passed to `format', so percent characters need to be doubled.")

;; Perl script to implement `file-attributes' in a Lisp `read'able
;; output.  If you are hacking on this, note that you get *no* output
;; unless this spits out a complete line, including the '\n' at the
;; end.
;; The device number is returned as "-1", because there will be a virtual
673
;; device number set in `tramp-sh-handle-file-attributes'.
674 675 676 677 678 679 680 681 682 683
(defconst tramp-perl-file-attributes
  "%s -e '
@stat = lstat($ARGV[0]);
if (!@stat) {
    print \"nil\\n\";
    exit 0;
}
if (($stat[2] & 0170000) == 0120000)
{
    $type = readlink($ARGV[0]);
Michael Albinus's avatar
Michael Albinus committed
684
    $type =~ s/\"/\\\\\"/g;
685 686 687 688 689 690 691 692 693 694 695 696 697
    $type = \"\\\"$type\\\"\";
}
elsif (($stat[2] & 0170000) == 040000)
{
    $type = \"t\";
}
else
{
    $type = \"nil\"
};
$uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
$gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
printf(
Michael Albinus's avatar
Michael Albinus committed
698
    \"(%%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u %%u t %%u -1)\\n\",
699 700 701 702 703 704 705 706 707 708 709 710
    $type,
    $stat[3],
    $uid,
    $gid,
    $stat[8] >> 16 & 0xffff,
    $stat[8] & 0xffff,
    $stat[9] >> 16 & 0xffff,
    $stat[9] & 0xffff,
    $stat[10] >> 16 & 0xffff,
    $stat[10] & 0xffff,
    $stat[7],
    $stat[2],
Michael Albinus's avatar
Michael Albinus committed
711
    $stat[1]
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
);' \"$1\" \"$2\" 2>/dev/null"
  "Perl script to produce output suitable for use with `file-attributes'
on the remote file system.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.")

(defconst tramp-perl-directory-files-and-attributes
  "%s -e '
chdir($ARGV[0]) or printf(\"\\\"Cannot change to $ARGV[0]: $''!''\\\"\\n\"), exit();
opendir(DIR,\".\") or printf(\"\\\"Cannot open directory $ARGV[0]: $''!''\\\"\\n\"), exit();
@list = readdir(DIR);
closedir(DIR);
$n = scalar(@list);
printf(\"(\\n\");
for($i = 0; $i < $n; $i++)
{
    $filename = $list[$i];
    @stat = lstat($filename);
    if (($stat[2] & 0170000) == 0120000)
    {
        $type = readlink($filename);
Michael Albinus's avatar
Michael Albinus committed
733
        $type =~ s/\"/\\\\\"/g;
734 735 736 737 738 739 740 741 742 743 744 745
        $type = \"\\\"$type\\\"\";
    }
    elsif (($stat[2] & 0170000) == 040000)
    {
        $type = \"t\";
    }
    else
    {
        $type = \"nil\"
    };
    $uid = ($ARGV[1] eq \"integer\") ? $stat[4] : \"\\\"\" . getpwuid($stat[4]) . \"\\\"\";
    $gid = ($ARGV[1] eq \"integer\") ? $stat[5] : \"\\\"\" . getgrgid($stat[5]) . \"\\\"\";
Michael Albinus's avatar
Michael Albinus committed
746
    $filename =~ s/\"/\\\\\"/g;
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
    printf(
        \"(\\\"%%s\\\" %%s %%u %%s %%s (%%u %%u) (%%u %%u) (%%u %%u) %%u.0 %%u t (%%u . %%u) (%%u . %%u))\\n\",
        $filename,
        $type,
        $stat[3],
        $uid,
        $gid,
        $stat[8] >> 16 & 0xffff,
        $stat[8] & 0xffff,
        $stat[9] >> 16 & 0xffff,
        $stat[9] & 0xffff,
        $stat[10] >> 16 & 0xffff,
        $stat[10] & 0xffff,
        $stat[7],
        $stat[2],
        $stat[1] >> 16 & 0xffff,
        $stat[1] & 0xffff,
        $stat[0] >> 16 & 0xffff,
        $stat[0] & 0xffff);
}
printf(\")\\n\");' \"$1\" \"$2\" 2>/dev/null"
  "Perl script implementing `directory-files-attributes' as Lisp `read'able
output.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.")

;; These two use base64 encoding.
(defconst tramp-perl-encode-with-module
  "%s -MMIME::Base64 -0777 -ne 'print encode_base64($_)' 2>/dev/null"
  "Perl program to use for encoding a file.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.
This implementation requires the MIME::Base64 Perl module to be installed
on the remote host.")

(defconst tramp-perl-decode-with-module
  "%s -MMIME::Base64 -0777 -ne 'print decode_base64($_)' 2>/dev/null"
  "Perl program to use for decoding a file.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.
This implementation requires the MIME::Base64 Perl module to be installed
on the remote host.")

(defconst tramp-perl-encode
  "%s -e '
# This script contributed by Juanma Barranquero <lektu@terra.es>.
Paul Eggert's avatar
Paul Eggert committed
793
# Copyright (C) 2002-2018 Free Software Foundation, Inc.
794 795 796 797 798 799 800
use strict;

my %%trans = do {
    my $i = 0;
    map {(substr(unpack(q(B8), chr $i++), 2, 6), $_)}
      split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/);
};
801
my $data;
802 803 804

# We read in chunks of 54 bytes, to generate output lines
# of 72 chars (plus end of line)
805
while (read STDIN, $data, 54) {
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
    my $pad = q();

    # Only for the last chunk, and only if did not fill the last three-byte packet
    if (eof) {
        my $mod = length($data) %% 3;
        $pad = q(=) x (3 - $mod) if $mod;
    }

    # Not the fastest method, but it is simple: unpack to binary string, split
    # by groups of 6 bits and convert back from binary to byte; then map into
    # the translation table
    print
      join q(),
        map($trans{$_},
            (substr(unpack(q(B*), $data) . q(00000), 0, 432) =~ /....../g)),
              $pad,
                qq(\\n);
}' 2>/dev/null"
  "Perl program to use for encoding a file.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.")

(defconst tramp-perl-decode
  "%s -e '
# This script contributed by Juanma Barranquero <lektu@terra.es>.
Paul Eggert's avatar
Paul Eggert committed
831
# Copyright (C) 2002-2018 Free Software Foundation, Inc.
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
use strict;

my %%trans = do {
    my $i = 0;
    map {($_, substr(unpack(q(B8), chr $i++), 2, 6))}
      split //, q(ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/)
};

my %%bytes = map {(unpack(q(B8), chr $_), chr $_)} 0 .. 255;

binmode(\\*STDOUT);

# We are going to accumulate into $pending to accept any line length
# (we do not check they are <= 76 chars as the RFC says)
my $pending = q();

while (my $data = <STDIN>) {
    chomp $data;

    # If we find one or two =, we have reached the end and
    # any following data is to be discarded
    my $finished = $data =~ s/(==?).*/$1/;
    $pending .= $data;

    my $len = length($pending);
    my $chunk = substr($pending, 0, $len & ~3);
    $pending = substr($pending, $len & ~3 + 1);

    # Easy method: translate from chars to (pregenerated) six-bit packets, join,
    # split in 8-bit chunks and convert back to char.
    print join q(),
      map $bytes{$_},
        ((join q(), map {$trans{$_} || q()} split //, $chunk) =~ /......../g);

    last if $finished;
}' 2>/dev/null"
  "Perl program to use for decoding a file.
Escape sequence %s is replaced with name of Perl binary.
This string is passed to `format', so percent characters need to be doubled.")

872 873 874 875 876 877 878 879 880 881
(defconst tramp-perl-pack
  "%s -e 'binmode STDIN; binmode STDOUT; print pack(q{u*}, join q{}, <>)'"
  "Perl program to use for encoding a file.
Escape sequence %s is replaced with name of Perl binary.")

(defconst tramp-perl-unpack
  "%s -e 'binmode STDIN; binmode STDOUT; print unpack(q{u*}, join q{}, <>)'"
  "Perl program to use for decoding a file.
Escape sequence %s is replaced with name of Perl binary.")

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
(defconst tramp-awk-encode
  "od -v -t x1 -A n | busybox awk '\\
BEGIN {
  b64 = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/\"
  b16 = \"0123456789abcdef\"
}
{
  for (c=1; c<=length($0); c++) {
    d=index(b16, substr($0,c,1))
    if (d--) {
      for (b=1; b<=4; b++) {
        o=o*2+int(d/8); d=(d*2)%%16
        if (++obc==6) {
          printf substr(b64,o+1,1)
          if (++rc>75) { printf \"\\n\"; rc=0 }
          obc=0; o=0
        }
      }
    }
  }
}
END {
  if (obc) {
    tail=(obc==2) ? \"==\\n\" : \"=\\n\"
    while (obc++<6) { o=o*2 }
    printf \"%%c\", substr(b64,o+1,1)
  } else {
    tail=\"\\n\"
  }
  printf tail
}'"
  "Awk program to use for encoding a file.
This string is passed to `format', so percent characters need to be doubled.")

(defconst tramp-awk-decode
  "busybox awk '\\
BEGIN {
  b64 = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/\"
}
{
  for (i=1; i<=length($0); i++) {
    c=index(b64, substr($0,i,1))
    if(c--) {
      for(b=0; b<6; b++) {
        o=o*2+int(c/32); c=(c*2)%%64
        if(++obc==8) {
          if (o) {
            printf \"%%c\", o
          } else {
            system(\"dd if=/dev/zero bs=1 count=1 2>/dev/null\")
          }
          obc=0; o=0
        }
      }
    }
  }
}'"
  "Awk program to use for decoding a file.
This string is passed to `format', so percent characters need to be doubled.")

(defconst tramp-awk-coding-test
  "test -c /dev/zero && \
od -v -t x1 -A n </dev/null && \
busybox awk '{}' </dev/null"
  "Test command for checking `tramp-awk-encode' and `tramp-awk-decode'.")

Michael Albinus's avatar
Michael Albinus committed
948
;;;###tramp-autoload
949 950 951 952 953 954
(defconst tramp-stat-marker "/////"
  "Marker in stat commands for file attributes.")

(defconst tramp-stat-quoted-marker "\\/\\/\\/\\/\\/"
  "Quoted marker in stat commands for file attributes.")

955 956 957
(defconst tramp-vc-registered-read-file-names
  "echo \"(\"
while read file; do
Michael Albinus's avatar
Michael Albinus committed
958
    quoted=`echo \"$file\" | sed -e \"s/\\\"/\\\\\\\\\\\\\\\\\\\"/\"`
959
    if %s \"$file\"; then
Michael Albinus's avatar
Michael Albinus committed
960
	echo \"(\\\"$quoted\\\" \\\"file-exists-p\\\" t)\"
961
    else
Michael Albinus's avatar
Michael Albinus committed
962
	echo \"(\\\"$quoted\\\" \\\"file-exists-p\\\" nil)\"
963 964
    fi
    if %s \"$file\"; then
Michael Albinus's avatar
Michael Albinus committed
965
	echo \"(\\\"$quoted\\\" \\\"file-readable-p\\\" t)\"
966
    else
Michael Albinus's avatar
Michael Albinus committed
967
	echo \"(\\\"$quoted\\\" \\\"file-readable-p\\\" nil)\"
968 969 970 971 972 973 974 975 976
    fi
done
echo \")\""
  "Script to check existence of VC related files.
It must be send formatted with two strings; the tests for file
existence, and file readability.  Input shall be read via
here-document, otherwise the command could exceed maximum length
of command line.")

Michael Albinus's avatar
Michael Albinus committed
977
;; New handlers should be added here.
Michael Albinus's avatar
Michael Albinus committed
978
;;;###tramp-autoload
979
(defconst tramp-sh-file-name-handler-alist
Michael Albinus's avatar
Michael Albinus committed
980
  '(;; `access-file' performed by default handler.
981
    (add-name-to-file . tramp-sh-handle-add-name-to-file)
Michael Albinus's avatar
Michael Albinus committed
982
    ;; `byte-compiler-base-file-name' performed by default handler.
983
    (copy-directory . tramp-sh-handle-copy-directory)
Michael Albinus's avatar
Michael Albinus committed
984
    (copy-file . tramp-sh-handle-copy-file)
985 986
    (delete-directory . tramp-sh-handle-delete-directory)
    (delete-file . tramp-sh-handle-delete-file)
Michael Albinus's avatar
Michael Albinus committed
987
    ;; `diff-latest-backup-file' performed by default handler.
988
    (directory-file-name . tramp-handle-directory-file-name)
Michael Albinus's avatar
Michael Albinus committed
989 990 991 992 993
    (directory-files . tramp-handle-directory-files)
    (directory-files-and-attributes
     . tramp-sh-handle-directory-files-and-attributes)
    (dired-compress-file . tramp-sh-handle-dired-compress-file)
    (dired-uncache . tramp-handle-dired-uncache)
994
    (exec-path . tramp-sh-handle-exec-path)
995
    (expand-file-name . tramp-sh-handle-expand-file-name)
Michael Albinus's avatar
Michael Albinus committed
996 997 998 999
    (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
    (file-acl . tramp-sh-handle-file-acl)
    (file-attributes . tramp-sh-handle-file-attributes)
    (file-directory-p . tramp-sh-handle-file-directory-p)
1000
    (file-equal-p . tramp-handle-file-equal-p)
Michael Albinus's avatar
Michael Albinus committed
1001 1002
    (file-executable-p . tramp-sh-handle-file-executable-p)
    (file-exists-p . tramp-sh-handle-file-exists-p)
1003
    (file-in-directory-p . tramp-handle-file-in-directory-p)
1004
    (file-local-copy . tramp-sh-handle-file-local-copy)
Michael Albinus's avatar
Michael Albinus committed
1005 1006 1007
    (file-modes . tramp-handle-file-modes)
    (file-name-all-completions . tramp-sh-handle-file-name-all-completions)
    (file-name-as-directory . tramp-handle-file-name-as-directory)
1008
    (file-name-case-insensitive-p . tramp-handle-file-name-case-insensitive-p)
Michael Albinus's avatar
Michael Albinus committed
1009 1010 1011 1012 1013 1014 1015
    (file-name-completion . tramp-handle-file-name-completion)
    (file-name-directory . tramp-handle-file-name-directory)
    (file-name-nondirectory . tramp-handle-file-name-nondirectory)
    ;; `file-name-sans-versions' performed by default handler.
    (file-newer-than-file-p . tramp-sh-handle-file-newer-than-file-p)
    (file-notify-add-watch . tramp-sh-handle-file-notify-add-watch)
    (file-notify-rm-watch . tramp-handle-file-notify-rm-watch)
1016
    (file-notify-valid-p . tramp-handle-file-notify-valid-p)
Michael Albinus's avatar
Michael Albinus committed
1017 1018 1019
    (file-ownership-preserved-p . tramp-sh-handle-file-ownership-preserved-p)
    (file-readable-p . tramp-sh-handle-file-readable-p)
    (file-regular-p . tramp-handle-file-regular-p)
1020
    (file-remote-p . tramp-handle-file-remote-p)
Michael Albinus's avatar
Michael Albinus committed
1021 1022
    (file-selinux-context . tramp-sh-handle-file-selinux-context)
    (file-symlink-p . tramp-handle-file-symlink-p)
1023
    (file-system-info . tramp-sh-handle-file-system-info)
Michael Albinus's avatar
Michael Albinus committed
1024 1025 1026 1027 1028
    (file-truename . tramp-sh-handle-file-truename)
    (file-writable-p . tramp-sh-handle-file-writable-p)
    (find-backup-file-name . tramp-handle-find-backup-file-name)
    ;; `get-file-buffer' performed by default handler.
    (insert-directory . tramp-sh-handle-insert-directory)
1029
    (insert-file-contents . tramp-handle-insert-file-contents)
Michael Albinus's avatar
Michael Albinus committed
1030
    (load . tramp-handle-load)
1031
    (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
Michael Albinus's avatar
Michael Albinus committed
1032
    (make-directory . tramp-sh-handle-make-directory)
Michael Albinus's avatar
Michael Albinus committed
1033
    ;; `make-directory-internal' performed by default handler.
1034
    (make-nearby-temp-file . tramp-handle-make-nearby-temp-file)
Michael Albinus's avatar
Michael Albinus committed
1035 1036 1037
    (make-symbolic-link . tramp-sh-handle-make-symbolic-link)
    (process-file . tramp-sh-handle-process-file)
    (rename-file . tramp-sh-handle-rename-file)
1038
    (set-file-acl . tramp-sh-handle-set-file-acl)
Michael Albinus's avatar
Michael Albinus committed
1039 1040 1041 1042 1043 1044 1045
    (set-file-modes . tramp-sh-handle-set-file-modes)
    (set-file-selinux-context . tramp-sh-handle-set-file-selinux-context)
    (set-file-times . tramp-sh-handle-set-file-times)
    (set-visited-file-modtime . tramp-sh-handle-set-visited-file-modtime)
    (shell-command . tramp-handle-shell-command)
    (start-file-process . tramp-sh-handle-start-file-process)
    (substitute-in-file-name . tramp-handle-substitute-in-file-name)
1046
    (temporary-file-directory . tramp-handle-temporary-file-directory)
1047
    (unhandled-file-name-directory . ignore)
1048
    (vc-registered . tramp-sh-handle-vc-registered)
Michael Albinus's avatar
Michael Albinus committed
1049 1050
    (verify-visited-file-modtime . tramp-sh-handle-verify-visited-file-modtime)
    (write-region . tramp-sh-handle-write-region))
1051 1052 1053 1054 1055
  "Alist of handler functions.
Operations not mentioned here will be handled by the normal Emacs functions.")

;;; File Name Handler Functions:

1056
(defun tramp-sh-handle-make-symbolic-link
Michael Albinus's avatar
Michael Albinus committed
1057
    (target linkname &optional ok-if-already-exists)
1058
  "Like `make-symbolic-link' for Tramp files.
Michael Albinus's avatar
Michael Albinus committed
1059 1060 1061 1062 1063 1064 1065 1066
If TARGET is a non-Tramp file, it is used verbatim as the target
of the symlink.  If TARGET is a Tramp file, only the localname
component is used as the target of the symlink."
  (if (not (tramp-tramp-file-p (expand-file-name linkname)))
      (tramp-run-real-handler
       'make-symbolic-link (list target linkname ok-if-already-exists))

    (with-parsed-tramp-file-name linkname nil
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
      ;; If TARGET is a Tramp name, use just the localname component.
      (when (and (tramp-tramp-file-p target)
		 (tramp-file-name-equal-p v (tramp-dissect-file-name target)))
	(setq target
	      (tramp-file-name-localname
	       (tramp-dissect-file-name (expand-file-name target)))))

      ;; If TARGET is still remote, quote it.
      (if (tramp-tramp-file-p target)
	  (make-symbolic-link
	   (let (file-name-handler-alist) (tramp-compat-file-name-quote target))
	   linkname ok-if-already-exists)

	(let ((ln (tramp-get-remote-ln v))
	      (cwd (tramp-run-real-handler
		    'file-name-directory (list localname))))
	  (unless ln
	    (tramp-error
	     v 'file-error
Michael Albinus's avatar
Michael Albinus committed
1086 1087
	   "Making a symbolic link.  ln(1) does not exist on the remote host."))

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
	  ;; Do the 'confirm if exists' thing.
	  (when (file-exists-p linkname)
	    ;; What to do?
	    (if (or (null ok-if-already-exists) ; not allowed to exist
		    (and (numberp ok-if-already-exists)
			 (not
			  (yes-or-no-p
			   (format
			    "File %s already exists; make it a link anyway? "
			    localname)))))
		(tramp-error v 'file-already-exists localname)
	      (delete-file linkname)))

1101 1102
	  (tramp-flush-file-properties v (file-name-directory localname))
	  (tramp-flush-file-properties v localname)
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119

	  ;; Right, they are on the same host, regardless of user,
	  ;; method, etc.  We now make the link on the remote
	  ;; machine. This will occur as the user that TARGET belongs to.
	  (and (tramp-send-command-and-check
		v (format "cd %s" (tramp-shell-quote-argument cwd)))
               (tramp-send-command-and-check
		v (format
		   "%s -sf %s %s" ln
		   (tramp-shell-quote-argument target)
		   ;; The command could exceed PATH_MAX, so we use
		   ;; relative file names.  However, relative file
		   ;; names could start with "-".
		   ;; `tramp-shell-quote-argument' does not handle
		   ;; this, we must do it ourselves.
		   (tramp-shell-quote-argument
                    (concat "./" (file-name-nondirectory localname)))))))))))
1120

1121
(defun tramp-sh-handle-file-truename (filename)
1122
  "Like `file-truename' for Tramp files."
1123 1124 1125 1126
   ;; Preserve trailing "/".
  (funcall
   (if (string-equal (file-name-nondirectory filename) "")
       'file-name-as-directory 'identity)
1127 1128
   (with-parsed-tramp-file-name (expand-file-name filename) nil
     (tramp-make-tramp-file-name
1129
      v
1130
      (with-tramp-file-property v localname "file-truename"
1131
	(let ((result nil)			; result steps in reverse order
1132 1133
	      (quoted (tramp-compat-file-name-quoted-p localname))
	      (localname (tramp-compat-file-name-unquote localname)))
1134
	  (tramp-message v 4 "Finding true name for `%s'" filename)
1135 1136 1137
	  (cond
	   ;; Use GNU readlink --canonicalize-missing where available.
	   ((tramp-get-remote-readlink v)
1138 1139 1140 1141 1142 1143 1144
	    (tramp-send-command-and-check
	     v
	     (format "%s --canonicalize-missing %s"
		     (tramp-get-remote-readlink v)
		     (tramp-shell-quote-argument localname)))
	    (with-current-buffer (tramp-get-connection-buffer v)
	      (goto-char (point-min))
1145
	      (setq result (buffer-substring (point-min) (point-at-eol)))))
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158

	   ;; Use Perl implementation.
	   ((and (tramp-get-remote-perl v)
		 (tramp-get-connection-property v "perl-file-spec" nil)
		 (tramp-get-connection-property v "perl-cwd-realpath" nil))
	    (tramp-maybe-send-script
	     v tramp-perl-file-truename "tramp_perl_file_truename")
	    (setq result
		  (tramp-send-command-and-read
		   v
		   (format "tramp_perl_file_truename %s"
			   (tramp-shell-quote-argument localname)))))

1159 1160
	   ;; Do it yourself.
	   (t (let ((steps (split-string localname "/" 'omit))
1161 1162 1163 1164 1165 1166 1167 1168 1169
		    (thisstep nil)
		    (numchase 0)
		    ;; Don't make the following value larger than
		    ;; necessary.  People expect an error message in a
		    ;; timely fashion when something is wrong;
		    ;; otherwise they might think that Emacs is hung.
		    ;; Of course, correctness has to come first.
		    (numchase-limit 20)
		    symlink-target)
1170 1171 1172 1173 1174 1175 1176 1177
		(while (and steps (< numchase numchase-limit))
		  (setq thisstep (pop steps))
		  (tramp-message
		   v 5 "Check %s"
		   (mapconcat 'identity
			      (append '("") (reverse result) (list thisstep))
			      "/"))
		  (setq symlink-target
1178 1179 1180
			(tramp-compat-file-attribute-type
			 (file-attributes
			  (tramp-make-tramp-file-name
1181
			   v
1182 1183 1184 1185
			   (mapconcat 'identity
				      (append '("")
					      (reverse result)
					      (list thisstep))