Commit | Line | Data |
---|---|---|
8749abea GM |
1 | ;;; ange-ftp.el --- transparent FTP support for GNU Emacs |
2 | ||
5fd6d89f | 3 | ;; Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, |
114f9c96 | 4 | ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
a3374680 | 5 | ;; Free Software Foundation, Inc. |
8749abea GM |
6 | |
7 | ;; Author: Andy Norman (ange@hplb.hpl.hp.com) | |
8 | ;; Maintainer: FSF | |
9 | ;; Keywords: comm | |
10 | ||
11 | ;; This file is part of GNU Emacs. | |
12 | ||
874a927a | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
8749abea | 14 | ;; it under the terms of the GNU General Public License as published by |
874a927a GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
8749abea GM |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
874a927a | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
8749abea GM |
25 | |
26 | ;;; Commentary: | |
27 | ||
28 | ;; This package attempts to make accessing files and directories using FTP | |
29 | ;; from within GNU Emacs as simple and transparent as possible. A subset of | |
30 | ;; the common file-handling routines are extended to interact with FTP. | |
31 | ||
32 | ;; Usage: | |
33 | ;; | |
34 | ;; Some of the common GNU Emacs file-handling operations have been made | |
35 | ;; FTP-smart. If one of these routines is given a filename that matches | |
36 | ;; '/user@host:name' then it will spawn an FTP process connecting to machine | |
37 | ;; 'host' as account 'user' and perform its operation on the file 'name'. | |
38 | ;; | |
39 | ;; For example: if find-file is given a filename of: | |
40 | ;; | |
41 | ;; /ange@anorman:/tmp/notes | |
42 | ;; | |
43 | ;; then ange-ftp spawns an FTP process, connect to the host 'anorman' as | |
44 | ;; user 'ange', get the file '/tmp/notes' and pop up a buffer containing the | |
45 | ;; contents of that file as if it were on the local filesystem. If ange-ftp | |
46 | ;; needs a password to connect then it reads one in the echo area. | |
47 | ||
48 | ;; Extended filename syntax: | |
49 | ;; | |
50 | ;; The default extended filename syntax is '/user@host:name', where the | |
51 | ;; 'user@' part may be omitted. This syntax can be customised to a certain | |
52 | ;; extent by changing ange-ftp-name-format. There are limitations. | |
53 | ;; The `host' part has an optional suffix `#port' which may be used to | |
54 | ;; specify a non-default port number for the connexion. | |
55 | ;; | |
56 | ;; If the user part is omitted then ange-ftp generates a default user | |
57 | ;; instead whose value depends on the variable ange-ftp-default-user. | |
58 | ||
59 | ;; Passwords: | |
60 | ;; | |
61 | ;; A password is required for each host/user pair. Ange-ftp reads passwords | |
62 | ;; as needed. You can also specify a password with ange-ftp-set-passwd, or | |
63 | ;; in a *valid* ~/.netrc file. | |
64 | ||
65 | ;; Passwords for user "anonymous": | |
66 | ;; | |
67 | ;; Passwords for the user "anonymous" (or "ftp") are handled | |
68 | ;; specially. The variable `ange-ftp-generate-anonymous-password' | |
69 | ;; controls what happens: if the value of this variable is a string, | |
70 | ;; then this is used as the password; if non-nil (the default), then | |
71 | ;; the value of `user-mail-address' is used; if nil then the user | |
72 | ;; is prompted for a password as normal. | |
73 | ||
74 | ;; "Dumb" UNIX hosts: | |
75 | ;; | |
76 | ;; The FTP servers on some UNIX machines have problems if the 'ls' command is | |
77 | ;; used. | |
78 | ;; | |
79 | ;; The routine ange-ftp-add-dumb-unix-host can be called to tell ange-ftp to | |
80 | ;; limit itself to the DIR command and not 'ls' for a given UNIX host. Note | |
81 | ;; that this change will take effect for the current GNU Emacs session only. | |
82 | ;; See below for a discussion of non-UNIX hosts. If a large number of | |
83 | ;; machines with similar hostnames have this problem then it is easier to set | |
84 | ;; the value of ange-ftp-dumb-unix-host-regexp in your .emacs file. ange-ftp | |
85 | ;; is unable to automatically recognize dumb unix hosts. | |
86 | ||
87 | ;; File name completion: | |
88 | ;; | |
89 | ;; Full file-name completion is supported on UNIX, VMS, CMS, and MTS hosts. | |
90 | ;; To do filename completion, ange-ftp needs a listing from the remote host. | |
91 | ;; Therefore, for very slow connections, it might not save any time. | |
92 | ||
93 | ;; FTP processes: | |
94 | ;; | |
95 | ;; When ange-ftp starts up an FTP process, it leaves it running for speed | |
96 | ;; purposes. Some FTP servers will close the connection after a period of | |
97 | ;; time, but ange-ftp should be able to quietly reconnect the next time that | |
98 | ;; the process is needed. | |
99 | ;; | |
100 | ;; Killing the "*ftp user@host*" buffer also kills the ftp process. | |
101 | ;; This should not cause ange-ftp any grief. | |
102 | ||
103 | ;; Binary file transfers: | |
104 | ;; | |
105 | ;; By default ange-ftp transfers files in ASCII mode. If a file being | |
106 | ;; transferred matches the value of ange-ftp-binary-file-name-regexp then | |
107 | ;; binary mode is used for that transfer. | |
108 | ||
109 | ;; Account passwords: | |
110 | ;; | |
111 | ;; Some FTP servers require an additional password which is sent by the | |
112 | ;; ACCOUNT command. ange-ftp partially supports this by allowing the user to | |
113 | ;; specify an account password by either calling ange-ftp-set-account, or by | |
114 | ;; specifying an account token in the .netrc file. If the account password | |
115 | ;; is set by either of these methods then ange-ftp will issue an ACCOUNT | |
116 | ;; command upon starting the FTP process. | |
117 | ||
118 | ;; Preloading: | |
119 | ;; | |
120 | ;; ange-ftp can be preloaded, but must be put in the site-init.el file and | |
121 | ;; not the site-load.el file in order for the documentation strings for the | |
122 | ;; functions being overloaded to be available. | |
123 | ||
124 | ;; Status reports: | |
125 | ;; | |
126 | ;; Most ange-ftp commands that talk to the FTP process output a status | |
127 | ;; message on what they are doing. In addition, ange-ftp can take advantage | |
128 | ;; of the FTP client's HASH command to display the status of transferring | |
129 | ;; files and listing directories. See the documentation for the variables | |
130 | ;; ange-ftp-{ascii,binary}-hash-mark-size, ange-ftp-send-hash and | |
131 | ;; ange-ftp-process-verbose for more details. | |
132 | ||
133 | ;; Gateways: | |
134 | ;; | |
135 | ;; Sometimes it is necessary for the FTP process to be run on a different | |
136 | ;; machine than the machine running GNU Emacs. This can happen when the | |
137 | ;; local machine has restrictions on what hosts it can access. | |
138 | ;; | |
139 | ;; ange-ftp has support for running the ftp process on a different (gateway) | |
140 | ;; machine. The way it works is as follows: | |
141 | ;; | |
142 | ;; 1) Set the variable 'ange-ftp-gateway-host' to the name of a machine | |
143 | ;; that doesn't have the access restrictions. | |
144 | ;; | |
145 | ;; 2) Set the variable 'ange-ftp-local-host-regexp' to a regular expression | |
146 | ;; that matches hosts that can be contacted from running a local ftp | |
147 | ;; process, but fails to match hosts that can't be accessed locally. For | |
148 | ;; example: | |
149 | ;; | |
150 | ;; "\\.hp\\.com$\\|^[^.]*$" | |
151 | ;; | |
152 | ;; will match all hosts that are in the .hp.com domain, or don't have an | |
153 | ;; explicit domain in their name, but will fail to match hosts with | |
154 | ;; explicit domains or that are specified by their ip address. | |
155 | ;; | |
156 | ;; 3) Using NFS and symlinks, make sure that there is a shared directory with | |
157 | ;; the *same* name between the local machine and the gateway machine. | |
158 | ;; This directory is necessary for temporary files created by ange-ftp. | |
159 | ;; | |
160 | ;; 4) Set the variable 'ange-ftp-gateway-tmp-name-template' to the name of | |
161 | ;; this directory plus an identifying filename prefix. For example: | |
162 | ;; | |
163 | ;; "/nfs/hplose/ange/ange-ftp" | |
164 | ;; | |
165 | ;; where /nfs/hplose/ange is a directory that is shared between the | |
166 | ;; gateway machine and the local machine. | |
167 | ;; | |
168 | ;; The simplest way of getting a ftp process running on the gateway machine | |
169 | ;; is if you can spawn a remote shell using either 'rsh' or 'remsh'. If you | |
170 | ;; can't do this for some reason such as security then points 7 onwards will | |
171 | ;; discuss an alternative approach. | |
172 | ;; | |
173 | ;; 5) Set the variable ange-ftp-gateway-program to the name of the remote | |
174 | ;; shell process such as 'remsh' or 'rsh' if the default isn't correct. | |
175 | ;; | |
176 | ;; 6) Set the variable ange-ftp-gateway-program-interactive to nil if it | |
177 | ;; isn't already. This tells ange-ftp that you are using a remote shell | |
178 | ;; rather than logging in using telnet or rlogin. | |
179 | ;; | |
180 | ;; That should be all you need to allow ange-ftp to spawn a ftp process on | |
181 | ;; the gateway machine. If you have to use telnet or rlogin to get to the | |
182 | ;; gateway machine then follow the instructions below. | |
183 | ;; | |
184 | ;; 7) Set the variable ange-ftp-gateway-program to the name of the program | |
185 | ;; that lets you log onto the gateway machine. This may be something like | |
186 | ;; telnet or rlogin. | |
187 | ;; | |
188 | ;; 8) Set the variable ange-ftp-gateway-prompt-pattern to a regular | |
189 | ;; expression that matches the prompt you get when you login to the | |
190 | ;; gateway machine. Be very specific here; this regexp must not match | |
191 | ;; *anything* in your login banner except this prompt. | |
192 | ;; shell-prompt-pattern is far too general as it appears to match some | |
193 | ;; login banners from Sun machines. For example: | |
194 | ;; | |
195 | ;; "^$*$ *" | |
196 | ;; | |
197 | ;; 9) Set the variable ange-ftp-gateway-program-interactive to 't' to let | |
198 | ;; ange-ftp know that it has to "hand-hold" the login to the gateway | |
199 | ;; machine. | |
200 | ;; | |
201 | ;; 10) Set the variable ange-ftp-gateway-setup-term-command to a UNIX command | |
202 | ;; that will put the pty connected to the gateway machine into a | |
203 | ;; no-echoing mode, and will strip off carriage-returns from output from | |
204 | ;; the gateway machine. For example: | |
205 | ;; | |
206 | ;; "stty -onlcr -echo" | |
207 | ;; | |
208 | ;; will work on HP-UX machines, whereas: | |
209 | ;; | |
210 | ;; "stty -echo nl" | |
211 | ;; | |
212 | ;; appears to work for some Sun machines. | |
213 | ;; | |
214 | ;; That's all there is to it. | |
215 | ||
216 | ;; Smart gateways: | |
217 | ;; | |
218 | ;; If you have a "smart" ftp program that allows you to issue commands like | |
219 | ;; "USER foo@bar" which do nice proxy things, then look at the variables | |
220 | ;; ange-ftp-smart-gateway and ange-ftp-smart-gateway-port. | |
221 | ;; | |
222 | ;; Otherwise, if there is an alternate ftp program that implements proxy in | |
223 | ;; a transparent way (i.e. w/o specifying the proxy host), that will | |
224 | ;; connect you directly to the desired destination host: | |
225 | ;; Set ange-ftp-gateway-ftp-program-name to that program's name. | |
226 | ;; Set ange-ftp-local-host-regexp to a value as stated earlier on. | |
227 | ;; Leave ange-ftp-gateway-host set to nil. | |
228 | ;; Set ange-ftp-smart-gateway to t. | |
229 | ||
230 | ;; Tips for using ange-ftp: | |
231 | ;; | |
232 | ;; 1. For dired to work on a host which marks symlinks with a trailing @ in | |
233 | ;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t). | |
234 | ;; Most UNIX systems do not do this, but ULTRIX does. If you think that | |
235 | ;; there is a chance you might connect to an ULTRIX machine (such as | |
236 | ;; prep.ai.mit.edu), then set this variable accordingly. This will have | |
237 | ;; the side effect that dired will have problems with symlinks whose names | |
238 | ;; end in an @. If you get yourself into this situation then editing | |
239 | ;; dired's ls-switches to remove "F", will temporarily fix things. | |
240 | ;; | |
241 | ;; 2. If you know that you are connecting to a certain non-UNIX machine | |
242 | ;; frequently, and ange-ftp seems to be unable to guess its host-type, | |
243 | ;; then setting the appropriate host-type regexp | |
244 | ;; (ange-ftp-vms-host-regexp, ange-ftp-mts-host-regexp, or | |
245 | ;; ange-ftp-cms-host-regexp) accordingly should help. Also, please report | |
246 | ;; ange-ftp's inability to recognize the host-type as a bug. | |
247 | ;; | |
248 | ;; 3. For slow connections, you might get "listing unreadable" error | |
249 | ;; messages, or get an empty buffer for a file that you know has something | |
250 | ;; in it. The solution is to increase the value of ange-ftp-retry-time. | |
251 | ;; Its default value is 5 which is plenty for reasonable connections. | |
252 | ;; However, for some transatlantic connections I set this to 20. | |
253 | ;; | |
254 | ;; 4. Beware of compressing files on non-UNIX hosts. Ange-ftp will do it by | |
255 | ;; copying the file to the local machine, compressing it there, and then | |
256 | ;; sending it back. Binary file transfers between machines of different | |
257 | ;; architectures can be a risky business. Test things out first on some | |
258 | ;; test files. See "Bugs" below. Also, note that ange-ftp copies files by | |
259 | ;; moving them through the local machine. Again, be careful when doing | |
260 | ;; this with binary files on non-Unix machines. | |
261 | ;; | |
262 | ;; 5. Beware that dired over ftp will use your setting of dired-no-confirm | |
263 | ;; (list of dired commands for which confirmation is not asked). You | |
264 | ;; might want to reconsider your setting of this variable, because you | |
265 | ;; might want confirmation for more commands on remote direds than on | |
266 | ;; local direds. For example, I strongly recommend that you not include | |
267 | ;; compress and uncompress in this list. If there is enough demand it | |
268 | ;; might be a good idea to have an alist ange-ftp-dired-no-confirm of | |
269 | ;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST | |
270 | ;; is a list of commands for which confirmation would be suppressed. Then | |
271 | ;; remote dired listings would take their (buffer-local) value of | |
272 | ;; dired-no-confirm from this alist. Who votes for this? | |
273 | ||
274 | ;; --------------------------------------------------------------------- | |
275 | ;; Non-UNIX support: | |
276 | ;; --------------------------------------------------------------------- | |
277 | ||
278 | ;; VMS support: | |
279 | ;; | |
280 | ;; Ange-ftp has full support for VMS hosts. It | |
281 | ;; should be able to automatically recognize any VMS machine. However, if it | |
282 | ;; fails to do this, you can use the command ange-ftp-add-vms-host. As well, | |
283 | ;; you can set the variable ange-ftp-vms-host-regexp in your .emacs file. We | |
284 | ;; would be grateful if you would report any failures to automatically | |
285 | ;; recognize a VMS host as a bug. | |
286 | ;; | |
287 | ;; Filename Syntax: | |
288 | ;; | |
289 | ;; For ease of *implementation*, the user enters the VMS filename syntax in a | |
290 | ;; UNIX-y way. For example: | |
291 | ;; PUB$:[ANONYMOUS.SDSCPUB.NEXT]README.TXT;1 | |
292 | ;; would be entered as: | |
293 | ;; /PUB$$:/ANONYMOUS/SDSCPUB/NEXT/README.TXT;1 | |
294 | ;; i.e. to log in as anonymous on ymir.claremont.edu and grab the file: | |
295 | ;; [.CSV.POLICY]RULES.MEM | |
296 | ;; you would type: | |
297 | ;; C-x C-f /anonymous@ymir.claremont.edu:CSV/POLICY/RULES.MEM | |
298 | ;; | |
0138efd4 | 299 | ;; A valid VMS filename is of the form: FILE.TYPE;## |
8749abea GM |
300 | ;; where FILE can be up to 39 characters |
301 | ;; TYPE can be up to 39 characters | |
302 | ;; ## is a version number (an integer between 1 and 32,767) | |
303 | ;; Valid characters in FILE and TYPE are A-Z 0-9 _ - $ | |
304 | ;; $ cannot begin a filename, and - cannot be used as the first or last | |
305 | ;; character. | |
306 | ;; | |
307 | ;; Tips: | |
308 | ;; 1. Although VMS is not case sensitive, EMACS running under UNIX is. | |
309 | ;; Therefore, to access a VMS file, you must enter the filename with upper | |
310 | ;; case letters. | |
311 | ;; 2. To access the latest version of file under VMS, you use the filename | |
312 | ;; without the ";" and version number. You should always edit the latest | |
313 | ;; version of a file. If you want to edit an earlier version, copy it to a | |
314 | ;; new file first. This has nothing to do with ange-ftp, but is simply | |
315 | ;; good VMS operating practice. Therefore, to edit FILE.TXT;3 (say 3 is | |
316 | ;; latest version), do C-x C-f /ymir.claremont.edu:FILE.TXT. If you | |
317 | ;; inadvertently do C-x C-f /ymir.claremont.edu:FILE.TXT;3, you will find | |
318 | ;; that VMS will not allow you to save the file because it will refuse to | |
319 | ;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and | |
320 | ;; attach the buffer to this file. To get out of this situation, M-x | |
321 | ;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to | |
322 | ;; latest version of the file. For this reason, in dired "f" | |
323 | ;; (dired-find-file), always loads the file sans version, whereas "v", | |
324 | ;; (dired-view-file), always loads the explicit version number. The | |
325 | ;; reasoning being that it reasonable to view old versions of a file, but | |
326 | ;; not to edit them. | |
327 | ;; 3. EMACS has a feature in which it does environment variable substitution | |
328 | ;; in filenames. Therefore, to enter a $ in a filename, you must quote it | |
329 | ;; by typing $$. | |
330 | ||
331 | ;; MTS support: | |
332 | ;; | |
333 | ;; Ange-ftp has full support for hosts running | |
334 | ;; the Michigan terminal system. It should be able to automatically | |
335 | ;; recognize any MTS machine. However, if it fails to do this, you can use | |
336 | ;; the command ange-ftp-add-mts-host. As well, you can set the variable | |
337 | ;; ange-ftp-mts-host-regexp in your .emacs file. We would be grateful if you | |
338 | ;; would report any failures to automatically recognize a MTS host as a bug. | |
339 | ;; | |
340 | ;; Filename syntax: | |
25759a92 | 341 | ;; |
8749abea GM |
342 | ;; MTS filenames are entered in a UNIX-y way. For example, if your account |
343 | ;; was YYYY, the file FILE in the account XXXX: on mtsg.ubc.ca would be | |
344 | ;; entered as | |
345 | ;; /YYYY@mtsg.ubc.ca:/XXXX:/FILE | |
346 | ;; In other words, MTS accounts are treated as UNIX directories. Of course, | |
347 | ;; to access a file in another account, you must have access permission for | |
348 | ;; it. If FILE were in your own account, then you could enter it in a | |
349 | ;; relative name fashion as | |
350 | ;; /YYYY@mtsg.ubc.ca:FILE | |
351 | ;; MTS filenames can be up to 12 characters. Like UNIX, the structure of the | |
352 | ;; filename does not contain a TYPE (i.e. it can have as many "."'s as you | |
353 | ;; like.) MTS filenames are always in upper case, and hence be sure to enter | |
354 | ;; them as such! MTS is not case sensitive, but an EMACS running under UNIX | |
355 | ;; is. | |
356 | ||
357 | ;; CMS support: | |
25759a92 | 358 | ;; |
8749abea GM |
359 | ;; Ange-ftp has full support for hosts running |
360 | ;; CMS. It should be able to automatically recognize any CMS machine. | |
361 | ;; However, if it fails to do this, you can use the command | |
362 | ;; ange-ftp-add-cms-host. As well, you can set the variable | |
363 | ;; ange-ftp-cms-host-regexp in your .emacs file. We would be grateful if you | |
364 | ;; would report any failures to automatically recognize a CMS host as a bug. | |
25759a92 | 365 | ;; |
8749abea GM |
366 | ;; Filename syntax: |
367 | ;; | |
368 | ;; CMS filenames are entered in a UNIX-y way. In otherwords, minidisks are | |
369 | ;; treated as UNIX directories. For example to access the file READ.ME in | |
370 | ;; minidisk *.311 on cuvmb.cc.columbia.edu, you would enter | |
371 | ;; /anonymous@cuvmb.cc.columbia.edu:/*.311/READ.ME | |
372 | ;; If *.301 is the default minidisk for this account, you could access | |
373 | ;; FOO.BAR on this minidisk as | |
374 | ;; /anonymous@cuvmb.cc.columbia.edu:FOO.BAR | |
375 | ;; CMS filenames are of the form FILE.TYPE, where both FILE and TYPE can be | |
376 | ;; up to 8 characters. Again, beware that CMS filenames are always upper | |
377 | ;; case, and hence must be entered as such. | |
378 | ;; | |
379 | ;; Tips: | |
380 | ;; 1. CMS machines, with the exception of anonymous accounts, nearly always | |
381 | ;; need an account password. To have ange-ftp send an account password, | |
382 | ;; you can either include it in your .netrc file, or use | |
383 | ;; ange-ftp-set-account. | |
384 | ;; 2. Ange-ftp cannot send "write passwords" for a minidisk. Hopefully, we | |
385 | ;; can fix this. | |
386 | ;; | |
9c35d706 RS |
387 | ;; BS2000 support: |
388 | ;; | |
389 | ;; Ange-ftp has full support for BS2000 hosts. It should be able to | |
390 | ;; automatically recognize any BS2000 machine. However, if it fails to | |
391 | ;; do this, you can use the command ange-ftp-add-bs2000-host. As well, | |
392 | ;; you can set the variable ange-ftp-bs2000-host-regexp in your .emacs | |
393 | ;; file. We would be grateful if you would report any failures to auto- | |
394 | ;; matically recognize a BS2000 host as a bug. | |
395 | ;; | |
396 | ;; If you want to access the POSIX subsystem on BS2000 you MUST use | |
397 | ;; command ange-ftp-add-bs2000-posix-host for that particular | |
398 | ;; hostname. ange-ftp can't decide if you want to access the native | |
399 | ;; filesystem or the POSIX filesystem, so it accesses the native | |
400 | ;; filesystem by default. And if you have an ASCII filesystem in | |
401 | ;; your BS2000 POSIX subsystem you must use | |
402 | ;; ange-ftp-binary-file-name-regexp to access its files. | |
403 | ;; | |
404 | ;; Filename Syntax: | |
405 | ;; | |
406 | ;; For ease of *implementation*, the user enters the BS2000 filename | |
407 | ;; syntax in a UNIX-y way. For example: | |
408 | ;; :PUB:$PUBLIC.ANONYMOUS.SDSCPUB.NEXT.README.TXT | |
409 | ;; would be entered as: | |
410 | ;; /:PUB:/$$PUBLIC/ANONYMOUS.SDSCPUB.NEXT.README.TXT | |
4671dba5 | 411 | ;; You don't have to type pubset and account, if they have default values, |
9c35d706 RS |
412 | ;; i.e. to log in as anonymous on bs2000.anywhere.com and grab the file |
413 | ;; IMPORTANT.TEXT.ON.BS2000 on the default pubset X on userid PUBLIC | |
414 | ;; (there are only 8 characters in a valid username), you could type: | |
415 | ;; C-x C-f /public@bs2000.anywhere.com:/IMPORTANT.TEXT.ON.BS2000 | |
416 | ;; or | |
417 | ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/$$PUBLIC/IMPORTANT.TEXT.ON.BS2000 | |
418 | ;; | |
419 | ;; If X is not your default pubset, you could add it as 'subdirectory' (BS2000 | |
420 | ;; has a flat architecture) with the command | |
421 | ;; (setq ange-ftp-bs2000-additional-pubsets '(":X:")) | |
422 | ;; and then you could type: | |
423 | ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/IMPORTANT.TEXT.ON.BS2000 | |
424 | ;; | |
425 | ;; Valid characters in an BS2000 filename are A-Z 0-9 $ # @ . - | |
426 | ;; If the first character in a filename is # or @, this is replaced with | |
427 | ;; ange-ftp-bs2000-special-prefix because names starting with # or @ | |
428 | ;; are reserved for temporary files. | |
429 | ;; This is especially important for auto-save files. | |
a1506d29 | 430 | ;; Valid file generations are ending with ([+|-|*]0-9...) . |
9c35d706 RS |
431 | ;; File generations are not supported yet! |
432 | ;; A filename must at least contain one character (A-Z) and cannot be longer | |
433 | ;; than 41 characters. | |
434 | ;; | |
435 | ;; Tips: | |
436 | ;; 1. Although BS2000 is not case sensitive, EMACS running under UNIX is. | |
437 | ;; Therefore, to access a BS2000 file, you must enter the filename with | |
438 | ;; upper case letters. | |
439 | ;; 2. EMACS has a feature in which it does environment variable substitution | |
440 | ;; in filenames. Therefore, to enter a $ in a filename, you must quote it | |
441 | ;; by typing $$. | |
442 | ;; 3. BS2000 machines, with the exception of anonymous accounts, nearly | |
443 | ;; always need an account password. To have ange-ftp send an account | |
444 | ;; password, you can either include it in your .netrc file, or use | |
445 | ;; ange-ftp-set-account. | |
446 | ;; | |
8749abea GM |
447 | ;; ------------------------------------------------------------------ |
448 | ;; Bugs: | |
449 | ;; ------------------------------------------------------------------ | |
25759a92 | 450 | ;; |
8749abea GM |
451 | ;; 1. Umask problems: |
452 | ;; Be warned that files created by using ange-ftp will take account of the | |
453 | ;; umask of the ftp daemon process rather than the umask of the creating | |
454 | ;; user. This is particularly important when logging in as the root user. | |
455 | ;; The way that I tighten up the ftp daemon's umask under HP-UX is to make | |
456 | ;; sure that the umask is changed to 027 before I spawn /etc/inetd. I | |
457 | ;; suspect that there is something similar on other systems. | |
458 | ;; | |
459 | ;; 2. Some combinations of FTP clients and servers break and get out of sync | |
460 | ;; when asked to list a non-existent directory. Some of the ai.mit.edu | |
461 | ;; machines cause this problem for some FTP clients. Using | |
462 | ;; ange-ftp-kill-ftp-process can restart the ftp process, which | |
463 | ;; should get things back in sync. | |
464 | ;; | |
465 | ;; 3. Ange-ftp does not check to make sure that when creating a new file, | |
466 | ;; you provide a valid filename for the remote operating system. | |
467 | ;; If you do not, then the remote FTP server will most likely | |
468 | ;; translate your filename in some way. This may cause ange-ftp to | |
469 | ;; get confused about what exactly is the name of the file. The | |
470 | ;; most common causes of this are using lower case filenames on systems | |
471 | ;; which support only upper case, and using filenames which are too | |
472 | ;; long. | |
473 | ;; | |
474 | ;; 4. Null (blank) passwords confuse both ange-ftp and some FTP daemons. | |
475 | ;; | |
476 | ;; 5. Ange-ftp likes to use pty's to talk to its FTP processes. If GNU Emacs | |
477 | ;; for some reason creates a FTP process that only talks via pipes then | |
478 | ;; ange-ftp won't be getting the information it requires at the time that | |
479 | ;; it wants it since pipes flush at different times to pty's. One | |
480 | ;; disgusting way around this problem is to talk to the FTP process via | |
481 | ;; rlogin which does the 'right' things with pty's. | |
482 | ;; | |
483 | ;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't | |
484 | ;; worried about this too much. Eventually, we should have some caching | |
485 | ;; of the current minidisk. | |
25759a92 | 486 | ;; |
8749abea GM |
487 | ;; 7. Some CMS machines do not assign a default minidisk when you ftp them as |
488 | ;; anonymous. It is then necessary to guess a valid minidisk name, and cd | |
489 | ;; to it. This is (understandably) beyond ange-ftp. | |
490 | ;; | |
491 | ;; 8. Remote to remote copying of files on non-Unix machines can be risky. | |
492 | ;; Depending on the variable ange-ftp-binary-file-name-regexp, ange-ftp | |
493 | ;; will use binary mode for the copy. Between systems of different | |
494 | ;; architecture, this still may not be enough to guarantee the integrity | |
495 | ;; of binary files. Binary file transfers from VMS machines are | |
496 | ;; particularly problematical. Should ange-ftp-binary-file-name-regexp be | |
497 | ;; an alist of OS type, regexp pairs? | |
498 | ;; | |
499 | ;; 9. The code to do compression of files over ftp is not as careful as it | |
500 | ;; should be. It deletes the old remote version of the file, before | |
501 | ;; actually checking if the local to remote transfer of the compressed | |
502 | ;; file succeeds. Of course to delete the original version of the file | |
503 | ;; after transferring the compressed version back is also dangerous, | |
504 | ;; because some OS's have severe restrictions on the length of filenames, | |
505 | ;; and when the compressed version is copied back the "-Z" or ".Z" may be | |
506 | ;; truncated. Then, ange-ftp would delete the only remaining version of | |
507 | ;; the file. Maybe ange-ftp should make backups when it compresses files | |
508 | ;; (of course, the backup "~" could also be truncated off, sigh...). | |
509 | ;; Suggestions? | |
510 | ;; | |
511 | ;; 10. If a dir listing is attempted for an empty directory on (at least | |
512 | ;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and | |
513 | ;; I don't know how to get ange-ftp work to around it. | |
514 | ;; | |
515 | ;; 11. Bombs on filenames that start with a space. Deals well with filenames | |
516 | ;; containing spaces, but beware that the remote ftpd may not like them | |
517 | ;; much. | |
518 | ;; | |
519 | ;; 12. The dired support for non-Unix-like systems does not currently work. | |
520 | ;; It needs to be reimplemented by modifying the parse-...-listing | |
521 | ;; functions to convert the directory listing to ls -l format. | |
25759a92 | 522 | ;; |
8749abea GM |
523 | ;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks |
524 | ;; with a trailing @ in a ls -alF listing. In order to account for this | |
525 | ;; ange-ftp looks to chop trailing @'s off of symlink names when it is | |
526 | ;; parsing a listing with the F switch. This will cause ange-ftp to | |
527 | ;; incorrectly get the name of a symlink on a non-ULTRIX host if its name | |
528 | ;; ends in an @. ange-ftp will correct itself if you take F out of the | |
529 | ;; dired ls switches (C-u s will allow you to edit the switches). The | |
530 | ;; dired buffer will be automatically reverted, which will allow ange-ftp | |
531 | ;; to fix its files hashtable. A cookie to anyone who can think of a | |
532 | ;; fast, sure-fire way to recognize ULTRIX over ftp. | |
533 | ||
534 | ;; If you find any bugs or problems with this package, PLEASE either e-mail | |
535 | ;; the above author, or send a message to the ange-ftp-lovers mailing list | |
536 | ;; below. Ideas and constructive comments are especially welcome. | |
537 | ||
538 | ;; ange-ftp-lovers: | |
539 | ;; | |
540 | ;; ange-ftp has its own mailing list modestly called ange-ftp-lovers. All | |
541 | ;; users of ange-ftp are welcome to subscribe (see below) and to discuss | |
542 | ;; aspects of ange-ftp. New versions of ange-ftp are posted periodically to | |
543 | ;; the mailing list. | |
544 | ||
8749abea GM |
545 | ;; To [un]subscribe to ange-ftp-lovers, or to report mailer problems with the |
546 | ;; list, please mail one of the following addresses: | |
547 | ;; | |
0101f7e1 | 548 | ;; ange-ftp-lovers-request@hplb.hpl.hp.com |
8749abea GM |
549 | ;; |
550 | ;; Please don't forget the -request part. | |
551 | ;; | |
552 | ;; For mail to be posted directly to ange-ftp-lovers, send to one of the | |
553 | ;; following addresses: | |
25759a92 | 554 | ;; |
0101f7e1 | 555 | ;; ange-ftp-lovers@hplb.hpl.hp.com |
8749abea GM |
556 | ;; |
557 | ;; Alternatively, there is a mailing list that only gets announcements of new | |
558 | ;; ange-ftp releases. This is called ange-ftp-lovers-announce, and can be | |
559 | ;; subscribed to by e-mailing to the -request address as above. Please make | |
560 | ;; it clear in the request which mailing list you wish to join. | |
8749abea GM |
561 | \f |
562 | ;; ----------------------------------------------------------- | |
563 | ;; Technical information on this package: | |
564 | ;; ----------------------------------------------------------- | |
565 | ||
566 | ;; ange-ftp works by putting a handler on file-name-handler-alist | |
567 | ;; which is called by many primitives, and a few non-primitives, | |
568 | ;; whenever they see a file name of the appropriate sort. | |
569 | ||
570 | ;; Checklist for adding non-UNIX support for TYPE | |
25759a92 | 571 | ;; |
8749abea GM |
572 | ;; The following functions may need TYPE versions: |
573 | ;; (not all functions will be needed for every OS) | |
574 | ;; | |
575 | ;; ange-ftp-fix-name-for-TYPE | |
576 | ;; ange-ftp-fix-dir-name-for-TYPE | |
577 | ;; ange-ftp-TYPE-host | |
578 | ;; ange-ftp-TYPE-add-host | |
579 | ;; ange-ftp-parse-TYPE-listing | |
580 | ;; ange-ftp-TYPE-delete-file-entry | |
581 | ;; ange-ftp-TYPE-add-file-entry | |
582 | ;; ange-ftp-TYPE-file-name-as-directory | |
583 | ;; ange-ftp-TYPE-make-compressed-filename | |
584 | ;; ange-ftp-TYPE-file-name-sans-versions | |
585 | ;; | |
586 | ;; Variables: | |
587 | ;; | |
588 | ;; ange-ftp-TYPE-host-regexp | |
589 | ;; May need to add TYPE to ange-ftp-dumb-host-types | |
590 | ;; | |
591 | ;; Check the following functions for OS dependent coding: | |
592 | ;; | |
593 | ;; ange-ftp-host-type | |
594 | ;; ange-ftp-guess-host-type | |
595 | ;; ange-ftp-allow-child-lookup | |
596 | ||
597 | ;; Host type conventions: | |
598 | ;; | |
599 | ;; The function ange-ftp-host-type and the variable ange-ftp-dired-host-type | |
600 | ;; (mostly) follow the following conventions for remote host types. At | |
601 | ;; least, I think that future code should try to follow these conventions, | |
602 | ;; and the current code should eventually be made compliant. | |
603 | ;; | |
604 | ;; nil = local host type, whatever that is (probably unix). | |
605 | ;; Think nil as in "not a remote host". This value is used by | |
606 | ;; ange-ftp-dired-host-type for local buffers. | |
607 | ;; | |
608 | ;; t = a remote host of unknown type. Think t as in true, it's remote. | |
609 | ;; Currently, `unix' is used as the default remote host type. | |
610 | ;; Maybe we should use t. | |
611 | ;; | |
612 | ;; TYPE = a remote host of TYPE type. | |
613 | ;; | |
614 | ;; TYPE:LIST = a remote host of TYPE type, using a specialized ftp listing | |
615 | ;; program called list. This is currently only used for Unix | |
616 | ;; dl (descriptive listings), when ange-ftp-dired-host-type | |
617 | ;; is set to `unix:dl'. | |
618 | ||
619 | ;; Bug report codes: | |
620 | ;; | |
621 | ;; Because of their naive faith in this code, there are certain situations | |
622 | ;; which the writers of this program believe could never happen. However, | |
623 | ;; being realists they have put calls to `error' in the program at these | |
624 | ;; points. These errors provide a code, which is an integer, greater than 1. | |
625 | ;; To aid debugging. the error codes, and the functions in which they reside | |
626 | ;; are listed below. | |
25759a92 | 627 | ;; |
8749abea GM |
628 | ;; 1: See ange-ftp-ls |
629 | ;; | |
630 | \f | |
631 | ;; ----------------------------------------------------------- | |
632 | ;; Hall of fame: | |
633 | ;; ----------------------------------------------------------- | |
25759a92 | 634 | ;; |
8749abea GM |
635 | ;; Thanks to Roland McGrath for improving the filename syntax handling, |
636 | ;; for suggesting many enhancements and for numerous cleanups to the code. | |
637 | ;; | |
638 | ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways. | |
639 | ;; | |
640 | ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and | |
641 | ;; dired / shell auto-loading. | |
642 | ;; | |
643 | ;; Thanks to Sebastian Kremer for dired support and for many ideas and | |
644 | ;; bugfixes. | |
645 | ;; | |
646 | ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support, | |
647 | ;; VOS support, and hostname completion. | |
648 | ;; | |
649 | ;; Thanks to Nakagawa Takayuki for many good ideas, filename-completion, help | |
650 | ;; with file-name expansion, efficiency worries, stylistic concerns and many | |
651 | ;; bugfixes. | |
652 | ;; | |
653 | ;; Thanks to Sandy Rutherford who re-wrote most of ange-ftp to support VMS, | |
654 | ;; MTS, CMS and UNIX-dls. Sandy also added dired-support for non-UNIX OS and | |
655 | ;; auto-recognition of the host type. | |
656 | ;; | |
657 | ;; Thanks to Dave Smith who wrote the info file for ange-ftp. | |
658 | ;; | |
659 | ;; Finally, thanks to Keith Waclena, Mark D. Baushke, Terence Kelleher, Ping | |
660 | ;; Zhou, Edward Vielmetti, Jack Repenning, Mike Balenger, Todd Kaufmann, | |
661 | ;; Kjetil Svarstad, Tom Wurgler, Linus Tolke, Niko Makila, Carl Edman, Bill | |
662 | ;; Trost, Dave Brennan, Dan Jacobson, Andy Scott, Steve Anderson, Sanjay | |
663 | ;; Mathur, the folks on the ange-ftp-lovers mailing list and many others | |
664 | ;; whose names I've forgotten who have helped to debug and fix problems with | |
665 | ;; ange-ftp.el. | |
666 | \f | |
667 | ;;; Code: | |
668 | ||
669 | (require 'comint) | |
8749abea GM |
670 | |
671 | ;;;; ------------------------------------------------------------ | |
672 | ;;;; User customization variables. | |
673 | ;;;; ------------------------------------------------------------ | |
674 | ||
675 | (defgroup ange-ftp nil | |
25759a92 | 676 | "Accessing remote files and directories using FTP |
8749abea GM |
677 | made as simple and transparent as possible." |
678 | :group 'files | |
26f4b8ab | 679 | :group 'comm |
8749abea GM |
680 | :prefix "ange-ftp-") |
681 | ||
682 | (defcustom ange-ftp-name-format | |
aa6f7b96 | 683 | '("\\`/\\(\\([^/:]*\\)@\\)?\\([^@/:]*[^@/:.]\\):\\(.*\\)" . (3 2 4)) |
4671dba5 | 684 | "Format of a fully expanded remote file name. |
8749abea GM |
685 | |
686 | This is a list of the form \(REGEXP HOST USER NAME\), | |
687 | where REGEXP is a regular expression matching | |
688 | the full remote name, and HOST, USER, and NAME are the numbers of | |
689 | parenthesized expressions in REGEXP for the components (in that order)." | |
690 | :group 'ange-ftp | |
ecd5fe1f | 691 | :type '(list (regexp :tag "Name regexp") |
8749abea GM |
692 | (integer :tag "Host group") |
693 | (integer :tag "User group") | |
694 | (integer :tag "Name group"))) | |
695 | ||
696 | ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of | |
697 | ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs. | |
698 | ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out. | |
699 | ||
700 | (defvar ange-ftp-multi-msgs | |
72e0a95b | 701 | "^150-\\|^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-" |
4671dba5 | 702 | "*Regular expression matching the start of a multiline FTP reply.") |
8749abea GM |
703 | |
704 | (defvar ange-ftp-good-msgs | |
705 | "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark" | |
4671dba5 | 706 | "*Regular expression matching FTP \"success\" messages.") |
8749abea GM |
707 | |
708 | ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT. | |
709 | ;; Also CMS machines use a multiline 550- reply to say that you | |
710 | ;; don't have write permission. ange-ftp gets into multi-line skip | |
711 | ;; mode and hangs. Have it ignore 550- instead. It will then barf | |
712 | ;; when it gets the 550 line, as it should. | |
713 | ||
a8a3541c GM |
714 | ;; RFC2228 "FTP Security Extensions" defines extensions to the FTP |
715 | ;; protocol which involve the client requesting particular | |
716 | ;; authentication methods (typically) at connection establishment. Non | |
717 | ;; security-aware FTP servers should respond to this with a 500 code, | |
718 | ;; which we ignore. | |
8749abea GM |
719 | (defcustom ange-ftp-skip-msgs |
720 | (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|" | |
721 | "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|" | |
722 | "^Data connection \\|" | |
723 | "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye\\|" | |
c35fcd52 | 724 | "^500 .*AUTH\\|^KERBEROS\\|" |
6309b0e1 | 725 | "^530 Please login with USER and PASS\\|" ; non kerberised vsFTPd |
8204704e | 726 | "^534 Kerberos Authentication not enabled\\|" |
7d685c84 | 727 | "^22[789] .*[Pp]assive\\|^200 EPRT\\|^500 .*EPRT") |
4671dba5 | 728 | "Regular expression matching FTP messages that can be ignored." |
8749abea GM |
729 | :group 'ange-ftp |
730 | :type 'regexp) | |
731 | ||
732 | (defcustom ange-ftp-fatal-msgs | |
733 | (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|" | |
734 | "^No control connection\\|unknown host\\|^lost connection") | |
4671dba5 | 735 | "Regular expression matching FTP messages that indicate serious errors. |
8749abea | 736 | |
4671dba5 | 737 | These mean that the FTP process should be (or already has been) killed." |
8749abea GM |
738 | :group 'ange-ftp |
739 | :type 'regexp) | |
740 | ||
92482d77 SM |
741 | (defcustom ange-ftp-potential-error-msgs |
742 | ;; On Mac OS X we sometimes get things like: | |
5fd6d89f | 743 | ;; |
92482d77 SM |
744 | ;; ftp> open ftp.nluug.nl |
745 | ;; Trying 2001:610:1:80aa:192:87:102:36... | |
746 | ;; ftp: connect to address 2001:610:1:80aa:192:87:102:36: No route to host | |
747 | ;; Trying 192.87.102.36... | |
748 | ;; Connected to ftp.nluug.nl. | |
749 | "^ftp: connect to address .*: No route to host" | |
4671dba5 | 750 | "Regular expression matching FTP messages that can indicate serious errors. |
92482d77 SM |
751 | These mean that something went wrong, but they may be followed by more |
752 | messages indicating that the error was somehow corrected." | |
753 | :group 'ange-ftp | |
754 | :type 'regexp) | |
755 | ||
8749abea GM |
756 | (defcustom ange-ftp-gateway-fatal-msgs |
757 | "No route to host\\|Connection closed\\|No such host\\|Login incorrect" | |
4671dba5 | 758 | "Regular expression matching login failure messages from rlogin/telnet." |
8749abea GM |
759 | :group 'ange-ftp |
760 | :type 'regexp) | |
761 | ||
762 | (defcustom ange-ftp-xfer-size-msgs | |
763 | "^150 .* connection for .* (\\([0-9]+\\) bytes)" | |
4671dba5 | 764 | "Regular expression used to determine the number of bytes in a FTP transfer." |
8749abea GM |
765 | :group 'ange-ftp |
766 | :type 'regexp) | |
767 | ||
25759a92 | 768 | (defcustom ange-ftp-tmp-name-template |
8749abea | 769 | (expand-file-name "ange-ftp" temporary-file-directory) |
4671dba5 | 770 | "Template used to create temporary files." |
8749abea GM |
771 | :group 'ange-ftp |
772 | :type 'directory) | |
773 | ||
774 | (defcustom ange-ftp-gateway-tmp-name-template "/tmp/ange-ftp" | |
4671dba5 | 775 | "Template used to create temporary files when FTP-ing through a gateway. |
8749abea GM |
776 | |
777 | Files starting with this prefix need to be accessible from BOTH the local | |
778 | machine and the gateway machine, and need to have the SAME name on both | |
779 | machines, that is, /tmp is probably NOT what you want, since that is rarely | |
780 | cross-mounted." | |
781 | :group 'ange-ftp | |
782 | :type 'directory) | |
783 | ||
784 | (defcustom ange-ftp-netrc-filename "~/.netrc" | |
4671dba5 | 785 | "File in .netrc format to search for passwords." |
8749abea GM |
786 | :group 'ange-ftp |
787 | :type 'file) | |
788 | ||
789 | (defcustom ange-ftp-disable-netrc-security-check (eq system-type 'windows-nt) | |
4671dba5 | 790 | "If non-nil avoid checking permissions on the .netrc file." |
8749abea GM |
791 | :group 'ange-ftp |
792 | :type 'boolean) | |
793 | ||
794 | (defcustom ange-ftp-default-user nil | |
4671dba5 | 795 | "User name to use when none is specified in a file name. |
8749abea GM |
796 | |
797 | If non-nil but not a string, you are prompted for the name. | |
798 | If nil, the value of `ange-ftp-netrc-default-user' is used. | |
799 | If that is nil too, then your login name is used. | |
800 | ||
801 | Once a connection to a given host has been initiated, the user name | |
802 | and password information for that host are cached and re-used by | |
803 | ange-ftp. Use \\[ange-ftp-set-user] to change the cached values, | |
804 | since setting `ange-ftp-default-user' directly does not affect | |
805 | the cached information." | |
806 | :group 'ange-ftp | |
807 | :type '(choice (const :tag "Default" nil) | |
808 | string | |
809 | (other :tag "Prompt" t))) | |
810 | ||
811 | (defcustom ange-ftp-netrc-default-user nil | |
812 | "Alternate default user name to use when none is specified. | |
813 | ||
814 | This variable is set from the `default' command in your `.netrc' file, | |
815 | if there is one." | |
816 | :group 'ange-ftp | |
817 | :type '(choice (const :tag "Default" nil) | |
818 | string)) | |
819 | ||
820 | (defcustom ange-ftp-default-password nil | |
4671dba5 | 821 | "Password to use when the user name equals `ange-ftp-default-user'." |
8749abea GM |
822 | :group 'ange-ftp |
823 | :type '(choice (const :tag "Default" nil) | |
824 | string)) | |
825 | ||
826 | (defcustom ange-ftp-default-account nil | |
4671dba5 | 827 | "Account to use when the user name equals `ange-ftp-default-user'." |
8749abea GM |
828 | :group 'ange-ftp |
829 | :type '(choice (const :tag "Default" nil) | |
830 | string)) | |
831 | ||
832 | (defcustom ange-ftp-netrc-default-password nil | |
4671dba5 | 833 | "Password to use when the user name equals `ange-ftp-netrc-default-user'." |
8749abea GM |
834 | :group 'ange-ftp |
835 | :type '(choice (const :tag "Default" nil) | |
836 | string)) | |
837 | ||
838 | (defcustom ange-ftp-netrc-default-account nil | |
4671dba5 | 839 | "Account to use when the user name equals `ange-ftp-netrc-default-user'." |
8749abea GM |
840 | :group 'ange-ftp |
841 | :type '(choice (const :tag "Default" nil) | |
842 | string)) | |
843 | ||
844 | (defcustom ange-ftp-generate-anonymous-password t | |
4671dba5 | 845 | "If t, use value of `user-mail-address' as password for anonymous FTP. |
8749abea GM |
846 | |
847 | If a string, then use that string as the password. | |
848 | If nil, prompt the user for a password." | |
849 | :group 'ange-ftp | |
850 | :type '(choice (const :tag "Prompt" nil) | |
851 | string | |
852 | (other :tag "User address" t))) | |
853 | ||
854 | (defcustom ange-ftp-dumb-unix-host-regexp nil | |
4671dba5 | 855 | "If non-nil, regexp matching hosts on which `dir' command lists directory." |
8749abea GM |
856 | :group 'ange-ftp |
857 | :type '(choice (const :tag "Default" nil) | |
858 | string)) | |
859 | ||
860 | (defcustom ange-ftp-binary-file-name-regexp | |
aa6f7b96 SM |
861 | (concat "TAGS\\'\\|\\.\\(?:" |
862 | (eval-when-compile | |
863 | (regexp-opt '("z" "Z" "lzh" "arc" "zip" "zoo" "tar" "dvi" | |
864 | "ps" "elc" "gif" "gz" "taz" "tgz"))) | |
865 | "\\|EXE\\(;[0-9]+\\)?\\|[zZ]-part-..\\)\\'") | |
4671dba5 | 866 | "If a file matches this regexp then it is transferred in binary mode." |
8749abea GM |
867 | :group 'ange-ftp |
868 | :type 'regexp) | |
869 | ||
870 | (defcustom ange-ftp-gateway-host nil | |
4671dba5 | 871 | "Name of host to use as gateway machine when local FTP isn't possible." |
8749abea GM |
872 | :group 'ange-ftp |
873 | :type '(choice (const :tag "Default" nil) | |
874 | string)) | |
875 | ||
876 | (defcustom ange-ftp-local-host-regexp ".*" | |
4671dba5 | 877 | "Regexp selecting hosts which can be reached directly with FTP. |
8749abea | 878 | |
4671dba5 JB |
879 | For other hosts the FTP process is started on `ange-ftp-gateway-host' |
880 | instead, and/or reached via `ange-ftp-gateway-ftp-program-name'." | |
8749abea GM |
881 | :group 'ange-ftp |
882 | :type 'regexp) | |
883 | ||
884 | (defcustom ange-ftp-gateway-program-interactive nil | |
4671dba5 | 885 | "If non-nil then the gateway program should give a shell prompt. |
8749abea GM |
886 | |
887 | Both telnet and rlogin do something like this." | |
888 | :group 'ange-ftp | |
889 | :type 'boolean) | |
890 | ||
891 | (defcustom ange-ftp-gateway-program remote-shell-program | |
4671dba5 | 892 | "Name of program to spawn a shell on the gateway machine. |
8749abea | 893 | |
4671dba5 JB |
894 | Valid candidates are rsh (remsh on some systems), telnet and rlogin. |
895 | See also the gateway variable above." | |
8749abea GM |
896 | :group 'ange-ftp |
897 | :type '(choice (const "rsh") | |
898 | (const "telnet") | |
899 | (const "rlogin") | |
900 | string)) | |
901 | ||
902 | (defcustom ange-ftp-gateway-prompt-pattern "^[^#$%>;\n]*[#$%>;] *" | |
4671dba5 | 903 | "Regexp matching prompt after complete login sequence on gateway machine. |
8749abea GM |
904 | |
905 | A match for this means the shell is now awaiting input. Make this regexp as | |
906 | strict as possible; it shouldn't match *anything* at all except the user's | |
907 | initial prompt. The above string will fail under most SUN-3's since it | |
908 | matches the login banner." | |
909 | :group 'ange-ftp | |
910 | :type 'regexp) | |
911 | ||
912 | (defvar ange-ftp-gateway-setup-term-command | |
913 | (if (eq system-type 'hpux) | |
914 | "stty -onlcr -echo\n" | |
915 | "stty -echo nl\n") | |
916 | "*Set up terminal after logging in to the gateway machine. | |
917 | This command should stop the terminal from echoing each command, and | |
918 | arrange to strip out trailing ^M characters.") | |
919 | ||
920 | (defcustom ange-ftp-smart-gateway nil | |
4671dba5 | 921 | "Non-nil says the FTP gateway (proxy) or gateway FTP program is smart. |
8749abea GM |
922 | |
923 | Don't bother telnetting, etc., already connected to desired host transparently, | |
4671dba5 | 924 | or just issue a user@host command in case `ange-ftp-gateway-host' is non-nil. |
0101f7e1 | 925 | See also `ange-ftp-smart-gateway-port'." |
8749abea GM |
926 | :group 'ange-ftp |
927 | :type 'boolean) | |
928 | ||
929 | (defcustom ange-ftp-smart-gateway-port "21" | |
4671dba5 | 930 | "Port on gateway machine to use when smart gateway is in operation." |
8749abea GM |
931 | :group 'ange-ftp |
932 | :type 'string) | |
933 | ||
934 | (defcustom ange-ftp-send-hash t | |
4671dba5 | 935 | "If non-nil, send the HASH command to the FTP client." |
8749abea GM |
936 | :group 'ange-ftp |
937 | :type 'boolean) | |
938 | ||
939 | (defcustom ange-ftp-binary-hash-mark-size nil | |
4671dba5 | 940 | "Default size, in bytes, between hash-marks when transferring a binary file. |
8749abea GM |
941 | If nil, this variable will be locally overridden if the FTP client outputs a |
942 | suitable response to the HASH command. If non-nil, this value takes | |
943 | precedence over the local value." | |
944 | :group 'ange-ftp | |
945 | :type '(choice (const :tag "Overridden" nil) | |
946 | integer)) | |
947 | ||
948 | (defcustom ange-ftp-ascii-hash-mark-size 1024 | |
4671dba5 | 949 | "Default size, in bytes, between hash-marks when transferring an ASCII file. |
8749abea GM |
950 | This variable is buffer-local and will be locally overridden if the FTP client |
951 | outputs a suitable response to the HASH command." | |
952 | :group 'ange-ftp | |
953 | :type 'integer) | |
954 | ||
955 | (defcustom ange-ftp-process-verbose t | |
4671dba5 | 956 | "If non-nil then be chatty about interaction with the FTP process." |
8749abea GM |
957 | :group 'ange-ftp |
958 | :type 'boolean) | |
959 | ||
960 | (defcustom ange-ftp-ftp-program-name "ftp" | |
4671dba5 | 961 | "Name of FTP program to run." |
8749abea GM |
962 | :group 'ange-ftp |
963 | :type 'string) | |
964 | ||
965 | (defcustom ange-ftp-gateway-ftp-program-name "ftp" | |
4671dba5 | 966 | "Name of FTP program to run when accessing non-local hosts. |
8749abea GM |
967 | |
968 | Some AT&T folks claim to use something called `pftp' here." | |
969 | :group 'ange-ftp | |
970 | :type 'string) | |
971 | ||
972 | (defcustom ange-ftp-ftp-program-args '("-i" "-n" "-g" "-v") | |
4671dba5 | 973 | "A list of arguments passed to the FTP program when started." |
8749abea GM |
974 | :group 'ange-ftp |
975 | :type '(repeat string)) | |
976 | ||
977 | (defcustom ange-ftp-nslookup-program nil | |
4671dba5 | 978 | "If non-nil, this is a string naming the nslookup program." |
8749abea GM |
979 | :group 'ange-ftp |
980 | :type '(choice (const :tag "None" nil) | |
981 | string)) | |
982 | ||
983 | (defcustom ange-ftp-make-backup-files () | |
4671dba5 | 984 | "Non-nil means make backup files for \"magic\" remote files." |
8749abea GM |
985 | :group 'ange-ftp |
986 | :type 'boolean) | |
987 | ||
988 | (defcustom ange-ftp-retry-time 5 | |
4671dba5 | 989 | "Number of seconds to wait before retry if file or listing doesn't arrive. |
8749abea GM |
990 | This might need to be increased for very slow connections." |
991 | :group 'ange-ftp | |
992 | :type 'integer) | |
993 | ||
994 | (defcustom ange-ftp-auto-save 0 | |
995 | "If 1, allow ange-ftp files to be auto-saved. | |
996 | If 0, inhibit auto-saving of ange-ftp files. | |
997 | Don't use any other value." | |
998 | :group 'ange-ftp | |
999 | :type '(choice (const :tag "Suppress" 0) | |
1000 | (const :tag "Allow" 1))) | |
1001 | ||
1002 | (defcustom ange-ftp-try-passive-mode nil | |
4671dba5 | 1003 | "If t, try to use passive mode in FTP, if the client program supports it." |
8749abea GM |
1004 | :group 'ange-ftp |
1005 | :type 'boolean | |
84778d91 | 1006 | :version "21.1") |
8749abea | 1007 | |
1d0653f8 RS |
1008 | (defcustom ange-ftp-passive-host-alist nil |
1009 | "Alist of FTP servers that need \"passive\" mode. | |
1010 | Each element is of the form (HOSTNAME . SETTING). | |
1011 | HOSTNAME is a regular expression to match the FTP server host name(s). | |
1012 | SETTING is \"on\" to turn passive mode on, \"off\" to turn it off, | |
1013 | or nil meaning don't change it." | |
1014 | :group 'ange-ftp | |
33ceea4f RS |
1015 | :type '(repeat (cons regexp (choice (const :tag "On" "on") |
1016 | (const :tag "Off" "off") | |
1017 | (const :tag "Don't change" nil)))) | |
bf247b6e | 1018 | :version "22.1") |
8749abea GM |
1019 | \f |
1020 | ;;;; ------------------------------------------------------------ | |
1021 | ;;;; Hash table support. | |
1022 | ;;;; ------------------------------------------------------------ | |
1023 | ||
1024 | (require 'backquote) | |
1025 | ||
8749abea | 1026 | (defun ange-ftp-hash-entry-exists-p (key tbl) |
4671dba5 | 1027 | "Return whether there is an association for KEY in table TBL." |
311f32fe | 1028 | (and tbl (not (eq (gethash key tbl 'unknown) 'unknown)))) |
8749abea GM |
1029 | |
1030 | (defun ange-ftp-hash-table-keys (tbl) | |
4671dba5 | 1031 | "Return a sorted list of all the active keys in table TBL, as strings." |
6e85ef5f SM |
1032 | ;; (let ((keys nil)) |
1033 | ;; (maphash (lambda (k v) (push k keys)) tbl) | |
1034 | ;; (sort keys 'string-lessp)) | |
1035 | (sort (all-completions "" tbl) 'string-lessp)) | |
8749abea GM |
1036 | \f |
1037 | ;;;; ------------------------------------------------------------ | |
1038 | ;;;; Internal variables. | |
1039 | ;;;; ------------------------------------------------------------ | |
1040 | ||
1041 | (defvar ange-ftp-data-buffer-name " *ftp data*" | |
4671dba5 | 1042 | "Buffer name to hold directory listing data received from FTP process.") |
8749abea GM |
1043 | |
1044 | (defvar ange-ftp-netrc-modtime nil | |
1045 | "Last modified time of the netrc file from file-attributes.") | |
1046 | ||
6e85ef5f | 1047 | (defvar ange-ftp-user-hashtable (make-hash-table :test 'equal) |
8749abea GM |
1048 | "Hash table holding associations between HOST, USER pairs.") |
1049 | ||
6e85ef5f | 1050 | (defvar ange-ftp-passwd-hashtable (make-hash-table :test 'equal) |
8749abea GM |
1051 | "Mapping between a HOST, USER pair and a PASSWORD for them. |
1052 | All HOST values should be in lower case.") | |
1053 | ||
6e85ef5f | 1054 | (defvar ange-ftp-account-hashtable (make-hash-table :test 'equal) |
4671dba5 | 1055 | "Mapping between a HOST, USER pair and an ACCOUNT password for them.") |
8749abea | 1056 | |
6e85ef5f | 1057 | (defvar ange-ftp-files-hashtable (make-hash-table :test 'equal :size 97) |
8749abea GM |
1058 | "Hash table for storing directories and their respective files.") |
1059 | ||
6e85ef5f | 1060 | (defvar ange-ftp-inodes-hashtable (make-hash-table :test 'equal :size 97) |
8749abea GM |
1061 | "Hash table for storing file names and their \"inode numbers\".") |
1062 | ||
1063 | (defvar ange-ftp-next-inode-number 1 | |
1064 | "Next \"inode number\" value. We give each file name a unique number.") | |
1065 | ||
1066 | (defvar ange-ftp-ls-cache-lsargs nil | |
4671dba5 | 1067 | "Last set of args used by `ange-ftp-ls'.") |
8749abea GM |
1068 | |
1069 | (defvar ange-ftp-ls-cache-file nil | |
4671dba5 | 1070 | "Last file passed to `ange-ftp-ls'.") |
8749abea GM |
1071 | |
1072 | (defvar ange-ftp-ls-cache-res nil | |
4671dba5 | 1073 | "Last result returned from `ange-ftp-ls'.") |
8749abea | 1074 | |
6e85ef5f | 1075 | (defconst ange-ftp-expand-dir-hashtable (make-hash-table :test 'equal)) |
8749abea GM |
1076 | |
1077 | (defconst ange-ftp-expand-dir-regexp "^5.0 \\([^: ]+\\):") | |
1078 | ||
1079 | ;; These are local variables in each FTP process buffer. | |
1080 | (defvar ange-ftp-hash-mark-unit nil) | |
1081 | (defvar ange-ftp-hash-mark-count nil) | |
1082 | (defvar ange-ftp-xfer-size nil) | |
1083 | (defvar ange-ftp-process-string nil) | |
1084 | (defvar ange-ftp-process-result-line nil) | |
92482d77 | 1085 | (defvar ange-ftp-pending-error-line nil) |
8749abea GM |
1086 | (defvar ange-ftp-process-busy nil) |
1087 | (defvar ange-ftp-process-result nil) | |
1088 | (defvar ange-ftp-process-multi-skip nil) | |
1089 | (defvar ange-ftp-process-msg nil) | |
1090 | (defvar ange-ftp-process-continue nil) | |
1091 | (defvar ange-ftp-last-percent nil) | |
1092 | ||
1093 | ;; These variables are bound by one function and examined by another. | |
1094 | ;; Leave them void globally for error checking. | |
1095 | (defvar ange-ftp-this-file) | |
1096 | (defvar ange-ftp-this-dir) | |
1097 | (defvar ange-ftp-this-user) | |
1098 | (defvar ange-ftp-this-host) | |
1099 | (defvar ange-ftp-this-msg) | |
1100 | (defvar ange-ftp-completion-ignored-pattern) | |
1101 | (defvar ange-ftp-trample-marker) | |
1102 | \f | |
1103 | ;; New error symbols. | |
1104 | (put 'ftp-error 'error-conditions '(ftp-error file-error error)) | |
1105 | ;; (put 'ftp-error 'error-message "FTP error") | |
1106 | \f | |
1107 | ;;; ------------------------------------------------------------ | |
1108 | ;;; Enhanced message support. | |
1109 | ;;; ------------------------------------------------------------ | |
1110 | ||
1111 | (defun ange-ftp-message (fmt &rest args) | |
1112 | "Display message in echo area, but indicate if truncated. | |
1113 | Args are as in `message': a format string, plus arguments to be formatted." | |
6e85ef5f | 1114 | (let ((msg (apply 'format fmt args)) |
8749abea GM |
1115 | (max (window-width (minibuffer-window)))) |
1116 | (if noninteractive | |
1117 | msg | |
1118 | (if (>= (length msg) max) | |
1119 | ;; Take just the last MAX - 3 chars of the string. | |
1120 | (setq msg (concat "> " (substring msg (- 3 max))))) | |
1121 | (message "%s" msg)))) | |
1122 | ||
1123 | (defun ange-ftp-abbreviate-filename (file &optional new) | |
25759a92 | 1124 | "Abbreviate the file name FILE relative to the `default-directory'. |
8749abea GM |
1125 | If the optional parameter NEW is given and the non-directory parts match, |
1126 | only return the directory part of FILE." | |
1127 | (save-match-data | |
1128 | (if (and default-directory | |
aa6f7b96 | 1129 | (string-match (concat "\\`" |
8749abea GM |
1130 | (regexp-quote default-directory) |
1131 | ".") file)) | |
1132 | (setq file (substring file (1- (match-end 0))))) | |
1133 | (if (and new | |
1134 | (string-equal (file-name-nondirectory file) | |
1135 | (file-name-nondirectory new))) | |
1136 | (setq file (file-name-directory file))) | |
1137 | (or file "./"))) | |
1138 | \f | |
1139 | ;;;; ------------------------------------------------------------ | |
1140 | ;;;; User / Host mapping support. | |
1141 | ;;;; ------------------------------------------------------------ | |
1142 | ||
1143 | (defun ange-ftp-set-user (host user) | |
1144 | "For a given HOST, set or change the default USER." | |
1145 | (interactive "sHost: \nsUser: ") | |
6e85ef5f | 1146 | (puthash host user ange-ftp-user-hashtable)) |
8749abea GM |
1147 | |
1148 | (defun ange-ftp-get-user (host) | |
4671dba5 | 1149 | "Given a HOST, return the default user." |
8749abea | 1150 | (ange-ftp-parse-netrc) |
6e85ef5f | 1151 | (let ((user (gethash host ange-ftp-user-hashtable))) |
8749abea GM |
1152 | (or user |
1153 | (prog1 | |
1154 | (setq user | |
1155 | (cond ((stringp ange-ftp-default-user) | |
1156 | ;; We have a default name. Use it. | |
1157 | ange-ftp-default-user) | |
1158 | (ange-ftp-default-user | |
1159 | ;; Ask the user. | |
1160 | (let ((enable-recursive-minibuffers t)) | |
1161 | (read-string (format "User for %s: " host) | |
1162 | (user-login-name)))) | |
1163 | (ange-ftp-netrc-default-user) | |
1164 | ;; Default to the user's login name. | |
1165 | (t | |
1166 | (user-login-name)))) | |
1167 | (ange-ftp-set-user host user))))) | |
1168 | \f | |
1169 | ;;;; ------------------------------------------------------------ | |
1170 | ;;;; Password support. | |
1171 | ;;;; ------------------------------------------------------------ | |
1172 | ||
1173 | (defmacro ange-ftp-generate-passwd-key (host user) | |
b3ee21ac | 1174 | `(and (stringp ,host) (stringp ,user) (concat (downcase ,host) "/" ,user))) |
8749abea GM |
1175 | |
1176 | (defmacro ange-ftp-lookup-passwd (host user) | |
6e85ef5f SM |
1177 | `(gethash (ange-ftp-generate-passwd-key ,host ,user) |
1178 | ange-ftp-passwd-hashtable)) | |
8749abea | 1179 | |
4671dba5 | 1180 | (defun ange-ftp-set-passwd (host user password) |
8749abea GM |
1181 | "For a given HOST and USER, set or change the associated PASSWORD." |
1182 | (interactive (list (read-string "Host: ") | |
1183 | (read-string "User: ") | |
1184 | (read-passwd "Password: "))) | |
6e85ef5f | 1185 | (puthash (ange-ftp-generate-passwd-key host user) |
4671dba5 | 1186 | password ange-ftp-passwd-hashtable)) |
8749abea GM |
1187 | |
1188 | (defun ange-ftp-get-host-with-passwd (user) | |
1189 | "Given a USER, return a host we know the password for." | |
1190 | (ange-ftp-parse-netrc) | |
1191 | (catch 'found-one | |
6e85ef5f SM |
1192 | (maphash |
1193 | (lambda (host val) | |
1194 | (if (ange-ftp-lookup-passwd host user) (throw 'found-one host))) | |
8749abea GM |
1195 | ange-ftp-user-hashtable) |
1196 | (save-match-data | |
6e85ef5f SM |
1197 | (maphash |
1198 | (lambda (key value) | |
aa6f7b96 | 1199 | (if (string-match "\\`[^/]*\\(/\\).*\\'" key) |
6e85ef5f SM |
1200 | (let ((host (substring key 0 (match-beginning 1)))) |
1201 | (if (and (string-equal user (substring key (match-end 1))) | |
1202 | value) | |
1203 | (throw 'found-one host))))) | |
8749abea GM |
1204 | ange-ftp-passwd-hashtable)) |
1205 | nil)) | |
1206 | ||
1207 | (defun ange-ftp-get-passwd (host user) | |
1208 | "Return the password for specified HOST and USER, asking user if necessary." | |
1209 | (ange-ftp-parse-netrc) | |
1210 | ||
1211 | ;; look up password in the hash table first; user might have overridden the | |
1212 | ;; defaults. | |
1213 | (cond ((ange-ftp-lookup-passwd host user)) | |
25759a92 | 1214 | |
8749abea GM |
1215 | ;; See if default user and password set. |
1216 | ((and (stringp ange-ftp-default-user) | |
1217 | ange-ftp-default-password | |
1218 | (string-equal user ange-ftp-default-user)) | |
1219 | ange-ftp-default-password) | |
25759a92 | 1220 | |
8749abea GM |
1221 | ;; See if default user and password set from .netrc file. |
1222 | ((and (stringp ange-ftp-netrc-default-user) | |
1223 | ange-ftp-netrc-default-password | |
1224 | (string-equal user ange-ftp-netrc-default-user)) | |
1225 | ange-ftp-netrc-default-password) | |
25759a92 | 1226 | |
8749abea GM |
1227 | ;; anonymous ftp password is handled specially since there is an |
1228 | ;; unwritten rule about how that is used on the Internet. | |
1229 | ((and (or (string-equal user "anonymous") | |
1230 | (string-equal user "ftp")) | |
1231 | ange-ftp-generate-anonymous-password) | |
1232 | (if (stringp ange-ftp-generate-anonymous-password) | |
1233 | ange-ftp-generate-anonymous-password | |
1234 | user-mail-address)) | |
25759a92 | 1235 | |
8749abea GM |
1236 | ;; see if same user has logged in to other hosts; if so then prompt |
1237 | ;; with the password that was used there. | |
1238 | (t | |
1239 | (let* ((other (ange-ftp-get-host-with-passwd user)) | |
1240 | (passwd (if other | |
25759a92 | 1241 | |
8749abea GM |
1242 | ;; found another machine with the same user. |
1243 | ;; Try that account. | |
1244 | (read-passwd | |
1245 | (format "passwd for %s@%s (default same as %s@%s): " | |
1246 | user host user other) | |
1247 | nil | |
1248 | (ange-ftp-lookup-passwd other user)) | |
25759a92 | 1249 | |
8749abea GM |
1250 | ;; I give up. Ask the user for the password. |
1251 | (read-passwd | |
1252 | (format "Password for %s@%s: " user host))))) | |
1253 | (ange-ftp-set-passwd host user passwd) | |
1254 | passwd)))) | |
1255 | \f | |
1256 | ;;;; ------------------------------------------------------------ | |
1257 | ;;;; Account support | |
1258 | ;;;; ------------------------------------------------------------ | |
1259 | ||
1260 | ;; Account passwords must be either specified in the .netrc file, or set | |
1261 | ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't | |
1262 | ;; check to see whether the FTP process is actually prompting for an account | |
1263 | ;; password. | |
25759a92 | 1264 | |
8749abea GM |
1265 | (defun ange-ftp-set-account (host user account) |
1266 | "For a given HOST and USER, set or change the associated ACCOUNT password." | |
1267 | (interactive (list (read-string "Host: ") | |
1268 | (read-string "User: ") | |
1269 | (read-passwd "Account password: "))) | |
6e85ef5f SM |
1270 | (puthash (ange-ftp-generate-passwd-key host user) |
1271 | account ange-ftp-account-hashtable)) | |
8749abea GM |
1272 | |
1273 | (defun ange-ftp-get-account (host user) | |
1274 | "Given a HOST and USER, return the FTP account." | |
1275 | (ange-ftp-parse-netrc) | |
6e85ef5f SM |
1276 | (or (gethash (ange-ftp-generate-passwd-key host user) |
1277 | ange-ftp-account-hashtable) | |
8749abea GM |
1278 | (and (stringp ange-ftp-default-user) |
1279 | (string-equal user ange-ftp-default-user) | |
1280 | ange-ftp-default-account) | |
1281 | (and (stringp ange-ftp-netrc-default-user) | |
1282 | (string-equal user ange-ftp-netrc-default-user) | |
1283 | ange-ftp-netrc-default-account))) | |
1284 | \f | |
1285 | ;;;; ------------------------------------------------------------ | |
1286 | ;;;; ~/.netrc support | |
1287 | ;;;; ------------------------------------------------------------ | |
1288 | ||
1289 | (defun ange-ftp-chase-symlinks (file) | |
1290 | "Return the filename that FILE references, following all symbolic links." | |
1291 | (let (temp) | |
1292 | (while (setq temp (ange-ftp-real-file-symlink-p file)) | |
1293 | (setq file | |
1294 | (if (file-name-absolute-p temp) | |
1295 | temp | |
3bd1644e SM |
1296 | ;; Wouldn't `expand-file-name' be better than `concat' ? |
1297 | ;; It would fail when `a/b/..' != `a', tho. --Stef | |
8749abea GM |
1298 | (concat (file-name-directory file) temp))))) |
1299 | file) | |
1300 | ||
1301 | ;; Move along current line looking for the value of the TOKEN. | |
1302 | ;; Valid separators between TOKEN and its value are commas and | |
1303 | ;; whitespace. Second arg LIMIT is a limit for the search. | |
1304 | ||
1305 | (defun ange-ftp-parse-netrc-token (token limit) | |
1306 | (if (search-forward token limit t) | |
1307 | (let (beg) | |
1308 | (skip-chars-forward ", \t\r\n" limit) | |
1309 | (if (eq (following-char) ?\") ;quoted token value | |
1310 | (progn (forward-char 1) | |
1311 | (setq beg (point)) | |
1312 | (skip-chars-forward "^\"" limit) | |
1313 | (forward-char 1) | |
1314 | (buffer-substring beg (1- (point)))) | |
1315 | (setq beg (point)) | |
1316 | (skip-chars-forward "^, \t\r\n" limit) | |
1317 | (buffer-substring beg (point)))))) | |
1318 | ||
1319 | ;; Extract the values for the tokens `machine', `login', | |
1320 | ;; `password' and `account' in the current buffer. If successful, | |
1321 | ;; record the information found. | |
1322 | ||
1323 | (defun ange-ftp-parse-netrc-group () | |
1324 | (let ((start (point)) | |
1325 | (end (save-excursion | |
1326 | (if (looking-at "machine\\>") | |
1327 | ;; Skip `machine' and the machine name that follows. | |
1328 | (progn | |
1329 | (skip-chars-forward "^ \t\r\n") | |
1330 | (skip-chars-forward " \t\r\n") | |
1331 | (skip-chars-forward "^ \t\r\n")) | |
1332 | ;; Skip `default'. | |
1333 | (skip-chars-forward "^ \t\r\n")) | |
1334 | ;; Find start of the next `machine' or `default' | |
1335 | ;; or the end of the buffer. | |
1336 | (if (re-search-forward "machine\\>\\|default\\>" nil t) | |
1337 | (match-beginning 0) | |
1338 | (point-max)))) | |
1339 | machine login password account) | |
1340 | (setq machine (ange-ftp-parse-netrc-token "machine" end) | |
1341 | login (ange-ftp-parse-netrc-token "login" end) | |
1342 | password (ange-ftp-parse-netrc-token "password" end) | |
1343 | account (ange-ftp-parse-netrc-token "account" end)) | |
1344 | (if (and machine login) | |
1345 | ;; found a `machine` token. | |
1346 | (progn | |
1347 | (ange-ftp-set-user machine login) | |
1348 | (ange-ftp-set-passwd machine login password) | |
1349 | (and account | |
1350 | (ange-ftp-set-account machine login account))) | |
1351 | (goto-char start) | |
1352 | (if (search-forward "default" end t) | |
1353 | ;; found a `default' token | |
1354 | (progn | |
1355 | (setq login (ange-ftp-parse-netrc-token "login" end) | |
1356 | password (ange-ftp-parse-netrc-token "password" end) | |
1357 | account (ange-ftp-parse-netrc-token "account" end)) | |
1358 | (and login | |
1359 | (setq ange-ftp-netrc-default-user login)) | |
1360 | (and password | |
1361 | (setq ange-ftp-netrc-default-password password)) | |
1362 | (and account | |
1363 | (setq ange-ftp-netrc-default-account account))))) | |
1364 | (goto-char end))) | |
1365 | ||
1366 | ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has | |
1367 | ;; the correct permissions then extract the \`machine\', \`login\', | |
1368 | ;; \`password\' and \`account\' information from within. | |
1369 | ||
1370 | (defun ange-ftp-parse-netrc () | |
1371 | ;; We set this before actually doing it to avoid the possibility | |
1372 | ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file. | |
1373 | (interactive) | |
1374 | (let (file attr) | |
1375 | (let ((default-directory "/")) | |
1376 | (setq file (ange-ftp-chase-symlinks | |
1377 | (ange-ftp-real-expand-file-name ange-ftp-netrc-filename))) | |
1378 | (setq attr (ange-ftp-real-file-attributes file))) | |
1379 | (if (and attr ; file exists. | |
1380 | (not (equal (nth 5 attr) ange-ftp-netrc-modtime))) ; file changed | |
1381 | (save-match-data | |
1382 | (if (or ange-ftp-disable-netrc-security-check | |
1383 | (and (eq (nth 2 attr) (user-uid)) ; Same uids. | |
1384 | (string-match ".r..------" (nth 8 attr)))) | |
b63f6e81 | 1385 | (with-current-buffer |
8749abea GM |
1386 | ;; we are cheating a bit here. I'm trying to do the equivalent |
1387 | ;; of find-file on the .netrc file, but then nuke it afterwards. | |
1388 | ;; with the bit of logic below we should be able to have | |
1389 | ;; encrypted .netrc files. | |
b63f6e81 | 1390 | (generate-new-buffer "*ftp-.netrc*") |
8749abea GM |
1391 | (ange-ftp-real-insert-file-contents file) |
1392 | (setq buffer-file-name file) | |
1393 | (setq default-directory (file-name-directory file)) | |
1394 | (normal-mode t) | |
c8607dc7 | 1395 | (run-hooks 'find-file-hook) |
8749abea GM |
1396 | (setq buffer-file-name nil) |
1397 | (goto-char (point-min)) | |
1398 | (skip-chars-forward " \t\r\n") | |
1399 | (while (not (eobp)) | |
1400 | (ange-ftp-parse-netrc-group)) | |
1401 | (kill-buffer (current-buffer))) | |
1402 | (ange-ftp-message "%s either not owned by you or badly protected." | |
1403 | ange-ftp-netrc-filename) | |
1404 | (sit-for 1)) | |
1405 | (setq ange-ftp-netrc-modtime (nth 5 attr)))))) | |
1406 | ||
1407 | ;; Return a list of prefixes of the form 'user@host:' to be used when | |
1408 | ;; completion is done in the root directory. | |
1409 | ||
1410 | (defun ange-ftp-generate-root-prefixes () | |
1411 | (ange-ftp-parse-netrc) | |
1412 | (save-match-data | |
1413 | (let (res) | |
6e85ef5f SM |
1414 | (maphash |
1415 | (lambda (key value) | |
aa6f7b96 | 1416 | (if (string-match "\\`[^/]*\\(/\\).*\\'" key) |
6e85ef5f SM |
1417 | (let ((host (substring key 0 (match-beginning 1))) |
1418 | (user (substring key (match-end 1)))) | |
1419 | (push (concat user "@" host ":") res)))) | |
8749abea | 1420 | ange-ftp-passwd-hashtable) |
6e85ef5f SM |
1421 | (maphash |
1422 | (lambda (host user) (push (concat host ":") res)) | |
8749abea GM |
1423 | ange-ftp-user-hashtable) |
1424 | (or res (list nil))))) | |
1425 | \f | |
1426 | ;;;; ------------------------------------------------------------ | |
1427 | ;;;; Remote file name syntax support. | |
1428 | ;;;; ------------------------------------------------------------ | |
1429 | ||
1430 | (defmacro ange-ftp-ftp-name-component (n ns name) | |
4671dba5 | 1431 | "Extract the Nth FTP file name component from NS." |
25759a92 | 1432 | `(let ((elt (nth ,n ,ns))) |
e3441f42 | 1433 | (match-string elt ,name))) |
8749abea GM |
1434 | |
1435 | (defvar ange-ftp-ftp-name-arg "") | |
1436 | (defvar ange-ftp-ftp-name-res nil) | |
1437 | ||
1438 | ;; Parse NAME according to `ange-ftp-name-format' (which see). | |
1439 | ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format. | |
1440 | (defun ange-ftp-ftp-name (name) | |
1441 | (if (string-equal name ange-ftp-ftp-name-arg) | |
1442 | ange-ftp-ftp-name-res | |
1443 | (setq ange-ftp-ftp-name-arg name | |
1444 | ange-ftp-ftp-name-res | |
1445 | (save-match-data | |
1446 | (if (posix-string-match (car ange-ftp-name-format) name) | |
1447 | (let* ((ns (cdr ange-ftp-name-format)) | |
1448 | (host (ange-ftp-ftp-name-component 0 ns name)) | |
1449 | (user (ange-ftp-ftp-name-component 1 ns name)) | |
1450 | (name (ange-ftp-ftp-name-component 2 ns name))) | |
1451 | (if (zerop (length user)) | |
1452 | (setq user (ange-ftp-get-user host))) | |
1453 | (list host user name)) | |
1454 | nil))))) | |
1455 | ||
1456 | ;; Take a FULLNAME that matches according to ange-ftp-name-format and | |
1457 | ;; replace the name component with NAME. | |
1458 | (defun ange-ftp-replace-name-component (fullname name) | |
1459 | (save-match-data | |
1460 | (if (posix-string-match (car ange-ftp-name-format) fullname) | |
1461 | (let* ((ns (cdr ange-ftp-name-format)) | |
1462 | (elt (nth 2 ns))) | |
1463 | (concat (substring fullname 0 (match-beginning elt)) | |
1464 | name | |
1465 | (substring fullname (match-end elt))))))) | |
1466 | \f | |
1467 | ;;;; ------------------------------------------------------------ | |
1468 | ;;;; Miscellaneous utils. | |
1469 | ;;;; ------------------------------------------------------------ | |
1470 | ||
1471 | ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap)) | |
1472 | ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer) | |
1473 | ||
1474 | (defun ange-ftp-repaint-minibuffer () | |
1475 | "Clear any existing minibuffer message; let the minibuffer contents show." | |
1476 | (message nil)) | |
1477 | ||
1478 | ;; Return the name of the buffer that collects output from the ftp process | |
1479 | ;; connected to the given HOST and USER pair. | |
1480 | (defun ange-ftp-ftp-process-buffer (host user) | |
1481 | (concat "*ftp " user "@" host "*")) | |
1482 | ||
1483 | ;; Display the last chunk of output from the ftp process for the given HOST | |
1484 | ;; USER pair, and signal an error including MSG in the text. | |
1485 | (defun ange-ftp-error (host user msg) | |
6df73ca3 RS |
1486 | (save-excursion ;; Prevent pop-to-buffer from changing current buffer. |
1487 | (let ((cur (selected-window)) | |
1488 | (pop-up-windows t)) | |
1489 | (pop-to-buffer | |
1490 | (get-buffer-create | |
1491 | (ange-ftp-ftp-process-buffer host user))) | |
1492 | (goto-char (point-max)) | |
1493 | (select-window cur)) | |
1494 | (signal 'ftp-error (list (format "FTP Error: %s" msg))))) | |
8749abea GM |
1495 | |
1496 | (defun ange-ftp-set-buffer-mode () | |
1497 | "Set correct modes for the current buffer if visiting a remote file." | |
1498 | (if (and (stringp buffer-file-name) | |
1499 | (ange-ftp-ftp-name buffer-file-name)) | |
1500 | (auto-save-mode ange-ftp-auto-save))) | |
1501 | ||
1502 | (defun ange-ftp-kill-ftp-process (&optional buffer) | |
1503 | "Kill the FTP process associated with BUFFER (the current buffer, if nil). | |
4671dba5 JB |
1504 | If the BUFFER's visited filename or `default-directory' is an FTP filename |
1505 | then kill the related FTP process." | |
8749abea GM |
1506 | (interactive "bKill FTP process associated with buffer: ") |
1507 | (if (null buffer) | |
1508 | (setq buffer (current-buffer)) | |
1509 | (setq buffer (get-buffer buffer))) | |
1510 | (let ((file (or (buffer-file-name buffer) | |
b63f6e81 | 1511 | (with-current-buffer buffer default-directory)))) |
8749abea GM |
1512 | (if file |
1513 | (let ((parsed (ange-ftp-ftp-name (expand-file-name file)))) | |
1514 | (if parsed | |
1515 | (let ((host (nth 0 parsed)) | |
1516 | (user (nth 1 parsed))) | |
1517 | (kill-buffer (get-buffer (ange-ftp-ftp-process-buffer host user))))))))) | |
1518 | ||
1519 | (defun ange-ftp-quote-string (string) | |
4671dba5 | 1520 | "Quote any characters in STRING that may confuse the FTP process." |
1860f08d MA |
1521 | ;; This is said to be wrong; ftp is said to need quoting only for ", |
1522 | ;; and that by doubling it. But experiment says UNIX-style kind of | |
1523 | ;; quoting is correct when talking to ftp on GNU/Linux systems, and | |
1524 | ;; W32-style kind of quoting on, yes, W32 systems. | |
c200c78d MA |
1525 | (if (stringp string) |
1526 | (shell-quote-argument string) | |
1527 | "")) | |
8749abea GM |
1528 | |
1529 | (defun ange-ftp-barf-if-not-directory (directory) | |
1530 | (or (file-directory-p directory) | |
1531 | (signal 'file-error | |
1532 | (list "Opening directory" | |
1533 | (if (file-exists-p directory) | |
1534 | "not a directory" | |
1535 | "no such file or directory") | |
1536 | directory)))) | |
1537 | \f | |
1538 | ;;;; ------------------------------------------------------------ | |
1539 | ;;;; FTP process filter support. | |
1540 | ;;;; ------------------------------------------------------------ | |
1541 | ||
1542 | (defun ange-ftp-process-handle-line (line proc) | |
4671dba5 | 1543 | "Look at the given LINE from the FTP process PROC. |
8749abea GM |
1544 | Try to categorize it into one of four categories: |
1545 | good, skip, fatal, or unknown." | |
1546 | (cond ((string-match ange-ftp-xfer-size-msgs line) | |
1547 | (setq ange-ftp-xfer-size | |
e3441f42 | 1548 | (/ (string-to-number (match-string 1 line)) |
5504af22 | 1549 | 1024))) |
8749abea GM |
1550 | ((string-match ange-ftp-skip-msgs line) |
1551 | t) | |
1552 | ((string-match ange-ftp-good-msgs line) | |
1553 | (setq ange-ftp-process-busy nil | |
1554 | ange-ftp-process-result t | |
92482d77 | 1555 | ange-ftp-pending-error-line nil |
8749abea GM |
1556 | ange-ftp-process-result-line line)) |
1557 | ;; Check this before checking for errors. | |
1558 | ;; Otherwise the last line of these three seems to be an error: | |
1559 | ;; 230-see a significant impact from the move. For those of you who can't | |
1560 | ;; 230-use DNS to resolve hostnames and get an error message like | |
1561 | ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be... | |
1562 | ((string-match ange-ftp-multi-msgs line) | |
1563 | (setq ange-ftp-process-multi-skip t)) | |
92482d77 SM |
1564 | ((string-match ange-ftp-potential-error-msgs line) |
1565 | ;; This looks like an error, but we have to keep reading the output | |
1566 | ;; to see if it was fixed or not. E.g. it may indicate that IPv6 | |
1567 | ;; failed, but maybe a subsequent IPv4 fallback succeeded. | |
1568 | (set (make-local-variable 'ange-ftp-pending-error-line) line) | |
1569 | t) | |
8749abea GM |
1570 | ((string-match ange-ftp-fatal-msgs line) |
1571 | (delete-process proc) | |
1572 | (setq ange-ftp-process-busy nil | |
1573 | ange-ftp-process-result-line line)) | |
92482d77 | 1574 | (ange-ftp-process-multi-skip |
8749abea GM |
1575 | t) |
1576 | (t | |
1577 | (setq ange-ftp-process-busy nil | |
1578 | ange-ftp-process-result-line line)))) | |
1579 | ||
1580 | (defun ange-ftp-set-xfer-size (host user bytes) | |
1581 | "Set the size of the next FTP transfer in bytes." | |
1582 | (let ((proc (ange-ftp-get-process host user))) | |
4671dba5 JB |
1583 | (when proc |
1584 | (let ((buf (process-buffer proc))) | |
1585 | (when buf | |
1586 | (with-current-buffer buf | |
1587 | (setq ange-ftp-xfer-size | |
1588 | ;; For very large files, BYTES can be a float. | |
1589 | (if (integerp bytes) | |
1590 | (ash bytes -10) | |
1591 | (/ bytes 1024))))))))) | |
1592 | ||
1593 | (defun ange-ftp-process-handle-hash (string) | |
8749abea | 1594 | "Remove hash marks from STRING and display count so far." |
4671dba5 JB |
1595 | (setq string (concat (substring string 0 (match-beginning 0)) |
1596 | (substring string (match-end 0))) | |
8749abea GM |
1597 | ange-ftp-hash-mark-count (+ (- (match-end 0) |
1598 | (match-beginning 0)) | |
1599 | ange-ftp-hash-mark-count)) | |
1600 | (and ange-ftp-hash-mark-unit | |
1601 | ange-ftp-process-msg | |
1602 | ange-ftp-process-verbose | |
1603 | (not (eq (selected-window) (minibuffer-window))) | |
1604 | (not (boundp 'search-message)) ;screws up isearch otherwise | |
1605 | (not cursor-in-echo-area) ;screws up y-or-n-p otherwise | |
1606 | (let ((kbytes (ash (* ange-ftp-hash-mark-unit | |
1607 | ange-ftp-hash-mark-count) | |
1608 | -6))) | |
6e85ef5f SM |
1609 | (if (zerop ange-ftp-xfer-size) |
1610 | (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes) | |
1611 | (let ((percent (/ (* 100 kbytes) ange-ftp-xfer-size))) | |
1612 | ;; cut out the redisplay of identical %-age messages. | |
1613 | (unless (eq percent ange-ftp-last-percent) | |
1614 | (setq ange-ftp-last-percent percent) | |
1615 | (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent)))))) | |
4671dba5 | 1616 | string) |
8749abea GM |
1617 | |
1618 | ;; Call the function specified by CONT. CONT can be either a function | |
1619 | ;; or a list of a function and some args. The first two parameters | |
1620 | ;; passed to the function will be RESULT and LINE. The remaining args | |
1621 | ;; will be taken from CONT if a list was passed. | |
1622 | ||
1623 | (defun ange-ftp-call-cont (cont result line) | |
4671dba5 JB |
1624 | (when cont |
1625 | (if (and (listp cont) | |
1626 | (not (eq (car cont) 'lambda))) | |
1627 | (apply (car cont) result line (cdr cont)) | |
1628 | (funcall cont result line)))) | |
8749abea GM |
1629 | |
1630 | ;; Build up a complete line of output from the ftp PROCESS and pass it | |
1631 | ;; on to ange-ftp-process-handle-line to deal with. | |
1632 | ||
1633 | (defun ange-ftp-process-filter (proc str) | |
503ac8a4 SM |
1634 | ;; Eliminate nulls. |
1635 | (while (string-match "\000+" str) | |
1636 | (setq str (replace-match "" nil nil str))) | |
1637 | ||
1638 | ;; see if the buffer is still around... it could have been deleted. | |
1639 | (when (buffer-live-p (process-buffer proc)) | |
1640 | (with-current-buffer (process-buffer proc) | |
1641 | ||
1642 | ;; handle hash mark printing | |
1643 | (and ange-ftp-process-busy | |
1644 | (string-match "^#+$" str) | |
1645 | (setq str (ange-ftp-process-handle-hash str))) | |
1646 | (comint-output-filter proc str) | |
1647 | ;; Replace STR by the result of the comint processing. | |
1648 | (setq str (buffer-substring comint-last-output-start | |
1649 | (process-mark proc))) | |
4671dba5 JB |
1650 | (when ange-ftp-process-busy |
1651 | (setq ange-ftp-process-string (concat ange-ftp-process-string | |
1652 | str)) | |
1653 | ||
1654 | ;; if we gave an empty password to the USER command earlier | |
1655 | ;; then we should send a null password now. | |
1656 | (if (string-match "Password: *$" ange-ftp-process-string) | |
1657 | (process-send-string proc "\n"))) | |
503ac8a4 SM |
1658 | (while (and ange-ftp-process-busy |
1659 | (string-match "\n" ange-ftp-process-string)) | |
1660 | (let ((line (substring ange-ftp-process-string | |
1661 | 0 | |
1662 | (match-beginning 0))) | |
1663 | (seen-prompt nil)) | |
1664 | (setq ange-ftp-process-string (substring ange-ftp-process-string | |
1665 | (match-end 0))) | |
1666 | (while (string-match "\\`ftp> *" line) | |
1667 | (setq seen-prompt t) | |
1668 | (setq line (substring line (match-end 0)))) | |
1669 | (if (not (and seen-prompt ange-ftp-pending-error-line)) | |
1670 | (ange-ftp-process-handle-line line proc) | |
1671 | ;; If we've seen a potential error message and it | |
1672 | ;; hasn't been cancelled by a good message before | |
1673 | ;; seeing a propt, then the error was real. | |
1674 | (delete-process proc) | |
1675 | (setq ange-ftp-process-busy nil | |
1676 | ange-ftp-process-result-line ange-ftp-pending-error-line)))) | |
1677 | ||
1678 | ;; has the ftp client finished? if so then do some clean-up | |
1679 | ;; actions. | |
4671dba5 JB |
1680 | (unless ange-ftp-process-busy |
1681 | ;; reset the xfer size | |
1682 | (setq ange-ftp-xfer-size 0) | |
1683 | ||
1684 | ;; issue the "done" message since we've finished. | |
1685 | (when (and ange-ftp-process-msg | |
1686 | ange-ftp-process-verbose | |
1687 | ange-ftp-process-result) | |
1688 | (ange-ftp-message "%s...done" ange-ftp-process-msg) | |
1689 | (ange-ftp-repaint-minibuffer) | |
1690 | (setq ange-ftp-process-msg nil)) | |
1691 | ||
1692 | ;; is there a continuation we should be calling? if so, | |
1693 | ;; we'd better call it, making sure we only call it once. | |
1694 | (when ange-ftp-process-continue | |
1695 | (let ((cont ange-ftp-process-continue)) | |
1696 | (setq ange-ftp-process-continue nil) | |
1697 | (ange-ftp-call-cont cont | |
1698 | ange-ftp-process-result | |
1699 | ange-ftp-process-result-line))))))) | |
8749abea GM |
1700 | |
1701 | (defun ange-ftp-process-sentinel (proc str) | |
4671dba5 | 1702 | "When FTP process changes state, nuke all file-entries in cache." |
8749abea | 1703 | (let ((name (process-name proc))) |
4671dba5 JB |
1704 | (when (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name) |
1705 | (let ((user (match-string 1 name)) | |
1706 | (host (match-string 2 name))) | |
1707 | (ange-ftp-wipe-file-entries host user)))) | |
8749abea GM |
1708 | (setq ange-ftp-ls-cache-file nil)) |
1709 | \f | |
1710 | ;;;; ------------------------------------------------------------ | |
1711 | ;;;; Gateway support. | |
1712 | ;;;; ------------------------------------------------------------ | |
1713 | ||
1714 | (defun ange-ftp-use-gateway-p (host) | |
4671dba5 | 1715 | "Return whether to access this HOST via a normal (non-smart) gateway." |
8749abea GM |
1716 | ;; yes, I know that I could simplify the following expression, but it is |
1717 | ;; clearer (to me at least) this way. | |
1718 | (and (not ange-ftp-smart-gateway) | |
4671dba5 | 1719 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
8749abea GM |
1720 | |
1721 | (defun ange-ftp-use-smart-gateway-p (host) | |
4671dba5 | 1722 | "Returns whether to access this HOST via a smart gateway." |
8749abea | 1723 | (and ange-ftp-smart-gateway |
4671dba5 | 1724 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
8749abea GM |
1725 | |
1726 | \f | |
1727 | ;;; ------------------------------------------------------------ | |
1728 | ;;; Temporary file location and deletion... | |
1729 | ;;; ------------------------------------------------------------ | |
1730 | ||
1731 | (defun ange-ftp-make-tmp-name (host) | |
1732 | "This routine will return the name of a new file." | |
1733 | (make-temp-file (if (ange-ftp-use-gateway-p host) | |
6e85ef5f SM |
1734 | ange-ftp-gateway-tmp-name-template |
1735 | ange-ftp-tmp-name-template))) | |
8749abea GM |
1736 | |
1737 | (defalias 'ange-ftp-del-tmp-name 'delete-file) | |
1738 | \f | |
1739 | ;;;; ------------------------------------------------------------ | |
1740 | ;;;; Interactive gateway program support. | |
1741 | ;;;; ------------------------------------------------------------ | |
1742 | ||
1743 | (defvar ange-ftp-gwp-running t) | |
1744 | (defvar ange-ftp-gwp-status nil) | |
1745 | ||
1746 | (defun ange-ftp-gwp-sentinel (proc str) | |
1747 | (setq ange-ftp-gwp-running nil)) | |
1748 | ||
1749 | (defun ange-ftp-gwp-filter (proc str) | |
1750 | (comint-output-filter proc str) | |
b63f6e81 | 1751 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1752 | ;; Replace STR by the result of the comint processing. |
1753 | (setq str (buffer-substring comint-last-output-start (process-mark proc)))) | |
1754 | (cond ((string-match "login: *$" str) | |
ff660307 JB |
1755 | (process-send-string proc |
1756 | (concat | |
1757 | (let ((ange-ftp-default-user t)) | |
1758 | (ange-ftp-get-user ange-ftp-gateway-host)) | |
1759 | "\n"))) | |
8749abea | 1760 | ((string-match "Password: *$" str) |
ff660307 JB |
1761 | (process-send-string proc |
1762 | (concat | |
1763 | (ange-ftp-get-passwd ange-ftp-gateway-host | |
1764 | (ange-ftp-get-user | |
1765 | ange-ftp-gateway-host)) | |
1766 | "\n"))) | |
8749abea GM |
1767 | ((string-match ange-ftp-gateway-fatal-msgs str) |
1768 | (delete-process proc) | |
1769 | (setq ange-ftp-gwp-running nil)) | |
1770 | ((string-match ange-ftp-gateway-prompt-pattern str) | |
1771 | (setq ange-ftp-gwp-running nil | |
1772 | ange-ftp-gwp-status t)))) | |
1773 | ||
1774 | (defun ange-ftp-gwp-start (host user name args) | |
4671dba5 JB |
1775 | "Login to the gateway machine and fire up an FTP process." |
1776 | (let (;; It would be nice to make process-connection-type nil, | |
1777 | ;; but that doesn't work: ftp never responds. | |
1778 | ;; Can anyone find a fix for that? | |
1779 | (proc (let ((process-connection-type t)) | |
1780 | (start-process name name | |
1781 | ange-ftp-gateway-program | |
1782 | ange-ftp-gateway-host))) | |
1783 | (ftp (mapconcat 'identity args " "))) | |
260763db | 1784 | (set-process-query-on-exit-flag proc nil) |
e3441f42 SM |
1785 | (set-process-sentinel proc 'ange-ftp-gwp-sentinel) |
1786 | (set-process-filter proc 'ange-ftp-gwp-filter) | |
3bd1644e | 1787 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1788 | (goto-char (point-max)) |
1789 | (set-marker (process-mark proc) (point))) | |
1790 | (setq ange-ftp-gwp-running t | |
1791 | ange-ftp-gwp-status nil) | |
1792 | (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host) | |
1793 | (while ange-ftp-gwp-running ;perform login sequence | |
1794 | (accept-process-output proc)) | |
4671dba5 JB |
1795 | (unless ange-ftp-gwp-status |
1796 | (ange-ftp-error host user "unable to login to gateway")) | |
8749abea GM |
1797 | (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host) |
1798 | (setq ange-ftp-gwp-running t | |
1799 | ange-ftp-gwp-status nil) | |
1800 | (process-send-string proc ange-ftp-gateway-setup-term-command) | |
1801 | (while ange-ftp-gwp-running ;zap ^M's and double echoing. | |
1802 | (accept-process-output proc)) | |
4671dba5 JB |
1803 | (unless ange-ftp-gwp-status |
1804 | (ange-ftp-error host user "unable to set terminal modes on gateway")) | |
8749abea GM |
1805 | (setq ange-ftp-gwp-running t |
1806 | ange-ftp-gwp-status nil) | |
1807 | (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process | |
1808 | proc)) | |
1809 | \f | |
1810 | ;;;; ------------------------------------------------------------ | |
1811 | ;;;; Support for sending commands to the ftp process. | |
1812 | ;;;; ------------------------------------------------------------ | |
1813 | ||
1814 | (defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait) | |
4671dba5 | 1815 | "Low-level routine to send the given FTP CMD to the FTP process PROC. |
8749abea | 1816 | MSG is an optional message to output before and after the command. |
25759a92 | 1817 | If CONT is non-nil then it is either a function or a list of function |
4671dba5 | 1818 | and some arguments. The function will be called when the FTP command |
25759a92 | 1819 | has completed. |
4671dba5 | 1820 | If CONT is nil then this routine will return (RESULT . LINE) where RESULT |
8749abea GM |
1821 | is whether the command was successful, and LINE is the line from the FTP |
1822 | process that caused the command to complete. | |
1823 | If NOWAIT is given then the routine will return immediately the command has | |
1824 | been queued with no result. CONT will still be called, however." | |
1825 | (if (memq (process-status proc) '(run open)) | |
67f300f8 | 1826 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1827 | (ange-ftp-wait-not-busy proc) |
1828 | (setq ange-ftp-process-string "" | |
1829 | ange-ftp-process-result-line "" | |
1830 | ange-ftp-process-busy t | |
1831 | ange-ftp-process-result nil | |
1832 | ange-ftp-process-multi-skip nil | |
1833 | ange-ftp-process-msg msg | |
1834 | ange-ftp-process-continue cont | |
1835 | ange-ftp-hash-mark-count 0 | |
1836 | ange-ftp-last-percent -1 | |
1837 | cmd (concat cmd "\n")) | |
1838 | (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg)) | |
1839 | (goto-char (point-max)) | |
1840 | (move-marker comint-last-input-start (point)) | |
1841 | ;; don't insert the password into the buffer on the USER command. | |
1842 | (save-match-data | |
aa6f7b96 | 1843 | (if (string-match "\\`user \"[^\"]*\"" cmd) |
8749abea GM |
1844 | (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n") |
1845 | (insert cmd))) | |
1846 | (move-marker comint-last-input-end (point)) | |
ff660307 | 1847 | (process-send-string proc cmd) |
8749abea GM |
1848 | (set-marker (process-mark proc) (point)) |
1849 | (if nowait | |
1850 | nil | |
1851 | (ange-ftp-wait-not-busy proc) | |
1852 | (if cont | |
1853 | nil ;cont has already been called | |
1854 | (cons ange-ftp-process-result ange-ftp-process-result-line)))))) | |
1855 | ||
1856 | ;; Wait for the ange-ftp process PROC not to be busy. | |
1857 | (defun ange-ftp-wait-not-busy (proc) | |
67f300f8 | 1858 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1859 | (condition-case nil |
1860 | ;; This is a kludge to let user quit in case ftp gets hung. | |
1861 | ;; It matters because this function can be called from the filter. | |
1862 | ;; It is bad to allow quitting in a filter, but getting hung | |
1863 | ;; is worse. By binding quit-flag to nil, we might avoid | |
1864 | ;; most of the probability of getting screwed because the user | |
1865 | ;; wants to quit some command. | |
1866 | (let ((quit-flag nil) | |
1867 | (inhibit-quit nil)) | |
1868 | (while ange-ftp-process-busy | |
1869 | (accept-process-output proc))) | |
1870 | (quit | |
1871 | ;; If the user does quit out of this, | |
1872 | ;; kill the process. That stops any transfer in progress. | |
1873 | ;; The next operation will open a new ftp connection. | |
1874 | (delete-process proc) | |
1875 | (signal 'quit nil))))) | |
1876 | ||
4671dba5 | 1877 | (defun ange-ftp-nslookup-host (hostname) |
8749abea GM |
1878 | "Attempt to resolve the given HOSTNAME using nslookup if possible." |
1879 | (interactive "sHost: ") | |
1880 | (if ange-ftp-nslookup-program | |
1881 | (let ((default-directory | |
1882 | (if (file-accessible-directory-p default-directory) | |
1883 | default-directory | |
1884 | exec-directory)) | |
1885 | ;; It would be nice to make process-connection-type nil, | |
1886 | ;; but that doesn't work: ftp never responds. | |
1887 | ;; Can anyone find a fix for that? | |
1888 | (proc (let ((process-connection-type t)) | |
1889 | (start-process " *nslookup*" " *nslookup*" | |
4671dba5 JB |
1890 | ange-ftp-nslookup-program hostname))) |
1891 | (res hostname)) | |
260763db | 1892 | (set-process-query-on-exit-flag proc nil) |
b63f6e81 | 1893 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1894 | (while (memq (process-status proc) '(run open)) |
1895 | (accept-process-output proc)) | |
1896 | (goto-char (point-min)) | |
1897 | (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t) | |
e3441f42 | 1898 | (setq res (match-string 1))) |
8749abea GM |
1899 | (kill-buffer (current-buffer))) |
1900 | res) | |
4671dba5 | 1901 | hostname)) |
8749abea GM |
1902 | |
1903 | (defun ange-ftp-start-process (host user name) | |
4671dba5 JB |
1904 | "Spawn a new FTP process ready to connect to machine HOST and give it NAME. |
1905 | If HOST is only FTP-able through a gateway machine then spawn a shell | |
1906 | on the gateway machine to do the FTP instead." | |
8749abea GM |
1907 | (let* ((use-gateway (ange-ftp-use-gateway-p host)) |
1908 | (use-smart-ftp (and (not ange-ftp-gateway-host) | |
1909 | (ange-ftp-use-smart-gateway-p host))) | |
1910 | (ftp-prog (if (or use-gateway | |
25759a92 | 1911 | use-smart-ftp) |
8749abea GM |
1912 | ange-ftp-gateway-ftp-program-name |
1913 | ange-ftp-ftp-program-name)) | |
1914 | (args (append (list ftp-prog) ange-ftp-ftp-program-args)) | |
1915 | ;; Without the following binding, ange-ftp-start-process | |
1916 | ;; recurses on file-accessible-directory-p, since it needs to | |
1917 | ;; restart its process in order to determine anything about | |
1918 | ;; default-directory. | |
1919 | (file-name-handler-alist) | |
1920 | (default-directory | |
1921 | (if (file-accessible-directory-p default-directory) | |
1922 | default-directory | |
1923 | exec-directory)) | |
1924 | proc) | |
1925 | ;; It would be nice to make process-connection-type nil, | |
1926 | ;; but that doesn't work: ftp never responds. | |
1927 | ;; Can anyone find a fix for that? | |
1928 | (let ((process-connection-type t) | |
5da64060 RS |
1929 | ;; Copy this so we don't alter it permanently. |
1930 | (process-environment (copy-tree process-environment)) | |
8749abea | 1931 | (buffer (get-buffer-create name))) |
b63f6e81 | 1932 | (with-current-buffer buffer |
8749abea GM |
1933 | (internal-ange-ftp-mode)) |
1934 | ;; This tells GNU ftp not to output any fancy escape sequences. | |
1935 | (setenv "TERM" "dumb") | |
1936 | (if use-gateway | |
1937 | (if ange-ftp-gateway-program-interactive | |
1938 | (setq proc (ange-ftp-gwp-start host user name args)) | |
1939 | (setq proc (apply 'start-process name name | |
1940 | (append (list ange-ftp-gateway-program | |
1941 | ange-ftp-gateway-host) | |
1942 | args)))) | |
1943 | (setq proc (apply 'start-process name name args)))) | |
b63f6e81 | 1944 | (with-current-buffer (process-buffer proc) |
8749abea GM |
1945 | (goto-char (point-max)) |
1946 | (set-marker (process-mark proc) (point))) | |
260763db | 1947 | (set-process-query-on-exit-flag proc nil) |
e3441f42 SM |
1948 | (set-process-sentinel proc 'ange-ftp-process-sentinel) |
1949 | (set-process-filter proc 'ange-ftp-process-filter) | |
8749abea GM |
1950 | ;; On Windows, the standard ftp client buffers its output (because |
1951 | ;; stdout is a pipe handle) so the startup message may never appear: | |
1952 | ;; `accept-process-output' at this point would hang indefinitely. | |
1953 | ;; However, sending an innocuous command ("help foo") forces some | |
1954 | ;; output that will be ignored, which is just as good. Once we | |
1955 | ;; start sending normal commands, the output no longer appears to be | |
1956 | ;; buffered, and everything works correctly. My guess is that the | |
1957 | ;; output of interest is being sent to stderr which is not buffered. | |
1958 | (when (eq system-type 'windows-nt) | |
1959 | ;; force ftp output to be treated as DOS text, otherwise the | |
1960 | ;; output of "help foo" confuses the EOL detection logic. | |
1961 | (set-process-coding-system proc 'raw-text-dos) | |
1962 | (process-send-string proc "help foo\n")) | |
1963 | (accept-process-output proc) ;wait for ftp startup message | |
1964 | proc)) | |
1965 | ||
844f7784 | 1966 | (define-derived-mode internal-ange-ftp-mode comint-mode "Internal Ange-ftp" |
8749abea GM |
1967 | "Major mode for interacting with the FTP process. |
1968 | ||
1969 | \\{comint-mode-map}" | |
ccedb10b LK |
1970 | (make-local-variable 'ange-ftp-process-string) |
1971 | (setq ange-ftp-process-string "") | |
1972 | (make-local-variable 'ange-ftp-process-busy) | |
1973 | (make-local-variable 'ange-ftp-process-result) | |
1974 | (make-local-variable 'ange-ftp-process-msg) | |
1975 | (make-local-variable 'ange-ftp-process-multi-skip) | |
1976 | (make-local-variable 'ange-ftp-process-result-line) | |
1977 | (make-local-variable 'ange-ftp-process-continue) | |
1978 | (make-local-variable 'ange-ftp-hash-mark-count) | |
1979 | (make-local-variable 'ange-ftp-binary-hash-mark-size) | |
1980 | (make-local-variable 'ange-ftp-ascii-hash-mark-size) | |
1981 | (make-local-variable 'ange-ftp-hash-mark-unit) | |
1982 | (make-local-variable 'ange-ftp-xfer-size) | |
1983 | (make-local-variable 'ange-ftp-last-percent) | |
1984 | (setq ange-ftp-hash-mark-count 0) | |
1985 | (setq ange-ftp-xfer-size 0) | |
1986 | (setq ange-ftp-process-result-line "") | |
1987 | (setq comint-prompt-regexp "^ftp> ") | |
1988 | (make-local-variable 'comint-password-prompt-regexp) | |
1989 | ;; This is a regexp that can't match anything. | |
1990 | ;; ange-ftp has its own ways of handling passwords. | |
92482d77 | 1991 | (setq comint-password-prompt-regexp "\\`a\\`") |
ccedb10b | 1992 | (make-local-variable 'paragraph-start) |
844f7784 | 1993 | (setq paragraph-start comint-prompt-regexp)) |
8749abea | 1994 | |
9c35d706 | 1995 | (defcustom ange-ftp-raw-login nil |
4671dba5 JB |
1996 | "Use raw FTP commands for login, if account password is not nil. |
1997 | Some FTP implementations need this, e.g. ftp in NT 4.0." | |
9c35d706 RS |
1998 | :group 'ange-ftp |
1999 | :version "21.3" | |
2000 | :type 'boolean) | |
2001 | ||
4671dba5 | 2002 | (defun ange-ftp-smart-login (host user password account proc) |
8749abea GM |
2003 | "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT. |
2004 | PROC is the FTP-client's process. This routine uses the smart-gateway | |
25759a92 | 2005 | host specified in `ange-ftp-gateway-host'." |
8749abea GM |
2006 | (let ((result (ange-ftp-raw-send-cmd |
2007 | proc | |
2008 | (format "open %s %s" | |
2009 | (ange-ftp-nslookup-host ange-ftp-gateway-host) | |
2010 | ange-ftp-smart-gateway-port) | |
2011 | (format "Opening FTP connection to %s via %s" | |
2012 | host | |
2013 | ange-ftp-gateway-host)))) | |
2014 | (or (car result) | |
25759a92 | 2015 | (ange-ftp-error host user |
8749abea GM |
2016 | (concat "OPEN request failed: " |
2017 | (cdr result)))) | |
2018 | (setq result (ange-ftp-raw-send-cmd | |
2019 | proc (format "user \"%s\"@%s %s %s" | |
2020 | user | |
2021 | (ange-ftp-nslookup-host host) | |
4671dba5 | 2022 | password |
8749abea GM |
2023 | account) |
2024 | (format "Logging in as user %s@%s" | |
2025 | user host))) | |
2026 | (or (car result) | |
2027 | (progn | |
2028 | (ange-ftp-set-passwd host user nil) ; reset password | |
2029 | (ange-ftp-set-account host user nil) ; reset account | |
2030 | (ange-ftp-error host user | |
2031 | (concat "USER request failed: " | |
2032 | (cdr result))))))) | |
2033 | ||
4671dba5 | 2034 | (defun ange-ftp-normal-login (host user password account proc) |
8749abea GM |
2035 | "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT. |
2036 | PROC is the process to the FTP-client. HOST may have an optional | |
4671dba5 | 2037 | suffix of the form #PORT to specify a non-default port." |
8749abea | 2038 | (save-match-data |
aa6f7b96 | 2039 | (string-match "\\`\\([^#]+\\)\\(#\\([0-9]+\\)\\)?\\'" host) |
8749abea GM |
2040 | (let* ((nshost (ange-ftp-nslookup-host (match-string 1 host))) |
2041 | (port (match-string 3 host)) | |
2042 | (result (ange-ftp-raw-send-cmd | |
2043 | proc | |
2044 | (if port | |
2045 | (format "open %s %s" nshost port) | |
2046 | (format "open %s" nshost)) | |
2047 | (format "Opening FTP connection to %s" host)))) | |
2048 | (or (car result) | |
2049 | (ange-ftp-error host user | |
2050 | (concat "OPEN request failed: " | |
2051 | (cdr result)))) | |
9c35d706 RS |
2052 | (if (not (and ange-ftp-raw-login (string< "" account))) |
2053 | (setq result (ange-ftp-raw-send-cmd | |
2054 | proc | |
2055 | (if (and (ange-ftp-use-smart-gateway-p host) | |
2056 | ange-ftp-gateway-host) | |
2057 | (format "user \"%s\"@%s %s %s" | |
4671dba5 JB |
2058 | user nshost password account) |
2059 | (format "user \"%s\" %s %s" user password account)) | |
9c35d706 RS |
2060 | (format "Logging in as user %s@%s" user host))) |
2061 | (let ((good ange-ftp-good-msgs) | |
2062 | (skip ange-ftp-skip-msgs)) | |
2063 | (setq ange-ftp-good-msgs (concat ange-ftp-good-msgs | |
2064 | "\\|^331 \\|^332 ")) | |
2065 | (if (string-match (regexp-quote "\\|^331 ") ange-ftp-skip-msgs) | |
2066 | (setq ange-ftp-skip-msgs | |
2067 | (replace-match "" t t ange-ftp-skip-msgs))) | |
2068 | (if (string-match (regexp-quote "\\|^332 ") ange-ftp-skip-msgs) | |
2069 | (setq ange-ftp-skip-msgs | |
2070 | (replace-match "" t t ange-ftp-skip-msgs))) | |
2071 | (setq result (ange-ftp-raw-send-cmd | |
2072 | proc | |
2073 | (format "quote \"USER %s\"" user) | |
2074 | (format "Logging in as user %s@%s" user host))) | |
2075 | (and (car result) | |
2076 | (setq result (ange-ftp-raw-send-cmd | |
2077 | proc | |
4671dba5 | 2078 | (format "quote \"PASS %s\"" password) |
9c35d706 RS |
2079 | (format "Logging in as user %s@%s" user host))) |
2080 | (and (car result) | |
2081 | (setq result (ange-ftp-raw-send-cmd | |
2082 | proc | |
2083 | (format "quote \"ACCT %s\"" account) | |
2084 | (format "Logging in as user %s@%s" user host))) | |
2085 | )) | |
2086 | (setq ange-ftp-good-msgs good | |
2087 | ange-ftp-skip-msgs skip))) | |
8749abea GM |
2088 | (or (car result) |
2089 | (progn | |
e3441f42 | 2090 | (ange-ftp-set-passwd host user nil) ;reset password. |
8749abea GM |
2091 | (ange-ftp-set-account host user nil) ;reset account. |
2092 | (ange-ftp-error host user | |
2093 | (concat "USER request failed: " | |
2094 | (cdr result)))))))) | |
2095 | ||
2096 | ;; ange@hplb.hpl.hp.com says this should not be changed. | |
2097 | (defvar ange-ftp-hash-mark-msgs | |
2098 | "[hH]ash mark [^0-9]*\\([0-9]+\\)" | |
2099 | "*Regexp matching the FTP client's output upon doing a HASH command.") | |
2100 | ||
2101 | (defun ange-ftp-guess-hash-mark-size (proc) | |
2102 | (if ange-ftp-send-hash | |
b63f6e81 | 2103 | (with-current-buffer (process-buffer proc) |
8749abea | 2104 | (let* ((status (ange-ftp-raw-send-cmd proc "hash")) |
8749abea GM |
2105 | (line (cdr status))) |
2106 | (save-match-data | |
2107 | (if (string-match ange-ftp-hash-mark-msgs line) | |
027a4b6b | 2108 | (let ((size (string-to-number (match-string 1 line)))) |
8749abea GM |
2109 | (setq ange-ftp-ascii-hash-mark-size size |
2110 | ange-ftp-hash-mark-unit (ash size -4)) | |
2111 | ||
2112 | ;; if a default value for this is set, use that value. | |
2113 | (or ange-ftp-binary-hash-mark-size | |
2114 | (setq ange-ftp-binary-hash-mark-size size))))))))) | |
2115 | ||
aa6f7b96 SM |
2116 | (defvar ange-ftp-process-startup-hook nil) |
2117 | ||
8749abea GM |
2118 | (defun ange-ftp-get-process (host user) |
2119 | "Return an FTP subprocess connected to HOST and logged in as USER. | |
2120 | Create a new process if needed." | |
2121 | (let* ((name (ange-ftp-ftp-process-buffer host user)) | |
2122 | (proc (get-process name))) | |
2123 | (if (and proc (memq (process-status proc) '(run open))) | |
2124 | proc | |
2125 | ;; Must delete dead process so that new process can reuse the name. | |
2126 | (if proc (delete-process proc)) | |
2127 | (let ((pass (ange-ftp-quote-string | |
2128 | (ange-ftp-get-passwd host user))) | |
2129 | (account (ange-ftp-quote-string | |
2130 | (ange-ftp-get-account host user)))) | |
2131 | ;; grab a suitable process. | |
2132 | (setq proc (ange-ftp-start-process host user name)) | |
25759a92 | 2133 | |
8749abea GM |
2134 | ;; login to FTP server. |
2135 | (if (and (ange-ftp-use-smart-gateway-p host) | |
2136 | ange-ftp-gateway-host) | |
2137 | (ange-ftp-smart-login host user pass account proc) | |
2138 | (ange-ftp-normal-login host user pass account proc)) | |
25759a92 | 2139 | |
8749abea GM |
2140 | ;; Tell client to send back hash-marks as progress. It isn't usually |
2141 | ;; fatal if this command fails. | |
2142 | (ange-ftp-guess-hash-mark-size proc) | |
2143 | ||
2144 | ;; Guess at the host type. | |
2145 | (ange-ftp-guess-host-type host user) | |
2146 | ||
1d0653f8 RS |
2147 | ;; Turn passive mode on or off as requested. |
2148 | (let* ((case-fold-search t) | |
2149 | (passive | |
2150 | (or (assoc-default host ange-ftp-passive-host-alist | |
2151 | 'string-match) | |
2152 | (if ange-ftp-try-passive-mode "on")))) | |
2153 | (if passive | |
31bcb0dc | 2154 | (ange-ftp-passive-mode proc passive))) |
8749abea GM |
2155 | |
2156 | ;; Run any user-specified hooks. Note that proc, host and user are | |
2157 | ;; dynamically bound at this point. | |
e3441f42 SM |
2158 | (let ((ange-ftp-this-user user) |
2159 | (ange-ftp-this-host host)) | |
2160 | (run-hooks 'ange-ftp-process-startup-hook))) | |
8749abea GM |
2161 | proc))) |
2162 | ||
31bcb0dc | 2163 | (defun ange-ftp-passive-mode (proc on-or-off) |
1d0653f8 RS |
2164 | (if (string-match (concat "Passive mode " on-or-off) |
2165 | (cdr (ange-ftp-raw-send-cmd | |
2166 | proc (concat "passive " on-or-off) | |
2167 | "Trying passive mode..." nil))) | |
2168 | (ange-ftp-message (concat "Trying passive mode..." on-or-off)) | |
2169 | (error "Trying passive mode...failed"))) | |
2170 | ||
8749abea GM |
2171 | ;; Variables for caching host and host-type |
2172 | (defvar ange-ftp-host-cache nil) | |
2173 | (defvar ange-ftp-host-type-cache nil) | |
2174 | ||
2175 | ;; If ange-ftp-host-type is called with the optional user | |
2176 | ;; argument, it will attempt to guess the host type by connecting | |
2177 | ;; as user, if necessary. For efficiency, I have tried to give this | |
2178 | ;; optional second argument only when necessary. Have I missed any calls | |
2179 | ;; to ange-ftp-host-type where it should have been supplied? | |
2180 | ||
2181 | (defun ange-ftp-host-type (host &optional user) | |
2182 | "Return a symbol which represents the type of the HOST given. | |
2183 | If the optional argument USER is given, attempts to guess the | |
2184 | host-type by logging in as USER." | |
2185 | (cond ((null host) 'unix) | |
2186 | ;; Return `unix' if HOST is nil, since that's the most vanilla | |
2187 | ;; possible return value. | |
2188 | ((eq host ange-ftp-host-cache) | |
2189 | ange-ftp-host-type-cache) | |
2190 | ;; Trigger an ftp connection, in case we need to guess at the host type. | |
2191 | ((and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache)) | |
2192 | ange-ftp-host-type-cache) | |
2193 | (t | |
2194 | (setq ange-ftp-host-cache host | |
2195 | ange-ftp-host-type-cache | |
2196 | (cond ((ange-ftp-dumb-unix-host host) | |
2197 | 'dumb-unix) | |
2198 | ;; ((and (fboundp 'ange-ftp-vos-host) | |
2199 | ;; (ange-ftp-vos-host host)) | |
2200 | ;; 'vos) | |
2201 | ((and (fboundp 'ange-ftp-vms-host) | |
2202 | (ange-ftp-vms-host host)) | |
2203 | 'vms) | |
2204 | ((and (fboundp 'ange-ftp-mts-host) | |
2205 | (ange-ftp-mts-host host)) | |
2206 | 'mts) | |
2207 | ((and (fboundp 'ange-ftp-cms-host) | |
2208 | (ange-ftp-cms-host host)) | |
2209 | 'cms) | |
9c35d706 RS |
2210 | ((and (fboundp 'ange-ftp-bs2000-posix-host) |
2211 | (ange-ftp-bs2000-posix-host host)) | |
2212 | 'text-unix) ; POSIX is a non-ASCII Unix | |
2213 | ((and (fboundp 'ange-ftp-bs2000-host) | |
2214 | (ange-ftp-bs2000-host host)) | |
2215 | 'bs2000) | |
8749abea GM |
2216 | (t |
2217 | 'unix)))))) | |
2218 | ||
2219 | ;; It would be nice to abstract the functions ange-ftp-TYPE-host and | |
2220 | ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions | |
2221 | ;; without sacrificing speed. Also, having separate variables | |
2222 | ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to | |
2223 | ;; set an alist to indicate that a host is of a given type. Even with | |
2224 | ;; automatic host type recognition, setting a regexp is still a good idea | |
2225 | ;; (for efficiency) if you log into a particular non-UNIX host frequently. | |
2226 | ||
2227 | (defvar ange-ftp-fix-name-func-alist nil | |
2228 | "Alist saying how to convert file name to the host's syntax. | |
4671dba5 JB |
2229 | Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can |
2230 | change a UNIX file name into a name more suitable for a host of type TYPE.") | |
8749abea GM |
2231 | |
2232 | (defvar ange-ftp-fix-dir-name-func-alist nil | |
2233 | "Alist saying how to convert directory name to the host's syntax. | |
4671dba5 JB |
2234 | Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can |
2235 | change UNIX directory name into a directory name more suitable for a host | |
2236 | of type TYPE.") | |
8749abea GM |
2237 | |
2238 | ;; *** Perhaps the sense of this variable should be inverted, since there | |
2239 | ;; *** is only 1 host type that can take ls-style listing options. | |
2240 | (defvar ange-ftp-dumb-host-types '(dumb-unix) | |
2241 | "List of host types that can't take UNIX ls-style listing options.") | |
2242 | ||
2243 | (defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait) | |
4671dba5 | 2244 | "Find an FTP process connected to HOST logged in as USER and send it CMD. |
8749abea GM |
2245 | MSG is an optional status message to be output before and after issuing the |
2246 | command. | |
25759a92 | 2247 | See the documentation for `ange-ftp-raw-send-cmd' for a description of CONT |
8749abea GM |
2248 | and NOWAIT." |
2249 | ;; Handle conversion to remote file name syntax and remote ls option | |
2250 | ;; capability. | |
2251 | (let ((cmd0 (car cmd)) | |
2252 | (cmd1 (nth 1 cmd)) | |
2253 | (ange-ftp-this-user user) | |
2254 | (ange-ftp-this-host host) | |
2255 | (ange-ftp-this-msg msg) | |
67f300f8 | 2256 | cmd2 cmd3 host-type fix-name-func result) |
8749abea GM |
2257 | |
2258 | (cond | |
25759a92 | 2259 | |
8749abea GM |
2260 | ;; pwd case (We don't care what host-type.) |
2261 | ((null cmd1)) | |
25759a92 | 2262 | |
8749abea GM |
2263 | ;; cmd == 'dir "remote-name" "local-name" "ls-switches" |
2264 | ((progn | |
2265 | (setq cmd2 (nth 2 cmd) | |
2266 | host-type (ange-ftp-host-type host user)) | |
2267 | ;; This will trigger an FTP login, if one doesn't exist | |
2268 | (eq cmd0 'dir)) | |
2269 | (setq cmd1 (funcall | |
2270 | (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist)) | |
2271 | 'identity) | |
2272 | cmd1) | |
2273 | cmd3 (nth 3 cmd)) | |
ae0bec0b SM |
2274 | ;; Need to deal with the HP-UX ftp bug. This should also allow us to |
2275 | ;; resolve symlinks to directories on SysV machines. (Sebastian will | |
8749abea GM |
2276 | ;; be happy.) |
2277 | (and (eq host-type 'unix) | |
aa6f7b96 | 2278 | (string-match "/\\'" cmd1) |
8749abea GM |
2279 | (not (string-match "R" cmd3)) |
2280 | (setq cmd1 (concat cmd1 "."))) | |
2281 | ||
b63f6e81 SM |
2282 | ;; Using "ls -flags foo" has several problems: |
2283 | ;; - if foo is a symlink, we may get a single line showing the symlink | |
2284 | ;; rather than the listing of the directory it points to. | |
2285 | ;; - if "foo" has spaces, the parsing of the command may be done wrong. | |
2286 | ;; - some version of netbsd's ftpd only accept a single argument after | |
2287 | ;; `ls', which can either be the directory or the flags. | |
2288 | ;; So to work around those problems, we use "cd foo; ls -flags". | |
2289 | ||
8749abea GM |
2290 | ;; If the dir name contains a space, some ftp servers will |
2291 | ;; refuse to list it. We instead change directory to the | |
2292 | ;; directory in question and ls ".". | |
2293 | (when (string-match " " cmd1) | |
67f300f8 SM |
2294 | ;; Keep the result. In case of failure, we will (see below) |
2295 | ;; short-circuit CMD and return this result directly. | |
2296 | (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror)) | |
8749abea GM |
2297 | (setq cmd1 ".")) |
2298 | ||
2299 | ;; If the remote ls can take switches, put them in | |
7ca26b02 SM |
2300 | (unless (memq host-type ange-ftp-dumb-host-types) |
2301 | (setq cmd0 'ls) | |
2302 | ;; We cd and then use `ls' with no directory argument. | |
aa6f7b96 SM |
2303 | ;; This works around a misfeature of some versions of netbsd ftpd |
2304 | ;; where `ls' can only take one argument: either one set of flags | |
2305 | ;; or a file/directory name. | |
3bd1644e | 2306 | ;; If we're trying to `ls' a single file, this fails since we |
aa6f7b96 SM |
2307 | ;; can't cd to a file. We can't fix this problem here, tho, because |
2308 | ;; at this point we don't know whether the argument is a file or | |
3bd1644e | 2309 | ;; a directory. Such an `ls' is only ever used (apparently) from |
aa6f7b96 SM |
2310 | ;; `insert-directory' when the `full-directory-p' argument is nil |
2311 | ;; (which seems to only be used by dired when updating its display | |
3bd1644e SM |
2312 | ;; after operating on a set of files). So we've changed |
2313 | ;; `ange-ftp-insert-directory' such that in this case it gets | |
aa6f7b96 SM |
2314 | ;; a full listing of the directory and extracting the line |
2315 | ;; corresponding to the requested file. | |
7ca26b02 | 2316 | (unless (equal cmd1 ".") |
aa6f7b96 SM |
2317 | (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror))) |
2318 | (setq cmd1 cmd3))) | |
25759a92 | 2319 | |
8749abea GM |
2320 | ;; First argument is the remote name |
2321 | ((progn | |
2322 | (setq fix-name-func (or (cdr (assq host-type | |
2323 | ange-ftp-fix-name-func-alist)) | |
2324 | 'identity)) | |
2325 | (memq cmd0 '(get delete mkdir rmdir cd))) | |
2326 | (setq cmd1 (funcall fix-name-func cmd1))) | |
2327 | ||
2328 | ;; Second argument is the remote name | |
cfc3aed3 | 2329 | ((or (memq cmd0 '(append put chmod)) |
412707c2 | 2330 | (and (eq cmd0 'quote) (member cmd1 '("mdtm" "size")))) |
8749abea | 2331 | (setq cmd2 (funcall fix-name-func cmd2))) |
8749abea GM |
2332 | ;; Both arguments are remote names |
2333 | ((eq cmd0 'rename) | |
2334 | (setq cmd1 (funcall fix-name-func cmd1) | |
2335 | cmd2 (funcall fix-name-func cmd2)))) | |
25759a92 SS |
2336 | |
2337 | ;; Turn the command into one long string | |
8749abea GM |
2338 | (setq cmd0 (symbol-name cmd0)) |
2339 | (setq cmd (concat cmd0 | |
2340 | (and cmd1 (concat " " cmd1)) | |
2341 | (and cmd2 (concat " " cmd2)))) | |
2342 | ||
2343 | ;; Actually send the resulting command. | |
67f300f8 SM |
2344 | (if (and (consp result) (null (car result))) |
2345 | ;; `ange-ftp-cd' has failed, so there's no point sending `cmd'. | |
2346 | result | |
2347 | (let (afsc-result | |
2348 | afsc-line) | |
2349 | (ange-ftp-raw-send-cmd | |
2350 | (ange-ftp-get-process host user) | |
2351 | cmd | |
2352 | msg | |
2353 | (list (lambda (result line host user cmd msg cont nowait) | |
2354 | (or cont (setq afsc-result result | |
2355 | afsc-line line)) | |
2356 | (if result (ange-ftp-call-cont cont result line) | |
25759a92 SS |
2357 | (ange-ftp-raw-send-cmd |
2358 | (ange-ftp-get-process host user) | |
2359 | cmd | |
2360 | msg | |
2361 | (list (lambda (result line cont) | |
2362 | (or cont (setq afsc-result result | |
2363 | afsc-line line)) | |
2364 | (ange-ftp-call-cont cont result line)) | |
67f300f8 SM |
2365 | cont) |
2366 | nowait))) | |
2367 | host user cmd msg cont nowait) | |
2368 | nowait) | |
2369 | ||
2370 | (if nowait | |
8749abea | 2371 | nil |
67f300f8 SM |
2372 | (if cont |
2373 | nil | |
2374 | (cons afsc-result afsc-line))))))) | |
8749abea GM |
2375 | |
2376 | ;; It might be nice to message users about the host type identified, | |
2377 | ;; but there is so much other messaging going on, it would not be | |
2378 | ;; seen. No point in slowing things down just so users can read | |
2379 | ;; a host type message. | |
2380 | ||
2381 | (defconst ange-ftp-cms-name-template | |
2382 | (concat | |
2383 | "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?" | |
2384 | "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$")) | |
2385 | (defconst ange-ftp-vms-name-template | |
2386 | "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$") | |
2387 | (defconst ange-ftp-mts-name-template | |
2388 | "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$") | |
9c35d706 RS |
2389 | (defconst ange-ftp-bs2000-filename-pubset-regexp |
2390 | ":[A-Z0-9]+:" | |
2391 | "Valid pubset for an BS2000 file name.") | |
2392 | (defconst ange-ftp-bs2000-filename-username-regexp | |
2393 | (concat | |
2394 | "\\$[A-Z0-9]*\\.") | |
2395 | "Valid username for an BS2000 file name.") | |
2396 | (defconst ange-ftp-bs2000-filename-prefix-regexp | |
2397 | (concat | |
2398 | ange-ftp-bs2000-filename-pubset-regexp | |
2399 | ange-ftp-bs2000-filename-username-regexp) | |
2400 | "Valid prefix for an BS2000 file name (pubset and user).") | |
2401 | (defconst ange-ftp-bs2000-name-template | |
2402 | (concat "^" ange-ftp-bs2000-filename-prefix-regexp "$")) | |
8749abea GM |
2403 | |
2404 | (defun ange-ftp-guess-host-type (host user) | |
110c171f | 2405 | "Guess the host type of HOST. |
8749abea GM |
2406 | Works by doing a pwd and examining the directory syntax." |
2407 | (let ((host-type (ange-ftp-host-type host)) | |
2408 | (key (concat host "/" user "/~"))) | |
2409 | (if (eq host-type 'unix) | |
2410 | ;; Note that ange-ftp-host-type returns unix as the default value. | |
2411 | (save-match-data | |
2412 | (let* ((result (ange-ftp-get-pwd host user)) | |
2413 | (dir (car result)) | |
2414 | fix-name-func) | |
2415 | (cond ((null dir) | |
2416 | (message "Warning! Unable to get home directory") | |
2417 | (sit-for 1) | |
2418 | (if (string-match | |
2419 | "^450 No current working directory defined$" | |
2420 | (cdr result)) | |
25759a92 | 2421 | |
8749abea GM |
2422 | ;; We'll assume that if pwd bombs with this |
2423 | ;; error message, then it's CMS. | |
2424 | (progn | |
2425 | (ange-ftp-add-cms-host host) | |
2426 | (setq ange-ftp-host-cache host | |
2427 | ange-ftp-host-type-cache 'cms)))) | |
2428 | ||
2429 | ;; try for VMS | |
2430 | ((string-match ange-ftp-vms-name-template dir) | |
2431 | (ange-ftp-add-vms-host host) | |
2432 | ;; The add-host functions clear the host type cache. | |
2433 | ;; Therefore, need to set the cache afterwards. | |
2434 | (setq ange-ftp-host-cache host | |
2435 | ange-ftp-host-type-cache 'vms)) | |
2436 | ||
2437 | ;; try for MTS | |
2438 | ((string-match ange-ftp-mts-name-template dir) | |
2439 | (ange-ftp-add-mts-host host) | |
2440 | (setq ange-ftp-host-cache host | |
2441 | ange-ftp-host-type-cache 'mts)) | |
25759a92 | 2442 | |
8749abea GM |
2443 | ;; try for CMS |
2444 | ((string-match ange-ftp-cms-name-template dir) | |
2445 | (ange-ftp-add-cms-host host) | |
2446 | (setq ange-ftp-host-cache host | |
2447 | ange-ftp-host-type-cache 'cms)) | |
2448 | ||
9c35d706 RS |
2449 | ;; try for BS2000-POSIX |
2450 | ((ange-ftp-bs2000-posix-host host) | |
2451 | (ange-ftp-add-bs2000-host host) | |
2452 | (setq ange-ftp-host-cache host | |
2453 | ange-ftp-host-type-cache 'text-unix)) | |
2454 | ;; try for BS2000 | |
2455 | ((and (string-match ange-ftp-bs2000-name-template dir) | |
2456 | (not (ange-ftp-bs2000-posix-host host))) | |
2457 | (ange-ftp-add-bs2000-host host) | |
2458 | (setq ange-ftp-host-cache host | |
2459 | ange-ftp-host-type-cache 'bs2000)) | |
8749abea GM |
2460 | ;; assume UN*X |
2461 | (t | |
2462 | (setq ange-ftp-host-cache host | |
2463 | ange-ftp-host-type-cache 'unix))) | |
2464 | ||
2465 | ;; Now that we have done a pwd, might as well put it in | |
2466 | ;; the expand-dir hashtable. | |
2467 | (let ((ange-ftp-this-user user) | |
2468 | (ange-ftp-this-host host)) | |
2469 | (setq fix-name-func (cdr (assq ange-ftp-host-type-cache | |
2470 | ange-ftp-fix-name-func-alist))) | |
2471 | (if fix-name-func | |
2472 | (setq dir (funcall fix-name-func dir 'reverse)))) | |
6e85ef5f | 2473 | (puthash key dir ange-ftp-expand-dir-hashtable)))) |
8749abea GM |
2474 | |
2475 | ;; In the special case of CMS make sure that know the | |
2476 | ;; expansion of the home minidisk now, because we will | |
2477 | ;; be doing a lot of cd's. | |
2478 | (if (and (eq host-type 'cms) | |
2479 | (not (ange-ftp-hash-entry-exists-p | |
2480 | key ange-ftp-expand-dir-hashtable))) | |
2481 | (let ((dir (car (ange-ftp-get-pwd host user)))) | |
2482 | (if dir | |
6e85ef5f | 2483 | (puthash key (concat "/" dir) ange-ftp-expand-dir-hashtable) |
8749abea GM |
2484 | (message "Warning! Unable to get home directory") |
2485 | (sit-for 1)))))) | |
2486 | ||
2487 | \f | |
2488 | ;;;; ------------------------------------------------------------ | |
2489 | ;;;; Remote file and directory listing support. | |
2490 | ;;;; ------------------------------------------------------------ | |
2491 | ||
2492 | ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands | |
2493 | ;; to take switch arguments. | |
2494 | (defun ange-ftp-dumb-unix-host (host) | |
2495 | (and host ange-ftp-dumb-unix-host-regexp | |
4671dba5 | 2496 | (string-match-p ange-ftp-dumb-unix-host-regexp host))) |
8749abea GM |
2497 | |
2498 | (defun ange-ftp-add-dumb-unix-host (host) | |
4671dba5 | 2499 | "Interactively add a given HOST to `ange-ftp-dumb-unix-host-regexp'." |
8749abea GM |
2500 | (interactive |
2501 | (list (read-string "Host: " | |
2502 | (let ((name (or (buffer-file-name) default-directory))) | |
2503 | (and name (car (ange-ftp-ftp-name name))))))) | |
2504 | (if (not (ange-ftp-dumb-unix-host host)) | |
2505 | (setq ange-ftp-dumb-unix-host-regexp | |
2506 | (concat "^" (regexp-quote host) "$" | |
2507 | (and ange-ftp-dumb-unix-host-regexp "\\|") | |
2508 | ange-ftp-dumb-unix-host-regexp) | |
2509 | ange-ftp-host-cache nil))) | |
2510 | ||
2511 | (defvar ange-ftp-parse-list-func-alist nil | |
2512 | "Alist saying how to parse directory listings for certain OS types. | |
4671dba5 JB |
2513 | Association list of (TYPE . FUNC) pairs. The FUNC is a routine which |
2514 | can parse the output from a DIR listing for a host of type TYPE.") | |
8749abea GM |
2515 | |
2516 | ;; With no-error nil, this function returns: | |
2517 | ;; an error if file is not an ange-ftp-name | |
25759a92 | 2518 | ;; (This should never happen.) |
8749abea GM |
2519 | ;; an error if either the listing is unreadable or there is an ftp error. |
2520 | ;; the listing (a string), if everything works. | |
25759a92 | 2521 | ;; |
8749abea GM |
2522 | ;; With no-error t, it returns: |
2523 | ;; an error if not an ange-ftp-name | |
2524 | ;; error if listing is unreadable (most likely caused by a slow connection) | |
2525 | ;; nil if ftp error (this is because although asking to list a nonexistent | |
2526 | ;; directory on a remote unix machine usually (except | |
2527 | ;; maybe for dumb hosts) returns an ls error, but no | |
2528 | ;; ftp error, if the same is done on a VMS machine, | |
2529 | ;; an ftp error is returned. Need to trap the error | |
2530 | ;; so we can go on and try to list the parent.) | |
2531 | ;; the listing, if everything works. | |
2532 | ||
2533 | ;; If WILDCARD is non-nil, then this implements the guts of insert-directory | |
2534 | ;; in the wildcard case. Then we make a relative directory listing | |
2535 | ;; of FILE within the directory specified by `default-directory'. | |
2536 | ||
2537 | (defvar ange-ftp-before-parse-ls-hook nil | |
4671dba5 | 2538 | "Normal hook run before parsing the text of an FTP directory listing.") |
8749abea | 2539 | |
a724ed38 | 2540 | (defvar ange-ftp-after-parse-ls-hook nil |
4671dba5 | 2541 | "Normal hook run after parsing the text of an FTP directory listing.") |
a724ed38 | 2542 | |
8749abea | 2543 | (defun ange-ftp-ls (file lsargs parse &optional no-error wildcard) |
4671dba5 | 2544 | "Return the output of a `DIR' or `ls' command done over FTP. |
8749abea GM |
2545 | FILE is the full name of the remote file, LSARGS is any args to pass to the |
2546 | `ls' command, and PARSE specifies that the output should be parsed and stored | |
2547 | away in the internal cache." | |
1fc85dae KG |
2548 | (when (string-match "^--dired\\s-+" lsargs) |
2549 | (setq lsargs (replace-match "" nil t lsargs))) | |
8749abea GM |
2550 | ;; If parse is t, we assume that file is a directory. i.e. we only parse |
2551 | ;; full directory listings. | |
2552 | (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file)) | |
2553 | (parsed (ange-ftp-ftp-name ange-ftp-this-file))) | |
2554 | (if parsed | |
2555 | (let* ((host (nth 0 parsed)) | |
2556 | (user (nth 1 parsed)) | |
2557 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
2558 | (key (directory-file-name ange-ftp-this-file)) | |
2559 | (host-type (ange-ftp-host-type host user)) | |
2560 | (dumb (memq host-type ange-ftp-dumb-host-types)) | |
2561 | result | |
2562 | temp | |
2563 | lscmd parse-func) | |
2564 | (if (string-equal name "") | |
2565 | (setq name | |
2566 | (ange-ftp-real-file-name-as-directory | |
6e85ef5f | 2567 | (ange-ftp-expand-dir host user "~")))) |
8749abea GM |
2568 | (if (and ange-ftp-ls-cache-file |
2569 | (string-equal key ange-ftp-ls-cache-file) | |
2570 | ;; Don't care about lsargs for dumb hosts. | |
2571 | (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs))) | |
2572 | ange-ftp-ls-cache-res | |
2573 | (setq temp (ange-ftp-make-tmp-name host)) | |
2574 | (if wildcard | |
2575 | (progn | |
2576 | (ange-ftp-cd host user (file-name-directory name)) | |
06531fc3 | 2577 | (setq lscmd (list 'ls file temp lsargs))) |
8749abea GM |
2578 | (setq lscmd (list 'dir name temp lsargs))) |
2579 | (unwind-protect | |
2580 | (if (car (setq result (ange-ftp-send-cmd | |
2581 | host | |
2582 | user | |
2583 | lscmd | |
2584 | (format "Listing %s" | |
2585 | (ange-ftp-abbreviate-filename | |
2586 | ange-ftp-this-file))))) | |
b63f6e81 | 2587 | (with-current-buffer (get-buffer-create |
c7bef55f | 2588 | ange-ftp-data-buffer-name) |
8749abea GM |
2589 | (erase-buffer) |
2590 | (if (ange-ftp-real-file-readable-p temp) | |
2591 | (ange-ftp-real-insert-file-contents temp) | |
2592 | (sleep-for ange-ftp-retry-time) | |
2593 | ;wait for file to possibly appear | |
2594 | (if (ange-ftp-real-file-readable-p temp) | |
2595 | ;; Try again. | |
2596 | (ange-ftp-real-insert-file-contents temp) | |
2597 | (ange-ftp-error host user | |
2598 | (format | |
2599 | "list data file %s not readable" | |
2600 | temp)))) | |
9d453139 SS |
2601 | ;; remove ^M inserted by the win32 ftp client |
2602 | (while (re-search-forward "\r$" nil t) | |
2603 | (replace-match "")) | |
2604 | (goto-char 1) | |
8749abea GM |
2605 | (run-hooks 'ange-ftp-before-parse-ls-hook) |
2606 | (if parse | |
2607 | (ange-ftp-set-files | |
2608 | ange-ftp-this-file | |
2609 | (if (setq | |
2610 | parse-func | |
2611 | (cdr (assq host-type | |
2612 | ange-ftp-parse-list-func-alist))) | |
2613 | (funcall parse-func) | |
2614 | (ange-ftp-parse-dired-listing lsargs)))) | |
a724ed38 GM |
2615 | ;; Place this hook here to convert the contents of the |
2616 | ;; buffer to a ls compatible format if the host system | |
2617 | ;; that is being queried is other than Unix i.e. VMS | |
2618 | ;; returns an ls format that really sucks. | |
2619 | (run-hooks 'ange-ftp-after-parse-ls-hook) | |
8749abea GM |
2620 | (setq ange-ftp-ls-cache-file key |
2621 | ange-ftp-ls-cache-lsargs lsargs | |
2622 | ; For dumb hosts-types this is | |
2623 | ; meaningless but harmless. | |
2624 | ange-ftp-ls-cache-res (buffer-string)) | |
2625 | ;; (kill-buffer (current-buffer)) | |
67f300f8 SM |
2626 | (if (equal ange-ftp-ls-cache-res "total 0\n") |
2627 | ;; wu-ftpd seems to return a successful result | |
2628 | ;; with an empty file-listing when doing a | |
2629 | ;; `DIR /some/file/.' which leads ange-ftp to | |
2630 | ;; believe that /some/file is a directory ;-( | |
2631 | nil | |
2632 | ange-ftp-ls-cache-res)) | |
8749abea GM |
2633 | (if no-error |
2634 | nil | |
2635 | (ange-ftp-error host user | |
2636 | (concat "DIR failed: " (cdr result))))) | |
2637 | (ange-ftp-del-tmp-name temp)))) | |
2638 | (error "Should never happen. Please report. Bug ref. no.: 1")))) | |
2639 | \f | |
2640 | ;;;; ------------------------------------------------------------ | |
2641 | ;;;; Directory information caching support. | |
2642 | ;;;; ------------------------------------------------------------ | |
2643 | ||
8749abea GM |
2644 | (defvar ange-ftp-add-file-entry-alist nil |
2645 | "Alist saying how to add file entries on certain OS types. | |
4671dba5 JB |
2646 | Association list of pairs (TYPE . FUNC), where FUNC is a function |
2647 | to be used to add a file entry for the OS TYPE. | |
2648 | The main reason for this alist is to deal with file versions in VMS.") | |
8749abea GM |
2649 | |
2650 | (defvar ange-ftp-delete-file-entry-alist nil | |
2651 | "Alist saying how to delete files on certain OS types. | |
4671dba5 JB |
2652 | Association list of pairs (TYPE . FUNC), where FUNC is a function |
2653 | to be used to delete a file entry for the OS TYPE. | |
8749abea GM |
2654 | The main reason for this alist is to deal with file versions in VMS.") |
2655 | ||
2656 | (defun ange-ftp-add-file-entry (name &optional dir-p) | |
2657 | "Add a file entry for file NAME, if its directory info exists." | |
2658 | (funcall (or (cdr (assq (ange-ftp-host-type | |
2659 | (car (ange-ftp-ftp-name name))) | |
2660 | ange-ftp-add-file-entry-alist)) | |
2661 | 'ange-ftp-internal-add-file-entry) | |
2662 | name dir-p) | |
2663 | (setq ange-ftp-ls-cache-file nil)) | |
2664 | ||
2665 | (defun ange-ftp-delete-file-entry (name &optional dir-p) | |
2666 | "Delete the file entry for file NAME, if its directory info exists." | |
2667 | (funcall (or (cdr (assq (ange-ftp-host-type | |
2668 | (car (ange-ftp-ftp-name name))) | |
2669 | ange-ftp-delete-file-entry-alist)) | |
2670 | 'ange-ftp-internal-delete-file-entry) | |
2671 | name dir-p) | |
2672 | (setq ange-ftp-ls-cache-file nil)) | |
2673 | ||
2674 | (defmacro ange-ftp-parse-filename () | |
2675 | ;;Extract the filename from the current line of a dired-like listing. | |
f06dbf7e MA |
2676 | `(save-match-data |
2677 | (let ((eol (progn (end-of-line) (point)))) | |
2678 | (beginning-of-line) | |
2679 | (if (re-search-forward directory-listing-before-filename-regexp eol t) | |
2680 | (buffer-substring (point) eol))))) | |
25759a92 | 2681 | |
8749abea GM |
2682 | ;; This deals with the F switch. Should also do something about |
2683 | ;; unquoting names obtained with the SysV b switch and the GNU Q | |
2684 | ;; switch. See Sebastian's dired-get-filename. | |
2685 | ||
e3441f42 | 2686 | (defun ange-ftp-ls-parser (switches) |
8749abea | 2687 | ;; Meant to be called by ange-ftp-parse-dired-listing |
6e85ef5f | 2688 | (let ((tbl (make-hash-table :test 'equal)) |
c8607dc7 SM |
2689 | (used-F (and (stringp switches) |
2690 | (string-match "F" switches))) | |
2691 | file-type symlink directory file) | |
2692 | (while (setq file (ange-ftp-parse-filename)) | |
2693 | (beginning-of-line) | |
2694 | (skip-chars-forward "\t 0-9") | |
2695 | (setq file-type (following-char) | |
2696 | directory (eq file-type ?d)) | |
2697 | (if (eq file-type ?l) | |
2698 | (let ((end (string-match " -> " file))) | |
2699 | (if end | |
2700 | ;; Sometimes `ls' appends a @ at the end of the target. | |
2701 | (setq symlink (substring file (match-end 0) | |
2702 | (string-match "@\\'" file)) | |
2703 | file (substring file 0 end)) | |
2704 | ;; Shouldn't happen | |
2705 | (setq symlink ""))) | |
2706 | (setq symlink nil)) | |
2707 | ;; Only do a costly regexp search if the F switch was used. | |
2708 | (if (and used-F | |
2709 | (not (string-equal file "")) | |
2710 | (looking-at | |
2711 | ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)")) | |
2712 | (let ((socket (eq file-type ?s)) | |
2713 | (executable | |
2714 | (and (not symlink) ; x bits don't mean a thing for symlinks | |
2715 | (string-match | |
2716 | "[xst]" | |
e3441f42 SM |
2717 | (concat (match-string 1) |
2718 | (match-string 2) | |
2719 | (match-string 3)))))) | |
c8607dc7 SM |
2720 | ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX) |
2721 | ;; and others don't. (sigh...) Beware, that some Unix's don't | |
2722 | ;; seem to believe in the F-switch | |
aa6f7b96 SM |
2723 | (if (or (and symlink (string-match "@\\'" file)) |
2724 | (and directory (string-match "/\\'" file)) | |
2725 | (and executable (string-match "*\\'" file)) | |
2726 | (and socket (string-match "=\\'" file))) | |
c8607dc7 | 2727 | (setq file (substring file 0 -1))))) |
6e85ef5f | 2728 | (puthash file (or symlink directory) tbl) |
c8607dc7 | 2729 | (forward-line 1)) |
6e85ef5f SM |
2730 | (puthash "." t tbl) |
2731 | (puthash ".." t tbl) | |
25759a92 | 2732 | tbl)) |
8749abea GM |
2733 | |
2734 | ;;; The dl stuff for descriptive listings | |
2735 | ||
2736 | (defvar ange-ftp-dl-dir-regexp nil | |
2737 | "Regexp matching directories which are listed in dl format. | |
2738 | This regexp should not be anchored with a trailing `$', because it should | |
2739 | match subdirectories as well.") | |
2740 | ||
2741 | (defun ange-ftp-add-dl-dir (dir) | |
4671dba5 | 2742 | "Interactively add a DIR to `ange-ftp-dl-dir-regexp'." |
8749abea GM |
2743 | (interactive |
2744 | (list (read-string "Directory: " | |
2745 | (let ((name (or (buffer-file-name) default-directory))) | |
2746 | (and name (ange-ftp-ftp-name name) | |
2747 | (file-name-directory name)))))) | |
2748 | (if (not (and ange-ftp-dl-dir-regexp | |
2749 | (string-match ange-ftp-dl-dir-regexp dir))) | |
2750 | (setq ange-ftp-dl-dir-regexp | |
2751 | (concat "^" (regexp-quote dir) | |
2752 | (and ange-ftp-dl-dir-regexp "\\|") | |
2753 | ange-ftp-dl-dir-regexp)))) | |
2754 | ||
2755 | (defmacro ange-ftp-dl-parser () | |
2756 | ;; Parse the current buffer, which is assumed to be a descriptive | |
2757 | ;; listing, and return a hashtable. | |
6e85ef5f | 2758 | `(let ((tbl (make-hash-table :test 'equal))) |
25759a92 | 2759 | (while (not (eobp)) |
6e85ef5f | 2760 | (puthash |
25759a92 SS |
2761 | (buffer-substring (point) |
2762 | (progn | |
2763 | (skip-chars-forward "^ /\n") | |
2764 | (point))) | |
2765 | (eq (following-char) ?/) | |
2766 | tbl) | |
2767 | (forward-line 1)) | |
6e85ef5f SM |
2768 | (puthash "." t tbl) |
2769 | (puthash ".." t tbl) | |
2770 | tbl)) | |
8749abea GM |
2771 | |
2772 | ;; Parse the current buffer which is assumed to be in a dired-like listing | |
2773 | ;; format, and return a hashtable as the result. If the listing is not really | |
2774 | ;; a listing, then return nil. | |
2775 | ||
2776 | (defun ange-ftp-parse-dired-listing (&optional switches) | |
2777 | (save-match-data | |
2778 | (cond | |
2779 | ((looking-at "^total [0-9]+$") | |
2780 | (forward-line 1) | |
2781 | ;; Some systems put in a blank line here. | |
2782 | (if (eolp) (forward-line 1)) | |
e3441f42 | 2783 | (ange-ftp-ls-parser switches)) |
8749abea GM |
2784 | ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'") |
2785 | ;; It's an ls error message. | |
2786 | nil) | |
2787 | ((eobp) ; i.e. (zerop (buffer-size)) | |
2788 | ;; This could be one of: | |
2789 | ;; (1) An Ultrix ls error message | |
2790 | ;; (2) A listing with the A switch of an empty directory | |
2791 | ;; on a machine which doesn't give a total line. | |
2792 | ;; (3) The twilight zone. | |
2793 | ;; We'll assume (1) for now. | |
2794 | nil) | |
9bc260cf | 2795 | ((re-search-forward directory-listing-before-filename-regexp nil t) |
8749abea | 2796 | (beginning-of-line) |
e3441f42 | 2797 | (ange-ftp-ls-parser switches)) |
8749abea GM |
2798 | ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t) |
2799 | ;; It's a dl listing (I hope). | |
2800 | ;; file is bound by the call to ange-ftp-ls | |
2801 | (ange-ftp-add-dl-dir ange-ftp-this-file) | |
2802 | (beginning-of-line) | |
2803 | (ange-ftp-dl-parser)) | |
2804 | (t nil)))) | |
2805 | ||
2806 | (defun ange-ftp-set-files (directory files) | |
2807 | "For a given DIRECTORY, set or change the associated FILES hashtable." | |
6e85ef5f SM |
2808 | (and files (puthash (file-name-as-directory directory) |
2809 | files ange-ftp-files-hashtable))) | |
8749abea GM |
2810 | |
2811 | (defun ange-ftp-get-files (directory &optional no-error) | |
4671dba5 | 2812 | "Given a DIRECTORY, return a hashtable of file entries. |
8749abea GM |
2813 | This will give an error or return nil, depending on the value of |
2814 | NO-ERROR, if a listing for DIRECTORY cannot be obtained." | |
2815 | (setq directory (file-name-as-directory directory)) ;normalize | |
6e85ef5f | 2816 | (or (gethash directory ange-ftp-files-hashtable) |
8749abea GM |
2817 | (save-match-data |
2818 | (and (ange-ftp-ls directory | |
2819 | ;; This is an efficiency hack. We try to | |
2820 | ;; anticipate what sort of listing dired | |
2821 | ;; might want, and cache just such a listing. | |
2822 | (if (and (boundp 'dired-actual-switches) | |
2823 | (stringp dired-actual-switches) | |
2824 | ;; We allow the A switch, which lists | |
2825 | ;; all files except "." and "..". | |
2826 | ;; This is OK because we manually | |
2827 | ;; insert these entries | |
2828 | ;; in the hash table. | |
2829 | (string-match | |
2830 | "[aA]" dired-actual-switches) | |
2831 | (string-match | |
2832 | "l" dired-actual-switches) | |
2833 | (not (string-match | |
2834 | "R" dired-actual-switches))) | |
2835 | dired-actual-switches | |
2836 | (if (and (boundp 'dired-listing-switches) | |
2837 | (stringp dired-listing-switches) | |
2838 | (string-match | |
2839 | "[aA]" dired-listing-switches) | |
2840 | (string-match | |
2841 | "l" dired-listing-switches) | |
2842 | (not (string-match | |
2843 | "R" dired-listing-switches))) | |
2844 | dired-listing-switches | |
2845 | "-al")) | |
2846 | t no-error) | |
6e85ef5f | 2847 | (gethash directory ange-ftp-files-hashtable))))) |
8749abea GM |
2848 | |
2849 | ;; Given NAME, return the file part that can be used for looking up the | |
2850 | ;; file's entry in a hashtable. | |
2851 | (defmacro ange-ftp-get-file-part (name) | |
25759a92 SS |
2852 | `(let ((file (file-name-nondirectory ,name))) |
2853 | (if (string-equal file "") | |
e3441f42 | 2854 | "." |
25759a92 | 2855 | file))) |
8749abea GM |
2856 | |
2857 | ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are | |
2858 | ;; allowed to determine if NAME is a sub-directory by listing it directly, | |
2859 | ;; rather than listing its parent directory. This is used for efficiency so | |
2860 | ;; that a wasted listing is not done: | |
2861 | ;; 1. When looking for a .dired file in dired-x.el. | |
2862 | ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid | |
2863 | ;; subdirectory. This is of course an OS dependent judgement. | |
2864 | ||
e3441f42 | 2865 | (defvar dired-local-variables-file) |
8749abea | 2866 | (defmacro ange-ftp-allow-child-lookup (dir file) |
76a98a50 SM |
2867 | `(not |
2868 | (let* ((efile ,file) ; expand once. | |
2869 | (edir ,dir) | |
2870 | (parsed (ange-ftp-ftp-name edir)) | |
2871 | (host-type (ange-ftp-host-type | |
2872 | (car parsed)))) | |
2873 | (or | |
2874 | ;; Deal with dired | |
2875 | (and (boundp 'dired-local-variables-file) ; in the dired-x package | |
2876 | (stringp dired-local-variables-file) | |
2877 | (string-equal dired-local-variables-file efile)) | |
2878 | ;; No dots in dir names in vms. | |
2879 | (and (eq host-type 'vms) | |
2880 | (string-match "\\." efile)) | |
2881 | ;; No subdirs in mts of cms. | |
2882 | (and (memq host-type '(mts cms)) | |
2883 | (not (string-equal "/" (nth 2 parsed)))) | |
2884 | ;; No dots in pseudo-dir names in bs2000. | |
2885 | (and (eq host-type 'bs2000) | |
2886 | (string-match "\\." efile)))))) | |
8749abea GM |
2887 | |
2888 | (defun ange-ftp-file-entry-p (name) | |
2889 | "Given NAME, return whether there is a file entry for it." | |
2890 | (let* ((name (directory-file-name name)) | |
2891 | (dir (file-name-directory name)) | |
6e85ef5f | 2892 | (ent (gethash dir ange-ftp-files-hashtable)) |
8749abea GM |
2893 | (file (ange-ftp-get-file-part name))) |
2894 | (if ent | |
2895 | (ange-ftp-hash-entry-exists-p file ent) | |
2896 | (or (and (ange-ftp-allow-child-lookup dir file) | |
2897 | (setq ent (ange-ftp-get-files name t)) | |
2898 | ;; Try a child lookup. i.e. try to list file as a | |
2899 | ;; subdirectory of dir. This is a good idea because | |
2900 | ;; we may not have read permission for file's parent. Also, | |
2901 | ;; people tend to work down directory trees anyway. We use | |
2902 | ;; no-error ;; because if file does not exist as a subdir., | |
2903 | ;; then dumb hosts will give an ftp error. Smart unix hosts | |
2904 | ;; will simply send back the ls | |
2905 | ;; error message. | |
6e85ef5f | 2906 | (gethash "." ent)) |
8749abea | 2907 | ;; Child lookup failed, so try the parent. |
311f32fe DK |
2908 | (ange-ftp-hash-entry-exists-p |
2909 | file (ange-ftp-get-files dir 'no-error)))))) | |
8749abea GM |
2910 | |
2911 | (defun ange-ftp-get-file-entry (name) | |
2912 | "Given NAME, return the given file entry. | |
2913 | The entry will be either t for a directory, nil for a normal file, | |
4671dba5 | 2914 | or a string for a symlink. If the file isn't in the hashtable, |
8749abea GM |
2915 | this also returns nil." |
2916 | (let* ((name (directory-file-name name)) | |
2917 | (dir (file-name-directory name)) | |
6e85ef5f | 2918 | (ent (gethash dir ange-ftp-files-hashtable)) |
8749abea GM |
2919 | (file (ange-ftp-get-file-part name))) |
2920 | (if ent | |
6e85ef5f | 2921 | (gethash file ent) |
8749abea GM |
2922 | (or (and (ange-ftp-allow-child-lookup dir file) |
2923 | (setq ent (ange-ftp-get-files name t)) | |
6e85ef5f SM |
2924 | (gethash "." ent)) |
2925 | ;; i.e. it's a directory by child lookup | |
57199263 DK |
2926 | (and (setq ent (ange-ftp-get-files dir t)) |
2927 | (gethash file ent)))))) | |
8749abea GM |
2928 | |
2929 | (defun ange-ftp-internal-delete-file-entry (name &optional dir-p) | |
6e85ef5f SM |
2930 | (when dir-p |
2931 | (setq name (file-name-as-directory name)) | |
2932 | (remhash name ange-ftp-files-hashtable) | |
2933 | (setq name (directory-file-name name))) | |
8749abea GM |
2934 | ;; Note that file-name-as-directory followed by directory-file-name |
2935 | ;; serves to canonicalize directory file names to their unix form. | |
2936 | ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO | |
6e85ef5f | 2937 | (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable))) |
8749abea | 2938 | (if files |
6e85ef5f | 2939 | (remhash (ange-ftp-get-file-part name) files)))) |
8749abea GM |
2940 | |
2941 | (defun ange-ftp-internal-add-file-entry (name &optional dir-p) | |
2942 | (and dir-p | |
2943 | (setq name (directory-file-name name))) | |
6e85ef5f | 2944 | (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable))) |
8749abea | 2945 | (if files |
6e85ef5f | 2946 | (puthash (ange-ftp-get-file-part name) dir-p files)))) |
8749abea GM |
2947 | |
2948 | (defun ange-ftp-wipe-file-entries (host user) | |
2949 | "Get rid of entry for HOST, USER pair from file entry information hashtable." | |
6e85ef5f | 2950 | (let ((new-tbl (make-hash-table :test 'equal |
7adee48a DK |
2951 | :size (hash-table-size |
2952 | ange-ftp-files-hashtable)))) | |
6e85ef5f | 2953 | (maphash |
25759a92 SS |
2954 | (lambda (key val) |
2955 | (let ((parsed (ange-ftp-ftp-name key))) | |
2956 | (if parsed | |
2957 | (let ((h (nth 0 parsed)) | |
2958 | (u (nth 1 parsed))) | |
2959 | (or (and (equal host h) (equal user u)) | |
6e85ef5f | 2960 | (puthash key val new-tbl)))))) |
8749abea GM |
2961 | ange-ftp-files-hashtable) |
2962 | (setq ange-ftp-files-hashtable new-tbl))) | |
2963 | \f | |
2964 | ;;;; ------------------------------------------------------------ | |
2965 | ;;;; File transfer mode support. | |
2966 | ;;;; ------------------------------------------------------------ | |
2967 | ||
2968 | (defun ange-ftp-set-binary-mode (host user) | |
4671dba5 | 2969 | "Tell the FTP process for the given HOST & USER to switch to binary mode." |
412707c2 SM |
2970 | ;; FIXME: We should keep track of the current mode, so as to avoid |
2971 | ;; unnecessary roundtrips. | |
8749abea GM |
2972 | (let ((result (ange-ftp-send-cmd host user '(type "binary")))) |
2973 | (if (not (car result)) | |
2974 | (ange-ftp-error host user (concat "BINARY failed: " (cdr result))) | |
b63f6e81 | 2975 | (with-current-buffer (process-buffer (ange-ftp-get-process host user)) |
8749abea GM |
2976 | (and ange-ftp-binary-hash-mark-size |
2977 | (setq ange-ftp-hash-mark-unit | |
2978 | (ash ange-ftp-binary-hash-mark-size -4))))))) | |
2979 | ||
2980 | (defun ange-ftp-set-ascii-mode (host user) | |
4671dba5 | 2981 | "Tell the FTP process for the given HOST & USER to switch to ASCII mode." |
412707c2 SM |
2982 | ;; FIXME: We should keep track of the current mode, so as to avoid |
2983 | ;; unnecessary roundtrips. | |
8749abea GM |
2984 | (let ((result (ange-ftp-send-cmd host user '(type "ascii")))) |
2985 | (if (not (car result)) | |
2986 | (ange-ftp-error host user (concat "ASCII failed: " (cdr result))) | |
b63f6e81 | 2987 | (with-current-buffer (process-buffer (ange-ftp-get-process host user)) |
8749abea GM |
2988 | (and ange-ftp-ascii-hash-mark-size |
2989 | (setq ange-ftp-hash-mark-unit | |
2990 | (ash ange-ftp-ascii-hash-mark-size -4))))))) | |
2991 | \f | |
67f300f8 | 2992 | (defun ange-ftp-cd (host user dir &optional noerror) |
8749abea | 2993 | (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD"))) |
67f300f8 SM |
2994 | (if noerror result |
2995 | (or (car result) | |
2996 | (ange-ftp-error host user (concat "CD failed: " (cdr result))))))) | |
8749abea GM |
2997 | |
2998 | (defun ange-ftp-get-pwd (host user) | |
4671dba5 JB |
2999 | "Attempt to get the current working directory for the given HOST/USER pair. |
3000 | Returns (DIR . LINE) where DIR is either the directory or nil if not found, | |
8749abea GM |
3001 | and LINE is the relevant success or fail line from the FTP-client." |
3002 | (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD")) | |
3003 | (line (cdr result)) | |
3004 | dir) | |
3005 | (if (car result) | |
3006 | (save-match-data | |
3007 | (and (or (string-match "\"\\([^\"]*\\)\"" line) | |
e3441f42 SM |
3008 | (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers! |
3009 | (setq dir (match-string 1 line))))) | |
8749abea GM |
3010 | (cons dir line))) |
3011 | \f | |
3012 | ;;; ------------------------------------------------------------ | |
3013 | ;;; expand-file-name and friends...which currently don't work | |
3014 | ;;; ------------------------------------------------------------ | |
3015 | ||
3016 | (defun ange-ftp-expand-dir (host user dir) | |
3017 | "Return the result of doing a PWD in the current FTP session. | |
3018 | Use the connection to machine HOST | |
3019 | logged in as user USER and cd'd to directory DIR." | |
3020 | (let* ((host-type (ange-ftp-host-type host user)) | |
3021 | ;; It is more efficient to call ange-ftp-host-type | |
3022 | ;; before binding res, because ange-ftp-host-type sometimes | |
3023 | ;; adds to the info in the expand-dir-hashtable. | |
3024 | (fix-name-func | |
3025 | (cdr (assq host-type ange-ftp-fix-name-func-alist))) | |
3026 | (key (concat host "/" user "/" dir)) | |
6e85ef5f | 3027 | (res (gethash key ange-ftp-expand-dir-hashtable))) |
8749abea GM |
3028 | (or res |
3029 | (progn | |
3030 | (or | |
3031 | (string-equal user "anonymous") | |
3032 | (string-equal user "ftp") | |
3033 | (not (eq host-type 'unix)) | |
3034 | (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp | |
3035 | "\\|" | |
3036 | ange-ftp-good-msgs)) | |
3037 | (result (ange-ftp-send-cmd host user | |
3038 | (list 'get dir null-device) | |
3039 | (format "expanding %s" dir))) | |
3040 | (line (cdr result))) | |
3041 | (setq res | |
3042 | (if (string-match ange-ftp-expand-dir-regexp line) | |
e3441f42 | 3043 | (match-string 1 line))))) |
8749abea GM |
3044 | (or res |
3045 | (if (string-equal dir "~") | |
3046 | (setq res (car (ange-ftp-get-pwd host user))) | |
3047 | (let ((home (ange-ftp-expand-dir host user "~"))) | |
3048 | (unwind-protect | |
3049 | (and (ange-ftp-cd host user dir) | |
3050 | (setq res (car (ange-ftp-get-pwd host user)))) | |
3051 | (ange-ftp-cd host user home))))) | |
3052 | (if res | |
3053 | (let ((ange-ftp-this-user user) | |
3054 | (ange-ftp-this-host host)) | |
3055 | (if fix-name-func | |
3056 | (setq res (funcall fix-name-func res 'reverse))) | |
6e85ef5f | 3057 | (puthash key res ange-ftp-expand-dir-hashtable))) |
8749abea GM |
3058 | res)))) |
3059 | ||
3060 | (defun ange-ftp-canonize-filename (n) | |
4671dba5 | 3061 | "Take a string N and short-circuit //, /. and /.." |
8749abea GM |
3062 | (if (string-match "[^:]+//" n) ;don't upset Apollo users |
3063 | (setq n (substring n (1- (match-end 0))))) | |
3064 | (let ((parsed (ange-ftp-ftp-name n))) | |
3065 | (if parsed | |
3066 | (let ((host (car parsed)) | |
3067 | (user (nth 1 parsed)) | |
3068 | (name (nth 2 parsed))) | |
25759a92 | 3069 | |
8749abea GM |
3070 | ;; See if remote name is absolute. If so then just expand it and |
3071 | ;; replace the name component of the overall name. | |
aa6f7b96 | 3072 | (cond ((string-match "\\`/" name) |
8749abea | 3073 | name) |
25759a92 | 3074 | |
8749abea GM |
3075 | ;; Name starts with ~ or ~user. Resolve that part of the name |
3076 | ;; making it absolute then re-expand it. | |
aa6f7b96 | 3077 | ((string-match "\\`~[^/]*" name) |
e3441f42 | 3078 | (let* ((tilda (match-string 0 name)) |
8749abea GM |
3079 | (rest (substring name (match-end 0))) |
3080 | (dir (ange-ftp-expand-dir host user tilda))) | |
3081 | (if dir | |
aa6f7b96 SM |
3082 | ;; C-x d /ftp:anonymous@ftp.gnu.org:~/ RET |
3083 | ;; seems to cause `rest' to sometimes be empty. | |
3084 | ;; Maybe it's an error for `rest' to be empty here, | |
3085 | ;; but until we figure this out, this quick fix | |
3086 | ;; seems to do the trick. | |
3087 | (setq name (cond ((string-equal rest "") dir) | |
3088 | ((string-equal dir "/") rest) | |
3089 | (t (concat dir rest)))) | |
25759a92 | 3090 | (error "User \"%s\" is not known" |
8749abea | 3091 | (substring tilda 1))))) |
25759a92 | 3092 | |
8749abea GM |
3093 | ;; relative name. Tack on homedir and re-expand. |
3094 | (t | |
3095 | (let ((dir (ange-ftp-expand-dir host user "~"))) | |
3096 | (if dir | |
3097 | (setq name (concat | |
3098 | (ange-ftp-real-file-name-as-directory dir) | |
3099 | name)) | |
3100 | (error "Unable to obtain CWD"))))) | |
25759a92 | 3101 | |
8749abea | 3102 | ;; If name starts with //, preserve that, for apollo system. |
aa6f7b96 SM |
3103 | (unless (string-match "\\`//" name) |
3104 | (if (not (eq system-type 'windows-nt)) | |
3105 | (setq name (ange-ftp-real-expand-file-name name)) | |
3106 | ;; Windows UNC default dirs do not make sense for ftp. | |
3107 | (setq name (if (string-match "\\`//" default-directory) | |
3108 | (ange-ftp-real-expand-file-name name "c:/") | |
3109 | (ange-ftp-real-expand-file-name name))) | |
3110 | ;; Strip off possible drive specifier. | |
3111 | (if (string-match "\\`[a-zA-Z]:" name) | |
3112 | (setq name (substring name 2)))) | |
3113 | (if (string-match "\\`//" name) | |
3114 | (setq name (substring name 1)))) | |
25759a92 | 3115 | |
8749abea GM |
3116 | ;; Now substitute the expanded name back into the overall filename. |
3117 | (ange-ftp-replace-name-component n name)) | |
25759a92 | 3118 | |
8749abea GM |
3119 | ;; non-ange-ftp name. Just expand normally. |
3120 | (if (eq (string-to-char n) ?/) | |
3121 | (ange-ftp-real-expand-file-name n) | |
3122 | (ange-ftp-real-expand-file-name | |
3123 | (ange-ftp-real-file-name-nondirectory n) | |
3124 | (ange-ftp-real-file-name-directory n)))))) | |
3125 | ||
3126 | (defun ange-ftp-expand-file-name (name &optional default) | |
3bd1644e | 3127 | "Documented as `expand-file-name'." |
8749abea GM |
3128 | (save-match-data |
3129 | (setq default (or default default-directory)) | |
3130 | (cond ((eq (string-to-char name) ?~) | |
3131 | (ange-ftp-real-expand-file-name name)) | |
3132 | ((eq (string-to-char name) ?/) | |
3133 | (ange-ftp-canonize-filename name)) | |
3134 | ((and (eq system-type 'windows-nt) | |
3135 | (eq (string-to-char name) ?\\)) | |
3136 | (ange-ftp-canonize-filename name)) | |
3137 | ((and (eq system-type 'windows-nt) | |
aa6f7b96 SM |
3138 | (or (string-match "\\`[a-zA-Z]:" name) |
3139 | (string-match "\\`[a-zA-Z]:" default))) | |
8749abea GM |
3140 | (ange-ftp-real-expand-file-name name default)) |
3141 | ((zerop (length name)) | |
3142 | (ange-ftp-canonize-filename default)) | |
3143 | ((ange-ftp-canonize-filename | |
3144 | (concat (file-name-as-directory default) name)))))) | |
3145 | \f | |
3146 | ;;; These are problems--they are currently not enabled. | |
3147 | ||
3148 | (defvar ange-ftp-file-name-as-directory-alist nil | |
4671dba5 | 3149 | "Association list of (TYPE . FUNC) pairs. |
8749abea GM |
3150 | FUNC converts a filename to a directory name for the operating |
3151 | system TYPE.") | |
3152 | ||
3153 | (defun ange-ftp-file-name-as-directory (name) | |
4671dba5 | 3154 | "Documented as `file-name-as-directory'." |
8749abea GM |
3155 | (let ((parsed (ange-ftp-ftp-name name))) |
3156 | (if parsed | |
3157 | (if (string-equal (nth 2 parsed) "") | |
3158 | name | |
3159 | (funcall (or (cdr (assq | |
3160 | (ange-ftp-host-type (car parsed)) | |
3161 | ange-ftp-file-name-as-directory-alist)) | |
3162 | 'ange-ftp-real-file-name-as-directory) | |
3163 | name)) | |
3164 | (ange-ftp-real-file-name-as-directory name)))) | |
25759a92 | 3165 | |
8749abea | 3166 | (defun ange-ftp-file-name-directory (name) |
4671dba5 | 3167 | "Documented as `file-name-directory'." |
8749abea GM |
3168 | (let ((parsed (ange-ftp-ftp-name name))) |
3169 | (if parsed | |
3170 | (let ((filename (nth 2 parsed))) | |
4671dba5 | 3171 | (if (string-match-p "\\`~[^/]*\\'" filename) |
8749abea GM |
3172 | name |
3173 | (ange-ftp-replace-name-component | |
3174 | name | |
3175 | (ange-ftp-real-file-name-directory filename)))) | |
3176 | (ange-ftp-real-file-name-directory name)))) | |
3177 | ||
3178 | (defun ange-ftp-file-name-nondirectory (name) | |
4671dba5 | 3179 | "Documented as `file-name-nondirectory'." |
8749abea GM |
3180 | (let ((parsed (ange-ftp-ftp-name name))) |
3181 | (if parsed | |
3182 | (let ((filename (nth 2 parsed))) | |
4671dba5 | 3183 | (if (string-match-p "\\`~[^/]*\\'" filename) |
8749abea GM |
3184 | "" |
3185 | (ange-ftp-real-file-name-nondirectory filename))) | |
3186 | (ange-ftp-real-file-name-nondirectory name)))) | |
3187 | ||
3188 | (defun ange-ftp-directory-file-name (dir) | |
4671dba5 | 3189 | "Documented as `directory-file-name'." |
8749abea GM |
3190 | (let ((parsed (ange-ftp-ftp-name dir))) |
3191 | (if parsed | |
3192 | (ange-ftp-replace-name-component | |
e3441f42 SM |
3193 | dir |
3194 | (ange-ftp-real-directory-file-name (nth 2 parsed))) | |
8749abea GM |
3195 | (ange-ftp-real-directory-file-name dir)))) |
3196 | ||
3197 | \f | |
3198 | ;;; Hooks that handle Emacs primitives. | |
3199 | ||
3200 | ;; Returns non-nil if should transfer FILE in binary mode. | |
3201 | (defun ange-ftp-binary-file (file) | |
4671dba5 | 3202 | (string-match-p ange-ftp-binary-file-name-regexp file)) |
8749abea GM |
3203 | |
3204 | (defun ange-ftp-write-region (start end filename &optional append visit) | |
3205 | (setq filename (expand-file-name filename)) | |
3206 | (let ((parsed (ange-ftp-ftp-name filename))) | |
3207 | (if parsed | |
3208 | (let* ((host (nth 0 parsed)) | |
3209 | (user (nth 1 parsed)) | |
3210 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3211 | (temp (ange-ftp-make-tmp-name host)) | |
3212 | ;; What we REALLY need here is a way to determine if the mode | |
3213 | ;; of the transfer is irrelevant, i.e. we can use binary mode | |
3214 | ;; regardless. Maybe a system-type to host-type lookup? | |
3215 | (binary (or (ange-ftp-binary-file filename) | |
67f300f8 | 3216 | (and (not (memq system-type |
a3374680 | 3217 | '(ms-dos windows-nt))) |
67f300f8 SM |
3218 | (memq (ange-ftp-host-type host user) |
3219 | '(unix dumb-unix))))) | |
8749abea GM |
3220 | (cmd (if append 'append 'put)) |
3221 | (abbr (ange-ftp-abbreviate-filename filename)) | |
3222 | ;; we need to reset `last-coding-system-used' to its | |
3223 | ;; value immediately after calling the real write-region, | |
3224 | ;; so that `basic-save-buffer' doesn't see whatever value | |
3225 | ;; might be used when communicating with the ftp process. | |
3226 | (coding-system-used last-coding-system-used)) | |
3227 | (unwind-protect | |
3228 | (progn | |
4494f50d | 3229 | (let ((filename (buffer-file-name)) |
8749abea GM |
3230 | (mod-p (buffer-modified-p))) |
3231 | (unwind-protect | |
2ca0d5f1 | 3232 | (progn |
4494f50d RS |
3233 | (ange-ftp-real-write-region start end temp nil |
3234 | (or visit 'quiet)) | |
2ca0d5f1 | 3235 | (setq coding-system-used last-coding-system-used)) |
8749abea | 3236 | ;; cleanup forms |
2ca0d5f1 | 3237 | (setq coding-system-used last-coding-system-used) |
8749abea | 3238 | (setq buffer-file-name filename) |
b63f6e81 | 3239 | (restore-buffer-modified-p mod-p))) |
8749abea GM |
3240 | (if binary |
3241 | (ange-ftp-set-binary-mode host user)) | |
3242 | ||
3243 | ;; tell the process filter what size the transfer will be. | |
3244 | (let ((attr (file-attributes temp))) | |
3245 | (if attr | |
3246 | (ange-ftp-set-xfer-size host user (nth 7 attr)))) | |
3247 | ||
3248 | ;; put or append the file. | |
3249 | (let ((result (ange-ftp-send-cmd host user | |
3250 | (list cmd temp name) | |
3251 | (format "Writing %s" abbr)))) | |
3252 | (or (car result) | |
3253 | (signal 'ftp-error | |
3254 | (list | |
3255 | "Opening output file" | |
3256 | (format "FTP Error: \"%s\"" (cdr result)) | |
3257 | filename))))) | |
3258 | (ange-ftp-del-tmp-name temp) | |
25759a92 | 3259 | (if binary |
8749abea GM |
3260 | (ange-ftp-set-ascii-mode host user))) |
3261 | (if (eq visit t) | |
3262 | (progn | |
25759a92 | 3263 | (set-visited-file-modtime (ange-ftp-file-modtime filename)) |
8749abea GM |
3264 | (ange-ftp-set-buffer-mode) |
3265 | (setq buffer-file-name filename) | |
3266 | (set-buffer-modified-p nil))) | |
3267 | ;; ensure `last-coding-system-used' has an appropriate value | |
3268 | (setq last-coding-system-used coding-system-used) | |
3269 | (ange-ftp-message "Wrote %s" abbr) | |
3270 | (ange-ftp-add-file-entry filename)) | |
3271 | (ange-ftp-real-write-region start end filename append visit)))) | |
3272 | ||
3273 | (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace) | |
3274 | (barf-if-buffer-read-only) | |
3275 | (setq filename (expand-file-name filename)) | |
3276 | (let ((parsed (ange-ftp-ftp-name filename))) | |
3277 | (if parsed | |
3278 | (progn | |
3279 | (if visit | |
3280 | (setq buffer-file-name filename)) | |
3281 | (if (or (file-exists-p filename) | |
3282 | (progn | |
3283 | (setq ange-ftp-ls-cache-file nil) | |
6e85ef5f SM |
3284 | (remhash (file-name-directory filename) |
3285 | ange-ftp-files-hashtable) | |
8749abea GM |
3286 | (file-exists-p filename))) |
3287 | (let* ((host (nth 0 parsed)) | |
3288 | (user (nth 1 parsed)) | |
3289 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3290 | (temp (ange-ftp-make-tmp-name host)) | |
3291 | (binary (or (ange-ftp-binary-file filename) | |
3292 | (memq (ange-ftp-host-type host user) | |
3293 | '(unix dumb-unix)))) | |
3294 | (abbr (ange-ftp-abbreviate-filename filename)) | |
3295 | (coding-system-used last-coding-system-used) | |
3296 | size) | |
3297 | (unwind-protect | |
3298 | (progn | |
3299 | (if binary | |
3300 | (ange-ftp-set-binary-mode host user)) | |
3301 | (let ((result (ange-ftp-send-cmd host user | |
3302 | (list 'get name temp) | |
3303 | (format "Retrieving %s" abbr)))) | |
3304 | (or (car result) | |
3305 | (signal 'ftp-error | |
3306 | (list | |
3307 | "Opening input file" | |
3308 | (format "FTP Error: \"%s\"" (cdr result)) | |
3309 | filename)))) | |
3310 | (if (or (ange-ftp-real-file-readable-p temp) | |
3311 | (sleep-for ange-ftp-retry-time) | |
3312 | ;; Wait for file to hopefully appear. | |
3313 | (ange-ftp-real-file-readable-p temp)) | |
3314 | (setq | |
3315 | size | |
3316 | (nth 1 (ange-ftp-real-insert-file-contents | |
3317 | temp visit beg end replace)) | |
3318 | coding-system-used last-coding-system-used | |
3319 | ;; override autodetection of buffer file type | |
3320 | ;; to ensure buffer is saved in DOS format | |
3321 | buffer-file-type binary) | |
3322 | (signal 'ftp-error | |
3323 | (list | |
3324 | "Opening input file:" | |
3325 | (format | |
3326 | "FTP Error: %s not arrived or readable" | |
3327 | filename))))) | |
3328 | (if binary | |
3329 | ;; We must keep `last-coding-system-used' | |
3330 | ;; unchanged. | |
3331 | (let (last-coding-system-used) | |
3332 | (ange-ftp-set-ascii-mode host user))) | |
3333 | (ange-ftp-del-tmp-name temp)) | |
3334 | (if visit | |
3335 | (progn | |
25759a92 SS |
3336 | (set-visited-file-modtime |
3337 | (ange-ftp-file-modtime filename)) | |
8749abea GM |
3338 | (setq buffer-file-name filename))) |
3339 | (setq last-coding-system-used coding-system-used) | |
3340 | (list filename size)) | |
3341 | (signal 'file-error | |
25759a92 | 3342 | (list |
8749abea GM |
3343 | "Opening input file" |
3344 | filename)))) | |
3345 | (ange-ftp-real-insert-file-contents filename visit beg end replace)))) | |
25759a92 | 3346 | |
8749abea | 3347 | (defun ange-ftp-expand-symlink (file dir) |
64cf2455 KG |
3348 | (let ((res (if (file-name-absolute-p file) |
3349 | (ange-ftp-replace-name-component dir file) | |
3350 | (expand-file-name file dir)))) | |
3351 | (if (file-symlink-p res) | |
3352 | (ange-ftp-expand-symlink | |
3353 | (ange-ftp-get-file-entry res) | |
3354 | (file-name-directory (directory-file-name res))) | |
3355 | res))) | |
8749abea GM |
3356 | |
3357 | (defun ange-ftp-file-symlink-p (file) | |
3358 | ;; call ange-ftp-expand-file-name rather than the normal | |
3359 | ;; expand-file-name to stop loops when using a package that | |
3360 | ;; redefines both file-symlink-p and expand-file-name. | |
3361 | (setq file (ange-ftp-expand-file-name file)) | |
3362 | (if (ange-ftp-ftp-name file) | |
34301ace | 3363 | (condition-case nil |
311f32fe DK |
3364 | (let ((ent (ange-ftp-get-files (file-name-directory file)))) |
3365 | (and ent | |
3366 | (stringp (setq ent | |
3367 | (gethash (ange-ftp-get-file-part file) ent))) | |
3368 | ent)) | |
34301ace RS |
3369 | ;; If we can't read the parent directory, just assume |
3370 | ;; this file is not a symlink. | |
3371 | ;; This makes it possible to access a directory that | |
3372 | ;; whose parent is not readable. | |
3373 | (file-error nil)) | |
8749abea GM |
3374 | (ange-ftp-real-file-symlink-p file))) |
3375 | ||
3376 | (defun ange-ftp-file-exists-p (name) | |
3377 | (setq name (expand-file-name name)) | |
3378 | (if (ange-ftp-ftp-name name) | |
3379 | (if (ange-ftp-file-entry-p name) | |
3380 | (let ((file-ent (ange-ftp-get-file-entry name))) | |
3381 | (if (stringp file-ent) | |
3382 | (file-exists-p | |
3383 | (ange-ftp-expand-symlink file-ent | |
3384 | (file-name-directory | |
3385 | (directory-file-name name)))) | |
3386 | t))) | |
3387 | (ange-ftp-real-file-exists-p name))) | |
3388 | ||
3389 | (defun ange-ftp-file-directory-p (name) | |
3390 | (setq name (expand-file-name name)) | |
3391 | (if (ange-ftp-ftp-name name) | |
3392 | ;; We do a file-name-as-directory on name here because some | |
3393 | ;; machines (VMS) use a .DIR to indicate the filename associated | |
3394 | ;; with a directory. This needs to be canonicalized. | |
3395 | (let ((file-ent (ange-ftp-get-file-entry | |
3396 | (ange-ftp-file-name-as-directory name)))) | |
3397 | (if (stringp file-ent) | |
3bd1644e SM |
3398 | ;; Calling file-directory-p doesn't work because ange-ftp |
3399 | ;; is temporarily disabled for this operation. | |
3400 | (ange-ftp-file-directory-p | |
8749abea GM |
3401 | (ange-ftp-expand-symlink file-ent |
3402 | (file-name-directory | |
3403 | (directory-file-name name)))) | |
3404 | file-ent)) | |
3405 | (ange-ftp-real-file-directory-p name))) | |
3406 | ||
3407 | (defun ange-ftp-directory-files (directory &optional full match | |
3408 | &rest v19-args) | |
3409 | (setq directory (expand-file-name directory)) | |
3410 | (if (ange-ftp-ftp-name directory) | |
3411 | (progn | |
3412 | (ange-ftp-barf-if-not-directory directory) | |
3413 | (let ((tail (ange-ftp-hash-table-keys | |
3414 | (ange-ftp-get-files directory))) | |
3415 | files f) | |
3416 | (setq directory (file-name-as-directory directory)) | |
4671dba5 JB |
3417 | (while tail |
3418 | (setq f (car tail) | |
3419 | tail (cdr tail)) | |
3420 | (if (or (not match) (string-match-p match f)) | |
3421 | (setq files | |
3422 | (cons (if full (concat directory f) f) files)))) | |
8749abea GM |
3423 | (nreverse files))) |
3424 | (apply 'ange-ftp-real-directory-files directory full match v19-args))) | |
3425 | ||
f06dbf7e MA |
3426 | (defun ange-ftp-directory-files-and-attributes |
3427 | (directory &optional full match nosort id-format) | |
3428 | (setq directory (expand-file-name directory)) | |
3429 | (if (ange-ftp-ftp-name directory) | |
3430 | (mapcar | |
3431 | (lambda (file) | |
3432 | (cons file (file-attributes (expand-file-name file directory)))) | |
3433 | (ange-ftp-directory-files directory full match nosort)) | |
3434 | (ange-ftp-real-directory-files-and-attributes | |
3435 | directory full match nosort id-format))) | |
3436 | ||
c4383667 | 3437 | (defun ange-ftp-file-attributes (file &optional id-format) |
8749abea GM |
3438 | (setq file (expand-file-name file)) |
3439 | (let ((parsed (ange-ftp-ftp-name file))) | |
3440 | (if parsed | |
3441 | (let ((part (ange-ftp-get-file-part file)) | |
3442 | (files (ange-ftp-get-files (file-name-directory file)))) | |
3443 | (if (ange-ftp-hash-entry-exists-p part files) | |
3444 | (let ((host (nth 0 parsed)) | |
3445 | (user (nth 1 parsed)) | |
3446 | (name (nth 2 parsed)) | |
6e85ef5f SM |
3447 | (dirp (gethash part files)) |
3448 | (inode (gethash file ange-ftp-inodes-hashtable))) | |
8749abea GM |
3449 | (unless inode |
3450 | (setq inode ange-ftp-next-inode-number | |
3451 | ange-ftp-next-inode-number (1+ inode)) | |
6e85ef5f | 3452 | (puthash file inode ange-ftp-inodes-hashtable)) |
8749abea GM |
3453 | (list (if (and (stringp dirp) (file-name-absolute-p dirp)) |
3454 | (ange-ftp-expand-symlink dirp | |
3455 | (file-name-directory file)) | |
3456 | dirp) ;0 file type | |
3457 | -1 ;1 link count | |
3458 | -1 ;2 uid | |
3459 | -1 ;3 gid | |
3460 | '(0 0) ;4 atime | |
25759a92 | 3461 | (ange-ftp-file-modtime file) ;5 mtime |
8749abea | 3462 | '(0 0) ;6 ctime |
412707c2 | 3463 | (ange-ftp-file-size file) ;7 size |
8749abea GM |
3464 | (concat (if (stringp dirp) "l" (if dirp "d" "-")) |
3465 | "?????????") ;8 mode | |
3466 | nil ;9 gid weird | |
3467 | inode ;10 "inode number". | |
3468 | -1 ;11 device number [v19 only] | |
3469 | )))) | |
836078f6 RS |
3470 | (if id-format |
3471 | (ange-ftp-real-file-attributes file id-format) | |
3472 | (ange-ftp-real-file-attributes file))))) | |
8749abea | 3473 | |
a1f84f6d SS |
3474 | (defun ange-ftp-file-newer-than-file-p (f1 f2) |
3475 | (let ((f1-parsed (ange-ftp-ftp-name f1)) | |
3476 | (f2-parsed (ange-ftp-ftp-name f2))) | |
3477 | (if (or f1-parsed f2-parsed) | |
3478 | (let ((f1-mt (nth 5 (file-attributes f1))) | |
3479 | (f2-mt (nth 5 (file-attributes f2)))) | |
3480 | (cond ((null f1-mt) nil) | |
3481 | ((null f2-mt) t) | |
3482 | (t (> (float-time f1-mt) (float-time f2-mt))))) | |
3483 | (ange-ftp-real-file-newer-than-file-p f1 f2)))) | |
3484 | ||
8749abea | 3485 | (defun ange-ftp-file-writable-p (file) |
0e14fe9f GM |
3486 | (let ((ange-ftp-process-verbose nil)) |
3487 | (setq file (expand-file-name file)) | |
3488 | (if (ange-ftp-ftp-name file) | |
3489 | (or (file-exists-p file) ;guess here for speed | |
3490 | (file-directory-p (file-name-directory file))) | |
3491 | (ange-ftp-real-file-writable-p file)))) | |
8749abea GM |
3492 | |
3493 | (defun ange-ftp-file-readable-p (file) | |
0e14fe9f GM |
3494 | (let ((ange-ftp-process-verbose nil)) |
3495 | (setq file (expand-file-name file)) | |
3496 | (if (ange-ftp-ftp-name file) | |
3497 | (file-exists-p file) | |
3498 | (ange-ftp-real-file-readable-p file)))) | |
8749abea GM |
3499 | |
3500 | (defun ange-ftp-file-executable-p (file) | |
0e14fe9f GM |
3501 | (let ((ange-ftp-process-verbose nil)) |
3502 | (setq file (expand-file-name file)) | |
3503 | (if (ange-ftp-ftp-name file) | |
3504 | (file-exists-p file) | |
3505 | (ange-ftp-real-file-executable-p file)))) | |
8749abea GM |
3506 | |
3507 | (defun ange-ftp-delete-file (file) | |
3508 | (interactive "fDelete file: ") | |
3509 | (setq file (expand-file-name file)) | |
3510 | (let ((parsed (ange-ftp-ftp-name file))) | |
3511 | (if parsed | |
3512 | (let* ((host (nth 0 parsed)) | |
3513 | (user (nth 1 parsed)) | |
3514 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3515 | (abbr (ange-ftp-abbreviate-filename file)) | |
3516 | (result (ange-ftp-send-cmd host user | |
3517 | (list 'delete name) | |
3518 | (format "Deleting %s" abbr)))) | |
3519 | (or (car result) | |
3520 | (signal 'ftp-error | |
3521 | (list | |
3522 | "Removing old name" | |
3523 | (format "FTP Error: \"%s\"" (cdr result)) | |
3524 | file))) | |
3525 | (ange-ftp-delete-file-entry file)) | |
3526 | (ange-ftp-real-delete-file file)))) | |
3527 | ||
25759a92 | 3528 | (defun ange-ftp-file-modtime (file) |
6573d87f GM |
3529 | "Return the modification time of remote file FILE. |
3530 | Value is (0 0) if the modification time cannot be determined." | |
25759a92 | 3531 | (let* ((parsed (ange-ftp-ftp-name file)) |
6573d87f GM |
3532 | ;; At least one FTP server (wu-ftpd) can return a "226 |
3533 | ;; Transfer complete" before the "213 MODTIME". Let's skip | |
3534 | ;; that. | |
3535 | (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226")) | |
25759a92 | 3536 | (res (ange-ftp-send-cmd (car parsed) (cadr parsed) |
6573d87f GM |
3537 | (list 'quote "mdtm" (cadr (cdr parsed))))) |
3538 | (line (cdr res)) | |
3539 | (modtime '(0 0))) | |
524ac5b2 GM |
3540 | ;; MDTM should return "213 YYYYMMDDhhmmss" GMT on success |
3541 | ;; following the Internet draft for FTP extensions. | |
3542 | ;; Bob@rattlesnake.com reports that is returns something different | |
3543 | ;; for at least one FTP server. So, let's use the response only | |
3544 | ;; if it matches the Internet draft. | |
4671dba5 | 3545 | (when (string-match-p "^213 [0-9]\\{14\\}$" line) |
6573d87f GM |
3546 | (setq modtime |
3547 | (encode-time | |
3548 | (string-to-number (substring line 16 18)) | |
3549 | (string-to-number (substring line 14 16)) | |
3550 | (string-to-number (substring line 12 14)) | |
3551 | (string-to-number (substring line 10 12)) | |
3552 | (string-to-number (substring line 8 10)) | |
3553 | (string-to-number (substring line 4 8)) | |
3554 | 0))) | |
3555 | modtime)) | |
25759a92 | 3556 | |
8749abea GM |
3557 | (defun ange-ftp-verify-visited-file-modtime (buf) |
3558 | (let ((name (buffer-file-name buf))) | |
3559 | (if (and (stringp name) (ange-ftp-ftp-name name)) | |
25759a92 SS |
3560 | (let ((file-mdtm (ange-ftp-file-modtime name)) |
3561 | (buf-mdtm (with-current-buffer buf (visited-file-modtime)))) | |
3562 | (or (zerop (car file-mdtm)) | |
9d453139 | 3563 | (<= (float-time file-mdtm) (float-time buf-mdtm)))) |
8749abea | 3564 | (ange-ftp-real-verify-visited-file-modtime buf)))) |
412707c2 SM |
3565 | |
3566 | (defun ange-ftp-file-size (file &optional ascii-mode) | |
3567 | "Return the size of remote file FILE. Return -1 if can't get it. | |
3568 | If ascii-mode is non-nil, return the size with the extra octets that | |
3569 | need to be inserted, one at the end of each line, to provide correct | |
3570 | end-of-line semantics for a transfer using TYPE=A. The default is nil, | |
3571 | so return the size on the remote host exactly. See RFC 3659." | |
3572 | (let* ((parsed (ange-ftp-ftp-name file)) | |
3573 | (host (nth 0 parsed)) | |
3574 | (user (nth 1 parsed)) | |
3575 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
3576 | ;; At least one FTP server (wu-ftpd) can return a "226 | |
3577 | ;; Transfer complete" before the "213 SIZE". Let's skip | |
3578 | ;; that. | |
3579 | (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226")) | |
2b93080a SM |
3580 | (res (unwind-protect |
3581 | (progn | |
3582 | (unless ascii-mode | |
3583 | (ange-ftp-set-binary-mode host user)) | |
3584 | (ange-ftp-send-cmd host user (list 'quote "size" name))) | |
412707c2 SM |
3585 | (unless ascii-mode |
3586 | (ange-ftp-set-ascii-mode host user)))) | |
3587 | (line (cdr res))) | |
3588 | (if (string-match "^213 \\([0-9]+\\)$" line) | |
3589 | (string-to-number (match-string 1 line)) | |
3590 | -1))) | |
3591 | ||
8749abea GM |
3592 | \f |
3593 | ;;;; ------------------------------------------------------------ | |
3594 | ;;;; File copying support... totally re-written 6/24/92. | |
3595 | ;;;; ------------------------------------------------------------ | |
3596 | ||
3597 | (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive) | |
3598 | (if (file-exists-p absname) | |
3599 | (if (not interactive) | |
3600 | (signal 'file-already-exists (list absname)) | |
3601 | (if (not (yes-or-no-p (format "File %s already exists; %s anyway? " | |
3602 | absname querystring))) | |
3603 | (signal 'file-already-exists (list absname)))))) | |
3604 | ||
3605 | ;; async local copy commented out for now since I don't seem to get | |
3606 | ;; the process sentinel called for some processes. | |
3607 | ;; | |
3608 | ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists | |
3609 | ;; keep-date cont) | |
3610 | ;; "Kludge to copy a local file and call a continuation when the copy | |
3611 | ;; finishes." | |
3612 | ;; ;; check to see if we can overwrite | |
3613 | ;; (if (or (not ok-if-already-exists) | |
3614 | ;; (numberp ok-if-already-exists)) | |
25759a92 | 3615 | ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it" |
8749abea GM |
3616 | ;; (numberp ok-if-already-exists))) |
3617 | ;; (let ((proc (start-process " *copy*" | |
3618 | ;; (generate-new-buffer "*copy*") | |
3619 | ;; "cp" | |
3620 | ;; filename | |
3621 | ;; newname)) | |
3622 | ;; res) | |
e3441f42 | 3623 | ;; (set-process-sentinel proc 'ange-ftp-copy-file-locally-sentinel) |
8749abea | 3624 | ;; (process-kill-without-query proc) |
67f300f8 SM |
3625 | ;; (with-current-buffer (process-buffer proc) |
3626 | ;; (set (make-local-variable 'copy-cont) cont)))) | |
25759a92 | 3627 | ;; |
8749abea | 3628 | ;; (defun ange-ftp-copy-file-locally-sentinel (proc status) |
b63f6e81 | 3629 | ;; (with-current-buffer (process-buffer proc) |
8749abea GM |
3630 | ;; (let ((cont copy-cont) |
3631 | ;; (result (buffer-string))) | |
3632 | ;; (unwind-protect | |
3633 | ;; (if (and (string-equal status "finished\n") | |
3634 | ;; (zerop (length result))) | |
3635 | ;; (ange-ftp-call-cont cont t nil) | |
3636 | ;; (ange-ftp-call-cont cont | |
3637 | ;; nil | |
3638 | ;; (if (zerop (length result)) | |
3639 | ;; (substring status 0 -1) | |
3640 | ;; (substring result 0 -1)))) | |
3641 | ;; (kill-buffer (current-buffer)))))) | |
3642 | ||
3643 | ;; this is the extended version of ange-ftp-copy-file-internal that works | |
3644 | ;; asynchronously if asked nicely. | |
3645 | (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists | |
3646 | keep-date &optional msg cont nowait) | |
3647 | (setq filename (expand-file-name filename) | |
3648 | newname (expand-file-name newname)) | |
3649 | ||
3650 | ;; canonicalize newname if a directory. | |
3651 | (if (file-directory-p newname) | |
3652 | (setq newname (expand-file-name (file-name-nondirectory filename) newname))) | |
3653 | ||
3654 | (let ((f-parsed (ange-ftp-ftp-name filename)) | |
3655 | (t-parsed (ange-ftp-ftp-name newname))) | |
3656 | ||
3657 | ;; local file to local file copy? | |
3658 | (if (and (not f-parsed) (not t-parsed)) | |
3659 | (progn | |
3660 | (ange-ftp-real-copy-file filename newname ok-if-already-exists | |
3661 | keep-date) | |
3662 | (if cont | |
3663 | (ange-ftp-call-cont cont t "Copied locally"))) | |
3664 | ;; one or both files are remote. | |
3665 | (let* ((f-host (and f-parsed (nth 0 f-parsed))) | |
3666 | (f-user (and f-parsed (nth 1 f-parsed))) | |
3667 | (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed)))) | |
3668 | (f-abbr (ange-ftp-abbreviate-filename filename)) | |
3669 | (t-host (and t-parsed (nth 0 t-parsed))) | |
3670 | (t-user (and t-parsed (nth 1 t-parsed))) | |
3671 | (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed)))) | |
3672 | (t-abbr (ange-ftp-abbreviate-filename newname filename)) | |
3673 | (binary (or (ange-ftp-binary-file filename) | |
3674 | (ange-ftp-binary-file newname) | |
3675 | (and (memq (ange-ftp-host-type f-host f-user) | |
3676 | '(unix dumb-unix)) | |
3677 | (memq (ange-ftp-host-type t-host t-user) | |
3678 | '(unix dumb-unix))))) | |
3679 | temp1 | |
3680 | temp2) | |
3681 | ||
3682 | ;; check to see if we can overwrite | |
3683 | (if (or (not ok-if-already-exists) | |
3684 | (numberp ok-if-already-exists)) | |
25759a92 | 3685 | (ange-ftp-barf-or-query-if-file-exists newname "copy to it" |
8749abea GM |
3686 | (numberp ok-if-already-exists))) |
3687 | ||
3688 | ;; do the copying. | |
3689 | (if f-parsed | |
25759a92 | 3690 | |
8749abea GM |
3691 | ;; filename was remote. |
3692 | (progn | |
3693 | (if (or (ange-ftp-use-gateway-p f-host) | |
3694 | t-parsed) | |
3695 | ;; have to use intermediate file if we are getting via | |
3696 | ;; gateway machine or we are doing a remote to remote copy. | |
3697 | (setq temp1 (ange-ftp-make-tmp-name f-host))) | |
25759a92 | 3698 | |
8749abea GM |
3699 | (if binary |
3700 | (ange-ftp-set-binary-mode f-host f-user)) | |
3701 | ||
3702 | (ange-ftp-send-cmd | |
3703 | f-host | |
3704 | f-user | |
3705 | (list 'get f-name (or temp1 (ange-ftp-quote-string newname))) | |
3706 | (or msg | |
3707 | (if (and temp1 t-parsed) | |
3708 | (format "Getting %s" f-abbr) | |
3709 | (format "Copying %s to %s" f-abbr t-abbr))) | |
e3441f42 | 3710 | (list 'ange-ftp-cf1 |
8749abea GM |
3711 | filename newname binary msg |
3712 | f-parsed f-host f-user f-name f-abbr | |
3713 | t-parsed t-host t-user t-name t-abbr | |
3714 | temp1 temp2 cont nowait) | |
3715 | nowait)) | |
3716 | ||
3717 | ;; filename wasn't remote. newname must be remote. call the | |
3718 | ;; function which does the remainder of the copying work. | |
3719 | (ange-ftp-cf1 t nil | |
3720 | filename newname binary msg | |
3721 | f-parsed f-host f-user f-name f-abbr | |
3722 | t-parsed t-host t-user t-name t-abbr | |
3723 | nil nil cont nowait)))))) | |
3724 | ||
3725 | (defvar ange-ftp-waiting-flag nil) | |
3726 | ||
3727 | ;; next part of copying routine. | |
3728 | (defun ange-ftp-cf1 (result line | |
3729 | filename newname binary msg | |
3730 | f-parsed f-host f-user f-name f-abbr | |
3731 | t-parsed t-host t-user t-name t-abbr | |
3732 | temp1 temp2 cont nowait) | |
3733 | (if line | |
3734 | ;; filename must have been remote, and we must have just done a GET. | |
3735 | (unwind-protect | |
3736 | (or result | |
3737 | ;; GET failed for some reason. Clean up and get out. | |
3738 | (progn | |
3739 | (and temp1 (ange-ftp-del-tmp-name temp1)) | |
3740 | (or cont | |
3741 | (if ange-ftp-waiting-flag | |
3742 | (throw 'ftp-error t) | |
3743 | (signal 'ftp-error | |
3744 | (list "Opening input file" | |
3745 | (format "FTP Error: \"%s\"" line) | |
3746 | filename)))))) | |
3747 | ;; cleanup | |
3748 | (if binary | |
3749 | (ange-ftp-set-ascii-mode f-host f-user)))) | |
3750 | ||
3751 | (if result | |
3752 | ;; We now have to copy either temp1 or filename to newname. | |
3753 | (if t-parsed | |
25759a92 | 3754 | |
8749abea GM |
3755 | ;; newname was remote. |
3756 | (progn | |
3757 | (if (ange-ftp-use-gateway-p t-host) | |
3758 | (setq temp2 (ange-ftp-make-tmp-name t-host))) | |
25759a92 | 3759 | |
8749abea GM |
3760 | ;; make sure data is moved into the right place for the |
3761 | ;; outgoing transfer. gateway temporary files complicate | |
3762 | ;; things nicely. | |
3763 | (if temp1 | |
3764 | (if temp2 | |
3765 | (if (string-equal temp1 temp2) | |
3766 | (setq temp1 nil) | |
3767 | (ange-ftp-real-copy-file temp1 temp2 t)) | |
3768 | (setq temp2 temp1 temp1 nil)) | |
3769 | (if temp2 | |
3770 | (ange-ftp-real-copy-file filename temp2 t))) | |
25759a92 | 3771 | |
8749abea GM |
3772 | (if binary |
3773 | (ange-ftp-set-binary-mode t-host t-user)) | |
3774 | ||
3775 | ;; tell the process filter what size the file is. | |
3776 | (let ((attr (file-attributes (or temp2 filename)))) | |
3777 | (if attr | |
3778 | (ange-ftp-set-xfer-size t-host t-user (nth 7 attr)))) | |
3779 | ||
3780 | (ange-ftp-send-cmd | |
3781 | t-host | |
3782 | t-user | |
1860f08d | 3783 | (list 'put (or temp2 (ange-ftp-quote-string filename)) t-name) |
8749abea GM |
3784 | (or msg |
3785 | (if (and temp2 f-parsed) | |
3786 | (format "Putting %s" newname) | |
3787 | (format "Copying %s to %s" f-abbr t-abbr))) | |
e3441f42 | 3788 | (list 'ange-ftp-cf2 |
8749abea GM |
3789 | newname t-host t-user binary temp1 temp2 cont) |
3790 | nowait)) | |
25759a92 | 3791 | |
8749abea GM |
3792 | ;; newname wasn't remote. |
3793 | (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont)) | |
3794 | ||
3795 | ;; first copy failed, tell caller | |
3796 | (ange-ftp-call-cont cont result line))) | |
3797 | ||
3798 | ;; last part of copying routine. | |
3799 | (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont) | |
3800 | (unwind-protect | |
3801 | (if line | |
3802 | ;; result from doing a local to remote copy. | |
3803 | (unwind-protect | |
3804 | (progn | |
3805 | (or result | |
3806 | (or cont | |
3807 | (if ange-ftp-waiting-flag | |
3808 | (throw 'ftp-error t) | |
3809 | (signal 'ftp-error | |
3810 | (list "Opening output file" | |
3811 | (format "FTP Error: \"%s\"" line) | |
3812 | newname))))) | |
25759a92 | 3813 | |
8749abea | 3814 | (ange-ftp-add-file-entry newname)) |
25759a92 | 3815 | |
8749abea GM |
3816 | ;; cleanup. |
3817 | (if binary | |
3818 | (ange-ftp-set-ascii-mode t-host t-user))) | |
25759a92 | 3819 | |
8749abea GM |
3820 | ;; newname was local. |
3821 | (if temp1 | |
3822 | (ange-ftp-real-copy-file temp1 newname t))) | |
25759a92 | 3823 | |
8749abea GM |
3824 | ;; clean up |
3825 | (and temp1 (ange-ftp-del-tmp-name temp1)) | |
3826 | (and temp2 (ange-ftp-del-tmp-name temp2)) | |
3827 | (ange-ftp-call-cont cont result line))) | |
3828 | ||
3829 | (defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists | |
5b2e628f | 3830 | keep-date preserve-uid-gid) |
8749abea GM |
3831 | (interactive "fCopy file: \nFCopy %s to file: \np") |
3832 | (ange-ftp-copy-file-internal filename | |
3833 | newname | |
3834 | ok-if-already-exists | |
3835 | keep-date | |
3836 | nil | |
3837 | nil | |
32226619 | 3838 | (called-interactively-p 'interactive))) |
b878b8c3 SS |
3839 | |
3840 | (defun ange-ftp-copy-files-async (okay-p line verbose-p files) | |
3841 | "Copy some files in the background. | |
4671dba5 | 3842 | OKAY-P must be t, and LINE does not matter. They are here to make this |
b878b8c3 SS |
3843 | function a valid CONT argument for `ange-ftp-raw-send-cmd'. |
3844 | If VERBOSE-P is non-nil, print progress report in the echo area. | |
3845 | When all the files have been copied already, a message is shown anyway. | |
3846 | FILES is a list of files to copy in the form | |
3847 | (from-file to-file ok-if-already-exists keep-date) | |
3848 | E.g., | |
3849 | (ange-ftp-copy-files-async t nil t '((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" | |
3850 | (unless okay-p (error "%s: %s" 'ange-ftp-copy-files-async line)) | |
3851 | (if files | |
3852 | (let* ((ff (car files)) | |
3853 | (from-file (nth 0 ff)) | |
3854 | (to-file (nth 1 ff)) | |
3855 | (ok-if-exists (nth 2 ff)) | |
3856 | (keep-date (nth 3 ff))) | |
3857 | (ange-ftp-copy-file-internal | |
3858 | from-file to-file ok-if-exists keep-date | |
3859 | (and verbose-p (format "%s --> %s" from-file to-file)) | |
3860 | (list 'ange-ftp-copy-files-async verbose-p (cdr files)) | |
3861 | t)) | |
6e85ef5f | 3862 | (message "%s: done" 'ange-ftp-copy-files-async))) |
b878b8c3 | 3863 | |
8749abea GM |
3864 | \f |
3865 | ;;;; ------------------------------------------------------------ | |
3866 | ;;;; File renaming support. | |
3867 | ;;;; ------------------------------------------------------------ | |
3868 | ||
3869 | (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed) | |
4671dba5 | 3870 | "Rename remote file FILENAME to remote file NEWNAME." |
8749abea GM |
3871 | (let ((f-host (nth 0 f-parsed)) |
3872 | (f-user (nth 1 f-parsed)) | |
3873 | (t-host (nth 0 t-parsed)) | |
3874 | (t-user (nth 1 t-parsed))) | |
3875 | (if (and (string-equal f-host t-host) | |
3876 | (string-equal f-user t-user)) | |
3877 | (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed))) | |
3878 | (t-name (ange-ftp-quote-string (nth 2 t-parsed))) | |
3879 | (cmd (list 'rename f-name t-name)) | |
3880 | (fabbr (ange-ftp-abbreviate-filename filename)) | |
3881 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3882 | (result (ange-ftp-send-cmd f-host f-user cmd | |
3883 | (format "Renaming %s to %s" | |
3884 | fabbr | |
3885 | nabbr)))) | |
3886 | (or (car result) | |
3887 | (signal 'ftp-error | |
3888 | (list | |
3889 | "Renaming" | |
3890 | (format "FTP Error: \"%s\"" (cdr result)) | |
3891 | filename | |
3892 | newname))) | |
3893 | (ange-ftp-add-file-entry newname) | |
3894 | (ange-ftp-delete-file-entry filename)) | |
3895 | (ange-ftp-copy-file-internal filename newname t nil) | |
3896 | (delete-file filename)))) | |
3897 | ||
3898 | (defun ange-ftp-rename-local-to-remote (filename newname) | |
4671dba5 | 3899 | "Rename local file FILENAME to remote file NEWNAME." |
8749abea GM |
3900 | (let* ((fabbr (ange-ftp-abbreviate-filename filename)) |
3901 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3902 | (msg (format "Renaming %s to %s" fabbr nabbr))) | |
3903 | (ange-ftp-copy-file-internal filename newname t nil msg) | |
3904 | (let (ange-ftp-process-verbose) | |
3905 | (delete-file filename)))) | |
3906 | ||
3907 | (defun ange-ftp-rename-remote-to-local (filename newname) | |
3908 | "Rename remote file FILENAME to local file NEWNAME." | |
3909 | (let* ((fabbr (ange-ftp-abbreviate-filename filename)) | |
3910 | (nabbr (ange-ftp-abbreviate-filename newname filename)) | |
3911 | (msg (format "Renaming %s to %s" fabbr nabbr))) | |
3912 | (ange-ftp-copy-file-internal filename newname t nil msg) | |
3913 | (let (ange-ftp-process-verbose) | |
3914 | (delete-file filename)))) | |
3915 | ||
3916 | (defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists) | |
3917 | (interactive "fRename file: \nFRename %s to file: \np") | |
3918 | (setq filename (expand-file-name filename)) | |
3919 | (setq newname (expand-file-name newname)) | |
3920 | (let* ((f-parsed (ange-ftp-ftp-name filename)) | |
3921 | (t-parsed (ange-ftp-ftp-name newname))) | |
3922 | (if (and (or f-parsed t-parsed) | |
3923 | (or (not ok-if-already-exists) | |
3924 | (numberp ok-if-already-exists))) | |
3925 | (ange-ftp-barf-or-query-if-file-exists | |
3926 | newname | |
3927 | "rename to it" | |
3928 | (numberp ok-if-already-exists))) | |
3929 | (if f-parsed | |
3930 | (if t-parsed | |
3931 | (ange-ftp-rename-remote-to-remote filename newname f-parsed | |
3932 | t-parsed) | |
3933 | (ange-ftp-rename-remote-to-local filename newname)) | |
3934 | (if t-parsed | |
3935 | (ange-ftp-rename-local-to-remote filename newname) | |
3936 | (ange-ftp-real-rename-file filename newname ok-if-already-exists))))) | |
3937 | \f | |
3938 | ;;;; ------------------------------------------------------------ | |
3939 | ;;;; File name completion support. | |
3940 | ;;;; ------------------------------------------------------------ | |
3941 | ||
8749abea GM |
3942 | ;; If the file entry is not a directory (nor a symlink pointing to a directory) |
3943 | ;; returns whether the file (or file pointed to by the symlink) is ignored | |
3944 | ;; by completion-ignored-extensions. | |
3945 | ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern' | |
3946 | ;; are used as free variables. | |
6e85ef5f SM |
3947 | (defun ange-ftp-file-entry-not-ignored-p (symname val) |
3948 | (if (stringp val) | |
3949 | (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir))) | |
3950 | (or (file-directory-p file) | |
3951 | (and (file-exists-p file) | |
3952 | (not (string-match ange-ftp-completion-ignored-pattern | |
3953 | symname))))) | |
3954 | (or val ; is a directory name | |
3955 | (not (string-match ange-ftp-completion-ignored-pattern symname))))) | |
8749abea | 3956 | |
ae0bec0b SM |
3957 | (defun ange-ftp-root-dir-p (dir) |
3958 | ;; Maybe we should use something more like | |
3959 | ;; (equal dir (file-name-directory (directory-file-name dir))) -stef | |
3960 | (or (and (eq system-type 'windows-nt) | |
aa6f7b96 | 3961 | (string-match "\\`[a-zA-Z]:[/\\]\\'" dir)) |
ae0bec0b SM |
3962 | (string-equal "/" dir))) |
3963 | ||
8749abea GM |
3964 | (defun ange-ftp-file-name-all-completions (file dir) |
3965 | (let ((ange-ftp-this-dir (expand-file-name dir))) | |
3966 | (if (ange-ftp-ftp-name ange-ftp-this-dir) | |
3967 | (progn | |
3968 | (ange-ftp-barf-if-not-directory ange-ftp-this-dir) | |
3969 | (setq ange-ftp-this-dir | |
3970 | (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) | |
3971 | (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir)) | |
e3441f42 | 3972 | (completions (all-completions file tbl))) |
8749abea GM |
3973 | |
3974 | ;; see whether each matching file is a directory or not... | |
3975 | (mapcar | |
25759a92 | 3976 | (lambda (file) |
6e85ef5f | 3977 | (let ((ent (gethash file tbl))) |
25759a92 SS |
3978 | (if (and ent |
3979 | (or (not (stringp ent)) | |
3980 | (file-directory-p | |
3981 | (ange-ftp-expand-symlink ent | |
3982 | ange-ftp-this-dir)))) | |
3983 | (concat file "/") | |
6e85ef5f | 3984 | file))) |
8749abea GM |
3985 | completions))) |
3986 | ||
ae0bec0b | 3987 | (if (ange-ftp-root-dir-p ange-ftp-this-dir) |
8749abea GM |
3988 | (nconc (all-completions file (ange-ftp-generate-root-prefixes)) |
3989 | (ange-ftp-real-file-name-all-completions file | |
3990 | ange-ftp-this-dir)) | |
3991 | (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir))))) | |
3992 | ||
e1e17cae | 3993 | (defun ange-ftp-file-name-completion (file dir &optional predicate) |
8749abea GM |
3994 | (let ((ange-ftp-this-dir (expand-file-name dir))) |
3995 | (if (ange-ftp-ftp-name ange-ftp-this-dir) | |
3996 | (progn | |
3997 | (ange-ftp-barf-if-not-directory ange-ftp-this-dir) | |
3998 | (if (equal file "") | |
3999 | "" | |
4000 | (setq ange-ftp-this-dir | |
4001 | (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real? | |
4002 | (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir)) | |
4003 | (ange-ftp-completion-ignored-pattern | |
25759a92 | 4004 | (mapconcat (lambda (s) (if (stringp s) |
aa6f7b96 SM |
4005 | (concat (regexp-quote s) "$") |
4006 | "/")) ; / never in filename | |
8749abea GM |
4007 | completion-ignored-extensions |
4008 | "\\|"))) | |
4009 | (save-match-data | |
4010 | (or (ange-ftp-file-name-completion-1 | |
4011 | file tbl ange-ftp-this-dir | |
e3441f42 | 4012 | 'ange-ftp-file-entry-not-ignored-p) |
8749abea | 4013 | (ange-ftp-file-name-completion-1 |
e3441f42 | 4014 | file tbl ange-ftp-this-dir)))))) |
8749abea | 4015 | |
ae0bec0b | 4016 | (if (ange-ftp-root-dir-p ange-ftp-this-dir) |
8749abea GM |
4017 | (try-completion |
4018 | file | |
4019 | (nconc (ange-ftp-generate-root-prefixes) | |
7ca26b02 | 4020 | (ange-ftp-real-file-name-all-completions |
e1e17cae MA |
4021 | file ange-ftp-this-dir)) |
4022 | predicate) | |
4023 | (if predicate | |
4024 | (ange-ftp-real-file-name-completion | |
4025 | file ange-ftp-this-dir predicate) | |
4026 | (ange-ftp-real-file-name-completion | |
4027 | file ange-ftp-this-dir)))))) | |
8749abea GM |
4028 | |
4029 | ||
e3441f42 | 4030 | (defun ange-ftp-file-name-completion-1 (file tbl dir &optional predicate) |
8749abea GM |
4031 | (let ((bestmatch (try-completion file tbl predicate))) |
4032 | (if bestmatch | |
4033 | (if (eq bestmatch t) | |
4034 | (if (file-directory-p (expand-file-name file dir)) | |
4035 | (concat file "/") | |
4036 | t) | |
4037 | (if (and (eq (try-completion bestmatch tbl predicate) t) | |
4038 | (file-directory-p | |
4039 | (expand-file-name bestmatch dir))) | |
4040 | (concat bestmatch "/") | |
4041 | bestmatch))))) | |
4042 | ||
4043 | ;; Put these lines uncommmented in your .emacs if you want C-r to refresh | |
4044 | ;; ange-ftp's cache whilst doing filename completion. | |
4045 | ;; | |
4046 | ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir) | |
4047 | ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir) | |
4048 | ||
b2ce953f MR |
4049 | ;;;###autoload |
4050 | (defalias 'ange-ftp-re-read-dir 'ange-ftp-reread-dir) | |
4051 | ||
8749abea GM |
4052 | ;;;###autoload |
4053 | (defun ange-ftp-reread-dir (&optional dir) | |
4054 | "Reread remote directory DIR to update the directory cache. | |
4671dba5 | 4055 | The implementation of remote FTP file names caches directory contents |
8749abea GM |
4056 | for speed. Therefore, when new remote files are created, Emacs |
4057 | may not know they exist. You can use this command to reread a specific | |
4058 | directory, so that Emacs will know its current contents." | |
4059 | (interactive) | |
4060 | (if dir | |
4061 | (setq dir (expand-file-name dir)) | |
4062 | (setq dir (file-name-directory (expand-file-name (buffer-string))))) | |
4063 | (if (ange-ftp-ftp-name dir) | |
4064 | (progn | |
4065 | (setq ange-ftp-ls-cache-file nil) | |
6e85ef5f | 4066 | (remhash dir ange-ftp-files-hashtable) |
8749abea GM |
4067 | (ange-ftp-get-files dir t)))) |
4068 | \f | |
4069 | (defun ange-ftp-make-directory (dir &optional parents) | |
4070 | (interactive (list (expand-file-name (read-file-name "Make directory: ")))) | |
4071 | (if parents | |
4072 | (let ((parent (file-name-directory (directory-file-name dir)))) | |
4073 | (or (file-exists-p parent) | |
4074 | (ange-ftp-make-directory parent parents)))) | |
4075 | (if (file-exists-p dir) | |
4076 | (error "Cannot make directory %s: file already exists" dir) | |
4077 | (let ((parsed (ange-ftp-ftp-name dir))) | |
4078 | (if parsed | |
4079 | (let* ((host (nth 0 parsed)) | |
4080 | (user (nth 1 parsed)) | |
4081 | ;; Some ftp's on unix machines (at least on Suns) | |
4082 | ;; insist that mkdir take a filename, and not a | |
4083 | ;; directory-name name as an arg. Argh!! This is a bug. | |
4084 | ;; Non-unix machines will probably always insist | |
4085 | ;; that mkdir takes a directory-name as an arg | |
4086 | ;; (as the ftp man page says it should). | |
4087 | (name (ange-ftp-quote-string | |
4088 | (if (eq (ange-ftp-host-type host) 'unix) | |
4089 | (ange-ftp-real-directory-file-name (nth 2 parsed)) | |
4090 | (ange-ftp-real-file-name-as-directory | |
4091 | (nth 2 parsed))))) | |
4092 | (abbr (ange-ftp-abbreviate-filename dir)) | |
4093 | (result (ange-ftp-send-cmd host user | |
4094 | (list 'mkdir name) | |
4095 | (format "Making directory %s" | |
4096 | abbr)))) | |
4097 | (or (car result) | |
4098 | (ange-ftp-error host user | |
4099 | (format "Could not make directory %s: %s" | |
4100 | dir | |
4101 | (cdr result)))) | |
4102 | (ange-ftp-add-file-entry dir t)) | |
4103 | (ange-ftp-real-make-directory dir))))) | |
4104 | ||
c90a8a9f | 4105 | (defun ange-ftp-delete-directory (dir &optional recursive) |
8749abea GM |
4106 | (if (file-directory-p dir) |
4107 | (let ((parsed (ange-ftp-ftp-name dir))) | |
b3ee21ac MA |
4108 | (if recursive |
4109 | (mapc | |
4110 | (lambda (file) | |
4111 | (if (file-directory-p file) | |
4112 | (ange-ftp-delete-directory file recursive) | |
4113 | (delete-file file))) | |
4114 | ;; We do not want to delete "." and "..". | |
4115 | (directory-files | |
4116 | dir 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"))) | |
8749abea GM |
4117 | (if parsed |
4118 | (let* ((host (nth 0 parsed)) | |
4119 | (user (nth 1 parsed)) | |
4120 | ;; Some ftp's on unix machines (at least on Suns) | |
4121 | ;; insist that rmdir take a filename, and not a | |
4122 | ;; directory-name name as an arg. Argh!! This is a bug. | |
4123 | ;; Non-unix machines will probably always insist | |
4124 | ;; that rmdir takes a directory-name as an arg | |
4125 | ;; (as the ftp man page says it should). | |
4126 | (name (ange-ftp-quote-string | |
4127 | (if (eq (ange-ftp-host-type host) 'unix) | |
4128 | (ange-ftp-real-directory-file-name | |
4129 | (nth 2 parsed)) | |
4130 | (ange-ftp-real-file-name-as-directory | |
4131 | (nth 2 parsed))))) | |
e3441f42 | 4132 | (abbr (ange-ftp-abbreviate-filename dir)) |
b3ee21ac MA |
4133 | (result |
4134 | (progn | |
4135 | ;; CWD must not in this directory. | |
4136 | (ange-ftp-cd host user "/" 'noerror) | |
4137 | (ange-ftp-send-cmd host user | |
4138 | (list 'rmdir name) | |
4139 | (format "Removing directory %s" | |
4140 | abbr))))) | |
8749abea GM |
4141 | (or (car result) |
4142 | (ange-ftp-error host user | |
4143 | (format "Could not remove directory %s: %s" | |
4144 | dir | |
4145 | (cdr result)))) | |
4146 | (ange-ftp-delete-file-entry dir t)) | |
c90a8a9f | 4147 | (ange-ftp-real-delete-directory dir recursive))) |
8749abea GM |
4148 | (error "Not a directory: %s" dir))) |
4149 | \f | |
4150 | ;; Make a local copy of FILE and return its name. | |
4151 | ||
4152 | (defun ange-ftp-file-local-copy (file) | |
4153 | (let* ((fn1 (expand-file-name file)) | |
4154 | (pa1 (ange-ftp-ftp-name fn1))) | |
4155 | (if pa1 | |
4156 | (let ((tmp1 (ange-ftp-make-tmp-name (car pa1)))) | |
4157 | (ange-ftp-copy-file-internal fn1 tmp1 t nil | |
4158 | (format "Getting %s" fn1)) | |
4159 | tmp1)))) | |
4160 | ||
3bd84a22 MA |
4161 | (defun ange-ftp-file-remote-p (file &optional identification connected) |
4162 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4163 | (host (nth 0 parsed)) | |
d5fb39b4 MA |
4164 | (user (nth 1 parsed)) |
4165 | (localname (nth 2 parsed))) | |
3bd84a22 MA |
4166 | (and (or (not connected) |
4167 | (let ((proc (get-process (ange-ftp-ftp-process-buffer host user)))) | |
4168 | (and proc (processp proc) | |
4169 | (memq (process-status proc) '(run open))))) | |
4170 | (cond | |
4171 | ((eq identification 'method) (and parsed "ftp")) | |
4172 | ((eq identification 'user) user) | |
4173 | ((eq identification 'host) host) | |
d5fb39b4 | 4174 | ((eq identification 'localname) localname) |
3bd84a22 | 4175 | (t (ange-ftp-replace-name-component file "")))))) |
e28c0668 | 4176 | |
8749abea GM |
4177 | (defun ange-ftp-load (file &optional noerror nomessage nosuffix) |
4178 | (if (ange-ftp-ftp-name file) | |
4179 | (let ((tryfiles (if nosuffix | |
4180 | (list file) | |
4181 | (list (concat file ".elc") (concat file ".el") file))) | |
4182 | ;; make sure there are no references to temp files | |
4183 | (load-force-doc-strings t) | |
4184 | copy) | |
4185 | (while (and tryfiles (not copy)) | |
4186 | (catch 'ftp-error | |
4187 | (let ((ange-ftp-waiting-flag t)) | |
4188 | (condition-case error | |
4189 | (setq copy (ange-ftp-file-local-copy (car tryfiles))) | |
4190 | (ftp-error nil)))) | |
4191 | (setq tryfiles (cdr tryfiles))) | |
4192 | (if copy | |
4193 | (unwind-protect | |
4194 | (funcall 'load copy noerror nomessage nosuffix) | |
4195 | (delete-file copy)) | |
4196 | (or noerror | |
4197 | (signal 'file-error (list "Cannot open load file" file))) | |
4198 | nil)) | |
4199 | (ange-ftp-real-load file noerror nomessage nosuffix))) | |
4200 | ||
4201 | ;; Calculate default-unhandled-directory for a given ange-ftp buffer. | |
4202 | (defun ange-ftp-unhandled-file-name-directory (filename) | |
e61e836b | 4203 | nil) |
8749abea GM |
4204 | |
4205 | \f | |
4206 | ;; Need the following functions for making filenames of compressed | |
4207 | ;; files, because some OS's (unlike UNIX) do not allow a filename to | |
4208 | ;; have two extensions. | |
4209 | ||
4210 | (defvar ange-ftp-make-compressed-filename-alist nil | |
4211 | "Alist of host-type-specific functions to process file names for compression. | |
4212 | Each element has the form (TYPE . FUNC). | |
4213 | FUNC should take one argument, a file name, and return a list | |
4214 | of the form (COMPRESSING NEWNAME). | |
25759a92 | 4215 | COMPRESSING should be t if the specified file should be compressed, |
8749abea GM |
4216 | and nil if it should be uncompressed (that is, if it is a compressed file). |
4217 | NEWNAME should be the name to give the new compressed or uncompressed file.") | |
4218 | ||
7e596924 GM |
4219 | (declare-function dired-compress-file "dired-aux" (file)) |
4220 | ||
8749abea | 4221 | (defun ange-ftp-dired-compress-file (name) |
7e596924 | 4222 | "Handler used by `dired-compress-file'." |
8749abea GM |
4223 | (let ((parsed (ange-ftp-ftp-name name)) |
4224 | conversion-func) | |
4225 | (if (and parsed | |
4226 | (setq conversion-func | |
4227 | (cdr (assq (ange-ftp-host-type (car parsed)) | |
4228 | ange-ftp-make-compressed-filename-alist)))) | |
4229 | (let* ((decision | |
4230 | (save-match-data (funcall conversion-func name))) | |
4231 | (compressing (car decision)) | |
4232 | (newfile (nth 1 decision))) | |
4233 | (if compressing | |
4234 | (ange-ftp-compress name newfile) | |
4235 | (ange-ftp-uncompress name newfile))) | |
4236 | (let (file-name-handler-alist) | |
4237 | (dired-compress-file name))))) | |
4238 | ||
4239 | ;; Copy FILE to this machine, compress it, and copy out to NFILE. | |
4240 | (defun ange-ftp-compress (file nfile) | |
4241 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4242 | (tmp1 (ange-ftp-make-tmp-name (car parsed))) | |
4243 | (tmp2 (ange-ftp-make-tmp-name (car parsed))) | |
4244 | (abbr (ange-ftp-abbreviate-filename file)) | |
4245 | (nabbr (ange-ftp-abbreviate-filename nfile)) | |
4246 | (msg1 (format "Getting %s" abbr)) | |
4247 | (msg2 (format "Putting %s" nabbr))) | |
4248 | (unwind-protect | |
4249 | (progn | |
4250 | (ange-ftp-copy-file-internal file tmp1 t nil msg1) | |
4251 | (and ange-ftp-process-verbose | |
4252 | (ange-ftp-message "Compressing %s..." abbr)) | |
4253 | (call-process-region (point) | |
4254 | (point) | |
4255 | shell-file-name | |
4256 | nil | |
4257 | t | |
4258 | nil | |
4259 | "-c" | |
4260 | (format "compress -f -c < %s > %s" tmp1 tmp2)) | |
4261 | (and ange-ftp-process-verbose | |
4262 | (ange-ftp-message "Compressing %s...done" abbr)) | |
4263 | (if (zerop (buffer-size)) | |
4264 | (progn | |
4265 | (let (ange-ftp-process-verbose) | |
4266 | (delete-file file)) | |
4267 | (ange-ftp-copy-file-internal tmp2 nfile t nil msg2)))) | |
4268 | (ange-ftp-del-tmp-name tmp1) | |
4269 | (ange-ftp-del-tmp-name tmp2)))) | |
25759a92 | 4270 | |
8749abea GM |
4271 | ;; Copy FILE to this machine, uncompress it, and copy out to NFILE. |
4272 | (defun ange-ftp-uncompress (file nfile) | |
4273 | (let* ((parsed (ange-ftp-ftp-name file)) | |
4274 | (tmp1 (ange-ftp-make-tmp-name (car parsed))) | |
4275 | (tmp2 (ange-ftp-make-tmp-name (car parsed))) | |
4276 | (abbr (ange-ftp-abbreviate-filename file)) | |
4277 | (nabbr (ange-ftp-abbreviate-filename nfile)) | |
4278 | (msg1 (format "Getting %s" abbr)) | |
4279 | (msg2 (format "Putting %s" nabbr)) | |
4280 | ;; ;; Cheap hack because of problems with binary file transfers from | |
4281 | ;; ;; VMS hosts. | |
4282 | ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed))))) | |
4283 | ) | |
4284 | (unwind-protect | |
4285 | (progn | |
4286 | (ange-ftp-copy-file-internal file tmp1 t nil msg1) | |
4287 | (and ange-ftp-process-verbose | |
4288 | (ange-ftp-message "Uncompressing %s..." abbr)) | |
4289 | (call-process-region (point) | |
4290 | (point) | |
4291 | shell-file-name | |
4292 | nil | |
4293 | t | |
4294 | nil | |
4295 | "-c" | |
4296 | (format "uncompress -c < %s > %s" tmp1 tmp2)) | |
4297 | (and ange-ftp-process-verbose | |
4298 | (ange-ftp-message "Uncompressing %s...done" abbr)) | |
4299 | (if (zerop (buffer-size)) | |
4300 | (progn | |
4301 | (let (ange-ftp-process-verbose) | |
4302 | (delete-file file)) | |
4303 | (ange-ftp-copy-file-internal tmp2 nfile t nil msg2)))) | |
4304 | (ange-ftp-del-tmp-name tmp1) | |
4305 | (ange-ftp-del-tmp-name tmp2)))) | |
4306 | ||
4307 | (defun ange-ftp-find-backup-file-name (fn) | |
4308 | ;; Either return the ordinary backup name, etc., | |
4309 | ;; or return nil meaning don't make a backup. | |
4310 | (if ange-ftp-make-backup-files | |
4311 | (ange-ftp-real-find-backup-file-name fn))) | |
4312 | \f | |
4313 | ;;; Define the handler for special file names | |
4314 | ;;; that causes ange-ftp to be invoked. | |
4315 | ||
4316 | ;;;###autoload | |
4317 | (defun ange-ftp-hook-function (operation &rest args) | |
4318 | (let ((fn (get operation 'ange-ftp))) | |
227eb744 MA |
4319 | (if fn |
4320 | ;; Catch also errors in process-filter. | |
4321 | (condition-case err | |
4322 | (let ((debug-on-error t)) | |
4323 | (save-match-data (apply fn args))) | |
75c23f5f | 4324 | (error (signal (car err) (cdr err)))) |
8749abea | 4325 | (ange-ftp-run-real-handler operation args)))) |
8749abea | 4326 | |
65399e83 KG |
4327 | ;; The following code is commented out because Tramp now deals with |
4328 | ;; Ange-FTP filenames, too. | |
4329 | ||
4330 | ;;-;;; This regexp takes care of real ange-ftp file names (with a slash | |
4331 | ;;-;;; and colon). | |
4332 | ;;-;;; Don't allow the host name to end in a period--some systems use /.: | |
4333 | ;;-;;;###autoload | |
4334 | ;;-(or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist) | |
4335 | ;;- (setq file-name-handler-alist | |
4336 | ;;- (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function) | |
4337 | ;;- file-name-handler-alist))) | |
4338 | ;;- | |
4339 | ;;-;;; This regexp recognizes absolute filenames with only one component, | |
4340 | ;;-;;; for the sake of hostname completion. | |
4341 | ;;-;;;###autoload | |
4342 | ;;-(or (assoc "^/[^/:]*\\'" file-name-handler-alist) | |
4343 | ;;- (setq file-name-handler-alist | |
4344 | ;;- (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function) | |
4345 | ;;- file-name-handler-alist))) | |
4346 | ;;- | |
4347 | ;;-;;; This regexp recognizes absolute filenames with only one component | |
4348 | ;;-;;; on Windows, for the sake of hostname completion. | |
4349 | ;;-;;; NB. Do not mark this as autoload, because it is very common to | |
4350 | ;;-;;; do completions in the root directory of drives on Windows. | |
4351 | ;;-(and (memq system-type '(ms-dos windows-nt)) | |
4352 | ;;- (or (assoc "^[a-zA-Z]:/[^/:]*\\'" file-name-handler-alist) | |
4353 | ;;- (setq file-name-handler-alist | |
4354 | ;;- (cons '("^[a-zA-Z]:/[^/:]*\\'" . | |
4355 | ;;- ange-ftp-completion-hook-function) | |
4356 | ;;- file-name-handler-alist)))) | |
8749abea GM |
4357 | |
4358 | ;;; The above two forms are sufficient to cause this file to be loaded | |
4359 | ;;; if the user ever uses a file name with a colon in it. | |
4360 | ||
25759a92 | 4361 | ;;; This sets the mode |
c8607dc7 | 4362 | (add-hook 'find-file-hook 'ange-ftp-set-buffer-mode) |
8749abea GM |
4363 | |
4364 | ;;; Now say where to find the handlers for particular operations. | |
4365 | ||
4366 | (put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory) | |
4367 | (put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory) | |
4368 | (put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory) | |
4369 | (put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name) | |
4370 | (put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name) | |
4371 | (put 'make-directory 'ange-ftp 'ange-ftp-make-directory) | |
4372 | (put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory) | |
4373 | (put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents) | |
4374 | (put 'directory-files 'ange-ftp 'ange-ftp-directory-files) | |
f06dbf7e MA |
4375 | (put 'directory-files-and-attributes 'ange-ftp |
4376 | 'ange-ftp-directory-files-and-attributes) | |
8749abea GM |
4377 | (put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p) |
4378 | (put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p) | |
4379 | (put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p) | |
4380 | (put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p) | |
4381 | (put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p) | |
4382 | (put 'delete-file 'ange-ftp 'ange-ftp-delete-file) | |
8749abea GM |
4383 | (put 'verify-visited-file-modtime 'ange-ftp |
4384 | 'ange-ftp-verify-visited-file-modtime) | |
4385 | (put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p) | |
4386 | (put 'write-region 'ange-ftp 'ange-ftp-write-region) | |
8749abea GM |
4387 | (put 'copy-file 'ange-ftp 'ange-ftp-copy-file) |
4388 | (put 'rename-file 'ange-ftp 'ange-ftp-rename-file) | |
4389 | (put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes) | |
a1f84f6d | 4390 | (put 'file-newer-than-file-p 'ange-ftp 'ange-ftp-file-newer-than-file-p) |
8749abea GM |
4391 | (put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions) |
4392 | (put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion) | |
4393 | (put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory) | |
4394 | (put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy) | |
e28c0668 | 4395 | (put 'file-remote-p 'ange-ftp 'ange-ftp-file-remote-p) |
8749abea GM |
4396 | (put 'unhandled-file-name-directory 'ange-ftp |
4397 | 'ange-ftp-unhandled-file-name-directory) | |
4398 | (put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions) | |
4399 | (put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache) | |
4400 | (put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file) | |
4401 | (put 'load 'ange-ftp 'ange-ftp-load) | |
4402 | (put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name) | |
c42e03b4 | 4403 | (put 'set-file-modes 'ange-ftp 'ange-ftp-set-file-modes) |
8749abea GM |
4404 | |
4405 | ;; Turn off truename processing to save time. | |
4406 | ;; Treat each name as its own truename. | |
4407 | (put 'file-truename 'ange-ftp 'identity) | |
4408 | ||
b83483d5 MA |
4409 | ;; We must return non-nil in order to mask our inability to do the job. |
4410 | ;; Otherwise there are errors when applied to the target file during | |
4411 | ;; copying from a (localhost) Tramp file. | |
b83483d5 MA |
4412 | (put 'set-file-times 'ange-ftp 'ignore) |
4413 | ||
8749abea GM |
4414 | ;; Turn off RCS/SCCS processing to save time. |
4415 | ;; This returns nil for any file name as argument. | |
4416 | (put 'vc-registered 'ange-ftp 'null) | |
4417 | ||
00d6fd04 | 4418 | ;; We can handle process-file in a restricted way (just for chown). |
b83483d5 | 4419 | ;; Nothing possible for `start-file-process'. |
4a725859 | 4420 | (put 'process-file 'ange-ftp 'ange-ftp-process-file) |
00d6fd04 | 4421 | (put 'start-file-process 'ange-ftp 'ignore) |
8749abea GM |
4422 | (put 'shell-command 'ange-ftp 'ange-ftp-shell-command) |
4423 | \f | |
4424 | ;;; Define ways of getting at unmodified Emacs primitives, | |
4425 | ;;; turning off our handler. | |
4426 | ||
4427 | (defun ange-ftp-run-real-handler (operation args) | |
4428 | (let ((inhibit-file-name-handlers | |
4429 | (cons 'ange-ftp-hook-function | |
4430 | (cons 'ange-ftp-completion-hook-function | |
4431 | (and (eq inhibit-file-name-operation operation) | |
4432 | inhibit-file-name-handlers)))) | |
4433 | (inhibit-file-name-operation operation)) | |
4434 | (apply operation args))) | |
4435 | ||
4436 | (defun ange-ftp-real-file-name-directory (&rest args) | |
4437 | (ange-ftp-run-real-handler 'file-name-directory args)) | |
4438 | (defun ange-ftp-real-file-name-nondirectory (&rest args) | |
4439 | (ange-ftp-run-real-handler 'file-name-nondirectory args)) | |
4440 | (defun ange-ftp-real-file-name-as-directory (&rest args) | |
4441 | (ange-ftp-run-real-handler 'file-name-as-directory args)) | |
4442 | (defun ange-ftp-real-directory-file-name (&rest args) | |
4443 | (ange-ftp-run-real-handler 'directory-file-name args)) | |
4444 | (defun ange-ftp-real-expand-file-name (&rest args) | |
4445 | (ange-ftp-run-real-handler 'expand-file-name args)) | |
4446 | (defun ange-ftp-real-make-directory (&rest args) | |
4447 | (ange-ftp-run-real-handler 'make-directory args)) | |
4448 | (defun ange-ftp-real-delete-directory (&rest args) | |
4449 | (ange-ftp-run-real-handler 'delete-directory args)) | |
4450 | (defun ange-ftp-real-insert-file-contents (&rest args) | |
4451 | (ange-ftp-run-real-handler 'insert-file-contents args)) | |
4452 | (defun ange-ftp-real-directory-files (&rest args) | |
4453 | (ange-ftp-run-real-handler 'directory-files args)) | |
f06dbf7e MA |
4454 | (defun ange-ftp-real-directory-files-and-attributes (&rest args) |
4455 | (ange-ftp-run-real-handler 'directory-files-and-attributes args)) | |
8749abea GM |
4456 | (defun ange-ftp-real-file-directory-p (&rest args) |
4457 | (ange-ftp-run-real-handler 'file-directory-p args)) | |
4458 | (defun ange-ftp-real-file-writable-p (&rest args) | |
4459 | (ange-ftp-run-real-handler 'file-writable-p args)) | |
4460 | (defun ange-ftp-real-file-readable-p (&rest args) | |
4461 | (ange-ftp-run-real-handler 'file-readable-p args)) | |
4462 | (defun ange-ftp-real-file-executable-p (&rest args) | |
4463 | (ange-ftp-run-real-handler 'file-executable-p args)) | |
4464 | (defun ange-ftp-real-file-symlink-p (&rest args) | |
4465 | (ange-ftp-run-real-handler 'file-symlink-p args)) | |
4466 | (defun ange-ftp-real-delete-file (&rest args) | |
4467 | (ange-ftp-run-real-handler 'delete-file args)) | |
8749abea GM |
4468 | (defun ange-ftp-real-verify-visited-file-modtime (&rest args) |
4469 | (ange-ftp-run-real-handler 'verify-visited-file-modtime args)) | |
4470 | (defun ange-ftp-real-file-exists-p (&rest args) | |
4471 | (ange-ftp-run-real-handler 'file-exists-p args)) | |
4472 | (defun ange-ftp-real-write-region (&rest args) | |
4473 | (ange-ftp-run-real-handler 'write-region args)) | |
4474 | (defun ange-ftp-real-backup-buffer (&rest args) | |
4475 | (ange-ftp-run-real-handler 'backup-buffer args)) | |
4476 | (defun ange-ftp-real-copy-file (&rest args) | |
4477 | (ange-ftp-run-real-handler 'copy-file args)) | |
4478 | (defun ange-ftp-real-rename-file (&rest args) | |
4479 | (ange-ftp-run-real-handler 'rename-file args)) | |
4480 | (defun ange-ftp-real-file-attributes (&rest args) | |
4481 | (ange-ftp-run-real-handler 'file-attributes args)) | |
a1f84f6d SS |
4482 | (defun ange-ftp-real-file-newer-than-file-p (&rest args) |
4483 | (ange-ftp-run-real-handler 'file-newer-than-file-p args)) | |
8749abea GM |
4484 | (defun ange-ftp-real-file-name-all-completions (&rest args) |
4485 | (ange-ftp-run-real-handler 'file-name-all-completions args)) | |
4486 | (defun ange-ftp-real-file-name-completion (&rest args) | |
4487 | (ange-ftp-run-real-handler 'file-name-completion args)) | |
4488 | (defun ange-ftp-real-insert-directory (&rest args) | |
4489 | (ange-ftp-run-real-handler 'insert-directory args)) | |
4490 | (defun ange-ftp-real-file-name-sans-versions (&rest args) | |
4491 | (ange-ftp-run-real-handler 'file-name-sans-versions args)) | |
4492 | (defun ange-ftp-real-shell-command (&rest args) | |
4493 | (ange-ftp-run-real-handler 'shell-command args)) | |
4494 | (defun ange-ftp-real-load (&rest args) | |
4495 | (ange-ftp-run-real-handler 'load args)) | |
4496 | (defun ange-ftp-real-find-backup-file-name (&rest args) | |
4497 | (ange-ftp-run-real-handler 'find-backup-file-name args)) | |
4498 | \f | |
4499 | ;; Here we support using dired on remote hosts. | |
4500 | ;; I have turned off the support for using dired on foreign directory formats. | |
4501 | ;; That involves too many unclean hooks. | |
25759a92 | 4502 | ;; It would be cleaner to support such operations by |
8749abea GM |
4503 | ;; converting the foreign directory format to something dired can understand; |
4504 | ;; something close to ls -l output. | |
4505 | ;; The logical place to do this is in the functions ange-ftp-parse-...-listing. | |
4506 | ||
4507 | ;; Some of the old dired hooks would still be needed even if this is done. | |
4508 | ;; I have preserved (and modernized) those hooks. | |
4509 | ;; So the format conversion should be all that is needed. | |
4510 | ||
1fc85dae KG |
4511 | ;; When called from dired, SWITCHES may start with "--dired". |
4512 | ;; `ange-ftp-ls' handles this. | |
4513 | ||
8749abea | 4514 | (defun ange-ftp-insert-directory (file switches &optional wildcard full) |
3bd1644e SM |
4515 | (if (not (ange-ftp-ftp-name (expand-file-name file))) |
4516 | (ange-ftp-real-insert-directory file switches wildcard full) | |
b63f6e81 SM |
4517 | ;; We used to follow symlinks on `file' here. Apparently it was done |
4518 | ;; because some FTP servers react to "ls foo" by listing the symlink foo | |
4519 | ;; rather than the directory it points to. Now that ange-ftp-ls uses | |
4520 | ;; "cd foo; ls" instead, this is not necesssary any more. | |
ecbaeb7b MA |
4521 | (let ((beg (point)) |
4522 | (end (point-marker))) | |
4523 | (set-marker-insertion-type end t) | |
4524 | (insert | |
4525 | (cond | |
4526 | (wildcard | |
4527 | (let ((default-directory (file-name-directory file))) | |
4528 | (ange-ftp-ls (file-name-nondirectory file) switches nil nil t))) | |
4529 | (full | |
4530 | (ange-ftp-ls file switches 'parse)) | |
4531 | (t | |
4532 | ;; If `full' is nil we're going to do `ls' for a single file. | |
4533 | ;; Problem is that for various reasons, ange-ftp-ls needs to cd and | |
4534 | ;; then do an ls of current dir, which obviously won't work if we | |
4535 | ;; want to ls a file. So instead, we get a full listing of the | |
4536 | ;; parent directory and extract the line corresponding to `file'. | |
4537 | (when (string-match "-?d\\'" switches) | |
4538 | ;; Remove "d" which dired added to `switches'. | |
4539 | (setq switches (substring switches 0 (match-beginning 0)))) | |
4540 | (setq file (directory-file-name file)) | |
4541 | (let* ((dirlist (ange-ftp-ls (or (file-name-directory file) ".") | |
4542 | switches 'parse)) | |
4543 | (filename (file-name-nondirectory file)) | |
4544 | (case-fold-search nil)) | |
4545 | ;; FIXME: This presumes a particular output format, which is | |
4546 | ;; basically Unix. | |
4547 | (if (string-match (concat "^.+[^ ] " (regexp-quote filename) | |
4548 | "\\( -> .*\\)?[@/*=]?\n") dirlist) | |
4549 | (match-string 0 dirlist) | |
4550 | ""))))) | |
4551 | ||
4552 | ;; Insert " " for dired's alignment sanity. | |
4553 | (goto-char beg) | |
4554 | (while (re-search-forward "^\\(\\S-\\)" end 'move) | |
4555 | (replace-match " \\1")) | |
4556 | ||
4557 | ;; The inserted file could be from somewhere else. | |
4558 | (when (and (not wildcard) (not full) | |
4559 | (search-backward | |
4560 | (if (zerop (length (file-name-nondirectory | |
4561 | (expand-file-name file)))) | |
4562 | "." | |
4563 | (file-name-nondirectory file)) | |
4564 | nil 'noerror)) | |
4565 | (replace-match (file-relative-name (expand-file-name file)) t) | |
4566 | (goto-char end)) | |
4567 | ||
4568 | (set-marker end nil)))) | |
8749abea GM |
4569 | |
4570 | (defun ange-ftp-dired-uncache (dir) | |
4571 | (if (ange-ftp-ftp-name (expand-file-name dir)) | |
4572 | (setq ange-ftp-ls-cache-file nil))) | |
4573 | ||
4574 | (defvar ange-ftp-sans-version-alist nil | |
4575 | "Alist of mapping host type into function to remove file version numbers.") | |
4576 | ||
4577 | (defun ange-ftp-file-name-sans-versions (file keep-backup-version) | |
4578 | (let* ((short (ange-ftp-abbreviate-filename file)) | |
4579 | (parsed (ange-ftp-ftp-name short)) | |
3bd1644e SM |
4580 | (func (if parsed (cdr (assq (ange-ftp-host-type (car parsed)) |
4581 | ange-ftp-sans-version-alist))))) | |
8749abea GM |
4582 | (if func (funcall func file keep-backup-version) |
4583 | (ange-ftp-real-file-name-sans-versions file keep-backup-version)))) | |
4584 | ||
4585 | ;; This is the handler for shell-command. | |
4586 | (defun ange-ftp-shell-command (command &optional output-buffer error-buffer) | |
4587 | (let* ((parsed (ange-ftp-ftp-name default-directory)) | |
4588 | (host (nth 0 parsed)) | |
4589 | (user (nth 1 parsed)) | |
4590 | (name (nth 2 parsed))) | |
4591 | (if (not parsed) | |
4592 | (ange-ftp-real-shell-command command output-buffer error-buffer) | |
4593 | (if (> (length name) 0) ; else it's $HOME | |
4594 | (setq command (concat "cd " name "; " command))) | |
cdc51589 | 4595 | ;; Remove port from the hostname |
ae0bec0b SM |
4596 | (when (string-match "\\(.*\\)#" host) |
4597 | (setq host (match-string 1 host))) | |
8749abea GM |
4598 | (setq command |
4599 | (format "%s %s \"%s\"" ; remsh -l USER does not work well | |
4600 | ; on a hp-ux machine I tried | |
4601 | remote-shell-program host command)) | |
4602 | (ange-ftp-message "Remote command '%s' ..." command) | |
4603 | ;; Cannot call ange-ftp-real-dired-run-shell-command here as it | |
4604 | ;; would prepend "cd default-directory" --- which bombs because | |
4605 | ;; default-directory is in ange-ftp syntax for remote file names. | |
4606 | (ange-ftp-real-shell-command command output-buffer error-buffer)))) | |
4607 | ||
4a725859 MA |
4608 | ;;; This is the handler for process-file. |
4609 | (defun ange-ftp-process-file (program infile buffer display &rest arguments) | |
8749abea GM |
4610 | ;; PROGRAM is always one of those below in the cond in dired.el. |
4611 | ;; The ARGUMENTS are (nearly) always files. | |
4612 | (if (ange-ftp-ftp-name default-directory) | |
4613 | ;; Can't use ange-ftp-dired-host-type here because the current | |
4614 | ;; buffer is *dired-check-process output* | |
4615 | (condition-case oops | |
5cf3709c GM |
4616 | (cond ((equal (or (bound-and-true-p dired-chmod-program) "chmod") |
4617 | program) | |
8749abea GM |
4618 | (ange-ftp-call-chmod arguments)) |
4619 | ;; ((equal "chgrp" program)) | |
4620 | ;; ((equal dired-chown-program program)) | |
4621 | (t (error "Unknown remote command: %s" program))) | |
4622 | (ftp-error (insert (format "%s: %s, %s\n" | |
e3441f42 SM |
4623 | (nth 1 oops) |
4624 | (nth 2 oops) | |
4625 | (nth 3 oops))) | |
8749abea GM |
4626 | ;; Caller expects nonzero value to mean failure. |
4627 | 1) | |
4628 | (error (insert (format "%s\n" (nth 1 oops))) | |
4629 | 1)) | |
4a725859 | 4630 | (apply 'call-process program infile buffer display arguments))) |
8749abea | 4631 | |
8749abea GM |
4632 | ;; Handle an attempt to run chmod on a remote file |
4633 | ;; by using the ftp chmod command. | |
4634 | (defun ange-ftp-call-chmod (args) | |
4635 | (if (< (length args) 2) | |
4636 | (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args)) | |
4637 | (let ((mode (car args)) | |
4638 | (rest (cdr args))) | |
4639 | (if (equal "--" (car rest)) | |
4640 | (setq rest (cdr rest))) | |
d590ea4d | 4641 | (mapc |
25759a92 SS |
4642 | (lambda (file) |
4643 | (setq file (expand-file-name file)) | |
4644 | (let ((parsed (ange-ftp-ftp-name file))) | |
4645 | (if parsed | |
4646 | (let* ((host (nth 0 parsed)) | |
4647 | (user (nth 1 parsed)) | |
4648 | (name (ange-ftp-quote-string (nth 2 parsed))) | |
4649 | (abbr (ange-ftp-abbreviate-filename file)) | |
4650 | (result (ange-ftp-send-cmd host user | |
4651 | (list 'chmod mode name) | |
4652 | (format "doing chmod %s" | |
4653 | abbr)))) | |
4654 | (or (car result) | |
c42e03b4 MA |
4655 | (ange-ftp-error |
4656 | host user (concat "CHMOD failed: " (cdr result)))))))) | |
8749abea GM |
4657 | rest)) |
4658 | (setq ange-ftp-ls-cache-file nil) ;Stop confusing Dired. | |
4659 | 0) | |
c42e03b4 MA |
4660 | |
4661 | (defun ange-ftp-set-file-modes (filename mode) | |
4662 | (ange-ftp-call-chmod (list (format "%o" mode) filename))) | |
8749abea | 4663 | \f |
92482d77 SM |
4664 | ;; This is turned off because it has nothing properly to do |
4665 | ;; with dired. It could be reasonable to adapt this to | |
4666 | ;; replace ange-ftp-copy-file. | |
8749abea GM |
4667 | |
4668 | ;;;;; ------------------------------------------------------------ | |
4669 | ;;;;; Noddy support for async copy-file within dired. | |
4670 | ;;;;; ------------------------------------------------------------ | |
4671 | ||
4672 | ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait) | |
4673 | ;; "Documented as original." | |
4674 | ;; (dired-handle-overwrite to) | |
4675 | ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil | |
4676 | ;; cont nowait)) | |
4677 | ||
4678 | ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg | |
4679 | ;; &optional marker-char op1 | |
4680 | ;; how-to) | |
4681 | ;; "Documented as original." | |
4682 | ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly | |
4683 | ;; ;; called it rather than somebody else. | |
4684 | ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is | |
4685 | ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation | |
4686 | ;; arg marker-char op1 how-to))) | |
4687 | ||
4688 | ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor | |
4689 | ;; &optional marker-char) | |
4690 | ;; "Documented as original." | |
4691 | ;; (if (and (boundp 'ange-ftp-dired-do-create-files) | |
4692 | ;; ;; called from ange-ftp-dired-do-create-files? | |
4693 | ;; ange-ftp-dired-do-create-files | |
4694 | ;; ;; any files worth copying? | |
4695 | ;; fn-list | |
4696 | ;; ;; we only support async copy-file at the mo. | |
4697 | ;; (eq file-creator 'dired-copy-file) | |
4698 | ;; ;; it is only worth calling the alternative function for remote files | |
4699 | ;; ;; as we tie ourself in recursive knots otherwise. | |
4700 | ;; (or (ange-ftp-ftp-name (car fn-list)) | |
4701 | ;; ;; we can only call the name constructor for dired-do-create-files | |
4702 | ;; ;; since the one for regexps starts prompting here, there and | |
4703 | ;; ;; everywhere. | |
4704 | ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list))))) | |
4705 | ;; ;; use the process-filter driven routine rather than the iterative one. | |
4706 | ;; (ange-ftp-dcf-1 file-creator | |
4707 | ;; operation | |
4708 | ;; fn-list | |
4709 | ;; name-constructor | |
4710 | ;; (and (boundp 'target) target) ;dynamically bound | |
4711 | ;; marker-char | |
4712 | ;; (current-buffer) | |
4713 | ;; nil ;overwrite-query | |
4714 | ;; nil ;overwrite-backup-query | |
4715 | ;; nil ;failures | |
4716 | ;; nil ;skipped | |
4717 | ;; 0 ;success-count | |
4718 | ;; (length fn-list) ;total | |
4719 | ;; ) | |
4720 | ;; ;; normal case... use the interactive routine... much cheaper. | |
4721 | ;; (ange-ftp-real-dired-create-files file-creator operation fn-list | |
4722 | ;; name-constructor marker-char))) | |
4723 | ||
4724 | ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor | |
25759a92 | 4725 | ;; target marker-char buffer overwrite-query |
8749abea GM |
4726 | ;; overwrite-backup-query failures skipped |
4727 | ;; success-count total) | |
b63f6e81 | 4728 | ;; (with-current-buffer buffer |
8749abea GM |
4729 | ;; (if (null fn-list) |
4730 | ;; (ange-ftp-dcf-3 failures operation total skipped | |
4731 | ;; success-count buffer) | |
25759a92 | 4732 | |
8749abea GM |
4733 | ;; (let* ((from (car fn-list)) |
4734 | ;; (to (funcall name-constructor from))) | |
4735 | ;; (if (equal to from) | |
4736 | ;; (progn | |
4737 | ;; (setq to nil) | |
4738 | ;; (dired-log "Cannot %s to same file: %s\n" | |
4739 | ;; (downcase operation) from))) | |
4740 | ;; (if (not to) | |
4741 | ;; (ange-ftp-dcf-1 file-creator | |
4742 | ;; operation | |
4743 | ;; (cdr fn-list) | |
4744 | ;; name-constructor | |
4745 | ;; target | |
4746 | ;; marker-char | |
4747 | ;; buffer | |
4748 | ;; overwrite-query | |
4749 | ;; overwrite-backup-query | |
4750 | ;; failures | |
4751 | ;; (cons (dired-make-relative from) skipped) | |
4752 | ;; success-count | |
4753 | ;; total) | |
4754 | ;; (let* ((overwrite (file-exists-p to)) | |
4755 | ;; (overwrite-confirmed ; for dired-handle-overwrite | |
4756 | ;; (and overwrite | |
4757 | ;; (let ((help-form '(format "\ | |
4758 | ;;Type SPC or `y' to overwrite file `%s', | |
4759 | ;;DEL or `n' to skip to next, | |
4760 | ;;ESC or `q' to not overwrite any of the remaining files, | |
4761 | ;;`!' to overwrite all remaining files with no more questions." to))) | |
4762 | ;; (dired-query 'overwrite-query | |
4763 | ;; "Overwrite `%s'?" to)))) | |
4764 | ;; ;; must determine if FROM is marked before file-creator | |
4765 | ;; ;; gets a chance to delete it (in case of a move). | |
4766 | ;; (actual-marker-char | |
4767 | ;; (cond ((integerp marker-char) marker-char) | |
4768 | ;; (marker-char (dired-file-marker from)) ; slow | |
4769 | ;; (t nil)))) | |
4770 | ;; (condition-case err | |
4771 | ;; (funcall file-creator from to overwrite-confirmed | |
e3441f42 | 4772 | ;; (list 'ange-ftp-dcf-2 |
8749abea GM |
4773 | ;; nil ;err |
4774 | ;; file-creator operation fn-list | |
4775 | ;; name-constructor | |
4776 | ;; target | |
4777 | ;; marker-char actual-marker-char | |
4778 | ;; buffer to from | |
4779 | ;; overwrite | |
4780 | ;; overwrite-confirmed | |
25759a92 | 4781 | ;; overwrite-query |
8749abea GM |
4782 | ;; overwrite-backup-query |
4783 | ;; failures skipped success-count | |
4784 | ;; total) | |
4785 | ;; t) | |
4786 | ;; (file-error ; FILE-CREATOR aborted | |
4787 | ;; (ange-ftp-dcf-2 nil ;result | |
4788 | ;; nil ;line | |
4789 | ;; err | |
4790 | ;; file-creator operation fn-list | |
4791 | ;; name-constructor | |
4792 | ;; target | |
4793 | ;; marker-char actual-marker-char | |
4794 | ;; buffer to from | |
4795 | ;; overwrite | |
4796 | ;; overwrite-confirmed | |
25759a92 | 4797 | ;; overwrite-query |
8749abea GM |
4798 | ;; overwrite-backup-query |
4799 | ;; failures skipped success-count | |
b63f6e81 | 4800 | ;; total))))))))) |
8749abea GM |
4801 | |
4802 | ;;(defun ange-ftp-dcf-2 (result line err | |
4803 | ;; file-creator operation fn-list | |
4804 | ;; name-constructor | |
4805 | ;; target | |
4806 | ;; marker-char actual-marker-char | |
4807 | ;; buffer to from | |
4808 | ;; overwrite | |
4809 | ;; overwrite-confirmed | |
25759a92 | 4810 | ;; overwrite-query |
8749abea GM |
4811 | ;; overwrite-backup-query |
4812 | ;; failures skipped success-count | |
4813 | ;; total) | |
b63f6e81 | 4814 | ;; (with-current-buffer buffer |
8749abea GM |
4815 | ;; (if (or err (not result)) |
4816 | ;; (progn | |
4817 | ;; (setq failures (cons (dired-make-relative from) failures)) | |
4818 | ;; (dired-log "%s `%s' to `%s' failed:\n%s\n" | |
4819 | ;; operation from to (or err line))) | |
4820 | ;; (if overwrite | |
4821 | ;; ;; If we get here, file-creator hasn't been aborted | |
4822 | ;; ;; and the old entry (if any) has to be deleted | |
4823 | ;; ;; before adding the new entry. | |
4824 | ;; (dired-remove-file to)) | |
4825 | ;; (setq success-count (1+ success-count)) | |
4826 | ;; (message "%s: %d of %d" operation success-count total) | |
4827 | ;; (dired-add-file to actual-marker-char)) | |
25759a92 | 4828 | |
8749abea GM |
4829 | ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list) |
4830 | ;; name-constructor | |
4831 | ;; target | |
4832 | ;; marker-char | |
4833 | ;; buffer | |
25759a92 | 4834 | ;; overwrite-query |
8749abea GM |
4835 | ;; overwrite-backup-query |
4836 | ;; failures skipped success-count | |
b63f6e81 | 4837 | ;; total))) |
8749abea GM |
4838 | |
4839 | ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count | |
4840 | ;; buffer) | |
b63f6e81 | 4841 | ;; (with-current-buffer buffer |
8749abea GM |
4842 | ;; (cond |
4843 | ;; (failures | |
4844 | ;; (dired-log-summary | |
4845 | ;; (message "%s failed for %d of %d file%s %s" | |
4846 | ;; operation (length failures) total | |
4847 | ;; (dired-plural-s total) failures))) | |
4848 | ;; (skipped | |
4849 | ;; (dired-log-summary | |
4850 | ;; (message "%s: %d of %d file%s skipped %s" | |
4851 | ;; operation (length skipped) total | |
4852 | ;; (dired-plural-s total) skipped))) | |
4853 | ;; (t | |
4854 | ;; (message "%s: %s file%s." | |
4855 | ;; operation success-count (dired-plural-s success-count)))) | |
b63f6e81 | 4856 | ;; (dired-move-to-filename))) |
8749abea GM |
4857 | \f |
4858 | ;;;; ----------------------------------------------- | |
4859 | ;;;; Unix Descriptive Listing (dl) Support | |
4860 | ;;;; ----------------------------------------------- | |
4861 | ||
4862 | ;; This is turned off because nothing uses it currently | |
4863 | ;; and because I don't understand what it's supposed to be for. --rms. | |
4864 | ||
4865 | ;;(defconst ange-ftp-dired-dl-re-dir | |
4866 | ;; "^. [^ /]+/[ \n]" | |
4867 | ;; "Regular expression to use to search for dl directories.") | |
4868 | ||
4869 | ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist) | |
4870 | ;; (setq ange-ftp-dired-re-dir-alist | |
4871 | ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir) | |
4872 | ;; ange-ftp-dired-re-dir-alist))) | |
4873 | ||
4874 | ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol) | |
4875 | ;; "In dired, move to the first character of the filename on this line." | |
4876 | ;; ;; This is the Unix dl version. | |
4877 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
4878 | ;; (let (case-fold-search) | |
4879 | ;; (beginning-of-line) | |
4880 | ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ") | |
4881 | ;; (goto-char (+ (point) 2)) | |
4882 | ;; (if raise-error | |
4883 | ;; (error "No file on this line") | |
4884 | ;; nil)))) | |
4885 | ||
4886 | ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist) | |
4887 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
4888 | ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename) | |
4889 | ;; ange-ftp-dired-move-to-filename-alist))) | |
4890 | ||
4891 | ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol) | |
4892 | ;; ;; Assumes point is at beginning of filename. | |
4893 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
4894 | ;; ;; On failure, signals an error or returns nil. | |
4895 | ;; ;; This is the Unix dl version. | |
4896 | ;; (let ((opoint (point)) | |
4897 | ;; case-fold-search hidden) | |
4898 | ;; (or eol (setq eol (save-excursion (end-of-line) (point)))) | |
4899 | ;; (setq hidden (and selective-display | |
4900 | ;; (save-excursion | |
4901 | ;; (search-forward "\r" eol t)))) | |
4902 | ;; (if hidden | |
4903 | ;; (if no-error | |
4904 | ;; nil | |
4905 | ;; (error | |
4906 | ;; (substitute-command-keys | |
4907 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide"))) | |
4908 | ;; (skip-chars-forward "^ /" eol) | |
4909 | ;; (if (eq opoint (point)) | |
4910 | ;; (if no-error | |
4911 | ;; nil | |
4912 | ;; (error "No file on this line")) | |
4913 | ;; (point))))) | |
4914 | ||
4915 | ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist) | |
4916 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
4917 | ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename) | |
4918 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
4919 | \f | |
4920 | ;;;; ------------------------------------------------------------ | |
4921 | ;;;; VOS support (VOS support is probably broken, | |
4922 | ;;;; but I don't know anything about VOS.) | |
4923 | ;;;; ------------------------------------------------------------ | |
4924 | ; | |
4925 | ;(defun ange-ftp-fix-name-for-vos (name &optional reverse) | |
4926 | ; (setq name (copy-sequence name)) | |
4927 | ; (let ((from (if reverse ?\> ?\/)) | |
4928 | ; (to (if reverse ?\/ ?\>)) | |
4929 | ; (i (1- (length name)))) | |
4930 | ; (while (>= i 0) | |
4931 | ; (if (= (aref name i) from) | |
4932 | ; (aset name i to)) | |
4933 | ; (setq i (1- i))) | |
4934 | ; name)) | |
4935 | ; | |
4936 | ;(or (assq 'vos ange-ftp-fix-name-func-alist) | |
4937 | ; (setq ange-ftp-fix-name-func-alist | |
4938 | ; (cons '(vos . ange-ftp-fix-name-for-vos) | |
4939 | ; ange-ftp-fix-name-func-alist))) | |
4940 | ; | |
4941 | ;(or (memq 'vos ange-ftp-dumb-host-types) | |
4942 | ; (setq ange-ftp-dumb-host-types | |
4943 | ; (cons 'vos ange-ftp-dumb-host-types))) | |
4944 | ; | |
4945 | ;(defun ange-ftp-fix-dir-name-for-vos (dir-name) | |
4946 | ; (ange-ftp-fix-name-for-vos | |
4947 | ; (concat dir-name | |
4948 | ; (if (eq ?/ (aref dir-name (1- (length dir-name)))) | |
4949 | ; "" "/") | |
4950 | ; "*"))) | |
4951 | ; | |
4952 | ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist) | |
4953 | ; (setq ange-ftp-fix-dir-name-func-alist | |
4954 | ; (cons '(vos . ange-ftp-fix-dir-name-for-vos) | |
4955 | ; ange-ftp-fix-dir-name-func-alist))) | |
4956 | ; | |
4957 | ;(defvar ange-ftp-vos-host-regexp nil | |
4958 | ; "If a host matches this regexp then it is assumed to be running VOS.") | |
4959 | ; | |
4960 | ;(defun ange-ftp-vos-host (host) | |
4961 | ; (and ange-ftp-vos-host-regexp | |
4962 | ; (save-match-data | |
4963 | ; (string-match ange-ftp-vos-host-regexp host)))) | |
4964 | ; | |
4965 | ;(defun ange-ftp-parse-vos-listing () | |
4966 | ; "Parse the current buffer which is assumed to be in VOS list -all | |
4967 | ;format, and return a hashtable as the result." | |
4968 | ; (let ((tbl (ange-ftp-make-hashtable)) | |
4969 | ; (type-list | |
4970 | ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40) | |
4971 | ; ("^Dirs: [0-9]+\n+" t 30))) | |
4972 | ; type-regexp type-is-dir type-col file) | |
4973 | ; (goto-char (point-min)) | |
4974 | ; (save-match-data | |
4975 | ; (while type-list | |
4976 | ; (setq type-regexp (car (car type-list)) | |
4977 | ; type-is-dir (nth 1 (car type-list)) | |
4978 | ; type-col (nth 2 (car type-list)) | |
4979 | ; type-list (cdr type-list)) | |
4980 | ; (if (re-search-forward type-regexp nil t) | |
4981 | ; (while (eq (char-after (point)) ? ) | |
4982 | ; (move-to-column type-col) | |
4983 | ; (setq file (buffer-substring (point) | |
4984 | ; (progn | |
4985 | ; (end-of-line 1) | |
4986 | ; (point)))) | |
6e85ef5f | 4987 | ; (puthash file type-is-dir tbl) |
8749abea | 4988 | ; (forward-line 1)))) |
6e85ef5f SM |
4989 | ; (puthash "." 'vosdir tbl) |
4990 | ; (puthash ".." 'vosdir tbl)) | |
8749abea GM |
4991 | ; tbl)) |
4992 | ; | |
4993 | ;(or (assq 'vos ange-ftp-parse-list-func-alist) | |
4994 | ; (setq ange-ftp-parse-list-func-alist | |
4995 | ; (cons '(vos . ange-ftp-parse-vos-listing) | |
4996 | ; ange-ftp-parse-list-func-alist))) | |
4997 | \f | |
4998 | ;;;; ------------------------------------------------------------ | |
4999 | ;;;; VMS support. | |
5000 | ;;;; ------------------------------------------------------------ | |
5001 | ||
5002 | ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS | |
5003 | ;; to UNIX-ish. | |
5004 | (defun ange-ftp-fix-name-for-vms (name &optional reverse) | |
5005 | (save-match-data | |
5006 | (if reverse | |
aa6f7b96 | 5007 | (if (string-match "\\`\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)\\'" name) |
8749abea | 5008 | (let (drive dir file) |
e3441f42 SM |
5009 | (setq drive (match-string 1 name)) |
5010 | (setq dir (match-string 2 name)) | |
5011 | (setq file (match-string 3 name)) | |
8749abea | 5012 | (and dir |
a1f84f6d | 5013 | (setq dir (subst-char-in-string |
a724ed38 | 5014 | ?/ ?. (substring dir 1 -1) t))) |
8749abea GM |
5015 | (concat (and drive |
5016 | (concat "/" drive "/")) | |
5017 | dir (and dir "/") | |
5018 | file)) | |
5019 | (error "name %s didn't match" name)) | |
5020 | (let (drive dir file tmp) | |
aa6f7b96 | 5021 | (if (string-match "\\`/[^:]+:/" name) |
8749abea GM |
5022 | (setq drive (substring name 1 |
5023 | (1- (match-end 0))) | |
5024 | name (substring name (match-end 0)))) | |
5025 | (setq tmp (file-name-directory name)) | |
5026 | (if tmp | |
a724ed38 | 5027 | (setq dir (subst-char-in-string ?/ ?. (substring tmp 0 -1) t))) |
8749abea GM |
5028 | (setq file (file-name-nondirectory name)) |
5029 | (concat drive | |
5030 | (and dir (concat "[" (if drive nil ".") dir "]")) | |
5031 | file))))) | |
5032 | ||
5033 | ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1") | |
5034 | ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t) | |
5035 | ||
5036 | (or (assq 'vms ange-ftp-fix-name-func-alist) | |
5037 | (setq ange-ftp-fix-name-func-alist | |
5038 | (cons '(vms . ange-ftp-fix-name-for-vms) | |
5039 | ange-ftp-fix-name-func-alist))) | |
5040 | ||
5041 | (or (memq 'vms ange-ftp-dumb-host-types) | |
5042 | (setq ange-ftp-dumb-host-types | |
5043 | (cons 'vms ange-ftp-dumb-host-types))) | |
5044 | ||
5045 | ;; It is important that this function barf for directories for which we know | |
5046 | ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/". | |
5047 | ;; This is because it saves an unnecessary FTP error, or possibly the listing | |
5048 | ;; might succeed, but give erroneous info. This last case is particularly | |
5049 | ;; likely for OS's (like MTS) for which we need to use a wildcard in order | |
5050 | ;; to list a directory. | |
5051 | ||
5052 | ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing. | |
5053 | (defun ange-ftp-fix-dir-name-for-vms (dir-name) | |
5054 | ;; Should there be entries for .. -> [-] and . -> [] below. Don't | |
5055 | ;; think so, because expand-filename should have already short-circuited | |
5056 | ;; them. | |
5057 | (cond ((string-equal dir-name "/") | |
55535639 | 5058 | (error "Cannot get listing for fictitious \"/\" directory")) |
aa6f7b96 | 5059 | ((string-match "\\`/[-A-Z0-9_$]+:/\\'" dir-name) |
55535639 | 5060 | (error "Cannot get listing for device")) |
8749abea | 5061 | ((ange-ftp-fix-name-for-vms dir-name)))) |
25759a92 | 5062 | |
8749abea GM |
5063 | (or (assq 'vms ange-ftp-fix-dir-name-func-alist) |
5064 | (setq ange-ftp-fix-dir-name-func-alist | |
5065 | (cons '(vms . ange-ftp-fix-dir-name-for-vms) | |
5066 | ange-ftp-fix-dir-name-func-alist))) | |
5067 | ||
5068 | (defvar ange-ftp-vms-host-regexp nil) | |
5069 | ||
5070 | ;; Return non-nil if HOST is running VMS. | |
5071 | (defun ange-ftp-vms-host (host) | |
5072 | (and ange-ftp-vms-host-regexp | |
4671dba5 | 5073 | (string-match-p ange-ftp-vms-host-regexp host))) |
8749abea GM |
5074 | |
5075 | ;; Because some VMS ftp servers convert filenames to lower case | |
5076 | ;; we allow a-z in the filename regexp. I'm not too happy about this. | |
5077 | ||
5078 | (defconst ange-ftp-vms-filename-regexp | |
5079 | (concat | |
5080 | "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\." | |
5081 | "[-_A-Za-z0-9$]*;+[0-9]*\\)") | |
5082 | "Regular expression to match for a valid VMS file name in Dired buffer. | |
4671dba5 JB |
5083 | Stupid freaking bug! Position of _ and $ shouldn't matter but they do. |
5084 | Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX. | |
8749abea GM |
5085 | Other orders of $ and _ seem to all work just fine.") |
5086 | ||
5087 | ;; These parsing functions are as general as possible because the syntax | |
5088 | ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that | |
5089 | ;; the VMS filename syntax is so rigid. If they bomb on a listing in the | |
5090 | ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing | |
5091 | ;; from vms.weird.net, then too bad. | |
5092 | ||
5093 | ;; Extract the next filename from a VMS dired-like listing. | |
5094 | (defun ange-ftp-parse-vms-filename () | |
5095 | (if (re-search-forward | |
e3441f42 SM |
5096 | ange-ftp-vms-filename-regexp |
5097 | nil t) | |
5098 | (match-string 0))) | |
8749abea GM |
5099 | |
5100 | ;; Parse the current buffer which is assumed to be in MultiNet FTP dir | |
5101 | ;; format, and return a hashtable as the result. | |
5102 | (defun ange-ftp-parse-vms-listing () | |
6e85ef5f | 5103 | (let ((tbl (make-hash-table :test 'equal)) |
8749abea GM |
5104 | file) |
5105 | (goto-char (point-min)) | |
5106 | (save-match-data | |
5107 | (while (setq file (ange-ftp-parse-vms-filename)) | |
5108 | (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file) | |
5109 | ;; deal with directories | |
6e85ef5f SM |
5110 | (puthash (substring file 0 (match-beginning 0)) t tbl) |
5111 | (puthash file nil tbl) | |
aa6f7b96 | 5112 | (if (string-match ";[0-9]+\\'" file) ; deal with extension |
8749abea | 5113 | ;; sans extension |
6e85ef5f | 5114 | (puthash (substring file 0 (match-beginning 0)) nil tbl))) |
8749abea GM |
5115 | (forward-line 1)) |
5116 | ;; Would like to look for a "Total" line, or a "Directory" line to | |
5117 | ;; make sure that the listing isn't complete garbage before putting | |
5118 | ;; in "." and "..", but we can't even count on all VAX's giving us | |
5119 | ;; either of these. | |
6e85ef5f SM |
5120 | (puthash "." t tbl) |
5121 | (puthash ".." t tbl)) | |
8749abea GM |
5122 | tbl)) |
5123 | ||
e3441f42 SM |
5124 | (add-to-list 'ange-ftp-parse-list-func-alist |
5125 | '(vms . ange-ftp-parse-vms-listing)) | |
8749abea GM |
5126 | |
5127 | ;; This version only deletes file entries which have | |
5128 | ;; explicit version numbers, because that is all VMS allows. | |
5129 | ||
5130 | ;; Can the following two functions be speeded up using file | |
5131 | ;; completion functions? | |
5132 | ||
5133 | (defun ange-ftp-vms-delete-file-entry (name &optional dir-p) | |
5134 | (if dir-p | |
5135 | (ange-ftp-internal-delete-file-entry name t) | |
5136 | (save-match-data | |
5137 | (let ((file (ange-ftp-get-file-part name))) | |
aa6f7b96 | 5138 | (if (string-match ";[0-9]+\\'" file) |
25759a92 | 5139 | ;; In VMS you can't delete a file without an explicit |
8749abea GM |
5140 | ;; version number, or wild-card (e.g. FOO;*) |
5141 | ;; For now, we give up on wildcards. | |
6e85ef5f SM |
5142 | (let ((files (gethash (file-name-directory name) |
5143 | ange-ftp-files-hashtable))) | |
8749abea GM |
5144 | (if files |
5145 | (let* ((root (substring file 0 | |
5146 | (match-beginning 0))) | |
5147 | (regexp (concat "^" | |
5148 | (regexp-quote root) | |
5149 | ";[0-9]+$")) | |
5150 | versions) | |
6e85ef5f | 5151 | (remhash file files) |
8749abea GM |
5152 | ;; Now we need to check if there are any |
5153 | ;; versions left. If not, then delete the | |
5154 | ;; root entry. | |
6e85ef5f SM |
5155 | (maphash |
5156 | (lambda (key val) | |
5157 | (and (string-match regexp key) | |
aeb18228 | 5158 | (setq versions t))) |
8749abea GM |
5159 | files) |
5160 | (or versions | |
6e85ef5f | 5161 | (remhash root files)))))))))) |
8749abea GM |
5162 | |
5163 | (or (assq 'vms ange-ftp-delete-file-entry-alist) | |
5164 | (setq ange-ftp-delete-file-entry-alist | |
5165 | (cons '(vms . ange-ftp-vms-delete-file-entry) | |
5166 | ange-ftp-delete-file-entry-alist))) | |
5167 | ||
5168 | (defun ange-ftp-vms-add-file-entry (name &optional dir-p) | |
5169 | (if dir-p | |
5170 | (ange-ftp-internal-add-file-entry name t) | |
6e85ef5f SM |
5171 | (let ((files (gethash (file-name-directory name) |
5172 | ange-ftp-files-hashtable))) | |
8749abea GM |
5173 | (if files |
5174 | (let ((file (ange-ftp-get-file-part name))) | |
5175 | (save-match-data | |
aa6f7b96 | 5176 | (if (string-match ";[0-9]+\\'" file) |
6e85ef5f | 5177 | (puthash (substring file 0 (match-beginning 0)) nil files) |
8749abea GM |
5178 | ;; Need to figure out what version of the file |
5179 | ;; is being added. | |
5180 | (let ((regexp (concat "^" | |
5181 | (regexp-quote file) | |
5182 | ";\\([0-9]+\\)$")) | |
5183 | (version 0)) | |
6e85ef5f SM |
5184 | (maphash |
5185 | (lambda (name val) | |
5186 | (and (string-match regexp name) | |
5187 | (setq version | |
5188 | (max version | |
027a4b6b | 5189 | (string-to-number (match-string 1 name)))))) |
8749abea GM |
5190 | files) |
5191 | (setq version (1+ version)) | |
6e85ef5f | 5192 | (puthash |
8749abea GM |
5193 | (concat file ";" (int-to-string version)) |
5194 | nil files)))) | |
6e85ef5f | 5195 | (puthash file nil files)))))) |
8749abea GM |
5196 | |
5197 | (or (assq 'vms ange-ftp-add-file-entry-alist) | |
5198 | (setq ange-ftp-add-file-entry-alist | |
5199 | (cons '(vms . ange-ftp-vms-add-file-entry) | |
5200 | ange-ftp-add-file-entry-alist))) | |
5201 | ||
5202 | ||
5203 | (defun ange-ftp-add-vms-host (host) | |
5204 | "Mark HOST as the name of a machine running VMS." | |
5205 | (interactive | |
5206 | (list (read-string "Host: " | |
5207 | (let ((name (or (buffer-file-name) default-directory))) | |
5208 | (and name (car (ange-ftp-ftp-name name))))))) | |
5209 | (if (not (ange-ftp-vms-host host)) | |
5210 | (setq ange-ftp-vms-host-regexp | |
5211 | (concat "^" (regexp-quote host) "$" | |
5212 | (and ange-ftp-vms-host-regexp "\\|") | |
5213 | ange-ftp-vms-host-regexp) | |
5214 | ange-ftp-host-cache nil))) | |
5215 | ||
5216 | ||
5217 | (defun ange-ftp-vms-file-name-as-directory (name) | |
5218 | (save-match-data | |
aa6f7b96 | 5219 | (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?\\'" name) |
8749abea GM |
5220 | (setq name (substring name 0 (match-beginning 0)))) |
5221 | (ange-ftp-real-file-name-as-directory name))) | |
5222 | ||
5223 | (or (assq 'vms ange-ftp-file-name-as-directory-alist) | |
5224 | (setq ange-ftp-file-name-as-directory-alist | |
5225 | (cons '(vms . ange-ftp-vms-file-name-as-directory) | |
5226 | ange-ftp-file-name-as-directory-alist))) | |
5227 | ||
5228 | ;;; Tree dired support: | |
5229 | ||
5230 | ;; For this code I have borrowed liberally from Sebastian Kremer's | |
5231 | ;; dired-vms.el | |
5232 | ||
5233 | ||
5234 | ;;;; These regexps must be anchored to beginning of line. | |
5235 | ;;;; Beware that the ftpd may put the device in front of the filename. | |
5236 | ||
5237 | ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]" | |
5238 | ;; "Regular expression to use to search for VMS executable files.") | |
5239 | ||
5240 | ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]" | |
5241 | ;; "Regular expression to use to search for VMS directories.") | |
5242 | ||
5243 | ;;(or (assq 'vms ange-ftp-dired-re-exe-alist) | |
5244 | ;; (setq ange-ftp-dired-re-exe-alist | |
5245 | ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe) | |
5246 | ;; ange-ftp-dired-re-exe-alist))) | |
5247 | ||
5248 | ;;(or (assq 'vms ange-ftp-dired-re-dir-alist) | |
5249 | ;; (setq ange-ftp-dired-re-dir-alist | |
5250 | ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir) | |
5251 | ;; ange-ftp-dired-re-dir-alist))) | |
5252 | ||
5253 | ;;(defun ange-ftp-dired-vms-insert-headerline (dir) | |
5254 | ;; ;; VMS inserts a headerline. I would prefer the headerline | |
5255 | ;; ;; to be in ange-ftp format. This version tries to | |
5256 | ;; ;; be careful, because we can't count on a headerline | |
5257 | ;; ;; over ftp, and we wouldn't want to delete anything | |
5258 | ;; ;; important. | |
5259 | ;; (save-excursion | |
5260 | ;; (if (looking-at "^ wildcard ") | |
5261 | ;; (forward-line 1)) | |
5262 | ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n") | |
5263 | ;; (delete-region (point) (match-end 0)))) | |
5264 | ;; (ange-ftp-real-dired-insert-headerline dir)) | |
5265 | ||
5266 | ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist) | |
5267 | ;; (setq ange-ftp-dired-insert-headerline-alist | |
5268 | ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline) | |
5269 | ;; ange-ftp-dired-insert-headerline-alist))) | |
5270 | ||
5271 | ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol) | |
5272 | ;; "In dired, move to first char of filename on this line. | |
5273 | ;;Returns position (point) or nil if no filename on this line." | |
5274 | ;; ;; This is the VMS version. | |
5275 | ;; (let (case-fold-search) | |
5276 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5277 | ;; (beginning-of-line) | |
5278 | ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t) | |
5279 | ;; (goto-char (match-beginning 1)) | |
5280 | ;; (if raise-error | |
5281 | ;; (error "No file on this line") | |
5282 | ;; nil)))) | |
5283 | ||
5284 | ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist) | |
5285 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5286 | ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename) | |
5287 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5288 | ||
5289 | ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol) | |
5290 | ;; ;; Assumes point is at beginning of filename. | |
5291 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5292 | ;; ;; case-fold-search must be nil, at least for VMS. | |
5293 | ;; ;; On failure, signals an error or returns nil. | |
5294 | ;; ;; This is the VMS version. | |
5295 | ;; (let (opoint hidden case-fold-search) | |
5296 | ;; (setq opoint (point)) | |
5297 | ;; (or eol (setq eol (save-excursion (end-of-line) (point)))) | |
5298 | ;; (setq hidden (and selective-display | |
5299 | ;; (save-excursion (search-forward "\r" eol t)))) | |
5300 | ;; (if hidden | |
5301 | ;; nil | |
5302 | ;; (re-search-forward ange-ftp-vms-filename-regexp eol t)) | |
5303 | ;; (or no-error | |
5304 | ;; (not (eq opoint (point))) | |
5305 | ;; (error | |
5306 | ;; (if hidden | |
5307 | ;; (substitute-command-keys | |
5308 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide") | |
5309 | ;; "No file on this line"))) | |
5310 | ;; (if (eq opoint (point)) | |
5311 | ;; nil | |
5312 | ;; (point)))) | |
5313 | ||
5314 | ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist) | |
5315 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5316 | ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename) | |
5317 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5318 | ||
5319 | ;;(defun ange-ftp-dired-vms-between-files () | |
5320 | ;; (save-excursion | |
5321 | ;; (beginning-of-line) | |
5322 | ;; (or (equal (following-char) 10) ; newline | |
5323 | ;; (equal (following-char) 9) ; tab | |
5324 | ;; (progn (forward-char 2) | |
5325 | ;; (or (looking-at "Total of") | |
5326 | ;; (equal (following-char) 32)))))) | |
5327 | ||
5328 | ;;(or (assq 'vms ange-ftp-dired-between-files-alist) | |
5329 | ;; (setq ange-ftp-dired-between-files-alist | |
5330 | ;; (cons '(vms . ange-ftp-dired-vms-between-files) | |
5331 | ;; ange-ftp-dired-between-files-alist))) | |
5332 | ||
5333 | ;; Beware! In VMS filenames must be of the form "FILE.TYPE". | |
5334 | ;; Therefore, we cannot just append a ".Z" to filenames for | |
5335 | ;; compressed files. Instead, we turn "FILE.TYPE" into | |
5336 | ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do. | |
5337 | ||
5338 | (defun ange-ftp-vms-make-compressed-filename (name &optional reverse) | |
5339 | (cond | |
aa6f7b96 | 5340 | ((string-match "-Z;[0-9]+\\'" name) |
8749abea | 5341 | (list nil (substring name 0 (match-beginning 0)))) |
aa6f7b96 | 5342 | ((string-match ";[0-9]+\\'" name) |
8749abea | 5343 | (list nil (substring name 0 (match-beginning 0)))) |
aa6f7b96 | 5344 | ((string-match "-Z\\'" name) |
8749abea GM |
5345 | (list nil (substring name 0 -2))) |
5346 | (t | |
5347 | (list t | |
aa6f7b96 | 5348 | (if (string-match ";[0-9]+\\'" name) |
8749abea GM |
5349 | (concat (substring name 0 (match-beginning 0)) |
5350 | "-Z") | |
5351 | (concat name "-Z")))))) | |
5352 | ||
5353 | (or (assq 'vms ange-ftp-make-compressed-filename-alist) | |
5354 | (setq ange-ftp-make-compressed-filename-alist | |
5355 | (cons '(vms . ange-ftp-vms-make-compressed-filename) | |
5356 | ange-ftp-make-compressed-filename-alist))) | |
5357 | ||
5358 | ;;;; When the filename is too long, VMS will use two lines to list a file | |
5359 | ;;;; (damn them!) This will confuse dired. To solve this, need to convince | |
5360 | ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of | |
5361 | ;;;; (forward-line 1). This would require a number of changes to dired.el. | |
5362 | ;;;; If dired gets confused, revert-buffer will fix it. | |
5363 | ||
5364 | ;;(defun ange-ftp-dired-vms-ls-trim () | |
5365 | ;; (goto-char (point-min)) | |
5366 | ;; (let ((case-fold-search nil)) | |
5367 | ;; (re-search-forward ange-ftp-vms-filename-regexp)) | |
5368 | ;; (beginning-of-line) | |
5369 | ;; (delete-region (point-min) (point)) | |
5370 | ;; (forward-line 1) | |
5371 | ;; (delete-region (point) (point-max))) | |
5372 | ||
5373 | ||
5374 | ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist) | |
5375 | ;; (setq ange-ftp-dired-ls-trim-alist | |
5376 | ;; (cons '(vms . ange-ftp-dired-vms-ls-trim) | |
25759a92 | 5377 | ;; ange-ftp-dired-ls-trim-alist))) |
8749abea GM |
5378 | |
5379 | (defun ange-ftp-vms-sans-version (name &rest args) | |
5380 | (save-match-data | |
aa6f7b96 | 5381 | (if (string-match ";[0-9]+\\'" name) |
8749abea GM |
5382 | (substring name 0 (match-beginning 0)) |
5383 | name))) | |
5384 | ||
5385 | (or (assq 'vms ange-ftp-sans-version-alist) | |
5386 | (setq ange-ftp-sans-version-alist | |
5387 | (cons '(vms . ange-ftp-vms-sans-version) | |
5388 | ange-ftp-sans-version-alist))) | |
5389 | ||
5390 | ;;(defvar ange-ftp-file-version-alist) | |
5391 | ||
5392 | ;;;;; The vms version of clean-directory has 2 more optional args | |
5393 | ;;;;; than the usual dired version. This is so that it can be used by | |
5394 | ;;;;; ange-ftp-dired-vms-flag-backup-files. | |
5395 | ||
5396 | ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg) | |
5397 | ;; "Flag numerical backups for deletion. | |
5398 | ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest. | |
5399 | ;;Positive prefix arg KEEP overrides `dired-kept-versions'; | |
5400 | ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive. | |
5401 | ||
5402 | ;;To clear the flags on these files, you can use \\[dired-flag-backup-files] | |
5403 | ;;with a prefix argument." | |
5404 | ;;; (interactive "P") ; Never actually called interactively. | |
5405 | ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions))) | |
5406 | ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions)) | |
5407 | ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS! | |
5408 | ;; ;; This could wipe ALL copies of the file. | |
5409 | ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep))) | |
5410 | ;; (action (or msg "Cleaning")) | |
5411 | ;; (ange-ftp-trample-marker (or marker dired-del-marker)) | |
5412 | ;; (ange-ftp-file-version-alist ())) | |
5413 | ;; (message (concat action | |
5414 | ;; " numerical backups (keeping %d late, %d old)...") | |
5415 | ;; late-retention early-retention) | |
5416 | ;; ;; Look at each file. | |
5417 | ;; ;; If the file has numeric backup versions, | |
5418 | ;; ;; put on ange-ftp-file-version-alist an element of the form | |
5419 | ;; ;; (FILENAME . VERSION-NUMBER-LIST) | |
e3441f42 | 5420 | ;; (dired-map-dired-file-lines 'ange-ftp-dired-vms-collect-file-versions) |
8749abea GM |
5421 | ;; ;; Sort each VERSION-NUMBER-LIST, |
5422 | ;; ;; and remove the versions not to be deleted. | |
5423 | ;; (let ((fval ange-ftp-file-version-alist)) | |
5424 | ;; (while fval | |
5425 | ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<))) | |
5426 | ;; (v-count (length sorted-v-list))) | |
5427 | ;; (if (> v-count (+ early-retention late-retention)) | |
5428 | ;; (rplacd (nthcdr early-retention sorted-v-list) | |
5429 | ;; (nthcdr (- v-count late-retention) | |
5430 | ;; sorted-v-list))) | |
5431 | ;; (rplacd (car fval) | |
5432 | ;; (cdr sorted-v-list))) | |
5433 | ;; (setq fval (cdr fval)))) | |
5434 | ;; ;; Look at each file. If it is a numeric backup file, | |
5435 | ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion. | |
5436 | ;; (dired-map-dired-file-lines | |
e3441f42 | 5437 | ;; 'ange-ftp-dired-vms-trample-file-versions mark) |
8749abea GM |
5438 | ;; (message (concat action " numerical backups...done")))) |
5439 | ||
5440 | ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist) | |
5441 | ;; (setq ange-ftp-dired-clean-directory-alist | |
5442 | ;; (cons '(vms . ange-ftp-dired-vms-clean-directory) | |
5443 | ;; ange-ftp-dired-clean-directory-alist))) | |
5444 | ||
5445 | ;;(defun ange-ftp-dired-vms-collect-file-versions (fn) | |
5446 | ;; ;; "If it looks like file FN has versions, return a list of the versions. | |
5447 | ;; ;;That is a list of strings which are file names. | |
5448 | ;; ;;The caller may want to flag some of these files for deletion." | |
5449 | ;;(let ((name (nth 2 (ange-ftp-ftp-name fn)))) | |
5450 | ;; (if (string-match ";[0-9]+$" name) | |
5451 | ;; (let* ((name (substring name 0 (match-beginning 0))) | |
5452 | ;; (fn (ange-ftp-replace-name-component fn name))) | |
5453 | ;; (if (not (assq fn ange-ftp-file-version-alist)) | |
5454 | ;; (let* ((base-versions | |
5455 | ;; (concat (file-name-nondirectory name) ";")) | |
5456 | ;; (bv-length (length base-versions)) | |
5457 | ;; (possibilities (file-name-all-completions | |
5458 | ;; base-versions | |
5459 | ;; (file-name-directory fn))) | |
5460 | ;; (versions (mapcar | |
5461 | ;; '(lambda (arg) | |
5462 | ;; (if (and (string-match | |
5463 | ;; "[0-9]+$" arg bv-length) | |
5464 | ;; (= (match-beginning 0) bv-length)) | |
5465 | ;; (string-to-int (substring arg bv-length)) | |
5466 | ;; 0)) | |
5467 | ;; possibilities))) | |
5468 | ;; (if versions | |
5469 | ;; (setq | |
5470 | ;; ange-ftp-file-version-alist | |
5471 | ;; (cons (cons fn versions) | |
5472 | ;; ange-ftp-file-version-alist))))))))) | |
5473 | ||
5474 | ;;(defun ange-ftp-dired-vms-trample-file-versions (fn) | |
5475 | ;; (let* ((start-vn (string-match ";[0-9]+$" fn)) | |
5476 | ;; base-version-list) | |
5477 | ;; (and start-vn | |
5478 | ;; (setq base-version-list ; there was a base version to which | |
5479 | ;; (assoc (substring fn 0 start-vn) ; this looks like a | |
5480 | ;; ange-ftp-file-version-alist)) ; subversion | |
5481 | ;; (not (memq (string-to-int (substring fn (1+ start-vn))) | |
5482 | ;; base-version-list)) ; this one doesn't make the cut | |
5483 | ;; (progn (beginning-of-line) | |
5484 | ;; (delete-char 1) | |
5485 | ;; (insert ange-ftp-trample-marker))))) | |
5486 | ||
5487 | ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p) | |
5488 | ;; (let ((dired-kept-versions 1) | |
5489 | ;; (kept-old-versions 0) | |
5490 | ;; marker msg) | |
5491 | ;; (if unflag-p | |
5492 | ;; (setq marker ?\040 msg "Unflagging") | |
5493 | ;; (setq marker dired-del-marker msg "Cleaning")) | |
5494 | ;; (ange-ftp-dired-vms-clean-directory nil marker msg))) | |
5495 | ||
5496 | ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist) | |
5497 | ;; (setq ange-ftp-dired-flag-backup-files-alist | |
5498 | ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files) | |
5499 | ;; ange-ftp-dired-flag-backup-files-alist))) | |
5500 | ||
5501 | ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches) | |
5502 | ;; (let ((file (dired-get-filename 'no-dir)) | |
5503 | ;; bak) | |
5504 | ;; (if (and (string-match ";[0-9]+$" file) | |
5505 | ;; ;; Find most recent previous version. | |
5506 | ;; (let ((root (substring file 0 (match-beginning 0))) | |
5507 | ;; (ver | |
5508 | ;; (string-to-int (substring file (1+ (match-beginning 0))))) | |
5509 | ;; found) | |
5510 | ;; (setq ver (1- ver)) | |
5511 | ;; (while (and (> ver 0) (not found)) | |
5512 | ;; (setq bak (concat root ";" (int-to-string ver))) | |
5513 | ;; (and (file-exists-p bak) (setq found t)) | |
5514 | ;; (setq ver (1- ver))) | |
5515 | ;; found)) | |
5516 | ;; (if switches | |
5517 | ;; (diff (expand-file-name bak) (expand-file-name file) switches) | |
5518 | ;; (diff (expand-file-name bak) (expand-file-name file))) | |
5519 | ;; (error "No previous version found for %s" file)))) | |
5520 | ||
5521 | ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist) | |
5522 | ;; (setq ange-ftp-dired-backup-diff-alist | |
5523 | ;; (cons '(vms . ange-ftp-dired-vms-backup-diff) | |
5524 | ;; ange-ftp-dired-backup-diff-alist))) | |
5525 | ||
5526 | \f | |
5527 | ;;;; ------------------------------------------------------------ | |
5528 | ;;;; MTS support | |
5529 | ;;;; ------------------------------------------------------------ | |
5530 | ||
5531 | ||
5532 | ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from | |
5533 | ;; MTS to UNIX-ish. | |
5534 | (defun ange-ftp-fix-name-for-mts (name &optional reverse) | |
5535 | (save-match-data | |
5536 | (if reverse | |
aa6f7b96 | 5537 | (if (string-match "\\`\\([^:]+:\\)?\\(.*\\)\\'" name) |
8749abea | 5538 | (let (acct file) |
e3441f42 SM |
5539 | (setq acct (match-string 1 name)) |
5540 | (setq file (match-string 2 name)) | |
8749abea GM |
5541 | (concat (and acct (concat "/" acct "/")) |
5542 | file)) | |
5543 | (error "name %s didn't match" name)) | |
aa6f7b96 | 5544 | (if (string-match "\\`/\\([^:]+:\\)/\\(.*\\)\\'" name) |
e3441f42 | 5545 | (concat (match-string 1 name) (match-string 2 name)) |
8749abea GM |
5546 | ;; Let's hope that mts will recognize it anyway. |
5547 | name)))) | |
5548 | ||
5549 | (or (assq 'mts ange-ftp-fix-name-func-alist) | |
5550 | (setq ange-ftp-fix-name-func-alist | |
5551 | (cons '(mts . ange-ftp-fix-name-for-mts) | |
5552 | ange-ftp-fix-name-func-alist))) | |
5553 | ||
5554 | ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing. | |
5555 | ;; Remember that there are no directories in MTS. | |
5556 | (defun ange-ftp-fix-dir-name-for-mts (dir-name) | |
5557 | (if (string-equal dir-name "/") | |
55535639 | 5558 | (error "Cannot get listing for fictitious \"/\" directory") |
8749abea GM |
5559 | (let ((dir-name (ange-ftp-fix-name-for-mts dir-name))) |
5560 | (cond | |
5561 | ((string-equal dir-name "") | |
5562 | "?") | |
aa6f7b96 | 5563 | ((string-match ":\\'" dir-name) |
8749abea GM |
5564 | (concat dir-name "?")) |
5565 | (dir-name))))) ; It's just a single file. | |
5566 | ||
5567 | (or (assq 'mts ange-ftp-fix-dir-name-func-alist) | |
5568 | (setq ange-ftp-fix-dir-name-func-alist | |
5569 | (cons '(mts . ange-ftp-fix-dir-name-for-mts) | |
5570 | ange-ftp-fix-dir-name-func-alist))) | |
5571 | ||
5572 | (or (memq 'mts ange-ftp-dumb-host-types) | |
5573 | (setq ange-ftp-dumb-host-types | |
5574 | (cons 'mts ange-ftp-dumb-host-types))) | |
5575 | ||
5576 | (defvar ange-ftp-mts-host-regexp nil) | |
5577 | ||
5578 | ;; Return non-nil if HOST is running MTS. | |
5579 | (defun ange-ftp-mts-host (host) | |
5580 | (and ange-ftp-mts-host-regexp | |
4671dba5 | 5581 | (string-match-p ange-ftp-mts-host-regexp host))) |
8749abea GM |
5582 | |
5583 | ;; Parse the current buffer which is assumed to be in mts ftp dir format. | |
5584 | (defun ange-ftp-parse-mts-listing () | |
6e85ef5f | 5585 | (let ((tbl (make-hash-table :test 'equal))) |
8749abea GM |
5586 | (goto-char (point-min)) |
5587 | (save-match-data | |
9bc260cf | 5588 | (while (re-search-forward directory-listing-before-filename-regexp nil t) |
8749abea GM |
5589 | (end-of-line) |
5590 | (skip-chars-backward " ") | |
5591 | (let ((end (point))) | |
5592 | (skip-chars-backward "-A-Z0-9_.!") | |
6e85ef5f | 5593 | (puthash (buffer-substring (point) end) nil tbl)) |
8749abea | 5594 | (forward-line 1))) |
6e85ef5f SM |
5595 | ;; Don't need to bother with .. |
5596 | (puthash "." t tbl) | |
8749abea GM |
5597 | tbl)) |
5598 | ||
e3441f42 SM |
5599 | (add-to-list 'ange-ftp-parse-list-func-alist |
5600 | '(mts . ange-ftp-parse-mts-listing)) | |
8749abea GM |
5601 | |
5602 | (defun ange-ftp-add-mts-host (host) | |
5603 | "Mark HOST as the name of a machine running MTS." | |
5604 | (interactive | |
5605 | (list (read-string "Host: " | |
5606 | (let ((name (or (buffer-file-name) default-directory))) | |
5607 | (and name (car (ange-ftp-ftp-name name))))))) | |
5608 | (if (not (ange-ftp-mts-host host)) | |
5609 | (setq ange-ftp-mts-host-regexp | |
5610 | (concat "^" (regexp-quote host) "$" | |
5611 | (and ange-ftp-mts-host-regexp "\\|") | |
5612 | ange-ftp-mts-host-regexp) | |
5613 | ange-ftp-host-cache nil))) | |
5614 | ||
5615 | ;;; Tree dired support: | |
5616 | ||
5617 | ;;;; There aren't too many systems left that use MTS. This dired support will | |
5618 | ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems | |
5619 | ;;;; implement ftp in the same way. If not, it might be necessary to make the | |
5620 | ;;;; following more flexible. | |
5621 | ||
5622 | ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol) | |
5623 | ;; "In dired, move to first char of filename on this line. | |
5624 | ;;Returns position (point) or nil if no filename on this line." | |
5625 | ;; ;; This is the MTS version. | |
5626 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5627 | ;; (beginning-of-line) | |
5628 | ;; (if (re-search-forward | |
5629 | ;; ange-ftp-date-regexp eol t) | |
5630 | ;; (progn | |
5631 | ;; (skip-chars-forward " ") ; Eat blanks after date | |
5632 | ;; (skip-chars-forward "0-9:" eol) ; Eat time or year | |
5633 | ;; (skip-chars-forward " " eol) ; one space before filename | |
5634 | ;; ;; When listing an account other than the users own account it appends | |
5635 | ;; ;; ACCT: to the beginning of the filename. Skip over this. | |
5636 | ;; (and (looking-at "[A-Z0-9_.]+:") | |
5637 | ;; (goto-char (match-end 0))) | |
5638 | ;; (point)) | |
5639 | ;; (if raise-error | |
5640 | ;; (error "No file on this line") | |
5641 | ;; nil))) | |
5642 | ||
5643 | ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist) | |
5644 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5645 | ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename) | |
5646 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5647 | ||
5648 | ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol) | |
5649 | ;; ;; Assumes point is at beginning of filename. | |
5650 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5651 | ;; ;; On failure, signals an error or returns nil. | |
5652 | ;; ;; This is the MTS version. | |
5653 | ;; (let (opoint hidden case-fold-search) | |
5654 | ;; (setq opoint (point) | |
5655 | ;; eol (save-excursion (end-of-line) (point)) | |
5656 | ;; hidden (and selective-display | |
5657 | ;; (save-excursion (search-forward "\r" eol t)))) | |
5658 | ;; (if hidden | |
5659 | ;; nil | |
5660 | ;; (skip-chars-forward "-A-Z0-9._!" eol)) | |
5661 | ;; (or no-error | |
5662 | ;; (not (eq opoint (point))) | |
5663 | ;; (error | |
5664 | ;; (if hidden | |
5665 | ;; (substitute-command-keys | |
5666 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide") | |
5667 | ;; "No file on this line"))) | |
5668 | ;; (if (eq opoint (point)) | |
5669 | ;; nil | |
5670 | ;; (point)))) | |
5671 | ||
5672 | ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist) | |
5673 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5674 | ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename) | |
5675 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5676 | \f | |
5677 | ;;;; ------------------------------------------------------------ | |
5678 | ;;;; CMS support | |
5679 | ;;;; ------------------------------------------------------------ | |
5680 | ||
5681 | ;; Since CMS doesn't have any full file name syntax, we have to fudge | |
5682 | ;; things with cd's. We actually send too many cd's, but it's dangerous | |
5683 | ;; to try to remember the current minidisk, because if the connection | |
5684 | ;; is closed and needs to be reopened, we will find ourselves back in | |
5685 | ;; the default minidisk. This is fairly likely since CMS ftp servers | |
5686 | ;; usually close the connection after 5 minutes of inactivity. | |
5687 | ||
5688 | ;; Have I got the filename character set right? | |
5689 | ||
5690 | (defun ange-ftp-fix-name-for-cms (name &optional reverse) | |
5691 | (save-match-data | |
5692 | (if reverse | |
5693 | ;; Since we only convert output from a pwd in this direction, | |
5694 | ;; we'll assume that it's a minidisk, and make it into a | |
5695 | ;; directory file name. Note that the expand-dir-hashtable | |
5696 | ;; stores directories without the trailing /. Is this | |
5697 | ;; consistent? | |
5698 | (concat "/" name) | |
aa6f7b96 | 5699 | (if (string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'" |
8749abea | 5700 | name) |
e3441f42 | 5701 | (let ((minidisk (match-string 1 name))) |
8749abea | 5702 | (if (match-beginning 2) |
e3441f42 | 5703 | (let ((file (match-string 2 name)) |
8749abea GM |
5704 | (cmd (concat "cd " minidisk)) |
5705 | ||
5706 | ;; Note that host and user are bound in the call | |
5707 | ;; to ange-ftp-send-cmd | |
5708 | (proc (ange-ftp-get-process ange-ftp-this-host | |
5709 | ange-ftp-this-user))) | |
5710 | ||
5711 | ;; Must use ange-ftp-raw-send-cmd here to avoid | |
5712 | ;; an infinite loop. | |
5713 | (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg)) | |
5714 | file | |
5715 | ;; failed... try ONCE more. | |
5716 | (setq proc (ange-ftp-get-process ange-ftp-this-host | |
5717 | ange-ftp-this-user)) | |
5718 | (let ((result (ange-ftp-raw-send-cmd proc cmd | |
5719 | ange-ftp-this-msg))) | |
5720 | (if (car result) | |
5721 | file | |
5722 | ;; failed. give up. | |
5723 | (ange-ftp-error ange-ftp-this-host ange-ftp-this-user | |
5724 | (format "cd to minidisk %s failed: %s" | |
5725 | minidisk (cdr result))))))) | |
5726 | ;; return the minidisk | |
5727 | minidisk)) | |
5728 | (error "Invalid CMS filename"))))) | |
5729 | ||
5730 | (or (assq 'cms ange-ftp-fix-name-func-alist) | |
5731 | (setq ange-ftp-fix-name-func-alist | |
5732 | (cons '(cms . ange-ftp-fix-name-for-cms) | |
5733 | ange-ftp-fix-name-func-alist))) | |
5734 | ||
5735 | (or (memq 'cms ange-ftp-dumb-host-types) | |
5736 | (setq ange-ftp-dumb-host-types | |
5737 | (cons 'cms ange-ftp-dumb-host-types))) | |
5738 | ||
5739 | ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing. | |
5740 | (defun ange-ftp-fix-dir-name-for-cms (dir-name) | |
5741 | (cond | |
5742 | ((string-equal "/" dir-name) | |
55535639 | 5743 | (error "Cannot get listing for fictitious \"/\" directory")) |
aa6f7b96 | 5744 | ((string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'" dir-name) |
e3441f42 | 5745 | (let* ((minidisk (match-string 1 dir-name)) |
8749abea GM |
5746 | ;; host and user are bound in the call to ange-ftp-send-cmd |
5747 | (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user)) | |
5748 | (cmd (concat "cd " minidisk)) | |
5749 | (file (if (match-beginning 2) | |
5750 | ;; it's a single file | |
e3441f42 | 5751 | (match-string 2 dir-name) |
8749abea GM |
5752 | ;; use the wild-card |
5753 | "*"))) | |
5754 | (if (car (ange-ftp-raw-send-cmd proc cmd)) | |
5755 | file | |
5756 | ;; try again... | |
5757 | (setq proc (ange-ftp-get-process ange-ftp-this-host | |
5758 | ange-ftp-this-user)) | |
5759 | (let ((result (ange-ftp-raw-send-cmd proc cmd))) | |
5760 | (if (car result) | |
5761 | file | |
5762 | ;; give up | |
5763 | (ange-ftp-error ange-ftp-this-host ange-ftp-this-user | |
5764 | (format "cd to minidisk %s failed: %s" | |
5765 | minidisk (cdr result)))))))) | |
5766 | (t (error "Invalid CMS file name")))) | |
5767 | ||
5768 | (or (assq 'cms ange-ftp-fix-dir-name-func-alist) | |
5769 | (setq ange-ftp-fix-dir-name-func-alist | |
5770 | (cons '(cms . ange-ftp-fix-dir-name-for-cms) | |
5771 | ange-ftp-fix-dir-name-func-alist))) | |
5772 | ||
5773 | (defvar ange-ftp-cms-host-regexp nil | |
5774 | "Regular expression to match hosts running the CMS operating system.") | |
5775 | ||
5776 | ;; Return non-nil if HOST is running CMS. | |
5777 | (defun ange-ftp-cms-host (host) | |
5778 | (and ange-ftp-cms-host-regexp | |
4671dba5 | 5779 | (string-match-p ange-ftp-cms-host-regexp host))) |
8749abea GM |
5780 | |
5781 | (defun ange-ftp-add-cms-host (host) | |
5782 | "Mark HOST as the name of a CMS host." | |
5783 | (interactive | |
5784 | (list (read-string "Host: " | |
5785 | (let ((name (or (buffer-file-name) default-directory))) | |
5786 | (and name (car (ange-ftp-ftp-name name))))))) | |
5787 | (if (not (ange-ftp-cms-host host)) | |
5788 | (setq ange-ftp-cms-host-regexp | |
5789 | (concat "^" (regexp-quote host) "$" | |
5790 | (and ange-ftp-cms-host-regexp "\\|") | |
5791 | ange-ftp-cms-host-regexp) | |
5792 | ange-ftp-host-cache nil))) | |
5793 | ||
5794 | (defun ange-ftp-parse-cms-listing () | |
5795 | ;; Parse the current buffer which is assumed to be a CMS directory listing. | |
5796 | ;; If we succeed in getting a listing, then we will assume that the minidisk | |
5797 | ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work | |
5798 | ;; because ange-ftp doesn't know that the root hashtable has only part of | |
5799 | ;; the info. It will assume that if a minidisk isn't in it, then it doesn't | |
5800 | ;; exist. It would be nice if completion worked for minidisks, as we | |
5801 | ;; discover them. | |
5802 | ; (let* ((dir-file (directory-file-name file)) | |
5803 | ; (root (file-name-directory dir-file)) | |
5804 | ; (minidisk (ange-ftp-get-file-part dir-file)) | |
5805 | ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable))) | |
5806 | ; (if root-tbl | |
6e85ef5f | 5807 | ; (puthash minidisk t root-tbl) |
8749abea | 5808 | ; (setq root-tbl (ange-ftp-make-hashtable)) |
6e85ef5f SM |
5809 | ; (puthash minidisk t root-tbl) |
5810 | ; (puthash "." t root-tbl) | |
8749abea GM |
5811 | ; (ange-ftp-set-files root root-tbl))) |
5812 | ;; Now do the usual parsing | |
6e85ef5f | 5813 | (let ((tbl (make-hash-table :test 'equal))) |
8749abea GM |
5814 | (goto-char (point-min)) |
5815 | (save-match-data | |
5816 | (while | |
5817 | (re-search-forward | |
5818 | "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t) | |
e3441f42 | 5819 | (puthash (concat (match-string 1) "." (match-string 2)) nil tbl) |
8749abea | 5820 | (forward-line 1)) |
6e85ef5f | 5821 | (puthash "." t tbl)) |
8749abea GM |
5822 | tbl)) |
5823 | ||
e3441f42 SM |
5824 | (add-to-list 'ange-ftp-parse-list-func-alist |
5825 | '(cms . ange-ftp-parse-cms-listing)) | |
25759a92 | 5826 | |
8749abea GM |
5827 | ;;;;; Tree dired support: |
5828 | ||
5829 | ;;(defconst ange-ftp-dired-cms-re-exe | |
5830 | ;; "^. [-A-Z0-9$_]+ +EXEC " | |
5831 | ;; "Regular expression to use to search for CMS executables.") | |
5832 | ||
5833 | ;;(or (assq 'cms ange-ftp-dired-re-exe-alist) | |
5834 | ;; (setq ange-ftp-dired-re-exe-alist | |
5835 | ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe) | |
5836 | ;; ange-ftp-dired-re-exe-alist))) | |
5837 | ||
5838 | ||
5839 | ;;(defun ange-ftp-dired-cms-insert-headerline (dir) | |
5840 | ;; ;; CMS has no total line, so we insert a blank line for | |
5841 | ;; ;; aesthetics. | |
5842 | ;; (insert "\n") | |
5843 | ;; (forward-char -1) | |
5844 | ;; (ange-ftp-real-dired-insert-headerline dir)) | |
5845 | ||
5846 | ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist) | |
5847 | ;; (setq ange-ftp-dired-insert-headerline-alist | |
5848 | ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline) | |
5849 | ;; ange-ftp-dired-insert-headerline-alist))) | |
5850 | ||
5851 | ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol) | |
5852 | ;; "In dired, move to the first char of filename on this line." | |
5853 | ;; ;; This is the CMS version. | |
5854 | ;; (or eol (setq eol (progn (end-of-line) (point)))) | |
5855 | ;; (let (case-fold-search) | |
5856 | ;; (beginning-of-line) | |
5857 | ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t) | |
5858 | ;; (goto-char (1+ (match-beginning 0))) | |
5859 | ;; (if raise-error | |
5860 | ;; (error "No file on this line") | |
5861 | ;; nil)))) | |
5862 | ||
5863 | ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist) | |
5864 | ;; (setq ange-ftp-dired-move-to-filename-alist | |
5865 | ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename) | |
5866 | ;; ange-ftp-dired-move-to-filename-alist))) | |
5867 | ||
5868 | ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol) | |
5869 | ;; ;; Assumes point is at beginning of filename. | |
5870 | ;; ;; So, it should be called only after (dired-move-to-filename t). | |
5871 | ;; ;; case-fold-search must be nil, at least for VMS. | |
5872 | ;; ;; On failure, signals an error or returns nil. | |
5873 | ;; ;; This is the CMS version. | |
5874 | ;; (let ((opoint (point)) | |
5875 | ;; case-fold-search hidden) | |
5876 | ;; (or eol (setq eol (save-excursion (end-of-line) (point)))) | |
5877 | ;; (setq hidden (and selective-display | |
5878 | ;; (save-excursion | |
5879 | ;; (search-forward "\r" eol t)))) | |
5880 | ;; (if hidden | |
5881 | ;; (if no-error | |
5882 | ;; nil | |
5883 | ;; (error | |
5884 | ;; (substitute-command-keys | |
5885 | ;; "File line is hidden, type \\[dired-hide-subdir] to unhide"))) | |
5886 | ;; (skip-chars-forward "-A-Z0-9$_" eol) | |
5887 | ;; (skip-chars-forward " " eol) | |
5888 | ;; (skip-chars-forward "-A-Z0-9$_" eol) | |
5889 | ;; (if (eq opoint (point)) | |
5890 | ;; (if no-error | |
5891 | ;; nil | |
5892 | ;; (error "No file on this line")) | |
5893 | ;; (point))))) | |
5894 | ||
5895 | ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist) | |
5896 | ;; (setq ange-ftp-dired-move-to-end-of-filename-alist | |
5897 | ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename) | |
5898 | ;; ange-ftp-dired-move-to-end-of-filename-alist))) | |
5899 | ||
5900 | (defun ange-ftp-cms-make-compressed-filename (name &optional reverse) | |
aa6f7b96 | 5901 | (if (string-match "-Z\\'" name) |
8749abea GM |
5902 | (list nil (substring name 0 -2)) |
5903 | (list t (concat name "-Z")))) | |
5904 | ||
5905 | (or (assq 'cms ange-ftp-make-compressed-filename-alist) | |
5906 | (setq ange-ftp-make-compressed-filename-alist | |
5907 | (cons '(cms . ange-ftp-cms-make-compressed-filename) | |
5908 | ange-ftp-make-compressed-filename-alist))) | |
5909 | ||
5910 | ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep) | |
5911 | ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep))) | |
5912 | ;; (and name | |
5913 | ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name) | |
5914 | ;; (concat (substring name 0 (match-end 1)) | |
5915 | ;; "." | |
5916 | ;; (substring name (match-beginning 2) (match-end 2))) | |
5917 | ;; name)))) | |
5918 | ||
5919 | ;;(or (assq 'cms ange-ftp-dired-get-filename-alist) | |
5920 | ;; (setq ange-ftp-dired-get-filename-alist | |
5921 | ;; (cons '(cms . ange-ftp-dired-cms-get-filename) | |
5922 | ;; ange-ftp-dired-get-filename-alist))) | |
5923 | \f | |
9c35d706 RS |
5924 | ;;;; ------------------------------------------------------------ |
5925 | ;;;; BS2000 support | |
5926 | ;;;; ------------------------------------------------------------ | |
5927 | ||
5928 | ;; There seems to be an error with regexps. '-' has to be the first | |
5929 | ;; character inside of the square brackets. | |
5930 | (defconst ange-ftp-bs2000-short-filename-regexp | |
5931 | "[-A-Z0-9$#@.]*[A-Z][-A-Z0-9$#@.]*" | |
5932 | "Regular expression to match for a valid short BS2000 file name.") | |
5933 | ||
5934 | (defconst ange-ftp-bs2000-fix-name-regexp-reverse | |
5935 | (concat | |
5936 | "^\\(" ange-ftp-bs2000-filename-pubset-regexp "\\)?" | |
5937 | "\\(" ange-ftp-bs2000-filename-username-regexp "\\)?" | |
5938 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?") | |
4671dba5 | 5939 | "Regular expression used in `ange-ftp-fix-name-for-bs2000'.") |
9c35d706 RS |
5940 | |
5941 | (defconst ange-ftp-bs2000-fix-name-regexp | |
5942 | (concat | |
5943 | "/?\\(" ange-ftp-bs2000-filename-pubset-regexp "/\\)?" | |
5944 | "\\(\\$[A-Z0-9]*/\\)?" | |
5945 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?") | |
4671dba5 | 5946 | "Regular expression used in `ange-ftp-fix-name-for-bs2000'.") |
9c35d706 RS |
5947 | |
5948 | (defcustom ange-ftp-bs2000-special-prefix | |
5949 | "X" | |
4671dba5 | 5950 | "Prefix used for filenames starting with '#' or '@'." |
9c35d706 RS |
5951 | :group 'ange-ftp |
5952 | :type 'string) | |
5953 | ||
5954 | ;; Convert NAME from UNIX-ish to BS2000. If REVERSE given then convert from | |
5955 | ;; BS2000 to UNIX-ish. | |
5956 | (defun ange-ftp-fix-name-for-bs2000 (name &optional reverse) | |
5957 | (save-match-data | |
5958 | (if reverse | |
5959 | (if (string-match | |
5960 | ange-ftp-bs2000-fix-name-regexp-reverse | |
5961 | name) | |
5962 | (let ((pubset (if (match-beginning 1) | |
5963 | (substring name 0 (match-end 1)))) | |
5964 | (userid (if (match-beginning 2) | |
5965 | (substring name | |
5966 | (match-beginning 2) | |
5967 | (1- (match-end 2))))) | |
5968 | (filename (if (match-beginning 3) | |
5969 | (substring name (match-beginning 3))))) | |
5970 | (concat | |
5971 | "/" | |
5972 | ;; we have to insert "_/" here to prevent expand-file-name to | |
5973 | ;; interpret BS2000 pubsets as the special escape prefix: | |
5974 | (and pubset (concat "_/" pubset "/")) | |
5975 | (and userid (concat userid "/")) | |
5976 | filename)) | |
5977 | (error "name %s didn't match" name)) | |
5978 | ;; and here we (maybe) have to remove the inserted "_/" 'cause | |
5979 | ;; of our prevention of the special escape prefix above: | |
5980 | (if (string-match (concat "^/_/") name) | |
5981 | (setq name (substring name 2))) | |
5982 | (if (string-match | |
5983 | ange-ftp-bs2000-fix-name-regexp | |
5984 | name) | |
5985 | (let ((pubset (if (match-beginning 1) | |
5986 | (substring name | |
5987 | (match-beginning 1) | |
5988 | (1- (match-end 1))))) | |
5989 | (userid (if (match-beginning 2) | |
5990 | (substring name | |
5991 | (match-beginning 2) | |
5992 | (1- (match-end 2))))) | |
5993 | (filename (if (match-beginning 3) | |
5994 | (substring name (match-beginning 3))))) | |
5995 | (if (and (boundp 'filename) | |
5996 | (stringp filename) | |
5997 | (string-match "[#@].+" filename)) | |
5998 | (setq filename (concat ange-ftp-bs2000-special-prefix | |
5999 | (substring filename 1)))) | |
6000 | (upcase | |
6001 | (concat | |
6002 | pubset | |
6003 | (and userid (concat userid ".")) | |
6004 | ;; change every '/' in filename to a '.', normally not neccessary | |
6005 | (and filename | |
e3441f42 | 6006 | (subst-char-in-string ?/ ?. filename))))) |
9c35d706 RS |
6007 | ;; Let's hope that BS2000 recognize this anyway: |
6008 | name)))) | |
6009 | ||
6010 | (or (assq 'bs2000 ange-ftp-fix-name-func-alist) | |
6011 | (setq ange-ftp-fix-name-func-alist | |
6012 | (cons '(bs2000 . ange-ftp-fix-name-for-bs2000) | |
6013 | ange-ftp-fix-name-func-alist))) | |
6014 | ||
6015 | ;; Convert name from UNIX-ish to BS2000 ready for a DIRectory listing. | |
6016 | ;; Remember that there are no directories in BS2000. | |
6017 | (defun ange-ftp-fix-dir-name-for-bs2000 (dir-name) | |
6018 | (if (string-equal dir-name "/") | |
6019 | "*" ;; Don't use an empty string here! | |
6020 | (ange-ftp-fix-name-for-bs2000 dir-name))) | |
6021 | ||
6022 | (or (assq 'bs2000 ange-ftp-fix-dir-name-func-alist) | |
6023 | (setq ange-ftp-fix-dir-name-func-alist | |
6024 | (cons '(bs2000 . ange-ftp-fix-dir-name-for-bs2000) | |
6025 | ange-ftp-fix-dir-name-func-alist))) | |
6026 | ||
6027 | (or (memq 'bs2000 ange-ftp-dumb-host-types) | |
6028 | (setq ange-ftp-dumb-host-types | |
6029 | (cons 'bs2000 ange-ftp-dumb-host-types))) | |
6030 | ||
6031 | (defvar ange-ftp-bs2000-host-regexp nil) | |
6032 | (defvar ange-ftp-bs2000-posix-host-regexp nil) | |
6033 | ||
6034 | ;; Return non-nil if HOST is running BS2000. | |
6035 | (defun ange-ftp-bs2000-host (host) | |
6036 | (and ange-ftp-bs2000-host-regexp | |
4671dba5 | 6037 | (string-match-p ange-ftp-bs2000-host-regexp host))) |
9c35d706 RS |
6038 | ;; Return non-nil if HOST is running BS2000 with POSIX subsystem. |
6039 | (defun ange-ftp-bs2000-posix-host (host) | |
6040 | (and ange-ftp-bs2000-posix-host-regexp | |
4671dba5 | 6041 | (string-match-p ange-ftp-bs2000-posix-host-regexp host))) |
9c35d706 RS |
6042 | |
6043 | (defun ange-ftp-add-bs2000-host (host) | |
6044 | "Mark HOST as the name of a machine running BS2000." | |
6045 | (interactive | |
6046 | (list (read-string "Host: " | |
6047 | (let ((name (or (buffer-file-name) default-directory))) | |
6048 | (and name (car (ange-ftp-ftp-name name))))))) | |
6049 | (if (not (ange-ftp-bs2000-host host)) | |
6050 | (setq ange-ftp-bs2000-host-regexp | |
6051 | (concat "^" (regexp-quote host) "$" | |
6052 | (and ange-ftp-bs2000-host-regexp "\\|") | |
6053 | ange-ftp-bs2000-host-regexp) | |
6054 | ange-ftp-host-cache nil))) | |
6055 | ||
6056 | (defun ange-ftp-add-bs2000-posix-host (host) | |
6057 | "Mark HOST as the name of a machine running BS2000 with POSIX subsystem." | |
6058 | (interactive | |
6059 | (list (read-string "Host: " | |
6060 | (let ((name (or (buffer-file-name) default-directory))) | |
6061 | (and name (car (ange-ftp-ftp-name name))))))) | |
6062 | (if (not (ange-ftp-bs2000-posix-host host)) | |
6063 | (setq ange-ftp-bs2000-posix-host-regexp | |
6064 | (concat "^" (regexp-quote host) "$" | |
6065 | (and ange-ftp-bs2000-posix-host-regexp "\\|") | |
6066 | ange-ftp-bs2000-posix-host-regexp) | |
6067 | ange-ftp-host-cache nil)) | |
6068 | ;; Install CD hook to cd to posix on connecting: | |
e3441f42 | 6069 | (add-hook 'ange-ftp-process-startup-hook 'ange-ftp-bs2000-cd-to-posix) |
9c35d706 RS |
6070 | host) |
6071 | ||
6072 | (defconst ange-ftp-bs2000-filename-regexp | |
6073 | (concat | |
6074 | "\\(" ange-ftp-bs2000-filename-prefix-regexp "\\)?" | |
6075 | "\\(" ange-ftp-bs2000-short-filename-regexp "\\)") | |
6076 | "Regular expression to match for a valid BS2000 file name.") | |
6077 | ||
6078 | (defcustom ange-ftp-bs2000-additional-pubsets | |
6079 | nil | |
6080 | "*List of additional pubsets available to all users." | |
6081 | :group 'ange-ftp | |
33ceea4f | 6082 | :type '(repeat string)) |
9c35d706 RS |
6083 | |
6084 | ;; These parsing functions are as general as possible because the syntax | |
6085 | ;; of ftp listings from BS2000 hosts is a bit erratic. What saves us is that | |
6086 | ;; the BS2000 filename syntax is so rigid. | |
6087 | ||
6088 | ;; Extract the next filename from a BS2000 dired-like listing. | |
6089 | (defun ange-ftp-parse-bs2000-filename () | |
6090 | (if (re-search-forward ange-ftp-bs2000-filename-regexp nil t) | |
e3441f42 | 6091 | (match-string 2))) |
9c35d706 RS |
6092 | |
6093 | ;; Parse the current buffer which is assumed to be in (some) BS2000 FTP dir | |
6094 | ;; format, and return a hashtable as the result. | |
6095 | (defun ange-ftp-parse-bs2000-listing () | |
6e85ef5f | 6096 | (let ((tbl (make-hash-table :test 'equal)) |
9c35d706 RS |
6097 | pubset |
6098 | file) | |
6099 | ;; get current pubset | |
6100 | (goto-char (point-min)) | |
6101 | (if (re-search-forward ange-ftp-bs2000-filename-pubset-regexp nil t) | |
e3441f42 | 6102 | (setq pubset (match-string 0))) |
9c35d706 RS |
6103 | ;; add files to hashtable |
6104 | (goto-char (point-min)) | |
6105 | (save-match-data | |
6106 | (while (setq file (ange-ftp-parse-bs2000-filename)) | |
6e85ef5f | 6107 | (puthash file nil tbl))) |
9c35d706 | 6108 | ;; add . and .. |
6e85ef5f SM |
6109 | (puthash "." t tbl) |
6110 | (puthash ".." t tbl) | |
9c35d706 RS |
6111 | ;; add all additional pubsets, if not listing one of them |
6112 | (if (not (member pubset ange-ftp-bs2000-additional-pubsets)) | |
d590ea4d JB |
6113 | (mapc (lambda (pubset) (puthash pubset t tbl)) |
6114 | ange-ftp-bs2000-additional-pubsets)) | |
9c35d706 RS |
6115 | tbl)) |
6116 | ||
e3441f42 SM |
6117 | (add-to-list 'ange-ftp-parse-list-func-alist |
6118 | '(bs2000 . ange-ftp-parse-bs2000-listing)) | |
9c35d706 | 6119 | |
9c35d706 RS |
6120 | (defun ange-ftp-bs2000-cd-to-posix () |
6121 | "cd to POSIX subsystem if the current host matches | |
e3441f42 SM |
6122 | `ange-ftp-bs2000-posix-host-regexp'. All BS2000 hosts with POSIX subsystem |
6123 | MUST BE EXPLICITLY SET with `ange-ftp-add-bs2000-posix-host' for they cannot | |
9c35d706 | 6124 | be recognized automatically (they are all valid BS2000 hosts too)." |
e3441f42 | 6125 | (if (and ange-ftp-this-host (ange-ftp-bs2000-posix-host ange-ftp-this-host)) |
9c35d706 RS |
6126 | (progn |
6127 | ;; change to POSIX: | |
6128 | ; (ange-ftp-raw-send-cmd proc "cd %POSIX") | |
e3441f42 | 6129 | (ange-ftp-cd ange-ftp-this-host ange-ftp-this-user "%POSIX") |
9c35d706 | 6130 | ;; put new home directory in the expand-dir hashtable. |
e3441f42 SM |
6131 | ;; `ange-ftp-this-host' and `ange-ftp-this-user' are bound in |
6132 | ;; ange-ftp-get-process. | |
6133 | (puthash (concat ange-ftp-this-host "/" ange-ftp-this-user "/~") | |
6134 | (car (ange-ftp-get-pwd ange-ftp-this-host ange-ftp-this-user)) | |
6e85ef5f | 6135 | ange-ftp-expand-dir-hashtable)))) |
9c35d706 RS |
6136 | |
6137 | ;; Not available yet: | |
6138 | ;; ange-ftp-bs2000-delete-file-entry | |
6139 | ;; ange-ftp-bs2000-add-file-entry | |
6140 | ;; ange-ftp-bs2000-file-name-as-directory | |
6141 | ;; ange-ftp-bs2000-make-compressed-filename | |
6142 | ;; ange-ftp-bs2000-file-name-sans-versions | |
6143 | \f | |
8749abea GM |
6144 | ;;;; ------------------------------------------------------------ |
6145 | ;;;; Finally provide package. | |
6146 | ;;;; ------------------------------------------------------------ | |
6147 | ||
6148 | (provide 'ange-ftp) | |
6149 | ||
aa6f7b96 | 6150 | ;; arch-tag: 2987ef88-cb56-4ec1-87a9-79132572e316 |
8749abea | 6151 | ;;; ange-ftp.el ends here |