Commit | Line | Data |
---|---|---|
8749abea GM |
1 | ;;; ange-ftp.el --- transparent FTP support for GNU Emacs |
2 | ||
95df8112 | 3 | ;; Copyright (C) 1989-1996, 1998, 2000-2011 Free Software Foundation, Inc. |
8749abea GM |
4 | |
5 | ;; Author: Andy Norman (ange@hplb.hpl.hp.com) | |
6 | ;; Maintainer: FSF | |
7 | ;; Keywords: comm | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
874a927a | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
8749abea | 12 | ;; it under the terms of the GNU General Public License as published by |
874a927a GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
8749abea GM |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
874a927a | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
8749abea GM |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; This package attempts to make accessing files and directories using FTP | |
27 | ;; from within GNU Emacs as simple and transparent as possible. A subset of | |
28 | ;; the common file-handling routines are extended to interact with FTP. | |
29 | ||
30 | ;; Usage: | |
31 | ;; | |
32 | ;; Some of the common GNU Emacs file-handling operations have been made | |
33 | ;; FTP-smart. If one of these routines is given a filename that matches | |
34 | ;; '/user@host:name' then it will spawn an FTP process connecting to machine | |
35 | ;; 'host' as account 'user' and perform its operation on the file 'name'. | |
36 | ;; | |
37 | ;; For example: if find-file is given a filename of: | |
38 | ;; | |
39 | ;; /ange@anorman:/tmp/notes | |
40 | ;; | |
41 | ;; then ange-ftp spawns an FTP process, connect to the host 'anorman' as | |
42 | ;; user 'ange', get the file '/tmp/notes' and pop up a buffer containing the | |
43 | ;; contents of that file as if it were on the local filesystem. If ange-ftp | |
44 | ;; needs a password to connect then it reads one in the echo area. | |
45 | ||
46 | ;; Extended filename syntax: | |
47 | ;; | |
48 | ;; The default extended filename syntax is '/user@host:name', where the | |
49 | ;; 'user@' part may be omitted. This syntax can be customised to a certain | |
50 | ;; extent by changing ange-ftp-name-format. There are limitations. | |
51 | ;; The `host' part has an optional suffix `#port' which may be used to | |
52 | ;; specify a non-default port number for the connexion. | |
53 | ;; | |
54 | ;; If the user part is omitted then ange-ftp generates a default user | |
55 | ;; instead whose value depends on the variable ange-ftp-default-user. | |
56 | ||
57 | ;; Passwords: | |
58 | ;; | |
59 | ;; A password is required for each host/user pair. Ange-ftp reads passwords | |
60 | ;; as needed. You can also specify a password with ange-ftp-set-passwd, or | |
61 | ;; in a *valid* ~/.netrc file. | |
62 | ||
63 | ;; Passwords for user "anonymous": | |
64 | ;; | |
65 | ;; Passwords for the user "anonymous" (or "ftp") are handled | |
66 | ;; specially. The variable `ange-ftp-generate-anonymous-password' | |
67 | ;; controls what happens: if the value of this variable is a string, | |
68 | ;; then this is used as the password; if non-nil (the default), then | |
69 | ;; the value of `user-mail-address' is used; if nil then the user | |
70 | ;; is prompted for a password as normal. | |
71 | ||
72 | ;; "Dumb" UNIX hosts: | |
73 | ;; | |
74 | ;; The FTP servers on some UNIX machines have problems if the 'ls' command is | |
75 | ;; used. | |
76 | ;; | |
77 | ;; The routine ange-ftp-add-dumb-unix-host can be called to tell ange-ftp to | |
78 | ;; limit itself to the DIR command and not 'ls' for a given UNIX host. Note | |
79 | ;; that this change will take effect for the current GNU Emacs session only. | |
80 | ;; See below for a discussion of non-UNIX hosts. If a large number of | |
81 | ;; machines with similar hostnames have this problem then it is easier to set | |
82 | ;; the value of ange-ftp-dumb-unix-host-regexp in your .emacs file. ange-ftp | |
83 | ;; is unable to automatically recognize dumb unix hosts. | |
84 | ||
85 | ;; File name completion: | |
86 | ;; | |
87 | ;; Full file-name completion is supported on UNIX, VMS, CMS, and MTS hosts. | |
88 | ;; To do filename completion, ange-ftp needs a listing from the remote host. | |
89 | ;; Therefore, for very slow connections, it might not save any time. | |
90 | ||
91 | ;; FTP processes: | |
92 | ;; | |
93 | ;; When ange-ftp starts up an FTP process, it leaves it running for speed | |
94 | ;; purposes. Some FTP servers will close the connection after a period of | |
95 | ;; time, but ange-ftp should be able to quietly reconnect the next time that | |
96 | ;; the process is needed. | |
97 | ;; | |
98 | ;; Killing the "*ftp user@host*" buffer also kills the ftp process. | |
99 | ;; This should not cause ange-ftp any grief. | |
100 | ||
101 | ;; Binary file transfers: | |
102 | ;; | |
103 | ;; By default ange-ftp transfers files in ASCII mode. If a file being | |
104 | ;; transferred matches the value of ange-ftp-binary-file-name-regexp then | |
105 | ;; binary mode is used for that transfer. | |
106 | ||
107 | ;; Account passwords: | |
108 | ;; | |
109 | ;; Some FTP servers require an additional password which is sent by the | |
110 | ;; ACCOUNT command. ange-ftp partially supports this by allowing the user to | |
111 | ;; specify an account password by either calling ange-ftp-set-account, or by | |
112 | ;; specifying an account token in the .netrc file. If the account password | |
113 | ;; is set by either of these methods then ange-ftp will issue an ACCOUNT | |
114 | ;; command upon starting the FTP process. | |
115 | ||
116 | ;; Preloading: | |
117 | ;; | |
118 | ;; ange-ftp can be preloaded, but must be put in the site-init.el file and | |
119 | ;; not the site-load.el file in order for the documentation strings for the | |
120 | ;; functions being overloaded to be available. | |
121 | ||
122 | ;; Status reports: | |
123 | ;; | |
124 | ;; Most ange-ftp commands that talk to the FTP process output a status | |
125 | ;; message on what they are doing. In addition, ange-ftp can take advantage | |
126 | ;; of the FTP client's HASH command to display the status of transferring | |
127 | ;; files and listing directories. See the documentation for the variables | |
128 | ;; ange-ftp-{ascii,binary}-hash-mark-size, ange-ftp-send-hash and | |
129 | ;; ange-ftp-process-verbose for more details. | |
130 | ||
131 | ;; Gateways: | |
132 | ;; | |
133 | ;; Sometimes it is necessary for the FTP process to be run on a different | |
134 | ;; machine than the machine running GNU Emacs. This can happen when the | |
135 | ;; local machine has restrictions on what hosts it can access. | |
136 | ;; | |
137 | ;; ange-ftp has support for running the ftp process on a different (gateway) | |
138 | ;; machine. The way it works is as follows: | |
139 | ;; | |
140 | ;; 1) Set the variable 'ange-ftp-gateway-host' to the name of a machine | |
141 | ;; that doesn't have the access restrictions. | |
142 | ;; | |
143 | ;; 2) Set the variable 'ange-ftp-local-host-regexp' to a regular expression | |
144 | ;; that matches hosts that can be contacted from running a local ftp | |
145 | ;; process, but fails to match hosts that can't be accessed locally. For | |
146 | ;; example: | |
147 | ;; | |
148 | ;; "\\.hp\\.com$\\|^[^.]*$" | |
149 | ;; | |
150 | ;; will match all hosts that are in the .hp.com domain, or don't have an | |
151 | ;; explicit domain in their name, but will fail to match hosts with | |
152 | ;; explicit domains or that are specified by their ip address. | |
153 | ;; | |
154 | ;; 3) Using NFS and symlinks, make sure that there is a shared directory with | |
155 | ;; the *same* name between the local machine and the gateway machine. | |
156 | ;; This directory is necessary for temporary files created by ange-ftp. | |
157 | ;; | |
158 | ;; 4) Set the variable 'ange-ftp-gateway-tmp-name-template' to the name of | |
159 | ;; this directory plus an identifying filename prefix. For example: | |
160 | ;; | |
161 | ;; "/nfs/hplose/ange/ange-ftp" | |
162 | ;; | |
163 | ;; where /nfs/hplose/ange is a directory that is shared between the | |
164 | ;; gateway machine and the local machine. | |
165 | ;; | |
166 | ;; The simplest way of getting a ftp process running on the gateway machine | |
167 | ;; is if you can spawn a remote shell using either 'rsh' or 'remsh'. If you | |
168 | ;; can't do this for some reason such as security then points 7 onwards will | |
169 | ;; discuss an alternative approach. | |
170 | ;; | |
171 | ;; 5) Set the variable ange-ftp-gateway-program to the name of the remote | |
172 | ;; shell process such as 'remsh' or 'rsh' if the default isn't correct. | |
173 | ;; | |
174 | ;; 6) Set the variable ange-ftp-gateway-program-interactive to nil if it | |
175 | ;; isn't already. This tells ange-ftp that you are using a remote shell | |
176 | ;; rather than logging in using telnet or rlogin. | |
177 | ;; | |
178 | ;; That should be all you need to allow ange-ftp to spawn a ftp process on | |
179 | ;; the gateway machine. If you have to use telnet or rlogin to get to the | |
180 | ;; gateway machine then follow the instructions below. | |
181 | ;; | |
182 | ;; 7) Set the variable ange-ftp-gateway-program to the name of the program | |
183 | ;; that lets you log onto the gateway machine. This may be something like | |
184 | ;; telnet or rlogin. | |
185 | ;; | |
186 | ;; 8) Set the variable ange-ftp-gateway-prompt-pattern to a regular | |
187 | ;; expression that matches the prompt you get when you login to the | |
188 | ;; gateway machine. Be very specific here; this regexp must not match | |
189 | ;; *anything* in your login banner except this prompt. | |
190 | ;; shell-prompt-pattern is far too general as it appears to match some | |
191 | ;; login banners from Sun machines. For example: | |
192 | ;; | |
193 | ;; "^$*$ *" | |
194 | ;; | |
195 | ;; 9) Set the variable ange-ftp-gateway-program-interactive to 't' to let | |
196 | ;; ange-ftp know that it has to "hand-hold" the login to the gateway | |
197 | ;; machine. | |
198 | ;; | |
199 | ;; 10) Set the variable ange-ftp-gateway-setup-term-command to a UNIX command | |
200 | ;; that will put the pty connected to the gateway machine into a | |
201 | ;; no-echoing mode, and will strip off carriage-returns from output from | |
202 | ;; the gateway machine. For example: | |
203 | ;; | |
204 | ;; "stty -onlcr -echo" | |
205 | ;; | |
206 | ;; will work on HP-UX machines, whereas: | |
207 | ;; | |
208 | ;; "stty -echo nl" | |
209 | ;; | |
210 | ;; appears to work for some Sun machines. | |
211 | ;; | |
212 | ;; That's all there is to it. | |
213 | ||
214 | ;; Smart gateways: | |
215 | ;; | |
216 | ;; If you have a "smart" ftp program that allows you to issue commands like | |
217 | ;; "USER foo@bar" which do nice proxy things, then look at the variables | |
218 | ;; ange-ftp-smart-gateway and ange-ftp-smart-gateway-port. | |
219 | ;; | |
220 | ;; Otherwise, if there is an alternate ftp program that implements proxy in | |
221 | ;; a transparent way (i.e. w/o specifying the proxy host), that will | |
222 | ;; connect you directly to the desired destination host: | |
223 | ;; Set ange-ftp-gateway-ftp-program-name to that program's name. | |
224 | ;; Set ange-ftp-local-host-regexp to a value as stated earlier on. | |
225 | ;; Leave ange-ftp-gateway-host set to nil. | |
226 | ;; Set ange-ftp-smart-gateway to t. | |
227 | ||
228 | ;; Tips for using ange-ftp: | |
229 | ;; | |
230 | ;; 1. For dired to work on a host which marks symlinks with a trailing @ in | |
231 | ;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t). | |
232 | ;; Most UNIX systems do not do this, but ULTRIX does. If you think that | |
233 | ;; there is a chance you might connect to an ULTRIX machine (such as | |
234 | ;; prep.ai.mit.edu), then set this variable accordingly. This will have | |
235 | ;; the side effect that dired will have problems with symlinks whose names | |
236 | ;; end in an @. If you get yourself into this situation then editing | |
237 | ;; dired's ls-switches to remove "F", will temporarily fix things. | |
238 | ;; | |
239 | ;; 2. If you know that you are connecting to a certain non-UNIX machine | |
240 | ;; frequently, and ange-ftp seems to be unable to guess its host-type, | |
241 | ;; then setting the appropriate host-type regexp | |
242 | ;; (ange-ftp-vms-host-regexp, ange-ftp-mts-host-regexp, or | |
243 | ;; ange-ftp-cms-host-regexp) accordingly should help. Also, please report | |
244 | ;; ange-ftp's inability to recognize the host-type as a bug. | |
245 | ;; | |
246 | ;; 3. For slow connections, you might get "listing unreadable" error | |
247 | ;; messages, or get an empty buffer for a file that you know has something | |
248 | ;; in it. The solution is to increase the value of ange-ftp-retry-time. | |
249 | ;; Its default value is 5 which is plenty for reasonable connections. | |
250 | ;; However, for some transatlantic connections I set this to 20. | |
251 | ;; | |
252 | ;; 4. Beware of compressing files on non-UNIX hosts. Ange-ftp will do it by | |
253 | ;; copying the file to the local machine, compressing it there, and then | |
254 | ;; sending it back. Binary file transfers between machines of different | |
255 | ;; architectures can be a risky business. Test things out first on some | |
256 | ;; test files. See "Bugs" below. Also, note that ange-ftp copies files by | |
257 | ;; moving them through the local machine. Again, be careful when doing | |
258 | ;; this with binary files on non-Unix machines. | |
259 | ;; | |
260 | ;; 5. Beware that dired over ftp will use your setting of dired-no-confirm | |
261 | ;; (list of dired commands for which confirmation is not asked). You | |
262 | ;; might want to reconsider your setting of this variable, because you | |
263 | ;; might want confirmation for more commands on remote direds than on | |
264 | ;; local direds. For example, I strongly recommend that you not include | |
265 | ;; compress and uncompress in this list. If there is enough demand it | |
266 | ;; might be a good idea to have an alist ange-ftp-dired-no-confirm of | |
267 | ;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST | |
268 | ;; is a list of commands for which confirmation would be suppressed. Then | |
269 | ;; remote dired listings would take their (buffer-local) value of | |
270 | ;; dired-no-confirm from this alist. Who votes for this? | |
271 | ||
272 | ;; --------------------------------------------------------------------- | |
273 | ;; Non-UNIX support: | |
274 | ;; --------------------------------------------------------------------- | |
275 | ||
276 | ;; VMS support: | |
277 | ;; | |
278 | ;; Ange-ftp has full support for VMS hosts. It | |
279 | ;; should be able to automatically recognize any VMS machine. However, if it | |
280 | ;; fails to do this, you can use the command ange-ftp-add-vms-host. As well, | |
281 | ;; you can set the variable ange-ftp-vms-host-regexp in your .emacs file. We | |
282 | ;; would be grateful if you would report any failures to automatically | |
283 | ;; recognize a VMS host as a bug. | |
284 | ;; | |
285 | ;; Filename Syntax: | |
286 | ;; | |
287 | ;; For ease of *implementation*, the user enters the VMS filename syntax in a | |
288 | ;; UNIX-y way. For example: | |
289 | ;; PUB$:[ANONYMOUS.SDSCPUB.NEXT]README.TXT;1 | |
290 | ;; would be entered as: | |
291 | ;; /PUB$$:/ANONYMOUS/SDSCPUB/NEXT/README.TXT;1 | |
292 | ;; i.e. to log in as anonymous on ymir.claremont.edu and grab the file: | |
293 | ;; [.CSV.POLICY]RULES.MEM | |
294 | ;; you would type: | |
295 | ;; C-x C-f /anonymous@ymir.claremont.edu:CSV/POLICY/RULES.MEM | |
296 | ;; | |
0138efd4 | 297 | ;; A valid VMS filename is of the form: FILE.TYPE;## |
8749abea GM |
298 | ;; where FILE can be up to 39 characters |
299 | ;; TYPE can be up to 39 characters | |
300 | ;; ## is a version number (an integer between 1 and 32,767) | |
301 | ;; Valid characters in FILE and TYPE are A-Z 0-9 _ - $ | |
302 | ;; $ cannot begin a filename, and - cannot be used as the first or last | |
303 | ;; character. | |
304 | ;; | |
305 | ;; Tips: | |
306 | ;; 1. Although VMS is not case sensitive, EMACS running under UNIX is. | |
307 | ;; Therefore, to access a VMS file, you must enter the filename with upper | |
308 | ;; case letters. | |
309 | ;; 2. To access the latest version of file under VMS, you use the filename | |
310 | ;; without the ";" and version number. You should always edit the latest | |
311 | ;; version of a file. If you want to edit an earlier version, copy it to a | |
312 | ;; new file first. This has nothing to do with ange-ftp, but is simply | |
313 | ;; good VMS operating practice. Therefore, to edit FILE.TXT;3 (say 3 is | |
314 | ;; latest version), do C-x C-f /ymir.claremont.edu:FILE.TXT. If you | |
315 | ;; inadvertently do C-x C-f /ymir.claremont.edu:FILE.TXT;3, you will find | |
316 | ;; that VMS will not allow you to save the file because it will refuse to | |
317 | ;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and | |
318 | ;; attach the buffer to this file. To get out of this situation, M-x | |
319 | ;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to | |
320 | ;; latest version of the file. For this reason, in dired "f" | |
321 | ;; (dired-find-file), always loads the file sans version, whereas "v", | |
322 | ;; (dired-view-file), always loads the explicit version number. The | |
323 | ;; reasoning being that it reasonable to view old versions of a file, but | |
324 | ;; not to edit them. | |
325 | ;; 3. EMACS has a feature in which it does environment variable substitution | |
326 | ;; in filenames. Therefore, to enter a $ in a filename, you must quote it | |
327 | ;; by typing $$. | |
328 | ||
329 | ;; MTS support: | |
330 | ;; | |
331 | ;; Ange-ftp has full support for hosts running | |
332 | ;; the Michigan terminal system. It should be able to automatically | |
333 | ;; recognize any MTS machine. However, if it fails to do this, you can use | |
334 | ;; the command ange-ftp-add-mts-host. As well, you can set the variable | |
335 | ;; ange-ftp-mts-host-regexp in your .emacs file. We would be grateful if you | |
336 | ;; would report any failures to automatically recognize a MTS host as a bug. | |
337 | ;; | |
338 | ;; Filename syntax: | |
25759a92 | 339 | ;; |
8749abea GM |
340 | ;; MTS filenames are entered in a UNIX-y way. For example, if your account |
341 | ;; was YYYY, the file FILE in the account XXXX: on mtsg.ubc.ca would be | |
342 | ;; entered as | |
343 | ;; /YYYY@mtsg.ubc.ca:/XXXX:/FILE | |
344 | ;; In other words, MTS accounts are treated as UNIX directories. Of course, | |
345 | ;; to access a file in another account, you must have access permission for | |
346 | ;; it. If FILE were in your own account, then you could enter it in a | |
347 | ;; relative name fashion as | |
348 | ;; /YYYY@mtsg.ubc.ca:FILE | |
349 | ;; MTS filenames can be up to 12 characters. Like UNIX, the structure of the | |
350 | ;; filename does not contain a TYPE (i.e. it can have as many "."'s as you | |
351 | ;; like.) MTS filenames are always in upper case, and hence be sure to enter | |
352 | ;; them as such! MTS is not case sensitive, but an EMACS running under UNIX | |
353 | ;; is. | |
354 | ||
355 | ;; CMS support: | |
25759a92 | 356 | ;; |
8749abea GM |
357 | ;; Ange-ftp has full support for hosts running |
358 | ;; CMS. It should be able to automatically recognize any CMS machine. | |
359 | ;; However, if it fails to do this, you can use the command | |
360 | ;; ange-ftp-add-cms-host. As well, you can set the variable | |
361 | ;; ange-ftp-cms-host-regexp in your .emacs file. We would be grateful if you | |
362 | ;; would report any failures to automatically recognize a CMS host as a bug. | |
25759a92 | 363 | ;; |
8749abea GM |
364 | ;; Filename syntax: |
365 | ;; | |
366 | ;; CMS filenames are entered in a UNIX-y way. In otherwords, minidisks are | |
367 | ;; treated as UNIX directories. For example to access the file READ.ME in | |
368 | ;; minidisk *.311 on cuvmb.cc.columbia.edu, you would enter | |
369 | ;; /anonymous@cuvmb.cc.columbia.edu:/*.311/READ.ME | |
370 | ;; If *.301 is the default minidisk for this account, you could access | |
371 | ;; FOO.BAR on this minidisk as | |
372 | ;; /anonymous@cuvmb.cc.columbia.edu:FOO.BAR | |
373 | ;; CMS filenames are of the form FILE.TYPE, where both FILE and TYPE can be | |
374 | ;; up to 8 characters. Again, beware that CMS filenames are always upper | |
375 | ;; case, and hence must be entered as such. | |
376 | ;; | |
377 | ;; Tips: | |
378 | ;; 1. CMS machines, with the exception of anonymous accounts, nearly always | |
379 | ;; need an account password. To have ange-ftp send an account password, | |
380 | ;; you can either include it in your .netrc file, or use | |
381 | ;; ange-ftp-set-account. | |
382 | ;; 2. Ange-ftp cannot send "write passwords" for a minidisk. Hopefully, we | |
383 | ;; can fix this. | |
384 | ;; | |
9c35d706 RS |
385 | ;; BS2000 support: |
386 | ;; | |
387 | ;; Ange-ftp has full support for BS2000 hosts. It should be able to | |
388 | ;; automatically recognize any BS2000 machine. However, if it fails to | |
389 | ;; do this, you can use the command ange-ftp-add-bs2000-host. As well, | |
390 | ;; you can set the variable ange-ftp-bs2000-host-regexp in your .emacs | |
391 | ;; file. We would be grateful if you would report any failures to auto- | |
392 | ;; matically recognize a BS2000 host as a bug. | |
393 | ;; | |
394 | ;; If you want to access the POSIX subsystem on BS2000 you MUST use | |
395 | ;; command ange-ftp-add-bs2000-posix-host for that particular | |
396 | ;; hostname. ange-ftp can't decide if you want to access the native | |
397 | ;; filesystem or the POSIX filesystem, so it accesses the native | |
398 | ;; filesystem by default. And if you have an ASCII filesystem in | |
399 | ;; your BS2000 POSIX subsystem you must use | |
400 | ;; ange-ftp-binary-file-name-regexp to access its files. | |
401 | ;; | |
402 | ;; Filename Syntax: | |
403 | ;; | |
404 | ;; For ease of *implementation*, the user enters the BS2000 filename | |
405 | ;; syntax in a UNIX-y way. For example: | |
406 | ;; :PUB:$PUBLIC.ANONYMOUS.SDSCPUB.NEXT.README.TXT | |
407 | ;; would be entered as: | |
408 | ;; /:PUB:/$$PUBLIC/ANONYMOUS.SDSCPUB.NEXT.README.TXT | |
4671dba5 | 409 | ;; You don't have to type pubset and account, if they have default values, |
9c35d706 RS |
410 | ;; i.e. to log in as anonymous on bs2000.anywhere.com and grab the file |
411 | ;; IMPORTANT.TEXT.ON.BS2000 on the default pubset X on userid PUBLIC | |
412 | ;; (there are only 8 characters in a valid username), you could type: | |
413 | ;; C-x C-f /public@bs2000.anywhere.com:/IMPORTANT.TEXT.ON.BS2000 | |
414 | ;; or | |
415 | ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/$$PUBLIC/IMPORTANT.TEXT.ON.BS2000 | |
416 | ;; | |
417 | ;; If X is not your default pubset, you could add it as 'subdirectory' (BS2000 | |
418 | ;; has a flat architecture) with the command | |
419 | ;; (setq ange-ftp-bs2000-additional-pubsets '(":X:")) | |
420 | ;; and then you could type: | |
421 | ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/IMPORTANT.TEXT.ON.BS2000 | |
422 | ;; | |
423 | ;; Valid characters in an BS2000 filename are A-Z 0-9 $ # @ . - | |
424 | ;; If the first character in a filename is # or @, this is replaced with | |
425 | ;; ange-ftp-bs2000-special-prefix because names starting with # or @ | |
426 | ;; are reserved for temporary files. | |
427 | ;; This is especially important for auto-save files. | |
a1506d29 | 428 | ;; Valid file generations are ending with ([+|-|*]0-9...) . |
9c35d706 RS |
429 | ;; File generations are not supported yet! |
430 | ;; A filename must at least contain one character (A-Z) and cannot be longer | |
431 | ;; than 41 characters. | |
432 | ;; | |
433 | ;; Tips: | |
434 | ;; 1. Although BS2000 is not case sensitive, EMACS running under UNIX is. | |
435 | ;; Therefore, to access a BS2000 file, you must enter the filename with | |
436 | ;; upper case letters. | |
437 | ;; 2. EMACS has a feature in which it does environment variable substitution | |
438 | ;; in filenames. Therefore, to enter a $ in a filename, you must quote it | |
439 | ;; by typing $$. | |
440 | ;; 3. BS2000 machines, with the exception of anonymous accounts, nearly | |
441 | ;; always need an account password. To have ange-ftp send an account | |
442 | ;; password, you can either include it in your .netrc file, or use | |
443 | ;; ange-ftp-set-account. | |
444 | ;; | |
8749abea GM |
445 | ;; ------------------------------------------------------------------ |
446 | ;; Bugs: | |
447 | ;; ------------------------------------------------------------------ | |
25759a92 | 448 | ;; |
8749abea GM |
449 | ;; 1. Umask problems: |
450 | ;; Be warned that files created by using ange-ftp will take account of the | |
451 | ;; umask of the ftp daemon process rather than the umask of the creating | |
452 | ;; user. This is particularly important when logging in as the root user. | |
453 | ;; The way that I tighten up the ftp daemon's umask under HP-UX is to make | |
454 | ;; sure that the umask is changed to 027 before I spawn /etc/inetd. I | |
455 | ;; suspect that there is something similar on other systems. | |
456 | ;; | |
457 | ;; 2. Some combinations of FTP clients and servers break and get out of sync | |
458 | ;; when asked to list a non-existent directory. Some of the ai.mit.edu | |
459 | ;; machines cause this problem for some FTP clients. Using | |
460 | ;; ange-ftp-kill-ftp-process can restart the ftp process, which | |
461 | ;; should get things back in sync. | |
462 | ;; | |
463 | ;; 3. Ange-ftp does not check to make sure that when creating a new file, | |
464 | ;; you provide a valid filename for the remote operating system. | |
465 | ;; If you do not, then the remote FTP server will most likely | |
466 | ;; translate your filename in some way. This may cause ange-ftp to | |
467 | ;; get confused about what exactly is the name of the file. The | |
468 | ;; most common causes of this are using lower case filenames on systems | |
469 | ;; which support only upper case, and using filenames which are too | |
470 | ;; long. | |
471 | ;; | |
472 | ;; 4. Null (blank) passwords confuse both ange-ftp and some FTP daemons. | |
473 | ;; | |
474 | ;; 5. Ange-ftp likes to use pty's to talk to its FTP processes. If GNU Emacs | |
475 | ;; for some reason creates a FTP process that only talks via pipes then | |
476 | ;; ange-ftp won't be getting the information it requires at the time that | |
477 | ;; it wants it since pipes flush at different times to pty's. One | |
478 | ;; disgusting way around this problem is to talk to the FTP process via | |
479 | ;; rlogin which does the 'right' things with pty's. | |
480 | ;; | |
481 | ;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't | |
482 | ;; worried about this too much. Eventually, we should have some caching | |
483 | ;; of the current minidisk. | |
25759a92 | 484 | ;; |
8749abea GM |
485 | ;; 7. Some CMS machines do not assign a default minidisk when you ftp them as |
486 | ;; anonymous. It is then necessary to guess a valid minidisk name, and cd | |
487 | ;; to it. This is (understandably) beyond ange-ftp. | |
488 | ;; | |
489 | ;; 8. Remote to remote copying of files on non-Unix machines can be risky. | |
490 | ;; Depending on the variable ange-ftp-binary-file-name-regexp, ange-ftp | |
491 | ;; will use binary mode for the copy. Between systems of different | |
492 | ;; architecture, this still may not be enough to guarantee the integrity | |
493 | ;; of binary files. Binary file transfers from VMS machines are | |
494 | ;; particularly problematical. Should ange-ftp-binary-file-name-regexp be | |
495 | ;; an alist of OS type, regexp pairs? | |
496 | ;; | |
497 | ;; 9. The code to do compression of files over ftp is not as careful as it | |
498 | ;; should be. It deletes the old remote version of the file, before | |
499 | ;; actually checking if the local to remote transfer of the compressed | |
500 | ;; file succeeds. Of course to delete the original version of the file | |
501 | ;; after transferring the compressed version back is also dangerous, | |
502 | ;; because some OS's have severe restrictions on the length of filenames, | |
503 | ;; and when the compressed version is copied back the "-Z" or ".Z" may be | |
504 | ;; truncated. Then, ange-ftp would delete the only remaining version of | |
505 | ;; the file. Maybe ange-ftp should make backups when it compresses files | |
506 | ;; (of course, the backup "~" could also be truncated off, sigh...). | |
507 | ;; Suggestions? | |
508 | ;; | |
509 | ;; 10. If a dir listing is attempted for an empty directory on (at least | |
510 | ;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and | |
511 | ;; I don't know how to get ange-ftp work to around it. | |
512 | ;; | |
513 | ;; 11. Bombs on filenames that start with a space. Deals well with filenames | |
514 | ;; containing spaces, but beware that the remote ftpd may not like them | |
515 | ;; much. | |
516 | ;; | |
517 | ;; 12. The dired support for non-Unix-like systems does not currently work. | |
518 | ;; It needs to be reimplemented by modifying the parse-...-listing | |
519 | ;; functions to convert the directory listing to ls -l format. | |
25759a92 | 520 | ;; |
8749abea GM |
521 | ;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks |
522 | ;; with a trailing @ in a ls -alF listing. In order to account for this | |
523 | ;; ange-ftp looks to chop trailing @'s off of symlink names when it is | |
524 | ;; parsing a listing with the F switch. This will cause ange-ftp to | |
525 | ;; incorrectly get the name of a symlink on a non-ULTRIX host if its name | |
526 | ;; ends in an @. ange-ftp will correct itself if you take F out of the | |
527 | ;; dired ls switches (C-u s will allow you to edit the switches). The | |
528 | ;; dired buffer will be automatically reverted, which will allow ange-ftp | |
529 | ;; to fix its files hashtable. A cookie to anyone who can think of a | |
530 | ;; fast, sure-fire way to recognize ULTRIX over ftp. | |
531 | ||
532 | ;; If you find any bugs or problems with this package, PLEASE either e-mail | |
533 | ;; the above author, or send a message to the ange-ftp-lovers mailing list | |
534 | ;; below. Ideas and constructive comments are especially welcome. | |
535 | ||
536 | ;; ange-ftp-lovers: | |
537 | ;; | |
538 | ;; ange-ftp has its own mailing list modestly called ange-ftp-lovers. All | |
539 | ;; users of ange-ftp are welcome to subscribe (see below) and to discuss | |
540 | ;; aspects of ange-ftp. New versions of ange-ftp are posted periodically to | |
541 | ;; the mailing list. | |
542 | ||
8749abea GM |
543 | ;; To [un]subscribe to ange-ftp-lovers, or to report mailer problems with the |
544 | ;; list, please mail one of the following addresses: | |
545 | ;; | |
0101f7e1 | 546 | ;; ange-ftp-lovers-request@hplb.hpl.hp.com |
8749abea GM |
547 | ;; |
548 | ;; Please don't forget the -request part. | |
549 | ;; | |
550 | ;; For mail to be posted directly to ange-ftp-lovers, send to one of the | |
551 | ;; following addresses: | |
25759a92 | 552 | ;; |
0101f7e1 | 553 | ;; ange-ftp-lovers@hplb.hpl.hp.com |
8749abea GM |
554 | ;; |
555 | ;; Alternatively, there is a mailing list that only gets announcements of new | |
556 | ;; ange-ftp releases. This is called ange-ftp-lovers-announce, and can be | |
557 | ;; subscribed to by e-mailing to the -request address as above. Please make | |
558 | ;; it clear in the request which mailing list you wish to join. | |
8749abea GM |
559 | \f |
560 | ;; ----------------------------------------------------------- | |
561 | ;; Technical information on this package: | |
562 | ;; ----------------------------------------------------------- | |
563 | ||
564 | ;; ange-ftp works by putting a handler on file-name-handler-alist | |
565 | ;; which is called by many primitives, and a few non-primitives, | |
566 | ;; whenever they see a file name of the appropriate sort. | |
567 | ||
568 | ;; Checklist for adding non-UNIX support for TYPE | |
25759a92 | 569 | ;; |
8749abea GM |
570 | ;; The following functions may need TYPE versions: |
571 | ;; (not all functions will be needed for every OS) | |
572 | ;; | |
573 | ;; ange-ftp-fix-name-for-TYPE | |
574 | ;; ange-ftp-fix-dir-name-for-TYPE | |
575 | ;; ange-ftp-TYPE-host | |
576 | ;; ange-ftp-TYPE-add-host | |
577 | ;; ange-ftp-parse-TYPE-listing | |
578 | ;; ange-ftp-TYPE-delete-file-entry | |
579 | ;; ange-ftp-TYPE-add-file-entry | |
580 | ;; ange-ftp-TYPE-file-name-as-directory | |
581 | ;; ange-ftp-TYPE-make-compressed-filename | |
582 | ;; ange-ftp-TYPE-file-name-sans-versions | |
583 | ;; | |
584 | ;; Variables: | |
585 | ;; | |
586 | ;; ange-ftp-TYPE-host-regexp | |
587 | ;; May need to add TYPE to ange-ftp-dumb-host-types | |
588 | ;; | |
589 | ;; Check the following functions for OS dependent coding: | |
590 | ;; | |
591 | ;; ange-ftp-host-type | |
592 | ;; ange-ftp-guess-host-type | |
593 | ;; ange-ftp-allow-child-lookup | |
594 | ||
595 | ;; Host type conventions: | |
596 | ;; | |
597 | ;; The function ange-ftp-host-type and the variable ange-ftp-dired-host-type | |
598 | ;; (mostly) follow the following conventions for remote host types. At | |
599 | ;; least, I think that future code should try to follow these conventions, | |
600 | ;; and the current code should eventually be made compliant. | |
601 | ;; | |
602 | ;; nil = local host type, whatever that is (probably unix). | |
603 | ;; Think nil as in "not a remote host". This value is used by | |
604 | ;; ange-ftp-dired-host-type for local buffers. | |
605 | ;; | |
606 | ;; t = a remote host of unknown type. Think t as in true, it's remote. | |
607 | ;; Currently, `unix' is used as the default remote host type. | |
608 | ;; Maybe we should use t. | |
609 | ;; | |
610 | ;; TYPE = a remote host of TYPE type. | |
611 | ;; | |
612 | ;; TYPE:LIST = a remote host of TYPE type, using a specialized ftp listing | |
613 | ;; program called list. This is currently only used for Unix | |
614 | ;; dl (descriptive listings), when ange-ftp-dired-host-type | |
615 | ;; is set to `unix:dl'. | |
616 | ||
617 | ;; Bug report codes: | |
618 | ;; | |
619 | ;; Because of their naive faith in this code, there are certain situations | |
620 | ;; which the writers of this program believe could never happen. However, | |
621 | ;; being realists they have put calls to `error' in the program at these | |
622 | ;; points. These errors provide a code, which is an integer, greater than 1. | |
623 | ;; To aid debugging. the error codes, and the functions in which they reside | |
624 | ;; are listed below. | |
25759a92 | 625 | ;; |
8749abea GM |
626 | ;; 1: See ange-ftp-ls |
627 | ;; | |
628 | \f | |
629 | ;; ----------------------------------------------------------- | |
630 | ;; Hall of fame: | |
631 | ;; ----------------------------------------------------------- | |
25759a92 | 632 | ;; |
8749abea GM |
633 | ;; Thanks to Roland McGrath for improving the filename syntax handling, |
634 | ;; for suggesting many enhancements and for numerous cleanups to the code. | |
635 | ;; | |
636 | ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways. | |
637 | ;; | |
638 | ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and | |
639 | ;; dired / shell auto-loading. | |
640 | ;; | |
641 | ;; Thanks to Sebastian Kremer for dired support and for many ideas and | |
642 | ;; bugfixes. | |
643 | ;; | |
644 | ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support, | |
645 | ;; VOS support, and hostname completion. | |
646 | ;; | |
647 | ;; Thanks to Nakagawa Takayuki for many good ideas, filename-completion, help | |
648 | ;; with file-name expansion, efficiency worries, stylistic concerns and many | |
649 | ;; bugfixes. | |
650 | ;; | |
651 | ;; Thanks to Sandy Rutherford who re-wrote most of ange-ftp to support VMS, | |
652 | ;; MTS, CMS and UNIX-dls. Sandy also added dired-support for non-UNIX OS and | |
653 | ;; auto-recognition of the host type. | |
654 | ;; | |
655 | ;; Thanks to Dave Smith who wrote the info file for ange-ftp. | |
656 | ;; | |
657 | ;; Finally, thanks to Keith Waclena, Mark D. Baushke, Terence Kelleher, Ping | |
658 | ;; Zhou, Edward Vielmetti, Jack Repenning, Mike Balenger, Todd Kaufmann, | |
659 | ;; Kjetil Svarstad, Tom Wurgler, Linus Tolke, Niko Makila, Carl Edman, Bill | |
660 | ;; Trost, Dave Brennan, Dan Jacobson, Andy Scott, Steve Anderson, Sanjay | |
661 | ;; Mathur, the folks on the ange-ftp-lovers mailing list and many others | |
662 | ;; whose names I've forgotten who have helped to debug and fix problems with | |
663 | ;; ange-ftp.el. | |
664 | \f | |
665 | ;;; Code: | |
666 | ||
667 | (require 'comint) | |
8749abea GM |
668 | |
669 | ;;;; ------------------------------------------------------------ | |
670 | ;;;; User customization variables. | |
671 | ;;;; ------------------------------------------------------------ | |
672 | ||
673 | (defgroup ange-ftp nil | |
25759a92 | 674 | "Accessing remote files and directories using FTP |
8749abea GM |
675 | made as simple and transparent as possible." |
676 | :group 'files | |
26f4b8ab | 677 | :group 'comm |
8749abea GM |
678 | :prefix "ange-ftp-") |
679 | ||
680 | (defcustom ange-ftp-name-format | |
aa6f7b96 | 681 | '("\\`/\\(\\([^/:]*\\)@\\)?\\([^@/:]*[^@/:.]\\):\\(.*\\)" . (3 2 4)) |
4671dba5 | 682 | "Format of a fully expanded remote file name. |
8749abea GM |
683 | |
684 | This is a list of the form \(REGEXP HOST USER NAME\), | |
685 | where REGEXP is a regular expression matching | |
686 | the full remote name, and HOST, USER, and NAME are the numbers of | |
687 | parenthesized expressions in REGEXP for the components (in that order)." | |
688 | :group 'ange-ftp | |
ecd5fe1f | 689 | :type '(list (regexp :tag "Name regexp") |
8749abea GM |
690 | (integer :tag "Host group") |
691 | (integer :tag "User group") | |
692 | (integer :tag "Name group"))) | |
693 | ||
694 | ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of | |
695 | ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs. | |
696 | ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out. | |
697 | ||
698 | (defvar ange-ftp-multi-msgs | |
72e0a95b | 699 | "^150-\\|^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-" |
4671dba5 | 700 | "*Regular expression matching the start of a multiline FTP reply.") |
8749abea GM |
701 | |
702 | (defvar ange-ftp-good-msgs | |
703 | "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark" | |
4671dba5 | 704 | "*Regular expression matching FTP \"success\" messages.") |
8749abea GM |
705 | |
706 | ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT. | |
707 | ;; Also CMS machines use a multiline 550- reply to say that you | |
708 | ;; don't have write permission. ange-ftp gets into multi-line skip | |
709 | ;; mode and hangs. Have it ignore 550- instead. It will then barf | |
710 | ;; when it gets the 550 line, as it should. | |
711 | ||
a8a3541c GM |
712 | ;; RFC2228 "FTP Security Extensions" defines extensions to the FTP |
713 | ;; protocol which involve the client requesting particular | |
714 | ;; authentication methods (typically) at connection establishment. Non | |
715 | ;; security-aware FTP servers should respond to this with a 500 code, | |
716 | ;; which we ignore. | |
8749abea GM |
717 | (defcustom ange-ftp-skip-msgs |
718 | (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|" | |
719 | "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|" | |
720 | "^Data connection \\|" | |
721 | "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye\\|" | |
c35fcd52 | 722 | "^500 .*AUTH\\|^KERBEROS\\|" |
b0f037ed | 723 | "^504 Unknown security mechanism\\|" |
6309b0e1 | 724 | "^530 Please login with USER and PASS\\|" ; non kerberised vsFTPd |
8204704e | 725 | "^534 Kerberos Authentication not enabled\\|" |
7d685c84 | 726 | "^22[789] .*[Pp]assive\\|^200 EPRT\\|^500 .*EPRT") |
4671dba5 | 727 | "Regular expression matching FTP messages that can be ignored." |
8749abea GM |
728 | :group 'ange-ftp |
729 | :type 'regexp) | |
730 | ||
731 | (defcustom ange-ftp-fatal-msgs | |
732 | (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|" | |
733 | "^No control connection\\|unknown host\\|^lost connection") | |
4671dba5 | 734 | "Regular expression matching FTP messages that indicate serious errors. |
8749abea | 735 | |
4671dba5 | 736 | These mean that the FTP process should be (or already has been) killed." |
8749abea GM |
737 | :group 'ange-ftp |
738 | :type 'regexp) | |
739 | ||
92482d77 SM |
740 | (defcustom ange-ftp-potential-error-msgs |
741 | ;; On Mac OS X we sometimes get things like: | |
5fd6d89f | 742 | ;; |
92482d77 SM |
743 | ;; ftp> open ftp.nluug.nl |
744 | ;; Trying 2001:610:1:80aa:192:87:102:36... | |
745 | ;; ftp: connect to address 2001:610:1:80aa:192:87:102:36: No route to host | |
746 | ;; Trying 192.87.102.36... | |
747 | ;; Connected to ftp.nluug.nl. | |
748 | "^ftp: connect to address .*: No route to host" | |
4671dba5 | 749 | "Regular expression matching FTP messages that can indicate serious errors. |
92482d77 SM |
750 | These mean that something went wrong, but they may be followed by more |
751 | messages indicating that the error was somehow corrected." | |
752 | :group 'ange-ftp | |
753 | :type 'regexp) | |
754 | ||
8749abea GM |
755 | (defcustom ange-ftp-gateway-fatal-msgs |
756 | "No route to host\\|Connection closed\\|No such host\\|Login incorrect" | |
4671dba5 | 757 | "Regular expression matching login failure messages from rlogin/telnet." |
8749abea GM |
758 | :group 'ange-ftp |
759 | :type 'regexp) | |
760 | ||
761 | (defcustom ange-ftp-xfer-size-msgs | |
762 | "^150 .* connection for .* (\\([0-9]+\\) bytes)" | |
4671dba5 | 763 | "Regular expression used to determine the number of bytes in a FTP transfer." |
8749abea GM |
764 | :group 'ange-ftp |
765 | :type 'regexp) | |
766 | ||
25759a92 | 767 | (defcustom ange-ftp-tmp-name-template |
8749abea | 768 | (expand-file-name "ange-ftp" temporary-file-directory) |
4671dba5 | 769 | "Template used to create temporary files." |
8749abea GM |
770 | :group 'ange-ftp |
771 | :type 'directory) | |
772 | ||
773 | (defcustom ange-ftp-gateway-tmp-name-template "/tmp/ange-ftp" | |
4671dba5 | 774 | "Template used to create temporary files when FTP-ing through a gateway. |
8749abea GM |
775 | |
776 | Files starting with this prefix need to be accessible from BOTH the local | |
777 | machine and the gateway machine, and need to have the SAME name on both | |
778 | machines, that is, /tmp is probably NOT what you want, since that is rarely | |
779 | cross-mounted." | |
780 | :group 'ange-ftp | |
781 | :type 'directory) | |
782 | ||
783 | (defcustom ange-ftp-netrc-filename "~/.netrc" | |
4671dba5 | 784 | "File in .netrc format to search for passwords." |
8749abea GM |
785 | :group 'ange-ftp |
786 | :type 'file) | |
787 | ||
788 | (defcustom ange-ftp-disable-netrc-security-check (eq system-type 'windows-nt) | |
4671dba5 | 789 | "If non-nil avoid checking permissions on the .netrc file." |
8749abea GM |
790 | :group 'ange-ftp |
791 | :type 'boolean) | |
792 | ||
793 | (defcustom ange-ftp-default-user nil | |
4671dba5 | 794 | "User name to use when none is specified in a file name. |
8749abea GM |
795 | |
796 | If non-nil but not a string, you are prompted for the name. | |
797 | If nil, the value of `ange-ftp-netrc-default-user' is used. | |
798 | If that is nil too, then your login name is used. | |
799 | ||
800 | Once a connection to a given host has been initiated, the user name | |
801 | and password information for that host are cached and re-used by | |
802 | ange-ftp. Use \\[ange-ftp-set-user] to change the cached values, | |
803 | since setting `ange-ftp-default-user' directly does not affect | |
804 | the cached information." | |
805 | :group 'ange-ftp | |
806 | :type '(choice (const :tag "Default" nil) | |
807 | string | |
808 | (other :tag "Prompt" t))) | |
809 | ||
810 | (defcustom ange-ftp-netrc-default-user nil | |
811 | "Alternate default user name to use when none is specified. | |
812 | ||
813 | This variable is set from the `default' command in your `.netrc' file, | |
814 | if there is one." | |
815 | :group 'ange-ftp | |
816 | :type '(choice (const :tag "Default" nil) | |
817 | string)) | |
818 | ||
819 | (defcustom ange-ftp-default-password nil | |
4671dba5 | 820 | "Password to use when the user name equals `ange-ftp-default-user'." |
8749abea GM |
821 | :group 'ange-ftp |
822 | :type '(choice (const :tag "Default" nil) | |
823 | string)) | |
824 | ||
825 | (defcustom ange-ftp-default-account nil | |
4671dba5 | 826 | "Account to use when the user name equals `ange-ftp-default-user'." |
8749abea GM |
827 | :group 'ange-ftp |
828 | :type '(choice (const :tag "Default" nil) | |
829 | string)) | |
830 | ||
831 | (defcustom ange-ftp-netrc-default-password nil | |
4671dba5 | 832 | "Password to use when the user name equals `ange-ftp-netrc-default-user'." |
8749abea GM |
833 | :group 'ange-ftp |
834 | :type '(choice (const :tag "Default" nil) | |
835 | string)) | |
836 | ||
837 | (defcustom ange-ftp-netrc-default-account nil | |
4671dba5 | 838 | "Account to use when the user name equals `ange-ftp-netrc-default-user'." |
8749abea GM |
839 | :group 'ange-ftp |
840 | :type '(choice (const :tag "Default" nil) | |
841 | string)) | |
842 | ||
843 | (defcustom ange-ftp-generate-anonymous-password t | |
4671dba5 | 844 | "If t, use value of `user-mail-address' as password for anonymous FTP. |
8749abea GM |
845 | |
846 | If a string, then use that string as the password. | |
847 | If nil, prompt the user for a password." | |
848 | :group 'ange-ftp | |
849 | :type '(choice (const :tag "Prompt" nil) | |
850 | string | |
851 | (other :tag "User address" t))) | |
852 | ||
853 | (defcustom ange-ftp-dumb-unix-host-regexp nil | |
4671dba5 | 854 | "If non-nil, regexp matching hosts on which `dir' command lists directory." |
8749abea GM |
855 | :group 'ange-ftp |
856 | :type '(choice (const :tag "Default" nil) | |
857 | string)) | |
858 | ||
a6bc05e1 | 859 | (defcustom ange-ftp-binary-file-name-regexp "" |
4671dba5 | 860 | "If a file matches this regexp then it is transferred in binary mode." |
8749abea | 861 | :group 'ange-ftp |
a6bc05e1 MA |
862 | :type 'regexp |
863 | :version "24.1") | |
8749abea GM |
864 | |
865 | (defcustom ange-ftp-gateway-host nil | |
4671dba5 | 866 | "Name of host to use as gateway machine when local FTP isn't possible." |
8749abea GM |
867 | :group 'ange-ftp |
868 | :type '(choice (const :tag "Default" nil) | |
869 | string)) | |
870 | ||
871 | (defcustom ange-ftp-local-host-regexp ".*" | |
4671dba5 | 872 | "Regexp selecting hosts which can be reached directly with FTP. |
8749abea | 873 | |
4671dba5 JB |
874 | For other hosts the FTP process is started on `ange-ftp-gateway-host' |
875 | instead, and/or reached via `ange-ftp-gateway-ftp-program-name'." | |
8749abea GM |
876 | :group 'ange-ftp |
877 | :type 'regexp) | |
878 | ||
879 | (defcustom ange-ftp-gateway-program-interactive nil | |
4671dba5 | 880 | "If non-nil then the gateway program should give a shell prompt. |
8749abea GM |
881 | |
882 | Both telnet and rlogin do something like this." | |
883 | :group 'ange-ftp | |
884 | :type 'boolean) | |
885 | ||
886 | (defcustom ange-ftp-gateway-program remote-shell-program | |
4671dba5 | 887 | "Name of program to spawn a shell on the gateway machine. |
8749abea | 888 | |
4671dba5 JB |
889 | Valid candidates are rsh (remsh on some systems), telnet and rlogin. |
890 | See also the gateway variable above." | |
8749abea GM |
891 | :group 'ange-ftp |
892 | :type '(choice (const "rsh") | |
893 | (const "telnet") | |
894 | (const "rlogin") | |
895 | string)) | |
896 | ||
897 | (defcustom ange-ftp-gateway-prompt-pattern "^[^#$%>;\n]*[#$%>;] *" | |
4671dba5 | 898 | "Regexp matching prompt after complete login sequence on gateway machine. |
8749abea GM |
899 | |
900 | A match for this means the shell is now awaiting input. Make this regexp as | |
901 | strict as possible; it shouldn't match *anything* at all except the user's | |
902 | initial prompt. The above string will fail under most SUN-3's since it | |
903 | matches the login banner." | |
904 | :group 'ange-ftp | |
905 | :type 'regexp) | |
906 | ||
907 | (defvar ange-ftp-gateway-setup-term-command | |
908 | (if (eq system-type 'hpux) | |
909 | "stty -onlcr -echo\n" | |
910 | "stty -echo nl\n") | |
911 | "*Set up terminal after logging in to the gateway machine. | |
912 | This command should stop the terminal from echoing each command, and | |
913 | arrange to strip out trailing ^M characters.") | |
914 | ||
915 | (defcustom ange-ftp-smart-gateway nil | |
4671dba5 | 916 | "Non-nil says the FTP gateway (proxy) or gateway FTP program is smart. |
8749abea GM |
917 | |
918 | Don't bother telnetting, etc., already connected to desired host transparently, | |
4671dba5 | 919 | or just issue a user@host command in case `ange-ftp-gateway-host' is non-nil. |
0101f7e1 | 920 | See also `ange-ftp-smart-gateway-port'." |
8749abea GM |
921 | :group 'ange-ftp |
922 | :type 'boolean) | |
923 | ||
924 | (defcustom ange-ftp-smart-gateway-port "21" | |
4671dba5 | 925 | "Port on gateway machine to use when smart gateway is in operation." |
8749abea GM |
926 | :group 'ange-ftp |
927 | :type 'string) | |
928 | ||
929 | (defcustom ange-ftp-send-hash t | |
4671dba5 | 930 | "If non-nil, send the HASH command to the FTP client." |
8749abea GM |
931 | :group 'ange-ftp |
932 | :type 'boolean) | |
933 | ||
934 | (defcustom ange-ftp-binary-hash-mark-size nil | |
4671dba5 | 935 | "Default size, in bytes, between hash-marks when transferring a binary file. |
8749abea GM |
936 | If nil, this variable will be locally overridden if the FTP client outputs a |
937 | suitable response to the HASH command. If non-nil, this value takes | |
938 | precedence over the local value." | |
939 | :group 'ange-ftp | |
940 | :type '(choice (const :tag "Overridden" nil) | |
941 | integer)) | |
942 | ||
943 | (defcustom ange-ftp-ascii-hash-mark-size 1024 | |
4671dba5 | 944 | "Default size, in bytes, between hash-marks when transferring an ASCII file. |
8749abea GM |
945 | This variable is buffer-local and will be locally overridden if the FTP client |
946 | outputs a suitable response to the HASH command." | |
947 | :group 'ange-ftp | |
948 | :type 'integer) | |
949 | ||
950 | (defcustom ange-ftp-process-verbose t | |
4671dba5 | 951 | "If non-nil then be chatty about interaction with the FTP process." |
8749abea GM |
952 | :group 'ange-ftp |
953 | :type 'boolean) | |
954 | ||
955 | (defcustom ange-ftp-ftp-program-name "ftp" | |
4671dba5 | 956 | "Name of FTP program to run." |
8749abea GM |
957 | :group 'ange-ftp |
958 | :type 'string) | |
959 | ||
960 | (defcustom ange-ftp-gateway-ftp-program-name "ftp" | |
4671dba5 | 961 | "Name of FTP program to run when accessing non-local hosts. |
8749abea GM |
962 | |
963 | Some AT&T folks claim to use something called `pftp' here." | |
964 | :group 'ange-ftp | |
965 | :type 'string) | |
966 | ||
967 | (defcustom ange-ftp-ftp-program-args '("-i" "-n" "-g" "-v") | |
4671dba5 | 968 | "A list of arguments passed to the FTP program when started." |
8749abea GM |
969 | :group 'ange-ftp |
970 | :type '(repeat string)) | |
971 | ||
972 | (defcustom ange-ftp-nslookup-program nil | |
4671dba5 | 973 | "If non-nil, this is a string naming the nslookup program." |
8749abea GM |
974 | :group 'ange-ftp |
975 | :type '(choice (const :tag "None" nil) | |
976 | string)) | |
977 | ||
978 | (defcustom ange-ftp-make-backup-files () | |
4671dba5 | 979 | "Non-nil means make backup files for \"magic\" remote files." |
8749abea GM |
980 | :group 'ange-ftp |
981 | :type 'boolean) | |
982 | ||
983 | (defcustom ange-ftp-retry-time 5 | |
4671dba5 | 984 | "Number of seconds to wait before retry if file or listing doesn't arrive. |
8749abea GM |
985 | This might need to be increased for very slow connections." |
986 | :group 'ange-ftp | |
987 | :type 'integer) | |
988 | ||
989 | (defcustom ange-ftp-auto-save 0 | |
990 | "If 1, allow ange-ftp files to be auto-saved. | |
991 | If 0, inhibit auto-saving of ange-ftp files. | |
992 | Don't use any other value." | |
993 | :group 'ange-ftp | |
994 | :type '(choice (const :tag "Suppress" 0) | |
995 | (const :tag "Allow" 1))) | |
996 | ||
997 | (defcustom ange-ftp-try-passive-mode nil | |
4671dba5 | 998 | "If t, try to use passive mode in FTP, if the client program supports it." |
8749abea GM |
999 | :group 'ange-ftp |
1000 | :type 'boolean | |
84778d91 | 1001 | :version "21.1") |
8749abea | 1002 | |
1d0653f8 RS |
1003 | (defcustom ange-ftp-passive-host-alist nil |
1004 | "Alist of FTP servers that need \"passive\" mode. | |
1005 | Each element is of the form (HOSTNAME . SETTING). | |
1006 | HOSTNAME is a regular expression to match the FTP server host name(s). | |
1007 | SETTING is \"on\" to turn passive mode on, \"off\" to turn it off, | |
1008 | or nil meaning don't change it." | |
1009 | :group 'ange-ftp | |
33ceea4f RS |
1010 | :type '(repeat (cons regexp (choice (const :tag "On" "on") |
1011 | (const :tag "Off" "off") | |
1012 | (const :tag "Don't change" nil)))) | |
bf247b6e | 1013 | :version "22.1") |
8749abea GM |
1014 | \f |
1015 | ;;;; ------------------------------------------------------------ | |
1016 | ;;;; Hash table support. | |
1017 | ;;;; ------------------------------------------------------------ | |
1018 | ||
1019 | (require 'backquote) | |
1020 | ||
8749abea | 1021 | (defun ange-ftp-hash-entry-exists-p (key tbl) |
4671dba5 | 1022 | "Return whether there is an association for KEY in table TBL." |
311f32fe | 1023 | (and tbl (not (eq (gethash key tbl 'unknown) 'unknown)))) |
8749abea GM |
1024 | |
1025 | (defun ange-ftp-hash-table-keys (tbl) | |
4671dba5 | 1026 | "Return a sorted list of all the active keys in table TBL, as strings." |
6e85ef5f SM |
1027 | ;; (let ((keys nil)) |
1028 | ;; (maphash (lambda (k v) (push k keys)) tbl) | |
1029 | ;; (sort keys 'string-lessp)) | |
1030 | (sort (all-completions "" tbl) 'string-lessp)) | |
8749abea GM |
1031 | \f |
1032 | ;;;; ------------------------------------------------------------ | |
1033 | ;;;; Internal variables. | |
1034 | ;;;; ------------------------------------------------------------ | |
1035 | ||
1036 | (defvar ange-ftp-data-buffer-name " *ftp data*" | |
4671dba5 | 1037 | "Buffer name to hold directory listing data received from FTP process.") |
8749abea GM |
1038 | |
1039 | (defvar ange-ftp-netrc-modtime nil | |
1040 | "Last modified time of the netrc file from file-attributes.") | |
1041 | ||
6e85ef5f | 1042 | (defvar ange-ftp-user-hashtable (make-hash-table :test 'equal) |
8749abea GM |
1043 | "Hash table holding associations between HOST, USER pairs.") |
1044 | ||
6e85ef5f | 1045 | (defvar ange-ftp-passwd-hashtable (make-hash-table :test 'equal) |
8749abea GM |
1046 | "Mapping between a HOST, USER pair and a PASSWORD for them. |
1047 | All HOST values should be in lower case.") | |
1048 | ||
6e85ef5f | 1049 | (defvar ange-ftp-account-hashtable (make-hash-table :test 'equal) |
4671dba5 | 1050 | "Mapping between a HOST, USER pair and an ACCOUNT password for them.") |
8749abea | 1051 | |
6e85ef5f | 1052 | (defvar ange-ftp-files-hashtable (make-hash-table :test 'equal :size 97) |
8749abea GM |
1053 | "Hash table for storing directories and their respective files.") |
1054 | ||
6e85ef5f | 1055 | (defvar ange-ftp-inodes-hashtable (make-hash-table :test 'equal :size 97) |
8749abea GM |
1056 | "Hash table for storing file names and their \"inode numbers\".") |
1057 | ||
1058 | (defvar ange-ftp-next-inode-number 1 | |
1059 | "Next \"inode number\" value. We give each file name a unique number.") | |
1060 | ||
1061 | (defvar ange-ftp-ls-cache-lsargs nil | |
4671dba5 | 1062 | "Last set of args used by `ange-ftp-ls'.") |
8749abea GM |
1063 | |
1064 | (defvar ange-ftp-ls-cache-file nil | |
4671dba5 | 1065 | "Last file passed to `ange-ftp-ls'.") |
8749abea GM |
1066 | |
1067 | (defvar ange-ftp-ls-cache-res nil | |
4671dba5 | 1068 | "Last result returned from `ange-ftp-ls'.") |
8749abea | 1069 | |
6e85ef5f | 1070 | (defconst ange-ftp-expand-dir-hashtable (make-hash-table :test 'equal)) |
8749abea GM |
1071 | |
1072 | (defconst ange-ftp-expand-dir-regexp "^5.0 \\([^: ]+\\):") | |
1073 | ||
1074 | ;; These are local variables in each FTP process buffer. | |
1075 | (defvar ange-ftp-hash-mark-unit nil) | |
1076 | (defvar ange-ftp-hash-mark-count nil) | |
1077 | (defvar ange-ftp-xfer-size nil) | |
1078 | (defvar ange-ftp-process-string nil) | |
1079 | (defvar ange-ftp-process-result-line nil) | |
92482d77 | 1080 | (defvar ange-ftp-pending-error-line nil) |
8749abea GM |
1081 | (defvar ange-ftp-process-busy nil) |
1082 | (defvar ange-ftp-process-result nil) | |
1083 | (defvar ange-ftp-process-multi-skip nil) | |
1084 | (defvar ange-ftp-process-msg nil) | |
1085 | (defvar ange-ftp-process-continue nil) | |
1086 | (defvar ange-ftp-last-percent nil) | |
1087 | ||
1088 | ;; These variables are bound by one function and examined by another. | |
1089 | ;; Leave them void globally for error checking. | |
1090 | (defvar ange-ftp-this-file) | |
1091 | (defvar ange-ftp-this-dir) | |
1092 | (defvar ange-ftp-this-user) | |
1093 | (defvar ange-ftp-this-host) | |
1094 | (defvar ange-ftp-this-msg) | |
1095 | (defvar ange-ftp-completion-ignored-pattern) | |
1096 | (defvar ange-ftp-trample-marker) | |
1097 | \f | |
1098 | ;; New error symbols. | |
1099 | (put 'ftp-error 'error-conditions '(ftp-error file-error error)) | |
1100 | ;; (put 'ftp-error 'error-message "FTP error") | |
1101 | \f | |
1102 | ;;; ------------------------------------------------------------ | |
1103 | ;;; Enhanced message support. | |
1104 | ;;; ------------------------------------------------------------ | |
1105 | ||
1106 | (defun ange-ftp-message (fmt &rest args) | |
1107 | "Display message in echo area, but indicate if truncated. | |
1108 | Args are as in `message': a format string, plus arguments to be formatted." | |
6e85ef5f | 1109 | (let ((msg (apply 'format fmt args)) |
8749abea GM |
1110 | (max (window-width (minibuffer-window)))) |
1111 | (if noninteractive | |
1112 | msg | |
1113 | (if (>= (length msg) max) | |
1114 | ;; Take just the last MAX - 3 chars of the string. | |
1115 | (setq msg (concat "> " (substring msg (- 3 max))))) | |
1116 | (message "%s" msg)))) | |
1117 | ||
1118 | (defun ange-ftp-abbreviate-filename (file &optional new) | |
25759a92 | 1119 | "Abbreviate the file name FILE relative to the `default-directory'. |
8749abea GM |
1120 | If the optional parameter NEW is given and the non-directory parts match, |
1121 | only return the directory part of FILE." | |
1122 | (save-match-data | |
1123 | (if (and default-directory | |
aa6f7b96 | 1124 | (string-match (concat "\\`" |
8749abea GM |
1125 | (regexp-quote default-directory) |
1126 | ".") file)) | |
1127 | (setq file (substring file (1- (match-end 0))))) | |
1128 | (if (and new | |
1129 | (string-equal (file-name-nondirectory file) | |
1130 | (file-name-nondirectory new))) | |
1131 | (setq file (file-name-directory file))) | |
1132 | (or file "./"))) | |
1133 | \f | |
1134 | ;;;; ------------------------------------------------------------ | |
1135 | ;;;; User / Host mapping support. | |
1136 | ;;;; ------------------------------------------------------------ | |
1137 | ||
1138 | (defun ange-ftp-set-user (host user) | |
1139 | "For a given HOST, set or change the default USER." | |
1140 | (interactive "sHost: \nsUser: ") | |
6e85ef5f | 1141 | (puthash host user ange-ftp-user-hashtable)) |
8749abea GM |
1142 | |
1143 | (defun ange-ftp-get-user (host) | |
4671dba5 | 1144 | "Given a HOST, return the default user." |
8749abea | 1145 | (ange-ftp-parse-netrc) |
6e85ef5f | 1146 | (let ((user (gethash host ange-ftp-user-hashtable))) |
8749abea GM |
1147 | (or user |
1148 | (prog1 | |
1149 | (setq user | |
1150 | (cond ((stringp ange-ftp-default-user) | |
1151 | ;; We have a default name. Use it. | |
1152 | ange-ftp-default-user) | |
1153 | (ange-ftp-default-user | |
1154 | ;; Ask the user. | |
1155 | (let ((enable-recursive-minibuffers t)) | |
1156 | (read-string (format "User for %s: " host) | |
1157 | (user-login-name)))) | |
1158 | (ange-ftp-netrc-default-user) | |
1159 | ;; Default to the user's login name. | |
1160 | (t | |
1161 | (user-login-name)))) | |
1162 | (ange-ftp-set-user host user))))) | |
1163 | \f | |
1164 | ;;;; ------------------------------------------------------------ | |
1165 | ;;;; Password support. | |
1166 | ;;;; ------------------------------------------------------------ | |
1167 | ||
1168 | (defmacro ange-ftp-generate-passwd-key (host user) | |
b3ee21ac | 1169 | `(and (stringp ,host) (stringp ,user) (concat (downcase ,host) "/" ,user))) |
8749abea GM |
1170 | |
1171 | (defmacro ange-ftp-lookup-passwd (host user) | |
6e85ef5f SM |
1172 | `(gethash (ange-ftp-generate-passwd-key ,host ,user) |
1173 | ange-ftp-passwd-hashtable)) | |
8749abea | 1174 | |
4671dba5 | 1175 | (defun ange-ftp-set-passwd (host user password) |
8749abea GM |
1176 | "For a given HOST and USER, set or change the associated PASSWORD." |
1177 | (interactive (list (read-string "Host: ") | |
1178 | (read-string "User: ") | |
1179 | (read-passwd "Password: "))) | |
6e85ef5f | 1180 | (puthash (ange-ftp-generate-passwd-key host user) |
4671dba5 | 1181 | password ange-ftp-passwd-hashtable)) |
8749abea GM |
1182 | |
1183 | (defun ange-ftp-get-host-with-passwd (user) | |
1184 | "Given a USER, return a host we know the password for." | |
1185 | (ange-ftp-parse-netrc) | |
1186 | (catch 'found-one | |
6e85ef5f SM |
1187 | (maphash |
1188 | (lambda (host val) | |
1189 | (if (ange-ftp-lookup-passwd host user) (throw 'found-one host))) | |
8749abea GM |
1190 | ange-ftp-user-hashtable) |
1191 | (save-match-data | |
6e85ef5f SM |
1192 | (maphash |
1193 | (lambda (key value) | |
aa6f7b96 | 1194 | (if (string-match "\\`[^/]*\\(/\\).*\\'" key) |
6e85ef5f SM |
1195 | (let ((host (substring key 0 (match-beginning 1)))) |
1196 | (if (and (string-equal user (substring key (match-end 1))) | |
1197 | value) | |
1198 | (throw 'found-one host))))) | |
8749abea GM |
1199 | ange-ftp-passwd-hashtable)) |
1200 | nil)) | |
1201 | ||
1202 | (defun ange-ftp-get-passwd (host user) | |
1203 | "Return the password for specified HOST and USER, asking user if necessary." | |
1204 | (ange-ftp-parse-netrc) | |
1205 | ||
1206 | ;; look up password in the hash table first; user might have overridden the | |
1207 | ;; defaults. | |
1208 | (cond ((ange-ftp-lookup-passwd host user)) | |
25759a92 | 1209 | |
8749abea GM |
1210 | ;; See if default user and password set. |
1211 | ((and (stringp ange-ftp-default-user) | |
1212 | ange-ftp-default-password | |
1213 | (string-equal user ange-ftp-default-user)) | |
1214 | ange-ftp-default-password) | |
25759a92 | 1215 | |
8749abea GM |
1216 | ;; See if default user and password set from .netrc file. |
1217 | ((and (stringp ange-ftp-netrc-default-user) | |
1218 | ange-ftp-netrc-default-password | |
1219 | (string-equal user ange-ftp-netrc-default-user)) | |
1220 | ange-ftp-netrc-default-password) | |
25759a92 | 1221 | |
8749abea GM |
1222 | ;; anonymous ftp password is handled specially since there is an |
1223 | ;; unwritten rule about how that is used on the Internet. | |
1224 | ((and (or (string-equal user "anonymous") | |
1225 | (string-equal user "ftp")) | |
1226 | ange-ftp-generate-anonymous-password) | |
1227 | (if (stringp ange-ftp-generate-anonymous-password) | |
1228 | ange-ftp-generate-anonymous-password | |
1229 | user-mail-address)) | |
25759a92 | 1230 | |
8749abea GM |
1231 | ;; see if same user has logged in to other hosts; if so then prompt |
1232 | ;; with the password that was used there. | |
1233 | (t | |
1234 | (let* ((other (ange-ftp-get-host-with-passwd user)) | |
1235 | (passwd (if other | |
25759a92 | 1236 | |
8749abea GM |
1237 | ;; found another machine with the same user. |
1238 | ;; Try that account. | |
1239 | (read-passwd | |
1240 | (format "passwd for %s@%s (default same as %s@%s): " | |
1241 | user host user other) | |
1242 | nil | |
1243 | (ange-ftp-lookup-passwd other user)) | |
25759a92 | 1244 | |
8749abea GM |
1245 | ;; I give up. Ask the user for the password. |
1246 | (read-passwd | |
1247 | (format "Password for %s@%s: " user host))))) | |
1248 | (ange-ftp-set-passwd host user passwd) | |
1249 | passwd)))) | |
1250 | \f | |
1251 | ;;;; ------------------------------------------------------------ | |
1252 | ;;;; Account support | |
1253 | ;;;; ------------------------------------------------------------ | |
1254 | ||
1255 | ;; Account passwords must be either specified in the .netrc file, or set | |
1256 | ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't | |
1257 | ;; check to see whether the FTP process is actually prompting for an account | |
1258 | ;; password. | |
25759a92 | 1259 | |
8749abea GM |
1260 | (defun ange-ftp-set-account (host user account) |
1261 | "For a given HOST and USER, set or change the associated ACCOUNT password." | |
1262 | (interactive (list (read-string "Host: ") | |
1263 | (read-string "User: ") | |
1264 | (read-passwd "Account password: "))) | |
6e85ef5f SM |
1265 | (puthash (ange-ftp-generate-passwd-key host user) |
1266 | account ange-ftp-account-hashtable)) | |
8749abea GM |
1267 | |
1268 | (defun ange-ftp-get-account (host user) | |
1269 | "Given a HOST and USER, return the FTP account." | |
1270 | (ange-ftp-parse-netrc) | |
6e85ef5f SM |
1271 | (or (gethash (ange-ftp-generate-passwd-key host user) |
1272 | ange-ftp-account-hashtable) | |
8749abea GM |
1273 | (and (stringp ange-ftp-default-user) |
1274 | (string-equal user ange-ftp-default-user) | |
1275 | ange-ftp-default-account) | |
1276 | (and (stringp ange-ftp-netrc-default-user) | |
1277 | (string-equal user ange-ftp-netrc-default-user) | |
1278 | ange-ftp-netrc-default-account))) | |
1279 | \f | |
1280 | ;;;; ------------------------------------------------------------ | |
1281 | ;;;; ~/.netrc support | |
1282 | ;;;; ------------------------------------------------------------ | |
1283 | ||
1284 | (defun ange-ftp-chase-symlinks (file) | |
1285 | "Return the filename that FILE references, following all symbolic links." | |
1286 | (let (temp) | |
1287 | (while (setq temp (ange-ftp-real-file-symlink-p file)) | |
1288 | (setq file | |
1289 | (if (file-name-absolute-p temp) | |
1290 | temp | |
3bd1644e SM |
1291 | ;; Wouldn't `expand-file-name' be better than `concat' ? |
1292 | ;; It would fail when `a/b/..' != `a', tho. --Stef | |
8749abea GM |
1293 | (concat (file-name-directory file) temp))))) |
1294 | file) | |
1295 | ||
1296 | ;; Move along current line looking for the value of the TOKEN. | |
1297 | ;; Valid separators between TOKEN and its value are commas and | |
1298 | ;; whitespace. Second arg LIMIT is a limit for the search. | |
1299 | ||
1300 | (defun ange-ftp-parse-netrc-token (token limit) | |
1301 | (if (search-forward token limit t) | |
1302 | (let (beg) | |
1303 | (skip-chars-forward ", \t\r\n" limit) | |
1304 | (if (eq (following-char) ?\") ;quoted token value | |
1305 | (progn (forward-char 1) | |
1306 | (setq beg (point)) | |
1307 | (skip-chars-forward "^\"" limit) | |
1308 | (forward-char 1) | |
1309 | (buffer-substring beg (1- (point)))) | |
1310 | (setq beg (point)) | |
1311 | (skip-chars-forward "^, \t\r\n" limit) | |
1312 | (buffer-substring beg (point)))))) | |
1313 | ||
1314 | ;; Extract the values for the tokens `machine', `login', | |
1315 | ;; `password' and `account' in the current buffer. If successful, | |
1316 | ;; record the information found. | |
1317 | ||
1318 | (defun ange-ftp-parse-netrc-group () | |
1319 | (let ((start (point)) | |
1320 | (end (save-excursion | |
1321 | (if (looking-at "machine\\>") | |
1322 | ;; Skip `machine' and the machine name that follows. | |
1323 | (progn | |
1324 | (skip-chars-forward "^ \t\r\n") | |
1325 | (skip-chars-forward " \t\r\n") | |
1326 | (skip-chars-forward "^ \t\r\n")) | |
1327 | ;; Skip `default'. | |
1328 | (skip-chars-forward "^ \t\r\n")) | |
1329 | ;; Find start of the next `machine' or `default' | |
1330 | ;; or the end of the buffer. | |
1331 | (if (re-search-forward "machine\\>\\|default\\>" nil t) | |
1332 | (match-beginning 0) | |
1333 | (point-max)))) | |
1334 | machine login password account) | |
1335 | (setq machine (ange-ftp-parse-netrc-token "machine" end) | |
1336 | login (ange-ftp-parse-netrc-token "login" end) | |
1337 | password (ange-ftp-parse-netrc-token "password" end) | |
1338 | account (ange-ftp-parse-netrc-token "account" end)) | |
1339 | (if (and machine login) | |
1340 | ;; found a `machine` token. | |
1341 | (progn | |
1342 | (ange-ftp-set-user machine login) | |
1343 | (ange-ftp-set-passwd machine login password) | |
1344 | (and account | |
1345 | (ange-ftp-set-account machine login account))) | |
1346 | (goto-char start) | |
1347 | (if (search-forward "default" end t) | |
1348 | ;; found a `default' token | |
1349 | (progn | |
1350 | (setq login (ange-ftp-parse-netrc-token "login" end) | |
1351 | password (ange-ftp-parse-netrc-token "password" end) | |
1352 | account (ange-ftp-parse-netrc-token "account" end)) | |
1353 | (and login | |
1354 | (setq ange-ftp-netrc-default-user login)) | |
1355 | (and password | |
1356 | (setq ange-ftp-netrc-default-password password)) | |
1357 | (and account | |
1358 | (setq ange-ftp-netrc-default-account account))))) | |
1359 | (goto-char end))) | |
1360 | ||
1361 | ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has | |
1362 | ;; the correct permissions then extract the \`machine\', \`login\', | |
1363 | ;; \`password\' and \`account\' information from within. | |
1364 | ||
1365 | (defun ange-ftp-parse-netrc () | |
1366 | ;; We set this before actually doing it to avoid the possibility | |
1367 | ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file. | |
1368 | (interactive) | |
1369 | (let (file attr) | |
1370 | (let ((default-directory "/")) | |
1371 | (setq file (ange-ftp-chase-symlinks | |
1372 | (ange-ftp-real-expand-file-name ange-ftp-netrc-filename))) | |
1373 | (setq attr (ange-ftp-real-file-attributes file))) | |
1374 | (if (and attr ; file exists. | |
1375 | (not (equal (nth 5 attr) ange-ftp-netrc-modtime))) ; file changed | |
1376 | (save-match-data | |
1377 | (if (or ange-ftp-disable-netrc-security-check | |
1378 | (and (eq (nth 2 attr) (user-uid)) ; Same uids. | |
1379 | (string-match ".r..------" (nth 8 attr)))) | |
b63f6e81 | 1380 | (with-current-buffer |
8749abea GM |
1381 | ;; we are cheating a bit here. I'm trying to do the equivalent |
1382 | ;; of find-file on the .netrc file, but then nuke it afterwards. | |
1383 | ;; with the bit of logic below we should be able to have | |
1384 | ;; encrypted .netrc files. | |
b63f6e81 | 1385 | (generate-new-buffer "*ftp-.netrc*") |
8749abea GM |
1386 | (ange-ftp-real-insert-file-contents file) |
1387 | (setq buffer-file-name file) | |
1388 | (setq default-directory (file-name-directory file)) | |
1389 | (normal-mode t) | |
c8607dc7 | 1390 | (run-hooks 'find-file-hook) |
8749abea GM |
1391 | (setq buffer-file-name nil) |
1392 | (goto-char (point-min)) | |
1393 | (skip-chars-forward " \t\r\n") | |
1394 | (while (not (eobp)) | |
1395 | (ange-ftp-parse-netrc-group)) | |
1396 | (kill-buffer (current-buffer))) | |
1397 | (ange-ftp-message "%s either not owned by you or badly protected." | |
1398 | ange-ftp-netrc-filename) | |
1399 | (sit-for 1)) | |
1400 | (setq ange-ftp-netrc-modtime (nth 5 attr)))))) | |
1401 | ||
1402 | ;; Return a list of prefixes of the form 'user@host:' to be used when | |
1403 | ;; completion is done in the root directory. | |
1404 | ||
1405 | (defun ange-ftp-generate-root-prefixes () | |
1406 | (ange-ftp-parse-netrc) | |
1407 | (save-match-data | |
1408 | (let (res) | |
6e85ef5f SM |
1409 | (maphash |
1410 | (lambda (key value) | |
aa6f7b96 | 1411 | (if (string-match "\\`[^/]*\\(/\\).*\\'" key) |
6e85ef5f SM |
1412 | (let ((host (substring key 0 (match-beginning 1))) |
1413 | (user (substring key (match-end 1)))) | |
1414 | (push (concat user "@" host ":") res)))) | |
8749abea | 1415 | ange-ftp-passwd-hashtable) |
6e85ef5f SM |
1416 | (maphash |
1417 | (lambda (host user) (push (concat host ":") res)) | |
8749abea GM |
1418 | ange-ftp-user-hashtable) |
1419 | (or res (list nil))))) | |
1420 | \f | |
1421 | ;;;; ------------------------------------------------------------ | |
1422 | ;;;; Remote file name syntax support. | |
1423 | ;;;; ------------------------------------------------------------ | |
1424 | ||
1425 | (defmacro ange-ftp-ftp-name-component (n ns name) | |
4671dba5 | 1426 | "Extract the Nth FTP file name component from NS." |
25759a92 | 1427 | `(let ((elt (nth ,n ,ns))) |
e3441f42 | 1428 | (match-string elt ,name))) |
8749abea GM |
1429 | |
1430 | (defvar ange-ftp-ftp-name-arg "") | |
1431 | (defvar ange-ftp-ftp-name-res nil) | |
1432 | ||
1433 | ;; Parse NAME according to `ange-ftp-name-format' (which see). | |
1434 | ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format. | |
1435 | (defun ange-ftp-ftp-name (name) | |
1436 | (if (string-equal name ange-ftp-ftp-name-arg) | |
1437 | ange-ftp-ftp-name-res | |
1438 | (setq ange-ftp-ftp-name-arg name | |
1439 | ange-ftp-ftp-name-res | |
1440 | (save-match-data | |
1441 | (if (posix-string-match (car ange-ftp-name-format) name) | |
1442 | (let* ((ns (cdr ange-ftp-name-format)) | |
1443 | (host (ange-ftp-ftp-name-component 0 ns name)) | |
1444 | (user (ange-ftp-ftp-name-component 1 ns name)) | |
1445 | (name (ange-ftp-ftp-name-component 2 ns name))) | |
1446 | (if (zerop (length user)) | |
1447 | (setq user (ange-ftp-get-user host))) | |
1448 | (list host user name)) | |
1449 | nil))))) | |
1450 | ||
1451 | ;; Take a FULLNAME that matches according to ange-ftp-name-format and | |
1452 | ;; replace the name component with NAME. | |
1453 | (defun ange-ftp-replace-name-component (fullname name) | |
1454 | (save-match-data | |
1455 | (if (posix-string-match (car ange-ftp-name-format) fullname) | |
1456 | (let* ((ns (cdr ange-ftp-name-format)) | |
1457 | (elt (nth 2 ns))) | |
1458 | (concat (substring fullname 0 (match-beginning elt)) | |
1459 | name | |
1460 | (substring fullname (match-end elt))))))) | |
1461 | \f | |
1462 | ;;;; ------------------------------------------------------------ | |
1463 | ;;;; Miscellaneous utils. | |
1464 | ;;;; ------------------------------------------------------------ | |
1465 | ||
1466 | ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap)) | |
1467 | ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer) | |
1468 | ||
1469 | (defun ange-ftp-repaint-minibuffer () | |
1470 | "Clear any existing minibuffer message; let the minibuffer contents show." | |
1471 | (message nil)) | |
1472 | ||
1473 | ;; Return the name of the buffer that collects output from the ftp process | |
1474 | ;; connected to the given HOST and USER pair. | |
1475 | (defun ange-ftp-ftp-process-buffer (host user) | |
1476 | (concat "*ftp " user "@" host "*")) | |
1477 | ||
1478 | ;; Display the last chunk of output from the ftp process for the given HOST | |
1479 | ;; USER pair, and signal an error including MSG in the text. | |
1480 | (defun ange-ftp-error (host user msg) | |
6df73ca3 RS |
1481 | (save-excursion ;; Prevent pop-to-buffer from changing current buffer. |
1482 | (let ((cur (selected-window)) | |
1483 | (pop-up-windows t)) | |
1484 | (pop-to-buffer | |
1485 | (get-buffer-create | |
1486 | (ange-ftp-ftp-process-buffer host user))) | |
1487 | (goto-char (point-max)) | |
1488 | (select-window cur)) | |
1489 | (signal 'ftp-error (list (format "FTP Error: %s" msg))))) | |
8749abea GM |
1490 | |
1491 | (defun ange-ftp-set-buffer-mode () | |
1492 | "Set correct modes for the current buffer if visiting a remote file." | |
1493 | (if (and (stringp buffer-file-name) | |
1494 | (ange-ftp-ftp-name buffer-file-name)) | |
1495 | (auto-save-mode ange-ftp-auto-save))) | |
1496 | ||
1497 | (defun ange-ftp-kill-ftp-process (&optional buffer) | |
1498 | "Kill the FTP process associated with BUFFER (the current buffer, if nil). | |
4671dba5 JB |
1499 | If the BUFFER's visited filename or `default-directory' is an FTP filename |
1500 | then kill the related FTP process." | |
8749abea GM |
1501 | (interactive "bKill FTP process associated with buffer: ") |
1502 | (if (null buffer) | |
1503 | (setq buffer (current-buffer)) | |
1504 | (setq buffer (get-buffer buffer))) | |
1505 | (let ((file (or (buffer-file-name buffer) | |
b63f6e81 | 1506 | (with-current-buffer buffer default-directory)))) |
8749abea GM |
1507 | (if file |
1508 | (let ((parsed (ange-ftp-ftp-name (expand-file-name file)))) | |
1509 | (if parsed | |
1510 | (let ((host (nth 0 parsed)) | |
1511 | (user (nth 1 parsed))) | |
1512 | (kill-buffer (get-buffer (ange-ftp-ftp-process-buffer host user))))))))) | |
1513 | ||
1514 | (defun ange-ftp-quote-string (string) | |
4671dba5 | 1515 | "Quote any characters in STRING that may confuse the FTP process." |
1860f08d MA |
1516 | ;; This is said to be wrong; ftp is said to need quoting only for ", |
1517 | ;; and that by doubling it. But experiment says UNIX-style kind of | |
1518 | ;; quoting is correct when talking to ftp on GNU/Linux systems, and | |
1519 | ;; W32-style kind of quoting on, yes, W32 systems. | |
c200c78d MA |
1520 | (if (stringp string) |
1521 | (shell-quote-argument string) | |
1522 | "")) | |
8749abea GM |
1523 | |
1524 | (defun ange-ftp-barf-if-not-directory (directory) | |
1525 | (or (file-directory-p directory) | |
1526 | (signal 'file-error | |
1527 | (list "Opening directory" | |
1528 | (if (file-exists-p directory) | |
1529 | "not a directory" | |
1530 | "no such file or directory") | |
1531 | directory)))) | |
1532 | \f | |
1533 | ;;;; ------------------------------------------------------------ | |
1534 | ;;;; FTP process filter support. | |
1535 | ;;;; ------------------------------------------------------------ | |
1536 | ||
1537 | (defun ange-ftp-process-handle-line (line proc) | |
4671dba5 | 1538 | "Look at the given LINE from the FTP process PROC. |
8749abea GM |
1539 | Try to categorize it into one of four categories: |
1540 | good, skip, fatal, or unknown." | |
1541 | (cond ((string-match ange-ftp-xfer-size-msgs line) | |
1542 | (setq ange-ftp-xfer-size | |
e3441f42 | 1543 | (/ (string-to-number (match-string 1 line)) |
5504af22 | 1544 | 1024))) |
8749abea GM |
1545 | ((string-match ange-ftp-skip-msgs line) |
1546 | t) | |
1547 | ((string-match ange-ftp-good-msgs line) | |
1548 | (setq ange-ftp-process-busy nil | |
1549 | ange-ftp-process-result t | |
92482d77 | 1550 | ange-ftp-pending-error-line nil |
8749abea GM |
1551 | ange-ftp-process-result-line line)) |
1552 | ;; Check this before checking for errors. | |
1553 | ;; Otherwise the last line of these three seems to be an error: | |
1554 | ;; 230-see a significant impact from the move. For those of you who can't | |
1555 | ;; 230-use DNS to resolve hostnames and get an error message like | |
1556 | ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be... | |
1557 | ((string-match ange-ftp-multi-msgs line) | |
1558 | (setq ange-ftp-process-multi-skip t)) | |
92482d77 SM |
1559 | ((string-match ange-ftp-potential-error-msgs line) |
1560 | ;; This looks like an error, but we have to keep reading the output | |
1561 | ;; to see if it was fixed or not. E.g. it may indicate that IPv6 | |
1562 | ;; failed, but maybe a subsequent IPv4 fallback succeeded. | |
1563 | (set (make-local-variable 'ange-ftp-pending-error-line) line) | |
1564 | t) | |
8749abea GM |
1565 | ((string-match ange-ftp-fatal-msgs line) |
1566 | (delete-process proc) | |
1567 | (setq ange-ftp-process-busy nil | |
1568 | ange-ftp-process-result-line line)) | |
92482d77 | 1569 | (ange-ftp-process-multi-skip |
8749abea GM |
1570 | t) |
1571 | (t | |
1572 | (setq ange-ftp-process-busy nil | |
1573 | ange-ftp-process-result-line line)))) | |
1574 | ||
1575 | (defun ange-ftp-set-xfer-size (host user bytes) | |
1576 | "Set the size of the next FTP transfer in bytes." | |
1577 | (let ((proc (ange-ftp-get-process host user))) | |
4671dba5 JB |
1578 | (when proc |
1579 | (let ((buf (process-buffer proc))) | |
1580 | (when buf | |
1581 | (with-current-buffer buf | |
1582 | (setq ange-ftp-xfer-size | |
1583 | ;; For very large files, BYTES can be a float. | |
1584 | (if (integerp bytes) | |
1585 | (ash bytes -10) | |
1586 | (/ bytes 1024))))))))) | |
1587 | ||
1588 | (defun ange-ftp-process-handle-hash (string) | |
8749abea | 1589 | "Remove hash marks from STRING and display count so far." |
4671dba5 JB |
1590 | (setq string (concat (substring string 0 (match-beginning 0)) |
1591 | (substring string (match-end 0))) | |
8749abea GM |
1592 | ange-ftp-hash-mark-count (+ (- (match-end 0) |
1593 | (match-beginning 0)) | |
1594 | ange-ftp-hash-mark-count)) | |
1595 | (and ange-ftp-hash-mark-unit | |
1596 | ange-ftp-process-msg | |
1597 | ange-ftp-process-verbose | |
1598 | (not (eq (selected-window) (minibuffer-window))) | |
1599 | (not (boundp 'search-message)) ;screws up isearch otherwise | |
1600 | (not cursor-in-echo-area) ;screws up y-or-n-p otherwise | |
1601 | (let ((kbytes (ash (* ange-ftp-hash-mark-unit | |
1602 | ange-ftp-hash-mark-count) | |
1603 | -6))) | |
6e85ef5f SM |
1604 | (if (zerop ange-ftp-xfer-size) |
1605 | (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes) | |
1606 | (let ((percent (/ (* 100 kbytes) ange-ftp-xfer-size))) | |
1607 | ;; cut out the redisplay of identical %-age messages. | |
1608 | (unless (eq percent ange-ftp-last-percent) | |
1609 | (setq ange-ftp-last-percent percent) | |
1610 | (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent)))))) | |
4671dba5 | 1611 | string) |
8749abea GM |
1612 | |
1613 | ;; Call the function specified by CONT. CONT can be either a function | |
1614 | ;; or a list of a function and some args. The first two parameters | |
1615 | ;; passed to the function will be RESULT and LINE. The remaining args | |
1616 | ;; will be taken from CONT if a list was passed. | |
1617 | ||
1618 | (defun ange-ftp-call-cont (cont result line) | |
4671dba5 JB |
1619 | (when cont |
1620 | (if (and (listp cont) | |
1621 | (not (eq (car cont) 'lambda))) | |
1622 | (apply (car cont) result line (cdr cont)) | |
1623 | (funcall cont result line)))) | |
8749abea GM |
1624 | |
1625 | ;; Build up a complete line of output from the ftp PROCESS and pass it | |
1626 | ;; on to ange-ftp-process-handle-line to deal with. | |
1627 | ||
1628 | (defun ange-ftp-process-filter (proc str) | |
503ac8a4 SM |
1629 | ;; Eliminate nulls. |
1630 | (while (string-match "\000+" str) | |
1631 | (setq str (replace-match "" nil nil str))) | |
1632 | ||
1633 | ;; see if the buffer is still around... it could have been deleted. | |
1634 | (when (buffer-live-p (process-buffer proc)) | |
1635 | (with-current-buffer (process-buffer proc) | |
1636 | ||
1637 | ;; handle hash mark printing | |
1638 | (and ange-ftp-process-busy | |
1639 | (string-match "^#+$" str) | |
1640 | (setq str (ange-ftp-process-handle-hash str))) | |
1641 | (comint-output-filter proc str) | |
1642 | ;; Replace STR by the result of the comint processing. | |
1643 | (setq str (buffer-substring comint-last-output-start | |
1644 | (process-mark proc))) | |
4671dba5 JB |
1645 | (when ange-ftp-process-busy |
1646 | (setq ange-ftp-process-string (concat ange-ftp-process-string | |
1647 | str)) | |
1648 | ||
1649 | ;; if we gave an empty password to the USER command earlier | |
1650 | ;; then we should send a null password now. | |
1651 | (if (string-match "Password: *$" ange-ftp-process-string) | |
1652 | (process-send-string proc "\n"))) | |
503ac8a4 SM |
1653 | (while (and ange-ftp-process-busy |
1654 | (string-match "\n" ange-ftp-process-string)) | |
1655 | (let ((line (substring ange-ftp-process-string | |
1656 | 0 | |
1657 | (match-beginning 0))) | |
1658 | (seen-prompt nil)) | |
1659 | (setq ange-ftp-process-string (substring ange-ftp-process-string | |
1660 | (match-end 0))) | |
1661 | (while (string-match "\\`ftp> *" line) | |
1662 | (setq seen-prompt t) | |
1663 | (setq line (substring line (match-end 0)))) | |
1664 | (if (not (and seen-prompt ange-ftp-pending-error-line)) | |
1665 | (ange-ftp-process-handle-line line proc) | |
1666 | ;; If we've seen a potential error message and it | |
1667 | ;; hasn't been cancelled by a good message before | |
1668 | ;; seeing a propt, then the error was real. | |
1669 | (delete-process proc) | |
1670 | (setq ange-ftp-process-busy nil | |
1671 | ange-ftp-process-result-line ange-ftp-pending-error-line)))) | |
1672 | ||
1673 | ;; has the ftp client finished? if so then do some clean-up | |
1674 | ;; actions. | |
4671dba5 JB |
1675 | (unless ange-ftp-process-busy |
1676 | ;; reset the xfer size | |
1677 | (setq ange-ftp-xfer-size 0) | |
1678 | ||
1679 | ;; issue the "done" message since we've finished. | |
1680 | (when (and ange-ftp-process-msg | |
1681 | ange-ftp-process-verbose | |
1682 | ange-ftp-process-result) | |
1683 | (ange-ftp-message "%s...done" ange-ftp-process-msg) | |
1684 | (ange-ftp-repaint-minibuffer) | |
1685 | (setq ange-ftp-process-msg nil)) | |
1686 | ||
1687 | ;; is there a continuation we should be calling? if so, | |
1688 | ;; we'd better call it, making sure we only call it once. | |
1689 | (when ange-ftp-process-continue | |
1690 | (let ((cont ange-ftp-process-continue)) | |
1691 | (setq ange-ftp-process-continue nil) | |
1692 | (ange-ftp-call-cont cont | |
1693 | ange-ftp-process-result | |
1694 | ange-ftp-process-result-line))))))) | |
8749abea GM |
1695 | |
1696 | (defun ange-ftp-process-sentinel (proc str) | |
4671dba5 | 1697 | "When FTP process changes state, nuke all file-entries in cache." |
8749abea | 1698 | (let ((name (process-name proc))) |
4671dba5 JB |
1699 | (when (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name) |
1700 | (let ((user (match-string 1 name)) | |
1701 | (host (match-string 2 name))) | |
1702 | (ange-ftp-wipe-file-entries host user)))) | |
8749abea GM |
1703 | (setq ange-ftp-ls-cache-file nil)) |
1704 | \f | |
1705 | ;;;; ------------------------------------------------------------ | |
1706 | ;;;; Gateway support. | |
1707 | ;;;; ------------------------------------------------------------ | |
1708 | ||
1709 | (defun ange-ftp-use-gateway-p (host) | |
4671dba5 | 1710 | "Return whether to access this HOST via a normal (non-smart) gateway." |
8749abea GM |
1711 | ;; yes, I know that I could simplify the following expression, but it is |
1712 | ;; clearer (to me at least) this way. | |
1713 | (and (not ange-ftp-smart-gateway) | |
4671dba5 | 1714 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
8749abea GM |
1715 | |
1716 | (defun ange-ftp-use-smart-gateway-p (host) | |
4671dba5 | 1717 | "Returns whether to access this HOST via a smart gateway." |
8749abea | 1718 | (and ange-ftp-smart-gateway |
4671dba5 | 1719 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
8749abea GM |
1720 | |
1721 | \f | |
1722 | ;;; ------------------------------------------------------------ | |
1723 | ;;; Temporary file location and deletion... | |
1724 | ;;; ------------------------------------------------------------ | |
1725 | ||
8982b231 | 1726 | (defun ange-ftp-make-tmp-name (host &optional suffix) |
8749abea GM |
1727 | "This routine will return the name of a new file." |
1728 | (make-temp-file (if (ange-ftp-use-gateway-p host) | |
6e85ef5f | 1729 | ange-ftp-gateway-tmp-name-template |
8982b231 KY |
1730 | ange-ftp-tmp-name-template) |
1731 | nil suffix)) | |
8749abea | 1732 | |
66bdc868 MA |
1733 | (defun ange-ftp-del-tmp-name (filename) |
1734 | "Force to delete temporary file." | |
f1a5d776 | 1735 | (delete-file filename)) |
66bdc868 | 1736 | |
8749abea GM |
1737 | \f |
1738 | ;;;; ------------------------------------------------------------ | |
1739 | ;;;; Interactive gateway program support. | |
1740 | ;;;; ------------------------------------------------------------ | |
1741 | ||
1742 | (defvar ange-ftp-gwp-running t) | |
1743 | (defvar ange-ftp-gwp-status nil) | |
1744 | ||
1745 | (defun ange-ftp-gwp-sentinel (proc str) | |
1746 | (setq ange-ftp-gwp-running nil)) | |
1747 | ||
1748 | (defun ange-ftp-gwp-filter (proc str) | |
1749 | (comint-output-filter proc str) | |
b63f6e81 | 1750 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1751 | ;; Replace STR by the result of the comint processing. |
1752 | (setq str (buffer-substring comint-last-output-start (process-mark proc)))) | |
1753 | (cond ((string-match "login: *$" str) | |
ff660307 JB |
1754 | (process-send-string proc |
1755 | (concat | |
1756 | (let ((ange-ftp-default-user t)) | |
1757 | (ange-ftp-get-user ange-ftp-gateway-host)) | |
1758 | "\n"))) | |
8749abea | 1759 | ((string-match "Password: *$" str) |
ff660307 JB |
1760 | (process-send-string proc |
1761 | (concat | |
1762 | (ange-ftp-get-passwd ange-ftp-gateway-host | |
1763 | (ange-ftp-get-user | |
1764 | ange-ftp-gateway-host)) | |
1765 | "\n"))) | |
8749abea GM |
1766 | ((string-match ange-ftp-gateway-fatal-msgs str) |
1767 | (delete-process proc) | |
1768 | (setq ange-ftp-gwp-running nil)) | |
1769 | ((string-match ange-ftp-gateway-prompt-pattern str) | |
1770 | (setq ange-ftp-gwp-running nil | |
1771 | ange-ftp-gwp-status t)))) | |
1772 | ||
1773 | (defun ange-ftp-gwp-start (host user name args) | |
4671dba5 JB |
1774 | "Login to the gateway machine and fire up an FTP process." |
1775 | (let (;; It would be nice to make process-connection-type nil, | |
1776 | ;; but that doesn't work: ftp never responds. | |
1777 | ;; Can anyone find a fix for that? | |
1778 | (proc (let ((process-connection-type t)) | |
1779 | (start-process name name | |
1780 | ange-ftp-gateway-program | |
1781 | ange-ftp-gateway-host))) | |
1782 | (ftp (mapconcat 'identity args " "))) | |
260763db | 1783 | (set-process-query-on-exit-flag proc nil) |
e3441f42 SM |
1784 | (set-process-sentinel proc 'ange-ftp-gwp-sentinel) |
1785 | (set-process-filter proc 'ange-ftp-gwp-filter) | |
3bd1644e | 1786 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1787 | (goto-char (point-max)) |
1788 | (set-marker (process-mark proc) (point))) | |
1789 | (setq ange-ftp-gwp-running t | |
1790 | ange-ftp-gwp-status nil) | |
1791 | (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host) | |
1792 | (while ange-ftp-gwp-running ;perform login sequence | |
1793 | (accept-process-output proc)) | |
4671dba5 JB |
1794 | (unless ange-ftp-gwp-status |
1795 | (ange-ftp-error host user "unable to login to gateway")) | |
8749abea GM |
1796 | (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host) |
1797 | (setq ange-ftp-gwp-running t | |
1798 | ange-ftp-gwp-status nil) | |
1799 | (process-send-string proc ange-ftp-gateway-setup-term-command) | |
1800 | (while ange-ftp-gwp-running ;zap ^M's and double echoing. | |
1801 | (accept-process-output proc)) | |
4671dba5 JB |
1802 | (unless ange-ftp-gwp-status |
1803 | (ange-ftp-error host user "unable to set terminal modes on gateway")) | |
8749abea GM |
1804 | (setq ange-ftp-gwp-running t |
1805 | ange-ftp-gwp-status nil) | |
1806 | (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process | |
1807 | proc)) | |
1808 | \f | |
1809 | ;;;; ------------------------------------------------------------ | |
1810 | ;;;; Support for sending commands to the ftp process. | |
1811 | ;;;; ------------------------------------------------------------ | |
1812 | ||
1813 | (defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait) | |
4671dba5 | 1814 | "Low-level routine to send the given FTP CMD to the FTP process PROC. |
8749abea | 1815 | MSG is an optional message to output before and after the command. |
25759a92 | 1816 | If CONT is non-nil then it is either a function or a list of function |
4671dba5 | 1817 | and some arguments. The function will be called when the FTP command |
25759a92 | 1818 | has completed. |
4671dba5 | 1819 | If CONT is nil then this routine will return (RESULT . LINE) where RESULT |
8749abea GM |
1820 | is whether the command was successful, and LINE is the line from the FTP |
1821 | process that caused the command to complete. | |
1822 | If NOWAIT is given then the routine will return immediately the command has | |
1823 | been queued with no result. CONT will still be called, however." | |
1824 | (if (memq (process-status proc) '(run open)) | |
67f300f8 | 1825 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1826 | (ange-ftp-wait-not-busy proc) |
1827 | (setq ange-ftp-process-string "" | |
1828 | ange-ftp-process-result-line "" | |
1829 | ange-ftp-process-busy t | |
1830 | ange-ftp-process-result nil | |
1831 | ange-ftp-process-multi-skip nil | |
1832 | ange-ftp-process-msg msg | |
1833 | ange-ftp-process-continue cont | |
1834 | ange-ftp-hash-mark-count 0 | |
1835 | ange-ftp-last-percent -1 | |
1836 | cmd (concat cmd "\n")) | |
1837 | (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg)) | |
1838 | (goto-char (point-max)) | |
1839 | (move-marker comint-last-input-start (point)) | |
1840 | ;; don't insert the password into the buffer on the USER command. | |
1841 | (save-match-data | |
aa6f7b96 | 1842 | (if (string-match "\\`user \"[^\"]*\"" cmd) |
8749abea GM |
1843 | (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n") |
1844 | (insert cmd))) | |
1845 | (move-marker comint-last-input-end (point)) | |
ff660307 | 1846 | (process-send-string proc cmd) |
8749abea GM |
1847 | (set-marker (process-mark proc) (point)) |
1848 | (if nowait | |
1849 | nil | |
1850 | (ange-ftp-wait-not-busy proc) | |
1851 | (if cont | |
1852 | nil ;cont has already been called | |
1853 | (cons ange-ftp-process-result ange-ftp-process-result-line)))))) | |
1854 | ||
1855 | ;; Wait for the ange-ftp process PROC not to be busy. | |
1856 | (defun ange-ftp-wait-not-busy (proc) | |
67f300f8 | 1857 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1858 | (condition-case nil |
1859 | ;; This is a kludge to let user quit in case ftp gets hung. | |
1860 | ;; It matters because this function can be called from the filter. | |
1861 | ;; It is bad to allow quitting in a filter, but getting hung | |
1862 | ;; is worse. By binding quit-flag to nil, we might avoid | |
1863 | ;; most of the probability of getting screwed because the user | |
1864 | ;; wants to quit some command. | |
1865 | (let ((quit-flag nil) | |
1866 | (inhibit-quit nil)) | |
1867 | (while ange-ftp-process-busy | |
1868 | (accept-process-output proc))) | |
1869 | (quit | |
1870 | ;; If the user does quit out of this, | |
1871 | ;; kill the process. That stops any transfer in progress. | |
1872 | ;; The next operation will open a new ftp connection. | |
1873 | (delete-process proc) | |
1874 | (signal 'quit nil))))) | |
1875 | ||
4671dba5 | 1876 | (defun ange-ftp-nslookup-host (hostname) |
8749abea GM |
1877 | "Attempt to resolve the given HOSTNAME using nslookup if possible." |
1878 | (interactive "sHost: ") | |
1879 | (if ange-ftp-nslookup-program | |
1880 | (let ((default-directory | |
1881 | (if (file-accessible-directory-p default-directory) | |
1882 | default-directory | |
1883 | exec-directory)) | |
1884 | ;; It would be nice to make process-connection-type nil, | |
1885 | ;; but that doesn't work: ftp never responds. | |
1886 | ;; Can anyone find a fix for that? | |
1887 | (proc (let ((process-connection-type t)) | |
1888 | (start-process " *nslookup*" " *nslookup*" | |
4671dba5 JB |
1889 | ange-ftp-nslookup-program hostname))) |
1890 | (res hostname)) | |
260763db | 1891 | (set-process-query-on-exit-flag proc nil) |
b63f6e81 | 1892 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1893 | (while (memq (process-status proc) '(run open)) |
1894 | (accept-process-output proc)) | |
1895 | (goto-char (point-min)) | |
1896 | (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t) | |
e3441f42 | 1897 | (setq res (match-string 1))) |
8749abea GM |
1898 | (kill-buffer (current-buffer))) |
1899 | res) | |
4671dba5 | 1900 | hostname)) |
8749abea GM |
1901 | |
1902 | (defun ange-ftp-start-process (host user name) | |
4671dba5 JB |
1903 | "Spawn a new FTP process ready to connect to machine HOST and give it NAME. |
1904 | If HOST is only FTP-able through a gateway machine then spawn a shell | |
1905 | on the gateway machine to do the FTP instead." | |
8749abea GM |
1906 | (let* ((use-gateway (ange-ftp-use-gateway-p host)) |
1907 | (use-smart-ftp (and (not ange-ftp-gateway-host) | |
1908 | (ange-ftp-use-smart-gateway-p host))) | |
1909 | (ftp-prog (if (or use-gateway | |
25759a92 | 1910 | use-smart-ftp) |
8749abea GM |
1911 | ange-ftp-gateway-ftp-program-name |
1912 | ange-ftp-ftp-program-name)) | |
1913 | (args (append (list ftp-prog) ange-ftp-ftp-program-args)) | |
1914 | ;; Without the following binding, ange-ftp-start-process | |
1915 | ;; recurses on file-accessible-directory-p, since it needs to | |
1916 | ;; restart its process in order to determine anything about | |
1917 | ;; default-directory. | |
1918 | (file-name-handler-alist) | |
1919 | (default-directory | |
1920 | (if (file-accessible-directory-p default-directory) | |
1921 | default-directory | |
1922 | exec-directory)) | |
1923 | proc) | |
1924 | ;; It would be nice to make process-connection-type nil, | |
1925 | ;; but that doesn't work: ftp never responds. | |
1926 | ;; Can anyone find a fix for that? | |
1927 | (let ((process-connection-type t) | |
5da64060 RS |
1928 | ;; Copy this so we don't alter it permanently. |
1929 | (process-environment (copy-tree process-environment)) | |
8749abea | 1930 | (buffer (get-buffer-create name))) |
b63f6e81 | 1931 | (with-current-buffer buffer |
8749abea GM |
1932 | (internal-ange-ftp-mode)) |
1933 | ;; This tells GNU ftp not to output any fancy escape sequences. | |
1934 | (setenv "TERM" "dumb") | |
1935 | (if use-gateway | |
1936 | (if ange-ftp-gateway-program-interactive | |
1937 | (setq proc (ange-ftp-gwp-start host user name args)) | |
1938 | (setq proc (apply 'start-process name name | |
1939 | (append (list ange-ftp-gateway-program | |
1940 | ange-ftp-gateway-host) | |
1941 | args)))) | |
1942 | (setq proc (apply 'start-process name name args)))) | |
b63f6e81 | 1943 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1944 | (goto-char (point-max)) |
1945 | (set-marker (process-mark proc) (point))) | |
260763db | 1946 | (set-process-query-on-exit-flag proc nil) |
e3441f42 SM |
1947 | (set-process-sentinel proc 'ange-ftp-process-sentinel) |
1948 | (set-process-filter proc 'ange-ftp-process-filter) | |
8749abea GM |
1949 | ;; On Windows, the standard ftp client buffers its output (because |
1950 | ;; stdout is a pipe handle) so the startup message may never appear: | |
1951 | ;; `accept-process-output' at this point would hang indefinitely. | |
1952 | ;; However, sending an innocuous command ("help foo") forces some | |
1953 | ;; output that will be ignored, which is just as good. Once we | |
1954 | ;; start sending normal commands, the output no longer appears to be | |
1955 | ;; buffered, and everything works correctly. My guess is that the | |
1956 | ;; output of interest is being sent to stderr which is not buffered. | |
1957 | (when (eq system-type 'windows-nt) | |
1958 | ;; force ftp output to be treated as DOS text, otherwise the | |
1959 | ;; output of "help foo" confuses the EOL detection logic. | |
1960 | (set-process-coding-system proc 'raw-text-dos) | |
1961 | (process-send-string proc "help foo\n")) | |
1962 | (accept-process-output proc) ;wait for ftp startup message | |
1963 | proc)) | |
1964 | ||
844f7784 | 1965 | (define-derived-mode internal-ange-ftp-mode comint-mode "Internal Ange-ftp" |
8749abea GM |
1966 | "Major mode for interacting with the FTP process. |
1967 | ||
1968 | \\{comint-mode-map}" | |
ccedb10b LK |
1969 | (make-local-variable 'ange-ftp-process-string) |
1970 | (setq ange-ftp-process-string "") | |
1971 | (make-local-variable 'ange-ftp-process-busy) | |
1972 | (make-local-variable 'ange-ftp-process-result) | |
1973 | (make-local-variable 'ange-ftp-process-msg) | |
1974 | (make-local-variable 'ange-ftp-process-multi-skip) | |
1975 | (make-local-variable 'ange-ftp-process-result-line) | |
1976 | (make-local-variable 'ange-ftp-process-continue) | |
1977 | (make-local-variable 'ange-ftp-hash-mark-count) | |
1978 | (make-local-variable 'ange-ftp-binary-hash-mark-size) | |
1979 | (make-local-variable 'ange-ftp-ascii-hash-mark-size) | |
1980 | (make-local-variable 'ange-ftp-hash-mark-unit) | |
1981 | (make-local-variable 'ange-ftp-xfer-size) | |
1982 | (make-local-variable 'ange-ftp-last-percent) | |
1983 | (setq ange-ftp-hash-mark-count 0) | |
1984 | (setq ange-ftp-xfer-size 0) | |
1985 | (setq ange-ftp-process-result-line "") | |
1986 | (setq comint-prompt-regexp "^ftp> ") | |
1987 | (make-local-variable 'comint-password-prompt-regexp) | |
1988 | ;; This is a regexp that can't match anything. | |
1989 | ;; ange-ftp has its own ways of handling passwords. | |
92482d77 | 1990 | (setq comint-password-prompt-regexp "\\`a\\`") |
ccedb10b | 1991 | (make-local-variable 'paragraph-start) |
844f7784 | 1992 | (setq paragraph-start comint-prompt-regexp)) |
8749abea | 1993 | |
9c35d706 | 1994 | (defcustom ange-ftp-raw-login nil |
4671dba5 JB |
1995 | "Use raw FTP commands for login, if account password is not nil. |
1996 | Some FTP implementations need this, e.g. ftp in NT 4.0." | |
9c35d706 RS |
1997 | :group 'ange-ftp |
1998 | :version "21.3" | |
1999 | :type 'boolean) | |
2000 | ||
4671dba5 | 2001 | (defun ange-ftp-smart-login (host user password account proc) |
8749abea GM |
2002 | "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT. |
2003 | PROC is the FTP-client's process. This routine uses the smart-gateway | |
25759a92 | 2004 | host specified in `ange-ftp-gateway-host'." |
8749abea GM |
2005 | (let ((result (ange-ftp-raw-send-cmd |
2006 | proc | |
2007 | (format "open %s %s" | |
2008 | (ange-ftp-nslookup-host ange-ftp-gateway-host) | |
2009 | ange-ftp-smart-gateway-port) | |
2010 | (format "Opening FTP connection to %s via %s" | |
2011 | host | |
2012 | ange-ftp-gateway-host)))) | |
2013 | (or (car result) | |
25759a92 | 2014 | (ange-ftp-error host user |
8749abea GM |
2015 | (concat "OPEN request failed: " |
2016 | (cdr result)))) | |
2017 | (setq result (ange-ftp-raw-send-cmd | |
2018 | proc (format "user \"%s\"@%s %s %s" | |
2019 | user | |
2020 | (ange-ftp-nslookup-host host) | |
4671dba5 | 2021 | password |
8749abea GM |
2022 | account) |
2023 | (format "Logging in as user %s@%s" | |
2024 | user host))) | |
2025 | (or (car result) | |
2026 | (progn | |
2027 | (ange-ftp-set-passwd host user nil) ; reset password | |
2028 | (ange-ftp-set-account host user nil) ; reset account | |
2029 | (ange-ftp-error host user | |
2030 | (concat "USER request failed: " | |
2031 | (cdr result))))))) | |
2032 | ||
4671dba5 | 2033 | (defun ange-ftp-normal-login (host user password account proc) |
8749abea GM |
2034 | "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT. |
2035 | PROC is the process to the FTP-client. HOST may have an optional | |
4671dba5 | 2036 | suffix of the form #PORT to specify a non-default port." |
8749abea | 2037 | (save-match-data |
aa6f7b96 | 2038 | (string-match "\\`\\([^#]+\\)\\(#\\([0-9]+\\)\\)?\\'" host) |
8749abea GM |
2039 | (let* ((nshost (ange-ftp-nslookup-host (match-string 1 host))) |
2040 | (port (match-string 3 host)) | |
2041 | (result (ange-ftp-raw-send-cmd | |
2042 | proc | |
2043 | (if port | |
2044 | (format "open %s %s" nshost port) | |
2045 | (format "open %s" nshost)) | |
2046 | (format "Opening FTP connection to %s" host)))) | |
2047 | (or (car result) | |
2048 | (ange-ftp-error host user | |
2049 | (concat "OPEN request failed: " | |
2050 | (cdr result)))) | |
9c35d706 RS |
2051 | (if (not (and ange-ftp-raw-login (string< "" account))) |
2052 | (setq result (ange-ftp-raw-send-cmd | |
2053 | proc | |
2054 | (if (and (ange-ftp-use-smart-gateway-p host) | |
2055 | ange-ftp-gateway-host) | |
2056 | (format "user \"%s\"@%s %s %s" | |
4671dba5 JB |
2057 | user nshost password account) |
2058 | (format "user \"%s\" %s %s" user password account)) | |
9c35d706 RS |
2059 | (format "Logging in as user %s@%s" user host))) |
2060 | (let ((good ange-ftp-good-msgs) | |
2061 | (skip ange-ftp-skip-msgs)) | |
2062 | (setq ange-ftp-good-msgs (concat ange-ftp-good-msgs | |
2063 | "\\|^331 \\|^332 ")) | |
2064 | (if (string-match (regexp-quote "\\|^331 ") ange-ftp-skip-msgs) | |
2065 | (setq ange-ftp-skip-msgs | |
2066 | (replace-match "" t t ange-ftp-skip-msgs))) | |
2067 | (if (string-match (regexp-quote "\\|^332 ") ange-ftp-skip-msgs) | |
2068 | (setq ange-ftp-skip-msgs | |
2069 | (replace-match "" t t ange-ftp-skip-msgs))) | |
2070 | (setq result (ange-ftp-raw-send-cmd | |
2071 | proc | |
2072 | (format "quote \"USER %s\"" user) | |
2073 | (format "Logging in as user %s@%s" user host))) | |
2074 | (and (car result) | |
2075 | (setq result (ange-ftp-raw-send-cmd | |
2076 | proc | |
4671dba5 | 2077 | (format "quote \"PASS %s\"" password) |
9c35d706 RS |
2078 | (format "Logging in as user %s@%s" user host))) |
2079 | (and (car result) | |
2080 | (setq result (ange-ftp-raw-send-cmd | |
2081 | proc | |
2082 | (format "quote \"ACCT %s\"" account) | |
2083 | (format "Logging in as user %s@%s" user host))) | |
2084 | )) | |
2085 | (setq ange-ftp-good-msgs good | |
2086 | ange-ftp-skip-msgs skip))) | |
8749abea GM |
2087 | (or (car result) |
2088 | (progn | |
e3441f42 | 2089 | (ange-ftp-set-passwd host user nil) ;reset password. |
8749abea GM |
2090 | (ange-ftp-set-account host user nil) ;reset account. |
2091 | (ange-ftp-error host user | |
2092 | (concat "USER request failed: " | |
2093 | (cdr result)))))))) | |
2094 | ||
2095 | ;; ange@hplb.hpl.hp.com says this should not be changed. | |
2096 | (defvar ange-ftp-hash-mark-msgs | |
2097 | "[hH]ash mark [^0-9]*\\([0-9]+\\)" | |
2098 | "*Regexp matching the FTP client's output upon doing a HASH command.") | |
2099 | ||
2100 | (defun ange-ftp-guess-hash-mark-size (proc) | |
2101 | (if ange-ftp-send-hash | |
b63f6e81 | 2102 | (with-current-buffer (process-buffer proc) |
8749abea | 2103 | (let* ((status (ange-ftp-raw-send-cmd proc "hash")) |
8749abea GM |
2104 | (line (cdr status))) |
2105 | (save-match-data | |
2106 | (if (string-match ange-ftp-hash-mark-msgs line) | |
027a4b6b | 2107 | (let ((size (string-to-number (match-string 1 line)))) |
8749abea GM |
2108 | (setq ange-ftp-ascii-hash-mark-size size |
2109 | ange-ftp-hash-mark-unit (ash size -4)) | |
2110 | ||
2111 | ;; if a default value for this is set, use that value. | |
2112 | (or ange-ftp-binary-hash-mark-size | |
2113 | (setq ange-ftp-binary-hash-mark-size size))))))))) | |
2114 | ||
aa6f7b96 SM |
2115 | (defvar ange-ftp-process-startup-hook nil) |
2116 | ||
8749abea GM |
2117 | (defun ange-ftp-get-process (host user) |
2118 | "Return an FTP subprocess connected to HOST and logged in as USER. | |
2119 | Create a new process if needed." | |
2120 | (let* ((name (ange-ftp-ftp-process-buffer host user)) | |
2121 | (proc (get-process name))) | |
2122 | (if (and proc (memq (process-status proc) '(run open))) | |
2123 | proc | |
2124 | ;; Must delete dead process so that new process can reuse the name. | |
2125 | (if proc (delete-process proc)) | |
2126 | (let ((pass (ange-ftp-quote-string | |
2127 | (ange-ftp-get-passwd host user))) | |
2128 | (account (ange-ftp-quote-string | |
2129 | (ange-ftp-get-account host user)))) | |
2130 | ;; grab a suitable process. | |
2131 | (setq proc (ange-ftp-start-process host user name)) | |
25759a92 | 2132 | |
8749abea GM |
2133 | ;; login to FTP server. |
2134 | (if (and (ange-ftp-use-smart-gateway-p host) | |
2135 | ange-ftp-gateway-host) | |
2136 | (ange-ftp-smart-login host user pass account proc) | |
2137 | (ange-ftp-normal-login host user pass account proc)) | |
25759a92 | 2138 | |
8749abea GM |
2139 | ;; Tell client to send back hash-marks as progress. It isn't usually |
2140 | ;; fatal if this command fails. | |
2141 | (ange-ftp-guess-hash-mark-size proc) | |
2142 | ||
2143 | ;; Guess at the host type. | |
2144 | (ange-ftp-guess-host-type host user) | |
2145 | ||
1d0653f8 RS |
2146 | ;; Turn passive mode on or off as requested. |
2147 | (let* ((case-fold-search t) | |
2148 | (passive | |
2149 | (or (assoc-default host ange-ftp-passive-host-alist | |
2150 | 'string-match) | |
2151 | (if ange-ftp-try-passive-mode "on")))) | |
2152 | (if passive | |
31bcb0dc | 2153 | (ange-ftp-passive-mode proc passive))) |
8749abea GM |
2154 | |
2155 | ;; Run any user-specified hooks. Note that proc, host and user are | |
2156 | ;; dynamically bound at this point. | |
e3441f42 SM |
2157 | (let ((ange-ftp-this-user user) |
2158 | (ange-ftp-this-host host)) | |
2159 | (run-hooks 'ange-ftp-process-startup-hook))) | |
8749abea GM |
2160 | proc))) |
2161 | ||
31bcb0dc | 2162 | (defun ange-ftp-passive-mode (proc on-or-off) |
1d0653f8 RS |
2163 | (if (string-match (concat "Passive mode " on-or-off) |
2164 | (cdr (ange-ftp-raw-send-cmd | |
2165 | proc (concat "passive " on-or-off) | |
2166 | "Trying passive mode..." nil))) | |
2167 | (ange-ftp-message (concat "Trying passive mode..." on-or-off)) | |
2168 | (error "Trying passive mode...failed"))) | |
2169 | ||
8749abea GM |
2170 | ;; Variables for caching host and host-type |
2171 | (defvar ange-ftp-host-cache nil) | |
2172 | (defvar ange-ftp-host-type-cache nil) | |
2173 | ||
2174 | ;; If ange-ftp-host-type is called with the optional user | |
2175 | ;; argument, it will attempt to guess the host type by connecting | |
2176 | ;; as user, if necessary. For efficiency, I have tried to give this | |
2177 | ;; optional second argument only when necessary. Have I missed any calls | |
2178 | ;; to ange-ftp-host-type where it should have been supplied? | |
2179 | ||
2180 | (defun ange-ftp-host-type (host &optional user) | |
2181 | "Return a symbol which represents the type of the HOST given. | |
2182 | If the optional argument USER is given, attempts to guess the | |
2183 | host-type by logging in as USER." | |
2184 | (cond ((null host) 'unix) | |
2185 | ;; Return `unix' if HOST is nil, since that's the most vanilla | |
2186 | ;; possible return value. | |
2187 | ((eq host ange-ftp-host-cache) | |
2188 | ange-ftp-host-type-cache) | |
2189 | ;; Trigger an ftp connection, in case we need to guess at the host type. | |
2190 | ((and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache)) | |
2191 | ange-ftp-host-type-cache) | |
2192 | (t | |
2193 | (setq ange-ftp-host-cache host | |
2194 | ange-ftp-host-type-cache | |
2195 | (cond ((ange-ftp-dumb-unix-host host) | |
2196 | 'dumb-unix) | |
2197 | ;; ((and (fboundp 'ange-ftp-vos-host) | |
2198 | ;; (ange-ftp-vos-host host)) | |
2199 | ;; 'vos) | |
2200 | ((and (fboundp 'ange-ftp-vms-host) | |
2201 | (ange-ftp-vms-host host)) | |
2202 | 'vms) | |
2203 | ((and (fboundp 'ange-ftp-mts-host) | |
2204 | (ange-ftp-mts-host host)) | |
2205 | 'mts) | |
2206 | ((and (fboundp 'ange-ftp-cms-host) | |
2207 | (ange-ftp-cms-host host)) | |
2208 | 'cms) | |
9c35d706 RS |
2209 | ((and (fboundp 'ange-ftp-bs2000-posix-host) |
2210 | (ange-ftp-bs2000-posix-host host)) | |
2211 | 'text-unix) ; POSIX is a non-ASCII Unix | |
2212 | ((and (fboundp 'ange-ftp-bs2000-host) | |
2213 | (ange-ftp-bs2000-host host)) | |
2214 | 'bs2000) | |
8749abea GM |
2215 | (t |
2216 | 'unix)))))) | |
2217 | ||
2218 | ;; It would be nice to abstract the functions ange-ftp-TYPE-host and | |
2219 | ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions | |
2220 | ;; without sacrificing speed. Also, having separate variables | |
2221 | ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to | |
2222 | ;; set an alist to indicate that a host is of a given type. Even with | |
2223 | ;; automatic host type recognition, setting a regexp is still a good idea | |
2224 | ;; (for efficiency) if you log into a particular non-UNIX host frequently. | |
2225 | ||
2226 | (defvar ange-ftp-fix-name-func-alist nil | |
2227 | "Alist saying how to convert file name to the host's syntax. | |
4671dba5 JB |
2228 | Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can |
2229 | change a UNIX file name into a name more suitable for a host of type TYPE.") | |
8749abea GM |
2230 | |
2231 | (defvar ange-ftp-fix-dir-name-func-alist nil | |
2232 | "Alist saying how to convert directory name to the host's syntax. | |
4671dba5 JB |
2233 | Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can |
2234 | change UNIX directory name into a directory name more suitable for a host | |
2235 | of type TYPE.") | |
8749abea GM |
2236 | |
2237 | ;; *** Perhaps the sense of this variable should be inverted, since there | |
2238 | ;; *** is only 1 host type that can take ls-style listing options. | |
2239 | (defvar ange-ftp-dumb-host-types '(dumb-unix) | |
2240 | "List of host types that can't take UNIX ls-style listing options.") | |
2241 | ||
2242 | (defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait) | |
4671dba5 | 2243 | "Find an FTP process connected to HOST logged in as USER and send it CMD. |
8749abea GM |
2244 | MSG is an optional status message to be output before and after issuing the |
2245 | command. | |
25759a92 | 2246 | See the documentation for `ange-ftp-raw-send-cmd' for a description of CONT |
8749abea GM |
2247 | and NOWAIT." |
2248 | ;; Handle conversion to remote file name syntax and remote ls option | |
2249 | ;; capability. | |
2250 | (let ((cmd0 (car cmd)) | |
2251 | (cmd1 (nth 1 cmd)) | |
2252 | (ange-ftp-this-user user) | |
2253 | (ange-ftp-this-host host) | |
2254 | (ange-ftp-this-msg msg) | |
67f300f8 | 2255 | cmd2 cmd3 host-type fix-name-func result) |
8749abea GM |
2256 | |
2257 | (cond | |
25759a92 | 2258 | |
8749abea GM |
2259 | ;; pwd case (We don't care what host-type.) |
2260 | ((null cmd1)) | |
25759a92 | 2261 | |
8749abea GM |
2262 | ;; cmd == 'dir "remote-name" "local-name" "ls-switches" |
2263 | ((progn | |
2264 | (setq cmd2 (nth 2 cmd) | |
2265 | host-type (ange-ftp-host-type host user)) | |
2266 | ;; This will trigger an FTP login, if one doesn't exist | |
2267 | (eq cmd0 'dir)) | |
2268 | (setq cmd1 (funcall | |
2269 | (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist)) | |
2270 | 'identity) | |
2271 | cmd1) | |
2272 | cmd3 (nth 3 cmd)) | |
ae0bec0b SM |
2273 | ;; Need to deal with the HP-UX ftp bug. This should also allow us to |
2274 | ;; resolve symlinks to directories on SysV machines. (Sebastian will | |
8749abea GM |
2275 | ;; be happy.) |
2276 | (and (eq host-type 'unix) | |
aa6f7b96 | 2277 | (string-match "/\\'" cmd1) |
8749abea GM |
2278 | (not (string-match "R" cmd3)) |
2279 | (setq cmd1 (concat cmd1 "."))) | |
2280 | ||
b63f6e81 SM |
2281 | ;; Using "ls -flags foo" has several problems: |
2282 | ;; - if foo is a symlink, we may get a single line showing the symlink | |
2283 | ;; rather than the listing of the directory it points to. | |
2284 | ;; - if "foo" has spaces, the parsing of the command may be done wrong. | |
2285 | ;; - some version of netbsd's ftpd only accept a single argument after | |
2286 | ;; `ls', which can either be the directory or the flags. | |
2287 | ;; So to work around those problems, we use "cd foo; ls -flags". | |
2288 | ||
8749abea GM |
2289 | ;; If the dir name contains a space, some ftp servers will |
2290 | ;; refuse to list it. We instead change directory to the | |
2291 | ;; directory in question and ls ".". | |
2292 | (when (string-match " " cmd1) | |
67f300f8 SM |
2293 | ;; Keep the result. In case of failure, we will (see below) |
2294 | ;; short-circuit CMD and return this result directly. | |
2295 | (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror)) | |
8749abea GM |
2296 | (setq cmd1 ".")) |
2297 | ||
2298 | ;; If the remote ls can take switches, put them in | |
7ca26b02 SM |
2299 | (unless (memq host-type ange-ftp-dumb-host-types) |
2300 | (setq cmd0 'ls) | |
2301 | ;; We cd and then use `ls' with no directory argument. | |
aa6f7b96 SM |
2302 | ;; This works around a misfeature of some versions of netbsd ftpd |
2303 | ;; where `ls' can only take one argument: either one set of flags | |
2304 | ;; or a file/directory name. | |
3bd1644e | 2305 | ;; If we're trying to `ls' a single file, this fails since we |
aa6f7b96 SM |
2306 | ;; can't cd to a file. We can't fix this problem here, tho, because |
2307 | ;; at this point we don't know whether the argument is a file or | |
3bd1644e | 2308 | ;; a directory. Such an `ls' is only ever used (apparently) from |
aa6f7b96 SM |
2309 | ;; `insert-directory' when the `full-directory-p' argument is nil |
2310 | ;; (which seems to only be used by dired when updating its display | |
3bd1644e SM |
2311 | ;; after operating on a set of files). So we've changed |
2312 | ;; `ange-ftp-insert-directory' such that in this case it gets | |
aa6f7b96 SM |
2313 | ;; a full listing of the directory and extracting the line |
2314 | ;; corresponding to the requested file. | |
7ca26b02 | 2315 | (unless (equal cmd1 ".") |
aa6f7b96 SM |
2316 | (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror))) |
2317 | (setq cmd1 cmd3))) | |
25759a92 | 2318 | |
8749abea GM |
2319 | ;; First argument is the remote name |
2320 | ((progn | |
2321 | (setq fix-name-func (or (cdr (assq host-type | |
2322 | ange-ftp-fix-name-func-alist)) | |
2323 | 'identity)) | |
2324 | (memq cmd0 '(get delete mkdir rmdir cd))) | |
2325 | (setq cmd1 (funcall fix-name-func cmd1))) | |
2326 | ||
2327 | ;; Second argument is the remote name | |
cfc3aed3 | 2328 | ((or (memq cmd0 '(append put chmod)) |
412707c2 | 2329 | (and (eq cmd0 'quote) (member cmd1 '("mdtm" "size")))) |
8749abea | 2330 | (setq cmd2 (funcall fix-name-func cmd2))) |
8749abea GM |
2331 | ;; Both arguments are remote names |
2332 | ((eq cmd0 'rename) | |
2333 | (setq cmd1 (funcall fix-name-func cmd1) | |
2334 | cmd2 (funcall fix-name-func cmd2)))) | |
25759a92 SS |
2335 | |
2336 | ;; Turn the command into one long string | |
8749abea GM |
2337 | (setq cmd0 (symbol-name cmd0)) |
2338 | (setq cmd (concat cmd0 | |
2339 | (and cmd1 (concat " " cmd1)) | |
2340 | (and cmd2 (concat " " cmd2)))) | |
2341 | ||
2342 | ;; Actually send the resulting command. | |
67f300f8 SM |
2343 | (if (and (consp result) (null (car result))) |
2344 | ;; `ange-ftp-cd' has failed, so there's no point sending `cmd'. | |
2345 | result | |
2346 | (let (afsc-result | |
2347 | afsc-line) | |
2348 | (ange-ftp-raw-send-cmd | |
2349 | (ange-ftp-get-process host user) | |
2350 | cmd | |
2351 | msg | |
2352 | (list (lambda (result line host user cmd msg cont nowait) | |
2353 | (or cont (setq afsc-result result | |
2354 | afsc-line line)) | |
2355 | (if result (ange-ftp-call-cont cont result line) | |
25759a92 SS |
2356 | (ange-ftp-raw-send-cmd |
2357 | (ange-ftp-get-process host user) | |
2358 | cmd | |
2359 | msg | |
2360 | (list (lambda (result line cont) | |
2361 | (or cont (setq afsc-result result | |
2362 | afsc-line line)) | |
2363 | (ange-ftp-call-cont cont result line)) | |
67f300f8 SM |
2364 | cont) |
2365 | nowait))) | |
2366 | host user cmd msg cont nowait) | |
2367 | nowait) | |
2368 | ||
2369 | (if nowait | |
8749abea | 2370 | nil |
67f300f8 SM |
2371 | (if cont |
2372 | nil | |
2373 | (cons afsc-result afsc-line))))))) | |
8749abea GM |
2374 | |
2375 | ;; It might be nice to message users about the host type identified, | |
2376 | ;; but there is so much other messaging going on, it would not be | |
2377 | ;; seen. No point in slowing things down just so users can read | |
2378 | ;; a host type message. | |
2379 | ||
2380 | (defconst ange-ftp-cms-name-template | |
2381 | (concat | |
2382 | "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?" | |
2383 | "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$")) | |
2384 | (defconst ange-ftp-vms-name-template | |
2385 | "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$") | |
2386 | (defconst ange-ftp-mts-name-template | |
2387 | "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$") | |
9c35d706 RS |
2388 | (defconst ange-ftp-bs2000-filename-pubset-regexp |
2389 | ":[A-Z0-9]+:" | |
2390 | "Valid pubset for an BS2000 file name.") | |
2391 | (defconst ange-ftp-bs2000-filename-username-regexp | |
2392 | (concat | |
2393 | "\\$[A-Z0-9]*\\.") | |
2394 | "Valid username for an BS2000 file name.") | |
2395 | (defconst ange-ftp-bs2000-filename-prefix-regexp | |
2396 | (concat | |
2397 | ange-ftp-bs2000-filename-pubset-regexp | |
2398 | ange-ftp-bs2000-filename-username-regexp) | |
2399 | "Valid prefix for an BS2000 file name (pubset and user).") | |
2400 | (defconst ange-ftp-bs2000-name-template | |
2401 | (concat "^" ange-ftp-bs2000-filename-prefix-regexp "$")) | |
8749abea GM |
2402 | |
2403 | (defun ange-ftp-guess-host-type (host user) | |
110c171f | 2404 | "Guess the host type of HOST. |
8749abea GM |
2405 | Works by doing a pwd and examining the directory syntax." |
2406 | (let ((host-type (ange-ftp-host-type host)) | |
2407 | (key (concat host "/" user "/~"))) | |
2408 | (if (eq host-type 'unix) | |
2409 | ;; Note that ange-ftp-host-type returns unix as the default value. | |
2410 | (save-match-data | |
2411 | (let* ((result (ange-ftp-get-pwd host user)) | |
2412 | (dir (car result)) | |
2413 | fix-name-func) | |
2414 | (cond ((null dir) | |
2415 | (message "Warning! Unable to get home directory") | |
2416 | (sit-for 1) | |
2417 | (if (string-match | |
2418 | "^450 No current working directory defined$" | |
2419 | (cdr result)) | |
25759a92 | 2420 | |
8749abea GM |
2421 | ;; We'll assume that if pwd bombs with this |
2422 | ;; error message, then it's CMS. | |
2423 | (progn | |
2424 | (ange-ftp-add-cms-host host) | |
2425 | (setq ange-ftp-host-cache host | |
2426 | ange-ftp-host-type-cache 'cms)))) | |
2427 | ||
2428 | ;; try for VMS | |
2429 | ((string-match ange-ftp-vms-name-template dir) | |
2430 | (ange-ftp-add-vms-host host) | |
2431 | ;; The add-host functions clear the host type cache. | |
2432 | ;; Therefore, need to set the cache afterwards. | |
2433 | (setq ange-ftp-host-cache host | |
2434 | ange-ftp-host-type-cache 'vms)) | |
2435 | ||
2436 | ;; try for MTS | |
2437 | ((string-match ange-ftp-mts-name-template dir) | |
2438 | (ange-ftp-add-mts-host host) | |
2439 | (setq ange-ftp-host-cache host | |
2440 | ange-ftp-host-type-cache 'mts)) | |
25759a92 | 2441 | |
8749abea GM |
2442 | ;; try for CMS |
2443 | ((string-match ange-ftp-cms-name-template dir) | |
2444 | (ange-ftp-add-cms-host host) | |
2445 | (setq ange-ftp-host-cache host | |
2446 | ange-ftp-host-type-cache 'cms)) | |
2447 | ||
9c35d706 RS |
2448 | ;; try for BS2000-POSIX |
2449 | ((ange-ftp-bs2000-posix-host host) | |
2450 | (ange-ftp-add-bs2000-host host) | |
2451 | (setq ange-ftp-host-cache host | |
2452 | ange-ftp-host-type-cache 'text-unix)) | |
2453 | ;; try for BS2000 | |
2454 | ((and (string-match ange-ftp-bs2000-name-template dir) | |
2455 | (not (ange-ftp-bs2000-posix-host host))) | |
2456 | (ange-ftp-add-bs2000-host host) | |
2457 | (setq ange-ftp-host-cache host | |
2458 | ange-ftp-host-type-cache 'bs2000)) | |
8749abea GM |
2459 | ;; assume UN*X |
2460 | (t | |
2461 | (setq ange-ftp-host-cache host | |
2462 | ange-ftp-host-type-cache 'unix))) | |
2463 | ||
2464 | ;; Now that we have done a pwd, might as well put it in | |
2465 | ;; the expand-dir hashtable. | |
2466 | (let ((ange-ftp-this-user user) | |
2467 | (ange-ftp-this-host host)) | |
2468 | (setq fix-name-func (cdr (assq ange-ftp-host-type-cache | |
2469 | ange-ftp-fix-name-func-alist))) | |
2470 | (if fix-name-func | |
2471 | (setq dir (funcall fix-name-func dir 'reverse)))) | |
6e85ef5f | 2472 | (puthash key dir ange-ftp-expand-dir-hashtable)))) |
8749abea GM |
2473 | |
2474 | ;; In the special case of CMS make sure that know the | |
2475 | ;; expansion of the home minidisk now, because we will | |
2476 | ;; be doing a lot of cd's. | |
2477 | (if (and (eq host-type 'cms) | |
2478 | (not (ange-ftp-hash-entry-exists-p | |
2479 | key ange-ftp-expand-dir-hashtable))) | |
2480 | (let ((dir (car (ange-ftp-get-pwd host user)))) | |
2481 | (if dir | |
6e85ef5f | 2482 | (puthash key (concat "/" dir) ange-ftp-expand-dir-hashtable) |
8749abea GM |
2483 | (message "Warning! Unable to get home directory") |
2484 | (sit-for 1)))))) | |
2485 | ||
2486 | \f | |
2487 | ;;;; ------------------------------------------------------------ | |
2488 | ;;;; Remote file and directory listing support. | |
2489 | ;;;; ------------------------------------------------------------ | |
2490 | ||
2491 | ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands | |
2492 | ;; to take switch arguments. | |
2493 | (defun ange-ftp-dumb-unix-host (host) | |
2494 | (and host ange-ftp-dumb-unix-host-regexp | |
4671dba5 | 2495 | (string-match-p ange-ftp-dumb-unix-host-regexp host))) |
8749abea GM |
2496 | |
2497 | (defun ange-ftp-add-dumb-unix-host (host) | |
4671dba5 | 2498 | "Interactively add a given HOST to `ange-ftp-dumb-unix-host-regexp'." |
8749abea GM |
2499 | (interactive |
2500 | (list (read-string "Host: " | |
2501 | (let ((name (or (buffer-file-name) default-directory))) | |
2502 | (and name (car (ange-ftp-ftp-name name))))))) | |
2503 | (if (not (ange-ftp-dumb-unix-host host)) | |
2504 | (setq ange-ftp-dumb-unix-host-regexp | |
2505 | (concat "^" (regexp-quote host) "$" | |
2506 | (and ange-ftp-dumb-unix-host-regexp "\\|") | |
2507 | ange-ftp-dumb-unix-host-regexp) | |
2508 | ange-ftp-host-cache nil))) | |
2509 | ||
2510 | (defvar ange-ftp-parse-list-func-alist nil | |
2511 | "Alist saying how to parse directory listings for certain OS types. | |
4671dba5 JB |
2512 | Association list of (TYPE . FUNC) pairs. The FUNC is a routine which |
2513 | can parse the output from a DIR listing for a host of type TYPE.") | |
8749abea GM |
2514 | |
2515 | ;; With no-error nil, this function returns: | |
2516 | ;; an error if file is not an ange-ftp-name | |
25759a92 | 2517 | ;; (This should never happen.) |
8749abea GM |
2518 | ;; an error if either the listing is unreadable or there is an ftp error. |
2519 | ;; the listing (a string), if everything works. | |
25759a92 | 2520 | ;; |
8749abea GM |
2521 | ;; With no-error t, it returns: |
2522 | ;; an error if not an ange-ftp-name | |
2523 | ;; error if listing is unreadable (most likely caused by a slow connection) | |
2524 | ;; nil if ftp error (this is because although asking to list a nonexistent | |
2525 | ;; directory on a remote unix machine usually (except | |
2526 | ;; maybe for dumb hosts) returns an ls error, but no | |
2527 | ;; ftp error, if the same is done on a VMS machine, | |
2528 | ;; an ftp error is returned. Need to trap the error | |
2529 | ;; so we can go on and try to list the parent.) | |
2530 | ;; the listing, if everything works. | |
2531 | ||
2532 | ;; If WILDCARD is non-nil, then this implements the guts of insert-directory | |
2533 | ;; in the wildcard case. Then we make a relative directory listing | |
2534 | ;; of FILE within the directory specified by `default-directory'. | |
2535 | ||
2536 | (defvar ange-ftp-before-parse-ls-hook nil | |
4671dba5 | 2537 | "Normal hook run before parsing the text of an FTP directory listing.") |
8749abea | 2538 | |
a724ed38 | 2539 | (defvar ange-ftp-after-parse-ls-hook nil |
4671dba5 | 2540 | "Normal hook run after parsing the text of an FTP directory listing.") |
a724ed38 | 2541 | |
8749abea | 2542 | (defun ange-ftp-ls (file lsargs parse &optional no-error wildcard) |
4671dba5 | 2543 | "Return the output of a `DIR' or `ls' command done over FTP. |
8749abea GM |
2544 | FILE is the full name of the remote file, LSARGS is any args to pass to the |
2545 | `ls' command, and PARSE specifies that the output should be parsed and stored | |
2546 | away in the internal cache." | |
1fc85dae KG |
2547 | (when (string-match "^--dired\\s-+" lsargs) |
2548 | (setq lsargs (replace-match "" nil t lsargs))) | |
8749abea GM |
2549 | ;; If parse is t, we assume that file is a directory. i.e. we only parse |
2550 | ;; full directory listings. | |
2551 | (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file)) | |
2552 | (parsed (ange-ftp-ftp-name ange-ftp-this-file))) | |
2553 | (if parsed | |
2554 | (let* ((host (nth 0 parsed)) | |
2555 | (user (nth 1 parsed)) | |
2556 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
2557 | (key (directory-file-name ange-ftp-this-file)) | |
2558 | (host-type (ange-ftp-host-type host user)) | |
2559 | (dumb (memq host-type ange-ftp-dumb-host-types)) | |
2560 | result | |
2561 | temp | |
2562 | lscmd parse-func) | |
2563 | (if (string-equal name "") | |
2564 | (setq name | |
2565 | (ange-ftp-real-file-name-as-directory | |
6e85ef5f | 2566 | (ange-ftp-expand-dir host user "~")))) |
8749abea GM |
2567 | (if (and ange-ftp-ls-cache-file |
2568 | (string-equal key ange-ftp-ls-cache-file) | |
2569 | ;; Don't care about lsargs for dumb hosts. | |
2570 | (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs))) | |
2571 | ange-ftp-ls-cache-res | |
2572 | (setq temp (ange-ftp-make-tmp-name host)) | |
2573 | (if wildcard | |
2574 | (progn | |
2575 | (ange-ftp-cd host user (file-name-directory name)) | |
06531fc3 | 2576 | (setq lscmd (list 'ls file temp lsargs))) |
8749abea GM |
2577 | (setq lscmd (list 'dir name temp lsargs))) |
2578 | (unwind-protect | |
2579 | (if (car (setq result (ange-ftp-send-cmd | |
2580 | host | |
2581 | user | |
2582 | lscmd | |
2583 | (format "Listing %s" | |
2584 | (ange-ftp-abbreviate-filename | |
2585 | ange-ftp-this-file))))) | |
b63f6e81 | 2586 | (with-current-buffer (get-buffer-create |
c7bef55f | 2587 | ange-ftp-data-buffer-name) |
8749abea GM |
2588 | (erase-buffer) |
2589 | (if (ange-ftp-real-file-readable-p temp) | |
2590 | (ange-ftp-real-insert-file-contents temp) | |
2591 | (sleep-for ange-ftp-retry-time) | |
2592 | ;wait for file to possibly appear | |
2593 | (if (ange-ftp-real-file-readable-p temp) | |
2594 | ;; Try again. | |
2595 | (ange-ftp-real-insert-file-contents temp) | |
2596 | (ange-ftp-error host user | |
2597 | (format | |
2598 | "list data file %s not readable" | |
2599 | temp)))) | |
9d453139 SS |
2600 | ;; remove ^M inserted by the win32 ftp client |
2601 | (while (re-search-forward "\r$" nil t) | |
2602 | (replace-match "")) | |
2603 | (goto-char 1) | |
8749abea GM |
2604 | (run-hooks 'ange-ftp-before-parse-ls-hook) |
2605 | (if parse | |
2606 | (ange-ftp-set-files | |
2607 | ange-ftp-this-file | |
2608 | (if (setq | |
2609 | parse-func | |
2610 | (cdr (assq host-type | |
2611 | ange-ftp-parse-list-func-alist))) | |
2612 | (funcall parse-func) | |
2613 | (ange-ftp-parse-dired-listing lsargs)))) | |
a724ed38 GM |
2614 | ;; Place this hook here to convert the contents of the |
2615 | ;; buffer to a ls compatible format if the host system | |
2616 | ;; that is being queried is other than Unix i.e. VMS | |
2617 | ;; returns an ls format that really sucks. | |
2618 | (run-hooks 'ange-ftp-after-parse-ls-hook) | |
8749abea GM |
2619 | (setq ange-ftp-ls-cache-file key |
2620 | ange-ftp-ls-cache-lsargs lsargs | |
2621 | ; For dumb hosts-types this is | |
2622 | ; meaningless but harmless. | |
2623 | ange-ftp-ls-cache-res (buffer-string)) | |
2624 | ;; (kill-buffer (current-buffer)) | |
67f300f8 SM |
2625 | (if (equal ange-ftp-ls-cache-res "total 0\n") |
2626 | ;; wu-ftpd seems to return a successful result | |
2627 | ;; with an empty file-listing when doing a | |
2628 | ;; `DIR /some/file/.' which leads ange-ftp to | |
2629 | ;; believe that /some/file is a directory ;-( | |
2630 | nil | |
2631 | ange-ftp-ls-cache-res)) | |
8749abea GM |
2632 | (if no-error |
2633 | nil | |
2634 | (ange-ftp-error host user | |
2635 | (concat "DIR failed: " (cdr result))))) | |
2636 | (ange-ftp-del-tmp-name temp)))) | |
2637 | (error "Should never happen. Please report. Bug ref. no.: 1")))) | |
2638 | \f | |
2639 | ;;;; ------------------------------------------------------------ | |
2640 | ;;;; Directory information caching support. | |
2641 | ;;;; ------------------------------------------------------------ | |
2642 | ||
8749abea GM |
2643 | (defvar ange-ftp-add-file-entry-alist nil |
2644 | "Alist saying how to add file entries on certain OS types. | |
4671dba5 JB |
2645 | Association list of pairs (TYPE . FUNC), where FUNC is a function |
2646 | to be used to add a file entry for the OS TYPE. | |
2647 | The main reason for this alist is to deal with file versions in VMS.") | |
8749abea GM |
2648 | |
2649 | (defvar ange-ftp-delete-file-entry-alist nil | |
2650 | "Alist saying how to delete files on certain OS types. | |
4671dba5 JB |
2651 | Association list of pairs (TYPE . FUNC), where FUNC is a function |
2652 | to be used to delete a file entry for the OS TYPE. | |
8749abea GM |
2653 | The main reason for this alist is to deal with file versions in VMS.") |
2654 | ||
2655 | (defun ange-ftp-add-file-entry (name &optional dir-p) | |
2656 | "Add a file entry for file NAME, if its directory info exists." | |
2657 | (funcall (or (cdr (assq (ange-ftp-host-type | |
2658 | (car (ange-ftp-ftp-name name))) | |
2659 | ange-ftp-add-file-entry-alist)) | |
2660 | 'ange-ftp-internal-add-file-entry) | |
2661 | name dir-p) | |
2662 | (setq ange-ftp-ls-cache-file nil)) | |
2663 | ||
2664 | (defun ange-ftp-delete-file-entry (name &optional dir-p) | |
2665 | "Delete the file entry for file NAME, if its directory info exists." | |
2666 | (funcall (or (cdr (assq (ange-ftp-host-type | |
2667 | (car (ange-ftp-ftp-name name))) | |
2668 | ange-ftp-delete-file-entry-alist)) | |
2669 | 'ange-ftp-internal-delete-file-entry) | |
2670 | name dir-p) | |
2671 | (setq ange-ftp-ls-cache-file nil)) | |
2672 | ||
2673 | (defmacro ange-ftp-parse-filename () | |
2674 | ;;Extract the filename from the current line of a dired-like listing. | |
f06dbf7e MA |
2675 | `(save-match-data |
2676 | (let ((eol (progn (end-of-line) (point)))) | |
2677 | (beginning-of-line) | |
2678 | (if (re-search-forward directory-listing-before-filename-regexp eol t) | |
2679 | (buffer-substring (point) eol))))) | |
25759a92 | 2680 | |
8749abea GM |
2681 | ;; This deals with the F switch. Should also do something about |
2682 | ;; unquoting names obtained with the SysV b switch and the GNU Q | |
2683 | ;; switch. See Sebastian's dired-get-filename. | |
2684 | ||
e3441f42 | 2685 | (defun ange-ftp-ls-parser (switches) |
8749abea | 2686 | ;; Meant to be called by ange-ftp-parse-dired-listing |
6e85ef5f | 2687 | (let ((tbl (make-hash-table :test 'equal)) |
c8607dc7 SM |
2688 | (used-F (and (stringp switches) |
2689 | (string-match "F" switches))) | |
2690 | file-type symlink directory file) | |
2691 | (while (setq file (ange-ftp-parse-filename)) | |
2692 | (beginning-of-line) | |
2693 | (skip-chars-forward "\t 0-9") | |
2694 | (setq file-type (following-char) | |
2695 | directory (eq file-type ?d)) | |
2696 | (if (eq file-type ?l) | |
2697 | (let ((end (string-match " -> " file))) | |
2698 | (if end | |
2699 | ;; Sometimes `ls' appends a @ at the end of the target. | |
2700 | (setq symlink (substring file (match-end 0) | |
2701 | (string-match "@\\'" file)) | |
2702 | file (substring file 0 end)) | |
2703 | ;; Shouldn't happen | |
2704 | (setq symlink ""))) | |
2705 | (setq symlink nil)) | |
2706 | ;; Only do a costly regexp search if the F switch was used. | |
2707 | (if (and used-F | |
2708 | (not (string-equal file "")) | |
2709 | (looking-at | |
2710 | ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)")) | |
2711 | (let ((socket (eq file-type ?s)) | |
2712 | (executable | |
2713 | (and (not symlink) ; x bits don't mean a thing for symlinks | |
2714 | (string-match | |
2715 | "[xst]" | |
e3441f42 SM |
2716 | (concat (match-string 1) |
2717 | (match-string 2) | |
2718 | (match-string 3)))))) | |
c8607dc7 SM |
2719 | ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX) |
2720 | ;; and others don't. (sigh...) Beware, that some Unix's don't | |
2721 | ;; seem to believe in the F-switch | |
aa6f7b96 SM |
2722 | (if (or (and symlink (string-match "@\\'" file)) |
2723 | (and directory (string-match "/\\'" file)) | |
2724 | (and executable (string-match "*\\'" file)) | |
2725 | (and socket (string-match "=\\'" file))) | |
c8607dc7 | 2726 | (setq file (substring file 0 -1))))) |
6e85ef5f | 2727 | (puthash file (or symlink directory) tbl) |
c8607dc7 | 2728 | (forward-line 1)) |
6e85ef5f SM |
2729 | (puthash "." t tbl) |
2730 | (puthash ".." t tbl) | |
25759a92 | 2731 | tbl)) |
8749abea GM |
2732 | |
2733 | ;;; The dl stuff for descriptive listings | |
2734 | ||
2735 | (defvar ange-ftp-dl-dir-regexp nil | |
2736 | "Regexp matching directories which are listed in dl format. | |
2737 | This regexp should not be anchored with a trailing `$', because it should | |
2738 | match subdirectories as well.") | |
2739 | ||
2740 | (defun ange-ftp-add-dl-dir (dir) | |
4671dba5 | 2741 | "Interactively add a DIR to `ange-ftp-dl-dir-regexp'." |
8749abea GM |
2742 | (interactive |
2743 | (list (read-string "Directory: " | |
2744 | (let ((name (or (buffer-file-name) default-directory))) | |
2745 | (and name (ange-ftp-ftp-name name) | |
2746 | (file-name-directory name)))))) | |
2747 | (if (not (and ange-ftp-dl-dir-regexp | |
2748 | (string-match ange-ftp-dl-dir-regexp dir))) | |
2749 | (setq ange-ftp-dl-dir-regexp | |
2750 | (concat "^" (regexp-quote dir) | |
2751 | (and ange-ftp-dl-dir-regexp "\\|") | |
2752 | ange-ftp-dl-dir-regexp)))) | |
2753 | ||
2754 | (defmacro ange-ftp-dl-parser () | |
2755 | ;; Parse the current buffer, which is assumed to be a descriptive | |
2756 | ;; listing, and return a hashtable. | |
6e85ef5f | 2757 | `(let ((tbl (make-hash-table :test 'equal))) |
25759a92 | 2758 | (while (not (eobp)) |
6e85ef5f | 2759 | (puthash |
25759a92 SS |
2760 | (buffer-substring (point) |
2761 | (progn | |
2762 | (skip-chars-forward "^ /\n") | |
2763 | (point))) | |
2764 | (eq (following-char) ?/) | |
2765 | tbl) | |
2766 | (forward-line 1)) | |
6e85ef5f SM |
2767 | (puthash "." t tbl) |
2768 | (puthash ".." t tbl) | |
2769 | tbl)) | |
8749abea GM |
2770 | |
2771 | ;; Parse the current buffer which is assumed to be in a dired-like listing | |
2772 | ;; format, and return a hashtable as the result. If the listing is not really | |
2773 | ;; a listing, then return nil. | |
2774 | ||
2775 | (defun ange-ftp-parse-dired-listing (&optional switches) | |
2776 | (save-match-data | |
2777 | (cond | |
2778 | ((looking-at "^total [0-9]+$") | |
2779 | (forward-line 1) | |
2780 | ;; Some systems put in a blank line here. | |
2781 | (if (eolp) (forward-line 1)) | |
e3441f42 | 2782 | (ange-ftp-ls-parser switches)) |
8749abea GM |
2783 | ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'") |
2784 | ;; It's an ls error message. | |
2785 | nil) | |
2786 | ((eobp) ; i.e. (zerop (buffer-size)) | |
2787 | ;; This could be one of: | |
2788 | ;; (1) An Ultrix ls error message | |
2789 | ;; (2) A listing with the A switch of an empty directory | |
2790 | ;; on a machine which doesn't give a total line. | |
2791 | ;; (3) The twilight zone. | |
2792 | ;; We'll assume (1) for now. | |
2793 | nil) | |
9bc260cf | 2794 | ((re-search-forward directory-listing-before-filename-regexp nil t) |
8749abea | 2795 | (beginning-of-line) |
e3441f42 | 2796 | (ange-ftp-ls-parser switches)) |
8749abea GM |
2797 | ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t) |
2798 | ;; It's a dl listing (I hope). | |
2799 | ;; file is bound by the call to ange-ftp-ls | |
2800 | (ange-ftp-add-dl-dir ange-ftp-this-file) | |
2801 | (beginning-of-line) | |
2802 | (ange-ftp-dl-parser)) | |
2803 | (t nil)))) | |
2804 | ||
2805 | (defun ange-ftp-set-files (directory files) | |
2806 | "For a given DIRECTORY, set or change the associated FILES hashtable." | |
6e85ef5f SM |
2807 | (and files (puthash (file-name-as-directory directory) |
2808 | files ange-ftp-files-hashtable))) | |
8749abea | 2809 | |
e8b08aee GM |
2810 | (defun ange-ftp-switches-ok (switches) |
2811 | "Return SWITCHES (a string) if suitable for our use." | |
2812 | (and (stringp switches) | |
2813 | ;; We allow the A switch, which lists all files except "." and | |
2814 | ;; "..". This is OK because we manually insert these entries | |
2815 | ;; in the hash table. | |
2816 | (string-match | |
2817 | "--\\(almost-\\)?all\\>\\|\\(\\`\\| \\)-[[:alpha:]]*[aA]" switches) | |
2818 | (string-match "\\(\\`\\| \\)-[[:alpha:]]*l" switches) | |
2819 | (not (string-match | |
2820 | "--recursive\\>\\|\\(\\`\\| \\)-[[:alpha:]]*R" switches)) | |
2821 | switches)) | |
2822 | ||
8749abea | 2823 | (defun ange-ftp-get-files (directory &optional no-error) |
4671dba5 | 2824 | "Given a DIRECTORY, return a hashtable of file entries. |
8749abea GM |
2825 | This will give an error or return nil, depending on the value of |
2826 | NO-ERROR, if a listing for DIRECTORY cannot be obtained." | |
2827 | (setq directory (file-name-as-directory directory)) ;normalize | |
6e85ef5f | 2828 | (or (gethash directory ange-ftp-files-hashtable) |
8749abea GM |
2829 | (save-match-data |
2830 | (and (ange-ftp-ls directory | |
2831 | ;; This is an efficiency hack. We try to | |
2832 | ;; anticipate what sort of listing dired | |
2833 | ;; might want, and cache just such a listing. | |
e8b08aee GM |
2834 | (or (and (boundp 'dired-actual-switches) |
2835 | (ange-ftp-switches-ok dired-actual-switches)) | |
2836 | (and (boundp 'dired-listing-switches) | |
2837 | (ange-ftp-switches-ok | |
2838 | dired-listing-switches)) | |
2839 | "-al") | |
8749abea | 2840 | t no-error) |
6e85ef5f | 2841 | (gethash directory ange-ftp-files-hashtable))))) |
8749abea GM |
2842 | |
2843 | ;; Given NAME, return the file part that can be used for looking up the | |
2844 | ;; file's entry in a hashtable. | |
2845 | (defmacro ange-ftp-get-file-part (name) | |
25759a92 SS |
2846 | `(let ((file (file-name-nondirectory ,name))) |
2847 | (if (string-equal file "") | |
e3441f42 | 2848 | "." |
25759a92 | 2849 | file))) |
8749abea GM |
2850 | |
2851 | ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are | |
2852 | ;; allowed to determine if NAME is a sub-directory by listing it directly, | |
2853 | ;; rather than listing its parent directory. This is used for efficiency so | |
2854 | ;; that a wasted listing is not done: | |
2855 | ;; 1. When looking for a .dired file in dired-x.el. | |
2856 | ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid | |
2857 | ;; subdirectory. This is of course an OS dependent judgement. | |
2858 | ||
e3441f42 | 2859 | (defvar dired-local-variables-file) |
8749abea | 2860 | (defmacro ange-ftp-allow-child-lookup (dir file) |
76a98a50 SM |
2861 | `(not |
2862 | (let* ((efile ,file) ; expand once. | |
2863 | (edir ,dir) | |
2864 | (parsed (ange-ftp-ftp-name edir)) | |
2865 | (host-type (ange-ftp-host-type | |
2866 | (car parsed)))) | |
2867 | (or | |
2868 | ;; Deal with dired | |
2869 | (and (boundp 'dired-local-variables-file) ; in the dired-x package | |
2870 | (stringp dired-local-variables-file) | |
2871 | (string-equal dired-local-variables-file efile)) | |
2872 | ;; No dots in dir names in vms. | |
2873 | (and (eq host-type 'vms) | |
2874 | (string-match "\\." efile)) | |
2875 | ;; No subdirs in mts of cms. | |
2876 | (and (memq host-type '(mts cms)) | |
2877 | (not (string-equal "/" (nth 2 parsed)))) | |
2878 | ;; No dots in pseudo-dir names in bs2000. | |
2879 | (and (eq host-type 'bs2000) | |
2880 | (string-match "\\." efile)))))) | |
8749abea GM |
2881 | |
2882 | (defun ange-ftp-file-entry-p (name) | |
2883 | "Given NAME, return whether there is a file entry for it." | |
2884 | (let* ((name (directory-file-name name)) | |
2885 | (dir (file-name-directory name)) | |
6e85ef5f | 2886 | (ent (gethash dir ange-ftp-files-hashtable)) |
8749abea GM |
2887 | (file (ange-ftp-get-file-part name))) |
2888 | (if ent | |
2889 | (ange-ftp-hash-entry-exists-p file ent) | |
2890 | (or (and (ange-ftp-allow-child-lookup dir file) | |
2891 | (setq ent (ange-ftp-get-files name t)) | |
2892 | ;; Try a child lookup. i.e. try to list file as a | |
2893 | ;; subdirectory of dir. This is a good idea because | |
2894 | ;; we may not have read permission for file's parent. Also, | |
2895 | ;; people tend to work down directory trees anyway. We use | |
2896 | ;; no-error ;; because if file does not exist as a subdir., | |
2897 | ;; then dumb hosts will give an ftp error. Smart unix hosts | |
2898 | ;; will simply send back the ls | |
2899 | ;; error message. | |
6e85ef5f | 2900 | (gethash "." ent)) |
8749abea | 2901 | ;; Child lookup failed, so try the parent. |
311f32fe DK |
2902 | (ange-ftp-hash-entry-exists-p |
2903 | file (ange-ftp-get-files dir 'no-error)))))) | |
8749abea GM |
2904 | |
2905 | (defun ange-ftp-get-file-entry (name) | |
2906 | "Given NAME, return the given file entry. | |
2907 | The entry will be either t for a directory, nil for a normal file, | |
4671dba5 | 2908 | or a string for a symlink. If the file isn't in the hashtable, |
8749abea GM |
2909 | this also returns nil." |
2910 | (let* ((name (directory-file-name name)) | |
2911 | (dir (file-name-directory name)) | |
6e85ef5f | 2912 | (ent (gethash dir ange-ftp-files-hashtable)) |
8749abea GM |
2913 | (file (ange-ftp-get-file-part name))) |
2914 | (if ent | |
6e85ef5f | 2915 | (gethash file ent) |
8749abea GM |
2916 | (or (and (ange-ftp-allow-child-lookup dir file) |
2917 | (setq ent (ange-ftp-get-files name t)) | |
6e85ef5f SM |
2918 | (gethash "." ent)) |
2919 | ;; i.e. it's a directory by child lookup | |
57199263 DK |
2920 | (and (setq ent (ange-ftp-get-files dir t)) |
2921 | (gethash file ent)))))) | |
8749abea GM |
2922 | |
2923 | (defun ange-ftp-internal-delete-file-entry (name &optional dir-p) | |
6e85ef5f SM |
2924 | (when dir-p |
2925 | (setq name (file-name-as-directory name)) | |
2926 | (remhash name ange-ftp-files-hashtable) | |
2927 | (setq name (directory-file-name name))) | |
8749abea GM |
2928 | ;; Note that file-name-as-directory followed by directory-file-name |
2929 | ;; serves to canonicalize directory file names to their unix form. | |
2930 | ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO | |
6e85ef5f | 2931 | (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable))) |
8749abea | 2932 | (if files |
6e85ef5f | 2933 | (remhash (ange-ftp-get-file-part name) files)))) |
8749abea GM |
2934 | |
2935 | (defun ange-ftp-internal-add-file-entry (name &optional dir-p) | |
2936 | (and dir-p | |
2937 | (setq name (directory-file-name name))) | |
6e85ef5f | 2938 | (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable))) |
8749abea | 2939 | (if files |
6e85ef5f | 2940 | (puthash (ange-ftp-get-file-part name) dir-p files)))) |
8749abea GM |
2941 | |
2942 | (defun ange-ftp-wipe-file-entries (host user) | |
2943 | "Get rid of entry for HOST, USER pair from file entry information hashtable." | |
6e85ef5f | 2944 | (let ((new-tbl (make-hash-table :test 'equal |
7adee48a DK |
2945 | :size (hash-table-size |
2946 | ange-ftp-files-hashtable)))) | |
6e85ef5f | 2947 | (maphash |
25759a92 SS |
2948 | (lambda (key val) |
2949 | (let ((parsed (ange-ftp-ftp-name key))) | |
2950 | (if parsed | |
2951 | (let ((h (nth 0 parsed)) | |
2952 | (u (nth 1 parsed))) | |
2953 | (or (and (equal host h) (equal user u)) | |
6e85ef5f | 2954 | (puthash key val new-tbl)))))) |
8749abea GM |
2955 | ange-ftp-files-hashtable) |
2956 | (setq ange-ftp-files-hashtable new-tbl))) | |
2957 | \f | |
2958 | ;;;; ------------------------------------------------------------ | |
2959 | ;;;; File transfer mode support. | |
2960 | ;;;; ------------------------------------------------------------ | |
2961 | ||
2962 | (defun ange-ftp-set-binary-mode (host user) | |
4671dba5 | 2963 | "Tell the FTP process for the given HOST & USER to switch to binary mode." |
412707c2 SM |
2964 | ;; FIXME: We should keep track of the current mode, so as to avoid |
2965 | ;; unnecessary roundtrips. | |
8749abea GM |
2966 | (let ((result (ange-ftp-send-cmd host user '(type "binary")))) |
2967 | (if (not (car result)) | |
2968 | (ange-ftp-error host user (concat "BINARY failed: " (cdr result))) | |
b63f6e81 | 2969 | (with-current-buffer (process-buffer (ange-ftp-get-process host user)) |
8749abea GM |
2970 | (and ange-ftp-binary-hash-mark-size |
2971 | (setq ange-ftp-hash-mark-unit | |
2972 | (ash ange-ftp-binary-hash-mark-size -4))))))) | |
2973 | ||
2974 | (defun ange-ftp-set-ascii-mode (host user) | |
4671dba5 | 2975 | "Tell the FTP process for the given HOST & USER to switch to ASCII mode." |
412707c2 SM |
2976 | ;; FIXME: We should keep track of the current mode, so as to avoid |
2977 | ;; unnecessary roundtrips. | |
8749abea GM |
2978 | (let ((result (ange-ftp-send-cmd host user '(type "ascii")))) |
2979 | (if (not (car result)) | |
2980 | (ange-ftp-error host user (concat "ASCII failed: " (cdr result))) | |
b63f6e81 | 2981 | (with-current-buffer (process-buffer (ange-ftp-get-process host user)) |
8749abea GM |
2982 | (and ange-ftp-ascii-hash-mark-size |
2983 | (setq ange-ftp-hash-mark-unit | |
2984 | (ash ange-ftp-ascii-hash-mark-size -4))))))) | |
2985 | \f | |
67f300f8 | 2986 | (defun ange-ftp-cd (host user dir &optional noerror) |
8749abea | 2987 | (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD"))) |
67f300f8 SM |
2988 | (if noerror result |
2989 | (or (car result) | |
2990 | (ange-ftp-error host user (concat "CD failed: " (cdr result))))))) | |
8749abea GM |
2991 | |
2992 | (defun ange-ftp-get-pwd (host user) | |
4671dba5 JB |
2993 | "Attempt to get the current working directory for the given HOST/USER pair. |
2994 | Returns (DIR . LINE) where DIR is either the directory or nil if not found, | |
8749abea GM |
2995 | and LINE is the relevant success or fail line from the FTP-client." |
2996 | (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD")) | |
2997 | (line (cdr result)) | |
2998 | dir) | |
2999 | (if (car result) | |
3000 | (save-match-data | |
3001 | (and (or (string-match "\"\\([^\"]*\\)\"" line) | |
e3441f42 SM |
3002 | (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers! |
3003 | (setq dir (match-string 1 line))))) | |
8749abea GM |
3004 | (cons dir line))) |
3005 | \f | |
3006 | ;;; ------------------------------------------------------------ | |
3007 | ;;; expand-file-name and friends...which currently don't work | |
3008 | ;;; ------------------------------------------------------------ | |
3009 | ||
3010 | (defun ange-ftp-expand-dir (host user dir) | |
3011 | "Return the result of doing a PWD in the current FTP session. | |
3012 | Use the connection to machine HOST | |
3013 | logged in as user USER and cd'd to directory DIR." | |
3014 | (let* ((host-type (ange-ftp-host-type host user)) | |
3015 | ;; It is more efficient to call ange-ftp-host-type | |
3016 | ;; before binding res, because ange-ftp-host-type sometimes | |
3017 | ;; adds to the info in the expand-dir-hashtable. | |
3018 | (fix-name-func | |
3019 | (cdr (assq host-type ange-ftp-fix-name-func-alist))) | |
3020 | (key (concat host "/" user "/" dir)) | |
6e85ef5f | 3021 | (res (gethash key ange-ftp-expand-dir-hashtable))) |
8749abea GM |
3022 | (or res |
3023 | (progn | |
3024 | (or | |
3025 | (string-equal user "anonymous") | |
3026 | (string-equal user "ftp") | |
3027 | (not (eq host-type 'unix)) | |
3028 | (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp | |
3029 | "\\|" | |
3030 | ange-ftp-good-msgs)) | |
3031 | (result (ange-ftp-send-cmd host user | |
3032 | (list 'get dir null-device) | |
3033 | (format "expanding %s" dir))) | |
3034 | (line (cdr result))) | |
3035 | (setq res | |
3036 | (if (string-match ange-ftp-expand-dir-regexp line) | |
e3441f42 | 3037 | (match-string 1 line))))) |
8749abea GM |
3038 | (or res |
3039 | (if (string-equal dir "~") | |
3040 | (setq res (car (ange-ftp-get-pwd host user))) | |
3041 | (let ((home (ange-ftp-expand-dir host user "~"))) | |
3042 | (unwind-protect | |
3043 | (and (ange-ftp-cd host user dir) | |
3044 | (setq res (car (ange-ftp-get-pwd host user)))) | |
3045 | (ange-ftp-cd host user home))))) | |
3046 | (if res | |
3047 | (let ((ange-ftp-this-user user) | |
3048 | (ange-ftp-this-host host)) | |
3049 | (if fix-name-func | |
3050 | (setq res (funcall fix-name-func res 'reverse))) | |
6e85ef5f | 3051 | (puthash key res ange-ftp-expand-dir-hashtable))) |
8749abea GM |
3052 | res)))) |
3053 | ||
3054 | (defun ange-ftp-canonize-filename (n) | |
4671dba5 | 3055 | "Take a string N and short-circuit //, /. and /.." |
8749abea GM |
3056 | (if (string-match "[^:]+//" n) ;don't upset Apollo users |
3057 | (setq n (substring n (1- (match-end 0))))) | |
3058 | (let ((parsed (ange-ftp-ftp-name n))) | |
3059 | (if parsed | |
3060 | (let ((host (car parsed)) | |
3061 | (user (nth 1 parsed)) | |
3062 | (name (nth 2 parsed))) | |
25759a92 | 3063 | |
8749abea GM |
3064 | ;; See if remote name is absolute. If so then just expand it and |
3065 | ;; replace the name component of the overall name. | |
aa6f7b96 | 3066 | (cond ((string-match "\\`/" name) |
8749abea | 3067 | name) |
25759a92 | 3068 | |
8749abea GM |
3069 | ;; Name starts with ~ or ~user. Resolve that part of the name |
3070 | ;; making it absolute then re-expand it. | |
aa6f7b96 | 3071 | ((string-match "\\`~[^/]*" name) |
e3441f42 | 3072 | (let* ((tilda (match-string 0 name)) |
8749abea GM |
3073 | (rest (substring name (match-end 0))) |
3074 | (dir (ange-ftp-expand-dir host user tilda))) | |
3075 | (if dir | |
aa6f7b96 SM |
3076 | ;; C-x d /ftp:anonymous@ftp.gnu.org:~/ RET |
3077 | ;; seems to cause `rest' to sometimes be empty. | |
3078 | ;; Maybe it's an error for `rest' to be empty here, | |
3079 | ;; but until we figure this out, this quick fix | |
3080 | ;; seems to do the trick. | |
3081 | (setq name (cond ((string-equal rest "") dir) | |
3082 | ((string-equal dir "/") rest) | |
3083 | (t (concat dir rest)))) | |
25759a92 | 3084 | (error "User \"%s\" is not known" |
8749abea | 3085 | (substring tilda 1))))) |
25759a92 | 3086 | |
8749abea GM |
3087 | ;; relative name. Tack on homedir and re-expand. |
3088 | (t | |
3089 | (let ((dir (ange-ftp-expand-dir host user "~"))) | |
3090 | (if dir | |
3091 | (setq name (concat | |
3092 | (ange-ftp-real-file-name-as-directory dir) | |
3093 | name)) | |
3094 | (error "Unable to obtain CWD"))))) | |
25759a92 | 3095 | |
8749abea | 3096 | ;; If name starts with //, preserve that, for apollo system. |
aa6f7b96 SM |
3097 | (unless (string-match "\\`//" name) |
3098 | (if (not (eq system-type 'windows-nt)) | |
3099 | (setq name (ange-ftp-real-expand-file-name name)) | |
3100 | ;; Windows UNC default dirs do not make sense for ftp. | |
3101 | (setq name (if (string-match "\\`//" default-directory) | |
3102 | (ange-ftp-real-expand-file-name name "c:/") | |
3103 | (ange-ftp-real-expand-file-name name))) | |
3104 | ;; Strip off possible drive specifier. | |
3105 | (if (string-match "\\`[a-zA-Z]:" name) | |
3106 | (setq name (substring name 2)))) | |
3107 | (if (string-match "\\`//" name) | |
3108 | (setq name (substring name 1)))) | |
25759a92 | 3109 | |
8749abea GM |
3110 | ;; Now substitute the expanded name back into the overall filename. |
3111 | (ange-ftp-replace-name-component n name)) | |
25759a92 | 3112 | |
8749abea GM |
3113 | ;; non-ange-ftp name. Just expand normally. |
3114 | (if (eq (string-to-char n) ?/) | |
3115 | (ange-ftp-real-expand-file-name n) | |
3116 | (ange-ftp-real-expand-file-name | |
3117 | (ange-ftp-real-file-name-nondirectory n) | |
3118 | (ange-ftp-real-file-name-directory n)))))) | |
3119 | ||
3120 | (defun ange-ftp-expand-file-name (name &optional default) | |
3bd1644e | 3121 | "Documented as `expand-file-name'." |
8749abea GM |
3122 | (save-match-data |
3123 | (setq default (or default default-directory)) | |
3124 | (cond ((eq (string-to-char name) ?~) | |
3125 | (ange-ftp-real-expand-file-name name)) | |
3126 | ((eq (string-to-char name) ?/) | |
3127 | (ange-ftp-canonize-filename name)) | |
3128 | ((and (eq system-type 'windows-nt) | |
3129 | (eq (string-to-char name) ?\\)) | |
3130 | (ange-ftp-canonize-filename name)) | |
3131 | ((and (eq system-type 'windows-nt) | |
aa6f7b96 SM |
3132 | (or (string-match "\\`[a-zA-Z]:" name) |
3133 | (string-match "\\`[a-zA-Z]:" default))) | |
8749abea GM |
3134 | (ange-ftp-real-expand-file-name name default)) |
3135 | ((zerop (length name)) | |
3136 | (ange-ftp-canonize-filename default)) | |
3137 | ((ange-ftp-canonize-filename | |
3138 | (concat (file-name-as-directory default) name)))))) | |
3139 | \f | |
3140 | ;;; These are problems--they are currently not enabled. | |
3141 | ||
3142 | (defvar ange-ftp-file-name-as-directory-alist nil | |
4671dba5 | 3143 | "Association list of (TYPE . FUNC) pairs. |
8749abea GM |
3144 | FUNC converts a filename to a directory name for the operating |
3145 | system TYPE.") | |
3146 | ||
3147 | (defun ange-ftp-file-name-as-directory (name) | |
4671dba5 | 3148 | "Documented as `file-name-as-directory'." |
8749abea GM |
3149 | (let ((parsed (ange-ftp-ftp-name name))) |
3150 | (if parsed | |
3151 | (if (string-equal (nth 2 parsed) "") | |
3152 | name | |
3153 | (funcall (or (cdr (assq | |
3154 | (ange-ftp-host-type (car parsed)) | |
3155 | ange-ftp-file-name-as-directory-alist)) | |
3156 | 'ange-ftp-real-file-name-as-directory) | |
3157 | name)) | |
3158 | (ange-ftp-real-file-name-as-directory name)))) | |
25759a92 | 3159 | |
8749abea | 3160 | (defun ange-ftp-file-name-directory (name) |
4671dba5 | 3161 | "Documented as `file-name-directory'." |
8749abea GM |
3162 | (let ((parsed (ange-ftp-ftp-name name))) |
3163 | (if parsed | |
3164 | (let ((filename (nth 2 parsed))) | |
4671dba5 | 3165 | (if (string-match-p "\\`~[^/]*\\'" filename) |
8749abea GM |
3166 | name |
3167 | (ange-ftp-replace-name-component | |
3168 | name | |
3169 | (ange-ftp-real-file-name-directory filename)))) | |
3170 | (ange-ftp-real-file-name-directory name)))) | |
3171 | ||
3172 | (defun ange-ftp-file-name-nondirectory (name) | |
4671dba5 | 3173 | "Documented as `file-name-nondirectory'." |
8749abea GM |
3174 | (let ((parsed (ange-ftp-ftp-name name))) |
3175 | (if parsed | |
3176 | (let ((filename (nth 2 parsed))) | |
4671dba5 | 3177 | (if (string-match-p "\\`~[^/]*\\'" filename) |
8749abea GM |
3178 | "" |
3179 | (ange-ftp-real-file-name-nondirectory filename))) | |
3180 | (ange-ftp-real-file-name-nondirectory name)))) | |
3181 | ||
3182 | (defun ange-ftp-directory-file-name (dir) | |
4671dba5 | 3183 | "Documented as `directory-file-name'." |
8749abea GM |
3184 | (let ((parsed (ange-ftp-ftp-name dir))) |
3185 | (if parsed | |
3186 | (ange-ftp-replace-name-component | |
e3441f42 SM |
3187 | dir |
3188 | (ange-ftp-real-directory-file-name (nth 2 parsed))) | |
8749abea GM |
3189 | (ange-ftp-real-directory-file-name dir)))) |
3190 | ||
3191 | \f | |
3192 | ;;; Hooks that handle Emacs primitives. | |
3193 | ||
3194 | ;; Returns non-nil if should transfer FILE in binary mode. | |
3195 | (defun ange-ftp-binary-file (file) | |
4671dba5 | 3196 | (string-match-p ange-ftp-binary-file-name-regexp file)) |
8749abea GM |
3197 | |
3198 | (defun ange-ftp-write-region (start end filename &optional append visit) | |
3199 | (setq filename (expand-file-name filename)) | |
3200 | (let ((parsed (ange-ftp-ftp-name filename))) | |
3201 | (if parsed | |
3202 | (let* ((host (nth 0 parsed)) | |
3203 | (user (nth 1 parsed)) | |
3204 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3205 | (temp (ange-ftp-make-tmp-name host)) | |
3206 | ;; What we REALLY need here is a way to determine if the mode | |
3207 | ;; of the transfer is irrelevant, i.e. we can use binary mode | |
3208 | ;; regardless. Maybe a system-type to host-type lookup? | |
a6bc05e1 | 3209 | (binary (ange-ftp-binary-file filename)) |
8749abea GM |
3210 | (cmd (if append 'append 'put)) |
3211 | (abbr (ange-ftp-abbreviate-filename filename)) | |
3212 | ;; we need to reset `last-coding-system-used' to its | |
3213 | ;; value immediately after calling the real write-region, | |
3214 | ;; so that `basic-save-buffer' doesn't see whatever value | |
3215 | ;; might be used when communicating with the ftp process. | |
3216 | (coding-system-used last-coding-system-used)) | |
3217 | (unwind-protect | |
3218 | (progn | |
4494f50d | 3219 | (let ((filename (buffer-file-name)) |
8749abea GM |
3220 | (mod-p (buffer-modified-p))) |
3221 | (unwind-protect | |
2ca0d5f1 | 3222 | (progn |
4494f50d RS |
3223 | (ange-ftp-real-write-region start end temp nil |
3224 | (or visit 'quiet)) | |
2ca0d5f1 | 3225 | (setq coding-system-used last-coding-system-used)) |
8749abea | 3226 | ;; cleanup forms |
2ca0d5f1 | 3227 | (setq coding-system-used last-coding-system-used) |
8749abea | 3228 | (setq buffer-file-name filename) |
b63f6e81 | 3229 | (restore-buffer-modified-p mod-p))) |
8749abea GM |
3230 | (if binary |
3231 | (ange-ftp-set-binary-mode host user)) | |
3232 | ||
3233 | ;; tell the process filter what size the transfer will be. | |
3234 | (let ((attr (file-attributes temp))) | |
3235 | (if attr | |
3236 | (ange-ftp-set-xfer-size host user (nth 7 attr)))) | |
3237 | ||
3238 | ;; put or append the file. | |
3239 | (let ((result (ange-ftp-send-cmd host user | |
3240 | (list cmd temp name) | |
3241 | (format "Writing %s" abbr)))) | |
3242 | (or (car result) | |
3243 | (signal 'ftp-error | |
3244 | (list | |
3245 | "Opening output file" | |
3246 | (format "FTP Error: \"%s\"" (cdr result)) | |
3247 | filename))))) | |
3248 | (ange-ftp-del-tmp-name temp) | |
25759a92 | 3249 | (if binary |
8749abea GM |
3250 | (ange-ftp-set-ascii-mode host user))) |
3251 | (if (eq visit t) | |
3252 | (progn | |
25759a92 | 3253 | (set-visited-file-modtime (ange-ftp-file-modtime filename)) |
8749abea GM |
3254 | (ange-ftp-set-buffer-mode) |
3255 | (setq buffer-file-name filename) | |
3256 | (set-buffer-modified-p nil))) | |
3257 | ;; ensure `last-coding-system-used' has an appropriate value | |
3258 | (setq last-coding-system-used coding-system-used) | |
3259 | (ange-ftp-message "Wrote %s" abbr) | |
3260 | (ange-ftp-add-file-entry filename)) | |
3261 | (ange-ftp-real-write-region start end filename append visit)))) | |
3262 | ||
3263 | (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace) | |
3264 | (barf-if-buffer-read-only) | |
3265 | (setq filename (expand-file-name filename)) | |
3266 | (let ((parsed (ange-ftp-ftp-name filename))) | |
3267 | (if parsed | |
3268 | (progn | |
3269 | (if visit | |
3270 | (setq buffer-file-name filename)) | |
3271 | (if (or (file-exists-p filename) | |
3272 | (progn | |
3273 | (setq ange-ftp-ls-cache-file nil) | |
6e85ef5f SM |
3274 | (remhash (file-name-directory filename) |
3275 | ange-ftp-files-hashtable) | |
8749abea GM |
3276 | (file-exists-p filename))) |
3277 | (let* ((host (nth 0 parsed)) | |
3278 | (user (nth 1 parsed)) | |
3279 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3280 | (temp (ange-ftp-make-tmp-name host)) | |
a6bc05e1 | 3281 | (binary (ange-ftp-binary-file filename)) |
638e9005 | 3282 | (buffer-file-type buffer-file-type) |
8749abea GM |
3283 | (abbr (ange-ftp-abbreviate-filename filename)) |
3284 | (coding-system-used last-coding-system-used) | |
3285 | size) | |
3286 | (unwind-protect | |
3287 | (progn | |
3288 | (if binary | |
3289 | (ange-ftp-set-binary-mode host user)) | |
3290 | (let ((result (ange-ftp-send-cmd host user | |
3291 | (list 'get name temp) | |
3292 | (format "Retrieving %s" abbr)))) | |
3293 | (or (car result) | |
3294 | (signal 'ftp-error | |
3295 | (list | |
3296 | "Opening input file" | |
3297 | (format "FTP Error: \"%s\"" (cdr result)) | |
3298 | filename)))) | |
3299 | (if (or (ange-ftp-real-file-readable-p temp) | |
3300 | (sleep-for ange-ftp-retry-time) | |
3301 | ;; Wait for file to hopefully appear. | |
3302 | (ange-ftp-real-file-readable-p temp)) | |
3303 | (setq | |
3304 | size | |
3305 | (nth 1 (ange-ftp-real-insert-file-contents | |
3306 | temp visit beg end replace)) | |
3307 | coding-system-used last-coding-system-used | |
3308 | ;; override autodetection of buffer file type | |
3309 | ;; to ensure buffer is saved in DOS format | |
3310 | buffer-file-type binary) | |
3311 | (signal 'ftp-error | |
3312 | (list | |
3313 | "Opening input file:" | |
3314 | (format | |
3315 | "FTP Error: %s not arrived or readable" | |
3316 | filename))))) | |
3317 | (if binary | |
3318 | ;; We must keep `last-coding-system-used' | |
3319 | ;; unchanged. | |
3320 | (let (last-coding-system-used) | |
3321 | (ange-ftp-set-ascii-mode host user))) | |
3322 | (ange-ftp-del-tmp-name temp)) | |
3323 | (if visit | |
3324 | (progn | |
25759a92 SS |
3325 | (set-visited-file-modtime |
3326 | (ange-ftp-file-modtime filename)) | |
8749abea GM |
3327 | (setq buffer-file-name filename))) |
3328 | (setq last-coding-system-used coding-system-used) | |
3329 | (list filename size)) | |
3330 | (signal 'file-error | |
25759a92 | 3331 | (list |
8749abea GM |
3332 | "Opening input file" |
3333 | filename)))) | |
3334 | (ange-ftp-real-insert-file-contents filename visit beg end replace)))) | |
25759a92 | 3335 | |
8749abea | 3336 | (defun ange-ftp-expand-symlink (file dir) |
64cf2455 KG |
3337 | (let ((res (if (file-name-absolute-p file) |
3338 | (ange-ftp-replace-name-component dir file) | |
3339 | (expand-file-name file dir)))) | |
3340 | (if (file-symlink-p res) | |
3341 | (ange-ftp-expand-symlink | |
3342 | (ange-ftp-get-file-entry res) | |
3343 | (file-name-directory (directory-file-name res))) | |
3344 | res))) | |
8749abea GM |
3345 | |
3346 | (defun ange-ftp-file-symlink-p (file) | |
3347 | ;; call ange-ftp-expand-file-name rather than the normal | |
3348 | ;; expand-file-name to stop loops when using a package that | |
3349 | ;; redefines both file-symlink-p and expand-file-name. | |
3350 | (setq file (ange-ftp-expand-file-name file)) | |
3351 | (if (ange-ftp-ftp-name file) | |
34301ace | 3352 | (condition-case nil |
311f32fe DK |
3353 | (let ((ent (ange-ftp-get-files (file-name-directory file)))) |
3354 | (and ent | |
3355 | (stringp (setq ent | |
3356 | (gethash (ange-ftp-get-file-part file) ent))) | |
3357 | ent)) | |
34301ace RS |
3358 | ;; If we can't read the parent directory, just assume |
3359 | ;; this file is not a symlink. | |
3360 | ;; This makes it possible to access a directory that | |
3361 | ;; whose parent is not readable. | |
3362 | (file-error nil)) | |
8749abea GM |
3363 | (ange-ftp-real-file-symlink-p file))) |
3364 | ||
3365 | (defun ange-ftp-file-exists-p (name) | |
3366 | (setq name (expand-file-name name)) | |
3367 | (if (ange-ftp-ftp-name name) | |
3368 | (if (ange-ftp-file-entry-p name) | |
3369 | (let ((file-ent (ange-ftp-get-file-entry name))) | |
3370 | (if (stringp file-ent) | |
3371 | (file-exists-p | |
3372 | (ange-ftp-expand-symlink file-ent | |
3373 | (file-name-directory | |
3374 | (directory-file-name name)))) | |
3375 | t))) | |
3376 | (ange-ftp-real-file-exists-p name))) | |
3377 | ||
3378 | (defun ange-ftp-file-directory-p (name) | |
3379 | (setq name (expand-file-name name)) | |
3380 | (if (ange-ftp-ftp-name name) | |
3381 | ;; We do a file-name-as-directory on name here because some | |
3382 | ;; machines (VMS) use a .DIR to indicate the filename associated | |
3383 | ;; with a directory. This needs to be canonicalized. | |
3384 | (let ((file-ent (ange-ftp-get-file-entry | |
3385 | (ange-ftp-file-name-as-directory name)))) | |
3386 | (if (stringp file-ent) | |
3bd1644e SM |
3387 | ;; Calling file-directory-p doesn't work because ange-ftp |
3388 | ;; is temporarily disabled for this operation. | |
3389 | (ange-ftp-file-directory-p | |
8749abea GM |
3390 | (ange-ftp-expand-symlink file-ent |
3391 | (file-name-directory | |
3392 | (directory-file-name name)))) | |
3393 | file-ent)) | |
3394 | (ange-ftp-real-file-directory-p name))) | |
3395 | ||
3396 | (defun ange-ftp-directory-files (directory &optional full match | |
3397 | &rest v19-args) | |
3398 | (setq directory (expand-file-name directory)) | |
3399 | (if (ange-ftp-ftp-name directory) | |
3400 | (progn | |
3401 | (ange-ftp-barf-if-not-directory directory) | |
3402 | (let ((tail (ange-ftp-hash-table-keys | |
3403 | (ange-ftp-get-files directory))) | |
3404 | files f) | |
3405 | (setq directory (file-name-as-directory directory)) | |
4671dba5 JB |
3406 | (while tail |
3407 | (setq f (car tail) | |
3408 | tail (cdr tail)) | |
3409 | (if (or (not match) (string-match-p match f)) | |
3410 | (setq files | |
3411 | (cons (if full (concat directory f) f) files)))) | |
8749abea GM |
3412 | (nreverse files))) |
3413 | (apply 'ange-ftp-real-directory-files directory full match v19-args))) | |
3414 | ||
f06dbf7e MA |
3415 | (defun ange-ftp-directory-files-and-attributes |
3416 | (directory &optional full match nosort id-format) | |
3417 | (setq directory (expand-file-name directory)) | |
3418 | (if (ange-ftp-ftp-name directory) | |
3419 | (mapcar | |
3420 | (lambda (file) | |
3421 | (cons file (file-attributes (expand-file-name file directory)))) | |
3422 | (ange-ftp-directory-files directory full match nosort)) | |
3423 | (ange-ftp-real-directory-files-and-attributes | |
3424 | directory full match nosort id-format))) | |
3425 | ||
c4383667 | 3426 | (defun ange-ftp-file-attributes (file &optional id-format) |
8749abea GM |
3427 | (setq file (expand-file-name file)) |
3428 | (let ((parsed (ange-ftp-ftp-name file))) | |
3429 | (if parsed | |
3430 | (let ((part (ange-ftp-get-file-part file)) | |
3431 | (files (ange-ftp-get-files (file-name-directory file)))) | |
3432 | (if (ange-ftp-hash-entry-exists-p part files) | |
3433 | (let ((host (nth 0 parsed)) | |
3434 | (user (nth 1 parsed)) | |
3435 | (name (nth 2 parsed)) | |
6e85ef5f SM |
3436 | (dirp (gethash part files)) |
3437 | (inode (gethash file ange-ftp-inodes-hashtable))) | |
8749abea GM |
3438 | (unless inode |
3439 | (setq inode ange-ftp-next-inode-number | |
3440 | ange-ftp-next-inode-number (1+ inode)) | |
6e85ef5f | 3441 | (puthash file inode ange-ftp-inodes-hashtable)) |
8749abea GM |
3442 | (list (if (and (stringp dirp) (file-name-absolute-p dirp)) |
3443 | (ange-ftp-expand-symlink dirp | |
3444 | (file-name-directory file)) | |
3445 | dirp) ;0 file type | |
3446 | -1 ;1 link count | |
3447 | -1 ;2 uid | |
3448 | -1 ;3 gid | |
3449 | '(0 0) ;4 atime | |
25759a92 | 3450 | (ange-ftp-file-modtime file) ;5 mtime |
8749abea | 3451 | '(0 0) ;6 ctime |
412707c2 | 3452 | (ange-ftp-file-size file) ;7 size |
8749abea GM |
3453 | (concat (if (stringp dirp) "l" (if dirp "d" "-")) |
3454 | "?????????") ;8 mode | |
3455 | nil ;9 gid weird | |
3456 | inode ;10 "inode number". | |
3457 | -1 ;11 device number [v19 only] | |
3458 | )))) | |
836078f6 RS |
3459 | (if id-format |
3460 | (ange-ftp-real-file-attributes file id-format) | |
3461 | (ange-ftp-real-file-attributes file))))) | |
8749abea | 3462 | |
a1f84f6d SS |
3463 | (defun ange-ftp-file-newer-than-file-p (f1 f2) |
3464 | (let ((f1-parsed (ange-ftp-ftp-name f1)) | |
3465 | (f2-parsed (ange-ftp-ftp-name f2))) | |
3466 | (if (or f1-parsed f2-parsed) | |
3467 | (let ((f1-mt (nth 5 (file-attributes f1))) | |
3468 | (f2-mt (nth 5 (file-attributes f2)))) | |
3469 | (cond ((null f1-mt) nil) | |
3470 | ((null f2-mt) t) | |
3471 | (t (> (float-time f1-mt) (float-time f2-mt))))) | |
3472 | (ange-ftp-real-file-newer-than-file-p f1 f2)))) | |
3473 | ||
8749abea | 3474 | (defun ange-ftp-file-writable-p (file) |
0e14fe9f GM |
3475 | (let ((ange-ftp-process-verbose nil)) |
3476 | (setq file (expand-file-name file)) | |
3477 | (if (ange-ftp-ftp-name file) | |
3478 | (or (file-exists-p file) ;guess here for speed | |
3479 | (file-directory-p (file-name-directory file))) | |
3480 | (ange-ftp-real-file-writable-p file)))) | |
8749abea GM |
3481 | |
3482 | (defun ange-ftp-file-readable-p (file) | |
0e14fe9f GM |
3483 | (let ((ange-ftp-process-verbose nil)) |
3484 | (setq file (expand-file-name file)) | |
3485 | (if (ange-ftp-ftp-name file) | |
3486 | (file-exists-p file) | |
3487 | (ange-ftp-real-file-readable-p file)))) | |
8749abea GM |
3488 | |
3489 | (defun ange-ftp-file-executable-p (file) | |
0e14fe9f GM |
3490 | (let ((ange-ftp-process-verbose nil)) |
3491 | (setq file (expand-file-name file)) | |
3492 | (if (ange-ftp-ftp-name file) | |
3493 | (file-exists-p file) | |
3494 | (ange-ftp-real-file-executable-p file)))) | |
8749abea | 3495 | |
f1a5d776 CY |
3496 | (defun ange-ftp-delete-file (file &optional trash) |
3497 | (interactive (list (read-file-name "Delete file: " nil default-directory) | |
3498 | (null current-prefix-arg))) | |
8749abea GM |
3499 | (setq file (expand-file-name file)) |
3500 | (let ((parsed (ange-ftp-ftp-name file))) | |
3501 | (if parsed | |
3502 | (let* ((host (nth 0 parsed)) | |
3503 | (user (nth 1 parsed)) | |
3504 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3505 | (abbr (ange-ftp-abbreviate-filename file)) | |
3506 | (result (ange-ftp-send-cmd host user | |
3507 | (list 'delete name) | |
3508 | (format "Deleting %s" abbr)))) | |
3509 | (or (car result) | |
3510 | (signal 'ftp-error | |
3511 | (list | |
3512 | "Removing old name" | |
3513 | (format "FTP Error: \"%s\"" (cdr result)) | |
3514 | file))) | |
3515 | (ange-ftp-delete-file-entry file)) | |
f1a5d776 | 3516 | (ange-ftp-real-delete-file file trash)))) |
8749abea | 3517 | |
25759a92 | 3518 | (defun ange-ftp-file-modtime (file) |
6573d87f GM |
3519 | "Return the modification time of remote file FILE. |
3520 | Value is (0 0) if the modification time cannot be determined." | |
25759a92 | 3521 | (let* ((parsed (ange-ftp-ftp-name file)) |
6573d87f GM |
3522 | ;; At least one FTP server (wu-ftpd) can return a "226 |
3523 | ;; Transfer complete" before the "213 MODTIME". Let's skip | |
3524 | ;; that. | |
3525 | (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226")) | |
25759a92 | 3526 | (res (ange-ftp-send-cmd (car parsed) (cadr parsed) |
6573d87f GM |
3527 | (list 'quote "mdtm" (cadr (cdr parsed))))) |
3528 | (line (cdr res)) | |
3529 | (modtime '(0 0))) | |
524ac5b2 GM |
3530 | ;; MDTM should return "213 YYYYMMDDhhmmss" GMT on success |
3531 | ;; following the Internet draft for FTP extensions. | |
3532 | ;; Bob@rattlesnake.com reports that is returns something different | |
3533 | ;; for at least one FTP server. So, let's use the response only | |
3534 | ;; if it matches the Internet draft. | |
4671dba5 | 3535 | (when (string-match-p "^213 [0-9]\\{14\\}$" line) |
6573d87f GM |
3536 | (setq modtime |
3537 | (encode-time | |
3538 | (string-to-number (substring line 16 18)) | |
3539 | (string-to-number (substring line 14 16)) | |
3540 | (string-to-number (substring line 12 14)) | |
3541 | (string-to-number (substring line 10 12)) | |
3542 | (string-to-number (substring line 8 10)) | |
3543 | (string-to-number (substring line 4 8)) | |
3544 | 0))) | |
3545 | modtime)) | |
25759a92 | 3546 | |
8749abea GM |
3547 | (defun ange-ftp-verify-visited-file-modtime (buf) |
3548 | (let ((name (buffer-file-name buf))) | |
3549 | (if (and (stringp name) (ange-ftp-ftp-name name)) | |
25759a92 SS |
3550 | (let ((file-mdtm (ange-ftp-file-modtime name)) |
3551 | (buf-mdtm (with-current-buffer buf (visited-file-modtime)))) | |
3552 | (or (zerop (car file-mdtm)) | |
9d453139 | 3553 | (<= (float-time file-mdtm) (float-time buf-mdtm)))) |
8749abea | 3554 | (ange-ftp-real-verify-visited-file-modtime buf)))) |
412707c2 SM |
3555 | |
3556 | (defun ange-ftp-file-size (file &optional ascii-mode) | |
3557 | "Return the size of remote file FILE. Return -1 if can't get it. | |
3558 | If ascii-mode is non-nil, return the size with the extra octets that | |
3559 | need to be inserted, one at the end of each line, to provide correct | |
3560 | end-of-line semantics for a transfer using TYPE=A. The default is nil, | |
3561 | so return the size on the remote host exactly. See RFC 3659." | |
3562 | (let* ((parsed (ange-ftp-ftp-name file)) | |
3563 | (host (nth 0 parsed)) | |
3564 | (user (nth 1 parsed)) | |
3565 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3566 | ;; At least one FTP server (wu-ftpd) can return a "226 | |
3567 | ;; Transfer complete" before the "213 SIZE". Let's skip | |
3568 | ;; that. | |
3569 | (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226")) | |
2b93080a SM |
3570 | (res (unwind-protect |
3571 | (progn | |
3572 | (unless ascii-mode | |
3573 | (ange-ftp-set-binary-mode host user)) | |
3574 | (ange-ftp-send-cmd host user (list 'quote "size" name))) | |
412707c2 SM |
3575 | (unless ascii-mode |
3576 | (ange-ftp-set-ascii-mode host user)))) | |
3577 | (line (cdr res))) | |
3578 | (if (string-match "^213 \\([0-9]+\\)$" line) | |
3579 | (string-to-number (match-string 1 line)) | |
3580 | -1))) | |
3581 | ||
8749abea GM |
3582 | \f |
3583 | ;;;; ------------------------------------------------------------ | |
3584 | ;;;; File copying support... totally re-written 6/24/92. | |
3585 | ;;;; ------------------------------------------------------------ | |
3586 | ||
3587 | (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive) | |
3588 | (if (file-exists-p absname) | |
3589 | (if (not interactive) | |
3590 | (signal 'file-already-exists (list absname)) | |
3591 | (if (not (yes-or-no-p (format "File %s already exists; %s anyway? " | |
3592 | absname querystring))) | |
3593 | (signal 'file-already-exists (list absname)))))) | |
3594 | ||
3595 | ;; async local copy commented out for now since I don't seem to get | |
3596 | ;; the process sentinel called for some processes. | |
3597 | ;; | |
3598 | ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists | |
3599 | ;; keep-date cont) | |
3600 | ;; "Kludge to copy a local file and call a continuation when the copy | |
3601 | ;; finishes." | |
3602 | ;; ;; check to see if we can overwrite | |
3603 | ;; (if (or (not ok-if-already-exists) | |
3604 | ;; (numberp ok-if-already-exists)) | |
25759a92 | 3605 | ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it" |
8749abea GM |
3606 | ;; (numberp ok-if-already-exists))) |
3607 | ;; (let ((proc (start-process " *copy*" | |
3608 | ;; (generate-new-buffer "*copy*") | |
3609 | ;; "cp" | |
3610 | ;; filename | |
3611 | ;; newname)) | |
3612 | ;; res) | |
e3441f42 | 3613 | ;; (set-process-sentinel proc 'ange-ftp-copy-file-locally-sentinel) |
8749abea | 3614 | ;; (process-kill-without-query proc) |
67f300f8 SM |
3615 | ;; (with-current-buffer (process-buffer proc) |
3616 | ;; (set (make-local-variable 'copy-cont) cont)))) | |
25759a92 | 3617 | ;; |
8749abea | 3618 | ;; (defun ange-ftp-copy-file-locally-sentinel (proc status) |
b63f6e81 | 3619 | ;; (with-current-buffer (process-buffer proc) |
8749abea GM |
3620 | ;; (let ((cont copy-cont) |
3621 | ;; (result (buffer-string))) | |
3622 | ;; (unwind-protect | |
3623 | ;; (if (and (string-equal status "finished\n") | |
3624 | ;; (zerop (length result))) | |
3625 | ;; (ange-ftp-call-cont cont t nil) | |
3626 | ;; (ange-ftp-call-cont cont | |
3627 | ;; nil | |
3628 | ;; (if (zerop (length result)) | |
3629 | ;; (substring status 0 -1) | |
3630 | ;; (substring result 0 -1)))) | |
3631 | ;; (kill-buffer (current-buffer)))))) | |
3632 | ||
3633 | ;; this is the extended version of ange-ftp-copy-file-internal that works | |
3634 | ;; asynchronously if asked nicely. | |
3635 | (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists | |
3636 | keep-date &optional msg cont nowait) | |
3637 | (setq filename (expand-file-name filename) | |
3638 | newname (expand-file-name newname)) | |
3639 | ||
3640 | ;; canonicalize newname if a directory. | |
3641 | (if (file-directory-p newname) | |
3642 | (setq newname (expand-file-name (file-name-nondirectory filename) newname))) | |
3643 | ||
3644 | (let ((f-parsed (ange-ftp-ftp-name filename)) | |
3645 | (t-parsed (ange-ftp-ftp-name newname))) | |
3646 | ||
3647 | ;; local file to local file copy? | |
3648 | (if (and (not f-parsed) (not t-parsed)) | |
3649 | (progn | |
3650 | (ange-ftp-real-copy-file filename newname ok-if-already-exists | |
3651 | keep-date) | |
3652 | (if cont | |
3653 | (ange-ftp-call-cont cont t "Copied locally"))) | |
3654 | ;; one or both files are remote. | |
3655 | (let* ((f-host (and f-parsed (nth 0 f-parsed))) | |
3656 | (f-user (and f-parsed (nth 1 f-parsed))) | |
3657 | (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed)))) | |
3658 | (f-abbr (ange-ftp-abbreviate-filename filename)) | |
3659 | (t-host (and t-parsed (nth 0 t-parsed))) | |
3660 | (t-user (and t-parsed (nth 1 t-parsed))) | |
3661 | (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed)))) | |
3662 | (t-abbr (ange-ftp-abbreviate-filename newname filename)) | |
3663 | (binary (or (ange-ftp-binary-file filename) | |
a6bc05e1 | 3664 | (ange-ftp-binary-file newname))) |
8749abea GM |
3665 | temp1 |
3666 | temp2) | |
3667 | ||
3668 | ;; check to see if we can overwrite | |
3669 | (if (or (not ok-if-already-exists) | |
3670 | (numberp ok-if-already-exists)) | |
25759a92 | 3671 | (ange-ftp-barf-or-query-if-file-exists newname "copy to it" |
8749abea GM |
3672 | (numberp ok-if-already-exists))) |
3673 | ||
3674 | ;; do the copying. | |
3675 | (if f-parsed | |
25759a92 | 3676 | |
8749abea GM |
3677 | ;; filename was remote. |
3678 | (progn | |
3679 | (if (or (ange-ftp-use-gateway-p f-host) | |
3680 | t-parsed) | |
3681 | ;; have to use intermediate file if we are getting via | |
3682 | ;; gateway machine or we are doing a remote to remote copy. | |
3683 | (setq temp1 (ange-ftp-make-tmp-name f-host))) | |
25759a92 | 3684 | |
8749abea GM |
3685 | (if binary |
3686 | (ange-ftp-set-binary-mode f-host f-user)) | |
3687 | ||
3688 | (ange-ftp-send-cmd | |
3689 | f-host | |
3690 | f-user | |
3691 | (list 'get f-name (or temp1 (ange-ftp-quote-string newname))) | |
3692 | (or msg | |
3693 | (if (and temp1 t-parsed) | |
3694 | (format "Getting %s" f-abbr) | |
3695 | (format "Copying %s to %s" f-abbr t-abbr))) | |
e3441f42 | 3696 | (list 'ange-ftp-cf1 |
8749abea GM |
3697 | filename newname binary msg |
3698 | f-parsed f-host f-user f-name f-abbr | |
3699 | t-parsed t-host t-user t-name t-abbr | |
3700 | temp1 temp2 cont nowait) | |
3701 | nowait)) | |
3702 | ||
3703 | ;; filename wasn't remote. newname must be remote. call the | |
3704 | ;; function which does the remainder of the copying work. | |
3705 | (ange-ftp-cf1 t nil | |
3706 | filename newname binary msg | |
3707 | f-parsed f-host f-user f-name f-abbr | |
3708 | t-parsed t-host t-user t-name t-abbr | |
3709 | nil nil cont nowait)))))) | |
3710 | ||
3711 | (defvar ange-ftp-waiting-flag nil) | |
3712 | ||
3713 | ;; next part of copying routine. | |
3714 | (defun ange-ftp-cf1 (result line | |
3715 | filename newname binary msg | |
3716 | f-parsed f-host f-user f-name f-abbr | |
3717 | t-parsed t-host t-user t-name t-abbr | |
3718 | temp1 temp2 cont nowait) | |
3719 | (if line | |
3720 | ;; filename must have been remote, and we must have just done a GET. | |
3721 | (unwind-protect | |
3722 | (or result | |
3723 | ;; GET failed for some reason. Clean up and get out. | |
3724 | (progn | |
3725 | (and temp1 (ange-ftp-del-tmp-name temp1)) | |
3726 | (or cont | |
3727 | (if ange-ftp-waiting-flag | |
3728 | (throw 'ftp-error t) | |
3729 | (signal 'ftp-error | |
3730 | (list "Opening input file" | |
3731 | (format "FTP Error: \"%s\"" line) | |
3732 | filename)))))) | |
3733 | ;; cleanup | |
3734 | (if binary | |
3735 | (ange-ftp-set-ascii-mode f-host f-user)))) | |
3736 | ||
3737 | (if result | |
3738 | ;; We now have to copy either temp1 or filename to newname. | |
3739 | (if t-parsed | |
25759a92 | 3740 | |
8749abea GM |
3741 | ;; newname was remote. |
3742 | (progn | |
3743 | (if (ange-ftp-use-gateway-p t-host) | |
3744 | (setq temp2 (ange-ftp-make-tmp-name t-host))) | |
25759a92 | 3745 | |
8749abea GM |
3746 | ;; make sure data is moved into the right place for the |
3747 | ;; outgoing transfer. gateway temporary files complicate | |
3748 | ;; things nicely. | |
3749 | (if temp1 | |
3750 | (if temp2 | |
3751 | (if (string-equal temp1 temp2) | |
3752 | (setq temp1 nil) | |
3753 | (ange-ftp-real-copy-file temp1 temp2 t)) | |
3754 | (setq temp2 temp1 temp1 nil)) | |
3755 | (if temp2 | |
3756 | (ange-ftp-real-copy-file filename temp2 t))) | |
25759a92 | 3757 | |
8749abea GM |
3758 | (if binary |
3759 | (ange-ftp-set-binary-mode t-host t-user)) | |
3760 | ||
3761 | ;; tell the process filter what size the file is. | |
3762 | (let ((attr (file-attributes (or temp2 filename)))) | |
3763 | (if attr | |
3764 | (ange-ftp-set-xfer-size t-host t-user (nth 7 attr)))) | |
3765 | ||
3766 | (ange-ftp-send-cmd | |
3767 | t-host | |
3768 | t-user | |
1860f08d | 3769 | (list 'put (or temp2 (ange-ftp-quote-string filename)) t-name) |
8749abea GM |
3770 | (or msg |
3771 | (if (and temp2 f-parsed) | |
3772 | (format "Putting %s" newname) | |
3773 | (format "Copying %s to %s" f-abbr t-abbr))) | |
e3441f42 | 3774 | (list 'ange-ftp-cf2 |
8749abea GM |
3775 | newname t-host t-user binary temp1 temp2 cont) |
3776 | nowait)) | |
25759a92 | 3777 | |
8749abea GM |
3778 | ;; newname wasn't remote. |
3779 | (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont)) | |
3780 | ||
3781 | ;; first copy failed, tell caller | |
3782 | (ange-ftp-call-cont cont result line))) | |
3783 | ||
3784 | ;; last part of copying routine. | |
3785 | (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont) | |
3786 | (unwind-protect | |
3787 | (if line | |
3788 | ;; result from doing a local to remote copy. | |
3789 | (unwind-protect | |
3790 | (progn | |
3791 | (or result | |
3792 | (or cont | |
3793 | (if ange-ftp-waiting-flag | |
3794 | (throw 'ftp-error t) | |
3795 | (signal 'ftp-error | |
3796 | (list "Opening output file" | |
3797 | (format "FTP Error: \"%s\"" line) | |
3798 | newname))))) | |
25759a92 | 3799 | |
8749abea | 3800 | (ange-ftp-add-file-entry newname)) |
25759a92 | 3801 | |
8749abea GM |
3802 | ;; cleanup. |
3803 | (if binary | |
3804 | (ange-ftp-set-ascii-mode t-host t-user))) | |
25759a92 | 3805 | |
8749abea GM |
3806 | ;; newname was local. |
3807 | (if temp1 | |
3808 | (ange-ftp-real-copy-file temp1 newname t))) | |
25759a92 | 3809 | |
8749abea GM |
3810 | ;; clean up |
3811 | (and temp1 (ange-ftp-del-tmp-name temp1)) | |
3812 | (and temp2 (ange-ftp-del-tmp-name temp2)) | |
3813 | (ange-ftp-call-cont cont result line))) | |
3814 | ||
3815 | (defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists | |
632c5478 MA |
3816 | keep-date preserve-uid-gid |
3817 | preserve-selinux-context) | |
8749abea GM |
3818 | (interactive "fCopy file: \nFCopy %s to file: \np") |
3819 | (ange-ftp-copy-file-internal filename | |
3820 | newname | |
3821 | ok-if-already-exists | |
3822 | keep-date | |
3823 | nil | |
3824 | nil | |
32226619 | 3825 | (called-interactively-p 'interactive))) |
b878b8c3 SS |
3826 | |
3827 | (defun ange-ftp-copy-files-async (okay-p line verbose-p files) | |
3828 | "Copy some files in the background. | |
4671dba5 | 3829 | OKAY-P must be t, and LINE does not matter. They are here to make this |
b878b8c3 SS |
3830 | function a valid CONT argument for `ange-ftp-raw-send-cmd'. |
3831 | If VERBOSE-P is non-nil, print progress report in the echo area. | |
3832 | When all the files have been copied already, a message is shown anyway. | |
3833 | FILES is a list of files to copy in the form | |
3834 | (from-file to-file ok-if-already-exists keep-date) | |
3835 | E.g., | |
3836 | (ange-ftp-copy-files-async t nil t '((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" | |
3837 | (unless okay-p (error "%s: %s" 'ange-ftp-copy-files-async line)) | |
3838 | (if files | |
3839 | (let* ((ff (car files)) | |
3840 | (from-file (nth 0 ff)) | |
3841 | (to-file (nth 1 ff)) | |
3842 | (ok-if-exists (nth 2 ff)) | |
3843 | (keep-date (nth 3 ff))) | |
3844 | (ange-ftp-copy-file-internal | |
3845 | from-file to-file ok-if-exists keep-date | |
3846 | (and verbose-p (format "%s --> %s" from-file to-file)) | |
3847 | (list 'ange-ftp-copy-files-async verbose-p (cdr files)) | |
3848 | t)) | |
6e85ef5f | 3849 | (message "%s: done" 'ange-ftp-copy-files-async))) |
b878b8c3 | 3850 | |
8749abea GM |
3851 | \f |
3852 | ;;;; ------------------------------------------------------------ | |
3853 | ;;;; File renaming support. | |
3854 | ;;;; ------------------------------------------------------------ | |
3855 | ||
3856 | (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed) | |
4671dba5 | 3857 | "Rename remote file FILENAME to remote file NEWNAME." |
8749abea GM |
3858 | (let ((f-host (nth 0 f-parsed)) |
3859 | (f-user (nth 1 f-parsed)) | |
3860 | (t-host (nth 0 t-parsed)) | |
3861 | (t-user (nth 1 t-parsed))) | |
3862 | (if (and (string-equal f-host t-host) | |
3863 | (string-equal f-user t-user)) | |
3864 | (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed))) | |
3865 | (t-name (ange-ftp-quote-string (nth 2 t-parsed))) | |
3866 | (cmd (list 'rename f-name t-name)) | |
3867 | (fabbr (ange-ftp-abbreviate-filename filename)) | |
3868 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3869 | (result (ange-ftp-send-cmd f-host f-user cmd | |
3870 | (format "Renaming %s to %s" | |
3871 | fabbr | |
3872 | nabbr)))) | |
3873 | (or (car result) | |
3874 | (signal 'ftp-error | |
3875 | (list | |
3876 | "Renaming" | |
3877 | (format "FTP Error: \"%s\"" (cdr result)) | |
3878 | filename | |
3879 | newname))) | |
3880 | (ange-ftp-add-file-entry newname) | |
3881 | (ange-ftp-delete-file-entry filename)) | |
3882 | (ange-ftp-copy-file-internal filename newname t nil) | |
f1a5d776 | 3883 | (delete-file filename)))) |
8749abea GM |
3884 | |
3885 | (defun ange-ftp-rename-local-to-remote (filename newname) | |
4671dba5 | 3886 | "Rename local file FILENAME to remote file NEWNAME." |
8749abea GM |
3887 | (let* ((fabbr (ange-ftp-abbreviate-filename filename)) |
3888 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3889 | (msg (format "Renaming %s to %s" fabbr nabbr))) | |
3890 | (ange-ftp-copy-file-internal filename newname t nil msg) | |
3891 | (let (ange-ftp-process-verbose) | |
f1a5d776 | 3892 | (delete-file filename)))) |
8749abea GM |
3893 | |
3894 | (defun ange-ftp-rename-remote-to-local (filename newname) | |
3895 | "Rename remote file FILENAME to local file NEWNAME." | |
3896 | (let* ((fabbr (ange-ftp-abbreviate-filename filename)) | |
3897 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3898 | (msg (format "Renaming %s to %s" fabbr nabbr))) | |
3899 | (ange-ftp-copy-file-internal filename newname t nil msg) | |
3900 | (let (ange-ftp-process-verbose) | |
f1a5d776 | 3901 | (delete-file filename)))) |
8749abea GM |
3902 | |
3903 | (defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists) | |
3904 | (interactive "fRename file: \nFRename %s to file: \np") | |
3905 | (setq filename (expand-file-name filename)) | |
3906 | (setq newname (expand-file-name newname)) | |
3907 | (let* ((f-parsed (ange-ftp-ftp-name filename)) | |
3908 | (t-parsed (ange-ftp-ftp-name newname))) | |
3909 | (if (and (or f-parsed t-parsed) | |
3910 | (or (not ok-if-already-exists) | |
3911 | (numberp ok-if-already-exists))) | |
3912 | (ange-ftp-barf-or-query-if-file-exists | |
3913 | newname | |
3914 | "rename to it" | |
3915 | (numberp ok-if-already-exists))) | |
3916 | (if f-parsed | |
3917 | (if t-parsed | |
3918 | (ange-ftp-rename-remote-to-remote filename newname f-parsed | |
3919 | t-parsed) | |
3920 | (ange-ftp-rename-remote-to-local filename newname)) | |
3921 | (if t-parsed | |
3922 | (ange-ftp-rename-local-to-remote filename newname) | |
3923 | (ange-ftp-real-rename-file filename newname ok-if-already-exists))))) | |
3924 | \f | |
3925 | ;;;; ------------------------------------------------------------ | |
3926 | ;;;; File name completion support. | |
3927 | ;;;; ------------------------------------------------------------ | |
3928 | ||
8749abea GM |
3929 | ;; If the file entry is not a directory (nor a symlink pointing to a directory) |
3930 | ;; returns whether the file (or file pointed to by the symlink) is ignored | |
3931 | ;; by completion-ignored-extensions. | |
3932 | ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern' | |
3933 | ;; are used as free variables. | |
6e85ef5f SM |
3934 | (defun ange-ftp-file-entry-not-ignored-p (symname val) |
3935 | (if (stringp val) | |
3936 | (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir))) | |
3937 | (or (file-directory-p file) | |
3938 | (and (file-exists-p file) | |
3939 | (not (string-match ange-ftp-completion-ignored-pattern | |
3940 | symname))))) | |
3941 | (or val ; is a directory name | |
3942 | (not (string-match ange-ftp-completion-ignored-pattern symname))))) | |
8749abea | 3943 | |
ae0bec0b SM |
3944 | (defun ange-ftp-root-dir-p (dir) |
3945 | ;; Maybe we should use something more like | |
3946 | ;; (equal dir (file-name-directory (directory-file-name dir))) -stef | |
3947 | (or (and (eq system-type 'windows-nt) | |
aa6f7b96 | 3948 | (string-match "\\`[a-zA-Z]:[/\\]\\'" dir)) |
ae0bec0b SM |
3949 | (string-equal "/" dir))) |
3950 | ||
8749abea GM |
3951 | (defun ange-ftp-file-name-all-completions (file dir) |
3952 | (let ((ange-ftp-this-dir (expand-file-name dir))) | |
3953 | (if (ange-ftp-ftp-name ange-ftp-this-dir) | |
3954 | (progn | |
3955 | (ange-ftp-barf-if-not-directory ange-ftp-this-dir) | |
3956 | (setq ange-ftp-this-dir | |
3957 | (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) | |
3958 | (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir)) | |
e3441f42 | 3959 | (completions (all-completions file tbl))) |
8749abea GM |
3960 | |
3961 | ;; see whether each matching file is a directory or not... | |
3962 | (mapcar | |
25759a92 | 3963 | (lambda (file) |
6e85ef5f | 3964 | (let ((ent (gethash file tbl))) |
25759a92 SS |
3965 | (if (and ent |
3966 | (or (not (stringp ent)) | |
3967 | (file-directory-p | |
3968 | (ange-ftp-expand-symlink ent | |
3969 | ange-ftp-this-dir)))) | |
3970 | (concat file "/") | |
6e85ef5f | 3971 | file))) |
8749abea GM |
3972 | completions))) |
3973 | ||
ae0bec0b | 3974 | (if (ange-ftp-root-dir-p ange-ftp-this-dir) |
8749abea GM |
3975 | (nconc (all-completions file (ange-ftp-generate-root-prefixes)) |
3976 | (ange-ftp-real-file-name-all-completions file | |
3977 | ange-ftp-this-dir)) | |
3978 | (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir))))) | |
3979 | ||
e1e17cae | 3980 | (defun ange-ftp-file-name-completion (file dir &optional predicate) |
8749abea GM |
3981 | (let ((ange-ftp-this-dir (expand-file-name dir))) |
3982 | (if (ange-ftp-ftp-name ange-ftp-this-dir) | |
3983 | (progn | |
3984 | (ange-ftp-barf-if-not-directory ange-ftp-this-dir) | |
3985 | (if (equal file "") | |
3986 | "" | |
3987 | (setq ange-ftp-this-dir | |
3988 | (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real? | |
3989 | (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir)) | |
3990 | (ange-ftp-completion-ignored-pattern | |
25759a92 | 3991 | (mapconcat (lambda (s) (if (stringp s) |
aa6f7b96 SM |
3992 | (concat (regexp-quote s) "$") |
3993 | "/")) ; / never in filename | |
8749abea GM |
3994 | completion-ignored-extensions |
3995 | "\\|"))) | |
3996 | (save-match-data | |
3997 | (or (ange-ftp-file-name-completion-1 | |
3998 | file tbl ange-ftp-this-dir | |
e3441f42 | 3999 | 'ange-ftp-file-entry-not-ignored-p) |
8749abea | 4000 | (ange-ftp-file-name-completion-1 |
e3441f42 | 4001 | file tbl ange-ftp-this-dir)))))) |
8749abea | 4002 | |
ae0bec0b | 4003 | (if (ange-ftp-root-dir-p ange-ftp-this-dir) |
8749abea GM |
4004 | (try-completion |
4005 | file | |
4006 | (nconc (ange-ftp-generate-root-prefixes) | |
7ca26b02 | 4007 | (ange-ftp-real-file-name-all-completions |
e1e17cae MA |
4008 | file ange-ftp-this-dir)) |
4009 | predicate) | |
4010 | (if predicate | |
4011 | (ange-ftp-real-file-name-completion | |
4012 | file ange-ftp-this-dir predicate) | |
4013 | (ange-ftp-real-file-name-completion | |
4014 | file ange-ftp-this-dir)))))) | |
8749abea GM |
4015 | |
4016 | ||
e3441f42 | 4017 | (defun ange-ftp-file-name-completion-1 (file tbl dir &optional predicate) |
8749abea GM |
4018 | (let ((bestmatch (try-completion file tbl predicate))) |
4019 | (if bestmatch | |
4020 | (if (eq bestmatch t) | |
4021 | (if (file-directory-p (expand-file-name file dir)) | |
4022 | (concat file "/") | |
4023 | t) | |
4024 | (if (and (eq (try-completion bestmatch tbl predicate) t) | |
4025 | (file-directory-p | |
4026 | (expand-file-name bestmatch dir))) | |
4027 | (concat bestmatch "/") | |
4028 | bestmatch))))) | |
4029 | ||
c7015153 | 4030 | ;; Put these lines uncommented in your .emacs if you want C-r to refresh |
8749abea GM |
4031 | ;; ange-ftp's cache whilst doing filename completion. |
4032 | ;; | |
4033 | ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir) | |
4034 | ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir) | |
4035 | ||
b2ce953f MR |
4036 | ;;;###autoload |
4037 | (defalias 'ange-ftp-re-read-dir 'ange-ftp-reread-dir) | |
4038 | ||
8749abea GM |
4039 | ;;;###autoload |
4040 | (defun ange-ftp-reread-dir (&optional dir) | |
4041 | "Reread remote directory DIR to update the directory cache. | |
4671dba5 | 4042 | The implementation of remote FTP file names caches directory contents |
8749abea GM |
4043 | for speed. Therefore, when new remote files are created, Emacs |
4044 | may not know they exist. You can use this command to reread a specific | |
4045 | directory, so that Emacs will know its current contents." | |
4046 | (interactive) | |
4047 | (if dir | |
4048 | (setq dir (expand-file-name dir)) | |
4049 | (setq dir (file-name-directory (expand-file-name (buffer-string))))) | |
4050 | (if (ange-ftp-ftp-name dir) | |
4051 | (progn | |
4052 | (setq ange-ftp-ls-cache-file nil) | |
6e85ef5f | 4053 | (remhash dir ange-ftp-files-hashtable) |
8749abea GM |
4054 | (ange-ftp-get-files dir t)))) |
4055 | \f | |
4056 | (defun ange-ftp-make-directory (dir &optional parents) | |
7e27ce9c | 4057 | (interactive (list (expand-file-name (read-directory-name "Make directory: ")))) |
8749abea GM |
4058 | (if parents |
4059 | (let ((parent (file-name-directory (directory-file-name dir)))) | |
4060 | (or (file-exists-p parent) | |
4061 | (ange-ftp-make-directory parent parents)))) | |
4062 | (if (file-exists-p dir) | |
4063 | (error "Cannot make directory %s: file already exists" dir) | |
4064 | (let ((parsed (ange-ftp-ftp-name dir))) | |
4065 | (if parsed | |
4066 | (let* ((host (nth 0 parsed)) | |
4067 | (user (nth 1 parsed)) | |
4068 | ;; Some ftp's on unix machines (at least on Suns) | |
4069 | ;; insist that mkdir take a filename, and not a | |
4070 | ;; directory-name name as an arg. Argh!! This is a bug. | |
4071 | ;; Non-unix machines will probably always insist | |
4072 | ;; that mkdir takes a directory-name as an arg | |
4073 | ;; (as the ftp man page says it should). | |
4074 | (name (ange-ftp-quote-string | |
4075 | (if (eq (ange-ftp-host-type host) 'unix) | |
4076 | (ange-ftp-real-directory-file-name (nth 2 parsed)) | |
4077 | (ange-ftp-real-file-name-as-directory | |
4078 | (nth 2 parsed))))) | |
4079 | (abbr (ange-ftp-abbreviate-filename dir)) | |
4080 | (result (ange-ftp-send-cmd host user | |
4081 | (list 'mkdir name) | |
4082 | (format "Making directory %s" | |
4083 | abbr)))) | |
4084 | (or (car result) | |
4085 | (ange-ftp-error host user | |
4086 | (format "Could not make directory %s: %s" | |
4087 | dir | |
4088 | (cdr result)))) | |
4089 | (ange-ftp-add-file-entry dir t)) | |
4090 | (ange-ftp-real-make-directory dir))))) | |
4091 | ||
c90a8a9f | 4092 | (defun ange-ftp-delete-directory (dir &optional recursive) |
8749abea GM |
4093 | (if (file-directory-p dir) |
4094 | (let ((parsed (ange-ftp-ftp-name dir))) | |
b3ee21ac MA |
4095 | (if recursive |
4096 | (mapc | |
4097 | (lambda (file) | |
4098 | (if (file-directory-p file) | |
4099 | (ange-ftp-delete-directory file recursive) | |
4100 | (delete-file file))) | |
4101 | ;; We do not want to delete "." and "..". | |
4102 | (directory-files | |
4103 | dir 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))) | |
8749abea GM |
4104 | (if parsed |
4105 | (let* ((host (nth 0 parsed)) | |
4106 | (user (nth 1 parsed)) | |
4107 | ;; Some ftp's on unix machines (at least on Suns) | |
4108 | ;; insist that rmdir take a filename, and not a | |
4109 | ;; directory-name name as an arg. Argh!! This is a bug. | |
4110 | ;; Non-unix machines will probably always insist | |
4111 | ;; that rmdir takes a directory-name as an arg | |
4112 | ;; (as the ftp man page says it should). | |
4113 | (name (ange-ftp-quote-string | |
4114 | (if (eq (ange-ftp-host-type host) 'unix) | |
4115 | (ange-ftp-real-directory-file-name | |
4116 | (nth 2 parsed)) | |
4117 | (ange-ftp-real-file-name-as-directory | |
4118 | (nth 2 parsed))))) | |
e3441f42 | 4119 | (abbr (ange-ftp-abbreviate-filename dir)) |
b3ee21ac MA |
4120 | (result |
4121 | (progn | |
4122 | ;; CWD must not in this directory. | |
4123 | (ange-ftp-cd host user "/" 'noerror) | |
4124 | (ange-ftp-send-cmd host user | |
4125 | (list 'rmdir name) | |
4126 | (format "Removing directory %s" | |
4127 | abbr))))) | |
8749abea GM |
4128 | (or (car result) |
4129 | (ange-ftp-error host user | |
4130 | (format "Could not remove directory %s: %s" | |
4131 | dir | |
4132 | (cdr result)))) | |
4133 | (ange-ftp-delete-file-entry dir t)) | |
c90a8a9f | 4134 | (ange-ftp-real-delete-directory dir recursive))) |
8749abea GM |
4135 | (error "Not a directory: %s" dir))) |
4136 | \f | |
4137 | ;; Make a local copy of FILE and return its name. | |
4138 | ||
4139 | (defun ange-ftp-file-local-copy (file) | |
4140 | (let* ((fn1 (expand-file-name file)) | |
4141 | (pa1 (ange-ftp-ftp-name fn1))) | |
4142 | (if pa1 | |
8982b231 KY |
4143 | (let ((tmp1 (ange-ftp-make-tmp-name (car pa1) |
4144 | (file-name-extension file t)))) | |
8749abea GM |
4145 | (ange-ftp-copy-file-internal fn1 tmp1 t nil |
4146 | (format "Getting %s" fn1)) | |
4147 | tmp1)))) | |
4148 | ||
3bd84a22 MA |
4149 | (defun ange-ftp-file-remote-p (file &optional identification connected) |
4150 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4151 | (host (nth 0 parsed)) | |
d5fb39b4 MA |
4152 | (user (nth 1 parsed)) |
4153 | (localname (nth 2 parsed))) | |
3bd84a22 MA |
4154 | (and (or (not connected) |
4155 | (let ((proc (get-process (ange-ftp-ftp-process-buffer host user)))) | |
4156 | (and proc (processp proc) | |
4157 | (memq (process-status proc) '(run open))))) | |
4158 | (cond | |
4159 | ((eq identification 'method) (and parsed "ftp")) | |
4160 | ((eq identification 'user) user) | |
4161 | ((eq identification 'host) host) | |
d5fb39b4 | 4162 | ((eq identification 'localname) localname) |
3bd84a22 | 4163 | (t (ange-ftp-replace-name-component file "")))))) |
e28c0668 | 4164 | |
8749abea GM |
4165 | (defun ange-ftp-load (file &optional noerror nomessage nosuffix) |
4166 | (if (ange-ftp-ftp-name file) | |
4167 | (let ((tryfiles (if nosuffix | |
4168 | (list file) | |
4169 | (list (concat file ".elc") (concat file ".el") file))) | |
4170 | ;; make sure there are no references to temp files | |
4171 | (load-force-doc-strings t) | |
4172 | copy) | |
4173 | (while (and tryfiles (not copy)) | |
4174 | (catch 'ftp-error | |
4175 | (let ((ange-ftp-waiting-flag t)) | |
4176 | (condition-case error | |
4177 | (setq copy (ange-ftp-file-local-copy (car tryfiles))) | |
4178 | (ftp-error nil)))) | |
4179 | (setq tryfiles (cdr tryfiles))) | |
4180 | (if copy | |
4181 | (unwind-protect | |
4182 | (funcall 'load copy noerror nomessage nosuffix) | |
f1a5d776 | 4183 | (delete-file copy)) |
8749abea GM |
4184 | (or noerror |
4185 | (signal 'file-error (list "Cannot open load file" file))) | |
4186 | nil)) | |
4187 | (ange-ftp-real-load file noerror nomessage nosuffix))) | |
4188 | ||
4189 | ;; Calculate default-unhandled-directory for a given ange-ftp buffer. | |
4190 | (defun ange-ftp-unhandled-file-name-directory (filename) | |
e61e836b | 4191 | nil) |
8749abea GM |
4192 | |
4193 | \f | |
4194 | ;; Need the following functions for making filenames of compressed | |
4195 | ;; files, because some OS's (unlike UNIX) do not allow a filename to | |
4196 | ;; have two extensions. | |
4197 | ||
4198 | (defvar ange-ftp-make-compressed-filename-alist nil | |
4199 | "Alist of host-type-specific functions to process file names for compression. | |
4200 | Each element has the form (TYPE . FUNC). | |
4201 | FUNC should take one argument, a file name, and return a list | |
4202 | of the form (COMPRESSING NEWNAME). | |
25759a92 | 4203 | COMPRESSING should be t if the specified file should be compressed, |
8749abea GM |
4204 | and nil if it should be uncompressed (that is, if it is a compressed file). |
4205 | NEWNAME should be the name to give the new compressed or uncompressed file.") | |
4206 | ||
7e596924 GM |
4207 | (declare-function dired-compress-file "dired-aux" (file)) |
4208 | ||
8749abea | 4209 | (defun ange-ftp-dired-compress-file (name) |
7e596924 | 4210 | "Handler used by `dired-compress-file'." |
8749abea GM |
4211 | (let ((parsed (ange-ftp-ftp-name name)) |
4212 | conversion-func) | |
4213 | (if (and parsed | |
4214 | (setq conversion-func | |
4215 | (cdr (assq (ange-ftp-host-type (car parsed)) | |
4216 | ange-ftp-make-compressed-filename-alist)))) | |
4217 | (let* ((decision | |
4218 | (save-match-data (funcall conversion-func name))) | |
4219 | (compressing (car decision)) | |
4220 | (newfile (nth 1 decision))) | |
4221 | (if compressing | |
4222 | (ange-ftp-compress name newfile) | |
4223 | (ange-ftp-uncompress name newfile))) | |
4224 | (let (file-name-handler-alist) | |
4225 | (dired-compress-file name))))) | |
4226 | ||
4227 | ;; Copy FILE to this machine, compress it, and copy out to NFILE. | |
4228 | (defun ange-ftp-compress (file nfile) | |
4229 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4230 | (tmp1 (ange-ftp-make-tmp-name (car parsed))) | |
4231 | (tmp2 (ange-ftp-make-tmp-name (car parsed))) | |
4232 | (abbr (ange-ftp-abbreviate-filename file)) | |
4233 | (nabbr (ange-ftp-abbreviate-filename nfile)) | |
4234 | (msg1 (format "Getting %s" abbr)) | |
4235 | (msg2 (format "Putting %s" nabbr))) | |
4236 | (unwind-protect | |
4237 | (progn | |
4238 | (ange-ftp-copy-file-internal file tmp1 t nil msg1) | |
4239 | (and ange-ftp-process-verbose | |
4240 | (ange-ftp-message "Compressing %s..." abbr)) | |
4241 | (call-process-region (point) | |
4242 | (point) | |
4243 | shell-file-name | |
4244 | nil | |
4245 | t | |
4246 | nil | |
4247 | "-c" | |
4248 | (format "compress -f -c < %s > %s" tmp1 tmp2)) | |
4249 | (and ange-ftp-process-verbose | |
4250 | (ange-ftp-message "Compressing %s...done" abbr)) | |
4251 | (if (zerop (buffer-size)) | |
4252 | (progn | |
4253 | (let (ange-ftp-process-verbose) | |
f1a5d776 | 4254 | (delete-file file)) |
8749abea GM |
4255 | (ange-ftp-copy-file-internal tmp2 nfile t nil msg2)))) |
4256 | (ange-ftp-del-tmp-name tmp1) | |
4257 | (ange-ftp-del-tmp-name tmp2)))) | |
25759a92 | 4258 | |
8749abea GM |
4259 | ;; Copy FILE to this machine, uncompress it, and copy out to NFILE. |
4260 | (defun ange-ftp-uncompress (file nfile) | |
4261 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4262 | (tmp1 (ange-ftp-make-tmp-name (car parsed))) | |
4263 | (tmp2 (ange-ftp-make-tmp-name (car parsed))) | |
4264 | (abbr (ange-ftp-abbreviate-filename file)) | |
4265 | (nabbr (ange-ftp-abbreviate-filename nfile)) | |
4266 | (msg1 (format "Getting %s" abbr)) | |
4267 | (msg2 (format "Putting %s" nabbr)) | |
4268 | ;; ;; Cheap hack because of problems with binary file transfers from | |
4269 | ;; ;; VMS hosts. | |
4270 | ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed))))) | |
4271 | ) | |
4272 | (unwind-protect | |
4273 | (progn | |
4274 | (ange-ftp-copy-file-internal file tmp1 t nil msg1) | |
4275 | (and ange-ftp-process-verbose | |
4276 | (ange-ftp-message "Uncompressing %s..." abbr)) | |
4277 | (call-process-region (point) | |
4278 | (point) | |
4279 | shell-file-name | |
4280 | nil | |
4281 | t | |
4282 | nil | |
4283 | "-c" | |
4284 | (format "uncompress -c < %s > %s" tmp1 tmp2)) | |
4285 | (and ange-ftp-process-verbose | |
4286 | (ange-ftp-message "Uncompressing %s...done" abbr)) | |
4287 | (if (zerop (buffer-size)) | |
4288 | (progn | |
4289 | (let (ange-ftp-process-verbose) | |
f1a5d776 | 4290 | (delete-file file)) |
8749abea GM |
4291 | (ange-ftp-copy-file-internal tmp2 nfile t nil msg2)))) |
4292 | (ange-ftp-del-tmp-name tmp1) | |
4293 | (ange-ftp-del-tmp-name tmp2)))) | |
4294 | ||
4295 | (defun ange-ftp-find-backup-file-name (fn) | |
4296 | ;; Either return the ordinary backup name, etc., | |
4297 | ;; or return nil meaning don't make a backup. | |
4298 | (if ange-ftp-make-backup-files | |
4299 | (ange-ftp-real-find-backup-file-name fn))) | |
4300 | \f | |
4301 | ;;; Define the handler for special file names | |
4302 | ;;; that causes ange-ftp to be invoked. | |
4303 | ||
4304 | ;;;###autoload | |
4305 | (defun ange-ftp-hook-function (operation &rest args) | |
4306 | (let ((fn (get operation 'ange-ftp))) | |
227eb744 MA |
4307 | (if fn |
4308 | ;; Catch also errors in process-filter. | |
4309 | (condition-case err | |
4310 | (let ((debug-on-error t)) | |
4311 | (save-match-data (apply fn args))) | |
75c23f5f | 4312 | (error (signal (car err) (cdr err)))) |
8749abea | 4313 | (ange-ftp-run-real-handler operation args)))) |
8749abea | 4314 | |
65399e83 KG |
4315 | ;; The following code is commented out because Tramp now deals with |
4316 | ;; Ange-FTP filenames, too. | |
4317 | ||
4318 | ;;-;;; This regexp takes care of real ange-ftp file names (with a slash | |
4319 | ;;-;;; and colon). | |
4320 | ;;-;;; Don't allow the host name to end in a period--some systems use /.: | |
4321 | ;;-;;;###autoload | |
4322 | ;;-(or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist) | |
4323 | ;;- (setq file-name-handler-alist | |
4324 | ;;- (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function) | |
4325 | ;;- file-name-handler-alist))) | |
4326 | ;;- | |
4327 | ;;-;;; This regexp recognizes absolute filenames with only one component, | |
4328 | ;;-;;; for the sake of hostname completion. | |
4329 | ;;-;;;###autoload | |
4330 | ;;-(or (assoc "^/[^/:]*\\'" file-name-handler-alist) | |
4331 | ;;- (setq file-name-handler-alist | |
4332 | ;;- (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function) | |
4333 | ;;- file-name-handler-alist))) | |
4334 | ;;- | |
4335 | ;;-;;; This regexp recognizes absolute filenames with only one component | |
4336 | ;;-;;; on Windows, for the sake of hostname completion. | |
4337 | ;;-;;; NB. Do not mark this as autoload, because it is very common to | |
4338 | ;;-;;; do completions in the root directory of drives on Windows. | |
4339 | ;;-(and (memq system-type '(ms-dos windows-nt)) | |
4340 | ;;- (or (assoc "^[a-zA-Z]:/[^/:]*\\'" file-name-handler-alist) | |
4341 | ;;- (setq file-name-handler-alist | |
4342 | ;;- (cons '("^[a-zA-Z]:/[^/:]*\\'" . | |
4343 | ;;- ange-ftp-completion-hook-function) | |
4344 | ;;- file-name-handler-alist)))) | |
8749abea GM |
4345 | |
4346 | ;;; The above two forms are sufficient to cause this file to be loaded | |
4347 | ;;; if the user ever uses a file name with a colon in it. | |
4348 | ||
25759a92 | 4349 | ;;; This sets the mode |
c8607dc7 | 4350 | (add-hook 'find-file-hook 'ange-ftp-set-buffer-mode) |
8749abea GM |
4351 | |
4352 | ;;; Now say where to find the handlers for particular operations. | |
4353 | ||
4354 | (put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory) | |
4355 | (put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory) | |
4356 | (put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory) | |
4357 | (put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name) | |
4358 | (put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name) | |
4359 | (put 'make-directory 'ange-ftp 'ange-ftp-make-directory) | |
4360 | (put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory) | |
4361 | (put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents) | |
4362 | (put 'directory-files 'ange-ftp 'ange-ftp-directory-files) | |
f06dbf7e MA |
4363 | (put 'directory-files-and-attributes 'ange-ftp |
4364 | 'ange-ftp-directory-files-and-attributes) | |
8749abea GM |
4365 | (put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p) |
4366 | (put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p) | |
4367 | (put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p) | |
4368 | (put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p) | |
4369 | (put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p) | |
4370 | (put 'delete-file 'ange-ftp 'ange-ftp-delete-file) | |
8749abea GM |
4371 | (put 'verify-visited-file-modtime 'ange-ftp |
4372 | 'ange-ftp-verify-visited-file-modtime) | |
4373 | (put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p) | |
4374 | (put 'write-region 'ange-ftp 'ange-ftp-write-region) | |
8749abea GM |
4375 | (put 'copy-file 'ange-ftp 'ange-ftp-copy-file) |
4376 | (put 'rename-file 'ange-ftp 'ange-ftp-rename-file) | |
4377 | (put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes) | |
a1f84f6d | 4378 | (put 'file-newer-than-file-p 'ange-ftp 'ange-ftp-file-newer-than-file-p) |
8749abea GM |
4379 | (put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions) |
4380 | (put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion) | |
4381 | (put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory) | |
4382 | (put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy) | |
e28c0668 | 4383 | (put 'file-remote-p 'ange-ftp 'ange-ftp-file-remote-p) |
8749abea GM |
4384 | (put 'unhandled-file-name-directory 'ange-ftp |
4385 | 'ange-ftp-unhandled-file-name-directory) | |
4386 | (put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions) | |
4387 | (put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache) | |
4388 | (put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file) | |
4389 | (put 'load 'ange-ftp 'ange-ftp-load) | |
4390 | (put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name) | |
c42e03b4 | 4391 | (put 'set-file-modes 'ange-ftp 'ange-ftp-set-file-modes) |
8749abea GM |
4392 | |
4393 | ;; Turn off truename processing to save time. | |
4394 | ;; Treat each name as its own truename. | |
4395 | (put 'file-truename 'ange-ftp 'identity) | |
4396 | ||
b83483d5 MA |
4397 | ;; We must return non-nil in order to mask our inability to do the job. |
4398 | ;; Otherwise there are errors when applied to the target file during | |
4399 | ;; copying from a (localhost) Tramp file. | |
b83483d5 MA |
4400 | (put 'set-file-times 'ange-ftp 'ignore) |
4401 | ||
8749abea GM |
4402 | ;; Turn off RCS/SCCS processing to save time. |
4403 | ;; This returns nil for any file name as argument. | |
4404 | (put 'vc-registered 'ange-ftp 'null) | |
4405 | ||
00d6fd04 | 4406 | ;; We can handle process-file in a restricted way (just for chown). |
b83483d5 | 4407 | ;; Nothing possible for `start-file-process'. |
4a725859 | 4408 | (put 'process-file 'ange-ftp 'ange-ftp-process-file) |
00d6fd04 | 4409 | (put 'start-file-process 'ange-ftp 'ignore) |
8749abea GM |
4410 | (put 'shell-command 'ange-ftp 'ange-ftp-shell-command) |
4411 | \f | |
4412 | ;;; Define ways of getting at unmodified Emacs primitives, | |
4413 | ;;; turning off our handler. | |
4414 | ||
28dbc92f MA |
4415 | ;(defun ange-ftp-run-real-handler (operation args) |
4416 | ; (let ((inhibit-file-name-handlers | |
4417 | ; (cons 'ange-ftp-hook-function | |
4418 | ; (cons 'ange-ftp-completion-hook-function | |
4419 | ; (and (eq inhibit-file-name-operation operation) | |
4420 | ; inhibit-file-name-handlers)))) | |
4421 | ; (inhibit-file-name-operation operation)) | |
4422 | ; (apply operation args))) | |
4423 | ||
4424 | (defalias 'ange-ftp-run-real-handler 'tramp-run-real-handler) | |
8749abea GM |
4425 | |
4426 | (defun ange-ftp-real-file-name-directory (&rest args) | |
4427 | (ange-ftp-run-real-handler 'file-name-directory args)) | |
4428 | (defun ange-ftp-real-file-name-nondirectory (&rest args) | |
4429 | (ange-ftp-run-real-handler 'file-name-nondirectory args)) | |
4430 | (defun ange-ftp-real-file-name-as-directory (&rest args) | |
4431 | (ange-ftp-run-real-handler 'file-name-as-directory args)) | |
4432 | (defun ange-ftp-real-directory-file-name (&rest args) | |
4433 | (ange-ftp-run-real-handler 'directory-file-name args)) | |
4434 | (defun ange-ftp-real-expand-file-name (&rest args) | |
4435 | (ange-ftp-run-real-handler 'expand-file-name args)) | |
4436 | (defun ange-ftp-real-make-directory (&rest args) | |
4437 | (ange-ftp-run-real-handler 'make-directory args)) | |
4438 | (defun ange-ftp-real-delete-directory (&rest args) | |
4439 | (ange-ftp-run-real-handler 'delete-directory args)) | |
4440 | (defun ange-ftp-real-insert-file-contents (&rest args) | |
4441 | (ange-ftp-run-real-handler 'insert-file-contents args)) | |
4442 | (defun ange-ftp-real-directory-files (&rest args) | |
4443 | (ange-ftp-run-real-handler 'directory-files args)) | |
f06dbf7e MA |
4444 | (defun ange-ftp-real-directory-files-and-attributes (&rest args) |
4445 | (ange-ftp-run-real-handler 'directory-files-and-attributes args)) | |
8749abea GM |
4446 | (defun ange-ftp-real-file-directory-p (&rest args) |
4447 | (ange-ftp-run-real-handler 'file-directory-p args)) | |
4448 | (defun ange-ftp-real-file-writable-p (&rest args) | |
4449 | (ange-ftp-run-real-handler 'file-writable-p args)) | |
4450 | (defun ange-ftp-real-file-readable-p (&rest args) | |
4451 | (ange-ftp-run-real-handler 'file-readable-p args)) | |
4452 | (defun ange-ftp-real-file-executable-p (&rest args) | |
4453 | (ange-ftp-run-real-handler 'file-executable-p args)) | |
4454 | (defun ange-ftp-real-file-symlink-p (&rest args) | |
4455 | (ange-ftp-run-real-handler 'file-symlink-p args)) | |
4456 | (defun ange-ftp-real-delete-file (&rest args) | |
4457 | (ange-ftp-run-real-handler 'delete-file args)) | |
8749abea GM |
4458 | (defun ange-ftp-real-verify-visited-file-modtime (&rest args) |
4459 | (ange-ftp-run-real-handler 'verify-visited-file-modtime args)) | |
4460 | (defun ange-ftp-real-file-exists-p (&rest args) | |
4461 | (ange-ftp-run-real-handler 'file-exists-p args)) | |
4462 | (defun ange-ftp-real-write-region (&rest args) | |
4463 | (ange-ftp-run-real-handler 'write-region args)) | |
4464 | (defun ange-ftp-real-backup-buffer (&rest args) | |
4465 | (ange-ftp-run-real-handler 'backup-buffer args)) | |
4466 | (defun ange-ftp-real-copy-file (&rest args) | |
4467 | (ange-ftp-run-real-handler 'copy-file args)) | |
4468 | (defun ange-ftp-real-rename-file (&rest args) | |
4469 | (ange-ftp-run-real-handler 'rename-file args)) | |
4470 | (defun ange-ftp-real-file-attributes (&rest args) | |
4471 | (ange-ftp-run-real-handler 'file-attributes args)) | |
a1f84f6d SS |
4472 | (defun ange-ftp-real-file-newer-than-file-p (&rest args) |
4473 | (ange-ftp-run-real-handler 'file-newer-than-file-p args)) | |
8749abea GM |
4474 | (defun ange-ftp-real-file-name-all-completions (&rest args) |
4475 | (ange-ftp-run-real-handler 'file-name-all-completions args)) | |
4476 | (defun ange-ftp-real-file-name-completion (&rest args) | |
4477 | (ange-ftp-run-real-handler 'file-name-completion args)) | |
4478 | (defun ange-ftp-real-insert-directory (&rest args) | |
4479 | (ange-ftp-run-real-handler 'insert-directory args)) | |
4480 | (defun ange-ftp-real-file-name-sans-versions (&rest args) | |
4481 | (ange-ftp-run-real-handler 'file-name-sans-versions args)) | |
4482 | (defun ange-ftp-real-shell-command (&rest args) | |
4483 | (ange-ftp-run-real-handler 'shell-command args)) | |
4484 | (defun ange-ftp-real-load (&rest args) | |
4485 | (ange-ftp-run-real-handler 'load args)) | |
4486 | (defun ange-ftp-real-find-backup-file-name (&rest args) | |
4487 | (ange-ftp-run-real-handler 'find-backup-file-name args)) | |
4488 | \f | |
4489 | ;; Here we support using dired on remote hosts. | |
4490 | ;; I have turned off the support for using dired on foreign directory formats. | |
4491 | ;; That involves too many unclean hooks. | |
25759a92 | 4492 | ;; It would be cleaner to support such operations by |
8749abea GM |
4493 | ;; converting the foreign directory format to something dired can understand; |
4494 | ;; something close to ls -l output. | |
4495 | ;; The logical place to do this is in the functions ange-ftp-parse-...-listing. | |
4496 | ||
4497 | ;; Some of the old dired hooks would still be needed even if this is done. | |
4498 | ;; I have preserved (and modernized) those hooks. | |
4499 | ;; So the format conversion should be all that is needed. | |
4500 | ||
1fc85dae KG |
4501 | ;; When called from dired, SWITCHES may start with "--dired". |
4502 | ;; `ange-ftp-ls' handles this. | |
4503 | ||
8749abea | 4504 | (defun ange-ftp-insert-directory (file switches &optional wildcard full) |
3bd1644e SM |
4505 | (if (not (ange-ftp-ftp-name (expand-file-name file))) |
4506 | (ange-ftp-real-insert-directory file switches wildcard full) | |
b63f6e81 SM |
4507 | ;; We used to follow symlinks on `file' here. Apparently it was done |
4508 | ;; because some FTP servers react to "ls foo" by listing the symlink foo | |
4509 | ;; rather than the directory it points to. Now that ange-ftp-ls uses | |
c7015153 | 4510 | ;; "cd foo; ls" instead, this is not necessary any more. |
ecbaeb7b MA |
4511 | (let ((beg (point)) |
4512 | (end (point-marker))) | |
4513 | (set-marker-insertion-type end t) | |
4514 | (insert | |
4515 | (cond | |
4516 | (wildcard | |
4517 | (let ((default-directory (file-name-directory file))) | |
4518 | (ange-ftp-ls (file-name-nondirectory file) switches nil nil t))) | |
4519 | (full | |
4520 | (ange-ftp-ls file switches 'parse)) | |
4521 | (t | |
4522 | ;; If `full' is nil we're going to do `ls' for a single file. | |
4523 | ;; Problem is that for various reasons, ange-ftp-ls needs to cd and | |
4524 | ;; then do an ls of current dir, which obviously won't work if we | |
4525 | ;; want to ls a file. So instead, we get a full listing of the | |
4526 | ;; parent directory and extract the line corresponding to `file'. | |
4527 | (when (string-match "-?d\\'" switches) | |
4528 | ;; Remove "d" which dired added to `switches'. | |
4529 | (setq switches (substring switches 0 (match-beginning 0)))) | |
4530 | (setq file (directory-file-name file)) | |
4531 | (let* ((dirlist (ange-ftp-ls (or (file-name-directory file) ".") | |
4532 | switches 'parse)) | |
4533 | (filename (file-name-nondirectory file)) | |
4534 | (case-fold-search nil)) | |
4535 | ;; FIXME: This presumes a particular output format, which is | |
4536 | ;; basically Unix. | |
4537 | (if (string-match (concat "^.+[^ ] " (regexp-quote filename) | |
4538 | "\\( -> .*\\)?[@/*=]?\n") dirlist) | |
4539 | (match-string 0 dirlist) | |
4540 | ""))))) | |
4541 | ||
4542 | ;; Insert " " for dired's alignment sanity. | |
4543 | (goto-char beg) | |
4544 | (while (re-search-forward "^\\(\\S-\\)" end 'move) | |
4545 | (replace-match " \\1")) | |
4546 | ||
4547 | ;; The inserted file could be from somewhere else. | |
4548 | (when (and (not wildcard) (not full) | |
4549 | (search-backward | |
4550 | (if (zerop (length (file-name-nondirectory | |
4551 | (expand-file-name file)))) | |
4552 | "." | |
4553 | (file-name-nondirectory file)) | |
4554 | nil 'noerror)) | |
4555 | (replace-match (file-relative-name (expand-file-name file)) t) | |
4556 | (goto-char end)) | |
4557 | ||
4558 | (set-marker end nil)))) | |
8749abea GM |
4559 | |
4560 | (defun ange-ftp-dired-uncache (dir) | |
4561 | (if (ange-ftp-ftp-name (expand-file-name dir)) | |
4562 | (setq ange-ftp-ls-cache-file nil))) | |
4563 | ||
4564 | (defvar ange-ftp-sans-version-alist nil | |
4565 | "Alist of mapping host type into function to remove file version numbers.") | |
4566 | ||
4567 | (defun ange-ftp-file-name-sans-versions (file keep-backup-version) | |
4568 | (let* ((short (ange-ftp-abbreviate-filename file)) | |
4569 | (parsed (ange-ftp-ftp-name short)) | |
3bd1644e SM |
4570 | (func (if parsed (cdr (assq (ange-ftp-host-type (car parsed)) |
4571 | ange-ftp-sans-version-alist))))) | |
8749abea GM |
4572 | (if func (funcall func file keep-backup-version) |
4573 | (ange-ftp-real-file-name-sans-versions file keep-backup-version)))) | |
4574 | ||
4575 | ;; This is the handler for shell-command. | |
4576 | (defun ange-ftp-shell-command (command &optional output-buffer error-buffer) | |
4577 | (let* ((parsed (ange-ftp-ftp-name default-directory)) | |
4578 | (host (nth 0 parsed)) | |
4579 | (user (nth 1 parsed)) | |
4580 | (name (nth 2 parsed))) | |
4581 | (if (not parsed) | |
4582 | (ange-ftp-real-shell-command command output-buffer error-buffer) | |
4583 | (if (> (length name) 0) ; else it's $HOME | |
4584 | (setq command (concat "cd " name "; " command))) | |
cdc51589 | 4585 | ;; Remove port from the hostname |
ae0bec0b SM |
4586 | (when (string-match "\\(.*\\)#" host) |
4587 | (setq host (match-string 1 host))) | |
8749abea GM |
4588 | (setq command |
4589 | (format "%s %s \"%s\"" ; remsh -l USER does not work well | |
4590 | ; on a hp-ux machine I tried | |
4591 | remote-shell-program host command)) | |
4592 | (ange-ftp-message "Remote command '%s' ..." command) | |
4593 | ;; Cannot call ange-ftp-real-dired-run-shell-command here as it | |
4594 | ;; would prepend "cd default-directory" --- which bombs because | |
4595 | ;; default-directory is in ange-ftp syntax for remote file names. | |
4596 | (ange-ftp-real-shell-command command output-buffer error-buffer)))) | |
4597 | ||
4a725859 MA |
4598 | ;;; This is the handler for process-file. |
4599 | (defun ange-ftp-process-file (program infile buffer display &rest arguments) | |
8749abea GM |
4600 | ;; PROGRAM is always one of those below in the cond in dired.el. |
4601 | ;; The ARGUMENTS are (nearly) always files. | |
4602 | (if (ange-ftp-ftp-name default-directory) | |
4603 | ;; Can't use ange-ftp-dired-host-type here because the current | |
4604 | ;; buffer is *dired-check-process output* | |
4605 | (condition-case oops | |
5cf3709c GM |
4606 | (cond ((equal (or (bound-and-true-p dired-chmod-program) "chmod") |
4607 | program) | |
8749abea GM |
4608 | (ange-ftp-call-chmod arguments)) |
4609 | ;; ((equal "chgrp" program)) | |
4610 | ;; ((equal dired-chown-program program)) | |
4611 | (t (error "Unknown remote command: %s" program))) | |
4612 | (ftp-error (insert (format "%s: %s, %s\n" | |
e3441f42 SM |
4613 | (nth 1 oops) |
4614 | (nth 2 oops) | |
4615 | (nth 3 oops))) | |
8749abea GM |
4616 | ;; Caller expects nonzero value to mean failure. |
4617 | 1) | |
4618 | (error (insert (format "%s\n" (nth 1 oops))) | |
4619 | 1)) | |
4a725859 | 4620 | (apply 'call-process program infile buffer display arguments))) |
8749abea | 4621 | |
8749abea GM |
4622 | ;; Handle an attempt to run chmod on a remote file |
4623 | ;; by using the ftp chmod command. | |
4624 | (defun ange-ftp-call-chmod (args) | |
4625 | (if (< (length args) 2) | |
4626 | (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args)) | |
4627 | (let ((mode (car args)) | |
4628 | (rest (cdr args))) | |
4629 | (if (equal "--" (car rest)) | |
4630 | (setq rest (cdr rest))) | |
d590ea4d | 4631 | (mapc |
25759a92 SS |
4632 | (lambda (file) |
4633 | (setq file (expand-file-name file)) | |
4634 | (let ((parsed (ange-ftp-ftp-name file))) | |
4635 | (if parsed | |
4636 | (let* ((host (nth 0 parsed)) | |
4637 | (user (nth 1 parsed)) | |
4638 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
4639 | (abbr (ange-ftp-abbreviate-filename file)) | |
4640 | (result (ange-ftp-send-cmd host user | |
4641 | (list 'chmod mode name) | |
4642 | (format "doing chmod %s" | |
4643 | abbr)))) | |
4644 | (or (car result) | |
c42e03b4 MA |
4645 | (ange-ftp-error |
4646 | host user (concat "CHMOD failed: " (cdr result)))))))) | |
8749abea GM |
4647 | rest)) |
4648 | (setq ange-ftp-ls-cache-file nil) ;Stop confusing Dired. | |
4649 | 0) | |
c42e03b4 MA |
4650 | |
4651 | (defun ange-ftp-set-file-modes (filename mode) | |
4652 | (ange-ftp-call-chmod (list (format "%o" mode) filename))) | |
8749abea | 4653 | \f |
92482d77 SM |
4654 | ;; This is turned off because it has nothing properly to do |
4655 | ;; with dired. It could be reasonable to adapt this to | |
4656 | ;; replace ange-ftp-copy-file. | |
8749abea GM |
4657 | |
4658 | ;;;;; ------------------------------------------------------------ | |
4659 | ;;;;; Noddy support for async copy-file within dired. | |
4660 | ;;;;; ------------------------------------------------------------ | |
4661 | ||
4662 | ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait) | |
4663 | ;; "Documented as original." | |
4664 | ;; (dired-handle-overwrite to) | |
4665 | ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil | |
4666 | ;; cont nowait)) | |
4667 | ||
4668 | ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg | |
4669 | ;; &optional marker-char op1 | |
4670 | ;; how-to) | |
4671 | ;; "Documented as original." | |
4672 | ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly | |
4673 | ;; ;; called it rather than somebody else. | |
4674 | ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is | |
4675 | ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation | |
4676 | ;; arg marker-char op1 how-to))) | |
4677 | ||
4678 | ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor | |
4679 | ;; &optional marker-char) | |
4680 | ;; "Documented as original." | |
4681 | ;; (if (and (boundp 'ange-ftp-dired-do-create-files) | |
4682 | ;; ;; called from ange-ftp-dired-do-create-files? | |
4683 | ;; ange-ftp-dired-do-create-files | |
4684 | ;; ;; any files worth copying? | |
4685 | ;; fn-list | |
4686 | ;; ;; we only support async copy-file at the mo. | |
4687 | ;; (eq file-creator 'dired-copy-file) | |
4688 | ;; ;; it is only worth calling the alternative function for remote files | |
4689 | ;; ;; as we tie ourself in recursive knots otherwise. | |
4690 | ;; (or (ange-ftp-ftp-name (car fn-list)) | |
4691 | ;; ;; we can only call the name constructor for dired-do-create-files | |
4692 | ;; ;; since the one for regexps starts prompting here, there and | |
4693 | ;; ;; everywhere. | |
4694 | ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list))))) | |
4695 | ;; ;; use the process-filter driven routine rather than the iterative one. | |
4696 | ;; (ange-ftp-dcf-1 file-creator | |
4697 | ;; operation | |
4698 | ;; fn-list | |
4699 | ;; name-constructor | |
4700 | ;; (and (boundp 'target) target) ;dynamically bound | |
4701 | ;; marker-char | |
4702 | ;; (current-buffer) | |
4703 | ;; nil ;overwrite-query | |
4704 | ;; nil ;overwrite-backup-query | |
4705 | ;; nil ;failures | |
4706 | ;; nil ;skipped | |
4707 | ;; 0 ;success-count | |
4708 | ;; (length fn-list) ;total | |
4709 | ;; ) | |
4710 | ;; ;; normal case... use the interactive routine... much cheaper. | |
4711 | ;; (ange-ftp-real-dired-create-files file-creator operation fn-list | |
4712 | ;; name-constructor marker-char))) | |
4713 | ||
4714 | ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor | |
25759a92 | 4715 | ;; target marker-char buffer overwrite-query |
8749abea GM |
4716 | ;; overwrite-backup-query failures skipped |
4717 | ;; success-count total) | |
b63f6e81 | 4718 | ;; (with-current-buffer buffer |
8749abea GM |
4719 | ;; (if (null fn-list) |
4720 | ;; (ange-ftp-dcf-3 failures operation total skipped | |
4721 | ;; success-count buffer) | |
25759a92 | 4722 | |
8749abea GM |
4723 | ;; (let* ((from (car fn-list)) |
4724 | ;; (to (funcall name-constructor from))) | |
4725 | ;; (if (equal to from) | |
4726 | ;; (progn | |
4727 | ;; (setq to nil) | |
4728 | ;; (dired-log "Cannot %s to same file: %s\n" | |
4729 | ;; (downcase operation) from))) | |
4730 | ;; (if (not to) | |
4731 | ;; (ange-ftp-dcf-1 file-creator | |
4732 | ;; operation | |
4733 | ;; (cdr fn-list) | |
4734 | ;; name-constructor | |
4735 | ;; target | |
4736 | ;; marker-char | |
4737 | ;; buffer | |
4738 | ;; overwrite-query | |
4739 | ;; overwrite-backup-query | |
4740 | ;; failures | |
4741 | ;; (cons (dired-make-relative from) skipped) | |
4742 | ;; success-count | |
4743 | ;; total) | |
4744 | ;; (let* ((overwrite (file-exists-p to)) | |
4745 | ;; (overwrite-confirmed ; for dired-handle-overwrite | |
4746 | ;; (and overwrite | |
4747 | ;; (let ((help-form '(format "\ | |
4748 | ;;Type SPC or `y' to overwrite file `%s', | |
4749 | ;;DEL or `n' to skip to next, | |
4750 | ;;ESC or `q' to not overwrite any of the remaining files, | |
4751 | ;;`!' to overwrite all remaining files with no more questions." to))) | |
4752 | ;; (dired-query 'overwrite-query | |
4753 | ;; "Overwrite `%s'?" to)))) | |
4754 | ;; ;; must determine if FROM is marked before file-creator | |
4755 | ;; ;; gets a chance to delete it (in case of a move). | |
4756 | ;; (actual-marker-char | |
4757 | ;; (cond ((integerp marker-char) marker-char) | |
4758 | ;; (marker-char (dired-file-marker from)) ; slow | |
4759 | ;; (t nil)))) | |
4760 | ;; (condition-case err | |
4761 | ;; (funcall file-creator from to overwrite-confirmed | |
e3441f42 | 4762 | ;; (list 'ange-ftp-dcf-2 |
8749abea GM |
4763 | ;; nil ;err |
4764 | ;; file-creator operation fn-list | |
4765 | ;; name-constructor | |
4766 | ;; target | |
4767 | ;; marker-char actual-marker-char | |
4768 | ;; buffer to from | |
4769 | ;; overwrite | |
4770 | ;; overwrite-confirmed | |
25759a92 | 4771 | ;; overwrite-query |
8749abea GM |
4772 | ;; overwrite-backup-query |
4773 | ;; failures skipped success-count | |
4774 | ;; total) | |
4775 | ;; t) | |
4776 | ;; (file-error ; FILE-CREATOR aborted | |
4777 | ;; (ange-ftp-dcf-2 nil ;result | |
4778 | ;; nil ;line | |
4779 | ;; err | |
4780 | ;; file-creator operation fn-list | |
4781 | ;; name-constructor | |
4782 | ;; target | |
4783 | ;; marker-char actual-marker-char | |
4784 | ;; buffer to from | |
4785 | ;; overwrite | |
4786 | ;; overwrite-confirmed | |
25759a92 | 4787 | ;; overwrite-query |
8749abea GM |
4788 | ;; overwrite-backup-query |
4789 | ;; failures skipped success-count | |
b63f6e81 | 4790 | ;; total))))))))) |
8749abea GM |
4791 | |
4792 | ;;(defun ange-ftp-dcf-2 (result line err | |
4793 | ;; file-creator operation fn-list | |
4794 | ;; name-constructor | |
4795 | ;; target | |
4796 | ;; marker-char actual-marker-char | |
4797 | ;; buffer to from | |
4798 | ;; overwrite | |
4799 | ;; overwrite-confirmed | |
25759a92 | 4800 | ;; overwrite-query |
8749abea GM |
4801 | ;; overwrite-backup-query |
4802 | ;; failures skipped success-count | |
4803 | ;; total) | |
b63f6e81 | 4804 | ;; (with-current-buffer buffer |
8749abea GM |
4805 | ;; (if (or err (not result)) |
4806 | ;; (progn | |
4807 | ;; (setq failures (cons (dired-make-relative from) failures)) | |
4808 | ;; (dired-log "%s `%s' to `%s' failed:\n%s\n" | |
4809 | ;; operation from to (or err line))) | |
4810 | ;; (if overwrite | |
4811 | ;; ;; If we get here, file-creator hasn't been aborted | |
4812 | ;; ;; and the old entry (if any) has to be deleted | |
4813 | ;; ;; before adding the new entry. | |
4814 | ;; (dired-remove-file to)) | |
4815 | ;; (setq success-count (1+ success-count)) | |
4816 | ;; (message "%s: %d of %d" operation success-count total) | |
4817 | ;; (dired-add-file to actual-marker-char)) | |
25759a92 | 4818 | |
8749abea GM |
4819 | ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list) |
4820 | ;; name-constructor | |
4821 | ;; target | |
4822 | ;; marker-char | |
4823 | ;; buffer | |
25759a92 | 4824 | ;; overwrite-query |
8749abea GM |
4825 | ;; overwrite-backup-query |
4826 | ;; failures skipped success-count | |
b63f6e81 | 4827 | ;; total))) |
8749abea GM |
4828 | |
4829 | ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count | |
4830 | ;; buffer) | |
b63f6e81 | 4831 | ;; (with-current-buffer buffer |
8749abea GM |
4832 | ;; (cond |
4833 | ;; (failures | |
4834 | ;; (dired-log-summary | |
4835 | ;; (message "%s failed for %d of %d file%s %s" | |
4836 | ;; operation (length failures) total | |
4837 | ;; (dired-plural-s total) failures))) | |
4838 | ;; (skipped | |
4839 | ;; (dired-log-summary | |
4840 | ;; (message "%s: %d of %d file%s skipped %s" | |
4841 | ;; operation (length skipped) total | |
4842 | ;; (dired-plural-s total) skipped))) | |
4843 | ;; (t | |
4844 | ;; (message "%s: %s file%s." | |
4845 | ;; operation success-count (dired-plural-s success-count)))) | |
b63f6e81 | 4846 | ;; (dired-move-to-filename))) |
8749abea GM |
4847 | \f |
4848 | ;;;; ----------------------------------------------- | |
4849 | ;;;; Unix Descriptive Listing (dl) Support | |
4850 | ;;;; ----------------------------------------------- | |
4851 | ||
4852 | ;; This is turned off because nothing uses it currently | |
4853 | ;; and because I don't understand what it's supposed to be for. --rms. | |
4854 | ||
4855 | ;;(defconst ange-ftp-dired-dl-re-dir | |
4856 | ;; "^. [^ /]+/[ \n]" | |
4857 | ;; "Regular expression to use to search for dl directories.") | |
4858 | ||
4859 | ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist) | |
4860 | ;; (setq ange-ftp-dired-re-dir-alist | |
4861 | ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir) | |
4862 | ;; ange-ftp-dired-re-dir-alist))) | |
4863 | ||
4864 | ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol) | |
4865 | ;; "In dired, move to the first character of the filename on this line." | |
4866 | ;; ;; This is the Unix dl version. | |
4867 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
4868 | ;; (let (case-fold-search) | |
4869 | ;; (beginning-of-line) | |
4870 | ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ") | |
4871 | ;; (goto-char (+ (point) 2)) | |
4872 | ;; (if raise-error | |
4873 | ;; (error "No file on this line") | |
4874 | ;; nil)))) | |
4875 | ||
4876 | ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist) | |
4877 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
4878 | ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename) | |
4879 | ;; ange-ftp-dired-move-to-filename-alist))) | |
4880 | ||
4881 | ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol) | |
4882 | ;; ;; Assumes point is at beginning of filename. | |
4883 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
4884 | ;; ;; On failure, signals an error or returns nil. | |
4885 | ;; ;; This is the Unix dl version. | |
4886 | ;; (let ((opoint (point)) | |
4887 | ;; case-fold-search hidden) | |
5ed619e0 | 4888 | ;; (or eol (setq eol (line-end-position))) |
8749abea GM |
4889 | ;; (setq hidden (and selective-display |
4890 | ;; (save-excursion | |
4891 | ;; (search-forward "\r" eol t)))) | |
4892 | ;; (if hidden | |
4893 | ;; (if no-error | |
4894 | ;; nil | |
4895 | ;; (error | |
4896 | ;; (substitute-command-keys | |
4897 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide"))) | |
4898 | ;; (skip-chars-forward "^ /" eol) | |
4899 | ;; (if (eq opoint (point)) | |
4900 | ;; (if no-error | |
4901 | ;; nil | |
4902 | ;; (error "No file on this line")) | |
4903 | ;; (point))))) | |
4904 | ||
4905 | ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist) | |
4906 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
4907 | ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename) | |
4908 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
4909 | \f | |
4910 | ;;;; ------------------------------------------------------------ | |
4911 | ;;;; VOS support (VOS support is probably broken, | |
4912 | ;;;; but I don't know anything about VOS.) | |
4913 | ;;;; ------------------------------------------------------------ | |
4914 | ; | |
4915 | ;(defun ange-ftp-fix-name-for-vos (name &optional reverse) | |
4916 | ; (setq name (copy-sequence name)) | |
4917 | ; (let ((from (if reverse ?\> ?\/)) | |
4918 | ; (to (if reverse ?\/ ?\>)) | |
4919 | ; (i (1- (length name)))) | |
4920 | ; (while (>= i 0) | |
4921 | ; (if (= (aref name i) from) | |
4922 | ; (aset name i to)) | |
4923 | ; (setq i (1- i))) | |
4924 | ; name)) | |
4925 | ; | |
4926 | ;(or (assq 'vos ange-ftp-fix-name-func-alist) | |
4927 | ; (setq ange-ftp-fix-name-func-alist | |
4928 | ; (cons '(vos . ange-ftp-fix-name-for-vos) | |
4929 | ; ange-ftp-fix-name-func-alist))) | |
4930 | ; | |
4931 | ;(or (memq 'vos ange-ftp-dumb-host-types) | |
4932 | ; (setq ange-ftp-dumb-host-types | |
4933 | ; (cons 'vos ange-ftp-dumb-host-types))) | |
4934 | ; | |
4935 | ;(defun ange-ftp-fix-dir-name-for-vos (dir-name) | |
4936 | ; (ange-ftp-fix-name-for-vos | |
4937 | ; (concat dir-name | |
4938 | ; (if (eq ?/ (aref dir-name (1- (length dir-name)))) | |
4939 | ; "" "/") | |
4940 | ; "*"))) | |
4941 | ; | |
4942 | ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist) | |
4943 | ; (setq ange-ftp-fix-dir-name-func-alist | |
4944 | ; (cons '(vos . ange-ftp-fix-dir-name-for-vos) | |
4945 | ; ange-ftp-fix-dir-name-func-alist))) | |
4946 | ; | |
4947 | ;(defvar ange-ftp-vos-host-regexp nil | |
4948 | ; "If a host matches this regexp then it is assumed to be running VOS.") | |
4949 | ; | |
4950 | ;(defun ange-ftp-vos-host (host) | |
4951 | ; (and ange-ftp-vos-host-regexp | |
4952 | ; (save-match-data | |
4953 | ; (string-match ange-ftp-vos-host-regexp host)))) | |
4954 | ; | |
4955 | ;(defun ange-ftp-parse-vos-listing () | |
4956 | ; "Parse the current buffer which is assumed to be in VOS list -all | |
4957 | ;format, and return a hashtable as the result." | |
4958 | ; (let ((tbl (ange-ftp-make-hashtable)) | |
4959 | ; (type-list | |
4960 | ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40) | |
4961 | ; ("^Dirs: [0-9]+\n+" t 30))) | |
4962 | ; type-regexp type-is-dir type-col file) | |
4963 | ; (goto-char (point-min)) | |
4964 | ; (save-match-data | |
4965 | ; (while type-list | |
4966 | ; (setq type-regexp (car (car type-list)) | |
4967 | ; type-is-dir (nth 1 (car type-list)) | |
4968 | ; type-col (nth 2 (car type-list)) | |
4969 | ; type-list (cdr type-list)) | |
4970 | ; (if (re-search-forward type-regexp nil t) | |
4971 | ; (while (eq (char-after (point)) ? ) | |
4972 | ; (move-to-column type-col) | |
4973 | ; (setq file (buffer-substring (point) | |
4974 | ; (progn | |
4975 | ; (end-of-line 1) | |
4976 | ; (point)))) | |
6e85ef5f | 4977 | ; (puthash file type-is-dir tbl) |
8749abea | 4978 | ; (forward-line 1)))) |
6e85ef5f SM |
4979 | ; (puthash "." 'vosdir tbl) |
4980 | ; (puthash ".." 'vosdir tbl)) | |
8749abea GM |
4981 | ; tbl)) |
4982 | ; | |
4983 | ;(or (assq 'vos ange-ftp-parse-list-func-alist) | |
4984 | ; (setq ange-ftp-parse-list-func-alist | |
4985 | ; (cons '(vos . ange-ftp-parse-vos-listing) | |
4986 | ; ange-ftp-parse-list-func-alist))) | |
4987 | \f | |
4988 | ;;;; ------------------------------------------------------------ | |
4989 | ;;;; VMS support. | |
4990 | ;;;; ------------------------------------------------------------ | |
4991 | ||
4992 | ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS | |
4993 | ;; to UNIX-ish. | |
4994 | (defun ange-ftp-fix-name-for-vms (name &optional reverse) | |
4995 | (save-match-data | |
4996 | (if reverse | |
aa6f7b96 | 4997 | (if (string-match "\\`\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)\\'" name) |
8749abea | 4998 | (let (drive dir file) |
e3441f42 SM |
4999 | (setq drive (match-string 1 name)) |
5000 | (setq dir (match-string 2 name)) | |
5001 | (setq file (match-string 3 name)) | |
8749abea | 5002 | (and dir |
a1f84f6d | 5003 | (setq dir (subst-char-in-string |
a724ed38 | 5004 | ?/ ?. (substring dir 1 -1) t))) |
8749abea GM |
5005 | (concat (and drive |
5006 | (concat "/" drive "/")) | |
5007 | dir (and dir "/") | |
5008 | file)) | |
5009 | (error "name %s didn't match" name)) | |
28dbc92f MA |
5010 | (let (drive dir file tmp quote) |
5011 | (if (string-match "\\`\".+\"\\'" name) | |
5012 | (setq name (substring name 1 -1) | |
5013 | quote "\"") | |
5014 | (setq quote "")) | |
aa6f7b96 | 5015 | (if (string-match "\\`/[^:]+:/" name) |
8749abea GM |
5016 | (setq drive (substring name 1 |
5017 | (1- (match-end 0))) | |
5018 | name (substring name (match-end 0)))) | |
5019 | (setq tmp (file-name-directory name)) | |
5020 | (if tmp | |
a724ed38 | 5021 | (setq dir (subst-char-in-string ?/ ?. (substring tmp 0 -1) t))) |
8749abea | 5022 | (setq file (file-name-nondirectory name)) |
28dbc92f | 5023 | (concat quote drive |
8749abea | 5024 | (and dir (concat "[" (if drive nil ".") dir "]")) |
28dbc92f | 5025 | file quote))))) |
8749abea GM |
5026 | |
5027 | ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1") | |
5028 | ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t) | |
5029 | ||
5030 | (or (assq 'vms ange-ftp-fix-name-func-alist) | |
5031 | (setq ange-ftp-fix-name-func-alist | |
5032 | (cons '(vms . ange-ftp-fix-name-for-vms) | |
5033 | ange-ftp-fix-name-func-alist))) | |
5034 | ||
5035 | (or (memq 'vms ange-ftp-dumb-host-types) | |
5036 | (setq ange-ftp-dumb-host-types | |
5037 | (cons 'vms ange-ftp-dumb-host-types))) | |
5038 | ||
5039 | ;; It is important that this function barf for directories for which we know | |
5040 | ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/". | |
5041 | ;; This is because it saves an unnecessary FTP error, or possibly the listing | |
5042 | ;; might succeed, but give erroneous info. This last case is particularly | |
5043 | ;; likely for OS's (like MTS) for which we need to use a wildcard in order | |
5044 | ;; to list a directory. | |
5045 | ||
5046 | ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing. | |
5047 | (defun ange-ftp-fix-dir-name-for-vms (dir-name) | |
5048 | ;; Should there be entries for .. -> [-] and . -> [] below. Don't | |
5049 | ;; think so, because expand-filename should have already short-circuited | |
5050 | ;; them. | |
5051 | (cond ((string-equal dir-name "/") | |
55535639 | 5052 | (error "Cannot get listing for fictitious \"/\" directory")) |
aa6f7b96 | 5053 | ((string-match "\\`/[-A-Z0-9_$]+:/\\'" dir-name) |
55535639 | 5054 | (error "Cannot get listing for device")) |
8749abea | 5055 | ((ange-ftp-fix-name-for-vms dir-name)))) |
25759a92 | 5056 | |
8749abea GM |
5057 | (or (assq 'vms ange-ftp-fix-dir-name-func-alist) |
5058 | (setq ange-ftp-fix-dir-name-func-alist | |
5059 | (cons '(vms . ange-ftp-fix-dir-name-for-vms) | |
5060 | ange-ftp-fix-dir-name-func-alist))) | |
5061 | ||
5062 | (defvar ange-ftp-vms-host-regexp nil) | |
5063 | ||
5064 | ;; Return non-nil if HOST is running VMS. | |
5065 | (defun ange-ftp-vms-host (host) | |
5066 | (and ange-ftp-vms-host-regexp | |
4671dba5 | 5067 | (string-match-p ange-ftp-vms-host-regexp host))) |
8749abea GM |
5068 | |
5069 | ;; Because some VMS ftp servers convert filenames to lower case | |
5070 | ;; we allow a-z in the filename regexp. I'm not too happy about this. | |
5071 | ||
5072 | (defconst ange-ftp-vms-filename-regexp | |
5073 | (concat | |
5074 | "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\." | |
5075 | "[-_A-Za-z0-9$]*;+[0-9]*\\)") | |
5076 | "Regular expression to match for a valid VMS file name in Dired buffer. | |
4671dba5 JB |
5077 | Stupid freaking bug! Position of _ and $ shouldn't matter but they do. |
5078 | Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX. | |
8749abea GM |
5079 | Other orders of $ and _ seem to all work just fine.") |
5080 | ||
5081 | ;; These parsing functions are as general as possible because the syntax | |
5082 | ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that | |
5083 | ;; the VMS filename syntax is so rigid. If they bomb on a listing in the | |
5084 | ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing | |
5085 | ;; from vms.weird.net, then too bad. | |
5086 | ||
5087 | ;; Extract the next filename from a VMS dired-like listing. | |
5088 | (defun ange-ftp-parse-vms-filename () | |
5089 | (if (re-search-forward | |
e3441f42 SM |
5090 | ange-ftp-vms-filename-regexp |
5091 | nil t) | |
5092 | (match-string 0))) | |
8749abea GM |
5093 | |
5094 | ;; Parse the current buffer which is assumed to be in MultiNet FTP dir | |
5095 | ;; format, and return a hashtable as the result. | |
5096 | (defun ange-ftp-parse-vms-listing () | |
6e85ef5f | 5097 | (let ((tbl (make-hash-table :test 'equal)) |
8749abea GM |
5098 | file) |
5099 | (goto-char (point-min)) | |
5100 | (save-match-data | |
5101 | (while (setq file (ange-ftp-parse-vms-filename)) | |
5102 | (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file) | |
5103 | ;; deal with directories | |
6e85ef5f SM |
5104 | (puthash (substring file 0 (match-beginning 0)) t tbl) |
5105 | (puthash file nil tbl) | |
aa6f7b96 | 5106 | (if (string-match ";[0-9]+\\'" file) ; deal with extension |
8749abea | 5107 | ;; sans extension |
6e85ef5f | 5108 | (puthash (substring file 0 (match-beginning 0)) nil tbl))) |
8749abea GM |
5109 | (forward-line 1)) |
5110 | ;; Would like to look for a "Total" line, or a "Directory" line to | |
5111 | ;; make sure that the listing isn't complete garbage before putting | |
5112 | ;; in "." and "..", but we can't even count on all VAX's giving us | |
5113 | ;; either of these. | |
6e85ef5f SM |
5114 | (puthash "." t tbl) |
5115 | (puthash ".." t tbl)) | |
8749abea GM |
5116 | tbl)) |
5117 | ||
e3441f42 SM |
5118 | (add-to-list 'ange-ftp-parse-list-func-alist |
5119 | '(vms . ange-ftp-parse-vms-listing)) | |
8749abea GM |
5120 | |
5121 | ;; This version only deletes file entries which have | |
5122 | ;; explicit version numbers, because that is all VMS allows. | |
5123 | ||
5124 | ;; Can the following two functions be speeded up using file | |
5125 | ;; completion functions? | |
5126 | ||
5127 | (defun ange-ftp-vms-delete-file-entry (name &optional dir-p) | |
5128 | (if dir-p | |
5129 | (ange-ftp-internal-delete-file-entry name t) | |
5130 | (save-match-data | |
5131 | (let ((file (ange-ftp-get-file-part name))) | |
aa6f7b96 | 5132 | (if (string-match ";[0-9]+\\'" file) |
25759a92 | 5133 | ;; In VMS you can't delete a file without an explicit |
8749abea GM |
5134 | ;; version number, or wild-card (e.g. FOO;*) |
5135 | ;; For now, we give up on wildcards. | |
6e85ef5f SM |
5136 | (let ((files (gethash (file-name-directory name) |
5137 | ange-ftp-files-hashtable))) | |
8749abea GM |
5138 | (if files |
5139 | (let* ((root (substring file 0 | |
5140 | (match-beginning 0))) | |
5141 | (regexp (concat "^" | |
5142 | (regexp-quote root) | |
5143 | ";[0-9]+$")) | |
5144 | versions) | |
6e85ef5f | 5145 | (remhash file files) |
8749abea GM |
5146 | ;; Now we need to check if there are any |
5147 | ;; versions left. If not, then delete the | |
5148 | ;; root entry. | |
6e85ef5f SM |
5149 | (maphash |
5150 | (lambda (key val) | |
5151 | (and (string-match regexp key) | |
aeb18228 | 5152 | (setq versions t))) |
8749abea GM |
5153 | files) |
5154 | (or versions | |
6e85ef5f | 5155 | (remhash root files)))))))))) |
8749abea GM |
5156 | |
5157 | (or (assq 'vms ange-ftp-delete-file-entry-alist) | |
5158 | (setq ange-ftp-delete-file-entry-alist | |
5159 | (cons '(vms . ange-ftp-vms-delete-file-entry) | |
5160 | ange-ftp-delete-file-entry-alist))) | |
5161 | ||
5162 | (defun ange-ftp-vms-add-file-entry (name &optional dir-p) | |
5163 | (if dir-p | |
5164 | (ange-ftp-internal-add-file-entry name t) | |
6e85ef5f SM |
5165 | (let ((files (gethash (file-name-directory name) |
5166 | ange-ftp-files-hashtable))) | |
8749abea GM |
5167 | (if files |
5168 | (let ((file (ange-ftp-get-file-part name))) | |
5169 | (save-match-data | |
aa6f7b96 | 5170 | (if (string-match ";[0-9]+\\'" file) |
6e85ef5f | 5171 | (puthash (substring file 0 (match-beginning 0)) nil files) |
8749abea GM |
5172 | ;; Need to figure out what version of the file |
5173 | ;; is being added. | |
5174 | (let ((regexp (concat "^" | |
5175 | (regexp-quote file) | |
5176 | ";\\([0-9]+\\)$")) | |
5177 | (version 0)) | |
6e85ef5f SM |
5178 | (maphash |
5179 | (lambda (name val) | |
5180 | (and (string-match regexp name) | |
5181 | (setq version | |
5182 | (max version | |
027a4b6b | 5183 | (string-to-number (match-string 1 name)))))) |
8749abea GM |
5184 | files) |
5185 | (setq version (1+ version)) | |
6e85ef5f | 5186 | (puthash |
8749abea GM |
5187 | (concat file ";" (int-to-string version)) |
5188 | nil files)))) | |
6e85ef5f | 5189 | (puthash file nil files)))))) |
8749abea GM |
5190 | |
5191 | (or (assq 'vms ange-ftp-add-file-entry-alist) | |
5192 | (setq ange-ftp-add-file-entry-alist | |
5193 | (cons '(vms . ange-ftp-vms-add-file-entry) | |
5194 | ange-ftp-add-file-entry-alist))) | |
5195 | ||
5196 | ||
5197 | (defun ange-ftp-add-vms-host (host) | |
5198 | "Mark HOST as the name of a machine running VMS." | |
5199 | (interactive | |
5200 | (list (read-string "Host: " | |
5201 | (let ((name (or (buffer-file-name) default-directory))) | |
5202 | (and name (car (ange-ftp-ftp-name name))))))) | |
5203 | (if (not (ange-ftp-vms-host host)) | |
5204 | (setq ange-ftp-vms-host-regexp | |
5205 | (concat "^" (regexp-quote host) "$" | |
5206 | (and ange-ftp-vms-host-regexp "\\|") | |
5207 | ange-ftp-vms-host-regexp) | |
5208 | ange-ftp-host-cache nil))) | |
5209 | ||
5210 | ||
5211 | (defun ange-ftp-vms-file-name-as-directory (name) | |
5212 | (save-match-data | |
aa6f7b96 | 5213 | (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?\\'" name) |
8749abea GM |
5214 | (setq name (substring name 0 (match-beginning 0)))) |
5215 | (ange-ftp-real-file-name-as-directory name))) | |
5216 | ||
5217 | (or (assq 'vms ange-ftp-file-name-as-directory-alist) | |
5218 | (setq ange-ftp-file-name-as-directory-alist | |
5219 | (cons '(vms . ange-ftp-vms-file-name-as-directory) | |
5220 | ange-ftp-file-name-as-directory-alist))) | |
5221 | ||
5222 | ;;; Tree dired support: | |
5223 | ||
5224 | ;; For this code I have borrowed liberally from Sebastian Kremer's | |
5225 | ;; dired-vms.el | |
5226 | ||
5227 | ||
5228 | ;;;; These regexps must be anchored to beginning of line. | |
5229 | ;;;; Beware that the ftpd may put the device in front of the filename. | |
5230 | ||
5231 | ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]" | |
5232 | ;; "Regular expression to use to search for VMS executable files.") | |
5233 | ||
5234 | ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]" | |
5235 | ;; "Regular expression to use to search for VMS directories.") | |
5236 | ||
5237 | ;;(or (assq 'vms ange-ftp-dired-re-exe-alist) | |
5238 | ;; (setq ange-ftp-dired-re-exe-alist | |
5239 | ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe) | |
5240 | ;; ange-ftp-dired-re-exe-alist))) | |
5241 | ||
5242 | ;;(or (assq 'vms ange-ftp-dired-re-dir-alist) | |
5243 | ;; (setq ange-ftp-dired-re-dir-alist | |
5244 | ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir) | |
5245 | ;; ange-ftp-dired-re-dir-alist))) | |
5246 | ||
5247 | ;;(defun ange-ftp-dired-vms-insert-headerline (dir) | |
5248 | ;; ;; VMS inserts a headerline. I would prefer the headerline | |
5249 | ;; ;; to be in ange-ftp format. This version tries to | |
5250 | ;; ;; be careful, because we can't count on a headerline | |
5251 | ;; ;; over ftp, and we wouldn't want to delete anything | |
5252 | ;; ;; important. | |
5253 | ;; (save-excursion | |
5254 | ;; (if (looking-at "^ wildcard ") | |
5255 | ;; (forward-line 1)) | |
5256 | ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n") | |
5257 | ;; (delete-region (point) (match-end 0)))) | |
5258 | ;; (ange-ftp-real-dired-insert-headerline dir)) | |
5259 | ||
5260 | ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist) | |
5261 | ;; (setq ange-ftp-dired-insert-headerline-alist | |
5262 | ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline) | |
5263 | ;; ange-ftp-dired-insert-headerline-alist))) | |
5264 | ||
5265 | ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol) | |
5266 | ;; "In dired, move to first char of filename on this line. | |
5267 | ;;Returns position (point) or nil if no filename on this line." | |
5268 | ;; ;; This is the VMS version. | |
5269 | ;; (let (case-fold-search) | |
5270 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5271 | ;; (beginning-of-line) | |
5272 | ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t) | |
5273 | ;; (goto-char (match-beginning 1)) | |
5274 | ;; (if raise-error | |
5275 | ;; (error "No file on this line") | |
5276 | ;; nil)))) | |
5277 | ||
5278 | ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist) | |
5279 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5280 | ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename) | |
5281 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5282 | ||
5283 | ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol) | |
5284 | ;; ;; Assumes point is at beginning of filename. | |
5285 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5286 | ;; ;; case-fold-search must be nil, at least for VMS. | |
5287 | ;; ;; On failure, signals an error or returns nil. | |
5288 | ;; ;; This is the VMS version. | |
5289 | ;; (let (opoint hidden case-fold-search) | |
5290 | ;; (setq opoint (point)) | |
5ed619e0 | 5291 | ;; (or eol (setq eol (line-end-position))) |
8749abea GM |
5292 | ;; (setq hidden (and selective-display |
5293 | ;; (save-excursion (search-forward "\r" eol t)))) | |
5294 | ;; (if hidden | |
5295 | ;; nil | |
5296 | ;; (re-search-forward ange-ftp-vms-filename-regexp eol t)) | |
5297 | ;; (or no-error | |
5298 | ;; (not (eq opoint (point))) | |
5299 | ;; (error | |
5300 | ;; (if hidden | |
5301 | ;; (substitute-command-keys | |
5302 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide") | |
5303 | ;; "No file on this line"))) | |
5304 | ;; (if (eq opoint (point)) | |
5305 | ;; nil | |
5306 | ;; (point)))) | |
5307 | ||
5308 | ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist) | |
5309 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5310 | ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename) | |
5311 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5312 | ||
5313 | ;;(defun ange-ftp-dired-vms-between-files () | |
5314 | ;; (save-excursion | |
5315 | ;; (beginning-of-line) | |
5316 | ;; (or (equal (following-char) 10) ; newline | |
5317 | ;; (equal (following-char) 9) ; tab | |
5318 | ;; (progn (forward-char 2) | |
5319 | ;; (or (looking-at "Total of") | |
5320 | ;; (equal (following-char) 32)))))) | |
5321 | ||
5322 | ;;(or (assq 'vms ange-ftp-dired-between-files-alist) | |
5323 | ;; (setq ange-ftp-dired-between-files-alist | |
5324 | ;; (cons '(vms . ange-ftp-dired-vms-between-files) | |
5325 | ;; ange-ftp-dired-between-files-alist))) | |
5326 | ||
5327 | ;; Beware! In VMS filenames must be of the form "FILE.TYPE". | |
5328 | ;; Therefore, we cannot just append a ".Z" to filenames for | |
5329 | ;; compressed files. Instead, we turn "FILE.TYPE" into | |
5330 | ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do. | |
5331 | ||
5332 | (defun ange-ftp-vms-make-compressed-filename (name &optional reverse) | |
5333 | (cond | |
aa6f7b96 | 5334 | ((string-match "-Z;[0-9]+\\'" name) |
8749abea | 5335 | (list nil (substring name 0 (match-beginning 0)))) |
aa6f7b96 | 5336 | ((string-match ";[0-9]+\\'" name) |
8749abea | 5337 | (list nil (substring name 0 (match-beginning 0)))) |
aa6f7b96 | 5338 | ((string-match "-Z\\'" name) |
8749abea GM |
5339 | (list nil (substring name 0 -2))) |
5340 | (t | |
5341 | (list t | |
aa6f7b96 | 5342 | (if (string-match ";[0-9]+\\'" name) |
8749abea GM |
5343 | (concat (substring name 0 (match-beginning 0)) |
5344 | "-Z") | |
5345 | (concat name "-Z")))))) | |
5346 | ||
5347 | (or (assq 'vms ange-ftp-make-compressed-filename-alist) | |
5348 | (setq ange-ftp-make-compressed-filename-alist | |
5349 | (cons '(vms . ange-ftp-vms-make-compressed-filename) | |
5350 | ange-ftp-make-compressed-filename-alist))) | |
5351 | ||
5352 | ;;;; When the filename is too long, VMS will use two lines to list a file | |
5353 | ;;;; (damn them!) This will confuse dired. To solve this, need to convince | |
5354 | ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of | |
5355 | ;;;; (forward-line 1). This would require a number of changes to dired.el. | |
5356 | ;;;; If dired gets confused, revert-buffer will fix it. | |
5357 | ||
5358 | ;;(defun ange-ftp-dired-vms-ls-trim () | |
5359 | ;; (goto-char (point-min)) | |
5360 | ;; (let ((case-fold-search nil)) | |
5361 | ;; (re-search-forward ange-ftp-vms-filename-regexp)) | |
5362 | ;; (beginning-of-line) | |
5363 | ;; (delete-region (point-min) (point)) | |
5364 | ;; (forward-line 1) | |
5365 | ;; (delete-region (point) (point-max))) | |
5366 | ||
5367 | ||
5368 | ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist) | |
5369 | ;; (setq ange-ftp-dired-ls-trim-alist | |
5370 | ;; (cons '(vms . ange-ftp-dired-vms-ls-trim) | |
25759a92 | 5371 | ;; ange-ftp-dired-ls-trim-alist))) |
8749abea GM |
5372 | |
5373 | (defun ange-ftp-vms-sans-version (name &rest args) | |
5374 | (save-match-data | |
aa6f7b96 | 5375 | (if (string-match ";[0-9]+\\'" name) |
8749abea GM |
5376 | (substring name 0 (match-beginning 0)) |
5377 | name))) | |
5378 | ||
5379 | (or (assq 'vms ange-ftp-sans-version-alist) | |
5380 | (setq ange-ftp-sans-version-alist | |
5381 | (cons '(vms . ange-ftp-vms-sans-version) | |
5382 | ange-ftp-sans-version-alist))) | |
5383 | ||
5384 | ;;(defvar ange-ftp-file-version-alist) | |
5385 | ||
5386 | ;;;;; The vms version of clean-directory has 2 more optional args | |
5387 | ;;;;; than the usual dired version. This is so that it can be used by | |
5388 | ;;;;; ange-ftp-dired-vms-flag-backup-files. | |
5389 | ||
5390 | ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg) | |
5391 | ;; "Flag numerical backups for deletion. | |
5392 | ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest. | |
5393 | ;;Positive prefix arg KEEP overrides `dired-kept-versions'; | |
5394 | ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive. | |
5395 | ||
5396 | ;;To clear the flags on these files, you can use \\[dired-flag-backup-files] | |
5397 | ;;with a prefix argument." | |
5398 | ;;; (interactive "P") ; Never actually called interactively. | |
5399 | ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions))) | |
5400 | ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions)) | |
5401 | ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS! | |
5402 | ;; ;; This could wipe ALL copies of the file. | |
5403 | ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep))) | |
5404 | ;; (action (or msg "Cleaning")) | |
5405 | ;; (ange-ftp-trample-marker (or marker dired-del-marker)) | |
5406 | ;; (ange-ftp-file-version-alist ())) | |
5407 | ;; (message (concat action | |
5408 | ;; " numerical backups (keeping %d late, %d old)...") | |
5409 | ;; late-retention early-retention) | |
5410 | ;; ;; Look at each file. | |
5411 | ;; ;; If the file has numeric backup versions, | |
5412 | ;; ;; put on ange-ftp-file-version-alist an element of the form | |
5413 | ;; ;; (FILENAME . VERSION-NUMBER-LIST) | |
e3441f42 | 5414 | ;; (dired-map-dired-file-lines 'ange-ftp-dired-vms-collect-file-versions) |
8749abea GM |
5415 | ;; ;; Sort each VERSION-NUMBER-LIST, |
5416 | ;; ;; and remove the versions not to be deleted. | |
5417 | ;; (let ((fval ange-ftp-file-version-alist)) | |
5418 | ;; (while fval | |
5419 | ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<))) | |
5420 | ;; (v-count (length sorted-v-list))) | |
5421 | ;; (if (> v-count (+ early-retention late-retention)) | |
5422 | ;; (rplacd (nthcdr early-retention sorted-v-list) | |
5423 | ;; (nthcdr (- v-count late-retention) | |
5424 | ;; sorted-v-list))) | |
5425 | ;; (rplacd (car fval) | |
5426 | ;; (cdr sorted-v-list))) | |
5427 | ;; (setq fval (cdr fval)))) | |
5428 | ;; ;; Look at each file. If it is a numeric backup file, | |
5429 | ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion. | |
5430 | ;; (dired-map-dired-file-lines | |
e3441f42 | 5431 | ;; 'ange-ftp-dired-vms-trample-file-versions mark) |
8749abea GM |
5432 | ;; (message (concat action " numerical backups...done")))) |
5433 | ||
5434 | ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist) | |
5435 | ;; (setq ange-ftp-dired-clean-directory-alist | |
5436 | ;; (cons '(vms . ange-ftp-dired-vms-clean-directory) | |
5437 | ;; ange-ftp-dired-clean-directory-alist))) | |
5438 | ||
5439 | ;;(defun ange-ftp-dired-vms-collect-file-versions (fn) | |
5440 | ;; ;; "If it looks like file FN has versions, return a list of the versions. | |
5441 | ;; ;;That is a list of strings which are file names. | |
5442 | ;; ;;The caller may want to flag some of these files for deletion." | |
5443 | ;;(let ((name (nth 2 (ange-ftp-ftp-name fn)))) | |
5444 | ;; (if (string-match ";[0-9]+$" name) | |
5445 | ;; (let* ((name (substring name 0 (match-beginning 0))) | |
5446 | ;; (fn (ange-ftp-replace-name-component fn name))) | |
5447 | ;; (if (not (assq fn ange-ftp-file-version-alist)) | |
5448 | ;; (let* ((base-versions | |
5449 | ;; (concat (file-name-nondirectory name) ";")) | |
5450 | ;; (bv-length (length base-versions)) | |
5451 | ;; (possibilities (file-name-all-completions | |
5452 | ;; base-versions | |
5453 | ;; (file-name-directory fn))) | |
5454 | ;; (versions (mapcar | |
4f91a816 | 5455 | ;; (lambda (arg) |
8749abea GM |
5456 | ;; (if (and (string-match |
5457 | ;; "[0-9]+$" arg bv-length) | |
5458 | ;; (= (match-beginning 0) bv-length)) | |
5459 | ;; (string-to-int (substring arg bv-length)) | |
5460 | ;; 0)) | |
5461 | ;; possibilities))) | |
5462 | ;; (if versions | |
5463 | ;; (setq | |
5464 | ;; ange-ftp-file-version-alist | |
5465 | ;; (cons (cons fn versions) | |
5466 | ;; ange-ftp-file-version-alist))))))))) | |
5467 | ||
5468 | ;;(defun ange-ftp-dired-vms-trample-file-versions (fn) | |
5469 | ;; (let* ((start-vn (string-match ";[0-9]+$" fn)) | |
5470 | ;; base-version-list) | |
5471 | ;; (and start-vn | |
5472 | ;; (setq base-version-list ; there was a base version to which | |
5473 | ;; (assoc (substring fn 0 start-vn) ; this looks like a | |
5474 | ;; ange-ftp-file-version-alist)) ; subversion | |
5475 | ;; (not (memq (string-to-int (substring fn (1+ start-vn))) | |
5476 | ;; base-version-list)) ; this one doesn't make the cut | |
5477 | ;; (progn (beginning-of-line) | |
5478 | ;; (delete-char 1) | |
5479 | ;; (insert ange-ftp-trample-marker))))) | |
5480 | ||
5481 | ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p) | |
5482 | ;; (let ((dired-kept-versions 1) | |
5483 | ;; (kept-old-versions 0) | |
5484 | ;; marker msg) | |
5485 | ;; (if unflag-p | |
5486 | ;; (setq marker ?\040 msg "Unflagging") | |
5487 | ;; (setq marker dired-del-marker msg "Cleaning")) | |
5488 | ;; (ange-ftp-dired-vms-clean-directory nil marker msg))) | |
5489 | ||
5490 | ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist) | |
5491 | ;; (setq ange-ftp-dired-flag-backup-files-alist | |
5492 | ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files) | |
5493 | ;; ange-ftp-dired-flag-backup-files-alist))) | |
5494 | ||
5495 | ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches) | |
5496 | ;; (let ((file (dired-get-filename 'no-dir)) | |
5497 | ;; bak) | |
5498 | ;; (if (and (string-match ";[0-9]+$" file) | |
5499 | ;; ;; Find most recent previous version. | |
5500 | ;; (let ((root (substring file 0 (match-beginning 0))) | |
5501 | ;; (ver | |
5502 | ;; (string-to-int (substring file (1+ (match-beginning 0))))) | |
5503 | ;; found) | |
5504 | ;; (setq ver (1- ver)) | |
5505 | ;; (while (and (> ver 0) (not found)) | |
5506 | ;; (setq bak (concat root ";" (int-to-string ver))) | |
5507 | ;; (and (file-exists-p bak) (setq found t)) | |
5508 | ;; (setq ver (1- ver))) | |
5509 | ;; found)) | |
5510 | ;; (if switches | |
5511 | ;; (diff (expand-file-name bak) (expand-file-name file) switches) | |
5512 | ;; (diff (expand-file-name bak) (expand-file-name file))) | |
5513 | ;; (error "No previous version found for %s" file)))) | |
5514 | ||
5515 | ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist) | |
5516 | ;; (setq ange-ftp-dired-backup-diff-alist | |
5517 | ;; (cons '(vms . ange-ftp-dired-vms-backup-diff) | |
5518 | ;; ange-ftp-dired-backup-diff-alist))) | |
5519 | ||
5520 | \f | |
5521 | ;;;; ------------------------------------------------------------ | |
5522 | ;;;; MTS support | |
5523 | ;;;; ------------------------------------------------------------ | |
5524 | ||
5525 | ||
5526 | ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from | |
5527 | ;; MTS to UNIX-ish. | |
5528 | (defun ange-ftp-fix-name-for-mts (name &optional reverse) | |
5529 | (save-match-data | |
5530 | (if reverse | |
aa6f7b96 | 5531 | (if (string-match "\\`\\([^:]+:\\)?\\(.*\\)\\'" name) |
8749abea | 5532 | (let (acct file) |
e3441f42 SM |
5533 | (setq acct (match-string 1 name)) |
5534 | (setq file (match-string 2 name)) | |
8749abea GM |
5535 | (concat (and acct (concat "/" acct "/")) |
5536 | file)) | |
5537 | (error "name %s didn't match" name)) | |
aa6f7b96 | 5538 | (if (string-match "\\`/\\([^:]+:\\)/\\(.*\\)\\'" name) |
e3441f42 | 5539 | (concat (match-string 1 name) (match-string 2 name)) |
8749abea GM |
5540 | ;; Let's hope that mts will recognize it anyway. |
5541 | name)))) | |
5542 | ||
5543 | (or (assq 'mts ange-ftp-fix-name-func-alist) | |
5544 | (setq ange-ftp-fix-name-func-alist | |
5545 | (cons '(mts . ange-ftp-fix-name-for-mts) | |
5546 | ange-ftp-fix-name-func-alist))) | |
5547 | ||
5548 | ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing. | |
5549 | ;; Remember that there are no directories in MTS. | |
5550 | (defun ange-ftp-fix-dir-name-for-mts (dir-name) | |
5551 | (if (string-equal dir-name "/") | |
55535639 | 5552 | (error "Cannot get listing for fictitious \"/\" directory") |
8749abea GM |
5553 | (let ((dir-name (ange-ftp-fix-name-for-mts dir-name))) |
5554 | (cond | |
5555 | ((string-equal dir-name "") | |
5556 | "?") | |
aa6f7b96 | 5557 | ((string-match ":\\'" dir-name) |
8749abea GM |
5558 | (concat dir-name "?")) |
5559 | (dir-name))))) ; It's just a single file. | |
5560 | ||
5561 | (or (assq 'mts ange-ftp-fix-dir-name-func-alist) | |
5562 | (setq ange-ftp-fix-dir-name-func-alist | |
5563 | (cons '(mts . ange-ftp-fix-dir-name-for-mts) | |
5564 | ange-ftp-fix-dir-name-func-alist))) | |
5565 | ||
5566 | (or (memq 'mts ange-ftp-dumb-host-types) | |
5567 | (setq ange-ftp-dumb-host-types | |
5568 | (cons 'mts ange-ftp-dumb-host-types))) | |
5569 | ||
5570 | (defvar ange-ftp-mts-host-regexp nil) | |
5571 | ||
5572 | ;; Return non-nil if HOST is running MTS. | |
5573 | (defun ange-ftp-mts-host (host) | |
5574 | (and ange-ftp-mts-host-regexp | |
4671dba5 | 5575 | (string-match-p ange-ftp-mts-host-regexp host))) |
8749abea GM |
5576 | |
5577 | ;; Parse the current buffer which is assumed to be in mts ftp dir format. | |
5578 | (defun ange-ftp-parse-mts-listing () | |
6e85ef5f | 5579 | (let ((tbl (make-hash-table :test 'equal))) |
8749abea GM |
5580 | (goto-char (point-min)) |
5581 | (save-match-data | |
9bc260cf | 5582 | (while (re-search-forward directory-listing-before-filename-regexp nil t) |
8749abea GM |
5583 | (end-of-line) |
5584 | (skip-chars-backward " ") | |
5585 | (let ((end (point))) | |
5586 | (skip-chars-backward "-A-Z0-9_.!") | |
6e85ef5f | 5587 | (puthash (buffer-substring (point) end) nil tbl)) |
8749abea | 5588 | (forward-line 1))) |
6e85ef5f SM |
5589 | ;; Don't need to bother with .. |
5590 | (puthash "." t tbl) | |
8749abea GM |
5591 | tbl)) |
5592 | ||
e3441f42 SM |
5593 | (add-to-list 'ange-ftp-parse-list-func-alist |
5594 | '(mts . ange-ftp-parse-mts-listing)) | |
8749abea GM |
5595 | |
5596 | (defun ange-ftp-add-mts-host (host) | |
5597 | "Mark HOST as the name of a machine running MTS." | |
5598 | (interactive | |
5599 | (list (read-string "Host: " | |
5600 | (let ((name (or (buffer-file-name) default-directory))) | |
5601 | (and name (car (ange-ftp-ftp-name name))))))) | |
5602 | (if (not (ange-ftp-mts-host host)) | |
5603 | (setq ange-ftp-mts-host-regexp | |
5604 | (concat "^" (regexp-quote host) "$" | |
5605 | (and ange-ftp-mts-host-regexp "\\|") | |
5606 | ange-ftp-mts-host-regexp) | |
5607 | ange-ftp-host-cache nil))) | |
5608 | ||
5609 | ;;; Tree dired support: | |
5610 | ||
5611 | ;;;; There aren't too many systems left that use MTS. This dired support will | |
5612 | ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems | |
5613 | ;;;; implement ftp in the same way. If not, it might be necessary to make the | |
5614 | ;;;; following more flexible. | |
5615 | ||
5616 | ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol) | |
5617 | ;; "In dired, move to first char of filename on this line. | |
5618 | ;;Returns position (point) or nil if no filename on this line." | |
5619 | ;; ;; This is the MTS version. | |
5620 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5621 | ;; (beginning-of-line) | |
5622 | ;; (if (re-search-forward | |
5623 | ;; ange-ftp-date-regexp eol t) | |
5624 | ;; (progn | |
5625 | ;; (skip-chars-forward " ") ; Eat blanks after date | |
5626 | ;; (skip-chars-forward "0-9:" eol) ; Eat time or year | |
5627 | ;; (skip-chars-forward " " eol) ; one space before filename | |
5628 | ;; ;; When listing an account other than the users own account it appends | |
5629 | ;; ;; ACCT: to the beginning of the filename. Skip over this. | |
5630 | ;; (and (looking-at "[A-Z0-9_.]+:") | |
5631 | ;; (goto-char (match-end 0))) | |
5632 | ;; (point)) | |
5633 | ;; (if raise-error | |
5634 | ;; (error "No file on this line") | |
5635 | ;; nil))) | |
5636 | ||
5637 | ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist) | |
5638 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5639 | ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename) | |
5640 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5641 | ||
5642 | ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol) | |
5643 | ;; ;; Assumes point is at beginning of filename. | |
5644 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5645 | ;; ;; On failure, signals an error or returns nil. | |
5646 | ;; ;; This is the MTS version. | |
5647 | ;; (let (opoint hidden case-fold-search) | |
5648 | ;; (setq opoint (point) | |
5ed619e0 | 5649 | ;; eol (line-end-position) |
8749abea GM |
5650 | ;; hidden (and selective-display |
5651 | ;; (save-excursion (search-forward "\r" eol t)))) | |
5652 | ;; (if hidden | |
5653 | ;; nil | |
5654 | ;; (skip-chars-forward "-A-Z0-9._!" eol)) | |
5655 | ;; (or no-error | |
5656 | ;; (not (eq opoint (point))) | |
5657 | ;; (error | |
5658 | ;; (if hidden | |
5659 | ;; (substitute-command-keys | |
5660 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide") | |
5661 | ;; "No file on this line"))) | |
5662 | ;; (if (eq opoint (point)) | |
5663 | ;; nil | |
5664 | ;; (point)))) | |
5665 | ||
5666 | ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist) | |
5667 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5668 | ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename) | |
5669 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5670 | \f | |
5671 | ;;;; ------------------------------------------------------------ | |
5672 | ;;;; CMS support | |
5673 | ;;;; ------------------------------------------------------------ | |
5674 | ||
5675 | ;; Since CMS doesn't have any full file name syntax, we have to fudge | |
5676 | ;; things with cd's. We actually send too many cd's, but it's dangerous | |
5677 | ;; to try to remember the current minidisk, because if the connection | |
5678 | ;; is closed and needs to be reopened, we will find ourselves back in | |
5679 | ;; the default minidisk. This is fairly likely since CMS ftp servers | |
5680 | ;; usually close the connection after 5 minutes of inactivity. | |
5681 | ||
5682 | ;; Have I got the filename character set right? | |
5683 | ||
5684 | (defun ange-ftp-fix-name-for-cms (name &optional reverse) | |
5685 | (save-match-data | |
5686 | (if reverse | |
5687 | ;; Since we only convert output from a pwd in this direction, | |
5688 | ;; we'll assume that it's a minidisk, and make it into a | |
5689 | ;; directory file name. Note that the expand-dir-hashtable | |
5690 | ;; stores directories without the trailing /. Is this | |
5691 | ;; consistent? | |
5692 | (concat "/" name) | |
aa6f7b96 | 5693 | (if (string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'" |
8749abea | 5694 | name) |
e3441f42 | 5695 | (let ((minidisk (match-string 1 name))) |
8749abea | 5696 | (if (match-beginning 2) |
e3441f42 | 5697 | (let ((file (match-string 2 name)) |
8749abea GM |
5698 | (cmd (concat "cd " minidisk)) |
5699 | ||
5700 | ;; Note that host and user are bound in the call | |
5701 | ;; to ange-ftp-send-cmd | |
5702 | (proc (ange-ftp-get-process ange-ftp-this-host | |
5703 | ange-ftp-this-user))) | |
5704 | ||
5705 | ;; Must use ange-ftp-raw-send-cmd here to avoid | |
5706 | ;; an infinite loop. | |
5707 | (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg)) | |
5708 | file | |
5709 | ;; failed... try ONCE more. | |
5710 | (setq proc (ange-ftp-get-process ange-ftp-this-host | |
5711 | ange-ftp-this-user)) | |
5712 | (let ((result (ange-ftp-raw-send-cmd proc cmd | |
5713 | ange-ftp-this-msg))) | |
5714 | (if (car result) | |
5715 | file | |
5716 | ;; failed. give up. | |
5717 | (ange-ftp-error ange-ftp-this-host ange-ftp-this-user | |
5718 | (format "cd to minidisk %s failed: %s" | |
5719 | minidisk (cdr result))))))) | |
5720 | ;; return the minidisk | |
5721 | minidisk)) | |
5722 | (error "Invalid CMS filename"))))) | |
5723 | ||
5724 | (or (assq 'cms ange-ftp-fix-name-func-alist) | |
5725 | (setq ange-ftp-fix-name-func-alist | |
5726 | (cons '(cms . ange-ftp-fix-name-for-cms) | |
5727 | ange-ftp-fix-name-func-alist))) | |
5728 | ||
5729 | (or (memq 'cms ange-ftp-dumb-host-types) | |
5730 | (setq ange-ftp-dumb-host-types | |
5731 | (cons 'cms ange-ftp-dumb-host-types))) | |
5732 | ||
5733 | ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing. | |
5734 | (defun ange-ftp-fix-dir-name-for-cms (dir-name) | |
5735 | (cond | |
5736 | ((string-equal "/" dir-name) | |
55535639 | 5737 | (error "Cannot get listing for fictitious \"/\" directory")) |
aa6f7b96 | 5738 | ((string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'" dir-name) |
e3441f42 | 5739 | (let* ((minidisk (match-string 1 dir-name)) |
8749abea GM |
5740 | ;; host and user are bound in the call to ange-ftp-send-cmd |
5741 | (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user)) | |
5742 | (cmd (concat "cd " minidisk)) | |
5743 | (file (if (match-beginning 2) | |
5744 | ;; it's a single file | |
e3441f42 | 5745 | (match-string 2 dir-name) |
8749abea GM |
5746 | ;; use the wild-card |
5747 | "*"))) | |
5748 | (if (car (ange-ftp-raw-send-cmd proc cmd)) | |
5749 | file | |
5750 | ;; try again... | |
5751 | (setq proc (ange-ftp-get-process ange-ftp-this-host | |
5752 | ange-ftp-this-user)) | |
5753 | (let ((result (ange-ftp-raw-send-cmd proc cmd))) | |
5754 | (if (car result) | |
5755 | file | |
5756 | ;; give up | |
5757 | (ange-ftp-error ange-ftp-this-host ange-ftp-this-user | |
5758 | (format "cd to minidisk %s failed: %s" | |
5759 | minidisk (cdr result)))))))) | |
5760 | (t (error "Invalid CMS file name")))) | |
5761 | ||
5762 | (or (assq 'cms ange-ftp-fix-dir-name-func-alist) | |
5763 | (setq ange-ftp-fix-dir-name-func-alist | |
5764 | (cons '(cms . ange-ftp-fix-dir-name-for-cms) | |
5765 | ange-ftp-fix-dir-name-func-alist))) | |
5766 | ||
5767 | (defvar ange-ftp-cms-host-regexp nil | |
5768 | "Regular expression to match hosts running the CMS operating system.") | |
5769 | ||
5770 | ;; Return non-nil if HOST is running CMS. | |
5771 | (defun ange-ftp-cms-host (host) | |
5772 | (and ange-ftp-cms-host-regexp | |
4671dba5 | 5773 | (string-match-p ange-ftp-cms-host-regexp host))) |
8749abea GM |
5774 | |
5775 | (defun ange-ftp-add-cms-host (host) | |
5776 | "Mark HOST as the name of a CMS host." | |
5777 | (interactive | |
5778 | (list (read-string "Host: " | |
5779 | (let ((name (or (buffer-file-name) default-directory))) | |
5780 | (and name (car (ange-ftp-ftp-name name))))))) | |
5781 | (if (not (ange-ftp-cms-host host)) | |
5782 | (setq ange-ftp-cms-host-regexp | |
5783 | (concat "^" (regexp-quote host) "$" | |
5784 | (and ange-ftp-cms-host-regexp "\\|") | |
5785 | ange-ftp-cms-host-regexp) | |
5786 | ange-ftp-host-cache nil))) | |
5787 | ||
5788 | (defun ange-ftp-parse-cms-listing () | |
5789 | ;; Parse the current buffer which is assumed to be a CMS directory listing. | |
5790 | ;; If we succeed in getting a listing, then we will assume that the minidisk | |
5791 | ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work | |
5792 | ;; because ange-ftp doesn't know that the root hashtable has only part of | |
5793 | ;; the info. It will assume that if a minidisk isn't in it, then it doesn't | |
5794 | ;; exist. It would be nice if completion worked for minidisks, as we | |
5795 | ;; discover them. | |
5796 | ; (let* ((dir-file (directory-file-name file)) | |
5797 | ; (root (file-name-directory dir-file)) | |
5798 | ; (minidisk (ange-ftp-get-file-part dir-file)) | |
5799 | ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable))) | |
5800 | ; (if root-tbl | |
6e85ef5f | 5801 | ; (puthash minidisk t root-tbl) |
8749abea | 5802 | ; (setq root-tbl (ange-ftp-make-hashtable)) |
6e85ef5f SM |
5803 | ; (puthash minidisk t root-tbl) |
5804 | ; (puthash "." t root-tbl) | |
8749abea GM |
5805 | ; (ange-ftp-set-files root root-tbl))) |
5806 | ;; Now do the usual parsing | |
6e85ef5f | 5807 | (let ((tbl (make-hash-table :test 'equal))) |
8749abea GM |
5808 | (goto-char (point-min)) |
5809 | (save-match-data | |
5810 | (while | |
5811 | (re-search-forward | |
5812 | "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t) | |
e3441f42 | 5813 | (puthash (concat (match-string 1) "." (match-string 2)) nil tbl) |
8749abea | 5814 | (forward-line 1)) |
6e85ef5f | 5815 | (puthash "." t tbl)) |
8749abea GM |
5816 | tbl)) |
5817 | ||
e3441f42 SM |
5818 | (add-to-list 'ange-ftp-parse-list-func-alist |
5819 | '(cms . ange-ftp-parse-cms-listing)) | |
25759a92 | 5820 | |
8749abea GM |
5821 | ;;;;; Tree dired support: |
5822 | ||
5823 | ;;(defconst ange-ftp-dired-cms-re-exe | |
5824 | ;; "^. [-A-Z0-9$_]+ +EXEC " | |
5825 | ;; "Regular expression to use to search for CMS executables.") | |
5826 | ||
5827 | ;;(or (assq 'cms ange-ftp-dired-re-exe-alist) | |
5828 | ;; (setq ange-ftp-dired-re-exe-alist | |
5829 | ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe) | |
5830 | ;; ange-ftp-dired-re-exe-alist))) | |
5831 | ||
5832 | ||
5833 | ;;(defun ange-ftp-dired-cms-insert-headerline (dir) | |
5834 | ;; ;; CMS has no total line, so we insert a blank line for | |
5835 | ;; ;; aesthetics. | |
5836 | ;; (insert "\n") | |
5837 | ;; (forward-char -1) | |
5838 | ;; (ange-ftp-real-dired-insert-headerline dir)) | |
5839 | ||
5840 | ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist) | |
5841 | ;; (setq ange-ftp-dired-insert-headerline-alist | |
5842 | ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline) | |
5843 | ;; ange-ftp-dired-insert-headerline-alist))) | |
5844 | ||
5845 | ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol) | |
5846 | ;; "In dired, move to the first char of filename on this line." | |
5847 | ;; ;; This is the CMS version. | |
5848 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5849 | ;; (let (case-fold-search) | |
5850 | ;; (beginning-of-line) | |
5851 | ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t) | |
5852 | ;; (goto-char (1+ (match-beginning 0))) | |
5853 | ;; (if raise-error | |
5854 | ;; (error "No file on this line") | |
5855 | ;; nil)))) | |
5856 | ||
5857 | ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist) | |
5858 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5859 | ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename) | |
5860 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5861 | ||
5862 | ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol) | |
5863 | ;; ;; Assumes point is at beginning of filename. | |
5864 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5865 | ;; ;; case-fold-search must be nil, at least for VMS. | |
5866 | ;; ;; On failure, signals an error or returns nil. | |
5867 | ;; ;; This is the CMS version. | |
5868 | ;; (let ((opoint (point)) | |
5869 | ;; case-fold-search hidden) | |
5ed619e0 | 5870 | ;; (or eol (setq eol (line-end-position))) |
8749abea GM |
5871 | ;; (setq hidden (and selective-display |
5872 | ;; (save-excursion | |
5873 | ;; (search-forward "\r" eol t)))) | |
5874 | ;; (if hidden | |
5875 | ;; (if no-error | |
5876 | ;; nil | |
5877 | ;; (error | |
5878 | ;; (substitute-command-keys | |
5879 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide"))) | |
5880 | ;; (skip-chars-forward "-A-Z0-9$_" eol) | |
5881 | ;; (skip-chars-forward " " eol) | |
5882 | ;; (skip-chars-forward "-A-Z0-9$_" eol) | |
5883 | ;; (if (eq opoint (point)) | |
5884 | ;; (if no-error | |
5885 | ;; nil | |
5886 | ;; (error "No file on this line")) | |
5887 | ;; (point))))) | |
5888 | ||
5889 | ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist) | |
5890 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5891 | ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename) | |
5892 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5893 | ||
5894 | (defun ange-ftp-cms-make-compressed-filename (name &optional reverse) | |
aa6f7b96 | 5895 | (if (string-match "-Z\\'" name) |
8749abea GM |
5896 | (list nil (substring name 0 -2)) |
5897 | (list t (concat name "-Z")))) | |
5898 | ||
5899 | (or (assq 'cms ange-ftp-make-compressed-filename-alist) | |
5900 | (setq ange-ftp-make-compressed-filename-alist | |
5901 | (cons '(cms . ange-ftp-cms-make-compressed-filename) | |
5902 | ange-ftp-make-compressed-filename-alist))) | |
5903 | ||
5904 | ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep) | |
5905 | ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep))) | |
5906 | ;; (and name | |
5907 | ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name) | |
5908 | ;; (concat (substring name 0 (match-end 1)) | |
5909 | ;; "." | |
5910 | ;; (substring name (match-beginning 2) (match-end 2))) | |
5911 | ;; name)))) | |
5912 | ||
5913 | ;;(or (assq 'cms ange-ftp-dired-get-filename-alist) | |
5914 | ;; (setq ange-ftp-dired-get-filename-alist | |
5915 | ;; (cons '(cms . ange-ftp-dired-cms-get-filename) | |
5916 | ;; ange-ftp-dired-get-filename-alist))) | |
5917 | \f | |
9c35d706 RS |
5918 | ;;;; ------------------------------------------------------------ |
5919 | ;;;; BS2000 support | |
5920 | ;;;; ------------------------------------------------------------ | |
5921 | ||
5922 | ;; There seems to be an error with regexps. '-' has to be the first | |
5923 | ;; character inside of the square brackets. | |
5924 | (defconst ange-ftp-bs2000-short-filename-regexp | |
5925 | "[-A-Z0-9$#@.]*[A-Z][-A-Z0-9$#@.]*" | |
5926 | "Regular expression to match for a valid short BS2000 file name.") | |
5927 | ||
5928 | (defconst ange-ftp-bs2000-fix-name-regexp-reverse | |
5929 | (concat | |
5930 | "^\\(" ange-ftp-bs2000-filename-pubset-regexp "\\)?" | |
5931 | "\\(" ange-ftp-bs2000-filename-username-regexp "\\)?" | |
5932 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?") | |
4671dba5 | 5933 | "Regular expression used in `ange-ftp-fix-name-for-bs2000'.") |
9c35d706 RS |
5934 | |
5935 | (defconst ange-ftp-bs2000-fix-name-regexp | |
5936 | (concat | |
5937 | "/?\\(" ange-ftp-bs2000-filename-pubset-regexp "/\\)?" | |
5938 | "\\(\\$[A-Z0-9]*/\\)?" | |
5939 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?") | |
4671dba5 | 5940 | "Regular expression used in `ange-ftp-fix-name-for-bs2000'.") |
9c35d706 RS |
5941 | |
5942 | (defcustom ange-ftp-bs2000-special-prefix | |
5943 | "X" | |
4671dba5 | 5944 | "Prefix used for filenames starting with '#' or '@'." |
9c35d706 RS |
5945 | :group 'ange-ftp |
5946 | :type 'string) | |
5947 | ||
5948 | ;; Convert NAME from UNIX-ish to BS2000. If REVERSE given then convert from | |
5949 | ;; BS2000 to UNIX-ish. | |
5950 | (defun ange-ftp-fix-name-for-bs2000 (name &optional reverse) | |
5951 | (save-match-data | |
5952 | (if reverse | |
5953 | (if (string-match | |
5954 | ange-ftp-bs2000-fix-name-regexp-reverse | |
5955 | name) | |
5956 | (let ((pubset (if (match-beginning 1) | |
5957 | (substring name 0 (match-end 1)))) | |
5958 | (userid (if (match-beginning 2) | |
5959 | (substring name | |
5960 | (match-beginning 2) | |
5961 | (1- (match-end 2))))) | |
5962 | (filename (if (match-beginning 3) | |
5963 | (substring name (match-beginning 3))))) | |
5964 | (concat | |
5965 | "/" | |
5966 | ;; we have to insert "_/" here to prevent expand-file-name to | |
5967 | ;; interpret BS2000 pubsets as the special escape prefix: | |
5968 | (and pubset (concat "_/" pubset "/")) | |
5969 | (and userid (concat userid "/")) | |
5970 | filename)) | |
5971 | (error "name %s didn't match" name)) | |
5972 | ;; and here we (maybe) have to remove the inserted "_/" 'cause | |
5973 | ;; of our prevention of the special escape prefix above: | |
5974 | (if (string-match (concat "^/_/") name) | |
5975 | (setq name (substring name 2))) | |
5976 | (if (string-match | |
5977 | ange-ftp-bs2000-fix-name-regexp | |
5978 | name) | |
5979 | (let ((pubset (if (match-beginning 1) | |
5980 | (substring name | |
5981 | (match-beginning 1) | |
5982 | (1- (match-end 1))))) | |
5983 | (userid (if (match-beginning 2) | |
5984 | (substring name | |
5985 | (match-beginning 2) | |
5986 | (1- (match-end 2))))) | |
5987 | (filename (if (match-beginning 3) | |
5988 | (substring name (match-beginning 3))))) | |
5989 | (if (and (boundp 'filename) | |
5990 | (stringp filename) | |
5991 | (string-match "[#@].+" filename)) | |
5992 | (setq filename (concat ange-ftp-bs2000-special-prefix | |
5993 | (substring filename 1)))) | |
5994 | (upcase | |
5995 | (concat | |
5996 | pubset | |
5997 | (and userid (concat userid ".")) | |
5998 | ;; change every '/' in filename to a '.', normally not neccessary | |
5999 | (and filename | |
e3441f42 | 6000 | (subst-char-in-string ?/ ?. filename))))) |
9c35d706 RS |
6001 | ;; Let's hope that BS2000 recognize this anyway: |
6002 | name)))) | |
6003 | ||
6004 | (or (assq 'bs2000 ange-ftp-fix-name-func-alist) | |
6005 | (setq ange-ftp-fix-name-func-alist | |
6006 | (cons '(bs2000 . ange-ftp-fix-name-for-bs2000) | |
6007 | ange-ftp-fix-name-func-alist))) | |
6008 | ||
6009 | ;; Convert name from UNIX-ish to BS2000 ready for a DIRectory listing. | |
6010 | ;; Remember that there are no directories in BS2000. | |
6011 | (defun ange-ftp-fix-dir-name-for-bs2000 (dir-name) | |
6012 | (if (string-equal dir-name "/") | |
6013 | "*" ;; Don't use an empty string here! | |
6014 | (ange-ftp-fix-name-for-bs2000 dir-name))) | |
6015 | ||
6016 | (or (assq 'bs2000 ange-ftp-fix-dir-name-func-alist) | |
6017 | (setq ange-ftp-fix-dir-name-func-alist | |
6018 | (cons '(bs2000 . ange-ftp-fix-dir-name-for-bs2000) | |
6019 | ange-ftp-fix-dir-name-func-alist))) | |
6020 | ||
6021 | (or (memq 'bs2000 ange-ftp-dumb-host-types) | |
6022 | (setq ange-ftp-dumb-host-types | |
6023 | (cons 'bs2000 ange-ftp-dumb-host-types))) | |
6024 | ||
6025 | (defvar ange-ftp-bs2000-host-regexp nil) | |
6026 | (defvar ange-ftp-bs2000-posix-host-regexp nil) | |
6027 | ||
6028 | ;; Return non-nil if HOST is running BS2000. | |
6029 | (defun ange-ftp-bs2000-host (host) | |
6030 | (and ange-ftp-bs2000-host-regexp | |
4671dba5 | 6031 | (string-match-p ange-ftp-bs2000-host-regexp host))) |
9c35d706 RS |
6032 | ;; Return non-nil if HOST is running BS2000 with POSIX subsystem. |
6033 | (defun ange-ftp-bs2000-posix-host (host) | |
6034 | (and ange-ftp-bs2000-posix-host-regexp | |
4671dba5 | 6035 | (string-match-p ange-ftp-bs2000-posix-host-regexp host))) |
9c35d706 RS |
6036 | |
6037 | (defun ange-ftp-add-bs2000-host (host) | |
6038 | "Mark HOST as the name of a machine running BS2000." | |
6039 | (interactive | |
6040 | (list (read-string "Host: " | |
6041 | (let ((name (or (buffer-file-name) default-directory))) | |
6042 | (and name (car (ange-ftp-ftp-name name))))))) | |
6043 | (if (not (ange-ftp-bs2000-host host)) | |
6044 | (setq ange-ftp-bs2000-host-regexp | |
6045 | (concat "^" (regexp-quote host) "$" | |
6046 | (and ange-ftp-bs2000-host-regexp "\\|") | |
6047 | ange-ftp-bs2000-host-regexp) | |
6048 | ange-ftp-host-cache nil))) | |
6049 | ||
6050 | (defun ange-ftp-add-bs2000-posix-host (host) | |
6051 | "Mark HOST as the name of a machine running BS2000 with POSIX subsystem." | |
6052 | (interactive | |
6053 | (list (read-string "Host: " | |
6054 | (let ((name (or (buffer-file-name) default-directory))) | |
6055 | (and name (car (ange-ftp-ftp-name name))))))) | |
6056 | (if (not (ange-ftp-bs2000-posix-host host)) | |
6057 | (setq ange-ftp-bs2000-posix-host-regexp | |
6058 | (concat "^" (regexp-quote host) "$" | |
6059 | (and ange-ftp-bs2000-posix-host-regexp "\\|") | |
6060 | ange-ftp-bs2000-posix-host-regexp) | |
6061 | ange-ftp-host-cache nil)) | |
6062 | ;; Install CD hook to cd to posix on connecting: | |
e3441f42 | 6063 | (add-hook 'ange-ftp-process-startup-hook 'ange-ftp-bs2000-cd-to-posix) |
9c35d706 RS |
6064 | host) |
6065 | ||
6066 | (defconst ange-ftp-bs2000-filename-regexp | |
6067 | (concat | |
6068 | "\\(" ange-ftp-bs2000-filename-prefix-regexp "\\)?" | |
6069 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)") | |
6070 | "Regular expression to match for a valid BS2000 file name.") | |
6071 | ||
6072 | (defcustom ange-ftp-bs2000-additional-pubsets | |
6073 | nil | |
6074 | "*List of additional pubsets available to all users." | |
6075 | :group 'ange-ftp | |
33ceea4f | 6076 | :type '(repeat string)) |
9c35d706 RS |
6077 | |
6078 | ;; These parsing functions are as general as possible because the syntax | |
6079 | ;; of ftp listings from BS2000 hosts is a bit erratic. What saves us is that | |
6080 | ;; the BS2000 filename syntax is so rigid. | |
6081 | ||
6082 | ;; Extract the next filename from a BS2000 dired-like listing. | |
6083 | (defun ange-ftp-parse-bs2000-filename () | |
6084 | (if (re-search-forward ange-ftp-bs2000-filename-regexp nil t) | |
e3441f42 | 6085 | (match-string 2))) |
9c35d706 RS |
6086 | |
6087 | ;; Parse the current buffer which is assumed to be in (some) BS2000 FTP dir | |
6088 | ;; format, and return a hashtable as the result. | |
6089 | (defun ange-ftp-parse-bs2000-listing () | |
6e85ef5f | 6090 | (let ((tbl (make-hash-table :test 'equal)) |
9c35d706 RS |
6091 | pubset |
6092 | file) | |
6093 | ;; get current pubset | |
6094 | (goto-char (point-min)) | |
6095 | (if (re-search-forward ange-ftp-bs2000-filename-pubset-regexp nil t) | |
e3441f42 | 6096 | (setq pubset (match-string 0))) |
9c35d706 RS |
6097 | ;; add files to hashtable |
6098 | (goto-char (point-min)) | |
6099 | (save-match-data | |
6100 | (while (setq file (ange-ftp-parse-bs2000-filename)) | |
6e85ef5f | 6101 | (puthash file nil tbl))) |
9c35d706 | 6102 | ;; add . and .. |
6e85ef5f SM |
6103 | (puthash "." t tbl) |
6104 | (puthash ".." t tbl) | |
9c35d706 RS |
6105 | ;; add all additional pubsets, if not listing one of them |
6106 | (if (not (member pubset ange-ftp-bs2000-additional-pubsets)) | |
d590ea4d JB |
6107 | (mapc (lambda (pubset) (puthash pubset t tbl)) |
6108 | ange-ftp-bs2000-additional-pubsets)) | |
9c35d706 RS |
6109 | tbl)) |
6110 | ||
e3441f42 SM |
6111 | (add-to-list 'ange-ftp-parse-list-func-alist |
6112 | '(bs2000 . ange-ftp-parse-bs2000-listing)) | |
9c35d706 | 6113 | |
9c35d706 RS |
6114 | (defun ange-ftp-bs2000-cd-to-posix () |
6115 | "cd to POSIX subsystem if the current host matches | |
e3441f42 SM |
6116 | `ange-ftp-bs2000-posix-host-regexp'. All BS2000 hosts with POSIX subsystem |
6117 | MUST BE EXPLICITLY SET with `ange-ftp-add-bs2000-posix-host' for they cannot | |
9c35d706 | 6118 | be recognized automatically (they are all valid BS2000 hosts too)." |
e3441f42 | 6119 | (if (and ange-ftp-this-host (ange-ftp-bs2000-posix-host ange-ftp-this-host)) |
9c35d706 RS |
6120 | (progn |
6121 | ;; change to POSIX: | |
6122 | ; (ange-ftp-raw-send-cmd proc "cd %POSIX") | |
e3441f42 | 6123 | (ange-ftp-cd ange-ftp-this-host ange-ftp-this-user "%POSIX") |
9c35d706 | 6124 | ;; put new home directory in the expand-dir hashtable. |
e3441f42 SM |
6125 | ;; `ange-ftp-this-host' and `ange-ftp-this-user' are bound in |
6126 | ;; ange-ftp-get-process. | |
6127 | (puthash (concat ange-ftp-this-host "/" ange-ftp-this-user "/~") | |
6128 | (car (ange-ftp-get-pwd ange-ftp-this-host ange-ftp-this-user)) | |
6e85ef5f | 6129 | ange-ftp-expand-dir-hashtable)))) |
9c35d706 RS |
6130 | |
6131 | ;; Not available yet: | |
6132 | ;; ange-ftp-bs2000-delete-file-entry | |
6133 | ;; ange-ftp-bs2000-add-file-entry | |
6134 | ;; ange-ftp-bs2000-file-name-as-directory | |
6135 | ;; ange-ftp-bs2000-make-compressed-filename | |
6136 | ;; ange-ftp-bs2000-file-name-sans-versions | |
6137 | \f | |
8749abea GM |
6138 | ;;;; ------------------------------------------------------------ |
6139 | ;;;; Finally provide package. | |
6140 | ;;;; ------------------------------------------------------------ | |
6141 | ||
6142 | (provide 'ange-ftp) | |
6143 | ||
6144 | ;;; ange-ftp.el ends here |