Commit | Line | Data |
---|---|---|
b1a2b924 | 1 | ;;; tramp.el --- Transparent Remote Access, Multiple Protocol |
fb7933a3 | 2 | |
73b0cd50 | 3 | ;; Copyright (C) 1998-2011 Free Software Foundation, Inc. |
fb7933a3 | 4 | |
cdd44874 | 5 | ;; Author: Kai Großjohann <kai.grossjohann@gmx.net> |
d2a2c17f | 6 | ;; Michael Albinus <michael.albinus@gmx.de> |
fb7933a3 | 7 | ;; Keywords: comm, processes |
0f34aa77 | 8 | ;; Package: tramp |
fb7933a3 KG |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
874a927a | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
fb7933a3 | 13 | ;; it under the terms of the GNU General Public License as published by |
874a927a GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
fb7933a3 KG |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
874a927a | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
fb7933a3 KG |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;; This package provides remote file editing, similar to ange-ftp. | |
28 | ;; The difference is that ange-ftp uses FTP to transfer files between | |
29 | ;; the local and the remote host, whereas tramp.el uses a combination | |
30 | ;; of rsh and rcp or other work-alike programs, such as ssh/scp. | |
31 | ;; | |
b1a2b924 | 32 | ;; For more detailed instructions, please see the info file. |
fb7933a3 KG |
33 | ;; |
34 | ;; Notes: | |
35 | ;; ----- | |
bf247b6e | 36 | ;; |
b533bc97 | 37 | ;; This package only works for Emacs 22.1 and higher, and for XEmacs 21.4 |
00d6fd04 | 38 | ;; and higher. For XEmacs 21, you need the package `fsf-compat' for |
7f4d4a97 | 39 | ;; the `with-timeout' macro. |
fb7933a3 | 40 | ;; |
fb7933a3 KG |
41 | ;; Also see the todo list at the bottom of this file. |
42 | ;; | |
b1a2b924 | 43 | ;; The current version of Tramp can be retrieved from the following URL: |
340b8d4f | 44 | ;; http://ftp.gnu.org/gnu/tramp/ |
fb7933a3 KG |
45 | ;; |
46 | ;; There's a mailing list for this, as well. Its name is: | |
340b8d4f MA |
47 | ;; tramp-devel@gnu.org |
48 | ;; You can use the Web to subscribe, under the following URL: | |
49 | ;; http://lists.gnu.org/mailman/listinfo/tramp-devel | |
fb7933a3 KG |
50 | ;; |
51 | ;; For the adventurous, the current development sources are available | |
52 | ;; via CVS. You can find instructions about this at the following URL: | |
c62c9d08 | 53 | ;; http://savannah.gnu.org/projects/tramp/ |
fb7933a3 KG |
54 | ;; Click on "CVS" in the navigation bar near the top. |
55 | ;; | |
56 | ;; Don't forget to put on your asbestos longjohns, first! | |
57 | ||
58 | ;;; Code: | |
59 | ||
9e6ab520 | 60 | (require 'tramp-compat) |
fb7933a3 | 61 | |
fb7933a3 KG |
62 | ;;; User Customizable Internal Variables: |
63 | ||
64 | (defgroup tramp nil | |
65 | "Edit remote files with a combination of rsh and rcp or similar programs." | |
589d30dd | 66 | :group 'files |
26f4b8ab | 67 | :group 'comm |
bf247b6e | 68 | :version "22.1") |
fb7933a3 | 69 | |
2e271195 MA |
70 | ;; Maybe we need once a real Tramp mode, with key bindings etc. |
71 | ;;;###autoload | |
72 | (defcustom tramp-mode t | |
73 | "*Whether Tramp is enabled. | |
74 | If it is set to nil, all remote file names are used literally." | |
75 | :group 'tramp | |
76 | :type 'boolean) | |
77 | ||
00d6fd04 | 78 | (defcustom tramp-verbose 3 |
263c02ef | 79 | "*Verbosity level for Tramp messages. |
00d6fd04 MA |
80 | Any level x includes messages for all levels 1 .. x-1. The levels are |
81 | ||
82 | 0 silent (no tramp messages at all) | |
83 | 1 errors | |
84 | 2 warnings | |
85 | 3 connection to remote hosts (default level) | |
86 | 4 activities | |
87 | 5 internal | |
88 | 6 sent and received strings | |
89 | 7 file caching | |
90 | 8 connection properties | |
8fbcce2d | 91 | 9 test commands |
00d6fd04 | 92 | 10 traces (huge)." |
fb7933a3 KG |
93 | :group 'tramp |
94 | :type 'integer) | |
95 | ||
263c02ef | 96 | ;; Emacs case. |
38c65fca KG |
97 | (eval-and-compile |
98 | (when (boundp 'backup-directory-alist) | |
99 | (defcustom tramp-backup-directory-alist nil | |
100 | "Alist of filename patterns and backup directory names. | |
101 | Each element looks like (REGEXP . DIRECTORY), with the same meaning like | |
102 | in `backup-directory-alist'. If a Tramp file is backed up, and DIRECTORY | |
103 | is a local file name, the backup directory is prepended with Tramp file | |
00d6fd04 | 104 | name prefix \(method, user, host\) of file. |
38c65fca KG |
105 | |
106 | \(setq tramp-backup-directory-alist backup-directory-alist\) | |
107 | ||
108 | gives the same backup policy for Tramp files on their hosts like the | |
109 | policy for local files." | |
110 | :group 'tramp | |
111 | :type '(repeat (cons (regexp :tag "Regexp matching filename") | |
112 | (directory :tag "Backup directory name")))))) | |
113 | ||
114 | ;; XEmacs case. We cannot check for `bkup-backup-directory-info', because | |
115 | ;; the package "backup-dir" might not be loaded yet. | |
116 | (eval-and-compile | |
117 | (when (featurep 'xemacs) | |
118 | (defcustom tramp-bkup-backup-directory-info nil | |
119 | "*Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...)) | |
120 | It has the same meaning like `bkup-backup-directory-info' from package | |
121 | `backup-dir'. If a Tramp file is backed up, and BACKUP-DIR is a local | |
122 | file name, the backup directory is prepended with Tramp file name prefix | |
00d6fd04 | 123 | \(method, user, host\) of file. |
38c65fca KG |
124 | |
125 | \(setq tramp-bkup-backup-directory-info bkup-backup-directory-info\) | |
126 | ||
127 | gives the same backup policy for Tramp files on their hosts like the | |
128 | policy for local files." | |
bf247b6e | 129 | :type '(repeat |
38c65fca KG |
130 | (list (regexp :tag "File regexp") |
131 | (string :tag "Backup Dir") | |
132 | (set :inline t | |
133 | (const ok-create) | |
134 | (const full-path) | |
135 | (const prepend-name) | |
136 | (const search-upward)))) | |
137 | :group 'tramp))) | |
138 | ||
fb7933a3 KG |
139 | (defcustom tramp-auto-save-directory nil |
140 | "*Put auto-save files in this directory, if set. | |
141 | The idea is to use a local directory so that auto-saving is faster." | |
142 | :group 'tramp | |
00d6fd04 | 143 | :type '(choice (const nil) string)) |
fb7933a3 | 144 | |
16674e4f KG |
145 | (defcustom tramp-encoding-shell |
146 | (if (memq system-type '(windows-nt)) | |
147 | (getenv "COMSPEC") | |
148 | "/bin/sh") | |
149 | "*Use this program for encoding and decoding commands on the local host. | |
150 | This shell is used to execute the encoding and decoding command on the | |
151 | local host, so if you want to use `~' in those commands, you should | |
152 | choose a shell here which groks tilde expansion. `/bin/sh' normally | |
153 | does not understand tilde expansion. | |
154 | ||
155 | For encoding and deocding, commands like the following are executed: | |
156 | ||
157 | /bin/sh -c COMMAND < INPUT > OUTPUT | |
158 | ||
159 | This variable can be used to change the \"/bin/sh\" part. See the | |
00d6fd04 | 160 | variable `tramp-encoding-command-switch' for the \"-c\" part. |
fb7933a3 | 161 | |
36b148cf MA |
162 | If the shell must be forced to be interactive, see |
163 | `tramp-encoding-command-interactive'. | |
164 | ||
fb7933a3 KG |
165 | Note that this variable is not used for remote commands. There are |
166 | mechanisms in tramp.el which automatically determine the right shell to | |
167 | use for the remote host." | |
168 | :group 'tramp | |
169 | :type '(file :must-match t)) | |
170 | ||
16674e4f KG |
171 | (defcustom tramp-encoding-command-switch |
172 | (if (string-match "cmd\\.exe" tramp-encoding-shell) | |
173 | "/c" | |
174 | "-c") | |
175 | "*Use this switch together with `tramp-encoding-shell' for local commands. | |
176 | See the variable `tramp-encoding-shell' for more information." | |
177 | :group 'tramp | |
178 | :type 'string) | |
179 | ||
36b148cf MA |
180 | (defcustom tramp-encoding-command-interactive |
181 | (unless (string-match "cmd\\.exe" tramp-encoding-shell) "-i") | |
182 | "*Use this switch together with `tramp-encoding-shell' for interactive shells. | |
183 | See the variable `tramp-encoding-shell' for more information." | |
184 | :group 'tramp | |
185 | :type '(choice (const nil) string)) | |
186 | ||
0f34aa77 | 187 | ;;;###tramp-autoload |
03c1ad43 | 188 | (defvar tramp-methods nil |
fb7933a3 KG |
189 | "*Alist of methods for remote files. |
190 | This is a list of entries of the form (NAME PARAM1 PARAM2 ...). | |
191 | Each NAME stands for a remote access method. Each PARAM is a | |
192 | pair of the form (KEY VALUE). The following KEYs are defined: | |
fb7933a3 KG |
193 | * `tramp-remote-sh' |
194 | This specifies the Bourne shell to use on the remote host. This | |
195 | MUST be a Bourne-like shell. It is normally not necessary to set | |
a4aeb9a4 | 196 | this to any value other than \"/bin/sh\": Tramp wants to use a shell |
fb7933a3 KG |
197 | which groks tilde expansion, but it can search for it. Also note |
198 | that \"/bin/sh\" exists on all Unixen, this might not be true for | |
199 | the value that you decide to use. You Have Been Warned. | |
b25a52cc KG |
200 | * `tramp-login-program' |
201 | This specifies the name of the program to use for logging in to the | |
00d6fd04 MA |
202 | remote host. This may be the name of rsh or a workalike program, |
203 | or the name of telnet or a workalike, or the name of su or a workalike. | |
b25a52cc | 204 | * `tramp-login-args' |
fb7933a3 | 205 | This specifies the list of arguments to pass to the above |
00d6fd04 | 206 | mentioned program. Please note that this is a list of list of arguments, |
fb7933a3 | 207 | that is, normally you don't want to put \"-a -b\" or \"-f foo\" |
00d6fd04 MA |
208 | here. Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\"). |
209 | There are some patterns: \"%h\" in this list is replaced by the host | |
210 | name, \"%u\" is replaced by the user name, \"%p\" is replaced by the | |
211 | port number, and \"%%\" can be used to obtain a literal percent character. | |
212 | If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during | |
213 | expansion (i.e. no host or no user specified), this list is not used as | |
214 | argument. By this, arguments like (\"-l\" \"%u\") are optional. | |
215 | \"%t\" is replaced by the temporary file name produced with | |
216 | `tramp-make-tramp-temp-file'. \"%k\" indicates the keep-date | |
217 | parameter of a program, if exists. | |
a7723e05 MA |
218 | * `tramp-async-args' |
219 | When an asynchronous process is started, we know already that | |
220 | the connection works. Therefore, we can pass additional | |
221 | parameters to suppress diagnostic messages, in order not to | |
222 | tamper the process output. | |
b25a52cc KG |
223 | * `tramp-copy-program' |
224 | This specifies the name of the program to use for remotely copying | |
225 | the file; this might be the absolute filename of rcp or the name of | |
226 | a workalike program. | |
227 | * `tramp-copy-args' | |
fb7933a3 | 228 | This specifies the list of parameters to pass to the above mentioned |
b25a52cc | 229 | program, the hints for `tramp-login-args' also apply here. |
00d6fd04 MA |
230 | * `tramp-copy-keep-date' |
231 | This specifies whether the copying program when the preserves the | |
232 | timestamp of the original file. | |
b88f2d0a MA |
233 | * `tramp-copy-keep-tmpfile' |
234 | This specifies whether a temporary local file shall be kept | |
235 | for optimization reasons (useful for \"rsync\" methods). | |
236 | * `tramp-copy-recursive' | |
237 | Whether the operation copies directories recursively. | |
00d6fd04 MA |
238 | * `tramp-default-port' |
239 | The default port of a method is needed in case of gateway connections. | |
240 | Additionally, it is used as indication which method is prepared for | |
241 | passing gateways. | |
242 | * `tramp-gw-args' | |
243 | As the attribute name says, additional arguments are specified here | |
244 | when a method is applied via a gateway. | |
90f8dc03 KG |
245 | * `tramp-password-end-of-line' |
246 | This specifies the string to use for terminating the line after | |
247 | submitting the password. If this method parameter is nil, then the | |
248 | value of the normal variable `tramp-default-password-end-of-line' | |
249 | is used. This parameter is necessary because the \"plink\" program | |
250 | requires any two characters after sending the password. These do | |
251 | not have to be newline or carriage return characters. Other login | |
252 | programs are happy with just one character, the newline character. | |
253 | We use \"xy\" as the value for methods using \"plink\". | |
b25a52cc KG |
254 | |
255 | What does all this mean? Well, you should specify `tramp-login-program' | |
256 | for all methods; this program is used to log in to the remote site. Then, | |
257 | there are two ways to actually transfer the files between the local and the | |
258 | remote side. One way is using an additional rcp-like program. If you want | |
259 | to do this, set `tramp-copy-program' in the method. | |
fb7933a3 KG |
260 | |
261 | Another possibility for file transfer is inline transfer, i.e. the | |
b25a52cc | 262 | file is passed through the same buffer used by `tramp-login-program'. In |
fb7933a3 | 263 | this case, the file contents need to be protected since the |
b25a52cc | 264 | `tramp-login-program' might use escape codes or the connection might not |
fb7933a3 | 265 | be eight-bit clean. Therefore, file contents are encoded for transit. |
00d6fd04 MA |
266 | See the variables `tramp-local-coding-commands' and |
267 | `tramp-remote-coding-commands' for details. | |
fb7933a3 | 268 | |
16674e4f | 269 | So, to summarize: if the method is an out-of-band method, then you |
b25a52cc | 270 | must specify `tramp-copy-program' and `tramp-copy-args'. If it is an |
00d6fd04 MA |
271 | inline method, then these two parameters should be nil. Methods which |
272 | are fit for gateways must have `tramp-default-port' at least. | |
fb7933a3 KG |
273 | |
274 | Notes: | |
275 | ||
00d6fd04 MA |
276 | When using `su' or `sudo' the phrase `open connection to a remote |
277 | host' sounds strange, but it is used nevertheless, for consistency. | |
278 | No connection is opened to a remote host, but `su' or `sudo' is | |
279 | started on the local host. You should specify a remote host | |
280 | `localhost' or the name of the local host. Another host name is | |
281 | useful only in combination with `tramp-default-proxies-alist'.") | |
fb7933a3 | 282 | |
a92375d9 MA |
283 | (defun tramp-detect-ssh-controlmaster () |
284 | "Call ssh to detect whether it supports the ControlMaster argument. | |
285 | This function may return nil when the argument is supported, but | |
286 | shouldn't return t when it isn't." | |
287 | (ignore-errors | |
288 | (with-temp-buffer | |
289 | (call-process "ssh" nil t nil "-o" "ControlMaster") | |
290 | (goto-char (point-min)) | |
291 | (search-forward-regexp "Missing ControlMaster argument" nil t)))) | |
292 | ||
b25a52cc | 293 | (defcustom tramp-default-method |
83e20b5c MA |
294 | ;; An external copy method seems to be preferred, because it is much |
295 | ;; more performant for large files, and it hasn't too serious delays | |
296 | ;; for small files. But it must be ensured that there aren't | |
297 | ;; permanent password queries. Either a password agent like | |
263c02ef MA |
298 | ;; "ssh-agent" or "Pageant" shall run, or the optional |
299 | ;; password-cache.el or auth-sources.el packages shall be active for | |
a92375d9 MA |
300 | ;; password caching. "scpc" is chosen if we detect that the user is |
301 | ;; running OpenSSH 4.0 or newer. | |
00d6fd04 | 302 | (cond |
362b9d48 GM |
303 | ;; PuTTY is installed. We don't take it, if it is installed on a |
304 | ;; non-windows system, or pscp from the pssh (parallel ssh) package | |
305 | ;; is found. | |
306 | ((and (eq system-type 'windows-nt) | |
307 | (executable-find "pscp")) | |
00d6fd04 | 308 | (if (or (fboundp 'password-read) |
263c02ef | 309 | (fboundp 'auth-source-user-or-password) |
563790b6 | 310 | (fboundp 'auth-source-search) |
00d6fd04 | 311 | ;; Pageant is running. |
70c11b0b | 312 | (tramp-compat-process-running-p "Pageant")) |
00d6fd04 MA |
313 | "pscp" |
314 | "plink")) | |
315 | ;; There is an ssh installation. | |
316 | ((executable-find "scp") | |
a92375d9 MA |
317 | (cond |
318 | ((tramp-detect-ssh-controlmaster) "scpc") | |
319 | ((or (fboundp 'password-read) | |
320 | (fboundp 'auth-source-user-or-password) | |
563790b6 | 321 | (fboundp 'auth-source-search) |
a92375d9 MA |
322 | ;; ssh-agent is running. |
323 | (getenv "SSH_AUTH_SOCK") | |
324 | (getenv "SSH_AGENT_PID")) | |
325 | "scp") | |
326 | (t "ssh"))) | |
00d6fd04 MA |
327 | ;; Fallback. |
328 | (t "ftp")) | |
fb7933a3 | 329 | "*Default method to use for transferring files. |
c62c9d08 | 330 | See `tramp-methods' for possibilities. |
4007ba5b | 331 | Also see `tramp-default-method-alist'." |
c62c9d08 KG |
332 | :group 'tramp |
333 | :type 'string) | |
334 | ||
b191c9d9 | 335 | ;;;###tramp-autoload |
03c1ad43 | 336 | (defcustom tramp-default-method-alist nil |
00d6fd04 | 337 | "*Default method to use for specific host/user pairs. |
c62c9d08 KG |
338 | This is an alist of items (HOST USER METHOD). The first matching item |
339 | specifies the method to use for a file name which does not specify a | |
340 | method. HOST and USER are regular expressions or nil, which is | |
341 | interpreted as a regular expression which always matches. If no entry | |
342 | matches, the variable `tramp-default-method' takes effect. | |
343 | ||
344 | If the file name does not specify the user, lookup is done using the | |
345 | empty string for the user name. | |
346 | ||
347 | See `tramp-methods' for a list of possibilities for METHOD." | |
348 | :group 'tramp | |
e40fc745 MA |
349 | :type '(repeat (list (choice :tag "Host regexp" regexp sexp) |
350 | (choice :tag "User regexp" regexp sexp) | |
351 | (choice :tag "Method name" string (const nil))))) | |
c62c9d08 | 352 | |
03c1ad43 | 353 | (defcustom tramp-default-user nil |
00d6fd04 MA |
354 | "*Default user to use for transferring files. |
355 | It is nil by default; otherwise settings in configuration files like | |
356 | \"~/.ssh/config\" would be overwritten. Also see `tramp-default-user-alist'. | |
357 | ||
358 | This variable is regarded as obsolete, and will be removed soon." | |
359 | :group 'tramp | |
360 | :type '(choice (const nil) string)) | |
361 | ||
b191c9d9 | 362 | ;;;###tramp-autoload |
03c1ad43 | 363 | (defcustom tramp-default-user-alist nil |
00d6fd04 MA |
364 | "*Default user to use for specific method/host pairs. |
365 | This is an alist of items (METHOD HOST USER). The first matching item | |
366 | specifies the user to use for a file name which does not specify a | |
367 | user. METHOD and USER are regular expressions or nil, which is | |
368 | interpreted as a regular expression which always matches. If no entry | |
369 | matches, the variable `tramp-default-user' takes effect. | |
370 | ||
371 | If the file name does not specify the method, lookup is done using the | |
372 | empty string for the method name." | |
373 | :group 'tramp | |
e40fc745 MA |
374 | :type '(repeat (list (choice :tag "Method regexp" regexp sexp) |
375 | (choice :tag " Host regexp" regexp sexp) | |
376 | (choice :tag " User name" string (const nil))))) | |
00d6fd04 | 377 | |
03c1ad43 | 378 | (defcustom tramp-default-host (system-name) |
00d6fd04 MA |
379 | "*Default host to use for transferring files. |
380 | Useful for su and sudo methods mostly." | |
381 | :group 'tramp | |
382 | :type 'string) | |
383 | ||
384 | (defcustom tramp-default-proxies-alist nil | |
385 | "*Route to be followed for specific host/user pairs. | |
386 | This is an alist of items (HOST USER PROXY). The first matching | |
387 | item specifies the proxy to be passed for a file name located on | |
388 | a remote target matching USER@HOST. HOST and USER are regular | |
70c11b0b MA |
389 | expressions. PROXY must be a Tramp filename without a localname |
390 | part. Method and user name on PROXY are optional, which is | |
391 | interpreted with the default values. PROXY can contain the | |
392 | patterns %h and %u, which are replaced by the strings matching | |
393 | HOST or USER, respectively. | |
394 | ||
395 | HOST, USER or PROXY could also be Lisp forms, which will be | |
396 | evaluated. The result must be a string or nil, which is | |
397 | interpreted as a regular expression which always matches." | |
00d6fd04 | 398 | :group 'tramp |
70c11b0b MA |
399 | :type '(repeat (list (choice :tag "Host regexp" regexp sexp) |
400 | (choice :tag "User regexp" regexp sexp) | |
e40fc745 | 401 | (choice :tag " Proxy name" string (const nil))))) |
00d6fd04 | 402 | |
b191c9d9 | 403 | ;;;###tramp-autoload |
b96e6899 MA |
404 | (defconst tramp-local-host-regexp |
405 | (concat | |
66feec8b MA |
406 | "\\`" |
407 | (regexp-opt | |
408 | (list "localhost" "localhost6" (system-name) "127\.0\.0\.1" "::1") t) | |
409 | "\\'") | |
b96e6899 MA |
410 | "*Host names which are regarded as local host.") |
411 | ||
5ec2cc41 | 412 | (defvar tramp-completion-function-alist nil |
16674e4f | 413 | "*Alist of methods for remote files. |
b533bc97 | 414 | This is a list of entries of the form \(NAME PAIR1 PAIR2 ...\). |
16674e4f | 415 | Each NAME stands for a remote access method. Each PAIR is of the form |
b533bc97 | 416 | \(FUNCTION FILE\). FUNCTION is responsible to extract user names and host |
16674e4f KG |
417 | names from FILE for completion. The following predefined FUNCTIONs exists: |
418 | ||
5ec2cc41 KG |
419 | * `tramp-parse-rhosts' for \"~/.rhosts\" like files, |
420 | * `tramp-parse-shosts' for \"~/.ssh/known_hosts\" like files, | |
421 | * `tramp-parse-sconfig' for \"~/.ssh/config\" like files, | |
422 | * `tramp-parse-shostkeys' for \"~/.ssh2/hostkeys/*\" like files, | |
423 | * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files, | |
424 | * `tramp-parse-hosts' for \"/etc/hosts\" like files, | |
425 | * `tramp-parse-passwd' for \"/etc/passwd\" like files. | |
426 | * `tramp-parse-netrc' for \"~/.netrc\" like files. | |
00d6fd04 | 427 | * `tramp-parse-putty' for PuTTY registry keys. |
5ec2cc41 KG |
428 | |
429 | FUNCTION can also be a customer defined function. For more details see | |
430 | the info pages.") | |
431 | ||
674da028 MA |
432 | (defconst tramp-echo-mark-marker "_echo" |
433 | "String marker to surround echoed commands.") | |
434 | ||
68712eb6 MA |
435 | (defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker) |
436 | "String length of `tramp-echo-mark-marker'.") | |
437 | ||
438 | (defconst tramp-echo-mark | |
439 | (concat tramp-echo-mark-marker | |
440 | (make-string tramp-echo-mark-marker-length ?\b)) | |
00d6fd04 MA |
441 | "String mark to be transmitted around shell commands. |
442 | Used to separate their echo from the output they produce. This | |
443 | will only be used if we cannot disable remote echo via stty. | |
444 | This string must have no effect on the remote shell except for | |
445 | producing some echo which can later be detected by | |
674da028 MA |
446 | `tramp-echoed-echo-mark-regexp'. Using `tramp-echo-mark-marker', |
447 | followed by an equal number of backspaces to erase them will | |
448 | usually suffice.") | |
00d6fd04 | 449 | |
68712eb6 MA |
450 | (defconst tramp-echoed-echo-mark-regexp |
451 | (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}" | |
452 | tramp-echo-mark-marker tramp-echo-mark-marker-length) | |
00d6fd04 MA |
453 | "Regexp which matches `tramp-echo-mark' as it gets echoed by |
454 | the remote shell.") | |
455 | ||
fb7933a3 KG |
456 | (defcustom tramp-rsh-end-of-line "\n" |
457 | "*String used for end of line in rsh connections. | |
458 | I don't think this ever needs to be changed, so please tell me about it | |
16674e4f | 459 | if you need to change this. |
90f8dc03 KG |
460 | Also see the method parameter `tramp-password-end-of-line' and the normal |
461 | variable `tramp-default-password-end-of-line'." | |
16674e4f KG |
462 | :group 'tramp |
463 | :type 'string) | |
464 | ||
90f8dc03 KG |
465 | (defcustom tramp-default-password-end-of-line |
466 | tramp-rsh-end-of-line | |
16674e4f | 467 | "*String used for end of line after sending a password. |
90f8dc03 KG |
468 | This variable provides the default value for the method parameter |
469 | `tramp-password-end-of-line', see `tramp-methods' for more details. | |
470 | ||
16674e4f KG |
471 | It seems that people using plink under Windows need to send |
472 | \"\\r\\n\" (carriage-return, then newline) after a password, but just | |
473 | \"\\n\" after all other lines. This variable can be used for the | |
474 | password, see `tramp-rsh-end-of-line' for the other cases. | |
475 | ||
476 | The default value is to use the same value as `tramp-rsh-end-of-line'." | |
fb7933a3 KG |
477 | :group 'tramp |
478 | :type 'string) | |
479 | ||
fb7933a3 | 480 | (defcustom tramp-login-prompt-regexp |
bc103d00 | 481 | ".*ogin\\( .*\\)?: *" |
fb7933a3 | 482 | "*Regexp matching login-like prompts. |
bc103d00 MA |
483 | The regexp should match at end of buffer. |
484 | ||
485 | Sometimes the prompt is reported to look like \"login as:\"." | |
fb7933a3 KG |
486 | :group 'tramp |
487 | :type 'regexp) | |
488 | ||
821e6e36 | 489 | (defcustom tramp-shell-prompt-pattern |
aa485f7c | 490 | ;; Allow a prompt to start right after a ^M since it indeed would be |
b81a0b56 MA |
491 | ;; displayed at the beginning of the line (and Zsh uses it). This |
492 | ;; regexp works only for GNU Emacs. | |
493 | (concat (if (featurep 'xemacs) "" "\\(?:^\\|\r\\)") | |
494 | "[^#$%>\n]*#?[#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*") | |
821e6e36 KG |
495 | "Regexp to match prompts from remote shell. |
496 | Normally, Tramp expects you to configure `shell-prompt-pattern' | |
497 | correctly, but sometimes it happens that you are connecting to a | |
498 | remote host which sends a different kind of shell prompt. Therefore, | |
499 | Tramp recognizes things matched by `shell-prompt-pattern' as prompt, | |
500 | and also things matched by this variable. The default value of this | |
b25a52cc | 501 | variable is similar to the default value of `shell-prompt-pattern', |
dab816a9 MA |
502 | which should work well in many cases. |
503 | ||
504 | This regexp must match both `tramp-initial-end-of-output' and | |
505 | `tramp-end-of-output'." | |
821e6e36 KG |
506 | :group 'tramp |
507 | :type 'regexp) | |
508 | ||
fb7933a3 | 509 | (defcustom tramp-password-prompt-regexp |
00d6fd04 | 510 | "^.*\\([pP]assword\\|[pP]assphrase\\).*:\^@? *" |
fb7933a3 | 511 | "*Regexp matching password-like prompts. |
ac474af1 | 512 | The regexp should match at end of buffer. |
fb7933a3 KG |
513 | |
514 | The `sudo' program appears to insert a `^@' character into the prompt." | |
515 | :group 'tramp | |
516 | :type 'regexp) | |
517 | ||
518 | (defcustom tramp-wrong-passwd-regexp | |
b1d06e75 KG |
519 | (concat "^.*" |
520 | ;; These strings should be on the last line | |
a4aeb9a4 | 521 | (regexp-opt '("Permission denied" |
b1d06e75 KG |
522 | "Login incorrect" |
523 | "Login Incorrect" | |
524 | "Connection refused" | |
27e813fe | 525 | "Connection closed" |
7e5686f0 | 526 | "Timeout, server not responding." |
b1d06e75 KG |
527 | "Sorry, try again." |
528 | "Name or service not known" | |
00d6fd04 | 529 | "Host key verification failed." |
70c11b0b | 530 | "No supported authentication methods left to try!") t) |
b1d06e75 KG |
531 | ".*" |
532 | "\\|" | |
533 | "^.*\\(" | |
534 | ;; Here comes a list of regexes, separated by \\| | |
535 | "Received signal [0-9]+" | |
536 | "\\).*") | |
fb7933a3 | 537 | "*Regexp matching a `login failed' message. |
ac474af1 KG |
538 | The regexp should match at end of buffer." |
539 | :group 'tramp | |
540 | :type 'regexp) | |
541 | ||
542 | (defcustom tramp-yesno-prompt-regexp | |
3cdaec13 KG |
543 | (concat |
544 | (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t) | |
545 | "\\s-*") | |
546 | "Regular expression matching all yes/no queries which need to be confirmed. | |
ac474af1 | 547 | The confirmation should be done with yes or no. |
3cdaec13 KG |
548 | The regexp should match at end of buffer. |
549 | See also `tramp-yn-prompt-regexp'." | |
fb7933a3 KG |
550 | :group 'tramp |
551 | :type 'regexp) | |
552 | ||
3cdaec13 | 553 | (defcustom tramp-yn-prompt-regexp |
658052a2 MA |
554 | (concat |
555 | (regexp-opt '("Store key in cache? (y/n)" | |
556 | "Update cached key? (y/n, Return cancels connection)") t) | |
557 | "\\s-*") | |
3cdaec13 KG |
558 | "Regular expression matching all y/n queries which need to be confirmed. |
559 | The confirmation should be done with y or n. | |
560 | The regexp should match at end of buffer. | |
561 | See also `tramp-yesno-prompt-regexp'." | |
562 | :group 'tramp | |
563 | :type 'regexp) | |
487f4fb7 KG |
564 | |
565 | (defcustom tramp-terminal-prompt-regexp | |
566 | (concat "\\(" | |
567 | "TERM = (.*)" | |
568 | "\\|" | |
569 | "Terminal type\\? \\[.*\\]" | |
570 | "\\)\\s-*") | |
571 | "Regular expression matching all terminal setting prompts. | |
572 | The regexp should match at end of buffer. | |
573 | The answer will be provided by `tramp-action-terminal', which see." | |
574 | :group 'tramp | |
575 | :type 'regexp) | |
3cdaec13 | 576 | |
01917a18 MA |
577 | (defcustom tramp-operation-not-permitted-regexp |
578 | (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*" | |
579 | (regexp-opt '("Operation not permitted") t)) | |
580 | "Regular expression matching keep-date problems in (s)cp operations. | |
581 | Copying has been performed successfully already, so this message can | |
582 | be ignored safely." | |
583 | :group 'tramp | |
584 | :type 'regexp) | |
585 | ||
6b2633cc LH |
586 | (defcustom tramp-copy-failed-regexp |
587 | (concat "\\(.+: " | |
588 | (regexp-opt '("Permission denied" | |
589 | "not a regular file" | |
590 | "is a directory" | |
591 | "No such file or directory") t) | |
592 | "\\)\\s-*") | |
593 | "Regular expression matching copy problems in (s)cp operations." | |
594 | :group 'tramp | |
595 | :type 'regexp) | |
596 | ||
19a87064 | 597 | (defcustom tramp-process-alive-regexp |
38c65fca | 598 | "" |
19a87064 | 599 | "Regular expression indicating a process has finished. |
38c65fca KG |
600 | In fact this expression is empty by intention, it will be used only to |
601 | check regularly the status of the associated process. | |
07dfe738 | 602 | The answer will be provided by `tramp-action-process-alive', |
00d6fd04 | 603 | `tramp-action-out-of-band', which see." |
38c65fca KG |
604 | :group 'tramp |
605 | :type 'regexp) | |
606 | ||
03c1ad43 | 607 | (defconst tramp-temp-name-prefix "tramp." |
fb7933a3 KG |
608 | "*Prefix to use for temporary files. |
609 | If this is a relative file name (such as \"tramp.\"), it is considered | |
610 | relative to the directory name returned by the function | |
9e6ab520 | 611 | `tramp-compat-temporary-file-directory' (which see). It may also be an |
fb7933a3 | 612 | absolute file name; don't forget to include a prefix for the filename |
03c1ad43 | 613 | part, though.") |
fb7933a3 | 614 | |
2296b54d MA |
615 | (defconst tramp-temp-buffer-name " *tramp temp*" |
616 | "Buffer name for a temporary buffer. | |
617 | It shall be used in combination with `generate-new-buffer-name'.") | |
618 | ||
b88f2d0a MA |
619 | (defvar tramp-temp-buffer-file-name nil |
620 | "File name of a persistent local temporary file. | |
621 | Useful for \"rsync\" like methods.") | |
622 | (make-variable-buffer-local 'tramp-temp-buffer-file-name) | |
d68b0220 | 623 | (put 'tramp-temp-buffer-file-name 'permanent-local t) |
b88f2d0a | 624 | |
00d6fd04 MA |
625 | ;; XEmacs is distributed with few Lisp packages. Further packages are |
626 | ;; installed using EFS. If we use a unified filename format, then | |
627 | ;; Tramp is required in addition to EFS. (But why can't Tramp just | |
628 | ;; disable EFS when Tramp is loaded? Then XEmacs can ship with EFS | |
629 | ;; just like before.) Another reason for using a separate filename | |
630 | ;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but | |
631 | ;; Tramp only knows how to deal with `file-name-handler-alist', not | |
632 | ;; the other places. | |
633 | ||
634 | ;; Currently, we have the choice between 'ftp, 'sep, and 'url. | |
635 | ;;;###autoload | |
636 | (defcustom tramp-syntax | |
637 | (if (featurep 'xemacs) 'sep 'ftp) | |
638 | "Tramp filename syntax to be used. | |
639 | ||
640 | It can have the following values: | |
641 | ||
642 | 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default) | |
643 | 'sep -- Syntax as defined for XEmacs (not available yet for GNU Emacs) | |
644 | 'url -- URL-like syntax." | |
16674e4f | 645 | :group 'tramp |
00d6fd04 MA |
646 | :type (if (featurep 'xemacs) |
647 | '(choice (const :tag "EFS" ftp) | |
648 | (const :tag "XEmacs" sep) | |
649 | (const :tag "URL" url)) | |
650 | '(choice (const :tag "Ange-FTP" ftp) | |
651 | (const :tag "URL" url)))) | |
652 | ||
653 | (defconst tramp-prefix-format | |
654 | (cond ((equal tramp-syntax 'ftp) "/") | |
655 | ((equal tramp-syntax 'sep) "/[") | |
656 | ((equal tramp-syntax 'url) "/") | |
657 | (t (error "Wrong `tramp-syntax' defined"))) | |
a4aeb9a4 | 658 | "*String matching the very beginning of Tramp file names. |
00d6fd04 | 659 | Used in `tramp-make-tramp-file-name'.") |
16674e4f | 660 | |
00d6fd04 | 661 | (defconst tramp-prefix-regexp |
16674e4f | 662 | (concat "^" (regexp-quote tramp-prefix-format)) |
a4aeb9a4 | 663 | "*Regexp matching the very beginning of Tramp file names. |
00d6fd04 | 664 | Should always start with \"^\". Derived from `tramp-prefix-format'.") |
16674e4f | 665 | |
00d6fd04 | 666 | (defconst tramp-method-regexp |
16674e4f | 667 | "[a-zA-Z_0-9-]+" |
00d6fd04 | 668 | "*Regexp matching methods identifiers.") |
16674e4f | 669 | |
00d6fd04 MA |
670 | (defconst tramp-postfix-method-format |
671 | (cond ((equal tramp-syntax 'ftp) ":") | |
672 | ((equal tramp-syntax 'sep) "/") | |
673 | ((equal tramp-syntax 'url) "://") | |
674 | (t (error "Wrong `tramp-syntax' defined"))) | |
51aba3f3 | 675 | "*String matching delimiter between method and user or host names. |
00d6fd04 | 676 | Used in `tramp-make-tramp-file-name'.") |
16674e4f | 677 | |
00d6fd04 MA |
678 | (defconst tramp-postfix-method-regexp |
679 | (regexp-quote tramp-postfix-method-format) | |
51aba3f3 | 680 | "*Regexp matching delimiter between method and user or host names. |
00d6fd04 | 681 | Derived from `tramp-postfix-method-format'.") |
16674e4f | 682 | |
03c1ad43 | 683 | (defconst tramp-user-regexp "[^:/ \t]+" |
00d6fd04 | 684 | "*Regexp matching user names.") |
16674e4f | 685 | |
b191c9d9 | 686 | ;;;###tramp-autoload |
b96e6899 | 687 | (defconst tramp-prefix-domain-format "%" |
51aba3f3 | 688 | "*String matching delimiter between user and domain names.") |
b96e6899 | 689 | |
b191c9d9 | 690 | ;;;###tramp-autoload |
b96e6899 MA |
691 | (defconst tramp-prefix-domain-regexp |
692 | (regexp-quote tramp-prefix-domain-format) | |
51aba3f3 | 693 | "*Regexp matching delimiter between user and domain names. |
b96e6899 MA |
694 | Derived from `tramp-prefix-domain-format'.") |
695 | ||
03c1ad43 | 696 | (defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+" |
b96e6899 MA |
697 | "*Regexp matching domain names.") |
698 | ||
699 | (defconst tramp-user-with-domain-regexp | |
700 | (concat "\\(" tramp-user-regexp "\\)" | |
701 | tramp-prefix-domain-regexp | |
702 | "\\(" tramp-domain-regexp "\\)") | |
703 | "*Regexp matching user names with domain names.") | |
704 | ||
03c1ad43 | 705 | (defconst tramp-postfix-user-format "@" |
51aba3f3 | 706 | "*String matching delimiter between user and host names. |
00d6fd04 | 707 | Used in `tramp-make-tramp-file-name'.") |
16674e4f | 708 | |
00d6fd04 | 709 | (defconst tramp-postfix-user-regexp |
16674e4f | 710 | (regexp-quote tramp-postfix-user-format) |
51aba3f3 | 711 | "*Regexp matching delimiter between user and host names. |
00d6fd04 MA |
712 | Derived from `tramp-postfix-user-format'.") |
713 | ||
03c1ad43 | 714 | (defconst tramp-host-regexp "[a-zA-Z0-9_.-]+" |
00d6fd04 MA |
715 | "*Regexp matching host names.") |
716 | ||
b96e6899 MA |
717 | (defconst tramp-prefix-ipv6-format |
718 | (cond ((equal tramp-syntax 'ftp) "[") | |
719 | ((equal tramp-syntax 'sep) "") | |
720 | ((equal tramp-syntax 'url) "[") | |
721 | (t (error "Wrong `tramp-syntax' defined"))) | |
722 | "*String matching left hand side of IPv6 addresses. | |
723 | Used in `tramp-make-tramp-file-name'.") | |
724 | ||
725 | (defconst tramp-prefix-ipv6-regexp | |
726 | (regexp-quote tramp-prefix-ipv6-format) | |
727 | "*Regexp matching left hand side of IPv6 addresses. | |
728 | Derived from `tramp-prefix-ipv6-format'.") | |
729 | ||
e0b6e3b9 MA |
730 | ;; The following regexp is a bit sloppy. But it shall serve our |
731 | ;; purposes. It covers also IPv4 mapped IPv6 addresses, like in | |
732 | ;; "::ffff:192.168.0.1". | |
b96e6899 | 733 | (defconst tramp-ipv6-regexp |
e0b6e3b9 | 734 | "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+" |
b96e6899 MA |
735 | "*Regexp matching IPv6 addresses.") |
736 | ||
737 | (defconst tramp-postfix-ipv6-format | |
738 | (cond ((equal tramp-syntax 'ftp) "]") | |
739 | ((equal tramp-syntax 'sep) "") | |
740 | ((equal tramp-syntax 'url) "]") | |
741 | (t (error "Wrong `tramp-syntax' defined"))) | |
742 | "*String matching right hand side of IPv6 addresses. | |
743 | Used in `tramp-make-tramp-file-name'.") | |
744 | ||
745 | (defconst tramp-postfix-ipv6-regexp | |
746 | (regexp-quote tramp-postfix-ipv6-format) | |
747 | "*Regexp matching right hand side of IPv6 addresses. | |
748 | Derived from `tramp-postfix-ipv6-format'.") | |
749 | ||
00d6fd04 MA |
750 | (defconst tramp-prefix-port-format |
751 | (cond ((equal tramp-syntax 'ftp) "#") | |
752 | ((equal tramp-syntax 'sep) "#") | |
753 | ((equal tramp-syntax 'url) ":") | |
754 | (t (error "Wrong `tramp-syntax' defined"))) | |
51aba3f3 | 755 | "*String matching delimiter between host names and port numbers.") |
00d6fd04 MA |
756 | |
757 | (defconst tramp-prefix-port-regexp | |
758 | (regexp-quote tramp-prefix-port-format) | |
51aba3f3 | 759 | "*Regexp matching delimiter between host names and port numbers. |
00d6fd04 MA |
760 | Derived from `tramp-prefix-port-format'.") |
761 | ||
03c1ad43 | 762 | (defconst tramp-port-regexp "[0-9]+" |
00d6fd04 MA |
763 | "*Regexp matching port numbers.") |
764 | ||
765 | (defconst tramp-host-with-port-regexp | |
766 | (concat "\\(" tramp-host-regexp "\\)" | |
767 | tramp-prefix-port-regexp | |
768 | "\\(" tramp-port-regexp "\\)") | |
769 | "*Regexp matching host names with port numbers.") | |
770 | ||
771 | (defconst tramp-postfix-host-format | |
772 | (cond ((equal tramp-syntax 'ftp) ":") | |
773 | ((equal tramp-syntax 'sep) "]") | |
774 | ((equal tramp-syntax 'url) "") | |
775 | (t (error "Wrong `tramp-syntax' defined"))) | |
51aba3f3 | 776 | "*String matching delimiter between host names and localnames. |
00d6fd04 | 777 | Used in `tramp-make-tramp-file-name'.") |
16674e4f | 778 | |
00d6fd04 | 779 | (defconst tramp-postfix-host-regexp |
16674e4f | 780 | (regexp-quote tramp-postfix-host-format) |
51aba3f3 | 781 | "*Regexp matching delimiter between host names and localnames. |
00d6fd04 | 782 | Derived from `tramp-postfix-host-format'.") |
16674e4f | 783 | |
03c1ad43 | 784 | (defconst tramp-localname-regexp ".*$" |
00d6fd04 | 785 | "*Regexp matching localnames.") |
16674e4f | 786 | |
4a93e698 | 787 | ;;; File name format: |
505edaeb | 788 | |
00d6fd04 | 789 | (defconst tramp-file-name-structure |
16674e4f KG |
790 | (list |
791 | (concat | |
792 | tramp-prefix-regexp | |
00d6fd04 MA |
793 | "\\(" "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?" |
794 | "\\(" "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp "\\)?" | |
b96e6899 MA |
795 | "\\(" "\\(" tramp-host-regexp |
796 | "\\|" | |
797 | tramp-prefix-ipv6-regexp tramp-ipv6-regexp | |
798 | tramp-postfix-ipv6-regexp "\\)" | |
799 | "\\(" tramp-prefix-port-regexp tramp-port-regexp "\\)?" "\\)?" | |
00d6fd04 MA |
800 | tramp-postfix-host-regexp |
801 | "\\(" tramp-localname-regexp "\\)") | |
b96e6899 | 802 | 2 4 5 8) |
16674e4f | 803 | |
fb7933a3 | 804 | "*List of five elements (REGEXP METHOD USER HOST FILE), detailing \ |
a4aeb9a4 | 805 | the Tramp file name structure. |
fb7933a3 | 806 | |
a4aeb9a4 | 807 | The first element REGEXP is a regular expression matching a Tramp file |
fb7933a3 KG |
808 | name. The regex should contain parentheses around the method name, |
809 | the user name, the host name, and the file name parts. | |
810 | ||
811 | The second element METHOD is a number, saying which pair of | |
812 | parentheses matches the method name. The third element USER is | |
813 | similar, but for the user name. The fourth element HOST is similar, | |
814 | but for the host name. The fifth element FILE is for the file name. | |
815 | These numbers are passed directly to `match-string', which see. That | |
816 | means the opening parentheses are counted to identify the pair. | |
817 | ||
00d6fd04 | 818 | See also `tramp-file-name-regexp'.") |
fb7933a3 KG |
819 | |
820 | ;;;###autoload | |
505edaeb | 821 | (defconst tramp-file-name-regexp-unified |
1eb5ca1c MA |
822 | (if (memq system-type '(cygwin windows-nt)) |
823 | "\\`/\\([^[/:]\\{2,\\}\\|[^/]\\{2,\\}]\\):" | |
824 | "\\`/\\([^[/:]+\\|[^/]+]\\):") | |
505edaeb KG |
825 | "Value for `tramp-file-name-regexp' for unified remoting. |
826 | Emacs (not XEmacs) uses a unified filename syntax for Ange-FTP and | |
1eb5ca1c MA |
827 | Tramp. See `tramp-file-name-structure' for more explanations. |
828 | ||
829 | On W32 systems, the volume letter must be ignored.") | |
505edaeb KG |
830 | |
831 | ;;;###autoload | |
03c1ad43 | 832 | (defconst tramp-file-name-regexp-separate "\\`/\\[.*\\]" |
505edaeb KG |
833 | "Value for `tramp-file-name-regexp' for separate remoting. |
834 | XEmacs uses a separate filename syntax for Tramp and EFS. | |
00d6fd04 | 835 | See `tramp-file-name-structure' for more explanations.") |
505edaeb KG |
836 | |
837 | ;;;###autoload | |
03c1ad43 | 838 | (defconst tramp-file-name-regexp-url "\\`/[^/:]+://" |
00d6fd04 MA |
839 | "Value for `tramp-file-name-regexp' for URL-like remoting. |
840 | See `tramp-file-name-structure' for more explanations.") | |
841 | ||
842 | ;;;###autoload | |
843 | (defconst tramp-file-name-regexp | |
844 | (cond ((equal tramp-syntax 'ftp) tramp-file-name-regexp-unified) | |
845 | ((equal tramp-syntax 'sep) tramp-file-name-regexp-separate) | |
846 | ((equal tramp-syntax 'url) tramp-file-name-regexp-url) | |
847 | (t (error "Wrong `tramp-syntax' defined"))) | |
94be87e8 | 848 | "*Regular expression matching file names handled by Tramp. |
a4aeb9a4 | 849 | This regexp should match Tramp file names but no other file names. |
b533bc97 | 850 | When tramp.el is loaded, this regular expression is prepended to |
fb7933a3 | 851 | `file-name-handler-alist', and that is searched sequentially. Thus, |
a4aeb9a4 MA |
852 | if the Tramp entry appears rather early in the `file-name-handler-alist' |
853 | and is a bit too general, then some files might be considered Tramp | |
00d6fd04 | 854 | files which are not really Tramp files. |
fb7933a3 KG |
855 | |
856 | Please note that the entry in `file-name-handler-alist' is made when | |
b533bc97 | 857 | this file \(tramp.el\) is loaded. This means that this variable must be set |
fb7933a3 KG |
858 | before loading tramp.el. Alternatively, `file-name-handler-alist' can be |
859 | updated after changing this variable. | |
860 | ||
00d6fd04 | 861 | Also see `tramp-file-name-structure'.") |
fb7933a3 | 862 | |
8a798e41 MA |
863 | ;;;###autoload |
864 | (defconst tramp-completion-file-name-regexp-unified | |
1eb5ca1c | 865 | (if (memq system-type '(cygwin windows-nt)) |
5bc3b51d | 866 | "\\`/[^/]\\{2,\\}\\'" "\\`/[^/]*\\'") |
16674e4f | 867 | "Value for `tramp-completion-file-name-regexp' for unified remoting. |
8a798e41 | 868 | GNU Emacs uses a unified filename syntax for Tramp and Ange-FTP. |
1eb5ca1c MA |
869 | See `tramp-file-name-structure' for more explanations. |
870 | ||
871 | On W32 systems, the volume letter must be ignored.") | |
fb7933a3 | 872 | |
16674e4f KG |
873 | ;;;###autoload |
874 | (defconst tramp-completion-file-name-regexp-separate | |
5bc3b51d | 875 | "\\`/\\([[][^]]*\\)?\\'" |
16674e4f KG |
876 | "Value for `tramp-completion-file-name-regexp' for separate remoting. |
877 | XEmacs uses a separate filename syntax for Tramp and EFS. | |
00d6fd04 | 878 | See `tramp-file-name-structure' for more explanations.") |
fb7933a3 | 879 | |
16674e4f | 880 | ;;;###autoload |
00d6fd04 | 881 | (defconst tramp-completion-file-name-regexp-url |
5bc3b51d | 882 | "\\`/[^/:]+\\(:\\(/\\(/[^/]*\\)?\\)?\\)?\\'" |
00d6fd04 MA |
883 | "Value for `tramp-completion-file-name-regexp' for URL-like remoting. |
884 | See `tramp-file-name-structure' for more explanations.") | |
885 | ||
886 | ;;;###autoload | |
887 | (defconst tramp-completion-file-name-regexp | |
888 | (cond ((equal tramp-syntax 'ftp) tramp-completion-file-name-regexp-unified) | |
889 | ((equal tramp-syntax 'sep) tramp-completion-file-name-regexp-separate) | |
890 | ((equal tramp-syntax 'url) tramp-completion-file-name-regexp-url) | |
891 | (t (error "Wrong `tramp-syntax' defined"))) | |
a4aeb9a4 MA |
892 | "*Regular expression matching file names handled by Tramp completion. |
893 | This regexp should match partial Tramp file names only. | |
16674e4f KG |
894 | |
895 | Please note that the entry in `file-name-handler-alist' is made when | |
896 | this file (tramp.el) is loaded. This means that this variable must be set | |
897 | before loading tramp.el. Alternatively, `file-name-handler-alist' can be | |
898 | updated after changing this variable. | |
899 | ||
00d6fd04 | 900 | Also see `tramp-file-name-structure'.") |
fb7933a3 | 901 | |
00d6fd04 | 902 | ;; Chunked sending kludge. We set this to 500 for black-listed constellations |
7432277c | 903 | ;; known to have a bug in `process-send-string'; some ssh connections appear |
7177e2a3 MA |
904 | ;; to drop bytes when data is sent too quickly. There is also a connection |
905 | ;; buffer local variable, which is computed depending on remote host properties | |
906 | ;; when `tramp-chunksize' is zero or nil. | |
7432277c KG |
907 | (defcustom tramp-chunksize |
908 | (when (and (not (featurep 'xemacs)) | |
909 | (memq system-type '(hpux))) | |
910 | 500) | |
55880756 MA |
911 | ;; Parentheses in docstring starting at beginning of line are escaped. |
912 | ;; Fontification is messed up when | |
913 | ;; `open-paren-in-column-0-is-defun-start' set to t. | |
7432277c KG |
914 | "*If non-nil, chunksize for sending input to local process. |
915 | It is necessary only on systems which have a buggy `process-send-string' | |
916 | implementation. The necessity, whether this variable must be set, can be | |
917 | checked via the following code: | |
918 | ||
919 | (with-temp-buffer | |
11948172 MA |
920 | (let* ((user \"xxx\") (host \"yyy\") |
921 | (init 0) (step 50) | |
922 | (sent init) (received init)) | |
923 | (while (= sent received) | |
924 | (setq sent (+ sent step)) | |
925 | (erase-buffer) | |
926 | (let ((proc (start-process (buffer-name) (current-buffer) | |
927 | \"ssh\" \"-l\" user host \"wc\" \"-c\"))) | |
928 | (when (memq (process-status proc) '(run open)) | |
929 | (process-send-string proc (make-string sent ?\\ )) | |
930 | (process-send-eof proc) | |
931 | (process-send-eof proc)) | |
932 | (while (not (progn (goto-char (point-min)) | |
933 | (re-search-forward \"\\\\w+\" (point-max) t))) | |
934 | (accept-process-output proc 1)) | |
935 | (when (memq (process-status proc) '(run open)) | |
936 | (setq received (string-to-number (match-string 0))) | |
937 | (delete-process proc) | |
938 | (message \"Bytes sent: %s\\tBytes received: %s\" sent received) | |
939 | (sit-for 0)))) | |
940 | (if (> sent (+ init step)) | |
941 | (message \"You should set `tramp-chunksize' to a maximum of %s\" | |
942 | (- sent step)) | |
943 | (message \"Test does not work\") | |
944 | (display-buffer (current-buffer)) | |
945 | (sit-for 30)))) | |
946 | ||
947 | In the Emacs normally running Tramp, evaluate the above code | |
55880756 | 948 | \(replace \"xxx\" and \"yyy\" by the remote user and host name, |
b533bc97 | 949 | respectively\). You can do this, for example, by pasting it into |
11948172 MA |
950 | the `*scratch*' buffer and then hitting C-j with the cursor after the |
951 | last closing parenthesis. Note that it works only if you have configured | |
b533bc97 | 952 | \"ssh\" to run without password query, see ssh-agent\(1\). |
11948172 MA |
953 | |
954 | You will see the number of bytes sent successfully to the remote host. | |
955 | If that number exceeds 1000, you can stop the execution by hitting | |
956 | C-g, because your Emacs is likely clean. | |
957 | ||
11948172 | 958 | When it is necessary to set `tramp-chunksize', you might consider to |
b533bc97 MA |
959 | use an out-of-the-band method \(like \"scp\"\) instead of an internal one |
960 | \(like \"ssh\"\), because setting `tramp-chunksize' to non-nil decreases | |
11948172 | 961 | performance. |
c951aecb | 962 | |
00d6fd04 MA |
963 | If your Emacs is buggy, the code stops and gives you an indication |
964 | about the value `tramp-chunksize' should be set. Maybe you could just | |
965 | experiment a bit, e.g. changing the values of `init' and `step' | |
966 | in the third line of the code. | |
967 | ||
7432277c KG |
968 | Please raise a bug report via \"M-x tramp-bug\" if your system needs |
969 | this variable to be set as well." | |
970 | :group 'tramp | |
b1a2b924 | 971 | :type '(choice (const nil) integer)) |
7432277c | 972 | |
5ec2cc41 KG |
973 | ;; Logging in to a remote host normally requires obtaining a pty. But |
974 | ;; Emacs on MacOS X has process-connection-type set to nil by default, | |
975 | ;; so on those systems Tramp doesn't obtain a pty. Here, we allow | |
976 | ;; for an override of the system default. | |
977 | (defcustom tramp-process-connection-type t | |
978 | "Overrides `process-connection-type' for connections from Tramp. | |
979 | Tramp binds process-connection-type to the value given here before | |
980 | opening a connection to a remote host." | |
981 | :group 'tramp | |
982 | :type '(choice (const nil) (const t) (const pty))) | |
983 | ||
b50dd0d2 MA |
984 | (defcustom tramp-completion-reread-directory-timeout 10 |
985 | "Defines seconds since last remote command before rereading a directory. | |
986 | A remote directory might have changed its contents. In order to | |
987 | make it visible during file name completion in the minibuffer, | |
988 | Tramp flushes its cache and rereads the directory contents when | |
989 | more than `tramp-completion-reread-directory-timeout' seconds | |
4bc3c53d MA |
990 | have been gone since last remote command execution. A value of `t' |
991 | would require an immediate reread during filename completion, `nil' | |
b50dd0d2 MA |
992 | means to use always cached values for the directory contents." |
993 | :group 'tramp | |
994 | :type '(choice (const nil) integer)) | |
995 | ||
fb7933a3 KG |
996 | ;;; Internal Variables: |
997 | ||
fb7933a3 | 998 | (defvar tramp-current-method nil |
00d6fd04 | 999 | "Connection method for this *tramp* buffer.") |
fb7933a3 KG |
1000 | |
1001 | (defvar tramp-current-user nil | |
00d6fd04 | 1002 | "Remote login name for this *tramp* buffer.") |
fb7933a3 KG |
1003 | |
1004 | (defvar tramp-current-host nil | |
00d6fd04 MA |
1005 | "Remote host for this *tramp* buffer.") |
1006 | ||
a01b1e22 | 1007 | ;;;###autoload |
16674e4f | 1008 | (defconst tramp-completion-file-name-handler-alist |
a01b1e22 | 1009 | '((file-name-all-completions . tramp-completion-handle-file-name-all-completions) |
41c8e348 | 1010 | (file-name-completion . tramp-completion-handle-file-name-completion)) |
16674e4f | 1011 | "Alist of completion handler functions. |
03c1ad43 MA |
1012 | Used for file names matching `tramp-file-name-regexp'. Operations |
1013 | not mentioned here will be handled by Tramp's file name handler | |
1014 | functions, or the normal Emacs functions.") | |
16674e4f | 1015 | |
4007ba5b | 1016 | ;; Handlers for foreign methods, like FTP or SMB, shall be plugged here. |
0f34aa77 | 1017 | ;;;###tramp-autoload |
03c1ad43 | 1018 | (defvar tramp-foreign-file-name-handler-alist nil |
4007ba5b KG |
1019 | "Alist of elements (FUNCTION . HANDLER) for foreign methods handled specially. |
1020 | If (FUNCTION FILENAME) returns non-nil, then all I/O on that file is done by | |
1021 | calling HANDLER.") | |
1022 | ||
0664ff72 | 1023 | ;;; Internal functions which must come first: |
fb7933a3 | 1024 | |
0f34aa77 MA |
1025 | ;; Conversion functions between external representation and |
1026 | ;; internal data structure. Convenience functions for internal | |
1027 | ;; data structure. | |
1028 | ||
1029 | (defun tramp-file-name-p (vec) | |
1030 | "Check, whether VEC is a Tramp object." | |
1031 | (and (vectorp vec) (= 4 (length vec)))) | |
1032 | ||
1033 | (defun tramp-file-name-method (vec) | |
1034 | "Return method component of VEC." | |
1035 | (and (tramp-file-name-p vec) (aref vec 0))) | |
1036 | ||
1037 | (defun tramp-file-name-user (vec) | |
1038 | "Return user component of VEC." | |
1039 | (and (tramp-file-name-p vec) (aref vec 1))) | |
1040 | ||
1041 | (defun tramp-file-name-host (vec) | |
1042 | "Return host component of VEC." | |
1043 | (and (tramp-file-name-p vec) (aref vec 2))) | |
1044 | ||
1045 | (defun tramp-file-name-localname (vec) | |
1046 | "Return localname component of VEC." | |
1047 | (and (tramp-file-name-p vec) (aref vec 3))) | |
1048 | ||
1049 | ;; The user part of a Tramp file name vector can be of kind | |
1050 | ;; "user%domain". Sometimes, we must extract these parts. | |
1051 | (defun tramp-file-name-real-user (vec) | |
1052 | "Return the user name of VEC without domain." | |
1053 | (save-match-data | |
1054 | (let ((user (tramp-file-name-user vec))) | |
1055 | (if (and (stringp user) | |
1056 | (string-match tramp-user-with-domain-regexp user)) | |
1057 | (match-string 1 user) | |
1058 | user)))) | |
1059 | ||
1060 | (defun tramp-file-name-domain (vec) | |
1061 | "Return the domain name of VEC." | |
1062 | (save-match-data | |
1063 | (let ((user (tramp-file-name-user vec))) | |
1064 | (and (stringp user) | |
1065 | (string-match tramp-user-with-domain-regexp user) | |
1066 | (match-string 2 user))))) | |
1067 | ||
1068 | ;; The host part of a Tramp file name vector can be of kind | |
1069 | ;; "host#port". Sometimes, we must extract these parts. | |
1070 | (defun tramp-file-name-real-host (vec) | |
1071 | "Return the host name of VEC without port." | |
1072 | (save-match-data | |
1073 | (let ((host (tramp-file-name-host vec))) | |
1074 | (if (and (stringp host) | |
1075 | (string-match tramp-host-with-port-regexp host)) | |
1076 | (match-string 1 host) | |
1077 | host)))) | |
1078 | ||
1079 | (defun tramp-file-name-port (vec) | |
1080 | "Return the port number of VEC." | |
1081 | (save-match-data | |
66feec8b MA |
1082 | (let ((method (tramp-file-name-method vec)) |
1083 | (host (tramp-file-name-host vec))) | |
1084 | (or (and (stringp host) | |
1085 | (string-match tramp-host-with-port-regexp host) | |
1086 | (string-to-number (match-string 2 host))) | |
1087 | (tramp-get-method-parameter method 'tramp-default-port))))) | |
0f34aa77 MA |
1088 | |
1089 | ;;;###tramp-autoload | |
1090 | (defun tramp-tramp-file-p (name) | |
1091 | "Return t if NAME is a string with Tramp file name syntax." | |
1092 | (save-match-data | |
1093 | (and (stringp name) (string-match tramp-file-name-regexp name)))) | |
1094 | ||
1095 | (defun tramp-find-method (method user host) | |
1096 | "Return the right method string to use. | |
1097 | This is METHOD, if non-nil. Otherwise, do a lookup in | |
1098 | `tramp-default-method-alist'." | |
1099 | (or method | |
1100 | (let ((choices tramp-default-method-alist) | |
1101 | lmethod item) | |
1102 | (while choices | |
1103 | (setq item (pop choices)) | |
1104 | (when (and (string-match (or (nth 0 item) "") (or host "")) | |
1105 | (string-match (or (nth 1 item) "") (or user ""))) | |
1106 | (setq lmethod (nth 2 item)) | |
1107 | (setq choices nil))) | |
1108 | lmethod) | |
1109 | tramp-default-method)) | |
1110 | ||
1111 | (defun tramp-find-user (method user host) | |
1112 | "Return the right user string to use. | |
1113 | This is USER, if non-nil. Otherwise, do a lookup in | |
1114 | `tramp-default-user-alist'." | |
1115 | (or user | |
1116 | (let ((choices tramp-default-user-alist) | |
1117 | luser item) | |
1118 | (while choices | |
1119 | (setq item (pop choices)) | |
1120 | (when (and (string-match (or (nth 0 item) "") (or method "")) | |
1121 | (string-match (or (nth 1 item) "") (or host ""))) | |
1122 | (setq luser (nth 2 item)) | |
1123 | (setq choices nil))) | |
1124 | luser) | |
1125 | tramp-default-user)) | |
1126 | ||
1127 | (defun tramp-find-host (method user host) | |
1128 | "Return the right host string to use. | |
1129 | This is HOST, if non-nil. Otherwise, it is `tramp-default-host'." | |
1130 | (or (and (> (length host) 0) host) | |
1131 | tramp-default-host)) | |
1132 | ||
1133 | (defun tramp-dissect-file-name (name &optional nodefault) | |
1134 | "Return a `tramp-file-name' structure. | |
1135 | The structure consists of remote method, remote user, remote host | |
1136 | and localname (file name on remote host). If NODEFAULT is | |
1137 | non-nil, the file name parts are not expanded to their default | |
1138 | values." | |
1139 | (save-match-data | |
1140 | (let ((match (string-match (nth 0 tramp-file-name-structure) name))) | |
1141 | (unless match (error "Not a Tramp file name: %s" name)) | |
1142 | (let ((method (match-string (nth 1 tramp-file-name-structure) name)) | |
1143 | (user (match-string (nth 2 tramp-file-name-structure) name)) | |
1144 | (host (match-string (nth 3 tramp-file-name-structure) name)) | |
1145 | (localname (match-string (nth 4 tramp-file-name-structure) name))) | |
0f34aa77 MA |
1146 | (when host |
1147 | (when (string-match tramp-prefix-ipv6-regexp host) | |
1148 | (setq host (replace-match "" nil t host))) | |
1149 | (when (string-match tramp-postfix-ipv6-regexp host) | |
1150 | (setq host (replace-match "" nil t host)))) | |
1151 | (if nodefault | |
1152 | (vector method user host localname) | |
1153 | (vector | |
1154 | (tramp-find-method method user host) | |
1155 | (tramp-find-user method user host) | |
1156 | (tramp-find-host method user host) | |
1157 | localname)))))) | |
1158 | ||
1159 | (defun tramp-buffer-name (vec) | |
1160 | "A name for the connection buffer VEC." | |
1161 | ;; We must use `tramp-file-name-real-host', because for gateway | |
1162 | ;; methods the default port will be expanded later on, which would | |
1163 | ;; tamper the name. | |
1164 | (let ((method (tramp-file-name-method vec)) | |
1165 | (user (tramp-file-name-user vec)) | |
1166 | (host (tramp-file-name-real-host vec))) | |
1167 | (if (not (zerop (length user))) | |
1168 | (format "*tramp/%s %s@%s*" method user host) | |
1169 | (format "*tramp/%s %s*" method host)))) | |
1170 | ||
1171 | (defun tramp-make-tramp-file-name (method user host localname) | |
1172 | "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME." | |
1173 | (concat tramp-prefix-format | |
1174 | (when (not (zerop (length method))) | |
1175 | (concat method tramp-postfix-method-format)) | |
1176 | (when (not (zerop (length user))) | |
1177 | (concat user tramp-postfix-user-format)) | |
1178 | (when host | |
1179 | (if (string-match tramp-ipv6-regexp host) | |
1180 | (concat tramp-prefix-ipv6-format host tramp-postfix-ipv6-format) | |
1181 | host)) | |
1182 | tramp-postfix-host-format | |
1183 | (when localname localname))) | |
1184 | ||
1185 | (defun tramp-completion-make-tramp-file-name (method user host localname) | |
1186 | "Constructs a Tramp file name from METHOD, USER, HOST and LOCALNAME. | |
1187 | It must not be a complete Tramp file name, but as long as there are | |
1188 | necessary only. This function will be used in file name completion." | |
1189 | (concat tramp-prefix-format | |
1190 | (when (not (zerop (length method))) | |
1191 | (concat method tramp-postfix-method-format)) | |
1192 | (when (not (zerop (length user))) | |
1193 | (concat user tramp-postfix-user-format)) | |
1194 | (when (not (zerop (length host))) | |
1195 | (concat | |
1196 | (if (string-match tramp-ipv6-regexp host) | |
03c1ad43 MA |
1197 | (concat |
1198 | tramp-prefix-ipv6-format host tramp-postfix-ipv6-format) | |
0f34aa77 MA |
1199 | host) |
1200 | tramp-postfix-host-format)) | |
1201 | (when localname localname))) | |
1202 | ||
1203 | (defun tramp-get-buffer (vec) | |
1204 | "Get the connection buffer to be used for VEC." | |
1205 | (or (get-buffer (tramp-buffer-name vec)) | |
1206 | (with-current-buffer (get-buffer-create (tramp-buffer-name vec)) | |
1207 | (setq buffer-undo-list t) | |
1208 | (setq default-directory | |
1209 | (tramp-make-tramp-file-name | |
1210 | (tramp-file-name-method vec) | |
1211 | (tramp-file-name-user vec) | |
1212 | (tramp-file-name-host vec) | |
1213 | "/")) | |
1214 | (current-buffer)))) | |
1215 | ||
1216 | (defun tramp-get-connection-buffer (vec) | |
1217 | "Get the connection buffer to be used for VEC. | |
1218 | In case a second asynchronous communication has been started, it is different | |
1219 | from `tramp-get-buffer'." | |
1220 | (or (tramp-get-connection-property vec "process-buffer" nil) | |
1221 | (tramp-get-buffer vec))) | |
1222 | ||
66feec8b MA |
1223 | (defun tramp-get-connection-name (vec) |
1224 | "Get the connection name to be used for VEC. | |
1225 | In case a second asynchronous communication has been started, it is different | |
1226 | from the default one." | |
1227 | (or (tramp-get-connection-property vec "process-name" nil) | |
1228 | (tramp-buffer-name vec))) | |
1229 | ||
0f34aa77 MA |
1230 | (defun tramp-get-connection-process (vec) |
1231 | "Get the connection process to be used for VEC. | |
1232 | In case a second asynchronous communication has been started, it is different | |
1233 | from the default one." | |
66feec8b | 1234 | (get-process (tramp-get-connection-name vec))) |
0f34aa77 MA |
1235 | |
1236 | (defun tramp-debug-buffer-name (vec) | |
1237 | "A name for the debug buffer for VEC." | |
1238 | ;; We must use `tramp-file-name-real-host', because for gateway | |
1239 | ;; methods the default port will be expanded later on, which would | |
1240 | ;; tamper the name. | |
1241 | (let ((method (tramp-file-name-method vec)) | |
1242 | (user (tramp-file-name-user vec)) | |
1243 | (host (tramp-file-name-real-host vec))) | |
1244 | (if (not (zerop (length user))) | |
1245 | (format "*debug tramp/%s %s@%s*" method user host) | |
1246 | (format "*debug tramp/%s %s*" method host)))) | |
1247 | ||
1248 | (defconst tramp-debug-outline-regexp | |
03c1ad43 MA |
1249 | "[0-9]+:[0-9]+:[0-9]+\\.[0-9]+ [a-z0-9-]+ (\\([0-9]+\\)) #" |
1250 | "Used for highlighting Tramp debug buffers in `outline-mode'.") | |
1251 | ||
1252 | (defun tramp-debug-outline-level () | |
1253 | "Return the depth to which a statement is nested in the outline. | |
1254 | Point must be at the beginning of a header line. | |
1255 | ||
1256 | The outline level is equal to the verbosity of the Tramp message." | |
1257 | (1+ (string-to-number (match-string 1)))) | |
0f34aa77 MA |
1258 | |
1259 | (defun tramp-get-debug-buffer (vec) | |
1260 | "Get the debug buffer for VEC." | |
1261 | (with-current-buffer | |
1262 | (get-buffer-create (tramp-debug-buffer-name vec)) | |
1263 | (when (bobp) | |
1264 | (setq buffer-undo-list t) | |
1265 | ;; Activate `outline-mode'. This runs `text-mode-hook' and | |
1266 | ;; `outline-mode-hook'. We must prevent that local processes | |
1267 | ;; die. Yes: I've seen `flyspell-mode', which starts "ispell". | |
1268 | ;; Furthermore, `outline-regexp' must have the correct value | |
1269 | ;; already, because it is used by `font-lock-compile-keywords'. | |
1270 | (let ((default-directory (tramp-compat-temporary-file-directory)) | |
1271 | (outline-regexp tramp-debug-outline-regexp)) | |
1272 | (outline-mode)) | |
1273 | (set (make-local-variable 'outline-regexp) tramp-debug-outline-regexp) | |
03c1ad43 | 1274 | (set (make-local-variable 'outline-level) 'tramp-debug-outline-level)) |
0f34aa77 MA |
1275 | (current-buffer))) |
1276 | ||
00d6fd04 MA |
1277 | (defsubst tramp-debug-message (vec fmt-string &rest args) |
1278 | "Append message to debug buffer. | |
1279 | Message is formatted with FMT-STRING as control string and the remaining | |
1280 | ARGS to actually emit the message (if applicable)." | |
1281 | (when (get-buffer (tramp-buffer-name vec)) | |
1282 | (with-current-buffer (tramp-get-debug-buffer vec) | |
1283 | (goto-char (point-max)) | |
70c11b0b MA |
1284 | ;; Headline. |
1285 | (when (bobp) | |
1286 | (insert | |
1287 | (format | |
1288 | ";; %sEmacs: %s Tramp: %s -*- mode: outline; -*-" | |
1289 | (if (featurep 'sxemacs) "SX" (if (featurep 'xemacs) "X" "GNU ")) | |
1290 | emacs-version tramp-version))) | |
00d6fd04 MA |
1291 | (unless (bolp) |
1292 | (insert "\n")) | |
70c11b0b | 1293 | ;; Timestamp. |
736ac90f MA |
1294 | (let ((now (current-time))) |
1295 | (insert (format-time-string "%T." now)) | |
1296 | (insert (format "%06d " (nth 2 now)))) | |
56761182 MA |
1297 | ;; Calling Tramp function. We suppress compat and trace |
1298 | ;; functions from being displayed. | |
00d6fd04 MA |
1299 | (let ((btn 1) btf fn) |
1300 | (while (not fn) | |
1301 | (setq btf (nth 1 (backtrace-frame btn))) | |
1302 | (if (not btf) | |
1303 | (setq fn "") | |
1304 | (when (symbolp btf) | |
1305 | (setq fn (symbol-name btf)) | |
56761182 MA |
1306 | (unless |
1307 | (and | |
1308 | (string-match "^tramp" fn) | |
1309 | (not | |
1310 | (string-match | |
1311 | (concat | |
1312 | "^" | |
1313 | (regexp-opt | |
1314 | '("tramp-compat-funcall" | |
1315 | "tramp-compat-with-temp-message" | |
1316 | "tramp-debug-message" | |
1317 | "tramp-error" | |
1318 | "tramp-error-with-buffer" | |
def722bf MA |
1319 | "tramp-message" |
1320 | "tramp-with-progress-reporter") | |
56761182 MA |
1321 | t) |
1322 | "$") | |
1323 | fn))) | |
00d6fd04 MA |
1324 | (setq fn nil))) |
1325 | (setq btn (1+ btn)))) | |
1326 | ;; The following code inserts filename and line number. | |
1327 | ;; Should be deactivated by default, because it is time | |
1328 | ;; consuming. | |
1329 | ; (let ((ffn (find-function-noselect (intern fn)))) | |
1330 | ; (insert | |
1331 | ; (format | |
1332 | ; "%s:%d: " | |
1333 | ; (file-name-nondirectory (buffer-file-name (car ffn))) | |
1334 | ; (with-current-buffer (car ffn) | |
1335 | ; (1+ (count-lines (point-min) (cdr ffn))))))) | |
1336 | (insert (format "%s " fn))) | |
70c11b0b | 1337 | ;; The message. |
00d6fd04 MA |
1338 | (insert (apply 'format fmt-string args))))) |
1339 | ||
946a5aeb MA |
1340 | (defvar tramp-message-show-message t |
1341 | "Show Tramp message in the minibuffer. | |
1342 | This variable is used to disable messages from `tramp-error'. | |
1343 | The messages are visible anyway, because an error is raised.") | |
1344 | ||
00d6fd04 | 1345 | (defsubst tramp-message (vec-or-proc level fmt-string &rest args) |
fb7933a3 | 1346 | "Emit a message depending on verbosity level. |
a4aeb9a4 | 1347 | VEC-OR-PROC identifies the Tramp buffer to use. It can be either a |
00d6fd04 MA |
1348 | vector or a process. LEVEL says to be quiet if `tramp-verbose' is |
1349 | less than LEVEL. The message is emitted only if `tramp-verbose' is | |
1350 | greater than or equal to LEVEL. | |
1351 | ||
1352 | The message is also logged into the debug buffer when `tramp-verbose' | |
1353 | is greater than or equal 4. | |
1354 | ||
1355 | Calls functions `message' and `tramp-debug-message' with FMT-STRING as | |
1356 | control string and the remaining ARGS to actually emit the message (if | |
1357 | applicable)." | |
03c1ad43 MA |
1358 | (ignore-errors |
1359 | (when (<= level tramp-verbose) | |
1360 | ;; Match data must be preserved! | |
1361 | (save-match-data | |
1362 | ;; Display only when there is a minimum level. | |
1363 | (when (and tramp-message-show-message (<= level 3)) | |
1364 | (apply 'message | |
1365 | (concat | |
1366 | (cond | |
1367 | ((= level 0) "") | |
1368 | ((= level 1) "") | |
1369 | ((= level 2) "Warning: ") | |
1370 | (t "Tramp: ")) | |
1371 | fmt-string) | |
1372 | args)) | |
1373 | ;; Log only when there is a minimum level. | |
1374 | (when (>= tramp-verbose 4) | |
1375 | (when (and vec-or-proc | |
1376 | (processp vec-or-proc) | |
1377 | (buffer-name (process-buffer vec-or-proc))) | |
1378 | (with-current-buffer (process-buffer vec-or-proc) | |
1379 | ;; Translate proc to vec. | |
1380 | (setq vec-or-proc (tramp-dissect-file-name default-directory)))) | |
1381 | (when (and vec-or-proc (vectorp vec-or-proc)) | |
1382 | (apply 'tramp-debug-message | |
1383 | vec-or-proc | |
1384 | (concat (format "(%d) # " level) fmt-string) | |
1385 | args))))))) | |
00d6fd04 MA |
1386 | |
1387 | (defsubst tramp-error (vec-or-proc signal fmt-string &rest args) | |
1388 | "Emit an error. | |
1389 | VEC-OR-PROC identifies the connection to use, SIGNAL is the | |
1390 | signal identifier to be raised, remaining args passed to | |
1391 | `tramp-message'. Finally, signal SIGNAL is raised." | |
946a5aeb MA |
1392 | (let (tramp-message-show-message) |
1393 | (tramp-message | |
1394 | vec-or-proc 1 "%s" | |
1395 | (error-message-string | |
1396 | (list signal | |
1397 | (get signal 'error-message) | |
1398 | (apply 'format fmt-string args)))) | |
1399 | (signal signal (list (apply 'format fmt-string args))))) | |
00d6fd04 MA |
1400 | |
1401 | (defsubst tramp-error-with-buffer | |
1402 | (buffer vec-or-proc signal fmt-string &rest args) | |
1403 | "Emit an error, and show BUFFER. | |
1404 | If BUFFER is nil, show the connection buffer. Wait for 30\", or until | |
1405 | an input event arrives. The other arguments are passed to `tramp-error'." | |
1406 | (save-window-excursion | |
1407 | (unwind-protect | |
1408 | (apply 'tramp-error vec-or-proc signal fmt-string args) | |
4874f5e6 MA |
1409 | (when (and vec-or-proc |
1410 | (not (zerop tramp-verbose)) | |
1411 | (not (tramp-completion-mode-p))) | |
00d6fd04 MA |
1412 | (let ((enable-recursive-minibuffers t)) |
1413 | (pop-to-buffer | |
1414 | (or (and (bufferp buffer) buffer) | |
1415 | (and (processp vec-or-proc) (process-buffer vec-or-proc)) | |
1416 | (tramp-get-buffer vec-or-proc))) | |
1417 | (sit-for 30)))))) | |
fb7933a3 | 1418 | |
c62c9d08 KG |
1419 | (defmacro with-parsed-tramp-file-name (filename var &rest body) |
1420 | "Parse a Tramp filename and make components available in the body. | |
1421 | ||
1422 | First arg FILENAME is evaluated and dissected into its components. | |
1423 | Second arg VAR is a symbol. It is used as a variable name to hold | |
1424 | the filename structure. It is also used as a prefix for the variables | |
1425 | holding the components. For example, if VAR is the symbol `foo', then | |
00d6fd04 MA |
1426 | `foo' will be bound to the whole structure, `foo-method' will be bound to |
1427 | the method component, and so on for `foo-user', `foo-host', `foo-localname'. | |
c62c9d08 KG |
1428 | |
1429 | Remaining args are Lisp expressions to be evaluated (inside an implicit | |
1430 | `progn'). | |
1431 | ||
00d6fd04 MA |
1432 | If VAR is nil, then we bind `v' to the structure and `method', `user', |
1433 | `host', `localname' to the components." | |
c62c9d08 | 1434 | `(let* ((,(or var 'v) (tramp-dissect-file-name ,filename)) |
c62c9d08 KG |
1435 | (,(if var (intern (concat (symbol-name var) "-method")) 'method) |
1436 | (tramp-file-name-method ,(or var 'v))) | |
1437 | (,(if var (intern (concat (symbol-name var) "-user")) 'user) | |
1438 | (tramp-file-name-user ,(or var 'v))) | |
1439 | (,(if var (intern (concat (symbol-name var) "-host")) 'host) | |
1440 | (tramp-file-name-host ,(or var 'v))) | |
7432277c KG |
1441 | (,(if var (intern (concat (symbol-name var) "-localname")) 'localname) |
1442 | (tramp-file-name-localname ,(or var 'v)))) | |
c62c9d08 KG |
1443 | ,@body)) |
1444 | ||
1445 | (put 'with-parsed-tramp-file-name 'lisp-indent-function 2) | |
00d6fd04 | 1446 | (put 'with-parsed-tramp-file-name 'edebug-form-spec '(form symbolp body)) |
6139f995 MA |
1447 | (tramp-compat-font-lock-add-keywords |
1448 | 'emacs-lisp-mode '("\\<with-parsed-tramp-file-name\\>")) | |
00d6fd04 | 1449 | |
9e021389 MA |
1450 | (defun tramp-progress-reporter-update (reporter &optional value) |
1451 | (let* ((parameters (cdr reporter)) | |
1452 | (message (aref parameters 3))) | |
1453 | (when (string-match message (or (current-message) "")) | |
6139f995 | 1454 | (tramp-compat-funcall 'progress-reporter-update reporter value)))) |
9e021389 | 1455 | |
7d520089 | 1456 | (defmacro tramp-with-progress-reporter (vec level message &rest body) |
b6827fff MA |
1457 | "Executes BODY, spinning a progress reporter with MESSAGE. |
1458 | If LEVEL does not fit for visible messages, or if this is a | |
1459 | nested call of the macro, there are only traces without a visible | |
1460 | progress reporter." | |
7d520089 | 1461 | (declare (indent 3) (debug t)) |
a94d821f MA |
1462 | `(let (pr tm) |
1463 | (tramp-message ,vec ,level "%s..." ,message) | |
1464 | ;; We start a pulsing progress reporter after 3 seconds. Feature | |
1465 | ;; introduced in Emacs 24.1. | |
3b30ccda MA |
1466 | (when (and tramp-message-show-message |
1467 | ;; Display only when there is a minimum level. | |
1468 | (<= ,level (min tramp-verbose 3))) | |
03c1ad43 MA |
1469 | (ignore-errors |
1470 | (setq pr (tramp-compat-funcall 'make-progress-reporter ,message) | |
1471 | tm (when pr | |
1472 | (run-at-time 3 0.1 'tramp-progress-reporter-update pr))))) | |
a94d821f | 1473 | (unwind-protect |
b6827fff MA |
1474 | ;; Execute the body. Unset `tramp-message-show-message' when |
1475 | ;; the timer object is created, in order to suppress | |
1476 | ;; concurrent timers. | |
3b30ccda MA |
1477 | (let ((tramp-message-show-message |
1478 | (and tramp-message-show-message (not tm)))) | |
1479 | ,@body) | |
a94d821f | 1480 | ;; Stop progress reporter. |
0d5852cf | 1481 | (if tm (tramp-compat-funcall 'cancel-timer tm)) |
a94d821f MA |
1482 | (tramp-message ,vec ,level "%s...done" ,message)))) |
1483 | ||
6139f995 | 1484 | (tramp-compat-font-lock-add-keywords |
7d520089 | 1485 | 'emacs-lisp-mode '("\\<tramp-with-progress-reporter\\>")) |
a94d821f | 1486 | |
5bc3b51d | 1487 | (defalias 'tramp-drop-volume-letter |
628c97b2 | 1488 | (if (memq system-type '(cygwin windows-nt)) |
5bc3b51d | 1489 | (lambda (name) |
628c97b2 | 1490 | "Cut off unnecessary drive letter from file NAME. |
66feec8b | 1491 | The functions `tramp-*-handle-expand-file-name' call `expand-file-name' |
628c97b2 GM |
1492 | locally on a remote file name. When the local system is a W32 system |
1493 | but the remote system is Unix, this introduces a superfluous drive | |
1494 | letter into the file name. This function removes it." | |
1495 | (save-match-data | |
5bc3b51d | 1496 | (if (string-match "\\`[a-zA-Z]:/" name) |
628c97b2 GM |
1497 | (replace-match "/" nil t name) |
1498 | name))) | |
1499 | ||
5bc3b51d | 1500 | 'identity)) |
628c97b2 | 1501 | |
16674e4f KG |
1502 | ;;; Config Manipulation Functions: |
1503 | ||
f8f91c2b | 1504 | ;;;###tramp-autoload |
16674e4f KG |
1505 | (defun tramp-set-completion-function (method function-list) |
1506 | "Sets the list of completion functions for METHOD. | |
1507 | FUNCTION-LIST is a list of entries of the form (FUNCTION FILE). | |
1508 | The FUNCTION is intended to parse FILE according its syntax. | |
1509 | It might be a predefined FUNCTION, or a user defined FUNCTION. | |
1510 | Predefined FUNCTIONs are `tramp-parse-rhosts', `tramp-parse-shosts', | |
8fc29035 | 1511 | `tramp-parse-sconfig', `tramp-parse-hosts', `tramp-parse-passwd', |
8daea7fc KG |
1512 | and `tramp-parse-netrc'. |
1513 | ||
16674e4f KG |
1514 | Example: |
1515 | ||
1516 | (tramp-set-completion-function | |
1517 | \"ssh\" | |
8daea7fc KG |
1518 | '((tramp-parse-sconfig \"/etc/ssh_config\") |
1519 | (tramp-parse-sconfig \"~/.ssh/config\")))" | |
16674e4f | 1520 | |
5ec2cc41 KG |
1521 | (let ((r function-list) |
1522 | (v function-list)) | |
1523 | (setq tramp-completion-function-alist | |
1524 | (delete (assoc method tramp-completion-function-alist) | |
1525 | tramp-completion-function-alist)) | |
1526 | ||
1527 | (while v | |
00d6fd04 | 1528 | ;; Remove double entries. |
5ec2cc41 KG |
1529 | (when (member (car v) (cdr v)) |
1530 | (setcdr v (delete (car v) (cdr v)))) | |
00d6fd04 | 1531 | ;; Check for function and file or registry key. |
5ec2cc41 | 1532 | (unless (and (functionp (nth 0 (car v))) |
00d6fd04 MA |
1533 | (if (string-match "^HKEY_CURRENT_USER" (nth 1 (car v))) |
1534 | ;; Windows registry. | |
1535 | (and (memq system-type '(cygwin windows-nt)) | |
a4aeb9a4 | 1536 | (zerop |
0f34aa77 | 1537 | (tramp-compat-call-process |
a4aeb9a4 | 1538 | "reg" nil nil nil "query" (nth 1 (car v))))) |
00d6fd04 MA |
1539 | ;; Configuration file. |
1540 | (file-exists-p (nth 1 (car v))))) | |
5ec2cc41 KG |
1541 | (setq r (delete (car v) r))) |
1542 | (setq v (cdr v))) | |
1543 | ||
1544 | (when r | |
4007ba5b | 1545 | (add-to-list 'tramp-completion-function-alist |
5ec2cc41 | 1546 | (cons method r))))) |
16674e4f KG |
1547 | |
1548 | (defun tramp-get-completion-function (method) | |
00d6fd04 | 1549 | "Returns a list of completion functions for METHOD. |
16674e4f | 1550 | For definition of that list see `tramp-set-completion-function'." |
00d6fd04 MA |
1551 | (cons |
1552 | ;; Hosts visited once shall be remembered. | |
1553 | `(tramp-parse-connection-properties ,method) | |
1554 | ;; The method related defaults. | |
1555 | (cdr (assoc method tramp-completion-function-alist)))) | |
16674e4f | 1556 | |
d037d501 | 1557 | |
0664ff72 | 1558 | ;;; Fontification of `read-file-name': |
d037d501 | 1559 | |
0664ff72 | 1560 | ;; rfn-eshadow.el is part of Emacs 22. It is autoloaded. |
d037d501 MA |
1561 | (defvar tramp-rfn-eshadow-overlay) |
1562 | (make-variable-buffer-local 'tramp-rfn-eshadow-overlay) | |
1563 | ||
1564 | (defun tramp-rfn-eshadow-setup-minibuffer () | |
1565 | "Set up a minibuffer for `file-name-shadow-mode'. | |
1566 | Adds another overlay hiding filename parts according to Tramp's | |
1567 | special handling of `substitute-in-file-name'." | |
9ce8462a | 1568 | (when (symbol-value 'minibuffer-completing-file-name) |
d037d501 | 1569 | (setq tramp-rfn-eshadow-overlay |
0d5852cf MA |
1570 | (tramp-compat-funcall |
1571 | 'make-overlay | |
1572 | (tramp-compat-funcall 'minibuffer-prompt-end) | |
1573 | (tramp-compat-funcall 'minibuffer-prompt-end))) | |
d037d501 | 1574 | ;; Copy rfn-eshadow-overlay properties. |
0d5852cf MA |
1575 | (let ((props (tramp-compat-funcall |
1576 | 'overlay-properties (symbol-value 'rfn-eshadow-overlay)))) | |
d037d501 | 1577 | (while props |
c6309045 MA |
1578 | ;; The `field' property prevents correct minibuffer |
1579 | ;; completion; we exclude it. | |
1580 | (if (not (eq (car props) 'field)) | |
1581 | (tramp-compat-funcall | |
1582 | 'overlay-put tramp-rfn-eshadow-overlay (pop props) (pop props)) | |
1583 | (pop props) (pop props)))))) | |
d037d501 MA |
1584 | |
1585 | (when (boundp 'rfn-eshadow-setup-minibuffer-hook) | |
1586 | (add-hook 'rfn-eshadow-setup-minibuffer-hook | |
48846dc5 MA |
1587 | 'tramp-rfn-eshadow-setup-minibuffer) |
1588 | (add-hook 'tramp-unload-hook | |
aa485f7c MA |
1589 | (lambda () |
1590 | (remove-hook 'rfn-eshadow-setup-minibuffer-hook | |
1591 | 'tramp-rfn-eshadow-setup-minibuffer)))) | |
d037d501 | 1592 | |
adcbca53 MA |
1593 | (defconst tramp-rfn-eshadow-update-overlay-regexp |
1594 | (format "[^%s/~]*\\(/\\|~\\)" tramp-postfix-host-format)) | |
1595 | ||
d037d501 MA |
1596 | (defun tramp-rfn-eshadow-update-overlay () |
1597 | "Update `rfn-eshadow-overlay' to cover shadowed part of minibuffer input. | |
1598 | This is intended to be used as a minibuffer `post-command-hook' for | |
1599 | `file-name-shadow-mode'; the minibuffer should have already | |
1600 | been set up by `rfn-eshadow-setup-minibuffer'." | |
1601 | ;; In remote files name, there is a shadowing just for the local part. | |
0d5852cf MA |
1602 | (let ((end (or (tramp-compat-funcall |
1603 | 'overlay-end (symbol-value 'rfn-eshadow-overlay)) | |
1604 | (tramp-compat-funcall 'minibuffer-prompt-end)))) | |
1605 | (when | |
1606 | (file-remote-p | |
1607 | (tramp-compat-funcall 'buffer-substring-no-properties end (point-max))) | |
bd316474 KY |
1608 | (save-excursion |
1609 | (save-restriction | |
1610 | (narrow-to-region | |
adcbca53 MA |
1611 | (1+ (or (string-match |
1612 | tramp-rfn-eshadow-update-overlay-regexp (buffer-string) end) | |
1613 | end)) | |
1614 | (point-max)) | |
bd316474 KY |
1615 | (let ((rfn-eshadow-overlay tramp-rfn-eshadow-overlay) |
1616 | (rfn-eshadow-update-overlay-hook nil)) | |
0d5852cf MA |
1617 | (tramp-compat-funcall |
1618 | 'move-overlay rfn-eshadow-overlay (point-max) (point-max)) | |
1619 | (tramp-compat-funcall 'rfn-eshadow-update-overlay))))))) | |
d037d501 MA |
1620 | |
1621 | (when (boundp 'rfn-eshadow-update-overlay-hook) | |
1622 | (add-hook 'rfn-eshadow-update-overlay-hook | |
b88f2d0a MA |
1623 | 'tramp-rfn-eshadow-update-overlay) |
1624 | (add-hook 'tramp-unload-hook | |
1625 | (lambda () | |
1626 | (remove-hook 'rfn-eshadow-update-overlay-hook | |
1627 | 'tramp-rfn-eshadow-update-overlay)))) | |
d037d501 | 1628 | |
00d6fd04 MA |
1629 | ;; Inodes don't exist for some file systems. Therefore we must |
1630 | ;; generate virtual ones. Used in `find-buffer-visiting'. The method | |
1631 | ;; applied might be not so efficient (Ange-FTP uses hashes). But | |
1632 | ;; performance isn't the major issue given that file transfer will | |
1633 | ;; take time. | |
1634 | (defvar tramp-inodes nil | |
1635 | "Keeps virtual inodes numbers.") | |
1636 | ||
8daea7fc KG |
1637 | ;; Devices must distinguish physical file systems. The device numbers |
1638 | ;; provided by "lstat" aren't unique, because we operate on different hosts. | |
1639 | ;; So we use virtual device numbers, generated by Tramp. Both Ange-FTP and | |
1640 | ;; EFS use device number "-1". In order to be different, we use device number | |
b946a456 | 1641 | ;; (-1 . x), whereby "x" is unique for a given (method user host). |
8daea7fc KG |
1642 | (defvar tramp-devices nil |
1643 | "Keeps virtual device numbers.") | |
1644 | ||
b86c1cd8 MA |
1645 | (defun tramp-default-file-modes (filename) |
1646 | "Return file modes of FILENAME as integer. | |
1647 | If the file modes of FILENAME cannot be determined, return the | |
974647ac MA |
1648 | value of `default-file-modes', without execute permissions." |
1649 | (or (file-modes filename) | |
0f34aa77 | 1650 | (logand (default-file-modes) (tramp-compat-octal-to-decimal "0666")))) |
b86c1cd8 | 1651 | |
c23c3394 MA |
1652 | (defun tramp-replace-environment-variables (filename) |
1653 | "Replace environment variables in FILENAME. | |
1654 | Return the string with the replaced variables." | |
2e271195 | 1655 | (save-match-data |
ec5145d6 | 1656 | (let ((idx (string-match "$\\(\\w+\\)" filename))) |
2e271195 | 1657 | ;; `$' is coded as `$$'. |
ec5145d6 MA |
1658 | (when (and idx |
1659 | (or (zerop idx) (not (eq ?$ (aref filename (1- idx))))) | |
1660 | (getenv (match-string 1 filename))) | |
2e271195 MA |
1661 | (setq filename |
1662 | (replace-match | |
1663 | (substitute-in-file-name (match-string 0 filename)) | |
1664 | t nil filename))) | |
1665 | filename))) | |
c23c3394 | 1666 | |
00d6fd04 MA |
1667 | ;; In XEmacs, electricity is implemented via a key map for ?/ and ?~, |
1668 | ;; which calls corresponding functions (see minibuf.el). | |
1669 | (when (fboundp 'minibuffer-electric-separator) | |
9e6ab520 | 1670 | (mapc |
aa485f7c MA |
1671 | (lambda (x) |
1672 | (eval | |
1673 | `(defadvice ,x | |
1674 | (around ,(intern (format "tramp-advice-%s" x)) activate) | |
1675 | "Invoke `substitute-in-file-name' for Tramp files." | |
1676 | (if (and (symbol-value 'minibuffer-electric-file-name-behavior) | |
1677 | (tramp-tramp-file-p (buffer-substring))) | |
1678 | ;; We don't need to handle `last-input-event', because | |
1679 | ;; due to the key map we know it must be ?/ or ?~. | |
1680 | (let ((s (concat (buffer-substring (point-min) (point)) | |
1681 | (string last-command-char)))) | |
1682 | (delete-region (point-min) (point)) | |
1683 | (insert (substitute-in-file-name s)) | |
1684 | (setq ad-return-value last-command-char)) | |
d7ec1df7 MA |
1685 | ad-do-it))) |
1686 | (eval | |
1687 | `(add-hook | |
1688 | 'tramp-unload-hook | |
1689 | (lambda () | |
1690 | (ad-remove-advice ',x 'around ',(intern (format "tramp-advice-%s" x))) | |
1691 | (ad-activate ',x))))) | |
00d6fd04 MA |
1692 | |
1693 | '(minibuffer-electric-separator | |
1694 | minibuffer-electric-tilde))) | |
1695 | ||
eb562962 MA |
1696 | (defun tramp-find-file-name-coding-system-alist (filename tmpname) |
1697 | "Like `find-operation-coding-system' for Tramp filenames. | |
1698 | Tramp's `insert-file-contents' and `write-region' work over | |
1699 | temporary file names. If `file-coding-system-alist' contains an | |
1700 | expression, which matches more than the file name suffix, the | |
1701 | coding system might not be determined. This function repairs it." | |
1702 | (let (result) | |
1703 | (dolist (elt file-coding-system-alist result) | |
1704 | (when (and (consp elt) (string-match (car elt) filename)) | |
1705 | ;; We found a matching entry in `file-coding-system-alist'. | |
1706 | ;; So we add a similar entry, but with the temporary file name | |
1707 | ;; as regexp. | |
1708 | (add-to-list | |
1709 | 'result (cons (regexp-quote tmpname) (cdr elt)) 'append))))) | |
1710 | ||
a01b1e22 MA |
1711 | ;;;###autoload |
1712 | (progn (defun tramp-run-real-handler (operation args) | |
fb7933a3 | 1713 | "Invoke normal file name handler for OPERATION. |
c62c9d08 KG |
1714 | First arg specifies the OPERATION, second arg is a list of arguments to |
1715 | pass to the OPERATION." | |
4007ba5b KG |
1716 | (let* ((inhibit-file-name-handlers |
1717 | `(tramp-file-name-handler | |
946a5aeb | 1718 | tramp-vc-file-name-handler |
4007ba5b KG |
1719 | tramp-completion-file-name-handler |
1720 | cygwin-mount-name-hook-function | |
1721 | cygwin-mount-map-drive-hook-function | |
1722 | . | |
1723 | ,(and (eq inhibit-file-name-operation operation) | |
1724 | inhibit-file-name-handlers))) | |
1725 | (inhibit-file-name-operation operation)) | |
a01b1e22 | 1726 | (apply operation args)))) |
16674e4f | 1727 | |
a01b1e22 MA |
1728 | ;;;###autoload |
1729 | (progn (defun tramp-completion-run-real-handler (operation args) | |
16674e4f KG |
1730 | "Invoke `tramp-file-name-handler' for OPERATION. |
1731 | First arg specifies the OPERATION, second arg is a list of arguments to | |
1732 | pass to the OPERATION." | |
4007ba5b KG |
1733 | (let* ((inhibit-file-name-handlers |
1734 | `(tramp-completion-file-name-handler | |
1735 | cygwin-mount-name-hook-function | |
1736 | cygwin-mount-map-drive-hook-function | |
1737 | . | |
1738 | ,(and (eq inhibit-file-name-operation operation) | |
1739 | inhibit-file-name-handlers))) | |
1740 | (inhibit-file-name-operation operation)) | |
a01b1e22 | 1741 | (apply operation args)))) |
fb7933a3 | 1742 | |
4007ba5b KG |
1743 | ;; We handle here all file primitives. Most of them have the file |
1744 | ;; name as first parameter; nevertheless we check for them explicitly | |
04bf5b65 | 1745 | ;; in order to be signaled if a new primitive appears. This |
4007ba5b KG |
1746 | ;; scenario is needed because there isn't a way to decide by |
1747 | ;; syntactical means whether a foreign method must be called. It would | |
19a87064 | 1748 | ;; ease the life if `file-name-handler-alist' would support a decision |
4007ba5b KG |
1749 | ;; function as well but regexp only. |
1750 | (defun tramp-file-name-for-operation (operation &rest args) | |
1751 | "Return file name related to OPERATION file primitive. | |
1752 | ARGS are the arguments OPERATION has been called with." | |
1753 | (cond | |
b533bc97 | 1754 | ;; FILE resp DIRECTORY. |
4007ba5b KG |
1755 | ((member operation |
1756 | (list 'access-file 'byte-compiler-base-file-name 'delete-directory | |
1757 | 'delete-file 'diff-latest-backup-file 'directory-file-name | |
1758 | 'directory-files 'directory-files-and-attributes | |
1759 | 'dired-compress-file 'dired-uncache | |
1760 | 'file-accessible-directory-p 'file-attributes | |
1761 | 'file-directory-p 'file-executable-p 'file-exists-p | |
25f14cdb | 1762 | 'file-local-copy 'file-remote-p 'file-modes |
19a87064 MA |
1763 | 'file-name-as-directory 'file-name-directory |
1764 | 'file-name-nondirectory 'file-name-sans-versions | |
1765 | 'file-ownership-preserved-p 'file-readable-p | |
1766 | 'file-regular-p 'file-symlink-p 'file-truename | |
1767 | 'file-writable-p 'find-backup-file-name 'find-file-noselect | |
1768 | 'get-file-buffer 'insert-directory 'insert-file-contents | |
1769 | 'load 'make-directory 'make-directory-internal | |
1770 | 'set-file-modes 'substitute-in-file-name | |
1771 | 'unhandled-file-name-directory 'vc-registered | |
b533bc97 | 1772 | ;; Emacs 22+ only. |
ce3f516f | 1773 | 'set-file-times |
25f14cdb MA |
1774 | ;; Emacs 24+ only. |
1775 | 'file-selinux-context 'set-file-selinux-context | |
b533bc97 | 1776 | ;; XEmacs only. |
4007ba5b KG |
1777 | 'abbreviate-file-name 'create-file-buffer |
1778 | 'dired-file-modtime 'dired-make-compressed-filename | |
1779 | 'dired-recursive-delete-directory 'dired-set-file-modtime | |
1780 | 'dired-shell-unhandle-file-name 'dired-uucode-file | |
5615d63f | 1781 | 'insert-file-contents-literally 'make-temp-name 'recover-file |
4007ba5b | 1782 | 'vm-imap-check-mail 'vm-pop-check-mail 'vm-spool-check-mail)) |
8daea7fc KG |
1783 | (if (file-name-absolute-p (nth 0 args)) |
1784 | (nth 0 args) | |
1785 | (expand-file-name (nth 0 args)))) | |
b533bc97 | 1786 | ;; FILE DIRECTORY resp FILE1 FILE2. |
4007ba5b KG |
1787 | ((member operation |
1788 | (list 'add-name-to-file 'copy-file 'expand-file-name | |
1789 | 'file-name-all-completions 'file-name-completion | |
1790 | 'file-newer-than-file-p 'make-symbolic-link 'rename-file | |
b533bc97 | 1791 | ;; Emacs 23+ only. |
263c02ef | 1792 | 'copy-directory |
b533bc97 | 1793 | ;; XEmacs only. |
4007ba5b KG |
1794 | 'dired-make-relative-symlink |
1795 | 'vm-imap-move-mail 'vm-pop-move-mail 'vm-spool-move-mail)) | |
1796 | (save-match-data | |
1797 | (cond | |
1798 | ((string-match tramp-file-name-regexp (nth 0 args)) (nth 0 args)) | |
1799 | ((string-match tramp-file-name-regexp (nth 1 args)) (nth 1 args)) | |
1800 | (t (buffer-file-name (current-buffer)))))) | |
b533bc97 | 1801 | ;; START END FILE. |
4007ba5b KG |
1802 | ((eq operation 'write-region) |
1803 | (nth 2 args)) | |
b533bc97 | 1804 | ;; BUFFER. |
4007ba5b | 1805 | ((member operation |
00d6fd04 | 1806 | (list 'set-visited-file-modtime 'verify-visited-file-modtime |
b533bc97 | 1807 | ;; Emacs 22+ only. |
00d6fd04 | 1808 | 'make-auto-save-file-name |
b533bc97 | 1809 | ;; XEmacs only. |
4007ba5b KG |
1810 | 'backup-buffer)) |
1811 | (buffer-file-name | |
1812 | (if (bufferp (nth 0 args)) (nth 0 args) (current-buffer)))) | |
b533bc97 | 1813 | ;; COMMAND. |
4007ba5b | 1814 | ((member operation |
b533bc97 | 1815 | (list ;; not in Emacs 23+. |
00d6fd04 | 1816 | 'dired-call-process |
b533bc97 | 1817 | ;; Emacs only. |
b71c9e75 | 1818 | 'shell-command |
b533bc97 | 1819 | ;; Emacs 22+ only. |
0457dd55 | 1820 | 'process-file |
b533bc97 | 1821 | ;; Emacs 23+ only. |
00d6fd04 | 1822 | 'start-file-process |
b533bc97 | 1823 | ;; XEmacs only. |
00d6fd04 | 1824 | 'dired-print-file 'dired-shell-call-process |
b533bc97 | 1825 | ;; nowhere yet. |
b81a0b56 MA |
1826 | 'executable-find 'start-process |
1827 | 'call-process 'call-process-region)) | |
4007ba5b | 1828 | default-directory) |
b533bc97 | 1829 | ;; Unknown file primitive. |
4007ba5b KG |
1830 | (t (error "unknown file I/O primitive: %s" operation)))) |
1831 | ||
1832 | (defun tramp-find-foreign-file-name-handler (filename) | |
1833 | "Return foreign file name handler if exists." | |
b533bc97 | 1834 | (when (tramp-tramp-file-p filename) |
9ce8462a MA |
1835 | (let ((v (tramp-dissect-file-name filename t)) |
1836 | (handler tramp-foreign-file-name-handler-alist) | |
1837 | elt res) | |
1838 | ;; When we are not fully sure that filename completion is safe, | |
1839 | ;; we should not return a handler. | |
1840 | (when (or (tramp-file-name-method v) (tramp-file-name-user v) | |
1834b39f MA |
1841 | (and (tramp-file-name-host v) |
1842 | (not (member (tramp-file-name-host v) | |
1843 | (mapcar 'car tramp-methods)))) | |
9ce8462a MA |
1844 | (not (tramp-completion-mode-p))) |
1845 | (while handler | |
1846 | (setq elt (car handler) | |
1847 | handler (cdr handler)) | |
1848 | (when (funcall (car elt) filename) | |
1849 | (setq handler nil | |
1850 | res (cdr elt)))) | |
1851 | res)))) | |
4007ba5b | 1852 | |
fb7933a3 KG |
1853 | ;; Main function. |
1854 | ;;;###autoload | |
1855 | (defun tramp-file-name-handler (operation &rest args) | |
ea9d1443 | 1856 | "Invoke Tramp file name handler. |
a4aeb9a4 | 1857 | Falls back to normal file name handler if no Tramp file name handler exists." |
2e271195 MA |
1858 | (if tramp-mode |
1859 | (save-match-data | |
1860 | (let* ((filename | |
1861 | (tramp-replace-environment-variables | |
1862 | (apply 'tramp-file-name-for-operation operation args))) | |
1863 | (completion (tramp-completion-mode-p)) | |
1864 | (foreign (tramp-find-foreign-file-name-handler filename))) | |
1865 | (with-parsed-tramp-file-name filename nil | |
4874f5e6 MA |
1866 | ;; Call the backend function. |
1867 | (if foreign | |
1868 | (condition-case err | |
11d074b2 MA |
1869 | (let ((sf (symbol-function foreign))) |
1870 | ;; Some packages set the default directory to a | |
1871 | ;; remote path, before respective Tramp packages | |
1872 | ;; are already loaded. This results in | |
1873 | ;; recursive loading. Therefore, we load the | |
1874 | ;; Tramp packages locally. | |
1875 | (when (and (listp sf) (eq (car sf) 'autoload)) | |
1876 | (let ((default-directory | |
1877 | (tramp-compat-temporary-file-directory))) | |
1878 | (load (cadr sf) 'noerror))) | |
1879 | (apply foreign operation args)) | |
af4b9ae5 | 1880 | |
51aba3f3 | 1881 | ;; Trace that somebody has interrupted the operation. |
af4b9ae5 MA |
1882 | (quit |
1883 | (let (tramp-message-show-message) | |
1884 | (tramp-message | |
1885 | v 1 "Interrupt received in operation %s" | |
1886 | (append (list operation) args))) | |
1887 | ;; Propagate the quit signal. | |
1888 | (signal (car err) (cdr err))) | |
1889 | ||
1890 | ;; When we are in completion mode, some failed | |
1891 | ;; operations shall return at least a default value | |
1892 | ;; in order to give the user a chance to correct the | |
1893 | ;; file name in the minibuffer. | |
4874f5e6 MA |
1894 | (error |
1895 | (cond | |
4874f5e6 MA |
1896 | ((and completion (zerop (length localname)) |
1897 | (memq operation '(file-exists-p file-directory-p))) | |
1898 | t) | |
1899 | ((and completion (zerop (length localname)) | |
1900 | (memq operation | |
1901 | '(expand-file-name file-name-as-directory))) | |
1902 | filename) | |
1903 | ;; Propagate the error. | |
1904 | (t (signal (car err) (cdr err)))))) | |
af4b9ae5 | 1905 | |
4874f5e6 MA |
1906 | ;; Nothing to do for us. |
1907 | (tramp-run-real-handler operation args))))) | |
1908 | ||
2e271195 MA |
1909 | ;; When `tramp-mode' is not enabled, we don't do anything. |
1910 | (tramp-run-real-handler operation args))) | |
fb7933a3 | 1911 | |
07dfe738 KG |
1912 | ;; In Emacs, there is some concurrency due to timers. If a timer |
1913 | ;; interrupts Tramp and wishes to use the same connection buffer as | |
1914 | ;; the "main" Emacs, then garbage might occur in the connection | |
1915 | ;; buffer. Therefore, we need to make sure that a timer does not use | |
1916 | ;; the same connection buffer as the "main" Emacs. We implement a | |
1917 | ;; cheap global lock, instead of locking each connection buffer | |
1918 | ;; separately. The global lock is based on two variables, | |
1919 | ;; `tramp-locked' and `tramp-locker'. `tramp-locked' is set to true | |
1920 | ;; (with setq) to indicate a lock. But Tramp also calls itself during | |
1921 | ;; processing of a single file operation, so we need to allow | |
1922 | ;; recursive calls. That's where the `tramp-locker' variable comes in | |
1923 | ;; -- it is let-bound to t during the execution of the current | |
1924 | ;; handler. So if `tramp-locked' is t and `tramp-locker' is also t, | |
1925 | ;; then we should just proceed because we have been called | |
1926 | ;; recursively. But if `tramp-locker' is nil, then we are a timer | |
1927 | ;; interrupting the "main" Emacs, and then we signal an error. | |
1928 | ||
1929 | (defvar tramp-locked nil | |
1930 | "If non-nil, then Tramp is currently busy. | |
1931 | Together with `tramp-locker', this implements a locking mechanism | |
1932 | preventing reentrant calls of Tramp.") | |
1933 | ||
1934 | (defvar tramp-locker nil | |
1935 | "If non-nil, then a caller has locked Tramp. | |
1936 | Together with `tramp-locked', this implements a locking mechanism | |
1937 | preventing reentrant calls of Tramp.") | |
1938 | ||
16674e4f | 1939 | ;;;###autoload |
1ecc6145 | 1940 | (progn (defun tramp-completion-file-name-handler (operation &rest args) |
a4aeb9a4 MA |
1941 | "Invoke Tramp file name completion handler. |
1942 | Falls back to normal file name handler if no Tramp file name handler exists." | |
57671b72 MA |
1943 | ;; We bind `directory-sep-char' here for XEmacs on Windows, which |
1944 | ;; would otherwise use backslash. | |
aff67808 MA |
1945 | (let ((directory-sep-char ?/) |
1946 | (fn (assoc operation tramp-completion-file-name-handler-alist))) | |
aa485f7c MA |
1947 | (if (and |
1948 | ;; When `tramp-mode' is not enabled, we don't do anything. | |
1949 | fn tramp-mode | |
1950 | ;; For other syntaxes than `sep', the regexp matches many common | |
1951 | ;; situations where the user doesn't actually want to use Tramp. | |
1952 | ;; So to avoid autoloading Tramp after typing just "/s", we | |
1953 | ;; disable this part of the completion, unless the user implicitly | |
1954 | ;; indicated his interest in using a fancier completion system. | |
1955 | (or (eq tramp-syntax 'sep) | |
a94d821f MA |
1956 | (featurep 'tramp) ;; If it's loaded, we may as well use it. |
1957 | ;; `partial-completion-mode' does not exist in XEmacs. | |
1958 | ;; It is obsoleted with Emacs 24.1. | |
0d5852cf MA |
1959 | (and (boundp 'partial-completion-mode) |
1960 | (symbol-value 'partial-completion-mode)) | |
aa485f7c MA |
1961 | ;; FIXME: These may have been loaded even if the user never |
1962 | ;; intended to use them. | |
1963 | (featurep 'ido) | |
1964 | (featurep 'icicles))) | |
aff67808 MA |
1965 | (save-match-data (apply (cdr fn) args)) |
1966 | (tramp-completion-run-real-handler operation args))))) | |
a01b1e22 | 1967 | |
b25a52cc | 1968 | ;;;###autoload |
aa485f7c MA |
1969 | (progn (defun tramp-register-file-name-handlers () |
1970 | "Add Tramp file name handlers to `file-name-handler-alist'." | |
1971 | ;; Remove autoloaded handlers from file name handler alist. Useful, | |
00d6fd04 MA |
1972 | ;; if `tramp-syntax' has been changed. |
1973 | (let ((a1 (rassq 'tramp-file-name-handler file-name-handler-alist))) | |
aa485f7c MA |
1974 | (setq file-name-handler-alist (delq a1 file-name-handler-alist))) |
1975 | (let ((a1 (rassq | |
1976 | 'tramp-completion-file-name-handler file-name-handler-alist))) | |
1977 | (setq file-name-handler-alist (delq a1 file-name-handler-alist))) | |
1978 | ;; Add the handlers. | |
a01b1e22 MA |
1979 | (add-to-list 'file-name-handler-alist |
1980 | (cons tramp-file-name-regexp 'tramp-file-name-handler)) | |
0c0b61f1 | 1981 | (put 'tramp-file-name-handler 'safe-magic t) |
aa485f7c MA |
1982 | (add-to-list 'file-name-handler-alist |
1983 | (cons tramp-completion-file-name-regexp | |
1984 | 'tramp-completion-file-name-handler)) | |
1985 | (put 'tramp-completion-file-name-handler 'safe-magic t) | |
1986 | ;; If jka-compr or epa-file are already loaded, move them to the | |
1987 | ;; front of `file-name-handler-alist'. | |
1988 | (dolist (fnh '(epa-file-handler jka-compr-handler)) | |
1989 | (let ((entry (rassoc fnh file-name-handler-alist))) | |
1990 | (when entry | |
1991 | (setq file-name-handler-alist | |
1992 | (cons entry (delete entry file-name-handler-alist)))))))) | |
69cee873 | 1993 | |
00d6fd04 MA |
1994 | ;; `tramp-file-name-handler' must be registered before evaluation of |
1995 | ;; site-start and init files, because there might exist remote files | |
1996 | ;; already, f.e. files kept via recentf-mode. | |
4a93e698 | 1997 | ;;;###autoload |
aa485f7c | 1998 | (tramp-register-file-name-handlers) |
b25a52cc | 1999 | |
4a93e698 MA |
2000 | (defun tramp-exists-file-name-handler (operation &rest args) |
2001 | "Check, whether OPERATION runs a file name handler." | |
2002 | ;; The file name handler is determined on base of either an | |
2003 | ;; argument, `buffer-file-name', or `default-directory'. | |
2004 | (ignore-errors | |
2005 | (let* ((buffer-file-name "/") | |
2006 | (default-directory "/") | |
2007 | (fnha file-name-handler-alist) | |
2008 | (check-file-name-operation operation) | |
2009 | (file-name-handler-alist | |
2010 | (list | |
2011 | (cons "/" | |
2012 | (lambda (operation &rest args) | |
2013 | "Returns OPERATION if it is the one to be checked." | |
2014 | (if (equal check-file-name-operation operation) | |
2015 | operation | |
2016 | (let ((file-name-handler-alist fnha)) | |
2017 | (apply operation args)))))))) | |
2018 | (equal (apply operation args) operation)))) | |
2019 | ||
fb7933a3 | 2020 | ;;;###autoload |
8c04e197 | 2021 | (defun tramp-unload-file-name-handlers () |
a69c01a0 MA |
2022 | (setq file-name-handler-alist |
2023 | (delete (rassoc 'tramp-file-name-handler | |
2024 | file-name-handler-alist) | |
2025 | (delete (rassoc 'tramp-completion-file-name-handler | |
2026 | file-name-handler-alist) | |
2027 | file-name-handler-alist)))) | |
2028 | ||
8c04e197 | 2029 | (add-hook 'tramp-unload-hook 'tramp-unload-file-name-handlers) |
a69c01a0 | 2030 | |
0664ff72 | 2031 | ;;; File name handler functions for completion mode: |
a6e96327 MA |
2032 | |
2033 | (defvar tramp-completion-mode nil | |
2034 | "If non-nil, external packages signal that they are in file name completion. | |
2035 | ||
2036 | This is necessary, because Tramp uses a heuristic depending on last | |
2037 | input event. This fails when external packages use other characters | |
2038 | but <TAB>, <SPACE> or ?\\? for file name completion. This variable | |
2039 | should never be set globally, the intention is to let-bind it.") | |
16674e4f KG |
2040 | |
2041 | ;; Necessary because `tramp-file-name-regexp-unified' and | |
00d6fd04 MA |
2042 | ;; `tramp-completion-file-name-regexp-unified' aren't different. If |
2043 | ;; nil, `tramp-completion-run-real-handler' is called (i.e. forwarding | |
2044 | ;; to `tramp-file-name-handler'). Otherwise, it takes | |
2045 | ;; `tramp-run-real-handler'. Using `last-input-event' is a little bit | |
2046 | ;; risky, because completing a file might require loading other files, | |
2047 | ;; like "~/.netrc", and for them it shouldn't be decided based on that | |
2048 | ;; variable. On the other hand, those files shouldn't have partial | |
a4aeb9a4 MA |
2049 | ;; Tramp file name syntax. Maybe another variable should be introduced |
2050 | ;; overwriting this check in such cases. Or we change Tramp file name | |
00d6fd04 | 2051 | ;; syntax in order to avoid ambiguities, like in XEmacs ... |
0f34aa77 | 2052 | ;;;###tramp-autoload |
6c4e47fa | 2053 | (defun tramp-completion-mode-p () |
a94d821f | 2054 | "Check, whether method / user name / host name completion is active." |
6c4e47fa | 2055 | (or |
5f2b693f MA |
2056 | ;; Signal from outside. `non-essential' has been introduced in Emacs 24. |
2057 | (and (boundp 'non-essential) (symbol-value 'non-essential)) | |
a6e96327 MA |
2058 | tramp-completion-mode |
2059 | ;; Emacs. | |
94be87e8 | 2060 | (equal last-input-event 'tab) |
6c4e47fa | 2061 | (and (natnump last-input-event) |
94be87e8 | 2062 | (or |
a6e96327 | 2063 | ;; ?\t has event-modifier 'control. |
800a97b8 | 2064 | (equal last-input-event ?\t) |
94be87e8 | 2065 | (and (not (event-modifiers last-input-event)) |
800a97b8 SM |
2066 | (or (equal last-input-event ?\?) |
2067 | (equal last-input-event ?\ ))))) | |
a6e96327 | 2068 | ;; XEmacs. |
6c4e47fa MA |
2069 | (and (featurep 'xemacs) |
2070 | ;; `last-input-event' might be nil. | |
2071 | (not (null last-input-event)) | |
2072 | ;; `last-input-event' may have no character approximation. | |
0d5852cf | 2073 | (tramp-compat-funcall 'event-to-character last-input-event) |
94be87e8 | 2074 | (or |
a6e96327 | 2075 | ;; ?\t has event-modifier 'control. |
800a97b8 | 2076 | (equal |
0d5852cf | 2077 | (tramp-compat-funcall 'event-to-character last-input-event) ?\t) |
94be87e8 | 2078 | (and (not (event-modifiers last-input-event)) |
800a97b8 | 2079 | (or (equal |
0d5852cf MA |
2080 | (tramp-compat-funcall 'event-to-character last-input-event) |
2081 | ?\?) | |
800a97b8 | 2082 | (equal |
0d5852cf MA |
2083 | (tramp-compat-funcall 'event-to-character last-input-event) |
2084 | ?\ ))))))) | |
16674e4f | 2085 | |
acd1f317 MA |
2086 | (defun tramp-connectable-p (filename) |
2087 | "Check, whether it is possible to connect the remote host w/o side-effects. | |
2088 | This is true, if either the remote host is already connected, or if we are | |
2089 | not in completion mode." | |
2090 | (and (tramp-tramp-file-p filename) | |
2091 | (with-parsed-tramp-file-name filename nil | |
2092 | (or (get-buffer (tramp-buffer-name v)) | |
2093 | (not (tramp-completion-mode-p)))))) | |
2094 | ||
16674e4f KG |
2095 | ;; Method, host name and user name completion. |
2096 | ;; `tramp-completion-dissect-file-name' returns a list of | |
2097 | ;; tramp-file-name structures. For all of them we return possible completions. | |
a01b1e22 | 2098 | ;;;###autoload |
16674e4f | 2099 | (defun tramp-completion-handle-file-name-all-completions (filename directory) |
00d6fd04 | 2100 | "Like `file-name-all-completions' for partial Tramp files." |
16674e4f | 2101 | |
00d6fd04 MA |
2102 | (let* ((fullname (tramp-drop-volume-letter |
2103 | (expand-file-name filename directory))) | |
2104 | ;; Possible completion structures. | |
2105 | (v (tramp-completion-dissect-file-name fullname)) | |
2106 | result result1) | |
2107 | ||
2108 | (while v | |
2109 | (let* ((car (car v)) | |
2110 | (method (tramp-file-name-method car)) | |
2111 | (user (tramp-file-name-user car)) | |
2112 | (host (tramp-file-name-host car)) | |
2113 | (localname (tramp-file-name-localname car)) | |
2114 | (m (tramp-find-method method user host)) | |
2115 | (tramp-current-user user) ; see `tramp-parse-passwd' | |
2116 | all-user-hosts) | |
2117 | ||
2118 | (unless localname ;; Nothing to complete. | |
2119 | ||
2120 | (if (or user host) | |
2121 | ||
2122 | ;; Method dependent user / host combinations. | |
2123 | (progn | |
9e6ab520 | 2124 | (mapc |
00d6fd04 MA |
2125 | (lambda (x) |
2126 | (setq all-user-hosts | |
2127 | (append all-user-hosts | |
2128 | (funcall (nth 0 x) (nth 1 x))))) | |
2129 | (tramp-get-completion-function m)) | |
2130 | ||
9e6ab520 MA |
2131 | (setq result |
2132 | (append result | |
2133 | (mapcar | |
2134 | (lambda (x) | |
2135 | (tramp-get-completion-user-host | |
2136 | method user host (nth 0 x) (nth 1 x))) | |
2137 | (delq nil all-user-hosts))))) | |
00d6fd04 MA |
2138 | |
2139 | ;; Possible methods. | |
2140 | (setq result | |
2141 | (append result (tramp-get-completion-methods m))))) | |
2142 | ||
2143 | (setq v (cdr v)))) | |
2144 | ||
2145 | ;; Unify list, remove nil elements. | |
2146 | (while result | |
2147 | (let ((car (car result))) | |
2148 | (when car | |
2149 | (add-to-list | |
2150 | 'result1 | |
2151 | (substring car (length (tramp-drop-volume-letter directory))))) | |
2152 | (setq result (cdr result)))) | |
2153 | ||
2154 | ;; Complete local parts. | |
2155 | (append | |
2156 | result1 | |
03c1ad43 MA |
2157 | (ignore-errors |
2158 | (apply (if (tramp-connectable-p fullname) | |
2159 | 'tramp-completion-run-real-handler | |
2160 | 'tramp-run-real-handler) | |
2161 | 'file-name-all-completions (list (list filename directory))))))) | |
16674e4f KG |
2162 | |
2163 | ;; Method, host name and user name completion for a file. | |
a01b1e22 | 2164 | ;;;###autoload |
e1e17cae MA |
2165 | (defun tramp-completion-handle-file-name-completion |
2166 | (filename directory &optional predicate) | |
00d6fd04 | 2167 | "Like `file-name-completion' for Tramp files." |
e1e17cae MA |
2168 | (try-completion |
2169 | filename | |
2170 | (mapcar 'list (file-name-all-completions filename directory)) | |
acd1f317 MA |
2171 | (when (and predicate |
2172 | (tramp-connectable-p (expand-file-name filename directory))) | |
83e20b5c | 2173 | (lambda (x) (funcall predicate (expand-file-name (car x) directory)))))) |
16674e4f KG |
2174 | |
2175 | ;; I misuse a little bit the tramp-file-name structure in order to handle | |
2176 | ;; completion possibilities for partial methods / user names / host names. | |
2177 | ;; Return value is a list of tramp-file-name structures according to possible | |
00d6fd04 | 2178 | ;; completions. If "localname" is non-nil it means there |
16674e4f KG |
2179 | ;; shouldn't be a completion anymore. |
2180 | ||
2181 | ;; Expected results: | |
2182 | ||
00d6fd04 MA |
2183 | ;; "/x" "/[x" "/x@" "/[x@" "/x@y" "/[x@y" |
2184 | ;; [nil nil "x" nil] [nil "x" nil nil] [nil "x" "y" nil] | |
2185 | ;; [nil "x" nil nil] | |
2186 | ;; ["x" nil nil nil] | |
2187 | ||
2188 | ;; "/x:" "/x:y" "/x:y:" | |
2189 | ;; [nil nil "x" ""] [nil nil "x" "y"] ["x" nil "y" ""] | |
2190 | ;; "/[x/" "/[x/y" | |
2191 | ;; ["x" nil "" nil] ["x" nil "y" nil] | |
2192 | ;; ["x" "" nil nil] ["x" "y" nil nil] | |
2193 | ||
2194 | ;; "/x:y@" "/x:y@z" "/x:y@z:" | |
2195 | ;; [nil nil "x" "y@"] [nil nil "x" "y@z"] ["x" "y" "z" ""] | |
2196 | ;; "/[x/y@" "/[x/y@z" | |
2197 | ;; ["x" nil "y" nil] ["x" "y" "z" nil] | |
16674e4f KG |
2198 | (defun tramp-completion-dissect-file-name (name) |
2199 | "Returns a list of `tramp-file-name' structures. | |
2200 | They are collected by `tramp-completion-dissect-file-name1'." | |
2201 | ||
2202 | (let* ((result) | |
4007ba5b | 2203 | (x-nil "\\|\\(\\)") |
b96e6899 MA |
2204 | (tramp-completion-ipv6-regexp |
2205 | (format | |
2206 | "[^%s]*" | |
2207 | (if (zerop (length tramp-postfix-ipv6-format)) | |
2208 | tramp-postfix-host-format | |
2209 | tramp-postfix-ipv6-format))) | |
4007ba5b KG |
2210 | ;; "/method" "/[method" |
2211 | (tramp-completion-file-name-structure1 | |
2212 | (list (concat tramp-prefix-regexp "\\(" tramp-method-regexp x-nil "\\)$") | |
2213 | 1 nil nil nil)) | |
2214 | ;; "/user" "/[user" | |
2215 | (tramp-completion-file-name-structure2 | |
2216 | (list (concat tramp-prefix-regexp "\\(" tramp-user-regexp x-nil "\\)$") | |
2217 | nil 1 nil nil)) | |
2218 | ;; "/host" "/[host" | |
2219 | (tramp-completion-file-name-structure3 | |
2220 | (list (concat tramp-prefix-regexp "\\(" tramp-host-regexp x-nil "\\)$") | |
2221 | nil nil 1 nil)) | |
b96e6899 | 2222 | ;; "/[ipv6" "/[ipv6" |
4007ba5b | 2223 | (tramp-completion-file-name-structure4 |
b96e6899 MA |
2224 | (list (concat tramp-prefix-regexp |
2225 | tramp-prefix-ipv6-regexp | |
2226 | "\\(" tramp-completion-ipv6-regexp x-nil "\\)$") | |
2227 | nil nil 1 nil)) | |
2228 | ;; "/user@host" "/[user@host" | |
2229 | (tramp-completion-file-name-structure5 | |
4007ba5b KG |
2230 | (list (concat tramp-prefix-regexp |
2231 | "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp | |
2232 | "\\(" tramp-host-regexp x-nil "\\)$") | |
2233 | nil 1 2 nil)) | |
b96e6899 MA |
2234 | ;; "/user@[ipv6" "/[user@ipv6" |
2235 | (tramp-completion-file-name-structure6 | |
2236 | (list (concat tramp-prefix-regexp | |
2237 | "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp | |
2238 | tramp-prefix-ipv6-regexp | |
2239 | "\\(" tramp-completion-ipv6-regexp x-nil "\\)$") | |
2240 | nil 1 2 nil)) | |
00d6fd04 | 2241 | ;; "/method:user" "/[method/user" "/method://user" |
b96e6899 | 2242 | (tramp-completion-file-name-structure7 |
4007ba5b | 2243 | (list (concat tramp-prefix-regexp |
00d6fd04 | 2244 | "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp |
4007ba5b KG |
2245 | "\\(" tramp-user-regexp x-nil "\\)$") |
2246 | 1 2 nil nil)) | |
00d6fd04 | 2247 | ;; "/method:host" "/[method/host" "/method://host" |
b96e6899 | 2248 | (tramp-completion-file-name-structure8 |
4007ba5b | 2249 | (list (concat tramp-prefix-regexp |
00d6fd04 | 2250 | "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp |
4007ba5b KG |
2251 | "\\(" tramp-host-regexp x-nil "\\)$") |
2252 | 1 nil 2 nil)) | |
b96e6899 MA |
2253 | ;; "/method:[ipv6" "/[method/ipv6" "/method://[ipv6" |
2254 | (tramp-completion-file-name-structure9 | |
2255 | (list (concat tramp-prefix-regexp | |
2256 | "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp | |
2257 | tramp-prefix-ipv6-regexp | |
2258 | "\\(" tramp-completion-ipv6-regexp x-nil "\\)$") | |
2259 | 1 nil 2 nil)) | |
00d6fd04 | 2260 | ;; "/method:user@host" "/[method/user@host" "/method://user@host" |
b96e6899 | 2261 | (tramp-completion-file-name-structure10 |
4007ba5b | 2262 | (list (concat tramp-prefix-regexp |
00d6fd04 | 2263 | "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp |
4007ba5b KG |
2264 | "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp |
2265 | "\\(" tramp-host-regexp x-nil "\\)$") | |
00d6fd04 | 2266 | 1 2 3 nil)) |
b96e6899 MA |
2267 | ;; "/method:user@[ipv6" "/[method/user@ipv6" "/method://user@[ipv6" |
2268 | (tramp-completion-file-name-structure11 | |
2269 | (list (concat tramp-prefix-regexp | |
2270 | "\\(" tramp-method-regexp "\\)" tramp-postfix-method-regexp | |
2271 | "\\(" tramp-user-regexp "\\)" tramp-postfix-user-regexp | |
2272 | tramp-prefix-ipv6-regexp | |
2273 | "\\(" tramp-completion-ipv6-regexp x-nil "\\)$") | |
2274 | 1 2 3 nil)) | |
00d6fd04 | 2275 | ;; "/method: "/method:/" |
b96e6899 | 2276 | (tramp-completion-file-name-structure12 |
00d6fd04 MA |
2277 | (list |
2278 | (if (equal tramp-syntax 'url) | |
2279 | (concat tramp-prefix-regexp | |
2280 | "\\(" tramp-method-regexp "\\)" | |
2281 | "\\(" (substring tramp-postfix-method-regexp 0 1) | |
2282 | "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)" | |
2283 | "\\(" "\\)$") | |
2284 | ;; Should not match if not URL syntax. | |
2285 | (concat tramp-prefix-regexp "/$")) | |
2286 | 1 3 nil nil)) | |
2287 | ;; "/method: "/method:/" | |
b96e6899 | 2288 | (tramp-completion-file-name-structure13 |
00d6fd04 MA |
2289 | (list |
2290 | (if (equal tramp-syntax 'url) | |
2291 | (concat tramp-prefix-regexp | |
2292 | "\\(" tramp-method-regexp "\\)" | |
2293 | "\\(" (substring tramp-postfix-method-regexp 0 1) | |
2294 | "\\|" (substring tramp-postfix-method-regexp 1 2) "\\)" | |
2295 | "\\(" "\\)$") | |
2296 | ;; Should not match if not URL syntax. | |
2297 | (concat tramp-prefix-regexp "/$")) | |
2298 | 1 nil 3 nil))) | |
4007ba5b | 2299 | |
9e6ab520 | 2300 | (mapc (lambda (regexp) |
16674e4f KG |
2301 | (add-to-list 'result |
2302 | (tramp-completion-dissect-file-name1 regexp name))) | |
2303 | (list | |
2304 | tramp-completion-file-name-structure1 | |
2305 | tramp-completion-file-name-structure2 | |
2306 | tramp-completion-file-name-structure3 | |
2307 | tramp-completion-file-name-structure4 | |
2308 | tramp-completion-file-name-structure5 | |
2309 | tramp-completion-file-name-structure6 | |
2310 | tramp-completion-file-name-structure7 | |
00d6fd04 MA |
2311 | tramp-completion-file-name-structure8 |
2312 | tramp-completion-file-name-structure9 | |
b96e6899 MA |
2313 | tramp-completion-file-name-structure10 |
2314 | tramp-completion-file-name-structure11 | |
2315 | tramp-completion-file-name-structure12 | |
2316 | tramp-completion-file-name-structure13 | |
16674e4f KG |
2317 | tramp-file-name-structure)) |
2318 | ||
2319 | (delq nil result))) | |
2320 | ||
2321 | (defun tramp-completion-dissect-file-name1 (structure name) | |
2322 | "Returns a `tramp-file-name' structure matching STRUCTURE. | |
00d6fd04 | 2323 | The structure consists of remote method, remote user, |
7432277c | 2324 | remote host and localname (filename on remote host)." |
fb7933a3 | 2325 | |
00d6fd04 MA |
2326 | (save-match-data |
2327 | (when (string-match (nth 0 structure) name) | |
2328 | (let ((method (and (nth 1 structure) | |
2329 | (match-string (nth 1 structure) name))) | |
2330 | (user (and (nth 2 structure) | |
2331 | (match-string (nth 2 structure) name))) | |
2332 | (host (and (nth 3 structure) | |
2333 | (match-string (nth 3 structure) name))) | |
2334 | (localname (and (nth 4 structure) | |
2335 | (match-string (nth 4 structure) name)))) | |
2336 | (vector method user host localname))))) | |
16674e4f KG |
2337 | |
2338 | ;; This function returns all possible method completions, adding the | |
51aba3f3 | 2339 | ;; trailing method delimiter. |
16674e4f KG |
2340 | (defun tramp-get-completion-methods (partial-method) |
2341 | "Returns all method completions for PARTIAL-METHOD." | |
4007ba5b KG |
2342 | (mapcar |
2343 | (lambda (method) | |
2344 | (and method | |
2345 | (string-match (concat "^" (regexp-quote partial-method)) method) | |
00d6fd04 MA |
2346 | (tramp-completion-make-tramp-file-name method nil nil nil))) |
2347 | (mapcar 'car tramp-methods))) | |
16674e4f KG |
2348 | |
2349 | ;; Compares partial user and host names with possible completions. | |
2350 | (defun tramp-get-completion-user-host (method partial-user partial-host user host) | |
2351 | "Returns the most expanded string for user and host name completion. | |
2352 | PARTIAL-USER must match USER, PARTIAL-HOST must match HOST." | |
2353 | (cond | |
2354 | ||
2355 | ((and partial-user partial-host) | |
2356 | (if (and host | |
2357 | (string-match (concat "^" (regexp-quote partial-host)) host) | |
2358 | (string-equal partial-user (or user partial-user))) | |
2359 | (setq user partial-user) | |
2360 | (setq user nil | |
2361 | host nil))) | |
2362 | ||
2363 | (partial-user | |
2364 | (setq host nil) | |
2365 | (unless | |
2366 | (and user (string-match (concat "^" (regexp-quote partial-user)) user)) | |
2367 | (setq user nil))) | |
2368 | ||
2369 | (partial-host | |
2370 | (setq user nil) | |
2371 | (unless | |
2372 | (and host (string-match (concat "^" (regexp-quote partial-host)) host)) | |
2373 | (setq host nil))) | |
2374 | ||
2375 | (t (setq user nil | |
2376 | host nil))) | |
2377 | ||
292ffc15 | 2378 | (unless (zerop (+ (length user) (length host))) |
00d6fd04 | 2379 | (tramp-completion-make-tramp-file-name method user host nil))) |
16674e4f | 2380 | |
f8f91c2b | 2381 | ;;;###tramp-autoload |
16674e4f KG |
2382 | (defun tramp-parse-rhosts (filename) |
2383 | "Return a list of (user host) tuples allowed to access. | |
292ffc15 | 2384 | Either user or host may be nil." |
00d6fd04 MA |
2385 | ;; On Windows, there are problems in completion when |
2386 | ;; `default-directory' is remote. | |
9e6ab520 | 2387 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2388 | res) |
8daea7fc | 2389 | (when (file-readable-p filename) |
16674e4f KG |
2390 | (with-temp-buffer |
2391 | (insert-file-contents filename) | |
2392 | (goto-char (point-min)) | |
2393 | (while (not (eobp)) | |
292ffc15 | 2394 | (push (tramp-parse-rhosts-group) res)))) |
16674e4f KG |
2395 | res)) |
2396 | ||
16674e4f KG |
2397 | (defun tramp-parse-rhosts-group () |
2398 | "Return a (user host) tuple allowed to access. | |
292ffc15 | 2399 | Either user or host may be nil." |
16674e4f KG |
2400 | (let ((result) |
2401 | (regexp | |
2402 | (concat | |
2403 | "^\\(" tramp-host-regexp "\\)" | |
2404 | "\\([ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?"))) | |
6e060cee | 2405 | (narrow-to-region (point) (point-at-eol)) |
16674e4f KG |
2406 | (when (re-search-forward regexp nil t) |
2407 | (setq result (append (list (match-string 3) (match-string 1))))) | |
2408 | (widen) | |
2409 | (forward-line 1) | |
2410 | result)) | |
2411 | ||
f8f91c2b | 2412 | ;;;###tramp-autoload |
16674e4f KG |
2413 | (defun tramp-parse-shosts (filename) |
2414 | "Return a list of (user host) tuples allowed to access. | |
2415 | User is always nil." | |
00d6fd04 MA |
2416 | ;; On Windows, there are problems in completion when |
2417 | ;; `default-directory' is remote. | |
9e6ab520 | 2418 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2419 | res) |
8daea7fc | 2420 | (when (file-readable-p filename) |
16674e4f KG |
2421 | (with-temp-buffer |
2422 | (insert-file-contents filename) | |
2423 | (goto-char (point-min)) | |
2424 | (while (not (eobp)) | |
292ffc15 | 2425 | (push (tramp-parse-shosts-group) res)))) |
16674e4f KG |
2426 | res)) |
2427 | ||
2428 | (defun tramp-parse-shosts-group () | |
2429 | "Return a (user host) tuple allowed to access. | |
2430 | User is always nil." | |
16674e4f KG |
2431 | (let ((result) |
2432 | (regexp (concat "^\\(" tramp-host-regexp "\\)"))) | |
6e060cee | 2433 | (narrow-to-region (point) (point-at-eol)) |
16674e4f KG |
2434 | (when (re-search-forward regexp nil t) |
2435 | (setq result (list nil (match-string 1)))) | |
2436 | (widen) | |
2437 | (or | |
2438 | (> (skip-chars-forward ",") 0) | |
2439 | (forward-line 1)) | |
2440 | result)) | |
2441 | ||
f8f91c2b | 2442 | ;;;###tramp-autoload |
8daea7fc KG |
2443 | (defun tramp-parse-sconfig (filename) |
2444 | "Return a list of (user host) tuples allowed to access. | |
2445 | User is always nil." | |
00d6fd04 MA |
2446 | ;; On Windows, there are problems in completion when |
2447 | ;; `default-directory' is remote. | |
9e6ab520 | 2448 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2449 | res) |
8daea7fc KG |
2450 | (when (file-readable-p filename) |
2451 | (with-temp-buffer | |
2452 | (insert-file-contents filename) | |
2453 | (goto-char (point-min)) | |
2454 | (while (not (eobp)) | |
2455 | (push (tramp-parse-sconfig-group) res)))) | |
2456 | res)) | |
2457 | ||
2458 | (defun tramp-parse-sconfig-group () | |
2459 | "Return a (user host) tuple allowed to access. | |
2460 | User is always nil." | |
8daea7fc KG |
2461 | (let ((result) |
2462 | (regexp (concat "^[ \t]*Host[ \t]+" "\\(" tramp-host-regexp "\\)"))) | |
6e060cee | 2463 | (narrow-to-region (point) (point-at-eol)) |
8daea7fc KG |
2464 | (when (re-search-forward regexp nil t) |
2465 | (setq result (list nil (match-string 1)))) | |
2466 | (widen) | |
2467 | (or | |
2468 | (> (skip-chars-forward ",") 0) | |
2469 | (forward-line 1)) | |
2470 | result)) | |
2471 | ||
f8f91c2b | 2472 | ;;;###tramp-autoload |
5ec2cc41 KG |
2473 | (defun tramp-parse-shostkeys (dirname) |
2474 | "Return a list of (user host) tuples allowed to access. | |
2475 | User is always nil." | |
00d6fd04 MA |
2476 | ;; On Windows, there are problems in completion when |
2477 | ;; `default-directory' is remote. | |
9e6ab520 | 2478 | (let* ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 MA |
2479 | (regexp (concat "^key_[0-9]+_\\(" tramp-host-regexp "\\)\\.pub$")) |
2480 | (files (when (file-directory-p dirname) (directory-files dirname))) | |
2481 | result) | |
5ec2cc41 KG |
2482 | (while files |
2483 | (when (string-match regexp (car files)) | |
2484 | (push (list nil (match-string 1 (car files))) result)) | |
2485 | (setq files (cdr files))) | |
2486 | result)) | |
2487 | ||
2488 | (defun tramp-parse-sknownhosts (dirname) | |
2489 | "Return a list of (user host) tuples allowed to access. | |
2490 | User is always nil." | |
00d6fd04 MA |
2491 | ;; On Windows, there are problems in completion when |
2492 | ;; `default-directory' is remote. | |
9e6ab520 | 2493 | (let* ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 MA |
2494 | (regexp (concat "^\\(" tramp-host-regexp |
2495 | "\\)\\.ssh-\\(dss\\|rsa\\)\\.pub$")) | |
2496 | (files (when (file-directory-p dirname) (directory-files dirname))) | |
2497 | result) | |
5ec2cc41 KG |
2498 | (while files |
2499 | (when (string-match regexp (car files)) | |
2500 | (push (list nil (match-string 1 (car files))) result)) | |
2501 | (setq files (cdr files))) | |
2502 | result)) | |
2503 | ||
f8f91c2b | 2504 | ;;;###tramp-autoload |
16674e4f KG |
2505 | (defun tramp-parse-hosts (filename) |
2506 | "Return a list of (user host) tuples allowed to access. | |
2507 | User is always nil." | |
00d6fd04 MA |
2508 | ;; On Windows, there are problems in completion when |
2509 | ;; `default-directory' is remote. | |
9e6ab520 | 2510 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2511 | res) |
8daea7fc | 2512 | (when (file-readable-p filename) |
16674e4f KG |
2513 | (with-temp-buffer |
2514 | (insert-file-contents filename) | |
2515 | (goto-char (point-min)) | |
2516 | (while (not (eobp)) | |
292ffc15 | 2517 | (push (tramp-parse-hosts-group) res)))) |
16674e4f KG |
2518 | res)) |
2519 | ||
2520 | (defun tramp-parse-hosts-group () | |
2521 | "Return a (user host) tuple allowed to access. | |
2522 | User is always nil." | |
16674e4f | 2523 | (let ((result) |
b96e6899 MA |
2524 | (regexp |
2525 | (concat "^\\(" tramp-ipv6-regexp "\\|" tramp-host-regexp "\\)"))) | |
6e060cee | 2526 | (narrow-to-region (point) (point-at-eol)) |
16674e4f | 2527 | (when (re-search-forward regexp nil t) |
b96e6899 | 2528 | (setq result (list nil (match-string 1)))) |
16674e4f KG |
2529 | (widen) |
2530 | (or | |
2531 | (> (skip-chars-forward " \t") 0) | |
2532 | (forward-line 1)) | |
2533 | result)) | |
2534 | ||
8daea7fc KG |
2535 | ;; For su-alike methods it would be desirable to return "root@localhost" |
2536 | ;; as default. Unfortunately, we have no information whether any user name | |
00d6fd04 | 2537 | ;; has been typed already. So we use `tramp-current-user' as indication, |
8daea7fc | 2538 | ;; assuming it is set in `tramp-completion-handle-file-name-all-completions'. |
f8f91c2b | 2539 | ;;;###tramp-autoload |
16674e4f KG |
2540 | (defun tramp-parse-passwd (filename) |
2541 | "Return a list of (user host) tuples allowed to access. | |
2542 | Host is always \"localhost\"." | |
00d6fd04 MA |
2543 | ;; On Windows, there are problems in completion when |
2544 | ;; `default-directory' is remote. | |
9e6ab520 | 2545 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2546 | res) |
8daea7fc | 2547 | (if (zerop (length tramp-current-user)) |
16674e4f | 2548 | '(("root" nil)) |
8daea7fc | 2549 | (when (file-readable-p filename) |
16674e4f KG |
2550 | (with-temp-buffer |
2551 | (insert-file-contents filename) | |
2552 | (goto-char (point-min)) | |
2553 | (while (not (eobp)) | |
292ffc15 | 2554 | (push (tramp-parse-passwd-group) res)))) |
16674e4f KG |
2555 | res))) |
2556 | ||
2557 | (defun tramp-parse-passwd-group () | |
2558 | "Return a (user host) tuple allowed to access. | |
292ffc15 | 2559 | Host is always \"localhost\"." |
16674e4f KG |
2560 | (let ((result) |
2561 | (regexp (concat "^\\(" tramp-user-regexp "\\):"))) | |
6e060cee | 2562 | (narrow-to-region (point) (point-at-eol)) |
16674e4f KG |
2563 | (when (re-search-forward regexp nil t) |
2564 | (setq result (list (match-string 1) "localhost"))) | |
2565 | (widen) | |
2566 | (forward-line 1) | |
2567 | result)) | |
2568 | ||
f8f91c2b | 2569 | ;;;###tramp-autoload |
292ffc15 KG |
2570 | (defun tramp-parse-netrc (filename) |
2571 | "Return a list of (user host) tuples allowed to access. | |
2572 | User may be nil." | |
00d6fd04 MA |
2573 | ;; On Windows, there are problems in completion when |
2574 | ;; `default-directory' is remote. | |
9e6ab520 | 2575 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 | 2576 | res) |
8daea7fc | 2577 | (when (file-readable-p filename) |
292ffc15 KG |
2578 | (with-temp-buffer |
2579 | (insert-file-contents filename) | |
2580 | (goto-char (point-min)) | |
2581 | (while (not (eobp)) | |
2582 | (push (tramp-parse-netrc-group) res)))) | |
2583 | res)) | |
2584 | ||
2585 | (defun tramp-parse-netrc-group () | |
2586 | "Return a (user host) tuple allowed to access. | |
2587 | User may be nil." | |
292ffc15 KG |
2588 | (let ((result) |
2589 | (regexp | |
2590 | (concat | |
2591 | "^[ \t]*machine[ \t]+" "\\(" tramp-host-regexp "\\)" | |
2592 | "\\([ \t]+login[ \t]+" "\\(" tramp-user-regexp "\\)" "\\)?"))) | |
6e060cee | 2593 | (narrow-to-region (point) (point-at-eol)) |
292ffc15 KG |
2594 | (when (re-search-forward regexp nil t) |
2595 | (setq result (list (match-string 3) (match-string 1)))) | |
2596 | (widen) | |
2597 | (forward-line 1) | |
2598 | result)) | |
2599 | ||
f8f91c2b | 2600 | ;;;###tramp-autoload |
00d6fd04 MA |
2601 | (defun tramp-parse-putty (registry) |
2602 | "Return a list of (user host) tuples allowed to access. | |
2603 | User is always nil." | |
2604 | ;; On Windows, there are problems in completion when | |
2605 | ;; `default-directory' is remote. | |
9e6ab520 | 2606 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
00d6fd04 MA |
2607 | res) |
2608 | (with-temp-buffer | |
0f34aa77 | 2609 | (when (zerop (tramp-compat-call-process "reg" nil t nil "query" registry)) |
00d6fd04 MA |
2610 | (goto-char (point-min)) |
2611 | (while (not (eobp)) | |
2612 | (push (tramp-parse-putty-group registry) res)))) | |
2613 | res)) | |
2614 | ||
2615 | (defun tramp-parse-putty-group (registry) | |
2616 | "Return a (user host) tuple allowed to access. | |
2617 | User is always nil." | |
2618 | (let ((result) | |
2619 | (regexp (concat (regexp-quote registry) "\\\\\\(.+\\)"))) | |
6e060cee | 2620 | (narrow-to-region (point) (point-at-eol)) |
00d6fd04 MA |
2621 | (when (re-search-forward regexp nil t) |
2622 | (setq result (list nil (match-string 1)))) | |
2623 | (widen) | |
2624 | (forward-line 1) | |
2625 | result)) | |
2626 | ||
4a93e698 | 2627 | ;;; Common file name handler functions for different backends: |
b88f2d0a | 2628 | |
4a93e698 MA |
2629 | (defvar tramp-handle-file-local-copy-hook nil |
2630 | "Normal hook to be run at the end of `tramp-*-handle-file-local-copy'.") | |
2631 | ||
2632 | (defvar tramp-handle-write-region-hook nil | |
2633 | "Normal hook to be run at the end of `tramp-*-handle-write-region'.") | |
2634 | ||
2635 | (defun tramp-handle-directory-file-name (directory) | |
2636 | "Like `directory-file-name' for Tramp files." | |
2637 | ;; If localname component of filename is "/", leave it unchanged. | |
2638 | ;; Otherwise, remove any trailing slash from localname component. | |
2639 | ;; Method, host, etc, are unchanged. Does it make sense to try | |
2640 | ;; to avoid parsing the filename? | |
2641 | (with-parsed-tramp-file-name directory nil | |
2642 | (if (and (not (zerop (length localname))) | |
2643 | (eq (aref localname (1- (length localname))) ?/) | |
2644 | (not (string= localname "/"))) | |
2645 | (substring directory 0 -1) | |
2646 | directory))) | |
2647 | ||
2648 | (defun tramp-handle-directory-files | |
2649 | (directory &optional full match nosort files-only) | |
2650 | "Like `directory-files' for Tramp files." | |
2651 | ;; FILES-ONLY is valid for XEmacs only. | |
2652 | (when (file-directory-p directory) | |
2653 | (setq directory (file-name-as-directory (expand-file-name directory))) | |
2654 | (let ((temp (nreverse (file-name-all-completions "" directory))) | |
2655 | result item) | |
2656 | ||
2657 | (while temp | |
2658 | (setq item (directory-file-name (pop temp))) | |
2659 | (when (and (or (null match) (string-match match item)) | |
2660 | (or (null files-only) | |
2661 | ;; Files only. | |
2662 | (and (equal files-only t) (file-regular-p item)) | |
2663 | ;; Directories only. | |
2664 | (file-directory-p item))) | |
2665 | (push (if full (concat directory item) item) | |
2666 | result))) | |
2667 | (if nosort result (sort result 'string<))))) | |
2668 | ||
bd8fadca MA |
2669 | (defun tramp-handle-directory-files-and-attributes |
2670 | (directory &optional full match nosort id-format) | |
2671 | "Like `directory-files-and-attributes' for Tramp files." | |
2672 | (mapcar | |
2673 | (lambda (x) | |
2674 | (cons x (tramp-compat-file-attributes | |
2675 | (if full x (expand-file-name x directory)) id-format))) | |
2676 | (directory-files directory full match nosort))) | |
2677 | ||
4a93e698 MA |
2678 | (defun tramp-handle-dired-uncache (dir &optional dir-p) |
2679 | "Like `dired-uncache' for Tramp files." | |
2680 | ;; DIR-P is valid for XEmacs only. | |
2681 | (with-parsed-tramp-file-name | |
2682 | (if (or dir-p (file-directory-p dir)) dir (file-name-directory dir)) nil | |
2683 | (tramp-flush-directory-property v localname))) | |
2684 | ||
bd8fadca MA |
2685 | (defun tramp-handle-file-exists-p (filename) |
2686 | "Like `file-exists-p' for Tramp files." | |
2687 | (not (null (file-attributes filename)))) | |
2688 | ||
4a93e698 MA |
2689 | (defun tramp-handle-file-modes (filename) |
2690 | "Like `file-modes' for Tramp files." | |
2691 | (let ((truename (or (file-truename filename) filename))) | |
2692 | (when (file-exists-p truename) | |
2693 | (tramp-mode-string-to-int (nth 8 (file-attributes truename)))))) | |
2694 | ||
2695 | ;; Localname manipulation functions that grok Tramp localnames... | |
2696 | (defun tramp-handle-file-name-as-directory (file) | |
2697 | "Like `file-name-as-directory' but aware of Tramp files." | |
2698 | ;; `file-name-as-directory' would be sufficient except localname is | |
2699 | ;; the empty string. | |
2700 | (let ((v (tramp-dissect-file-name file t))) | |
2701 | ;; Run the command on the localname portion only. | |
2702 | (tramp-make-tramp-file-name | |
2703 | (tramp-file-name-method v) | |
2704 | (tramp-file-name-user v) | |
2705 | (tramp-file-name-host v) | |
2706 | (tramp-run-real-handler | |
2707 | 'file-name-as-directory (list (or (tramp-file-name-localname v) "")))))) | |
2708 | ||
2709 | (defun tramp-handle-file-name-completion | |
2710 | (filename directory &optional predicate) | |
2711 | "Like `file-name-completion' for Tramp files." | |
2712 | (unless (tramp-tramp-file-p directory) | |
2713 | (error | |
2714 | "tramp-handle-file-name-completion invoked on non-tramp directory `%s'" | |
2715 | directory)) | |
2716 | (try-completion | |
2717 | filename | |
2718 | (mapcar 'list (file-name-all-completions filename directory)) | |
2719 | (when predicate | |
2720 | (lambda (x) (funcall predicate (expand-file-name (car x) directory)))))) | |
2721 | ||
2722 | (defun tramp-handle-file-name-directory (file) | |
2723 | "Like `file-name-directory' but aware of Tramp files." | |
2724 | ;; Everything except the last filename thing is the directory. We | |
2725 | ;; cannot apply `with-parsed-tramp-file-name', because this expands | |
2726 | ;; the remote file name parts. This is a problem when we are in | |
2727 | ;; file name completion. | |
2728 | (let ((v (tramp-dissect-file-name file t))) | |
2729 | ;; Run the command on the localname portion only. | |
2730 | (tramp-make-tramp-file-name | |
2731 | (tramp-file-name-method v) | |
2732 | (tramp-file-name-user v) | |
2733 | (tramp-file-name-host v) | |
2734 | (tramp-run-real-handler | |
2735 | 'file-name-directory (list (or (tramp-file-name-localname v) "")))))) | |
2736 | ||
2737 | (defun tramp-handle-file-name-nondirectory (file) | |
2738 | "Like `file-name-nondirectory' but aware of Tramp files." | |
2739 | (with-parsed-tramp-file-name file nil | |
2740 | (tramp-run-real-handler 'file-name-nondirectory (list localname)))) | |
2741 | ||
bd8fadca MA |
2742 | (defun tramp-handle-file-newer-than-file-p (file1 file2) |
2743 | "Like `file-newer-than-file-p' for Tramp files." | |
2744 | (cond | |
2745 | ((not (file-exists-p file1)) nil) | |
2746 | ((not (file-exists-p file2)) t) | |
2747 | (t (tramp-time-less-p (nth 5 (file-attributes file2)) | |
2748 | (nth 5 (file-attributes file1)))))) | |
2749 | ||
4a93e698 MA |
2750 | (defun tramp-handle-file-regular-p (filename) |
2751 | "Like `file-regular-p' for Tramp files." | |
2752 | (and (file-exists-p filename) | |
2753 | (eq ?- (aref (nth 8 (file-attributes filename)) 0)))) | |
2754 | ||
2755 | (defun tramp-handle-file-remote-p (filename &optional identification connected) | |
2756 | "Like `file-remote-p' for Tramp files." | |
2757 | (let ((tramp-verbose 3)) | |
2758 | (when (tramp-tramp-file-p filename) | |
2759 | (let* ((v (tramp-dissect-file-name filename)) | |
2760 | (p (tramp-get-connection-process v)) | |
2761 | (c (and p (processp p) (memq (process-status p) '(run open))))) | |
2762 | ;; We expand the file name only, if there is already a connection. | |
2763 | (with-parsed-tramp-file-name | |
2764 | (if c (expand-file-name filename) filename) nil | |
2765 | (and (or (not connected) c) | |
2766 | (cond | |
2767 | ((eq identification 'method) method) | |
2768 | ((eq identification 'user) user) | |
2769 | ((eq identification 'host) host) | |
2770 | ((eq identification 'localname) localname) | |
2771 | (t (tramp-make-tramp-file-name method user host ""))))))))) | |
2772 | ||
2773 | (defun tramp-handle-file-symlink-p (filename) | |
2774 | "Like `file-symlink-p' for Tramp files." | |
2775 | (with-parsed-tramp-file-name filename nil | |
2776 | (let ((x (car (file-attributes filename)))) | |
2777 | (when (stringp x) | |
2778 | ;; When Tramp is running on VMS, then `file-name-absolute-p' | |
2779 | ;; might do weird things. | |
2780 | (if (file-name-absolute-p x) | |
2781 | (tramp-make-tramp-file-name method user host x) | |
2782 | x))))) | |
2783 | ||
2784 | (defun tramp-handle-find-backup-file-name (filename) | |
2785 | "Like `find-backup-file-name' for Tramp files." | |
2786 | (with-parsed-tramp-file-name filename nil | |
2787 | ;; We set both variables. It doesn't matter whether it is | |
2788 | ;; Emacs or XEmacs. | |
2789 | (let ((backup-directory-alist | |
2790 | ;; Emacs case. | |
2791 | (when (boundp 'backup-directory-alist) | |
2792 | (if (symbol-value 'tramp-backup-directory-alist) | |
2793 | (mapcar | |
2794 | (lambda (x) | |
2795 | (cons | |
2796 | (car x) | |
2797 | (if (and (stringp (cdr x)) | |
2798 | (file-name-absolute-p (cdr x)) | |
2799 | (not (tramp-file-name-p (cdr x)))) | |
2800 | (tramp-make-tramp-file-name method user host (cdr x)) | |
2801 | (cdr x)))) | |
2802 | (symbol-value 'tramp-backup-directory-alist)) | |
2803 | (symbol-value 'backup-directory-alist)))) | |
2804 | ||
2805 | (bkup-backup-directory-info | |
2806 | ;; XEmacs case. | |
2807 | (when (boundp 'bkup-backup-directory-info) | |
2808 | (if (symbol-value 'tramp-bkup-backup-directory-info) | |
2809 | (mapcar | |
2810 | (lambda (x) | |
2811 | (nconc | |
2812 | (list (car x)) | |
2813 | (list | |
2814 | (if (and (stringp (car (cdr x))) | |
2815 | (file-name-absolute-p (car (cdr x))) | |
2816 | (not (tramp-file-name-p (car (cdr x))))) | |
2817 | (tramp-make-tramp-file-name | |
2818 | method user host (car (cdr x))) | |
2819 | (car (cdr x)))) | |
2820 | (cdr (cdr x)))) | |
2821 | (symbol-value 'tramp-bkup-backup-directory-info)) | |
2822 | (symbol-value 'bkup-backup-directory-info))))) | |
2823 | ||
2824 | (tramp-run-real-handler 'find-backup-file-name (list filename))))) | |
2825 | ||
2826 | (defun tramp-handle-insert-file-contents | |
2827 | (filename &optional visit beg end replace) | |
2828 | "Like `insert-file-contents' for Tramp files." | |
2829 | (barf-if-buffer-read-only) | |
2830 | (setq filename (expand-file-name filename)) | |
2831 | (let (result local-copy remote-copy) | |
2832 | (with-parsed-tramp-file-name filename nil | |
2833 | (unwind-protect | |
2834 | (if (not (file-exists-p filename)) | |
2835 | ;; We don't raise a Tramp error, because it might be | |
2836 | ;; suppressed, like in `find-file-noselect-1'. | |
2837 | (signal 'file-error | |
2838 | (list "File not found on remote host" filename)) | |
2839 | ||
2840 | (if (and (tramp-local-host-p v) | |
2841 | (let (file-name-handler-alist) | |
2842 | (file-readable-p localname))) | |
2843 | ;; Short track: if we are on the local host, we can | |
2844 | ;; run directly. | |
2845 | (setq result | |
2846 | (tramp-run-real-handler | |
2847 | 'insert-file-contents | |
2848 | (list localname visit beg end replace))) | |
2849 | ||
2850 | ;; When we shall insert only a part of the file, we copy | |
2851 | ;; this part. | |
2852 | (when (or beg end) | |
2853 | (setq remote-copy (tramp-make-tramp-temp-file v)) | |
2854 | ;; This is defined in tramp-sh.el. Let's assume this | |
2855 | ;; is loaded already. | |
2856 | (tramp-compat-funcall 'tramp-send-command | |
2857 | v | |
2858 | (cond | |
2859 | ((and beg end) | |
7c1d9aa0 MA |
2860 | (format "dd bs=1 skip=%d if=%s count=%d of=%s" |
2861 | beg (tramp-shell-quote-argument localname) | |
4a93e698 MA |
2862 | (- end beg) remote-copy)) |
2863 | (beg | |
7c1d9aa0 MA |
2864 | (format "dd bs=1 skip=%d if=%s of=%s" |
2865 | beg (tramp-shell-quote-argument localname) | |
4a93e698 MA |
2866 | remote-copy)) |
2867 | (end | |
7c1d9aa0 MA |
2868 | (format "dd bs=1 count=%d if=%s of=%s" |
2869 | end (tramp-shell-quote-argument localname) | |
4a93e698 MA |
2870 | remote-copy))))) |
2871 | ||
2872 | ;; `insert-file-contents-literally' takes care to avoid | |
2873 | ;; calling jka-compr. By let-binding | |
2874 | ;; `inhibit-file-name-operation', we propagate that care | |
2875 | ;; to the `file-local-copy' operation. | |
2876 | (setq local-copy | |
2877 | (let ((inhibit-file-name-operation | |
2878 | (when (eq inhibit-file-name-operation | |
2879 | 'insert-file-contents) | |
2880 | 'file-local-copy))) | |
2881 | (cond | |
2882 | ((stringp remote-copy) | |
2883 | (file-local-copy | |
2884 | (tramp-make-tramp-file-name | |
2885 | method user host remote-copy))) | |
2886 | ((stringp tramp-temp-buffer-file-name) | |
2887 | (copy-file filename tramp-temp-buffer-file-name 'ok) | |
2888 | tramp-temp-buffer-file-name) | |
2889 | (t (file-local-copy filename))))) | |
2890 | ||
2891 | ;; When the file is not readable for the owner, it | |
d68b0220 MA |
2892 | ;; cannot be inserted, even if it is readable for the |
2893 | ;; group or for everybody. | |
4a93e698 MA |
2894 | (set-file-modes local-copy (tramp-compat-octal-to-decimal "0600")) |
2895 | ||
2896 | (when (and (null remote-copy) | |
2897 | (tramp-get-method-parameter | |
2898 | method 'tramp-copy-keep-tmpfile)) | |
2899 | ;; We keep the local file for performance reasons, | |
2900 | ;; useful for "rsync". | |
d68b0220 | 2901 | (setq tramp-temp-buffer-file-name local-copy)) |
4a93e698 | 2902 | |
7d520089 | 2903 | (tramp-with-progress-reporter |
4a93e698 MA |
2904 | v 3 (format "Inserting local temp file `%s'" local-copy) |
2905 | ;; We must ensure that `file-coding-system-alist' | |
2906 | ;; matches `local-copy'. | |
2907 | (let ((file-coding-system-alist | |
2908 | (tramp-find-file-name-coding-system-alist | |
2909 | filename local-copy))) | |
2910 | (setq result | |
2911 | (insert-file-contents | |
2912 | local-copy nil nil nil replace)))))) | |
2913 | ||
2914 | ;; Save exit. | |
2915 | (progn | |
2916 | (when visit | |
2917 | (setq buffer-file-name filename) | |
2918 | (setq buffer-read-only (not (file-writable-p filename))) | |
2919 | (set-visited-file-modtime) | |
e274eb13 | 2920 | (set-buffer-modified-p nil)) |
4a93e698 MA |
2921 | (when (and (stringp local-copy) |
2922 | (or remote-copy (null tramp-temp-buffer-file-name))) | |
2923 | (delete-file local-copy)) | |
2924 | (when (stringp remote-copy) | |
2925 | (delete-file | |
2926 | (tramp-make-tramp-file-name method user host remote-copy)))))) | |
2927 | ||
2928 | ;; Result. | |
2929 | (list (expand-file-name filename) | |
2930 | (cadr result)))) | |
2931 | ||
2932 | (defun tramp-handle-load (file &optional noerror nomessage nosuffix must-suffix) | |
2933 | "Like `load' for Tramp files." | |
2934 | (with-parsed-tramp-file-name (expand-file-name file) nil | |
2935 | (unless nosuffix | |
2936 | (cond ((file-exists-p (concat file ".elc")) | |
2937 | (setq file (concat file ".elc"))) | |
2938 | ((file-exists-p (concat file ".el")) | |
2939 | (setq file (concat file ".el"))))) | |
2940 | (when must-suffix | |
2941 | ;; The first condition is always true for absolute file names. | |
2942 | ;; Included for safety's sake. | |
2943 | (unless (or (file-name-directory file) | |
2944 | (string-match "\\.elc?\\'" file)) | |
2945 | (tramp-error | |
2946 | v 'file-error | |
2947 | "File `%s' does not include a `.el' or `.elc' suffix" file))) | |
2948 | (unless noerror | |
2949 | (when (not (file-exists-p file)) | |
2950 | (tramp-error v 'file-error "Cannot load nonexistent file `%s'" file))) | |
2951 | (if (not (file-exists-p file)) | |
2952 | nil | |
2953 | (let ((tramp-message-show-message (not nomessage))) | |
7d520089 | 2954 | (tramp-with-progress-reporter v 0 (format "Loading %s" file) |
4a93e698 MA |
2955 | (let ((local-copy (file-local-copy file))) |
2956 | ;; MUST-SUFFIX doesn't exist on XEmacs, so let it default to nil. | |
2957 | (unwind-protect | |
2958 | (load local-copy noerror t t) | |
2959 | (delete-file local-copy))))) | |
2960 | t))) | |
2961 | ||
2962 | (defun tramp-handle-substitute-in-file-name (filename) | |
2963 | "Like `substitute-in-file-name' for Tramp files. | |
2964 | \"//\" and \"/~\" substitute only in the local filename part. | |
51aba3f3 | 2965 | If the URL Tramp syntax is chosen, \"//\" as method delimiter and \"/~\" at |
4a93e698 MA |
2966 | beginning of local filename are not substituted." |
2967 | ;; First, we must replace environment variables. | |
2968 | (setq filename (tramp-replace-environment-variables filename)) | |
2969 | (with-parsed-tramp-file-name filename nil | |
2970 | (if (equal tramp-syntax 'url) | |
2971 | ;; We need to check localname only. The other parts cannot contain | |
2972 | ;; "//" or "/~". | |
2973 | (if (and (> (length localname) 1) | |
2974 | (or (string-match "//" localname) | |
2975 | (string-match "/~" localname 1))) | |
2976 | (tramp-run-real-handler 'substitute-in-file-name (list filename)) | |
2977 | (tramp-make-tramp-file-name | |
2978 | (when method (substitute-in-file-name method)) | |
2979 | (when user (substitute-in-file-name user)) | |
2980 | (when host (substitute-in-file-name host)) | |
2981 | (when localname | |
2982 | (tramp-run-real-handler | |
2983 | 'substitute-in-file-name (list localname))))) | |
2984 | ;; Ignore in LOCALNAME everything before "//" or "/~". | |
2985 | (when (and (stringp localname) (string-match ".+?/\\(/\\|~\\)" localname)) | |
2986 | (setq filename | |
2987 | (concat (file-remote-p filename) | |
2988 | (replace-match "\\1" nil nil localname))) | |
2989 | ;; "/m:h:~" does not work for completion. We use "/m:h:~/". | |
2990 | (when (string-match "~$" filename) | |
2991 | (setq filename (concat filename "/")))) | |
2992 | (tramp-run-real-handler 'substitute-in-file-name (list filename))))) | |
2993 | ||
2994 | (defun tramp-handle-unhandled-file-name-directory (filename) | |
2995 | "Like `unhandled-file-name-directory' for Tramp files." | |
2996 | ;; With Emacs 23, we could simply return `nil'. But we must keep it | |
2997 | ;; for backward compatibility. | |
2998 | (expand-file-name "~/")) | |
b88f2d0a | 2999 | |
4a93e698 | 3000 | ;;; Functions for establishing connection: |
fb7933a3 | 3001 | |
ac474af1 KG |
3002 | ;; The following functions are actions to be taken when seeing certain |
3003 | ;; prompts from the remote host. See the variable | |
3004 | ;; `tramp-actions-before-shell' for usage of these functions. | |
3005 | ||
00d6fd04 | 3006 | (defun tramp-action-login (proc vec) |
ac474af1 | 3007 | "Send the login name." |
00d6fd04 MA |
3008 | (when (not (stringp tramp-current-user)) |
3009 | (save-window-excursion | |
3010 | (let ((enable-recursive-minibuffers t)) | |
3011 | (pop-to-buffer (tramp-get-connection-buffer vec)) | |
3012 | (setq tramp-current-user (read-string (match-string 0)))))) | |
3013 | (tramp-message vec 3 "Sending login name `%s'" tramp-current-user) | |
3014 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3015 | (tramp-message vec 6 "\n%s" (buffer-string))) | |
3016 | (tramp-send-string vec tramp-current-user)) | |
3017 | ||
3018 | (defun tramp-action-password (proc vec) | |
ac474af1 | 3019 | "Query the user for a password." |
70c11b0b MA |
3020 | (with-current-buffer (process-buffer proc) |
3021 | (tramp-check-for-regexp proc tramp-password-prompt-regexp) | |
bb6aba9c MA |
3022 | (tramp-message vec 3 "Sending %s" (match-string 1)) |
3023 | (tramp-enter-password proc) | |
3024 | ;; Hide password prompt. | |
3025 | (narrow-to-region (point-max) (point-max)))) | |
00d6fd04 MA |
3026 | |
3027 | (defun tramp-action-succeed (proc vec) | |
ac474af1 | 3028 | "Signal success in finding shell prompt." |
ac474af1 KG |
3029 | (throw 'tramp-action 'ok)) |
3030 | ||
00d6fd04 | 3031 | (defun tramp-action-permission-denied (proc vec) |
ac474af1 | 3032 | "Signal permission denied." |
00d6fd04 | 3033 | (kill-process proc) |
ac474af1 KG |
3034 | (throw 'tramp-action 'permission-denied)) |
3035 | ||
00d6fd04 | 3036 | (defun tramp-action-yesno (proc vec) |
3cdaec13 KG |
3037 | "Ask the user for confirmation using `yes-or-no-p'. |
3038 | Send \"yes\" to remote process on confirmation, abort otherwise. | |
3039 | See also `tramp-action-yn'." | |
ac474af1 | 3040 | (save-window-excursion |
00d6fd04 MA |
3041 | (let ((enable-recursive-minibuffers t)) |
3042 | (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec))) | |
3043 | (unless (yes-or-no-p (match-string 0)) | |
3044 | (kill-process proc) | |
3045 | (throw 'tramp-action 'permission-denied)) | |
3046 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3047 | (tramp-message vec 6 "\n%s" (buffer-string))) | |
3048 | (tramp-send-string vec "yes")))) | |
3049 | ||
3050 | (defun tramp-action-yn (proc vec) | |
3cdaec13 KG |
3051 | "Ask the user for confirmation using `y-or-n-p'. |
3052 | Send \"y\" to remote process on confirmation, abort otherwise. | |
3053 | See also `tramp-action-yesno'." | |
3054 | (save-window-excursion | |
00d6fd04 MA |
3055 | (let ((enable-recursive-minibuffers t)) |
3056 | (save-match-data (pop-to-buffer (tramp-get-connection-buffer vec))) | |
3057 | (unless (y-or-n-p (match-string 0)) | |
3058 | (kill-process proc) | |
3059 | (throw 'tramp-action 'permission-denied)) | |
3060 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3061 | (tramp-message vec 6 "\n%s" (buffer-string))) | |
3062 | (tramp-send-string vec "y")))) | |
3063 | ||
3064 | (defun tramp-action-terminal (proc vec) | |
487f4fb7 KG |
3065 | "Tell the remote host which terminal type to use. |
3066 | The terminal type can be configured with `tramp-terminal-type'." | |
00d6fd04 | 3067 | (tramp-message vec 5 "Setting `%s' as terminal type." tramp-terminal-type) |
7e780ff1 MA |
3068 | (with-current-buffer (tramp-get-connection-buffer vec) |
3069 | (tramp-message vec 6 "\n%s" (buffer-string))) | |
00d6fd04 | 3070 | (tramp-send-string vec tramp-terminal-type)) |
487f4fb7 | 3071 | |
00d6fd04 | 3072 | (defun tramp-action-process-alive (proc vec) |
a94d821f | 3073 | "Check, whether a process has finished." |
00d6fd04 | 3074 | (unless (memq (process-status proc) '(run open)) |
19a87064 MA |
3075 | (throw 'tramp-action 'process-died))) |
3076 | ||
00d6fd04 | 3077 | (defun tramp-action-out-of-band (proc vec) |
a94d821f | 3078 | "Check, whether an out-of-band copy has finished." |
00d6fd04 MA |
3079 | (cond ((and (memq (process-status proc) '(stop exit)) |
3080 | (zerop (process-exit-status proc))) | |
3081 | (tramp-message vec 3 "Process has finished.") | |
38c65fca | 3082 | (throw 'tramp-action 'ok)) |
00d6fd04 MA |
3083 | ((or (and (memq (process-status proc) '(stop exit)) |
3084 | (not (zerop (process-exit-status proc)))) | |
3085 | (memq (process-status proc) '(signal))) | |
01917a18 MA |
3086 | ;; `scp' could have copied correctly, but set modes could have failed. |
3087 | ;; This can be ignored. | |
00d6fd04 MA |
3088 | (with-current-buffer (process-buffer proc) |
3089 | (goto-char (point-min)) | |
3090 | (if (re-search-forward tramp-operation-not-permitted-regexp nil t) | |
3091 | (progn | |
3092 | (tramp-message vec 5 "'set mode' error ignored.") | |
3093 | (tramp-message vec 3 "Process has finished.") | |
3094 | (throw 'tramp-action 'ok)) | |
3095 | (tramp-message vec 3 "Process has died.") | |
3096 | (throw 'tramp-action 'process-died)))) | |
38c65fca KG |
3097 | (t nil))) |
3098 | ||
4a93e698 | 3099 | ;;; Functions for processing the actions: |
ac474af1 | 3100 | |
00d6fd04 | 3101 | (defun tramp-process-one-action (proc vec actions) |
ac474af1 | 3102 | "Wait for output from the shell and perform one action." |
00d6fd04 | 3103 | (let (found todo item pattern action) |
e6466697 | 3104 | (while (not found) |
00d6fd04 MA |
3105 | ;; Reread output once all actions have been performed. |
3106 | ;; Obviously, the output was not complete. | |
3107 | (tramp-accept-process-output proc 1) | |
e6466697 MA |
3108 | (setq todo actions) |
3109 | (while todo | |
e6466697 | 3110 | (setq item (pop todo)) |
95d610cb | 3111 | (setq pattern (format "\\(%s\\)\\'" (symbol-value (nth 0 item)))) |
e6466697 | 3112 | (setq action (nth 1 item)) |
00d6fd04 MA |
3113 | (tramp-message |
3114 | vec 5 "Looking for regexp \"%s\" from remote shell" pattern) | |
3115 | (when (tramp-check-for-regexp proc pattern) | |
3116 | (tramp-message vec 5 "Call `%s'" (symbol-name action)) | |
3117 | (setq found (funcall action proc vec))))) | |
e6466697 MA |
3118 | found)) |
3119 | ||
bfd31217 MA |
3120 | (defun tramp-process-actions (proc vec pos actions &optional timeout) |
3121 | "Perform ACTIONS until success or TIMEOUT. | |
3122 | PROC and VEC indicate the remote connection to be used. POS, if | |
3123 | set, is the starting point of the region to be deleted in the | |
3124 | connection buffer." | |
9e021389 | 3125 | ;; Preserve message for `progress-reporter'. |
6139f995 | 3126 | (tramp-compat-with-temp-message "" |
2fb0a219 MA |
3127 | ;; Enable auth-source and password-cache. We must use |
3128 | ;; tramp-current-* variables in case we have several hops. | |
3129 | (tramp-set-connection-property | |
3130 | (tramp-dissect-file-name | |
3131 | (tramp-make-tramp-file-name | |
3132 | tramp-current-method tramp-current-user tramp-current-host "")) | |
3133 | "first-password-request" t) | |
158d5945 MA |
3134 | (save-restriction |
3135 | (let (exit) | |
3136 | (while (not exit) | |
3137 | (tramp-message proc 3 "Waiting for prompts from remote shell") | |
3138 | (setq exit | |
3139 | (catch 'tramp-action | |
3140 | (if timeout | |
3141 | (with-timeout (timeout) | |
3142 | (tramp-process-one-action proc vec actions)) | |
3143 | (tramp-process-one-action proc vec actions))))) | |
3144 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3145 | (widen) | |
3146 | (tramp-message vec 6 "\n%s" (buffer-string))) | |
3147 | (unless (eq exit 'ok) | |
3148 | (tramp-clear-passwd vec) | |
3149 | (tramp-error-with-buffer | |
3150 | nil vec 'file-error | |
3151 | (cond | |
3152 | ((eq exit 'permission-denied) "Permission denied") | |
3153 | ((eq exit 'process-died) "Process died") | |
bfd31217 MA |
3154 | (t "Login failed")))) |
3155 | (when (numberp pos) | |
3156 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3157 | (let (buffer-read-only) (delete-region pos (point))))))))) | |
fb7933a3 | 3158 | |
4a93e698 | 3159 | :;; Utility functions: |
fb7933a3 | 3160 | |
00d6fd04 | 3161 | (defun tramp-accept-process-output (&optional proc timeout timeout-msecs) |
d2a2c17f MA |
3162 | "Like `accept-process-output' for Tramp processes. |
3163 | This is needed in order to hide `last-coding-system-used', which is set | |
3164 | for process communication also." | |
00d6fd04 MA |
3165 | (with-current-buffer (process-buffer proc) |
3166 | (tramp-message proc 10 "%s %s" proc (process-status proc)) | |
3167 | (let (buffer-read-only last-coding-system-used) | |
3168 | ;; Under Windows XP, accept-process-output doesn't return | |
3169 | ;; sometimes. So we add an additional timeout. | |
3170 | (with-timeout ((or timeout 1)) | |
3171 | (accept-process-output proc timeout timeout-msecs))) | |
3172 | (tramp-message proc 10 "\n%s" (buffer-string)))) | |
3173 | ||
3174 | (defun tramp-check-for-regexp (proc regexp) | |
a94d821f | 3175 | "Check, whether REGEXP is contained in process buffer of PROC. |
00d6fd04 MA |
3176 | Erase echoed commands if exists." |
3177 | (with-current-buffer (process-buffer proc) | |
3178 | (goto-char (point-min)) | |
674da028 | 3179 | |
00d6fd04 MA |
3180 | ;; Check whether we need to remove echo output. |
3181 | (when (and (tramp-get-connection-property proc "check-remote-echo" nil) | |
3182 | (re-search-forward tramp-echoed-echo-mark-regexp nil t)) | |
3183 | (let ((begin (match-beginning 0))) | |
3184 | (when (re-search-forward tramp-echoed-echo-mark-regexp nil t) | |
3185 | ;; Discard echo from remote output. | |
3186 | (tramp-set-connection-property proc "check-remote-echo" nil) | |
3187 | (tramp-message proc 5 "echo-mark found") | |
b533bc97 | 3188 | (forward-line 1) |
00d6fd04 MA |
3189 | (delete-region begin (point)) |
3190 | (goto-char (point-min))))) | |
674da028 | 3191 | |
68712eb6 MA |
3192 | (when (or (not (tramp-get-connection-property proc "check-remote-echo" nil)) |
3193 | ;; Sometimes, the echo string is suppressed on the remote side. | |
3194 | (not (string-equal | |
0d5852cf MA |
3195 | (tramp-compat-funcall |
3196 | 'substring-no-properties tramp-echo-mark-marker | |
68712eb6 | 3197 | 0 (min tramp-echo-mark-marker-length (1- (point-max)))) |
0d5852cf MA |
3198 | (tramp-compat-funcall |
3199 | 'buffer-substring-no-properties | |
68712eb6 | 3200 | 1 (min (1+ tramp-echo-mark-marker-length) (point-max)))))) |
70c11b0b | 3201 | ;; No echo to be handled, now we can look for the regexp. |
674da028 | 3202 | (goto-char (point-min)) |
00d6fd04 | 3203 | (re-search-forward regexp nil t)))) |
d2a2c17f | 3204 | |
fb7933a3 KG |
3205 | (defun tramp-wait-for-regexp (proc timeout regexp) |
3206 | "Wait for a REGEXP to appear from process PROC within TIMEOUT seconds. | |
3207 | Expects the output of PROC to be sent to the current buffer. Returns | |
3208 | the string that matched, or nil. Waits indefinitely if TIMEOUT is | |
3209 | nil." | |
00d6fd04 MA |
3210 | (with-current-buffer (process-buffer proc) |
3211 | (let ((found (tramp-check-for-regexp proc regexp)) | |
3212 | (start-time (current-time))) | |
3213 | (cond (timeout | |
3214 | ;; Work around a bug in XEmacs 21, where the timeout | |
3215 | ;; expires faster than it should. This degenerates | |
3216 | ;; to polling for buggy XEmacsen, but oh, well. | |
3217 | (while (and (not found) | |
3218 | (< (tramp-time-diff (current-time) start-time) | |
3219 | timeout)) | |
3220 | (with-timeout (timeout) | |
3221 | (while (not found) | |
3222 | (tramp-accept-process-output proc 1) | |
3223 | (unless (memq (process-status proc) '(run open)) | |
3224 | (tramp-error-with-buffer | |
3225 | nil proc 'file-error "Process has died")) | |
3226 | (setq found (tramp-check-for-regexp proc regexp)))))) | |
3227 | (t | |
3228 | (while (not found) | |
3229 | (tramp-accept-process-output proc 1) | |
3230 | (unless (memq (process-status proc) '(run open)) | |
3231 | (tramp-error-with-buffer | |
3232 | nil proc 'file-error "Process has died")) | |
3233 | (setq found (tramp-check-for-regexp proc regexp))))) | |
3234 | (tramp-message proc 6 "\n%s" (buffer-string)) | |
fb7933a3 | 3235 | (when (not found) |
00d6fd04 MA |
3236 | (if timeout |
3237 | (tramp-error | |
3238 | proc 'file-error "[[Regexp `%s' not found in %d secs]]" | |
3239 | regexp timeout) | |
3240 | (tramp-error proc 'file-error "[[Regexp `%s' not found]]" regexp))) | |
3241 | found))) | |
fb7933a3 | 3242 | |
7e780ff1 MA |
3243 | ;; We don't call `tramp-send-string' in order to hide the password |
3244 | ;; from the debug buffer, and because end-of-line handling of the | |
3245 | ;; string. | |
3246 | (defun tramp-enter-password (proc) | |
00d6fd04 MA |
3247 | "Prompt for a password and send it to the remote end." |
3248 | (process-send-string | |
7e780ff1 MA |
3249 | proc (concat (tramp-read-passwd proc) |
3250 | (or (tramp-get-method-parameter | |
3251 | tramp-current-method | |
3252 | 'tramp-password-end-of-line) | |
3253 | tramp-default-password-end-of-line)))) | |
00d6fd04 | 3254 | |
7432277c KG |
3255 | ;; It seems that Tru64 Unix does not like it if long strings are sent |
3256 | ;; to it in one go. (This happens when sending the Perl | |
3257 | ;; `file-attributes' implementation, for instance.) Therefore, we | |
27e813fe | 3258 | ;; have this function which sends the string in chunks. |
00d6fd04 MA |
3259 | (defun tramp-send-string (vec string) |
3260 | "Send the STRING via connection VEC. | |
7432277c KG |
3261 | |
3262 | The STRING is expected to use Unix line-endings, but the lines sent to | |
3263 | the remote host use line-endings as defined in the variable | |
00d6fd04 MA |
3264 | `tramp-rsh-end-of-line'. The communication buffer is erased before sending." |
3265 | (let* ((p (tramp-get-connection-process vec)) | |
3266 | (chunksize (tramp-get-connection-property p "chunksize" nil))) | |
3267 | (unless p | |
3268 | (tramp-error | |
3269 | vec 'file-error "Can't send string to remote host -- not logged in")) | |
3270 | (tramp-set-connection-property p "last-cmd-time" (current-time)) | |
3271 | (tramp-message vec 10 "%s" string) | |
3272 | (with-current-buffer (tramp-get-connection-buffer vec) | |
3273 | ;; Clean up the buffer. We cannot call `erase-buffer' because | |
3274 | ;; narrowing might be in effect. | |
3275 | (let (buffer-read-only) (delete-region (point-min) (point-max))) | |
27e813fe | 3276 | ;; Replace "\n" by `tramp-rsh-end-of-line'. |
00d6fd04 MA |
3277 | (setq string |
3278 | (mapconcat 'identity | |
70c11b0b | 3279 | (tramp-compat-split-string string "\n") |
00d6fd04 MA |
3280 | tramp-rsh-end-of-line)) |
3281 | (unless (or (string= string "") | |
3282 | (string-equal (substring string -1) tramp-rsh-end-of-line)) | |
3283 | (setq string (concat string tramp-rsh-end-of-line))) | |
27e813fe | 3284 | ;; Send the string. |
00d6fd04 MA |
3285 | (if (and chunksize (not (zerop chunksize))) |
3286 | (let ((pos 0) | |
3287 | (end (length string))) | |
3288 | (while (< pos end) | |
3289 | (tramp-message | |
3290 | vec 10 "Sending chunk from %s to %s" | |
3291 | pos (min (+ pos chunksize) end)) | |
3292 | (process-send-string | |
3293 | p (substring string pos (min (+ pos chunksize) end))) | |
3294 | (setq pos (+ pos chunksize)))) | |
3295 | (process-send-string p string))))) | |
fb7933a3 | 3296 | |
ce3f516f | 3297 | (defun tramp-get-inode (vec) |
00d6fd04 MA |
3298 | "Returns the virtual inode number. |
3299 | If it doesn't exist, generate a new one." | |
ce3f516f MA |
3300 | (let ((string (tramp-make-tramp-file-name |
3301 | (tramp-file-name-method vec) | |
3302 | (tramp-file-name-user vec) | |
3303 | (tramp-file-name-host vec) | |
3304 | ""))) | |
00d6fd04 MA |
3305 | (unless (assoc string tramp-inodes) |
3306 | (add-to-list 'tramp-inodes | |
3307 | (list string (length tramp-inodes)))) | |
3308 | (nth 1 (assoc string tramp-inodes)))) | |
3309 | ||
3310 | (defun tramp-get-device (vec) | |
c82c5727 LH |
3311 | "Returns the virtual device number. |
3312 | If it doesn't exist, generate a new one." | |
00d6fd04 MA |
3313 | (let ((string (tramp-make-tramp-file-name |
3314 | (tramp-file-name-method vec) | |
3315 | (tramp-file-name-user vec) | |
3316 | (tramp-file-name-host vec) | |
3317 | ""))) | |
c82c5727 LH |
3318 | (unless (assoc string tramp-devices) |
3319 | (add-to-list 'tramp-devices | |
3320 | (list string (length tramp-devices)))) | |
b946a456 | 3321 | (cons -1 (nth 1 (assoc string tramp-devices))))) |
fb7933a3 | 3322 | |
00d6fd04 | 3323 | (defun tramp-equal-remote (file1 file2) |
a94d821f | 3324 | "Check, whether the remote parts of FILE1 and FILE2 are identical. |
00d6fd04 MA |
3325 | The check depends on method, user and host name of the files. If |
3326 | one of the components is missing, the default values are used. | |
3327 | The local file name parts of FILE1 and FILE2 are not taken into | |
3328 | account. | |
fb7933a3 | 3329 | |
00d6fd04 MA |
3330 | Example: |
3331 | ||
3332 | (tramp-equal-remote \"/ssh::/etc\" \"/<your host name>:/home\") | |
3333 | ||
3334 | would yield `t'. On the other hand, the following check results in nil: | |
3335 | ||
3336 | (tramp-equal-remote \"/sudo::/etc\" \"/su::/etc\")" | |
9e6ab520 MA |
3337 | (and (stringp (file-remote-p file1)) |
3338 | (stringp (file-remote-p file2)) | |
94be87e8 | 3339 | (string-equal (file-remote-p file1) (file-remote-p file2)))) |
00d6fd04 | 3340 | |
00d6fd04 | 3341 | (defun tramp-get-method-parameter (method param) |
c951aecb | 3342 | "Return the method parameter PARAM. |
6a29a838 | 3343 | If the `tramp-methods' entry does not exist, return nil." |
00d6fd04 MA |
3344 | (let ((entry (assoc param (assoc method tramp-methods)))) |
3345 | (when entry (cadr entry)))) | |
90f8dc03 | 3346 | |
4a93e698 MA |
3347 | (defun tramp-mode-string-to-int (mode-string) |
3348 | "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits." | |
3349 | (let* (case-fold-search | |
3350 | (mode-chars (string-to-vector mode-string)) | |
3351 | (owner-read (aref mode-chars 1)) | |
3352 | (owner-write (aref mode-chars 2)) | |
3353 | (owner-execute-or-setid (aref mode-chars 3)) | |
3354 | (group-read (aref mode-chars 4)) | |
3355 | (group-write (aref mode-chars 5)) | |
3356 | (group-execute-or-setid (aref mode-chars 6)) | |
3357 | (other-read (aref mode-chars 7)) | |
3358 | (other-write (aref mode-chars 8)) | |
3359 | (other-execute-or-sticky (aref mode-chars 9))) | |
3360 | (save-match-data | |
3361 | (logior | |
3362 | (cond | |
3363 | ((char-equal owner-read ?r) (tramp-compat-octal-to-decimal "00400")) | |
3364 | ((char-equal owner-read ?-) 0) | |
3365 | (t (error "Second char `%c' must be one of `r-'" owner-read))) | |
3366 | (cond | |
3367 | ((char-equal owner-write ?w) (tramp-compat-octal-to-decimal "00200")) | |
3368 | ((char-equal owner-write ?-) 0) | |
3369 | (t (error "Third char `%c' must be one of `w-'" owner-write))) | |
3370 | (cond | |
3371 | ((char-equal owner-execute-or-setid ?x) | |
3372 | (tramp-compat-octal-to-decimal "00100")) | |
3373 | ((char-equal owner-execute-or-setid ?S) | |
3374 | (tramp-compat-octal-to-decimal "04000")) | |
3375 | ((char-equal owner-execute-or-setid ?s) | |
3376 | (tramp-compat-octal-to-decimal "04100")) | |
3377 | ((char-equal owner-execute-or-setid ?-) 0) | |
3378 | (t (error "Fourth char `%c' must be one of `xsS-'" | |
3379 | owner-execute-or-setid))) | |
3380 | (cond | |
3381 | ((char-equal group-read ?r) (tramp-compat-octal-to-decimal "00040")) | |
3382 | ((char-equal group-read ?-) 0) | |
3383 | (t (error "Fifth char `%c' must be one of `r-'" group-read))) | |
3384 | (cond | |
3385 | ((char-equal group-write ?w) (tramp-compat-octal-to-decimal "00020")) | |
3386 | ((char-equal group-write ?-) 0) | |
3387 | (t (error "Sixth char `%c' must be one of `w-'" group-write))) | |
3388 | (cond | |
3389 | ((char-equal group-execute-or-setid ?x) | |
3390 | (tramp-compat-octal-to-decimal "00010")) | |
3391 | ((char-equal group-execute-or-setid ?S) | |
3392 | (tramp-compat-octal-to-decimal "02000")) | |
3393 | ((char-equal group-execute-or-setid ?s) | |
3394 | (tramp-compat-octal-to-decimal "02010")) | |
3395 | ((char-equal group-execute-or-setid ?-) 0) | |
3396 | (t (error "Seventh char `%c' must be one of `xsS-'" | |
3397 | group-execute-or-setid))) | |
3398 | (cond | |
3399 | ((char-equal other-read ?r) | |
3400 | (tramp-compat-octal-to-decimal "00004")) | |
3401 | ((char-equal other-read ?-) 0) | |
3402 | (t (error "Eighth char `%c' must be one of `r-'" other-read))) | |
3403 | (cond | |
3404 | ((char-equal other-write ?w) (tramp-compat-octal-to-decimal "00002")) | |
3405 | ((char-equal other-write ?-) 0) | |
3406 | (t (error "Nineth char `%c' must be one of `w-'" other-write))) | |
3407 | (cond | |
3408 | ((char-equal other-execute-or-sticky ?x) | |
3409 | (tramp-compat-octal-to-decimal "00001")) | |
3410 | ((char-equal other-execute-or-sticky ?T) | |
3411 | (tramp-compat-octal-to-decimal "01000")) | |
3412 | ((char-equal other-execute-or-sticky ?t) | |
3413 | (tramp-compat-octal-to-decimal "01001")) | |
3414 | ((char-equal other-execute-or-sticky ?-) 0) | |
3415 | (t (error "Tenth char `%c' must be one of `xtT-'" | |
3416 | other-execute-or-sticky))))))) | |
3417 | ||
3418 | (defun tramp-local-host-p (vec) | |
3419 | "Return t if this points to the local host, nil otherwise." | |
3420 | ;; We cannot use `tramp-file-name-real-host'. A port is an | |
3421 | ;; indication for an ssh tunnel or alike. | |
3422 | (let ((host (tramp-file-name-host vec))) | |
3423 | (and | |
3424 | (stringp host) | |
3425 | (string-match tramp-local-host-regexp host) | |
3426 | ;; The method shall be applied to one of the shell file name | |
3427 | ;; handler. `tramp-local-host-p' is also called for "smb" and | |
3428 | ;; alike, where it must fail. | |
3429 | (tramp-get-method-parameter | |
3430 | (tramp-file-name-method vec) 'tramp-login-program) | |
3431 | ;; The local temp directory must be writable for the other user. | |
3432 | (file-writable-p | |
3433 | (tramp-make-tramp-file-name | |
3434 | (tramp-file-name-method vec) | |
3435 | (tramp-file-name-user vec) | |
3436 | host | |
3437 | (tramp-compat-temporary-file-directory))) | |
3438 | ;; On some systems, chown runs only for root. | |
3439 | (or (zerop (user-uid)) | |
3440 | ;; This is defined in tramp-sh.el. Let's assume this is | |
3441 | ;; loaded already. | |
3442 | (zerop (tramp-compat-funcall 'tramp-get-remote-uid vec 'integer)))))) | |
3443 | ||
3444 | (defun tramp-make-tramp-temp-file (vec) | |
3445 | "Create a temporary file on the remote host identified by VEC. | |
3446 | Return the local name of the temporary file." | |
3447 | (let ((prefix | |
3448 | (tramp-make-tramp-file-name | |
3449 | (tramp-file-name-method vec) | |
3450 | (tramp-file-name-user vec) | |
3451 | (tramp-file-name-host vec) | |
3452 | (tramp-drop-volume-letter | |
3453 | (expand-file-name | |
3454 | tramp-temp-name-prefix | |
3455 | ;; This is defined in tramp-sh.el. Let's assume this is | |
3456 | ;; loaded already. | |
3457 | (tramp-compat-funcall 'tramp-get-remote-tmpdir vec))))) | |
3458 | result) | |
3459 | (while (not result) | |
3460 | ;; `make-temp-file' would be the natural choice for | |
3461 | ;; implementation. But it calls `write-region' internally, | |
3462 | ;; which also needs a temporary file - we would end in an | |
3463 | ;; infinite loop. | |
3464 | (setq result (make-temp-name prefix)) | |
3465 | (if (file-exists-p result) | |
3466 | (setq result nil) | |
3467 | ;; This creates the file by side effect. | |
3468 | (set-file-times result) | |
3469 | (set-file-modes result (tramp-compat-octal-to-decimal "0700")))) | |
3470 | ||
3471 | ;; Return the local part. | |
3472 | (with-parsed-tramp-file-name result nil localname))) | |
fb7933a3 | 3473 | |
4a93e698 MA |
3474 | (defun tramp-delete-temp-file-function () |
3475 | "Remove temporary files related to current buffer." | |
3476 | (when (stringp tramp-temp-buffer-file-name) | |
3477 | (ignore-errors (delete-file tramp-temp-buffer-file-name)))) | |
3478 | ||
3479 | (add-hook 'kill-buffer-hook 'tramp-delete-temp-file-function) | |
3480 | (add-hook 'tramp-cache-unload-hook | |
3481 | (lambda () | |
3482 | (remove-hook 'kill-buffer-hook | |
3483 | 'tramp-delete-temp-file-function))) | |
3484 | ||
3485 | ;;; Auto saving to a special directory: | |
c1105d05 MA |
3486 | |
3487 | (unless (tramp-exists-file-name-handler 'make-auto-save-file-name) | |
3488 | (defadvice make-auto-save-file-name | |
3489 | (around tramp-advice-make-auto-save-file-name () activate) | |
03c1ad43 | 3490 | "Invoke `tramp-*-handle-make-auto-save-file-name' for Tramp files." |
b533bc97 | 3491 | (if (tramp-tramp-file-p (buffer-file-name)) |
7f49fe46 MA |
3492 | ;; We cannot call `tramp-handle-make-auto-save-file-name' |
3493 | ;; directly, because this would bypass the locking mechanism. | |
3494 | (setq ad-return-value | |
3495 | (tramp-file-name-handler 'make-auto-save-file-name)) | |
a69c01a0 | 3496 | ad-do-it)) |
191bb792 MA |
3497 | (add-hook |
3498 | 'tramp-unload-hook | |
3499 | (lambda () | |
3500 | (ad-remove-advice | |
3501 | 'make-auto-save-file-name | |
d7ec1df7 MA |
3502 | 'around 'tramp-advice-make-auto-save-file-name) |
3503 | (ad-activate 'make-auto-save-file-name)))) | |
fb7933a3 | 3504 | |
b533bc97 MA |
3505 | ;; In XEmacs < 21.5, autosaved remote files have permission 0666 minus |
3506 | ;; umask. This is a security threat. | |
414da5ab MA |
3507 | |
3508 | (defun tramp-set-auto-save-file-modes () | |
3509 | "Set permissions of autosaved remote files to the original permissions." | |
3510 | (let ((bfn (buffer-file-name))) | |
b533bc97 | 3511 | (when (and (tramp-tramp-file-p bfn) |
b50dd0d2 | 3512 | (buffer-modified-p) |
414da5ab | 3513 | (stringp buffer-auto-save-file-name) |
340b8d4f MA |
3514 | (not (equal bfn buffer-auto-save-file-name))) |
3515 | (unless (file-exists-p buffer-auto-save-file-name) | |
3516 | (write-region "" nil buffer-auto-save-file-name)) | |
3517 | ;; Permissions should be set always, because there might be an old | |
3518 | ;; auto-saved file belonging to another original file. This could | |
3519 | ;; be a security threat. | |
0f34aa77 MA |
3520 | (set-file-modes |
3521 | buffer-auto-save-file-name | |
3522 | (or (file-modes bfn) (tramp-compat-octal-to-decimal "0600")))))) | |
414da5ab | 3523 | |
b533bc97 MA |
3524 | (unless (and (featurep 'xemacs) |
3525 | (= emacs-major-version 21) | |
3526 | (> emacs-minor-version 4)) | |
a69c01a0 MA |
3527 | (add-hook 'auto-save-hook 'tramp-set-auto-save-file-modes) |
3528 | (add-hook 'tramp-unload-hook | |
aa485f7c MA |
3529 | (lambda () |
3530 | (remove-hook 'auto-save-hook 'tramp-set-auto-save-file-modes)))) | |
414da5ab | 3531 | |
fb7933a3 KG |
3532 | (defun tramp-subst-strs-in-string (alist string) |
3533 | "Replace all occurrences of the string FROM with TO in STRING. | |
3534 | ALIST is of the form ((FROM . TO) ...)." | |
3535 | (save-match-data | |
3536 | (while alist | |
3537 | (let* ((pr (car alist)) | |
3538 | (from (car pr)) | |
3539 | (to (cdr pr))) | |
3540 | (while (string-match (regexp-quote from) string) | |
3541 | (setq string (replace-match to t t string))) | |
3542 | (setq alist (cdr alist)))) | |
3543 | string)) | |
3544 | ||
4a93e698 | 3545 | ;;; Compatibility functions section: |
fb7933a3 | 3546 | |
00d6fd04 | 3547 | (defun tramp-read-passwd (proc &optional prompt) |
fb7933a3 | 3548 | "Read a password from user (compat function). |
5615d63f | 3549 | Consults the auth-source package. |
5ec2cc41 | 3550 | Invokes `password-read' if available, `read-passwd' else." |
00d6fd04 MA |
3551 | (let* ((key (tramp-make-tramp-file-name |
3552 | tramp-current-method tramp-current-user | |
3553 | tramp-current-host "")) | |
3554 | (pw-prompt | |
3555 | (or prompt | |
3556 | (with-current-buffer (process-buffer proc) | |
3557 | (tramp-check-for-regexp proc tramp-password-prompt-regexp) | |
563790b6 TZ |
3558 | (format "%s for %s " (capitalize (match-string 1)) key)))) |
3559 | auth-info auth-passwd) | |
7540f029 MA |
3560 | (with-parsed-tramp-file-name key nil |
3561 | (prog1 | |
3562 | (or | |
7a6ebb1a MA |
3563 | ;; See if auth-sources contains something useful, if it's |
3564 | ;; bound. `auth-source-user-or-password' is an obsoleted | |
3565 | ;; function, it has been replaced by `auth-source-search'. | |
7540f029 MA |
3566 | (and (boundp 'auth-sources) |
3567 | (tramp-get-connection-property v "first-password-request" nil) | |
3568 | ;; Try with Tramp's current method. | |
563790b6 | 3569 | (if (fboundp 'auth-source-search) |
7a6ebb1a | 3570 | (setq auth-info |
2fb0a219 MA |
3571 | (tramp-compat-funcall |
3572 | 'auth-source-search | |
3573 | :max 1 | |
3574 | :user (or tramp-current-user t) | |
3575 | :host tramp-current-host | |
3576 | :port tramp-current-method) | |
3577 | auth-passwd (plist-get (nth 0 auth-info) :secret) | |
3578 | auth-passwd (if (functionp auth-passwd) | |
3579 | (funcall auth-passwd) | |
3580 | auth-passwd)) | |
563790b6 TZ |
3581 | (tramp-compat-funcall |
3582 | 'auth-source-user-or-password | |
3583 | "password" tramp-current-host tramp-current-method))) | |
7540f029 MA |
3584 | ;; Try the password cache. |
3585 | (when (functionp 'password-read) | |
3586 | (unless (tramp-get-connection-property | |
3587 | v "first-password-request" nil) | |
0d5852cf | 3588 | (tramp-compat-funcall 'password-cache-remove key)) |
7540f029 | 3589 | (let ((password |
0d5852cf MA |
3590 | (tramp-compat-funcall 'password-read pw-prompt key))) |
3591 | (tramp-compat-funcall 'password-cache-add key password) | |
7540f029 MA |
3592 | password)) |
3593 | ;; Else, get the password interactively. | |
3594 | (read-passwd pw-prompt)) | |
3595 | (tramp-set-connection-property v "first-password-request" nil))))) | |
00d6fd04 | 3596 | |
9c13938d MA |
3597 | (defun tramp-clear-passwd (vec) |
3598 | "Clear password cache for connection related to VEC." | |
0d5852cf MA |
3599 | (tramp-compat-funcall |
3600 | 'password-cache-remove | |
3601 | (tramp-make-tramp-file-name | |
3602 | (tramp-file-name-method vec) | |
3603 | (tramp-file-name-user vec) | |
3604 | (tramp-file-name-host vec) | |
3605 | ""))) | |
00d6fd04 MA |
3606 | |
3607 | ;; Snarfed code from time-date.el and parse-time.el | |
3608 | ||
3609 | (defconst tramp-half-a-year '(241 17024) | |
3610 | "Evaluated by \"(days-to-time 183)\".") | |
3611 | ||
3612 | (defconst tramp-parse-time-months | |
3613 | '(("jan" . 1) ("feb" . 2) ("mar" . 3) | |
3614 | ("apr" . 4) ("may" . 5) ("jun" . 6) | |
3615 | ("jul" . 7) ("aug" . 8) ("sep" . 9) | |
3616 | ("oct" . 10) ("nov" . 11) ("dec" . 12)) | |
3617 | "Alist mapping month names to integers.") | |
3618 | ||
3619 | (defun tramp-time-less-p (t1 t2) | |
3620 | "Say whether time value T1 is less than time value T2." | |
3621 | (unless t1 (setq t1 '(0 0))) | |
3622 | (unless t2 (setq t2 '(0 0))) | |
3623 | (or (< (car t1) (car t2)) | |
3624 | (and (= (car t1) (car t2)) | |
3625 | (< (nth 1 t1) (nth 1 t2))))) | |
3626 | ||
3627 | (defun tramp-time-subtract (t1 t2) | |
3628 | "Subtract two time values. | |
3629 | Return the difference in the format of a time value." | |
3630 | (unless t1 (setq t1 '(0 0))) | |
3631 | (unless t2 (setq t2 '(0 0))) | |
3632 | (let ((borrow (< (cadr t1) (cadr t2)))) | |
3633 | (list (- (car t1) (car t2) (if borrow 1 0)) | |
3634 | (- (+ (if borrow 65536 0) (cadr t1)) (cadr t2))))) | |
fb7933a3 KG |
3635 | |
3636 | (defun tramp-time-diff (t1 t2) | |
3637 | "Return the difference between the two times, in seconds. | |
1a762140 | 3638 | T1 and T2 are time values (as returned by `current-time' for example)." |
ea9d1443 KG |
3639 | (cond ((and (fboundp 'subtract-time) |
3640 | (fboundp 'float-time)) | |
0d5852cf MA |
3641 | (tramp-compat-funcall |
3642 | 'float-time (tramp-compat-funcall 'subtract-time t1 t2))) | |
ea9d1443 KG |
3643 | ((and (fboundp 'subtract-time) |
3644 | (fboundp 'time-to-seconds)) | |
0d5852cf MA |
3645 | (tramp-compat-funcall |
3646 | 'time-to-seconds (tramp-compat-funcall 'subtract-time t1 t2))) | |
fb7933a3 | 3647 | ((fboundp 'itimer-time-difference) |
0d5852cf MA |
3648 | (tramp-compat-funcall |
3649 | 'itimer-time-difference | |
3650 | (if (< (length t1) 3) (append t1 '(0)) t1) | |
3651 | (if (< (length t2) 3) (append t2 '(0)) t2))) | |
fb7933a3 | 3652 | (t |
00d6fd04 | 3653 | (let ((time (tramp-time-subtract t1 t2))) |
ea9d1443 KG |
3654 | (+ (* (car time) 65536.0) |
3655 | (cadr time) | |
3656 | (/ (or (nth 2 time) 0) 1000000.0)))))) | |
fb7933a3 | 3657 | |
fb7933a3 KG |
3658 | ;; Currently (as of Emacs 20.5), the function `shell-quote-argument' |
3659 | ;; does not deal well with newline characters. Newline is replaced by | |
3660 | ;; backslash newline. But if, say, the string `a backslash newline b' | |
3661 | ;; is passed to a shell, the shell will expand this into "ab", | |
3662 | ;; completely omitting the newline. This is not what was intended. | |
3663 | ;; It does not appear to be possible to make the function | |
3664 | ;; `shell-quote-argument' work with newlines without making it | |
3665 | ;; dependent on the shell used. But within this package, we know that | |
3666 | ;; we will always use a Bourne-like shell, so we use an approach which | |
3667 | ;; groks newlines. | |
3668 | ;; | |
3669 | ;; The approach is simple: we call `shell-quote-argument', then | |
3670 | ;; massage the newline part of the result. | |
3671 | ;; | |
3672 | ;; This function should produce a string which is grokked by a Unix | |
3673 | ;; shell, even if the Emacs is running on Windows. Since this is the | |
3674 | ;; kludges section, we bind `system-type' in such a way that | |
3675 | ;; `shell-quote-arguments' behaves as if on Unix. | |
3676 | ;; | |
3677 | ;; Thanks to Mario DeWeerd for the hint that it is sufficient for this | |
3678 | ;; function to work with Bourne-like shells. | |
3679 | ;; | |
3680 | ;; CCC: This function should be rewritten so that | |
3681 | ;; `shell-quote-argument' is not used. This way, we are safe from | |
3682 | ;; changes in `shell-quote-argument'. | |
0f34aa77 | 3683 | ;;;###tramp-autoload |
fb7933a3 KG |
3684 | (defun tramp-shell-quote-argument (s) |
3685 | "Similar to `shell-quote-argument', but groks newlines. | |
3686 | Only works for Bourne-like shells." | |
3687 | (let ((system-type 'not-windows)) | |
3688 | (save-match-data | |
3689 | (let ((result (shell-quote-argument s)) | |
3690 | (nl (regexp-quote (format "\\%s" tramp-rsh-end-of-line)))) | |
3691 | (when (and (>= (length result) 2) | |
3692 | (string= (substring result 0 2) "\\~")) | |
3693 | (setq result (substring result 1))) | |
3694 | (while (string-match nl result) | |
3695 | (setq result (replace-match (format "'%s'" tramp-rsh-end-of-line) | |
3696 | t t result))) | |
3697 | result)))) | |
3698 | ||
a69c01a0 MA |
3699 | ;; Checklist for `tramp-unload-hook' |
3700 | ;; - Unload all `tramp-*' packages | |
3701 | ;; - Reset `file-name-handler-alist' | |
3702 | ;; - Cleanup hooks where Tramp functions are in | |
3703 | ;; - Cleanup advised functions | |
3704 | ;; - Cleanup autoloads | |
3705 | ;;;###autoload | |
3706 | (defun tramp-unload-tramp () | |
08b1eb21 | 3707 | "Discard Tramp from loading remote files." |
a69c01a0 | 3708 | (interactive) |
a69c01a0 | 3709 | ;; ange-ftp settings must be enabled. |
0d5852cf | 3710 | (tramp-compat-funcall 'tramp-ftp-enable-ange-ftp) |
0f34aa77 | 3711 | ;; Maybe it's not loaded yet. |
03c1ad43 | 3712 | (ignore-errors (unload-feature 'tramp 'force))) |
ccb4a481 | 3713 | |
fb7933a3 KG |
3714 | (provide 'tramp) |
3715 | ||
fb7933a3 KG |
3716 | ;;; TODO: |
3717 | ||
fb7933a3 | 3718 | ;; * Rewrite `tramp-shell-quote-argument' to abstain from using |
b1d06e75 | 3719 | ;; `shell-quote-argument'. |
fb7933a3 KG |
3720 | ;; * In Emacs 21, `insert-directory' shows total number of bytes used |
3721 | ;; by the files in that directory. Add this here. | |
3722 | ;; * Avoid screen blanking when hitting `g' in dired. (Eli Tziperman) | |
3723 | ;; * Make ffap.el grok Tramp filenames. (Eli Tziperman) | |
fb7933a3 | 3724 | ;; * abbreviate-file-name |
8e754ea2 | 3725 | ;; * Better error checking. At least whenever we see something |
fb7933a3 KG |
3726 | ;; strange when doing zerop, we should kill the process and start |
3727 | ;; again. (Greg Stark) | |
3cdaec13 | 3728 | ;; * Username and hostname completion. |
6c4e47fa | 3729 | ;; ** Try to avoid usage of `last-input-event' in `tramp-completion-mode-p'. |
8daea7fc | 3730 | ;; ** Unify `tramp-parse-{rhosts,shosts,sconfig,hosts,passwd,netrc}'. |
16674e4f | 3731 | ;; Code is nearly identical. |
00d6fd04 | 3732 | ;; * Make `tramp-default-user' obsolete. |
3e2fa353 MA |
3733 | ;; * Implement a general server-local-variable mechanism, as there are |
3734 | ;; probably other variables that need different values for different | |
3735 | ;; servers too. The user could then configure a variable (such as | |
3736 | ;; tramp-server-local-variable-alist) to define any such variables | |
3737 | ;; that they need to, which would then be let bound as appropriate | |
6e4f5731 | 3738 | ;; in tramp functions. (Jason Rumney) |
7e5686f0 MA |
3739 | ;; * IMHO, it's a drawback that currently Tramp doesn't support |
3740 | ;; Unicode in Dired file names by default. Is it possible to | |
3741 | ;; improve Tramp to set LC_ALL to "C" only for commands where Tramp | |
3742 | ;; expects English? Or just to set LC_MESSAGES to "C" if Tramp | |
6e4f5731 | 3743 | ;; expects only English messages? (Juri Linkov) |
7e5686f0 | 3744 | ;; * Make shadowfile.el grok Tramp filenames. (Bug#4526, Bug#4846) |
44ffae96 MA |
3745 | ;; * I was wondering it it would be possible to use tramp even if I'm |
3746 | ;; actually using sshfs. But when I launch a command I would like | |
3747 | ;; to get it executed on the remote machine where the files really | |
3748 | ;; are. (Andrea Crotti) | |
3749 | ;; * Run emerge on two remote files. Bug is described here: | |
3750 | ;; <http://www.mail-archive.com/tramp-devel@nongnu.org/msg01041.html>. | |
3751 | ;; (Bug#6850) | |
fb7933a3 KG |
3752 | |
3753 | ;; Functions for file-name-handler-alist: | |
3754 | ;; diff-latest-backup-file -- in diff.el | |
fb7933a3 KG |
3755 | |
3756 | ;;; tramp.el ends here | |
57671b72 MA |
3757 | |
3758 | ;; Local Variables: | |
3759 | ;; mode: Emacs-Lisp | |
3760 | ;; coding: utf-8 | |
3761 | ;; End: |