]> code.delx.au - gnu-emacs/blob - lisp/ange-ftp.el
(replace_buffer_in_all_windows): Only re-select old
[gnu-emacs] / lisp / ange-ftp.el
1 ;;; ange-ftp.el --- transparent FTP support for GNU Emacs
2
3 ;;; Copyright (C) 1989,90,91,92,93,94,95 Free Software Foundation, Inc.
4 ;;;
5 ;; Author: Andy Norman (ange@hplb.hpl.hp.com)
6 ;; Keywords: comm
7 ;;;
8 ;;; This program is free software; you can redistribute it and/or modify
9 ;;; it under the terms of the GNU General Public License as published by
10 ;;; the Free Software Foundation; either version 2, or (at your option)
11 ;;; any later version.
12 ;;;
13 ;;; This program is distributed in the hope that it will be useful,
14 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;;; GNU General Public License for more details.
17 ;;;
18 ;;; A copy of the GNU General Public License can be obtained from this
19 ;;; program's author (send electronic mail to ange@hplb.hpl.hp.com) or from
20 ;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
21 ;;; 02139, USA.
22
23 ;;; Commentary:
24 ;;;
25 ;;; This package attempts to make accessing files and directories using FTP
26 ;;; from within GNU Emacs as simple and transparent as possible. A subset of
27 ;;; the common file-handling routines are extended to interact with FTP.
28
29 ;;; Usage:
30 ;;;
31 ;;; Some of the common GNU Emacs file-handling operations have been made
32 ;;; FTP-smart. If one of these routines is given a filename that matches
33 ;;; '/user@host:name' then it will spawn an FTP process connecting to machine
34 ;;; 'host' as account 'user' and perform its operation on the file 'name'.
35 ;;;
36 ;;; For example: if find-file is given a filename of:
37 ;;;
38 ;;; /ange@anorman:/tmp/notes
39 ;;;
40 ;;; then ange-ftp spawns an FTP process, connect to the host 'anorman' as
41 ;;; user 'ange', get the file '/tmp/notes' and pop up a buffer containing the
42 ;;; contents of that file as if it were on the local filesystem. If ange-ftp
43 ;;; needs a password to connect then it reads one in the echo area.
44
45 ;;; Extended filename syntax:
46 ;;;
47 ;;; The default extended filename syntax is '/user@host:name', where the
48 ;;; 'user@' part may be omitted. This syntax can be customised to a certain
49 ;;; extent by changing ange-ftp-name-format. There are limitations.
50 ;;;
51 ;;; If the user part is omitted then ange-ftp generates a default user
52 ;;; instead whose value depends on the variable ange-ftp-default-user.
53
54 ;;; Passwords:
55 ;;;
56 ;;; A password is required for each host/user pair. Ange-ftp reads passwords
57 ;;; as needed. You can also specify a password with ange-ftp-set-passwd, or
58 ;;; in a *valid* ~/.netrc file.
59
60 ;;; Passwords for user "anonymous":
61 ;;;
62 ;;; Passwords for the user "anonymous" (or "ftp") are handled
63 ;;; specially. The variable `ange-ftp-generate-anonymous-password'
64 ;;; controls what happens: if the value of this variable is a string,
65 ;;; then this is used as the password; if non-nil (the default), then
66 ;;; the value of `user-mail-address' is used; if nil then the user
67 ;;; is prompted for a password as normal.
68
69 ;;; "Dumb" UNIX hosts:
70 ;;;
71 ;;; The FTP servers on some UNIX machines have problems if the 'ls' command is
72 ;;; used.
73 ;;;
74 ;;; The routine ange-ftp-add-dumb-unix-host can be called to tell ange-ftp to
75 ;;; limit itself to the DIR command and not 'ls' for a given UNIX host. Note
76 ;;; that this change will take effect for the current GNU Emacs session only.
77 ;;; See below for a discussion of non-UNIX hosts. If a large number of
78 ;;; machines with similar hostnames have this problem then it is easier to set
79 ;;; the value of ange-ftp-dumb-unix-host-regexp in your .emacs file. ange-ftp
80 ;;; is unable to automatically recognize dumb unix hosts.
81
82 ;;; File name completion:
83 ;;;
84 ;;; Full file-name completion is supported on UNIX, VMS, CMS, and MTS hosts.
85 ;;; To do filename completion, ange-ftp needs a listing from the remote host.
86 ;;; Therefore, for very slow connections, it might not save any time.
87
88 ;;; FTP processes:
89 ;;;
90 ;;; When ange-ftp starts up an FTP process, it leaves it running for speed
91 ;;; purposes. Some FTP servers will close the connection after a period of
92 ;;; time, but ange-ftp should be able to quietly reconnect the next time that
93 ;;; the process is needed.
94 ;;;
95 ;;; Killing the "*ftp user@host*" buffer also kills the ftp process.
96 ;;; This should not cause ange-ftp any grief.
97
98 ;;; Binary file transfers:
99 ;;;
100 ;;; By default ange-ftp transfers files in ASCII mode. If a file being
101 ;;; transferred matches the value of ange-ftp-binary-file-name-regexp then
102 ;;; binary mode is used for that transfer.
103
104 ;;; Account passwords:
105 ;;;
106 ;;; Some FTP servers require an additional password which is sent by the
107 ;;; ACCOUNT command. ange-ftp partially supports this by allowing the user to
108 ;;; specify an account password by either calling ange-ftp-set-account, or by
109 ;;; specifying an account token in the .netrc file. If the account password
110 ;;; is set by either of these methods then ange-ftp will issue an ACCOUNT
111 ;;; command upon starting the FTP process.
112
113 ;;; Preloading:
114 ;;;
115 ;;; ange-ftp can be preloaded, but must be put in the site-init.el file and
116 ;;; not the site-load.el file in order for the documentation strings for the
117 ;;; functions being overloaded to be available.
118
119 ;;; Status reports:
120 ;;;
121 ;;; Most ange-ftp commands that talk to the FTP process output a status
122 ;;; message on what they are doing. In addition, ange-ftp can take advantage
123 ;;; of the FTP client's HASH command to display the status of transferring
124 ;;; files and listing directories. See the documentation for the variables
125 ;;; ange-ftp-{ascii,binary}-hash-mark-size, ange-ftp-send-hash and
126 ;;; ange-ftp-process-verbose for more details.
127
128 ;;; Gateways:
129 ;;;
130 ;;; Sometimes it is necessary for the FTP process to be run on a different
131 ;;; machine than the machine running GNU Emacs. This can happen when the
132 ;;; local machine has restrictions on what hosts it can access.
133 ;;;
134 ;;; ange-ftp has support for running the ftp process on a different (gateway)
135 ;;; machine. The way it works is as follows:
136 ;;;
137 ;;; 1) Set the variable 'ange-ftp-gateway-host' to the name of a machine
138 ;;; that doesn't have the access restrictions.
139 ;;;
140 ;;; 2) Set the variable 'ange-ftp-local-host-regexp' to a regular expression
141 ;;; that matches hosts that can be contacted from running a local ftp
142 ;;; process, but fails to match hosts that can't be accessed locally. For
143 ;;; example:
144 ;;;
145 ;;; "\\.hp\\.com$\\|^[^.]*$"
146 ;;;
147 ;;; will match all hosts that are in the .hp.com domain, or don't have an
148 ;;; explicit domain in their name, but will fail to match hosts with
149 ;;; explicit domains or that are specified by their ip address.
150 ;;;
151 ;;; 3) Using NFS and symlinks, make sure that there is a shared directory with
152 ;;; the *same* name between the local machine and the gateway machine.
153 ;;; This directory is necessary for temporary files created by ange-ftp.
154 ;;;
155 ;;; 4) Set the variable 'ange-ftp-gateway-tmp-name-template' to the name of
156 ;;; this directory plus an identifying filename prefix. For example:
157 ;;;
158 ;;; "/nfs/hplose/ange/ange-ftp"
159 ;;;
160 ;;; where /nfs/hplose/ange is a directory that is shared between the
161 ;;; gateway machine and the local machine.
162 ;;;
163 ;;; The simplest way of getting a ftp process running on the gateway machine
164 ;;; is if you can spawn a remote shell using either 'rsh' or 'remsh'. If you
165 ;;; can't do this for some reason such as security then points 7 onwards will
166 ;;; discuss an alternative approach.
167 ;;;
168 ;;; 5) Set the variable ange-ftp-gateway-program to the name of the remote
169 ;;; shell process such as 'remsh' or 'rsh' if the default isn't correct.
170 ;;;
171 ;;; 6) Set the variable ange-ftp-gateway-program-interactive to nil if it
172 ;;; isn't already. This tells ange-ftp that you are using a remote shell
173 ;;; rather than logging in using telnet or rlogin.
174 ;;;
175 ;;; That should be all you need to allow ange-ftp to spawn a ftp process on
176 ;;; the gateway machine. If you have to use telnet or rlogin to get to the
177 ;;; gateway machine then follow the instructions below.
178 ;;;
179 ;;; 7) Set the variable ange-ftp-gateway-program to the name of the program
180 ;;; that lets you log onto the gateway machine. This may be something like
181 ;;; telnet or rlogin.
182 ;;;
183 ;;; 8) Set the variable ange-ftp-gateway-prompt-pattern to a regular
184 ;;; expression that matches the prompt you get when you login to the
185 ;;; gateway machine. Be very specific here; this regexp must not match
186 ;;; *anything* in your login banner except this prompt.
187 ;;; shell-prompt-pattern is far too general as it appears to match some
188 ;;; login banners from Sun machines. For example:
189 ;;;
190 ;;; "^$*$ *"
191 ;;;
192 ;;; 9) Set the variable ange-ftp-gateway-program-interactive to 't' to let
193 ;;; ange-ftp know that it has to "hand-hold" the login to the gateway
194 ;;; machine.
195 ;;;
196 ;;; 10) Set the variable ange-ftp-gateway-setup-term-command to a UNIX command
197 ;;; that will put the pty connected to the gateway machine into a
198 ;;; no-echoing mode, and will strip off carriage-returns from output from
199 ;;; the gateway machine. For example:
200 ;;;
201 ;;; "stty -onlcr -echo"
202 ;;;
203 ;;; will work on HP-UX machines, whereas:
204 ;;;
205 ;;; "stty -echo nl"
206 ;;;
207 ;;; appears to work for some Sun machines.
208 ;;;
209 ;;; That's all there is to it.
210
211 ;;; Smart gateways:
212 ;;;
213 ;;; If you have a "smart" ftp program that allows you to issue commands like
214 ;;; "USER foo@bar" which do nice proxy things, then look at the variables
215 ;;; ange-ftp-smart-gateway and ange-ftp-smart-gateway-port.
216 ;;;
217 ;;; Otherwise, if there is an alternate ftp program that implements proxy in
218 ;;; a transparent way (i.e. w/o specifying the proxy host), that will
219 ;;; connect you directly to the desired destination host:
220 ;;; Set ange-ftp-gateway-ftp-program-name to that program's name.
221 ;;; Set ange-ftp-local-host-regexp to a value as stated earlier on.
222 ;;; Leave ange-ftp-gateway-host set to nil.
223 ;;; Set ange-ftp-smart-gateway to t.
224
225 ;;; Tips for using ange-ftp:
226 ;;;
227 ;;; 1. For dired to work on a host which marks symlinks with a trailing @ in
228 ;;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t).
229 ;;; Most UNIX systems do not do this, but ULTRIX does. If you think that
230 ;;; there is a chance you might connect to an ULTRIX machine (such as
231 ;;; prep.ai.mit.edu), then set this variable accordingly. This will have
232 ;;; the side effect that dired will have problems with symlinks whose names
233 ;;; end in an @. If you get yourself into this situation then editing
234 ;;; dired's ls-switches to remove "F", will temporarily fix things.
235 ;;;
236 ;;; 2. If you know that you are connecting to a certain non-UNIX machine
237 ;;; frequently, and ange-ftp seems to be unable to guess its host-type,
238 ;;; then setting the appropriate host-type regexp
239 ;;; (ange-ftp-vms-host-regexp, ange-ftp-mts-host-regexp, or
240 ;;; ange-ftp-cms-host-regexp) accordingly should help. Also, please report
241 ;;; ange-ftp's inability to recognize the host-type as a bug.
242 ;;;
243 ;;; 3. For slow connections, you might get "listing unreadable" error
244 ;;; messages, or get an empty buffer for a file that you know has something
245 ;;; in it. The solution is to increase the value of ange-ftp-retry-time.
246 ;;; Its default value is 5 which is plenty for reasonable connections.
247 ;;; However, for some transatlantic connections I set this to 20.
248 ;;;
249 ;;; 4. Beware of compressing files on non-UNIX hosts. Ange-ftp will do it by
250 ;;; copying the file to the local machine, compressing it there, and then
251 ;;; sending it back. Binary file transfers between machines of different
252 ;;; architectures can be a risky business. Test things out first on some
253 ;;; test files. See "Bugs" below. Also, note that ange-ftp copies files by
254 ;;; moving them through the local machine. Again, be careful when doing
255 ;;; this with binary files on non-Unix machines.
256 ;;;
257 ;;; 5. Beware that dired over ftp will use your setting of dired-no-confirm
258 ;;; (list of dired commands for which confirmation is not asked). You
259 ;;; might want to reconsider your setting of this variable, because you
260 ;;; might want confirmation for more commands on remote direds than on
261 ;;; local direds. For example, I strongly recommend that you not include
262 ;;; compress and uncompress in this list. If there is enough demand it
263 ;;; might be a good idea to have an alist ange-ftp-dired-no-confirm of
264 ;;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST
265 ;;; is a list of commands for which confirmation would be suppressed. Then
266 ;;; remote dired listings would take their (buffer-local) value of
267 ;;; dired-no-confirm from this alist. Who votes for this?
268
269 ;;; ---------------------------------------------------------------------
270 ;;; Non-UNIX support:
271 ;;; ---------------------------------------------------------------------
272
273 ;;; VMS support:
274 ;;;
275 ;;; Ange-ftp has full support for VMS hosts. It
276 ;;; should be able to automatically recognize any VMS machine. However, if it
277 ;;; fails to do this, you can use the command ange-ftp-add-vms-host. As well,
278 ;;; you can set the variable ange-ftp-vms-host-regexp in your .emacs file. We
279 ;;; would be grateful if you would report any failures to automatically
280 ;;; recognize a VMS host as a bug.
281 ;;;
282 ;;; Filename Syntax:
283 ;;;
284 ;;; For ease of *implementation*, the user enters the VMS filename syntax in a
285 ;;; UNIX-y way. For example:
286 ;;; PUB$:[ANONYMOUS.SDSCPUB.NEXT]README.TXT;1
287 ;;; would be entered as:
288 ;;; /PUB$$:/ANONYMOUS/SDSCPUB/NEXT/README.TXT;1
289 ;;; i.e. to log in as anonymous on ymir.claremont.edu and grab the file:
290 ;;; [.CSV.POLICY]RULES.MEM
291 ;;; you would type:
292 ;;; C-x C-f /anonymous@ymir.claremont.edu:CSV/POLICY/RULES.MEM
293 ;;;
294 ;;; A legal VMS filename is of the form: FILE.TYPE;##
295 ;;; where FILE can be up to 39 characters
296 ;;; TYPE can be up to 39 characters
297 ;;; ## is a version number (an integer between 1 and 32,767)
298 ;;; Valid characters in FILE and TYPE are A-Z 0-9 _ - $
299 ;;; $ cannot begin a filename, and - cannot be used as the first or last
300 ;;; character.
301 ;;;
302 ;;; Tips:
303 ;;; 1. Although VMS is not case sensitive, EMACS running under UNIX is.
304 ;;; Therefore, to access a VMS file, you must enter the filename with upper
305 ;;; case letters.
306 ;;; 2. To access the latest version of file under VMS, you use the filename
307 ;;; without the ";" and version number. You should always edit the latest
308 ;;; version of a file. If you want to edit an earlier version, copy it to a
309 ;;; new file first. This has nothing to do with ange-ftp, but is simply
310 ;;; good VMS operating practice. Therefore, to edit FILE.TXT;3 (say 3 is
311 ;;; latest version), do C-x C-f /ymir.claremont.edu:FILE.TXT. If you
312 ;;; inadvertently do C-x C-f /ymir.claremont.edu:FILE.TXT;3, you will find
313 ;;; that VMS will not allow you to save the file because it will refuse to
314 ;;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and
315 ;;; attach the buffer to this file. To get out of this situation, M-x
316 ;;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to
317 ;;; latest version of the file. For this reason, in dired "f"
318 ;;; (dired-find-file), always loads the file sans version, whereas "v",
319 ;;; (dired-view-file), always loads the explicit version number. The
320 ;;; reasoning being that it reasonable to view old versions of a file, but
321 ;;; not to edit them.
322 ;;; 3. EMACS has a feature in which it does environment variable substitution
323 ;;; in filenames. Therefore, to enter a $ in a filename, you must quote it
324 ;;; by typing $$.
325
326 ;;; MTS support:
327 ;;;
328 ;;; Ange-ftp has full support for hosts running
329 ;;; the Michigan terminal system. It should be able to automatically
330 ;;; recognize any MTS machine. However, if it fails to do this, you can use
331 ;;; the command ange-ftp-add-mts-host. As well, you can set the variable
332 ;;; ange-ftp-mts-host-regexp in your .emacs file. We would be grateful if you
333 ;;; would report any failures to automatically recognize a MTS host as a bug.
334 ;;;
335 ;;; Filename syntax:
336 ;;;
337 ;;; MTS filenames are entered in a UNIX-y way. For example, if your account
338 ;;; was YYYY, the file FILE in the account XXXX: on mtsg.ubc.ca would be
339 ;;; entered as
340 ;;; /YYYY@mtsg.ubc.ca:/XXXX:/FILE
341 ;;; In other words, MTS accounts are treated as UNIX directories. Of course,
342 ;;; to access a file in another account, you must have access permission for
343 ;;; it. If FILE were in your own account, then you could enter it in a
344 ;;; relative name fashion as
345 ;;; /YYYY@mtsg.ubc.ca:FILE
346 ;;; MTS filenames can be up to 12 characters. Like UNIX, the structure of the
347 ;;; filename does not contain a TYPE (i.e. it can have as many "."'s as you
348 ;;; like.) MTS filenames are always in upper case, and hence be sure to enter
349 ;;; them as such! MTS is not case sensitive, but an EMACS running under UNIX
350 ;;; is.
351
352 ;;; CMS support:
353 ;;;
354 ;;; Ange-ftp has full support for hosts running
355 ;;; CMS. It should be able to automatically recognize any CMS machine.
356 ;;; However, if it fails to do this, you can use the command
357 ;;; ange-ftp-add-cms-host. As well, you can set the variable
358 ;;; ange-ftp-cms-host-regexp in your .emacs file. We would be grateful if you
359 ;;; would report any failures to automatically recognize a CMS host as a bug.
360 ;;;
361 ;;; Filename syntax:
362 ;;;
363 ;;; CMS filenames are entered in a UNIX-y way. In otherwords, minidisks are
364 ;;; treated as UNIX directories. For example to access the file READ.ME in
365 ;;; minidisk *.311 on cuvmb.cc.columbia.edu, you would enter
366 ;;; /anonymous@cuvmb.cc.columbia.edu:/*.311/READ.ME
367 ;;; If *.301 is the default minidisk for this account, you could access
368 ;;; FOO.BAR on this minidisk as
369 ;;; /anonymous@cuvmb.cc.columbia.edu:FOO.BAR
370 ;;; CMS filenames are of the form FILE.TYPE, where both FILE and TYPE can be
371 ;;; up to 8 characters. Again, beware that CMS filenames are always upper
372 ;;; case, and hence must be entered as such.
373 ;;;
374 ;;; Tips:
375 ;;; 1. CMS machines, with the exception of anonymous accounts, nearly always
376 ;;; need an account password. To have ange-ftp send an account password,
377 ;;; you can either include it in your .netrc file, or use
378 ;;; ange-ftp-set-account.
379 ;;; 2. Ange-ftp cannot send "write passwords" for a minidisk. Hopefully, we
380 ;;; can fix this.
381 ;;;
382 ;;; ------------------------------------------------------------------
383 ;;; Bugs:
384 ;;; ------------------------------------------------------------------
385 ;;;
386 ;;; 1. Umask problems:
387 ;;; Be warned that files created by using ange-ftp will take account of the
388 ;;; umask of the ftp daemon process rather than the umask of the creating
389 ;;; user. This is particularly important when logging in as the root user.
390 ;;; The way that I tighten up the ftp daemon's umask under HP-UX is to make
391 ;;; sure that the umask is changed to 027 before I spawn /etc/inetd. I
392 ;;; suspect that there is something similar on other systems.
393 ;;;
394 ;;; 2. Some combinations of FTP clients and servers break and get out of sync
395 ;;; when asked to list a non-existent directory. Some of the ai.mit.edu
396 ;;; machines cause this problem for some FTP clients. Using
397 ;;; ange-ftp-kill-ftp-process can restart the ftp process, which
398 ;;; should get things back in synch.
399 ;;;
400 ;;; 3. Ange-ftp does not check to make sure that when creating a new file,
401 ;;; you provide a valid filename for the remote operating system.
402 ;;; If you do not, then the remote FTP server will most likely
403 ;;; translate your filename in some way. This may cause ange-ftp to
404 ;;; get confused about what exactly is the name of the file. The
405 ;;; most common causes of this are using lower case filenames on systems
406 ;;; which support only upper case, and using filenames which are too
407 ;;; long.
408 ;;;
409 ;;; 4. Null (blank) passwords confuse both ange-ftp and some FTP daemons.
410 ;;;
411 ;;; 5. Ange-ftp likes to use pty's to talk to its FTP processes. If GNU Emacs
412 ;;; for some reason creates a FTP process that only talks via pipes then
413 ;;; ange-ftp won't be getting the information it requires at the time that
414 ;;; it wants it since pipes flush at different times to pty's. One
415 ;;; disgusting way around this problem is to talk to the FTP process via
416 ;;; rlogin which does the 'right' things with pty's.
417 ;;;
418 ;;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't
419 ;;; worried about this too much. Eventually, we should have some caching
420 ;;; of the current minidisk.
421 ;;;
422 ;;; 7. Some CMS machines do not assign a default minidisk when you ftp them as
423 ;;; anonymous. It is then necessary to guess a valid minidisk name, and cd
424 ;;; to it. This is (understandably) beyond ange-ftp.
425 ;;;
426 ;;; 8. Remote to remote copying of files on non-Unix machines can be risky.
427 ;;; Depending on the variable ange-ftp-binary-file-name-regexp, ange-ftp
428 ;;; will use binary mode for the copy. Between systems of different
429 ;;; architecture, this still may not be enough to guarantee the integrity
430 ;;; of binary files. Binary file transfers from VMS machines are
431 ;;; particularly problematical. Should ange-ftp-binary-file-name-regexp be
432 ;;; an alist of OS type, regexp pairs?
433 ;;;
434 ;;; 9. The code to do compression of files over ftp is not as careful as it
435 ;;; should be. It deletes the old remote version of the file, before
436 ;;; actually checking if the local to remote transfer of the compressed
437 ;;; file succeeds. Of course to delete the original version of the file
438 ;;; after transferring the compressed version back is also dangerous,
439 ;;; because some OS's have severe restrictions on the length of filenames,
440 ;;; and when the compressed version is copied back the "-Z" or ".Z" may be
441 ;;; truncated. Then, ange-ftp would delete the only remaining version of
442 ;;; the file. Maybe ange-ftp should make backups when it compresses files
443 ;;; (of course, the backup "~" could also be truncated off, sigh...).
444 ;;; Suggestions?
445 ;;;
446
447 ;;; 10. If a dir listing is attempted for an empty directory on (at least
448 ;;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and
449 ;;; I don't know how to get ange-ftp work to around it.
450 ;;;
451 ;;; 11. Bombs on filenames that start with a space. Deals well with filenames
452 ;;; containing spaces, but beware that the remote ftpd may not like them
453 ;;; much.
454 ;;;
455 ;;; 12. The dired support for non-Unix-like systems does not currently work.
456 ;;; It needs to be reimplemented by modifying the parse-...-listing
457 ;;; functions to convert the directory listing to ls -l format.
458 ;;;
459 ;;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks
460 ;;; with a trailing @ in a ls -alF listing. In order to account for this
461 ;;; ange-ftp looks to chop trailing @'s off of symlink names when it is
462 ;;; parsing a listing with the F switch. This will cause ange-ftp to
463 ;;; incorrectly get the name of a symlink on a non-ULTRIX host if its name
464 ;;; ends in an @. ange-ftp will correct itself if you take F out of the
465 ;;; dired ls switches (C-u s will allow you to edit the switches). The
466 ;;; dired buffer will be automatically reverted, which will allow ange-ftp
467 ;;; to fix its files hashtable. A cookie to anyone who can think of a
468 ;;; fast, sure-fire way to recognize ULTRIX over ftp.
469
470 ;;; If you find any bugs or problems with this package, PLEASE either e-mail
471 ;;; the above author, or send a message to the ange-ftp-lovers mailing list
472 ;;; below. Ideas and constructive comments are especially welcome.
473
474 ;;; ange-ftp-lovers:
475 ;;;
476 ;;; ange-ftp has its own mailing list modestly called ange-ftp-lovers. All
477 ;;; users of ange-ftp are welcome to subscribe (see below) and to discuss
478 ;;; aspects of ange-ftp. New versions of ange-ftp are posted periodically to
479 ;;; the mailing list.
480 ;;;
481 ;;; To [un]subscribe to ange-ftp-lovers, or to report mailer problems with the
482 ;;; list, please mail one of the following addresses:
483 ;;;
484 ;;; ange-ftp-lovers-request@anorman.hpl.hp.com
485 ;;; or
486 ;;; ange-ftp-lovers-request%anorman.hpl.hp.com@hplb.hpl.hp.com
487 ;;;
488 ;;; Please don't forget the -request part.
489 ;;;
490 ;;; For mail to be posted directly to ange-ftp-lovers, send to one of the
491 ;;; following addresses:
492 ;;;
493 ;;; ange-ftp-lovers@anorman.hpl.hp.com
494 ;;; or
495 ;;; ange-ftp-lovers%anorman.hpl.hp.com@hplb.hpl.hp.com
496 ;;;
497 ;;; Alternatively, there is a mailing list that only gets announcements of new
498 ;;; ange-ftp releases. This is called ange-ftp-lovers-announce, and can be
499 ;;; subscribed to by e-mailing to the -request address as above. Please make
500 ;;; it clear in the request which mailing list you wish to join.
501
502 ;;; The latest version of ange-ftp can usually be obtained via anonymous ftp
503 ;;; from:
504 ;;; alpha.gnu.ai.mit.edu:ange-ftp/ange-ftp.tar.Z
505 ;;; or:
506 ;;; ugle.unit.no:/pub/gnu/emacs-lisp/ange-ftp.tar.Z
507 ;;; or:
508 ;;; archive.cis.ohio-state.edu:pub/gnu/emacs/elisp-archive/packages/ange-ftp.tar.Z
509
510 ;;; The archives for ange-ftp-lovers can be found via anonymous ftp under:
511 ;;;
512 ;;; ftp.reed.edu:pub/mailing-lists/ange-ftp/
513 \f
514 ;;; -----------------------------------------------------------
515 ;;; Technical information on this package:
516 ;;; -----------------------------------------------------------
517
518 ;;; ange-ftp works by putting a handler on file-name-handler-alist
519 ;;; which is called by many primitives, and a few non-primitives,
520 ;;; whenever they see a file name of the appropriate sort.
521
522 ;;; Checklist for adding non-UNIX support for TYPE
523 ;;;
524 ;;; The following functions may need TYPE versions:
525 ;;; (not all functions will be needed for every OS)
526 ;;;
527 ;;; ange-ftp-fix-name-for-TYPE
528 ;;; ange-ftp-fix-dir-name-for-TYPE
529 ;;; ange-ftp-TYPE-host
530 ;;; ange-ftp-TYPE-add-host
531 ;;; ange-ftp-parse-TYPE-listing
532 ;;; ange-ftp-TYPE-delete-file-entry
533 ;;; ange-ftp-TYPE-add-file-entry
534 ;;; ange-ftp-TYPE-file-name-as-directory
535 ;;; ange-ftp-TYPE-make-compressed-filename
536 ;;; ange-ftp-TYPE-file-name-sans-versions
537 ;;;
538 ;;; Variables:
539 ;;;
540 ;;; ange-ftp-TYPE-host-regexp
541 ;;; May need to add TYPE to ange-ftp-dumb-host-types
542 ;;;
543 ;;; Check the following functions for OS dependent coding:
544 ;;;
545 ;;; ange-ftp-host-type
546 ;;; ange-ftp-guess-host-type
547 ;;; ange-ftp-allow-child-lookup
548
549 ;;; Host type conventions:
550 ;;;
551 ;;; The function ange-ftp-host-type and the variable ange-ftp-dired-host-type
552 ;;; (mostly) follow the following conventions for remote host types. At
553 ;;; least, I think that future code should try to follow these conventions,
554 ;;; and the current code should eventually be made compliant.
555 ;;;
556 ;;; nil = local host type, whatever that is (probably unix).
557 ;;; Think nil as in "not a remote host". This value is used by
558 ;;; ange-ftp-dired-host-type for local buffers.
559 ;;;
560 ;;; t = a remote host of unknown type. Think t is in true, it's remote.
561 ;;; Currently, 'unix is used as the default remote host type.
562 ;;; Maybe we should use t.
563 ;;;
564 ;;; 'type = a remote host of TYPE type.
565 ;;;
566 ;;; 'type:list = a remote host of TYPE type, using a specialized ftp listing
567 ;;; program called list. This is currently only used for Unix
568 ;;; dl (descriptive listings), when ange-ftp-dired-host-type
569 ;;; is set to 'unix:dl.
570
571 ;;; Bug report codes:
572 ;;;
573 ;;; Because of their naive faith in this code, there are certain situations
574 ;;; which the writers of this program believe could never happen. However,
575 ;;; being realists they have put calls to `error' in the program at these
576 ;;; points. These errors provide a code, which is an integer, greater than 1.
577 ;;; To aid debugging. the error codes, and the functions in which they reside
578 ;;; are listed below.
579 ;;;
580 ;;; 1: See ange-ftp-ls
581 ;;;
582 \f
583 ;;; -----------------------------------------------------------
584 ;;; Hall of fame:
585 ;;; -----------------------------------------------------------
586 ;;;
587 ;;; Thanks to Roland McGrath for improving the filename syntax handling,
588 ;;; for suggesting many enhancements and for numerous cleanups to the code.
589 ;;;
590 ;;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways.
591 ;;;
592 ;;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and
593 ;;; dired / shell auto-loading.
594 ;;;
595 ;;; Thanks to Sebastian Kremer for dired support and for many ideas and
596 ;;; bugfixes.
597 ;;;
598 ;;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support,
599 ;;; VOS support, and hostname completion.
600 ;;;
601 ;;; Thanks to Nakagawa Takayuki for many good ideas, filename-completion, help
602 ;;; with file-name expansion, efficiency worries, stylistic concerns and many
603 ;;; bugfixes.
604 ;;;
605 ;;; Thanks to Sandy Rutherford who re-wrote most of ange-ftp to support VMS,
606 ;;; MTS, CMS and UNIX-dls. Sandy also added dired-support for non-UNIX OS and
607 ;;; auto-recognition of the host type.
608 ;;;
609 ;;; Thanks to Dave Smith who wrote the info file for ange-ftp.
610 ;;;
611 ;;; Finally, thanks to Keith Waclena, Mark D. Baushke, Terence Kelleher, Ping
612 ;;; Zhou, Edward Vielmetti, Jack Repenning, Mike Balenger, Todd Kaufmann,
613 ;;; Kjetil Svarstad, Tom Wurgler, Linus Tolke, Niko Makila, Carl Edman, Bill
614 ;;; Trost, Dave Brennan, Dan Jacobson, Andy Scott, Steve Anderson, Sanjay
615 ;;; Mathur, the folks on the ange-ftp-lovers mailing list and many others
616 ;;; whose names I've forgotten who have helped to debug and fix problems with
617 ;;; ange-ftp.el.
618 \f
619
620 ;;; Code:
621 (require 'comint)
622
623 ;;;; ------------------------------------------------------------
624 ;;;; User customization variables.
625 ;;;; ------------------------------------------------------------
626
627 (defvar ange-ftp-name-format
628 '("^/\\(\\([^@/:]*\\)@\\)?\\([^@/:]*\\):\\(.*\\)" . (3 2 4))
629 "*Format of a fully expanded remote file name.
630 This is a list of the form \(REGEXP HOST USER NAME\),
631 where REGEXP is a regular expression matching
632 the full remote name, and HOST, USER, and NAME are the numbers of
633 parenthesized expressions in REGEXP for the components (in that order).")
634
635 ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of
636 ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs.
637 ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out.
638
639 (defvar ange-ftp-multi-msgs
640 "^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-"
641 "*Regular expression matching the start of a multiline ftp reply.")
642
643 (defvar ange-ftp-good-msgs
644 "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark"
645 "*Regular expression matching ftp \"success\" messages.")
646
647 ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT.
648 ;; Also CMS machines use a multiline 550- reply to say that you
649 ;; don't have write permission. ange-ftp gets into multi-line skip
650 ;; mode and hangs. Have it ignore 550- instead. It will then barf
651 ;; when it gets the 550 line, as it should.
652
653 (defvar ange-ftp-skip-msgs
654 (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|"
655 "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|"
656 "^Data connection \\|"
657 "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye")
658 "*Regular expression matching ftp messages that can be ignored.")
659
660 (defvar ange-ftp-fatal-msgs
661 (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|"
662 "^No control connection\\|unknown host\\|^lost connection")
663 "*Regular expression matching ftp messages that indicate serious errors.
664 These mean that the FTP process should (or already has) been killed.")
665
666 (defvar ange-ftp-gateway-fatal-msgs
667 "No route to host\\|Connection closed\\|No such host\\|Login incorrect"
668 "*Regular expression matching login failure messages from rlogin/telnet.")
669
670 (defvar ange-ftp-xfer-size-msgs
671 "^150 .* connection for .* (\\([0-9]+\\) bytes)"
672 "*Regular expression used to determine the number of bytes in a FTP transfer.")
673
674 (defvar ange-ftp-tmp-name-template "/tmp/ange-ftp"
675 "*Template used to create temporary files.")
676
677 (defvar ange-ftp-gateway-tmp-name-template "/tmp/ange-ftp"
678 "*Template used to create temporary files when ftp-ing through a gateway.
679 Files starting with this prefix need to be accessible from BOTH the local
680 machine and the gateway machine, and need to have the SAME name on both
681 machines, that is, /tmp is probably NOT what you want, since that is rarely
682 cross-mounted.")
683
684 (defvar ange-ftp-netrc-filename "~/.netrc"
685 "*File in .netrc format to search for passwords.")
686
687 (defvar ange-ftp-disable-netrc-security-check nil
688 "*If non-nil avoid checking permissions on the .netrc file.")
689
690 (defvar ange-ftp-default-user nil
691 "*User name to use when none is specied in a file name.
692 If nil, then the name under which the user is logged in is used.
693 If non-nil but not a string, the user is prompted for the name.")
694
695 (defvar ange-ftp-default-password nil
696 "*Password to use when the user is the same as ange-ftp-default-user.")
697
698 (defvar ange-ftp-default-account nil
699 "*Account password to use when the user is the same as ange-ftp-default-user.")
700
701 (defvar ange-ftp-generate-anonymous-password t
702 "*If t, use value of `user-mail-address' as password for anonymous ftp.
703 If a string, then use that string as the password.
704 If nil, prompt the user for a password.")
705
706 (defvar ange-ftp-dumb-unix-host-regexp nil
707 "*If non-nil, regexp matching hosts on which `dir' command lists directory.")
708
709 (defvar ange-ftp-binary-file-name-regexp
710 (concat "\\.[zZ]$\\|\\.lzh$\\|\\.arc$\\|\\.zip$\\|\\.zoo$\\|\\.tar$\\|"
711 "\\.dvi$\\|\\.ps$\\|\\.elc$\\|TAGS$\\|\\.gif$\\|"
712 "\\.EXE\\(;[0-9]+\\)?$\\|\\.[zZ]-part-..$\\|\\.gz$\\|"
713 "\\.taz$\\|\\.tgz$")
714 "*If a file matches this regexp then it is transferred in binary mode.")
715
716 (defvar ange-ftp-gateway-host nil
717 "*Name of host to use as gateway machine when local FTP isn't possible.")
718
719 (defvar ange-ftp-local-host-regexp ".*"
720 "*Regexp selecting hosts which can be reached directly with ftp.
721 For other hosts the FTP process is started on \`ange-ftp-gateway-host\'
722 instead, and/or reached via \`ange-ftp-gateway-ftp-program-name\'.")
723
724 (defvar ange-ftp-gateway-program-interactive nil
725 "*If non-nil then the gateway program should give a shell prompt.
726 Both telnet and rlogin do something like this.")
727
728 (defvar ange-ftp-gateway-program remote-shell-program
729 "*Name of program to spawn a shell on the gateway machine.
730 Valid candidates are rsh (remsh on some systems), telnet and rlogin. See
731 also the gateway variable above.")
732
733 (defvar ange-ftp-gateway-prompt-pattern "^[^#$%>;\n]*[#$%>;] *"
734 "*Regexp matching prompt after complete login sequence on gateway machine.
735 A match for this means the shell is now awaiting input. Make this regexp as
736 strict as possible; it shouldn't match *anything* at all except the user's
737 initial prompt. The above string will fail under most SUN-3's since it
738 matches the login banner.")
739
740 (defvar ange-ftp-gateway-setup-term-command
741 (if (eq system-type 'hpux)
742 "stty -onlcr -echo\n"
743 "stty -echo nl\n")
744 "*Set up terminal after logging in to the gateway machine.
745 This command should stop the terminal from echoing each command, and
746 arrange to strip out trailing ^M characters.")
747
748 (defvar ange-ftp-smart-gateway nil
749 "*Non-nil means the ftp gateway and/or the gateway ftp program is smart.
750 Don't bother telnetting, etc., already connected to desired host transparently,
751 or just issue a user@host command in case \`ange-ftp-gateway-host\' is non-nil.")
752
753 (defvar ange-ftp-smart-gateway-port "21"
754 "*Port on gateway machine to use when smart gateway is in operation.")
755
756 (defvar ange-ftp-send-hash t
757 "*If non-nil, send the HASH command to the FTP client.")
758
759 (defvar ange-ftp-binary-hash-mark-size nil
760 "*Default size, in bytes, between hash-marks when transferring a binary file.
761 If NIL, this variable will be locally overridden if the FTP client outputs a
762 suitable response to the HASH command. If non-NIL then this value takes
763 precedence over the local value.")
764
765 (defvar ange-ftp-ascii-hash-mark-size 1024
766 "*Default size, in bytes, between hash-marks when transferring an ASCII file.
767 This variable is buffer-local and will be locally overridden if the FTP client
768 outputs a suitable response to the HASH command.")
769
770 (defvar ange-ftp-process-verbose t
771 "*If non-NIL then be chatty about interaction with the FTP process.")
772
773 (defvar ange-ftp-ftp-program-name "ftp"
774 "*Name of FTP program to run.")
775
776 (defvar ange-ftp-gateway-ftp-program-name "ftp"
777 "*Name of FTP program to run when accessing non-local hosts.
778 Some AT&T folks claim to use something called `pftp' here.")
779
780 (defvar ange-ftp-ftp-program-args '("-i" "-n" "-g" "-v")
781 "*A list of arguments passed to the FTP program when started.")
782
783 (defvar ange-ftp-nslookup-program nil
784 "*If non-NIL then a string naming nslookup program." )
785
786 (defvar ange-ftp-make-backup-files ()
787 "*Non-nil means make backup files for \"magic\" remote files.")
788
789 (defvar ange-ftp-retry-time 5
790 "*Number of seconds to wait before retry if file or listing doesn't arrive.
791 This might need to be increased for very slow connections.")
792
793 (defvar ange-ftp-auto-save 0
794 "If 1, allows ange-ftp files to be auto-saved.
795 If 0, suppresses auto-saving of ange-ftp files.
796 Don't use any other value.")
797 \f
798 ;;;; ------------------------------------------------------------
799 ;;;; Hash table support.
800 ;;;; ------------------------------------------------------------
801
802 (require 'backquote)
803
804 (defun ange-ftp-make-hashtable (&optional size)
805 "Make an obarray suitable for use as a hashtable.
806 SIZE, if supplied, should be a prime number."
807 (make-vector (or size 31) 0))
808
809 (defun ange-ftp-map-hashtable (fun tbl)
810 "Call FUNCTION on each key and value in HASHTABLE."
811 (mapatoms
812 (function
813 (lambda (sym)
814 (funcall fun (get sym 'key) (get sym 'val))))
815 tbl))
816
817 (defmacro ange-ftp-make-hash-key (key)
818 "Convert KEY into a suitable key for a hashtable."
819 (` (if (stringp (, key))
820 (, key)
821 (prin1-to-string (, key)))))
822
823 (defun ange-ftp-get-hash-entry (key tbl)
824 "Return the value associated with KEY in HASHTABLE."
825 (let ((sym (intern-soft (ange-ftp-make-hash-key key) tbl)))
826 (and sym (get sym 'val))))
827
828 (defun ange-ftp-put-hash-entry (key val tbl)
829 "Record an association between KEY and VALUE in HASHTABLE."
830 (let ((sym (intern (ange-ftp-make-hash-key key) tbl)))
831 (put sym 'val val)
832 (put sym 'key key)))
833
834 (defun ange-ftp-del-hash-entry (key tbl)
835 "Copy all symbols except KEY in HASHTABLE and return modified hashtable."
836 (let* ((len (length tbl))
837 (new-tbl (ange-ftp-make-hashtable len))
838 (i (1- len)))
839 (ange-ftp-map-hashtable
840 (function
841 (lambda (k v)
842 (or (equal k key)
843 (ange-ftp-put-hash-entry k v new-tbl))))
844 tbl)
845 (while (>= i 0)
846 (aset tbl i (aref new-tbl i))
847 (setq i (1- i)))
848 tbl))
849
850 (defun ange-ftp-hash-entry-exists-p (key tbl)
851 "Return whether there is an association for KEY in TABLE."
852 (intern-soft (ange-ftp-make-hash-key key) tbl))
853
854 (defun ange-ftp-hash-table-keys (tbl)
855 "Return a sorted list of all the active keys in TABLE, as strings."
856 (sort (all-completions "" tbl)
857 (function string-lessp)))
858 \f
859 ;;;; ------------------------------------------------------------
860 ;;;; Internal variables.
861 ;;;; ------------------------------------------------------------
862
863 (defvar ange-ftp-data-buffer-name " *ftp data*"
864 "Buffer name to hold directory listing data received from ftp process.")
865
866 (defvar ange-ftp-netrc-modtime nil
867 "Last modified time of the netrc file from file-attributes.")
868
869 (defvar ange-ftp-user-hashtable (ange-ftp-make-hashtable)
870 "Hash table holding associations between HOST, USER pairs.")
871
872 (defvar ange-ftp-passwd-hashtable (ange-ftp-make-hashtable)
873 "Mapping between a HOST, USER pair and a PASSWORD for them.")
874
875 (defvar ange-ftp-account-hashtable (ange-ftp-make-hashtable)
876 "Mapping between a HOST, USER pair and a ACCOUNT password for them.")
877
878 (defvar ange-ftp-files-hashtable (ange-ftp-make-hashtable 97)
879 "Hash table for storing directories and their respective files.")
880
881 (defvar ange-ftp-ls-cache-lsargs nil
882 "Last set of args used by ange-ftp-ls.")
883
884 (defvar ange-ftp-ls-cache-file nil
885 "Last file passed to ange-ftp-ls.")
886
887 (defvar ange-ftp-ls-cache-res nil
888 "Last result returned from ange-ftp-ls.")
889
890 (defconst ange-ftp-expand-dir-hashtable (ange-ftp-make-hashtable))
891
892 (defconst ange-ftp-expand-dir-regexp "^5.0 \\([^: ]+\\):")
893
894 ;; These are local variables in each FTP process buffer.
895 (defvar ange-ftp-hash-mark-unit nil)
896 (defvar ange-ftp-hash-mark-count nil)
897 (defvar ange-ftp-xfer-size nil)
898 (defvar ange-ftp-process-string nil)
899 (defvar ange-ftp-process-result-line nil)
900 (defvar ange-ftp-process-busy nil)
901 (defvar ange-ftp-process-result nil)
902 (defvar ange-ftp-process-multi-skip nil)
903 (defvar ange-ftp-process-msg nil)
904 (defvar ange-ftp-process-continue nil)
905 (defvar ange-ftp-last-percent nil)
906
907 ;; These variables are bound by one function and examined by another.
908 ;; Leave them void globally for error checking.
909 (defvar ange-ftp-this-file)
910 (defvar ange-ftp-this-dir)
911 (defvar ange-ftp-this-user)
912 (defvar ange-ftp-this-host)
913 (defvar ange-ftp-this-msg)
914 (defvar ange-ftp-completion-ignored-pattern)
915 (defvar ange-ftp-trample-marker)
916 \f
917 ;; New error symbols.
918 (put 'ftp-error 'error-conditions '(ftp-error file-error error))
919 ;; (put 'ftp-error 'error-message "FTP error")
920 \f
921 ;;; ------------------------------------------------------------
922 ;;; Enhanced message support.
923 ;;; ------------------------------------------------------------
924
925 (defun ange-ftp-message (fmt &rest args)
926 "Display message in echo area, but indicate if truncated.
927 Args are as in `message': a format string, plus arguments to be formatted."
928 (let ((msg (apply (function format) fmt args))
929 (max (window-width (minibuffer-window))))
930 (if noninteractive
931 msg
932 (if (>= (length msg) max)
933 ;; Take just the last MAX - 3 chars of the string.
934 (setq msg (concat "> " (substring msg (- 3 max)))))
935 (message "%s" msg))))
936
937 (defun ange-ftp-abbreviate-filename (file &optional new)
938 "Abbreviate the file name FILE relative to the default-directory.
939 If the optional parameter NEW is given and the non-directory parts match,
940 only return the directory part of FILE."
941 (save-match-data
942 (if (and default-directory
943 (string-match (concat "^"
944 (regexp-quote default-directory)
945 ".") file))
946 (setq file (substring file (1- (match-end 0)))))
947 (if (and new
948 (string-equal (file-name-nondirectory file)
949 (file-name-nondirectory new)))
950 (setq file (file-name-directory file)))
951 (or file "./")))
952 \f
953 ;;;; ------------------------------------------------------------
954 ;;;; User / Host mapping support.
955 ;;;; ------------------------------------------------------------
956
957 (defun ange-ftp-set-user (host user)
958 "For a given HOST, set or change the default USER."
959 (interactive "sHost: \nsUser: ")
960 (ange-ftp-put-hash-entry host user ange-ftp-user-hashtable))
961
962 (defun ange-ftp-get-user (host)
963 "Given a HOST, return the default USER."
964 (ange-ftp-parse-netrc)
965 (let ((user (ange-ftp-get-hash-entry host ange-ftp-user-hashtable)))
966 (or user
967 (prog1
968 (setq user
969 (cond ((stringp ange-ftp-default-user)
970 ;; We have a default name. Use it.
971 ange-ftp-default-user)
972 (ange-ftp-default-user
973 ;; Ask the user.
974 (let ((enable-recursive-minibuffers t))
975 (read-string (format "User for %s: " host)
976 (user-login-name))))
977 ;; Default to the user's login name.
978 (t
979 (user-login-name))))
980 (ange-ftp-set-user host user)))))
981 \f
982 ;;;; ------------------------------------------------------------
983 ;;;; Password support.
984 ;;;; ------------------------------------------------------------
985
986 (defun ange-ftp-read-passwd (prompt &optional default)
987 "Read a password, echoing `.' for each character typed.
988 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
989 Optional DEFAULT is password to start with."
990 (let ((pass (if default default ""))
991 (c 0)
992 (echo-keystrokes 0)
993 (cursor-in-echo-area t))
994 (while (progn (message "%s%s"
995 prompt
996 (make-string (length pass) ?.))
997 (setq c (read-char))
998 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
999 (if (= c ?\C-u)
1000 (setq pass "")
1001 (if (and (/= c ?\b) (/= c ?\177))
1002 (setq pass (concat pass (char-to-string c)))
1003 (if (> (length pass) 0)
1004 (setq pass (substring pass 0 -1))))))
1005 (message "")
1006 (ange-ftp-repaint-minibuffer)
1007 pass))
1008
1009 (defmacro ange-ftp-generate-passwd-key (host user)
1010 (` (concat (, host) "/" (, user))))
1011
1012 (defmacro ange-ftp-lookup-passwd (host user)
1013 (` (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key (, host) (, user))
1014 ange-ftp-passwd-hashtable)))
1015
1016 (defun ange-ftp-set-passwd (host user passwd)
1017 "For a given HOST and USER, set or change the associated PASSWORD."
1018 (interactive (list (read-string "Host: ")
1019 (read-string "User: ")
1020 (ange-ftp-read-passwd "Password: ")))
1021 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user)
1022 passwd
1023 ange-ftp-passwd-hashtable))
1024
1025 (defun ange-ftp-get-host-with-passwd (user)
1026 "Given a USER, return a host we know the password for."
1027 (ange-ftp-parse-netrc)
1028 (catch 'found-one
1029 (ange-ftp-map-hashtable
1030 (function (lambda (host val)
1031 (if (ange-ftp-lookup-passwd host user)
1032 (throw 'found-one host))))
1033 ange-ftp-user-hashtable)
1034 (save-match-data
1035 (ange-ftp-map-hashtable
1036 (function
1037 (lambda (key value)
1038 (if (string-match "^[^/]*\\(/\\).*$" key)
1039 (let ((host (substring key 0 (match-beginning 1))))
1040 (if (and (string-equal user (substring key (match-end 1)))
1041 value)
1042 (throw 'found-one host))))))
1043 ange-ftp-passwd-hashtable))
1044 nil))
1045
1046 (defun ange-ftp-get-passwd (host user)
1047 "Return the password for specified HOST and USER, asking user if necessary."
1048 (ange-ftp-parse-netrc)
1049
1050 ;; look up password in the hash table first; user might have overridden the
1051 ;; defaults.
1052 (cond ((ange-ftp-lookup-passwd host user))
1053
1054 ;; see if default user and password set from the .netrc file.
1055 ((and (stringp ange-ftp-default-user)
1056 ange-ftp-default-password
1057 (string-equal user ange-ftp-default-user))
1058 ange-ftp-default-password)
1059
1060 ;; anonymous ftp password is handled specially since there is an
1061 ;; unwritten rule about how that is used on the Internet.
1062 ((and (or (string-equal user "anonymous")
1063 (string-equal user "ftp"))
1064 ange-ftp-generate-anonymous-password)
1065 (if (stringp ange-ftp-generate-anonymous-password)
1066 ange-ftp-generate-anonymous-password
1067 user-mail-address))
1068
1069 ;; see if same user has logged in to other hosts; if so then prompt
1070 ;; with the password that was used there.
1071 (t
1072 (let* ((other (ange-ftp-get-host-with-passwd user))
1073 (passwd (if other
1074
1075 ;; found another machine with the same user.
1076 ;; Try that account.
1077 (ange-ftp-read-passwd
1078 (format "passwd for %s@%s (same as %s@%s): "
1079 user host user other)
1080 (ange-ftp-lookup-passwd other user))
1081
1082 ;; I give up. Ask the user for the password.
1083 (ange-ftp-read-passwd
1084 (format "Password for %s@%s: " user host)))))
1085 (ange-ftp-set-passwd host user passwd)
1086 passwd))))
1087 \f
1088 ;;;; ------------------------------------------------------------
1089 ;;;; Account support
1090 ;;;; ------------------------------------------------------------
1091
1092 ;; Account passwords must be either specified in the .netrc file, or set
1093 ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't
1094 ;; check to see whether the FTP process is actually prompting for an account
1095 ;; password.
1096
1097 (defun ange-ftp-set-account (host user account)
1098 "For a given HOST and USER, set or change the associated ACCOUNT password."
1099 (interactive (list (read-string "Host: ")
1100 (read-string "User: ")
1101 (ange-ftp-read-passwd "Account password: ")))
1102 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user)
1103 account
1104 ange-ftp-account-hashtable))
1105
1106 (defun ange-ftp-get-account (host user)
1107 "Given a HOST and USER, return the FTP account."
1108 (ange-ftp-parse-netrc)
1109 (or (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key host user)
1110 ange-ftp-account-hashtable)
1111 (and (stringp ange-ftp-default-user)
1112 (string-equal user ange-ftp-default-user)
1113 ange-ftp-default-account)))
1114 \f
1115 ;;;; ------------------------------------------------------------
1116 ;;;; ~/.netrc support
1117 ;;;; ------------------------------------------------------------
1118
1119 (defun ange-ftp-chase-symlinks (file)
1120 "Return the filename that FILE references, following all symbolic links."
1121 (let (temp)
1122 (while (setq temp (ange-ftp-real-file-symlink-p file))
1123 (setq file
1124 (if (file-name-absolute-p temp)
1125 temp
1126 (concat (file-name-directory file) temp)))))
1127 file)
1128
1129 ;; Move along current line looking for the value of the TOKEN.
1130 ;; Valid separators between TOKEN and its value are commas and
1131 ;; whitespace. Second arg LIMIT is a limit for the search.
1132
1133 (defun ange-ftp-parse-netrc-token (token limit)
1134 (if (search-forward token limit t)
1135 (let (beg)
1136 (skip-chars-forward ", \t\r\n" limit)
1137 (if (eq (following-char) ?\") ;quoted token value
1138 (progn (forward-char 1)
1139 (setq beg (point))
1140 (skip-chars-forward "^\"" limit)
1141 (forward-char 1)
1142 (buffer-substring beg (1- (point))))
1143 (setq beg (point))
1144 (skip-chars-forward "^, \t\r\n" limit)
1145 (buffer-substring beg (point))))))
1146
1147 ;; Extract the values for the tokens `machine', `login',
1148 ;; `password' and `account' in the current buffer. If successful,
1149 ;; record the information found.
1150
1151 (defun ange-ftp-parse-netrc-group ()
1152 (let ((start (point))
1153 (end (save-excursion
1154 (if (looking-at "machine\\>")
1155 ;; Skip `machine' and the machine name that follows.
1156 (progn
1157 (skip-chars-forward "^ \t\n")
1158 (skip-chars-forward " \t\n")
1159 (skip-chars-forward "^ \t\n"))
1160 ;; Skip `default'.
1161 (skip-chars-forward "^ \t\n"))
1162 ;; Find start of the next `machine' or `default'
1163 ;; or the end of the buffer.
1164 (if (re-search-forward "machine\\>\\|default\\>" nil t)
1165 (match-beginning 0)
1166 (point-max))))
1167 machine login password account)
1168 (setq machine (ange-ftp-parse-netrc-token "machine" end)
1169 login (ange-ftp-parse-netrc-token "login" end)
1170 password (ange-ftp-parse-netrc-token "password" end)
1171 account (ange-ftp-parse-netrc-token "account" end))
1172 (if (and machine login)
1173 ;; found a `machine` token.
1174 (progn
1175 (ange-ftp-set-user machine login)
1176 (ange-ftp-set-passwd machine login password)
1177 (and account
1178 (ange-ftp-set-account machine login account)))
1179 (goto-char start)
1180 (if (search-forward "default" end t)
1181 ;; found a `default' token
1182 (progn
1183 (setq login (ange-ftp-parse-netrc-token "login" end)
1184 password (ange-ftp-parse-netrc-token "password" end)
1185 account (ange-ftp-parse-netrc-token "account" end))
1186 (and login
1187 (setq ange-ftp-default-user login))
1188 (and password
1189 (setq ange-ftp-default-password password))
1190 (and account
1191 (setq ange-ftp-default-account account)))))
1192 (goto-char end)))
1193
1194 ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has
1195 ;; the correct permissions then extract the \`machine\', \`login\',
1196 ;; \`password\' and \`account\' information from within.
1197
1198 (defun ange-ftp-parse-netrc ()
1199 ;; We set this before actually doing it to avoid the possibility
1200 ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file.
1201 (interactive)
1202 (let (file attr)
1203 (let ((default-directory "/"))
1204 (setq file (ange-ftp-chase-symlinks
1205 (ange-ftp-real-expand-file-name ange-ftp-netrc-filename)))
1206 (setq attr (ange-ftp-real-file-attributes file)))
1207 (if (and attr ; file exists.
1208 (not (equal (nth 5 attr) ange-ftp-netrc-modtime))) ; file changed
1209 (save-match-data
1210 (if (or ange-ftp-disable-netrc-security-check
1211 (and (eq (nth 2 attr) (user-uid)) ; Same uids.
1212 (string-match ".r..------" (nth 8 attr))))
1213 (save-excursion
1214 ;; we are cheating a bit here. I'm trying to do the equivalent
1215 ;; of find-file on the .netrc file, but then nuke it afterwards.
1216 ;; with the bit of logic below we should be able to have
1217 ;; encrypted .netrc files.
1218 (set-buffer (generate-new-buffer "*ftp-.netrc*"))
1219 (ange-ftp-real-insert-file-contents file)
1220 (setq buffer-file-name file)
1221 (setq default-directory (file-name-directory file))
1222 (normal-mode t)
1223 (mapcar 'funcall find-file-hooks)
1224 (setq buffer-file-name nil)
1225 (goto-char (point-min))
1226 (skip-chars-forward " \t\n")
1227 (while (not (eobp))
1228 (ange-ftp-parse-netrc-group))
1229 (kill-buffer (current-buffer)))
1230 (ange-ftp-message "%s either not owned by you or badly protected."
1231 ange-ftp-netrc-filename)
1232 (sit-for 1))
1233 (setq ange-ftp-netrc-modtime (nth 5 attr))))))
1234
1235 ;; Return a list of prefixes of the form 'user@host:' to be used when
1236 ;; completion is done in the root directory.
1237
1238 (defun ange-ftp-generate-root-prefixes ()
1239 (ange-ftp-parse-netrc)
1240 (save-match-data
1241 (let (res)
1242 (ange-ftp-map-hashtable
1243 (function
1244 (lambda (key value)
1245 (if (string-match "^[^/]*\\(/\\).*$" key)
1246 (let ((host (substring key 0 (match-beginning 1)))
1247 (user (substring key (match-end 1))))
1248 (setq res (cons (list (concat user "@" host ":"))
1249 res))))))
1250 ange-ftp-passwd-hashtable)
1251 (ange-ftp-map-hashtable
1252 (function (lambda (host user)
1253 (setq res (cons (list (concat host ":"))
1254 res))))
1255 ange-ftp-user-hashtable)
1256 (or res (list nil)))))
1257 \f
1258 ;;;; ------------------------------------------------------------
1259 ;;;; Remote file name syntax support.
1260 ;;;; ------------------------------------------------------------
1261
1262 (defmacro ange-ftp-ftp-name-component (n ns name)
1263 "Extract the Nth ftp file name component from NS."
1264 (` (let ((elt (nth (, n) (, ns))))
1265 (if (match-beginning elt)
1266 (substring (, name) (match-beginning elt) (match-end elt))))))
1267
1268 (defvar ange-ftp-ftp-name-arg "")
1269 (defvar ange-ftp-ftp-name-res nil)
1270
1271 ;; Parse NAME according to `ange-ftp-name-format' (which see).
1272 ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format.
1273 (defun ange-ftp-ftp-name (name)
1274 (if (string-equal name ange-ftp-ftp-name-arg)
1275 ange-ftp-ftp-name-res
1276 (setq ange-ftp-ftp-name-arg name
1277 ange-ftp-ftp-name-res
1278 (save-match-data
1279 (if (posix-string-match (car ange-ftp-name-format) name)
1280 (let* ((ns (cdr ange-ftp-name-format))
1281 (host (ange-ftp-ftp-name-component 0 ns name))
1282 (user (ange-ftp-ftp-name-component 1 ns name))
1283 (name (ange-ftp-ftp-name-component 2 ns name)))
1284 (if (zerop (length user))
1285 (setq user (ange-ftp-get-user host)))
1286 (list host user name))
1287 nil)))))
1288
1289 ;; Take a FULLNAME that matches according to ange-ftp-name-format and
1290 ;; replace the name component with NAME.
1291 (defun ange-ftp-replace-name-component (fullname name)
1292 (save-match-data
1293 (if (posix-string-match (car ange-ftp-name-format) fullname)
1294 (let* ((ns (cdr ange-ftp-name-format))
1295 (elt (nth 2 ns)))
1296 (concat (substring fullname 0 (match-beginning elt))
1297 name
1298 (substring fullname (match-end elt)))))))
1299 \f
1300 ;;;; ------------------------------------------------------------
1301 ;;;; Miscellaneous utils.
1302 ;;;; ------------------------------------------------------------
1303
1304 ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap))
1305 ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer)
1306
1307 (defun ange-ftp-repaint-minibuffer ()
1308 "Clear any existing minibuffer message; let the minibuffer contents show."
1309 (message nil))
1310
1311 ;; Return the name of the buffer that collects output from the ftp process
1312 ;; connected to the given HOST and USER pair.
1313 (defun ange-ftp-ftp-process-buffer (host user)
1314 (concat "*ftp " user "@" host "*"))
1315
1316 ;; Display the last chunk of output from the ftp process for the given HOST
1317 ;; USER pair, and signal an error including MSG in the text.
1318 (defun ange-ftp-error (host user msg)
1319 (let ((cur (selected-window))
1320 (pop-up-windows t))
1321 (pop-to-buffer
1322 (get-buffer-create
1323 (ange-ftp-ftp-process-buffer host user)))
1324 (goto-char (point-max))
1325 (select-window cur))
1326 (signal 'ftp-error (list (format "FTP Error: %s" msg))))
1327
1328 (defun ange-ftp-set-buffer-mode ()
1329 "Set correct modes for the current buffer if visiting a remote file."
1330 (if (and (stringp buffer-file-name)
1331 (ange-ftp-ftp-name buffer-file-name))
1332 (auto-save-mode ange-ftp-auto-save)))
1333
1334 (defun ange-ftp-kill-ftp-process (buffer)
1335 "Kill the FTP process associated with BUFFER.
1336 If the BUFFER's visited filename or default-directory is an ftp filename
1337 then kill the related ftp process."
1338 (interactive "bKill FTP process associated with buffer: ")
1339 (if (null buffer)
1340 (setq buffer (current-buffer)))
1341 (let ((file (or (buffer-file-name) default-directory)))
1342 (if file
1343 (let ((parsed (ange-ftp-ftp-name (expand-file-name file))))
1344 (if parsed
1345 (let ((host (nth 0 parsed))
1346 (user (nth 1 parsed)))
1347 (kill-buffer (ange-ftp-ftp-process-buffer host user))))))))
1348
1349 (defun ange-ftp-quote-string (string)
1350 "Quote any characters in STRING that may confuse the ftp process."
1351 (apply (function concat)
1352 (mapcar (function
1353 (lambda (char)
1354 (if (or (<= char ? )
1355 (> char ?\~)
1356 (= char ?\")
1357 (= char ?\\))
1358 (vector ?\\ char)
1359 (vector char))))
1360 string)))
1361
1362 (defun ange-ftp-barf-if-not-directory (directory)
1363 (or (file-directory-p directory)
1364 (signal 'file-error
1365 (list "Opening directory"
1366 (if (file-exists-p directory)
1367 "not a directory"
1368 "no such file or directory")
1369 directory))))
1370 \f
1371 ;;;; ------------------------------------------------------------
1372 ;;;; FTP process filter support.
1373 ;;;; ------------------------------------------------------------
1374
1375 (defun ange-ftp-process-handle-line (line proc)
1376 "Look at the given LINE from the ftp process PROC.
1377 Try to categorize it into one of four categories:
1378 good, skip, fatal, or unknown."
1379 (cond ((string-match ange-ftp-xfer-size-msgs line)
1380 (setq ange-ftp-xfer-size
1381 (ash (string-to-int (substring line
1382 (match-beginning 1)
1383 (match-end 1)))
1384 -10)))
1385 ((string-match ange-ftp-skip-msgs line)
1386 t)
1387 ((string-match ange-ftp-good-msgs line)
1388 (setq ange-ftp-process-busy nil
1389 ange-ftp-process-result t
1390 ange-ftp-process-result-line line))
1391 ;; Check this before checking for errors.
1392 ;; Otherwise the last line of these three seems to be an error:
1393 ;; 230-see a significant impact from the move. For those of you who can't
1394 ;; 230-use DNS to resolve hostnames and get an error message like
1395 ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be...
1396 ((string-match ange-ftp-multi-msgs line)
1397 (setq ange-ftp-process-multi-skip t))
1398 ((string-match ange-ftp-fatal-msgs line)
1399 (delete-process proc)
1400 (setq ange-ftp-process-busy nil
1401 ange-ftp-process-result-line line))
1402 (ange-ftp-process-multi-skip
1403 t)
1404 (t
1405 (setq ange-ftp-process-busy nil
1406 ange-ftp-process-result-line line))))
1407
1408 (defun ange-ftp-set-xfer-size (host user bytes)
1409 "Set the size of the next FTP transfer in bytes."
1410 (let ((proc (ange-ftp-get-process host user)))
1411 (if proc
1412 (let ((buf (process-buffer proc)))
1413 (if buf
1414 (save-excursion
1415 (set-buffer buf)
1416 (setq ange-ftp-xfer-size (ash bytes -10))))))))
1417
1418 (defun ange-ftp-process-handle-hash (str)
1419 "Remove hash marks from STRING and display count so far."
1420 (setq str (concat (substring str 0 (match-beginning 0))
1421 (substring str (match-end 0)))
1422 ange-ftp-hash-mark-count (+ (- (match-end 0)
1423 (match-beginning 0))
1424 ange-ftp-hash-mark-count))
1425 (and ange-ftp-hash-mark-unit
1426 ange-ftp-process-msg
1427 ange-ftp-process-verbose
1428 (not (eq (selected-window) (minibuffer-window)))
1429 (not (boundp 'search-message)) ;screws up isearch otherwise
1430 (not cursor-in-echo-area) ;screws up y-or-n-p otherwise
1431 (let ((kbytes (ash (* ange-ftp-hash-mark-unit
1432 ange-ftp-hash-mark-count)
1433 -6)))
1434 (if (zerop ange-ftp-xfer-size)
1435 (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes)
1436 (let ((percent (/ (* 100 kbytes) ange-ftp-xfer-size)))
1437 ;; cut out the redisplay of identical %-age messages.
1438 (if (not (eq percent ange-ftp-last-percent))
1439 (progn
1440 (setq ange-ftp-last-percent percent)
1441 (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent)))))))
1442 str)
1443
1444 ;; Call the function specified by CONT. CONT can be either a function
1445 ;; or a list of a function and some args. The first two parameters
1446 ;; passed to the function will be RESULT and LINE. The remaining args
1447 ;; will be taken from CONT if a list was passed.
1448
1449 (defun ange-ftp-call-cont (cont result line)
1450 (if cont
1451 (if (and (listp cont)
1452 (not (eq (car cont) 'lambda)))
1453 (apply (car cont) result line (cdr cont))
1454 (funcall cont result line))))
1455
1456 ;; Build up a complete line of output from the ftp PROCESS and pass it
1457 ;; on to ange-ftp-process-handle-line to deal with.
1458
1459 (defun ange-ftp-process-filter (proc str)
1460 (let ((buffer (process-buffer proc))
1461 (old-buffer (current-buffer)))
1462
1463 ;; see if the buffer is still around... it could have been deleted.
1464 (if (buffer-name buffer)
1465 (unwind-protect
1466 (progn
1467 (set-buffer (process-buffer proc))
1468
1469 ;; handle hash mark printing
1470 (and ange-ftp-process-busy
1471 (string-match "^#+$" str)
1472 (setq str (ange-ftp-process-handle-hash str)))
1473 (comint-output-filter proc str)
1474 ;; Replace STR by the result of the comint processing.
1475 (setq str (buffer-substring comint-last-output-start
1476 (process-mark proc)))
1477 (if ange-ftp-process-busy
1478 (progn
1479 (setq ange-ftp-process-string (concat ange-ftp-process-string
1480 str))
1481
1482 ;; if we gave an empty password to the USER command earlier
1483 ;; then we should send a null password now.
1484 (if (string-match "Password: *$" ange-ftp-process-string)
1485 (send-string proc "\n"))))
1486 (while (and ange-ftp-process-busy
1487 (string-match "\n" ange-ftp-process-string))
1488 (let ((line (substring ange-ftp-process-string
1489 0
1490 (match-beginning 0))))
1491 (setq ange-ftp-process-string (substring ange-ftp-process-string
1492 (match-end 0)))
1493 (while (string-match "^ftp> *" line)
1494 (setq line (substring line (match-end 0))))
1495 (ange-ftp-process-handle-line line proc)))
1496
1497 ;; has the ftp client finished? if so then do some clean-up
1498 ;; actions.
1499 (if (not ange-ftp-process-busy)
1500 (progn
1501 ;; reset the xfer size
1502 (setq ange-ftp-xfer-size 0)
1503
1504 ;; issue the "done" message since we've finished.
1505 (if (and ange-ftp-process-msg
1506 ange-ftp-process-verbose
1507 ange-ftp-process-result)
1508 (progn
1509 (ange-ftp-message "%s...done" ange-ftp-process-msg)
1510 (ange-ftp-repaint-minibuffer)
1511 (setq ange-ftp-process-msg nil)))
1512
1513 ;; is there a continuation we should be calling? if so,
1514 ;; we'd better call it, making sure we only call it once.
1515 (if ange-ftp-process-continue
1516 (let ((cont ange-ftp-process-continue))
1517 (setq ange-ftp-process-continue nil)
1518 (ange-ftp-call-cont cont
1519 ange-ftp-process-result
1520 ange-ftp-process-result-line))))))
1521 (set-buffer old-buffer)))))
1522
1523 (defun ange-ftp-process-sentinel (proc str)
1524 "When ftp process changes state, nuke all file-entries in cache."
1525 (let ((name (process-name proc)))
1526 (if (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name)
1527 (let ((user (substring name (match-beginning 1) (match-end 1)))
1528 (host (substring name (match-beginning 2) (match-end 2))))
1529 (ange-ftp-wipe-file-entries host user))))
1530 (setq ange-ftp-ls-cache-file nil))
1531 \f
1532 ;;;; ------------------------------------------------------------
1533 ;;;; Gateway support.
1534 ;;;; ------------------------------------------------------------
1535
1536 (defun ange-ftp-use-gateway-p (host)
1537 "Returns whether to access this host via a normal (non-smart) gateway."
1538 ;; yes, I know that I could simplify the following expression, but it is
1539 ;; clearer (to me at least) this way.
1540 (and (not ange-ftp-smart-gateway)
1541 (save-match-data
1542 (not (string-match ange-ftp-local-host-regexp host)))))
1543
1544 (defun ange-ftp-use-smart-gateway-p (host)
1545 "Returns whether to access this host via a smart gateway."
1546 (and ange-ftp-smart-gateway
1547 (save-match-data
1548 (not (string-match ange-ftp-local-host-regexp host)))))
1549
1550 \f
1551 ;;; ------------------------------------------------------------
1552 ;;; Temporary file location and deletion...
1553 ;;; ------------------------------------------------------------
1554
1555 (defvar ange-ftp-tmp-name-files ())
1556 (defvar ange-ftp-tmp-name-hashtable (ange-ftp-make-hashtable 10))
1557 (defvar ange-ftp-pid nil)
1558
1559 (defun ange-ftp-get-pid ()
1560 "Half-hearted attempt to get the current process's id."
1561 (setq ange-ftp-pid (substring (make-temp-name "") 1)))
1562
1563 (defun ange-ftp-make-tmp-name (host)
1564 "This routine will return the name of a new file."
1565 (let* ((template (if (ange-ftp-use-gateway-p host)
1566 ange-ftp-gateway-tmp-name-template
1567 ange-ftp-tmp-name-template))
1568 (pid (or ange-ftp-pid (ange-ftp-get-pid)))
1569 (start ?a)
1570 file entry)
1571 (while
1572 (progn
1573 (setq file (format "%s%c%s" template start pid))
1574 (setq entry (intern file ange-ftp-tmp-name-hashtable))
1575 (or (memq entry ange-ftp-tmp-name-files)
1576 (ange-ftp-real-file-exists-p file)))
1577 (if (> (setq start (1+ start)) ?z)
1578 (progn
1579 (setq template (concat template "X"))
1580 (setq start ?a))))
1581 (setq ange-ftp-tmp-name-files
1582 (cons entry ange-ftp-tmp-name-files))
1583 file))
1584
1585 (defun ange-ftp-del-tmp-name (temp)
1586 (setq ange-ftp-tmp-name-files
1587 (delq (intern temp ange-ftp-tmp-name-hashtable)
1588 ange-ftp-tmp-name-files))
1589 (condition-case ()
1590 (ange-ftp-real-delete-file temp)
1591 (error nil)))
1592 \f
1593 ;;;; ------------------------------------------------------------
1594 ;;;; Interactive gateway program support.
1595 ;;;; ------------------------------------------------------------
1596
1597 (defvar ange-ftp-gwp-running t)
1598 (defvar ange-ftp-gwp-status nil)
1599
1600 (defun ange-ftp-gwp-sentinel (proc str)
1601 (setq ange-ftp-gwp-running nil))
1602
1603 (defun ange-ftp-gwp-filter (proc str)
1604 (comint-output-filter proc str)
1605 (save-excursion
1606 (set-buffer (process-buffer proc))
1607 ;; Replace STR by the result of the comint processing.
1608 (setq str (buffer-substring comint-last-output-start (process-mark proc))))
1609 (cond ((string-match "login: *$" str)
1610 (send-string proc
1611 (concat
1612 (let ((ange-ftp-default-user t))
1613 (ange-ftp-get-user ange-ftp-gateway-host))
1614 "\n")))
1615 ((string-match "Password: *$" str)
1616 (send-string proc
1617 (concat
1618 (ange-ftp-get-passwd ange-ftp-gateway-host
1619 (ange-ftp-get-user
1620 ange-ftp-gateway-host))
1621 "\n")))
1622 ((string-match ange-ftp-gateway-fatal-msgs str)
1623 (delete-process proc)
1624 (setq ange-ftp-gwp-running nil))
1625 ((string-match ange-ftp-gateway-prompt-pattern str)
1626 (setq ange-ftp-gwp-running nil
1627 ange-ftp-gwp-status t))))
1628
1629 (defun ange-ftp-gwp-start (host user name args)
1630 "Login to the gateway machine and fire up an ftp process."
1631 (let* ((gw-user (ange-ftp-get-user ange-ftp-gateway-host))
1632 ;; It would be nice to make process-connection-type nil,
1633 ;; but that doesn't work: ftp never responds.
1634 ;; Can anyone find a fix for that?
1635 (proc (let ((process-connection-type t))
1636 (start-process name name
1637 ange-ftp-gateway-program
1638 ange-ftp-gateway-host)))
1639 (ftp (mapconcat (function identity) args " ")))
1640 (process-kill-without-query proc)
1641 (set-process-sentinel proc (function ange-ftp-gwp-sentinel))
1642 (set-process-filter proc (function ange-ftp-gwp-filter))
1643 (save-excursion
1644 (set-buffer (process-buffer proc))
1645 (internal-ange-ftp-mode)
1646 (set-marker (process-mark proc) (point)))
1647 (setq ange-ftp-gwp-running t
1648 ange-ftp-gwp-status nil)
1649 (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host)
1650 (while ange-ftp-gwp-running ;perform login sequence
1651 (accept-process-output proc))
1652 (if (not ange-ftp-gwp-status)
1653 (ange-ftp-error host user "unable to login to gateway"))
1654 (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host)
1655 (setq ange-ftp-gwp-running t
1656 ange-ftp-gwp-status nil)
1657 (process-send-string proc ange-ftp-gateway-setup-term-command)
1658 (while ange-ftp-gwp-running ;zap ^M's and double echoing.
1659 (accept-process-output proc))
1660 (if (not ange-ftp-gwp-status)
1661 (ange-ftp-error host user "unable to set terminal modes on gateway"))
1662 (setq ange-ftp-gwp-running t
1663 ange-ftp-gwp-status nil)
1664 (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process
1665 proc))
1666 \f
1667 ;;;; ------------------------------------------------------------
1668 ;;;; Support for sending commands to the ftp process.
1669 ;;;; ------------------------------------------------------------
1670
1671 (defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait)
1672 "Low-level routine to send the given ftp CMD to the ftp PROCESS.
1673 MSG is an optional message to output before and after the command.
1674 If CONT is non-NIL then it is either a function or a list of function and
1675 some arguments. The function will be called when the ftp command has completed.
1676 If CONT is NIL then this routine will return \( RESULT . LINE \) where RESULT
1677 is whether the command was successful, and LINE is the line from the FTP
1678 process that caused the command to complete.
1679 If NOWAIT is given then the routine will return immediately the command has
1680 been queued with no result. CONT will still be called, however."
1681 (if (memq (process-status proc) '(run open))
1682 (save-excursion
1683 (set-buffer (process-buffer proc))
1684 (while ange-ftp-process-busy
1685 ;; This is a kludge to let user quit in case ftp gets hung.
1686 ;; It matters because this function can be called from the filter.
1687 ;; It is bad to allow quitting in a filter, but getting hung
1688 ;; is worse. By binding quit-flag to nil, we might avoid
1689 ;; most of the probability of getting screwed because the user
1690 ;; wants to quit some command.
1691 (let ((quit-flag nil)
1692 (inhibit-quit nil))
1693 (accept-process-output)))
1694 (setq ange-ftp-process-string ""
1695 ange-ftp-process-result-line ""
1696 ange-ftp-process-busy t
1697 ange-ftp-process-result nil
1698 ange-ftp-process-multi-skip nil
1699 ange-ftp-process-msg msg
1700 ange-ftp-process-continue cont
1701 ange-ftp-hash-mark-count 0
1702 ange-ftp-last-percent -1
1703 cmd (concat cmd "\n"))
1704 (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg))
1705 (goto-char (point-max))
1706 (move-marker comint-last-input-start (point))
1707 ;; don't insert the password into the buffer on the USER command.
1708 (save-match-data
1709 (if (string-match "^user \"[^\"]*\"" cmd)
1710 (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n")
1711 (insert cmd)))
1712 (move-marker comint-last-input-end (point))
1713 (send-string proc cmd)
1714 (set-marker (process-mark proc) (point))
1715 (if nowait
1716 nil
1717 ;; hang around for command to complete
1718 (while ange-ftp-process-busy
1719 ;; This is a kludge to let user quit in case ftp gets hung.
1720 ;; It matters because this function can be called from the filter.
1721 (let ((quit-flag nil)
1722 (inhibit-quit nil))
1723 (accept-process-output proc)))
1724 (if cont
1725 nil ;cont has already been called
1726 (cons ange-ftp-process-result ange-ftp-process-result-line))))))
1727
1728 (defun ange-ftp-nslookup-host (host)
1729 "Attempt to resolve the given HOSTNAME using nslookup if possible."
1730 (interactive "sHost: ")
1731 (if ange-ftp-nslookup-program
1732 (let ((default-directory
1733 (if (file-accessible-directory-p default-directory)
1734 default-directory
1735 exec-directory))
1736 ;; It would be nice to make process-connection-type nil,
1737 ;; but that doesn't work: ftp never responds.
1738 ;; Can anyone find a fix for that?
1739 (proc (let ((process-connection-type t))
1740 (start-process " *nslookup*" " *nslookup*"
1741 ange-ftp-nslookup-program host)))
1742 (res host))
1743 (process-kill-without-query proc)
1744 (save-excursion
1745 (set-buffer (process-buffer proc))
1746 (while (memq (process-status proc) '(run open))
1747 (accept-process-output proc))
1748 (goto-char (point-min))
1749 (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t)
1750 (setq res (buffer-substring (match-beginning 1)
1751 (match-end 1))))
1752 (kill-buffer (current-buffer)))
1753 res)
1754 host))
1755
1756 (defun ange-ftp-start-process (host user name)
1757 "Spawn a new ftp process ready to connect to machine HOST and give it NAME.
1758 If HOST is only ftp-able through a gateway machine then spawn a shell
1759 on the gateway machine to do the ftp instead."
1760 (let* ((use-gateway (ange-ftp-use-gateway-p host))
1761 (use-smart-ftp (and (not ange-ftp-gateway-host)
1762 (ange-ftp-use-smart-gateway-p host)))
1763 (ftp-prog (if (or use-gateway
1764 use-smart-ftp)
1765 ange-ftp-gateway-ftp-program-name
1766 ange-ftp-ftp-program-name))
1767 (args (append (list ftp-prog) ange-ftp-ftp-program-args))
1768 ;; Without the following binding, ange-ftp-start-process
1769 ;; recurses on file-accessible-directory-p, since it needs to
1770 ;; restart its process in order to determine anything about
1771 ;; default-directory.
1772 (file-name-handler-alist)
1773 (default-directory
1774 (if (file-accessible-directory-p default-directory)
1775 default-directory
1776 exec-directory))
1777 proc)
1778 ;; It would be nice to make process-connection-type nil,
1779 ;; but that doesn't work: ftp never responds.
1780 ;; Can anyone find a fix for that?
1781 (let ((process-connection-type t)
1782 (process-environment process-environment))
1783 ;; This tells GNU ftp not to output any fancy escape sequences.
1784 (setenv "TERM" "dumb")
1785 (if use-gateway
1786 (if ange-ftp-gateway-program-interactive
1787 (setq proc (ange-ftp-gwp-start host user name args))
1788 (setq proc (apply 'start-process name name
1789 (append (list ange-ftp-gateway-program
1790 ange-ftp-gateway-host)
1791 args))))
1792 (setq proc (apply 'start-process name name args))))
1793 (process-kill-without-query proc)
1794 (save-excursion
1795 (set-buffer (process-buffer proc))
1796 (internal-ange-ftp-mode))
1797 (set-process-sentinel proc (function ange-ftp-process-sentinel))
1798 (set-process-filter proc (function ange-ftp-process-filter))
1799 (accept-process-output proc) ;wait for ftp startup message
1800 proc))
1801
1802 (defun internal-ange-ftp-mode ()
1803 "Major mode for interacting with the FTP process.
1804
1805 \\{comint-mode-map}"
1806 (interactive)
1807 (comint-mode)
1808 (setq major-mode 'internal-ange-ftp-mode)
1809 (setq mode-name "Internal Ange-ftp")
1810 (let ((proc (get-buffer-process (current-buffer))))
1811 (goto-char (point-max))
1812 (set-marker (process-mark proc) (point))
1813 (make-local-variable 'ange-ftp-process-string)
1814 (setq ange-ftp-process-string "")
1815 (make-local-variable 'ange-ftp-process-busy)
1816 (make-local-variable 'ange-ftp-process-result)
1817 (make-local-variable 'ange-ftp-process-msg)
1818 (make-local-variable 'ange-ftp-process-multi-skip)
1819 (make-local-variable 'ange-ftp-process-result-line)
1820 (make-local-variable 'ange-ftp-process-continue)
1821 (make-local-variable 'ange-ftp-hash-mark-count)
1822 (make-local-variable 'ange-ftp-binary-hash-mark-size)
1823 (make-local-variable 'ange-ftp-ascii-hash-mark-size)
1824 (make-local-variable 'ange-ftp-hash-mark-unit)
1825 (make-local-variable 'ange-ftp-xfer-size)
1826 (make-local-variable 'ange-ftp-last-percent)
1827 (setq ange-ftp-hash-mark-count 0)
1828 (setq ange-ftp-xfer-size 0)
1829 (setq ange-ftp-process-result-line "")
1830
1831 (setq comint-prompt-regexp "^ftp> ")
1832 (make-local-variable 'comint-password-prompt-regexp)
1833 ;; This is a regexp that can't match anything.
1834 ;; ange-ftp has its own ways of handling passwords.
1835 (setq comint-password-prompt-regexp "^a\\'z")
1836 (make-local-variable 'paragraph-start)
1837 (setq paragraph-start comint-prompt-regexp)))
1838
1839 (defun ange-ftp-smart-login (host user pass account proc)
1840 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1841 PROC is the FTP-client's process. This routine uses the smart-gateway
1842 host specified in ``ange-ftp-gateway-host''."
1843 (let ((result (ange-ftp-raw-send-cmd
1844 proc
1845 (format "open %s %s"
1846 (ange-ftp-nslookup-host ange-ftp-gateway-host)
1847 ange-ftp-smart-gateway-port)
1848 (format "Opening FTP connection to %s via %s"
1849 host
1850 ange-ftp-gateway-host))))
1851 (or (car result)
1852 (ange-ftp-error host user
1853 (concat "OPEN request failed: "
1854 (cdr result))))
1855 (setq result (ange-ftp-raw-send-cmd
1856 proc (format "user \"%s\"@%s %s %s"
1857 user
1858 (ange-ftp-nslookup-host host)
1859 pass
1860 account)
1861 (format "Logging in as user %s@%s"
1862 user host)))
1863 (or (car result)
1864 (progn
1865 (ange-ftp-set-passwd host user nil) ; reset password
1866 (ange-ftp-set-account host user nil) ; reset account
1867 (ange-ftp-error host user
1868 (concat "USER request failed: "
1869 (cdr result)))))))
1870
1871 (defun ange-ftp-normal-login (host user pass account proc)
1872 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1873 PROC is the process to the FTP-client."
1874 (let* ((nshost (ange-ftp-nslookup-host host))
1875 (result (ange-ftp-raw-send-cmd
1876 proc
1877 (format "open %s" nshost)
1878 (format "Opening FTP connection to %s" host))))
1879 (or (car result)
1880 (ange-ftp-error host user
1881 (concat "OPEN request failed: "
1882 (cdr result))))
1883 (setq result (ange-ftp-raw-send-cmd
1884 proc
1885 (if (ange-ftp-use-smart-gateway-p host)
1886 (format "user \"%s\"@%s %s %s" user nshost pass account)
1887 (format "user \"%s\" %s %s" user pass account))
1888 (format "Logging in as user %s@%s" user host)))
1889 (or (car result)
1890 (progn
1891 (ange-ftp-set-passwd host user nil) ;reset password.
1892 (ange-ftp-set-account host user nil) ;reset account.
1893 (ange-ftp-error host user
1894 (concat "USER request failed: "
1895 (cdr result)))))))
1896
1897 ;; ange@hplb.hpl.hp.com says this should not be changed.
1898 (defvar ange-ftp-hash-mark-msgs
1899 "[hH]ash mark [^0-9]*\\([0-9]+\\)"
1900 "*Regexp matching the FTP client's output upon doing a HASH command.")
1901
1902 (defun ange-ftp-guess-hash-mark-size (proc)
1903 (if ange-ftp-send-hash
1904 (save-excursion
1905 (set-buffer (process-buffer proc))
1906 (let* ((status (ange-ftp-raw-send-cmd proc "hash"))
1907 (result (car status))
1908 (line (cdr status)))
1909 (save-match-data
1910 (if (string-match ange-ftp-hash-mark-msgs line)
1911 (let ((size (string-to-int
1912 (substring line
1913 (match-beginning 1)
1914 (match-end 1)))))
1915 (setq ange-ftp-ascii-hash-mark-size size
1916 ange-ftp-hash-mark-unit (ash size -4))
1917
1918 ;; if a default value for this is set, use that value.
1919 (or ange-ftp-binary-hash-mark-size
1920 (setq ange-ftp-binary-hash-mark-size size)))))))))
1921
1922 (defun ange-ftp-get-process (host user)
1923 "Return an FTP subprocess connected to HOST and logged in as USER.
1924 Create a new process if needed."
1925 (let* ((name (ange-ftp-ftp-process-buffer host user))
1926 (proc (get-process name)))
1927 (if (and proc (memq (process-status proc) '(run open)))
1928 proc
1929 (let ((pass (ange-ftp-quote-string
1930 (ange-ftp-get-passwd host user)))
1931 (account (ange-ftp-quote-string
1932 (ange-ftp-get-account host user))))
1933 ;; grab a suitable process.
1934 (setq proc (ange-ftp-start-process host user name))
1935
1936 ;; login to FTP server.
1937 (if (and (ange-ftp-use-smart-gateway-p host)
1938 ange-ftp-gateway-host)
1939 (ange-ftp-smart-login host user pass account proc)
1940 (ange-ftp-normal-login host user pass account proc))
1941
1942 ;; Tell client to send back hash-marks as progress. It isn't usually
1943 ;; fatal if this command fails.
1944 (ange-ftp-guess-hash-mark-size proc)
1945
1946 ;; Guess at the host type.
1947 (ange-ftp-guess-host-type host user)
1948
1949 ;; Run any user-specified hooks. Note that proc, host and user are
1950 ;; dynamically bound at this point.
1951 (run-hooks 'ange-ftp-process-startup-hook))
1952 proc)))
1953
1954 ;; Variables for caching host and host-type
1955 (defvar ange-ftp-host-cache nil)
1956 (defvar ange-ftp-host-type-cache nil)
1957
1958 ;; If ange-ftp-host-type is called with the optional user
1959 ;; argument, it will attempt to guess the host type by connecting
1960 ;; as user, if necessary. For efficiency, I have tried to give this
1961 ;; optional second argument only when necessary. Have I missed any calls
1962 ;; to ange-ftp-host-type where it should have been supplied?
1963
1964 (defun ange-ftp-host-type (host &optional user)
1965 "Return a symbol which represents the type of the HOST given.
1966 If the optional argument USER is given, attempts to guess the
1967 host-type by logging in as USER."
1968 (if (eq host ange-ftp-host-cache)
1969 ange-ftp-host-type-cache
1970 ;; Trigger an ftp connection, in case we need to guess at the host type.
1971 (if (and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache))
1972 ange-ftp-host-type-cache
1973 (setq ange-ftp-host-cache host
1974 ange-ftp-host-type-cache
1975 (cond ((ange-ftp-dumb-unix-host host)
1976 'dumb-unix)
1977 ;; ((and (fboundp 'ange-ftp-vos-host)
1978 ;; (ange-ftp-vos-host host))
1979 ;; 'vos)
1980 ((and (fboundp 'ange-ftp-vms-host)
1981 (ange-ftp-vms-host host))
1982 'vms)
1983 ((and (fboundp 'ange-ftp-mts-host)
1984 (ange-ftp-mts-host host))
1985 'mts)
1986 ((and (fboundp 'ange-ftp-cms-host)
1987 (ange-ftp-cms-host host))
1988 'cms)
1989 (t
1990 'unix))))))
1991
1992 ;; It would be nice to abstract the functions ange-ftp-TYPE-host and
1993 ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions
1994 ;; without sacrificing speed. Also, having separate variables
1995 ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to
1996 ;; set an alist to indicate that a host is of a given type. Even with
1997 ;; automatic host type recognition, setting a regexp is still a good idea
1998 ;; (for efficiency) if you log into a particular non-UNIX host frequently.
1999
2000 (defvar ange-ftp-fix-name-func-alist nil
2001 "Alist saying how to convert file name to the host's syntax.
2002 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2003 which can change a UNIX file name into a name more suitable for a host of type
2004 TYPE.")
2005
2006 (defvar ange-ftp-fix-dir-name-func-alist nil
2007 "Alist saying how to convert directory name to the host's syntax.
2008 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2009 which can change UNIX directory name into a directory name more suitable
2010 for a host of type TYPE.")
2011
2012 ;; *** Perhaps the sense of this variable should be inverted, since there
2013 ;; *** is only 1 host type that can take ls-style listing options.
2014 (defvar ange-ftp-dumb-host-types '(dumb-unix)
2015 "List of host types that can't take UNIX ls-style listing options.")
2016
2017 (defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait)
2018 "Find an ftp process connected to HOST logged in as USER and send it CMD.
2019 MSG is an optional status message to be output before and after issuing the
2020 command.
2021 See the documentation for ange-ftp-raw-send-cmd for a description of CONT
2022 and NOWAIT."
2023 ;; Handle conversion to remote file name syntax and remote ls option
2024 ;; capability.
2025 (let ((cmd0 (car cmd))
2026 (cmd1 (nth 1 cmd))
2027 (ange-ftp-this-user user)
2028 (ange-ftp-this-host host)
2029 (ange-ftp-this-msg msg)
2030 cmd2 cmd3 host-type fix-name-func)
2031
2032 (cond
2033
2034 ;; pwd case (We don't care what host-type.)
2035 ((null cmd1))
2036
2037 ;; cmd == 'dir "remote-name" "local-name" "ls-switches"
2038 ((progn
2039 (setq cmd2 (nth 2 cmd)
2040 host-type (ange-ftp-host-type host user))
2041 ;; This will trigger an FTP login, if one doesn't exist
2042 (eq cmd0 'dir))
2043 (setq cmd1 (funcall
2044 (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist))
2045 'identity)
2046 cmd1)
2047 cmd3 (nth 3 cmd))
2048 ;; Need to deal with the HP-UX ftp bug. This should also allow
2049 ;; us to resolve symlinks to directories on SysV machines. (Sebastian will
2050 ;; be happy.)
2051 (and (eq host-type 'unix)
2052 (string-match "/$" cmd1)
2053 (not (string-match "R" cmd3))
2054 (setq cmd1 (concat cmd1 ".")))
2055 ;; If the remote ls can take switches, put them in
2056 (or (memq host-type ange-ftp-dumb-host-types)
2057 (setq cmd0 'ls
2058 cmd1 (format "\"%s %s\"" cmd3 cmd1))))
2059
2060 ;; First argument is the remote name
2061 ((progn
2062 (setq fix-name-func (or (cdr (assq host-type
2063 ange-ftp-fix-name-func-alist))
2064 'identity))
2065 (memq cmd0 '(get delete mkdir rmdir cd)))
2066 (setq cmd1 (funcall fix-name-func cmd1)))
2067
2068 ;; Second argument is the remote name
2069 ((memq cmd0 '(append put chmod))
2070 (setq cmd2 (funcall fix-name-func cmd2)))
2071
2072 ;; Both arguments are remote names
2073 ((eq cmd0 'rename)
2074 (setq cmd1 (funcall fix-name-func cmd1)
2075 cmd2 (funcall fix-name-func cmd2))))
2076
2077 ;; Turn the command into one long string
2078 (setq cmd0 (symbol-name cmd0))
2079 (setq cmd (concat cmd0
2080 (and cmd1 (concat " " cmd1))
2081 (and cmd2 (concat " " cmd2))))
2082
2083 ;; Actually send the resulting command.
2084 (let (afsc-result
2085 afsc-line)
2086 (ange-ftp-raw-send-cmd
2087 (ange-ftp-get-process host user)
2088 cmd
2089 msg
2090 (list
2091 (function (lambda (result line host user
2092 cmd msg cont nowait)
2093 (or cont
2094 (setq afsc-result result
2095 afsc-line line))
2096 (if result
2097 (ange-ftp-call-cont cont result line)
2098 (ange-ftp-raw-send-cmd
2099 (ange-ftp-get-process host user)
2100 cmd
2101 msg
2102 (list
2103 (function (lambda (result line cont)
2104 (or cont
2105 (setq afsc-result result
2106 afsc-line line))
2107 (ange-ftp-call-cont cont result line)))
2108 cont)
2109 nowait))))
2110 host user cmd msg cont nowait)
2111 nowait)
2112
2113 (if nowait
2114 nil
2115 (if cont
2116 nil
2117 (cons afsc-result afsc-line))))))
2118
2119 ;; It might be nice to message users about the host type identified,
2120 ;; but there is so much other messaging going on, it would not be
2121 ;; seen. No point in slowing things down just so users can read
2122 ;; a host type message.
2123
2124 (defconst ange-ftp-cms-name-template
2125 (concat
2126 "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?"
2127 "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$"))
2128 (defconst ange-ftp-vms-name-template
2129 "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$")
2130 (defconst ange-ftp-mts-name-template
2131 "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$")
2132
2133 (defun ange-ftp-guess-host-type (host user)
2134 "Guess at the the host type of HOST.
2135 Works by doing a pwd and examining the directory syntax."
2136 (let ((host-type (ange-ftp-host-type host))
2137 (key (concat host "/" user "/~")))
2138 (if (eq host-type 'unix)
2139 ;; Note that ange-ftp-host-type returns unix as the default value.
2140 (save-match-data
2141 (let* ((result (ange-ftp-get-pwd host user))
2142 (dir (car result))
2143 fix-name-func)
2144 (cond ((null dir)
2145 (message "Warning! Unable to get home directory")
2146 (sit-for 1)
2147 (if (string-match
2148 "^450 No current working directory defined$"
2149 (cdr result))
2150
2151 ;; We'll assume that if pwd bombs with this
2152 ;; error message, then it's CMS.
2153 (progn
2154 (ange-ftp-add-cms-host host)
2155 (setq ange-ftp-host-cache host
2156 ange-ftp-host-type-cache 'cms))))
2157
2158 ;; try for VMS
2159 ((string-match ange-ftp-vms-name-template dir)
2160 (ange-ftp-add-vms-host host)
2161 ;; The add-host functions clear the host type cache.
2162 ;; Therefore, need to set the cache afterwards.
2163 (setq ange-ftp-host-cache host
2164 ange-ftp-host-type-cache 'vms))
2165
2166 ;; try for MTS
2167 ((string-match ange-ftp-mts-name-template dir)
2168 (ange-ftp-add-mts-host host)
2169 (setq ange-ftp-host-cache host
2170 ange-ftp-host-type-cache 'mts))
2171
2172 ;; try for CMS
2173 ((string-match ange-ftp-cms-name-template dir)
2174 (ange-ftp-add-cms-host host)
2175 (setq ange-ftp-host-cache host
2176 ange-ftp-host-type-cache 'cms))
2177
2178 ;; assume UN*X
2179 (t
2180 (setq ange-ftp-host-cache host
2181 ange-ftp-host-type-cache 'unix)))
2182
2183 ;; Now that we have done a pwd, might as well put it in
2184 ;; the expand-dir hashtable.
2185 (let ((ange-ftp-this-user user)
2186 (ange-ftp-this-host host))
2187 (setq fix-name-func (cdr (assq ange-ftp-host-type-cache
2188 ange-ftp-fix-name-func-alist)))
2189 (if fix-name-func
2190 (setq dir (funcall fix-name-func dir 'reverse))))
2191 (ange-ftp-put-hash-entry key dir
2192 ange-ftp-expand-dir-hashtable))))
2193
2194 ;; In the special case of CMS make sure that know the
2195 ;; expansion of the home minidisk now, because we will
2196 ;; be doing a lot of cd's.
2197 (if (and (eq host-type 'cms)
2198 (not (ange-ftp-hash-entry-exists-p
2199 key ange-ftp-expand-dir-hashtable)))
2200 (let ((dir (car (ange-ftp-get-pwd host user))))
2201 (if dir
2202 (ange-ftp-put-hash-entry key (concat "/" dir)
2203 ange-ftp-expand-dir-hashtable)
2204 (message "Warning! Unable to get home directory")
2205 (sit-for 1))))))
2206
2207 \f
2208 ;;;; ------------------------------------------------------------
2209 ;;;; Remote file and directory listing support.
2210 ;;;; ------------------------------------------------------------
2211
2212 ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands
2213 ;; to take switch arguments.
2214 (defun ange-ftp-dumb-unix-host (host)
2215 (and host ange-ftp-dumb-unix-host-regexp
2216 (save-match-data
2217 (string-match ange-ftp-dumb-unix-host-regexp host))))
2218
2219 (defun ange-ftp-add-dumb-unix-host (host)
2220 "Interactively adds a given HOST to ange-ftp-dumb-unix-host-regexp."
2221 (interactive
2222 (list (read-string "Host: "
2223 (let ((name (or (buffer-file-name) default-directory)))
2224 (and name (car (ange-ftp-ftp-name name)))))))
2225 (if (not (ange-ftp-dumb-unix-host host))
2226 (setq ange-ftp-dumb-unix-host-regexp
2227 (concat "^" (regexp-quote host) "$"
2228 (and ange-ftp-dumb-unix-host-regexp "\\|")
2229 ange-ftp-dumb-unix-host-regexp)
2230 ange-ftp-host-cache nil)))
2231
2232 (defvar ange-ftp-parse-list-func-alist nil
2233 "Alist saying how to parse directory listings for certain OS types.
2234 Association list of \( TYPE \. FUNC \) pairs. The FUNC is a routine
2235 which can parse the output from a DIR listing for a host of type TYPE.")
2236
2237 ;; With no-error nil, this function returns:
2238 ;; an error if file is not an ange-ftp-name
2239 ;; (This should never happen.)
2240 ;; an error if either the listing is unreadable or there is an ftp error.
2241 ;; the listing (a string), if everything works.
2242 ;;
2243 ;; With no-error t, it returns:
2244 ;; an error if not an ange-ftp-name
2245 ;; error if listing is unreable (most likely caused by a slow connection)
2246 ;; nil if ftp error (this is because although asking to list a nonexistent
2247 ;; directory on a remote unix machine usually (except
2248 ;; maybe for dumb hosts) returns an ls error, but no
2249 ;; ftp error, if the same is done on a VMS machine,
2250 ;; an ftp error is returned. Need to trap the error
2251 ;; so we can go on and try to list the parent.)
2252 ;; the listing, if everything works.
2253
2254 ;; If WILDCARD is non-nil, then this implements the guts of insert-directory
2255 ;; in the wildcard case. Then we make a relative directory listing
2256 ;; of FILE within the directory specified by `default-directory'.
2257
2258 (defun ange-ftp-ls (file lsargs parse &optional no-error wildcard)
2259 "Return the output of an `DIR' or `ls' command done over ftp.
2260 FILE is the full name of the remote file, LSARGS is any args to pass to the
2261 `ls' command, and PARSE specifies that the output should be parsed and stored
2262 away in the internal cache."
2263 ;; If parse is t, we assume that file is a directory. i.e. we only parse
2264 ;; full directory listings.
2265 (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file))
2266 (parsed (ange-ftp-ftp-name ange-ftp-this-file)))
2267 (if parsed
2268 (let* ((host (nth 0 parsed))
2269 (user (nth 1 parsed))
2270 (name (ange-ftp-quote-string (nth 2 parsed)))
2271 (key (directory-file-name ange-ftp-this-file))
2272 (host-type (ange-ftp-host-type host user))
2273 (dumb (memq host-type ange-ftp-dumb-host-types))
2274 result
2275 temp
2276 lscmd parse-func)
2277 (if (string-equal name "")
2278 (setq name
2279 (ange-ftp-real-file-name-as-directory
2280 (ange-ftp-expand-dir host user "~"))))
2281 (if (and ange-ftp-ls-cache-file
2282 (string-equal key ange-ftp-ls-cache-file)
2283 ;; Don't care about lsargs for dumb hosts.
2284 (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs)))
2285 ange-ftp-ls-cache-res
2286 (setq temp (ange-ftp-make-tmp-name host))
2287 (if wildcard
2288 (progn
2289 (ange-ftp-cd host user (file-name-directory name))
2290 (setq lscmd (list 'dir file temp lsargs)))
2291 (setq lscmd (list 'dir name temp lsargs)))
2292 (unwind-protect
2293 (if (car (setq result (ange-ftp-send-cmd
2294 host
2295 user
2296 lscmd
2297 (format "Listing %s"
2298 (ange-ftp-abbreviate-filename
2299 ange-ftp-this-file)))))
2300 (save-excursion
2301 (set-buffer (get-buffer-create
2302 ange-ftp-data-buffer-name))
2303 (erase-buffer)
2304 (if (ange-ftp-real-file-readable-p temp)
2305 (ange-ftp-real-insert-file-contents temp)
2306 (sleep-for ange-ftp-retry-time)
2307 ;wait for file to possibly appear
2308 (if (ange-ftp-real-file-readable-p temp)
2309 ;; Try again.
2310 (ange-ftp-real-insert-file-contents temp)
2311 (ange-ftp-error host user
2312 (format
2313 "list data file %s not readable"
2314 temp))))
2315 (if parse
2316 (ange-ftp-set-files
2317 ange-ftp-this-file
2318 (if (setq
2319 parse-func
2320 (cdr (assq host-type
2321 ange-ftp-parse-list-func-alist)))
2322 (funcall parse-func)
2323 (ange-ftp-parse-dired-listing lsargs))))
2324 (setq ange-ftp-ls-cache-file key
2325 ange-ftp-ls-cache-lsargs lsargs
2326 ; For dumb hosts-types this is
2327 ; meaningless but harmless.
2328 ange-ftp-ls-cache-res (buffer-string))
2329 ;; (kill-buffer (current-buffer))
2330 ange-ftp-ls-cache-res)
2331 (if no-error
2332 nil
2333 (ange-ftp-error host user
2334 (concat "DIR failed: " (cdr result)))))
2335 (ange-ftp-del-tmp-name temp))))
2336 (error "Should never happen. Please report. Bug ref. no.: 1"))))
2337 \f
2338 ;;;; ------------------------------------------------------------
2339 ;;;; Directory information caching support.
2340 ;;;; ------------------------------------------------------------
2341
2342 (defconst ange-ftp-date-regexp
2343 (concat
2344 " \\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct"
2345 "\\|Nov\\|Dec\\) +[0-3]?[0-9] "))
2346
2347 (defvar ange-ftp-add-file-entry-alist nil
2348 "Alist saying how to add file entries on certain OS types.
2349 Association list of pairs \( TYPE \. FUNC \), where FUNC
2350 is a function to be used to add a file entry for the OS TYPE. The
2351 main reason for this alist is to deal with file versions in VMS.")
2352
2353 (defvar ange-ftp-delete-file-entry-alist nil
2354 "Alist saying how to delete files on certain OS types.
2355 Association list of pairs \( TYPE \. FUNC \), where FUNC
2356 is a function to be used to delete a file entry for the OS TYPE.
2357 The main reason for this alist is to deal with file versions in VMS.")
2358
2359 (defun ange-ftp-add-file-entry (name &optional dir-p)
2360 "Add a file entry for file NAME, if its directory info exists."
2361 (funcall (or (cdr (assq (ange-ftp-host-type
2362 (car (ange-ftp-ftp-name name)))
2363 ange-ftp-add-file-entry-alist))
2364 'ange-ftp-internal-add-file-entry)
2365 name dir-p)
2366 (setq ange-ftp-ls-cache-file nil))
2367
2368 (defun ange-ftp-delete-file-entry (name &optional dir-p)
2369 "Delete the file entry for file NAME, if its directory info exists."
2370 (funcall (or (cdr (assq (ange-ftp-host-type
2371 (car (ange-ftp-ftp-name name)))
2372 ange-ftp-delete-file-entry-alist))
2373 'ange-ftp-internal-delete-file-entry)
2374 name dir-p)
2375 (setq ange-ftp-ls-cache-file nil))
2376
2377 (defmacro ange-ftp-parse-filename ()
2378 ;;Extract the filename from the current line of a dired-like listing.
2379 (` (let ((eol (progn (end-of-line) (point))))
2380 (beginning-of-line)
2381 (if (re-search-forward ange-ftp-date-regexp eol t)
2382 (progn
2383 (skip-chars-forward " ")
2384 (skip-chars-forward "^ " eol)
2385 (skip-chars-forward " " eol)
2386 ;; We bomb on filenames starting with a space.
2387 (buffer-substring (point) eol))))))
2388
2389 ;; This deals with the F switch. Should also do something about
2390 ;; unquoting names obtained with the SysV b switch and the GNU Q
2391 ;; switch. See Sebastian's dired-get-filename.
2392
2393 (defmacro ange-ftp-ls-parser ()
2394 ;; Note that switches is dynamically bound.
2395 ;; Meant to be called by ange-ftp-parse-dired-listing
2396 (` (let ((tbl (ange-ftp-make-hashtable))
2397 (used-F (and (stringp switches)
2398 (string-match "F" switches)))
2399 file-type symlink directory file)
2400 (while (setq file (ange-ftp-parse-filename))
2401 (beginning-of-line)
2402 (skip-chars-forward "\t 0-9")
2403 (setq file-type (following-char)
2404 directory (eq file-type ?d))
2405 (if (eq file-type ?l)
2406 (if (string-match " -> " file)
2407 (setq symlink (substring file (match-end 0))
2408 file (substring file 0 (match-beginning 0)))
2409 ;; Shouldn't happen
2410 (setq symlink ""))
2411 (setq symlink nil))
2412 ;; Only do a costly regexp search if the F switch was used.
2413 (if (and used-F
2414 (not (string-equal file ""))
2415 (looking-at
2416 ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"))
2417 (let ((socket (eq file-type ?s))
2418 (executable
2419 (and (not symlink) ; x bits don't mean a thing for symlinks
2420 (string-match "[xst]"
2421 (concat
2422 (buffer-substring
2423 (match-beginning 1)
2424 (match-end 1))
2425 (buffer-substring
2426 (match-beginning 2)
2427 (match-end 2))
2428 (buffer-substring
2429 (match-beginning 3)
2430 (match-end 3)))))))
2431 ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX)
2432 ;; and others don't. (sigh...) Beware, that some Unix's don't
2433 ;; seem to believe in the F-switch
2434 (if (or (and symlink (string-match "@$" file))
2435 (and directory (string-match "/$" file))
2436 (and executable (string-match "*$" file))
2437 (and socket (string-match "=$" file)))
2438 (setq file (substring file 0 -1)))))
2439 (ange-ftp-put-hash-entry file (or symlink directory) tbl)
2440 (forward-line 1))
2441 (ange-ftp-put-hash-entry "." t tbl)
2442 (ange-ftp-put-hash-entry ".." t tbl)
2443 tbl)))
2444
2445 ;;; The dl stuff for descriptive listings
2446
2447 (defvar ange-ftp-dl-dir-regexp nil
2448 "Regexp matching directories which are listed in dl format.
2449 This regexp should not be anchored with a trailing `$', because it should
2450 match subdirectories as well.")
2451
2452 (defun ange-ftp-add-dl-dir (dir)
2453 "Interactively adds a DIR to ange-ftp-dl-dir-regexp."
2454 (interactive
2455 (list (read-string "Directory: "
2456 (let ((name (or (buffer-file-name) default-directory)))
2457 (and name (ange-ftp-ftp-name name)
2458 (file-name-directory name))))))
2459 (if (not (and ange-ftp-dl-dir-regexp
2460 (string-match ange-ftp-dl-dir-regexp dir)))
2461 (setq ange-ftp-dl-dir-regexp
2462 (concat "^" (regexp-quote dir)
2463 (and ange-ftp-dl-dir-regexp "\\|")
2464 ange-ftp-dl-dir-regexp))))
2465
2466 (defmacro ange-ftp-dl-parser ()
2467 ;; Parse the current buffer, which is assumed to be a descriptive
2468 ;; listing, and return a hashtable.
2469 (` (let ((tbl (ange-ftp-make-hashtable)))
2470 (while (not (eobp))
2471 (ange-ftp-put-hash-entry
2472 (buffer-substring (point)
2473 (progn
2474 (skip-chars-forward "^ /\n")
2475 (point)))
2476 (eq (following-char) ?/)
2477 tbl)
2478 (forward-line 1))
2479 (ange-ftp-put-hash-entry "." t tbl)
2480 (ange-ftp-put-hash-entry ".." t tbl)
2481 tbl)))
2482
2483 ;; Parse the current buffer which is assumed to be in a dired-like listing
2484 ;; format, and return a hashtable as the result. If the listing is not really
2485 ;; a listing, then return nil.
2486
2487 (defun ange-ftp-parse-dired-listing (&optional switches)
2488 (save-match-data
2489 (cond
2490 ((looking-at "^total [0-9]+$")
2491 (forward-line 1)
2492 ;; Some systems put in a blank line here.
2493 (if (eolp) (forward-line 1))
2494 (ange-ftp-ls-parser))
2495 ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'")
2496 ;; It's an ls error message.
2497 nil)
2498 ((eobp) ; i.e. (zerop (buffer-size))
2499 ;; This could be one of:
2500 ;; (1) An Ultrix ls error message
2501 ;; (2) A listing with the A switch of an empty directory
2502 ;; on a machine which doesn't give a total line.
2503 ;; (3) The twilight zone.
2504 ;; We'll assume (1) for now.
2505 nil)
2506 ((re-search-forward ange-ftp-date-regexp nil t)
2507 (beginning-of-line)
2508 (ange-ftp-ls-parser))
2509 ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t)
2510 ;; It's a dl listing (I hope).
2511 ;; file is bound by the call to ange-ftp-ls
2512 (ange-ftp-add-dl-dir ange-ftp-this-file)
2513 (beginning-of-line)
2514 (ange-ftp-dl-parser))
2515 (t nil))))
2516
2517 (defun ange-ftp-set-files (directory files)
2518 "For a given DIRECTORY, set or change the associated FILES hashtable."
2519 (and files (ange-ftp-put-hash-entry (file-name-as-directory directory)
2520 files ange-ftp-files-hashtable)))
2521
2522 (defun ange-ftp-get-files (directory &optional no-error)
2523 "Given a given DIRECTORY, return a hashtable of file entries.
2524 This will give an error or return nil, depending on the value of
2525 NO-ERROR, if a listing for DIRECTORY cannot be obtained."
2526 (setq directory (file-name-as-directory directory)) ;normalize
2527 (or (ange-ftp-get-hash-entry directory ange-ftp-files-hashtable)
2528 (save-match-data
2529 (and (ange-ftp-ls directory
2530 ;; This is an efficiency hack. We try to
2531 ;; anticipate what sort of listing dired
2532 ;; might want, and cache just such a listing.
2533 (if (and (boundp 'dired-actual-switches)
2534 (stringp dired-actual-switches)
2535 ;; We allow the A switch, which lists
2536 ;; all files except "." and "..".
2537 ;; This is OK because we manually
2538 ;; insert these entries
2539 ;; in the hash table.
2540 (string-match
2541 "[aA]" dired-actual-switches)
2542 (string-match
2543 "l" dired-actual-switches)
2544 (not (string-match
2545 "R" dired-actual-switches)))
2546 dired-actual-switches
2547 (if (and (boundp 'dired-listing-switches)
2548 (stringp dired-listing-switches)
2549 (string-match
2550 "[aA]" dired-listing-switches)
2551 (string-match
2552 "l" dired-listing-switches)
2553 (not (string-match
2554 "R" dired-listing-switches)))
2555 dired-listing-switches
2556 "-al"))
2557 t no-error)
2558 (ange-ftp-get-hash-entry
2559 directory ange-ftp-files-hashtable)))))
2560
2561 ;; Given NAME, return the file part that can be used for looking up the
2562 ;; file's entry in a hashtable.
2563 (defmacro ange-ftp-get-file-part (name)
2564 (` (let ((file (file-name-nondirectory (, name))))
2565 (if (string-equal file "")
2566 "."
2567 file))))
2568
2569 ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are
2570 ;; allowed to determine if NAME is a sub-directory by listing it directly,
2571 ;; rather than listing its parent directory. This is used for efficiency so
2572 ;; that a wasted listing is not done:
2573 ;; 1. When looking for a .dired file in dired-x.el.
2574 ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid
2575 ;; subdirectory. This is of course an OS dependent judgement.
2576
2577 (defmacro ange-ftp-allow-child-lookup (dir file)
2578 (` (not
2579 (let* ((efile (, file)) ; expand once.
2580 (edir (, dir))
2581 (parsed (ange-ftp-ftp-name edir))
2582 (host-type (ange-ftp-host-type
2583 (car parsed))))
2584 (or
2585 ;;; This variable seems not to exist in Emacs 19 -- rms.
2586 ;;; ;; Deal with dired
2587 ;;; (and (boundp 'dired-local-variables-file)
2588 ;;; (stringp dired-local-variables-file)
2589 ;;; (string-equal dired-local-variables-file efile))
2590 ;; No dots in dir names in vms.
2591 (and (eq host-type 'vms)
2592 (string-match "\\." efile))
2593 ;; No subdirs in mts of cms.
2594 (and (memq host-type '(mts cms))
2595 (not (string-equal "/" (nth 2 parsed)))))))))
2596
2597 (defun ange-ftp-file-entry-p (name)
2598 "Given NAME, return whether there is a file entry for it."
2599 (let* ((name (directory-file-name name))
2600 (dir (file-name-directory name))
2601 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
2602 (file (ange-ftp-get-file-part name)))
2603 (if ent
2604 (ange-ftp-hash-entry-exists-p file ent)
2605 (or (and (ange-ftp-allow-child-lookup dir file)
2606 (setq ent (ange-ftp-get-files name t))
2607 ;; Try a child lookup. i.e. try to list file as a
2608 ;; subdirectory of dir. This is a good idea because
2609 ;; we may not have read permission for file's parent. Also,
2610 ;; people tend to work down directory trees anyway. We use
2611 ;; no-error ;; because if file does not exist as a subdir.,
2612 ;; then dumb hosts will give an ftp error. Smart unix hosts
2613 ;; will simply send back the ls
2614 ;; error message.
2615 (ange-ftp-get-hash-entry "." ent))
2616 ;; Child lookup failed. Try the parent. If this bombs,
2617 ;; we are at wits end -- signal an error.
2618 ;; Problem: If this signals an error, the error message
2619 ;; may not have a lot to do with what went wrong.
2620 (ange-ftp-hash-entry-exists-p file
2621 (ange-ftp-get-files dir))))))
2622
2623 (defun ange-ftp-get-file-entry (name)
2624 "Given NAME, return the given file entry.
2625 The entry will be either t for a directory, nil for a normal file,
2626 or a string for a symlink. If the file isn't in the hashtable,
2627 this also returns nil."
2628 (let* ((name (directory-file-name name))
2629 (dir (file-name-directory name))
2630 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
2631 (file (ange-ftp-get-file-part name)))
2632 (if ent
2633 (ange-ftp-get-hash-entry file ent)
2634 (or (and (ange-ftp-allow-child-lookup dir file)
2635 (setq ent (ange-ftp-get-files name t))
2636 (ange-ftp-get-hash-entry "." ent))
2637 ;; i.e. it's a directory by child lookup
2638 (ange-ftp-get-hash-entry file
2639 (ange-ftp-get-files dir))))))
2640
2641 (defun ange-ftp-internal-delete-file-entry (name &optional dir-p)
2642 (if dir-p
2643 (progn
2644 (setq name (file-name-as-directory name))
2645 (ange-ftp-del-hash-entry name ange-ftp-files-hashtable)
2646 (setq name (directory-file-name name))))
2647 ;; Note that file-name-as-directory followed by directory-file-name
2648 ;; serves to canonicalize directory file names to their unix form.
2649 ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO
2650 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2651 ange-ftp-files-hashtable)))
2652 (if files
2653 (ange-ftp-del-hash-entry (ange-ftp-get-file-part name)
2654 files))))
2655
2656 (defun ange-ftp-internal-add-file-entry (name &optional dir-p)
2657 (and dir-p
2658 (setq name (directory-file-name name)))
2659 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2660 ange-ftp-files-hashtable)))
2661 (if files
2662 (ange-ftp-put-hash-entry (ange-ftp-get-file-part name)
2663 dir-p
2664 files))))
2665
2666 (defun ange-ftp-wipe-file-entries (host user)
2667 "Get rid of entry for HOST, USER pair from file entry information hashtable."
2668 (let ((new-tbl (ange-ftp-make-hashtable (length ange-ftp-files-hashtable))))
2669 (ange-ftp-map-hashtable
2670 (function
2671 (lambda (key val)
2672 (let ((parsed (ange-ftp-ftp-name key)))
2673 (if parsed
2674 (let ((h (nth 0 parsed))
2675 (u (nth 1 parsed)))
2676 (or (and (equal host h) (equal user u))
2677 (ange-ftp-put-hash-entry key val new-tbl)))))))
2678 ange-ftp-files-hashtable)
2679 (setq ange-ftp-files-hashtable new-tbl)))
2680 \f
2681 ;;;; ------------------------------------------------------------
2682 ;;;; File transfer mode support.
2683 ;;;; ------------------------------------------------------------
2684
2685 (defun ange-ftp-set-binary-mode (host user)
2686 "Tell the ftp process for the given HOST & USER to switch to binary mode."
2687 (let ((result (ange-ftp-send-cmd host user '(type "binary"))))
2688 (if (not (car result))
2689 (ange-ftp-error host user (concat "BINARY failed: " (cdr result)))
2690 (save-excursion
2691 (set-buffer (process-buffer (ange-ftp-get-process host user)))
2692 (and ange-ftp-binary-hash-mark-size
2693 (setq ange-ftp-hash-mark-unit
2694 (ash ange-ftp-binary-hash-mark-size -4)))))))
2695
2696 (defun ange-ftp-set-ascii-mode (host user)
2697 "Tell the ftp process for the given HOST & USER to switch to ascii mode."
2698 (let ((result (ange-ftp-send-cmd host user '(type "ascii"))))
2699 (if (not (car result))
2700 (ange-ftp-error host user (concat "ASCII failed: " (cdr result)))
2701 (save-excursion
2702 (set-buffer (process-buffer (ange-ftp-get-process host user)))
2703 (and ange-ftp-ascii-hash-mark-size
2704 (setq ange-ftp-hash-mark-unit
2705 (ash ange-ftp-ascii-hash-mark-size -4)))))))
2706 \f
2707 (defun ange-ftp-cd (host user dir)
2708 (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD")))
2709 (or (car result)
2710 (ange-ftp-error host user (concat "CD failed: " (cdr result))))))
2711
2712 (defun ange-ftp-get-pwd (host user)
2713 "Attempts to get the current working directory for the given HOST/USER pair.
2714 Returns \( DIR . LINE \) where DIR is either the directory or NIL if not found,
2715 and LINE is the relevant success or fail line from the FTP-client."
2716 (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD"))
2717 (line (cdr result))
2718 dir)
2719 (if (car result)
2720 (save-match-data
2721 (and (or (string-match "\"\\([^\"]*\\)\"" line)
2722 (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers!
2723 (setq dir (substring line
2724 (match-beginning 1)
2725 (match-end 1))))))
2726 (cons dir line)))
2727 \f
2728 ;;; ------------------------------------------------------------
2729 ;;; expand-file-name and friends...which currently don't work
2730 ;;; ------------------------------------------------------------
2731
2732 (defun ange-ftp-expand-dir (host user dir)
2733 "Return the result of doing a PWD in the current FTP session.
2734 Use the connection to machine HOST
2735 logged in as user USER and cd'd to directory DIR."
2736 (let* ((host-type (ange-ftp-host-type host user))
2737 ;; It is more efficient to call ange-ftp-host-type
2738 ;; before binding res, because ange-ftp-host-type sometimes
2739 ;; adds to the info in the expand-dir-hashtable.
2740 (fix-name-func
2741 (cdr (assq host-type ange-ftp-fix-name-func-alist)))
2742 (key (concat host "/" user "/" dir))
2743 (res (ange-ftp-get-hash-entry key ange-ftp-expand-dir-hashtable)))
2744 (or res
2745 (progn
2746 (or
2747 (string-equal user "anonymous")
2748 (string-equal user "ftp")
2749 (not (eq host-type 'unix))
2750 (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp
2751 "\\|"
2752 ange-ftp-good-msgs))
2753 (result (ange-ftp-send-cmd host user
2754 (list 'get dir "/dev/null")
2755 (format "expanding %s" dir)))
2756 (line (cdr result)))
2757 (setq res
2758 (if (string-match ange-ftp-expand-dir-regexp line)
2759 (substring line
2760 (match-beginning 1)
2761 (match-end 1))))))
2762 (or res
2763 (if (string-equal dir "~")
2764 (setq res (car (ange-ftp-get-pwd host user)))
2765 (let ((home (ange-ftp-expand-dir host user "~")))
2766 (unwind-protect
2767 (and (ange-ftp-cd host user dir)
2768 (setq res (car (ange-ftp-get-pwd host user))))
2769 (ange-ftp-cd host user home)))))
2770 (if res
2771 (let ((ange-ftp-this-user user)
2772 (ange-ftp-this-host host))
2773 (if fix-name-func
2774 (setq res (funcall fix-name-func res 'reverse)))
2775 (ange-ftp-put-hash-entry
2776 key res ange-ftp-expand-dir-hashtable)))
2777 res))))
2778
2779 (defun ange-ftp-canonize-filename (n)
2780 "Take a string and short-circuit //, /. and /.."
2781 (if (string-match "[^:]+//" n) ;don't upset Apollo users
2782 (setq n (substring n (1- (match-end 0)))))
2783 (let ((parsed (ange-ftp-ftp-name n)))
2784 (if parsed
2785 (let ((host (car parsed))
2786 (user (nth 1 parsed))
2787 (name (nth 2 parsed)))
2788
2789 ;; See if remote name is absolute. If so then just expand it and
2790 ;; replace the name component of the overall name.
2791 (cond ((string-match "^/" name)
2792 name)
2793
2794 ;; Name starts with ~ or ~user. Resolve that part of the name
2795 ;; making it absolute then re-expand it.
2796 ((string-match "^~[^/]*" name)
2797 (let* ((tilda (substring name
2798 (match-beginning 0)
2799 (match-end 0)))
2800 (rest (substring name (match-end 0)))
2801 (dir (ange-ftp-expand-dir host user tilda)))
2802 (if dir
2803 (setq name (concat dir rest))
2804 (error "User \"%s\" is not known"
2805 (substring tilda 1)))))
2806
2807 ;; relative name. Tack on homedir and re-expand.
2808 (t
2809 (let ((dir (ange-ftp-expand-dir host user "~")))
2810 (if dir
2811 (setq name (concat
2812 (ange-ftp-real-file-name-as-directory dir)
2813 name))
2814 (error "Unable to obtain CWD")))))
2815
2816 ;; If name starts with //, preserve that, for apollo system.
2817 (if (not (string-match "^//" name))
2818 (progn
2819 (setq name (ange-ftp-real-expand-file-name name))
2820
2821 (if (string-match "^//" name)
2822 (setq name (substring name 1)))))
2823
2824 ;; Now substitute the expanded name back into the overall filename.
2825 (ange-ftp-replace-name-component n name))
2826
2827 ;; non-ange-ftp name. Just expand normally.
2828 (if (eq (string-to-char n) ?/)
2829 (ange-ftp-real-expand-file-name n)
2830 (ange-ftp-real-expand-file-name
2831 (ange-ftp-real-file-name-nondirectory n)
2832 (ange-ftp-real-file-name-directory n))))))
2833
2834 (defun ange-ftp-expand-file-name (name &optional default)
2835 "Documented as original."
2836 (save-match-data
2837 (if (eq (string-to-char name) ?/)
2838 (while (cond ((string-match "[^:]+//" name) ;don't upset Apollo users
2839 (setq name (substring name (1- (match-end 0)))))
2840 ((string-match "/~" name)
2841 (setq name (substring name (1- (match-end 0))))))))
2842 (cond ((eq (string-to-char name) ?~)
2843 (ange-ftp-real-expand-file-name name))
2844 ((eq (string-to-char name) ?/)
2845 (ange-ftp-canonize-filename name))
2846 ((zerop (length name))
2847 (ange-ftp-canonize-filename (or default default-directory)))
2848 ((ange-ftp-canonize-filename
2849 (concat (file-name-as-directory (or default default-directory))
2850 name))))))
2851 \f
2852 ;;; These are problems--they are currently not enabled.
2853
2854 (defvar ange-ftp-file-name-as-directory-alist nil
2855 "Association list of \( TYPE \. FUNC \) pairs.
2856 FUNC converts a filename to a directory name for the operating
2857 system TYPE.")
2858
2859 (defun ange-ftp-file-name-as-directory (name)
2860 "Documented as original."
2861 (let ((parsed (ange-ftp-ftp-name name)))
2862 (if parsed
2863 (if (string-equal (nth 2 parsed) "")
2864 name
2865 (funcall (or (cdr (assq
2866 (ange-ftp-host-type (car parsed))
2867 ange-ftp-file-name-as-directory-alist))
2868 'ange-ftp-real-file-name-as-directory)
2869 name))
2870 (ange-ftp-real-file-name-as-directory name))))
2871
2872 (defun ange-ftp-file-name-directory (name)
2873 "Documented as original."
2874 (let ((parsed (ange-ftp-ftp-name name)))
2875 (if parsed
2876 (let ((filename (nth 2 parsed)))
2877 (if (save-match-data
2878 (string-match "^~[^/]*$" filename))
2879 name
2880 (ange-ftp-replace-name-component
2881 name
2882 (ange-ftp-real-file-name-directory filename))))
2883 (ange-ftp-real-file-name-directory name))))
2884
2885 (defun ange-ftp-file-name-nondirectory (name)
2886 "Documented as original."
2887 (let ((parsed (ange-ftp-ftp-name name)))
2888 (if parsed
2889 (let ((filename (nth 2 parsed)))
2890 (if (save-match-data
2891 (string-match "^~[^/]*$" filename))
2892 ""
2893 (ange-ftp-real-file-name-nondirectory name)))
2894 (ange-ftp-real-file-name-nondirectory name))))
2895
2896 (defun ange-ftp-directory-file-name (dir)
2897 "Documented as original."
2898 (let ((parsed (ange-ftp-ftp-name dir)))
2899 (if parsed
2900 (ange-ftp-replace-name-component
2901 dir
2902 (ange-ftp-real-directory-file-name (nth 2 parsed)))
2903 (ange-ftp-real-directory-file-name dir))))
2904
2905 \f
2906 ;;; Hooks that handle Emacs primitives.
2907
2908 ;; Returns non-nil if should transfer FILE in binary mode.
2909 (defun ange-ftp-binary-file (file)
2910 (save-match-data
2911 (string-match ange-ftp-binary-file-name-regexp file)))
2912
2913 (defun ange-ftp-write-region (start end filename &optional append visit)
2914 (setq filename (expand-file-name filename))
2915 (let ((parsed (ange-ftp-ftp-name filename)))
2916 (if parsed
2917 (let* ((host (nth 0 parsed))
2918 (user (nth 1 parsed))
2919 (name (ange-ftp-quote-string (nth 2 parsed)))
2920 (temp (ange-ftp-make-tmp-name host))
2921 (binary (or (ange-ftp-binary-file filename)
2922 (eq (ange-ftp-host-type host user) 'unix)))
2923 (cmd (if append 'append 'put))
2924 (abbr (ange-ftp-abbreviate-filename filename)))
2925 (unwind-protect
2926 (progn
2927 (let ((executing-macro t)
2928 (filename (buffer-file-name))
2929 (mod-p (buffer-modified-p)))
2930 (unwind-protect
2931 (ange-ftp-real-write-region start end temp nil visit)
2932 ;; cleanup forms
2933 (setq buffer-file-name filename)
2934 (set-buffer-modified-p mod-p)))
2935 (if binary
2936 (ange-ftp-set-binary-mode host user))
2937
2938 ;; tell the process filter what size the transfer will be.
2939 (let ((attr (file-attributes temp)))
2940 (if attr
2941 (ange-ftp-set-xfer-size host user (nth 7 attr))))
2942
2943 ;; put or append the file.
2944 (let ((result (ange-ftp-send-cmd host user
2945 (list cmd temp name)
2946 (format "Writing %s" abbr))))
2947 (or (car result)
2948 (signal 'ftp-error
2949 (list
2950 "Opening output file"
2951 (format "FTP Error: \"%s\"" (cdr result))
2952 filename)))))
2953 (ange-ftp-del-tmp-name temp)
2954 (if binary
2955 (ange-ftp-set-ascii-mode host user)))
2956 (if (eq visit t)
2957 (progn
2958 (set-visited-file-modtime '(0 0))
2959 (ange-ftp-set-buffer-mode)
2960 (setq buffer-file-name filename)
2961 (set-buffer-modified-p nil)))
2962 (ange-ftp-message "Wrote %s" abbr)
2963 (ange-ftp-add-file-entry filename))
2964 (ange-ftp-real-write-region start end filename append visit))))
2965
2966 (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace)
2967 (barf-if-buffer-read-only)
2968 (setq filename (expand-file-name filename))
2969 (let ((parsed (ange-ftp-ftp-name filename)))
2970 (if parsed
2971 (progn
2972 (if visit
2973 (setq buffer-file-name filename))
2974 (if (or (file-exists-p filename)
2975 (progn
2976 (setq ange-ftp-ls-cache-file nil)
2977 (ange-ftp-del-hash-entry (file-name-directory filename)
2978 ange-ftp-files-hashtable)
2979 (file-exists-p filename)))
2980 (let* ((host (nth 0 parsed))
2981 (user (nth 1 parsed))
2982 (name (ange-ftp-quote-string (nth 2 parsed)))
2983 (temp (ange-ftp-make-tmp-name host))
2984 (binary (or (ange-ftp-binary-file filename)
2985 (eq (ange-ftp-host-type host user) 'unix)))
2986 (abbr (ange-ftp-abbreviate-filename filename))
2987 size)
2988 (unwind-protect
2989 (progn
2990 (if binary
2991 (ange-ftp-set-binary-mode host user))
2992 (let ((result (ange-ftp-send-cmd host user
2993 (list 'get name temp)
2994 (format "Retrieving %s" abbr))))
2995 (or (car result)
2996 (signal 'ftp-error
2997 (list
2998 "Opening input file"
2999 (format "FTP Error: \"%s\"" (cdr result))
3000 filename))))
3001 (if (or (ange-ftp-real-file-readable-p temp)
3002 (sleep-for ange-ftp-retry-time)
3003 ;; Wait for file to hopefully appear.
3004 (ange-ftp-real-file-readable-p temp))
3005 (setq
3006 size
3007 (nth 1 (ange-ftp-real-insert-file-contents
3008 temp visit beg end replace)))
3009 (signal 'ftp-error
3010 (list
3011 "Opening input file:"
3012 (format
3013 "FTP Error: %s not arrived or readable"
3014 filename)))))
3015 (if binary
3016 (ange-ftp-set-ascii-mode host user))
3017 (ange-ftp-del-tmp-name temp))
3018 (if visit
3019 (progn
3020 (set-visited-file-modtime '(0 0))
3021 (setq buffer-file-name filename)))
3022 (list filename size))
3023 (signal 'file-error
3024 (list
3025 "Opening input file"
3026 filename))))
3027 (ange-ftp-real-insert-file-contents filename visit beg end replace))))
3028
3029 (defun ange-ftp-expand-symlink (file dir)
3030 (if (file-name-absolute-p file)
3031 (ange-ftp-replace-name-component dir file)
3032 (expand-file-name file dir)))
3033
3034 (defun ange-ftp-file-symlink-p (file)
3035 ;; call ange-ftp-expand-file-name rather than the normal
3036 ;; expand-file-name to stop loops when using a package that
3037 ;; redefines both file-symlink-p and expand-file-name.
3038 (setq file (ange-ftp-expand-file-name file))
3039 (if (ange-ftp-ftp-name file)
3040 (let ((file-ent
3041 (ange-ftp-get-hash-entry
3042 (ange-ftp-get-file-part file)
3043 (ange-ftp-get-files (file-name-directory file)))))
3044 (if (stringp file-ent)
3045 (if (file-name-absolute-p file-ent)
3046 (ange-ftp-replace-name-component
3047 (file-name-directory file) file-ent)
3048 file-ent)))
3049 (ange-ftp-real-file-symlink-p file)))
3050
3051 (defun ange-ftp-file-exists-p (name)
3052 (setq name (expand-file-name name))
3053 (if (ange-ftp-ftp-name name)
3054 (if (ange-ftp-file-entry-p name)
3055 (let ((file-ent (ange-ftp-get-file-entry name)))
3056 (if (stringp file-ent)
3057 (file-exists-p
3058 (ange-ftp-expand-symlink file-ent
3059 (file-name-directory
3060 (directory-file-name name))))
3061 t)))
3062 (ange-ftp-real-file-exists-p name)))
3063
3064 (defun ange-ftp-file-directory-p (name)
3065 (setq name (expand-file-name name))
3066 (if (ange-ftp-ftp-name name)
3067 ;; We do a file-name-as-directory on name here because some
3068 ;; machines (VMS) use a .DIR to indicate the filename associated
3069 ;; with a directory. This needs to be canonicalized.
3070 (let ((file-ent (ange-ftp-get-file-entry
3071 (ange-ftp-file-name-as-directory name))))
3072 (if (stringp file-ent)
3073 (file-directory-p
3074 (ange-ftp-expand-symlink file-ent
3075 (file-name-directory
3076 (directory-file-name name))))
3077 file-ent))
3078 (ange-ftp-real-file-directory-p name)))
3079
3080 (defun ange-ftp-directory-files (directory &optional full match
3081 &rest v19-args)
3082 (setq directory (expand-file-name directory))
3083 (if (ange-ftp-ftp-name directory)
3084 (progn
3085 (ange-ftp-barf-if-not-directory directory)
3086 (let ((tail (ange-ftp-hash-table-keys
3087 (ange-ftp-get-files directory)))
3088 files f)
3089 (setq directory (file-name-as-directory directory))
3090 (save-match-data
3091 (while tail
3092 (setq f (car tail)
3093 tail (cdr tail))
3094 (if (or (not match) (string-match match f))
3095 (setq files
3096 (cons (if full (concat directory f) f) files)))))
3097 (nreverse files)))
3098 (apply 'ange-ftp-real-directory-files directory full match v19-args)))
3099
3100 (defun ange-ftp-file-attributes (file)
3101 (setq file (expand-file-name file))
3102 (let ((parsed (ange-ftp-ftp-name file)))
3103 (if parsed
3104 (let ((part (ange-ftp-get-file-part file))
3105 (files (ange-ftp-get-files (file-name-directory file))))
3106 (if (ange-ftp-hash-entry-exists-p part files)
3107 (let ((host (nth 0 parsed))
3108 (user (nth 1 parsed))
3109 (name (nth 2 parsed))
3110 (dirp (ange-ftp-get-hash-entry part files)))
3111 (list (if (and (stringp dirp) (file-name-absolute-p dirp))
3112 (ange-ftp-expand-symlink dirp
3113 (file-name-directory file))
3114 dirp) ;0 file type
3115 -1 ;1 link count
3116 -1 ;2 uid
3117 -1 ;3 gid
3118 '(0 0) ;4 atime
3119 '(0 0) ;5 mtime
3120 '(0 0) ;6 ctime
3121 -1 ;7 size
3122 (concat (if (stringp dirp) "l" (if dirp "d" "-"))
3123 "?????????") ;8 mode
3124 nil ;9 gid weird
3125 ;; Hack to give remote files a unique "inode number".
3126 ;; It's actually the sum of the characters in its name.
3127 (apply '+ (nconc (mapcar 'identity host)
3128 (mapcar 'identity user)
3129 (mapcar 'identity
3130 (directory-file-name name))))
3131 -1 ;11 device number [v19 only]
3132 ))))
3133 (ange-ftp-real-file-attributes file))))
3134
3135 (defun ange-ftp-file-writable-p (file)
3136 (setq file (expand-file-name file))
3137 (if (ange-ftp-ftp-name file)
3138 (or (file-exists-p file) ;guess here for speed
3139 (file-directory-p (file-name-directory file)))
3140 (ange-ftp-real-file-writable-p file)))
3141
3142 (defun ange-ftp-file-readable-p (file)
3143 (setq file (expand-file-name file))
3144 (if (ange-ftp-ftp-name file)
3145 (file-exists-p file)
3146 (ange-ftp-real-file-readable-p file)))
3147
3148 (defun ange-ftp-file-executable-p (file)
3149 (setq file (expand-file-name file))
3150 (if (ange-ftp-ftp-name file)
3151 (file-exists-p file)
3152 (ange-ftp-real-file-executable-p file)))
3153
3154 (defun ange-ftp-delete-file (file)
3155 (interactive "fDelete file: ")
3156 (setq file (expand-file-name file))
3157 (let ((parsed (ange-ftp-ftp-name file)))
3158 (if parsed
3159 (let* ((host (nth 0 parsed))
3160 (user (nth 1 parsed))
3161 (name (ange-ftp-quote-string (nth 2 parsed)))
3162 (abbr (ange-ftp-abbreviate-filename file))
3163 (result (ange-ftp-send-cmd host user
3164 (list 'delete name)
3165 (format "Deleting %s" abbr))))
3166 (or (car result)
3167 (signal 'ftp-error
3168 (list
3169 "Removing old name"
3170 (format "FTP Error: \"%s\"" (cdr result))
3171 file)))
3172 (ange-ftp-delete-file-entry file))
3173 (ange-ftp-real-delete-file file))))
3174
3175 (defun ange-ftp-verify-visited-file-modtime (buf)
3176 (let ((name (buffer-file-name buf)))
3177 (if (and (stringp name) (ange-ftp-ftp-name name))
3178 t
3179 (ange-ftp-real-verify-visited-file-modtime buf))))
3180 \f
3181 ;;;; ------------------------------------------------------------
3182 ;;;; File copying support... totally re-written 6/24/92.
3183 ;;;; ------------------------------------------------------------
3184
3185 (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive)
3186 (if (file-exists-p absname)
3187 (if (not interactive)
3188 (signal 'file-already-exists (list absname))
3189 (if (not (yes-or-no-p (format "File %s already exists; %s anyway? "
3190 absname querystring)))
3191 (signal 'file-already-exists (list absname))))))
3192
3193 ;; async local copy commented out for now since I don't seem to get
3194 ;; the process sentinel called for some processes.
3195 ;;
3196 ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists
3197 ;; keep-date cont)
3198 ;; "Kludge to copy a local file and call a continuation when the copy
3199 ;; finishes."
3200 ;; ;; check to see if we can overwrite
3201 ;; (if (or (not ok-if-already-exists)
3202 ;; (numberp ok-if-already-exists))
3203 ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3204 ;; (numberp ok-if-already-exists)))
3205 ;; (let ((proc (start-process " *copy*"
3206 ;; (generate-new-buffer "*copy*")
3207 ;; "cp"
3208 ;; filename
3209 ;; newname))
3210 ;; res)
3211 ;; (set-process-sentinel proc (function ange-ftp-copy-file-locally-sentinel))
3212 ;; (process-kill-without-query proc)
3213 ;; (save-excursion
3214 ;; (set-buffer (process-buffer proc))
3215 ;; (make-variable-buffer-local 'copy-cont)
3216 ;; (setq copy-cont cont))))
3217 ;;
3218 ;; (defun ange-ftp-copy-file-locally-sentinel (proc status)
3219 ;; (save-excursion
3220 ;; (set-buffer (process-buffer proc))
3221 ;; (let ((cont copy-cont)
3222 ;; (result (buffer-string)))
3223 ;; (unwind-protect
3224 ;; (if (and (string-equal status "finished\n")
3225 ;; (zerop (length result)))
3226 ;; (ange-ftp-call-cont cont t nil)
3227 ;; (ange-ftp-call-cont cont
3228 ;; nil
3229 ;; (if (zerop (length result))
3230 ;; (substring status 0 -1)
3231 ;; (substring result 0 -1))))
3232 ;; (kill-buffer (current-buffer))))))
3233
3234 ;; this is the extended version of ange-ftp-copy-file-internal that works
3235 ;; asynchronously if asked nicely.
3236 (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists
3237 keep-date &optional msg cont nowait)
3238 (setq filename (expand-file-name filename)
3239 newname (expand-file-name newname))
3240
3241 ;; canonicalize newname if a directory.
3242 (if (file-directory-p newname)
3243 (setq newname (expand-file-name (file-name-nondirectory filename) newname)))
3244
3245 (let ((f-parsed (ange-ftp-ftp-name filename))
3246 (t-parsed (ange-ftp-ftp-name newname)))
3247
3248 ;; local file to local file copy?
3249 (if (and (not f-parsed) (not t-parsed))
3250 (progn
3251 (ange-ftp-real-copy-file filename newname ok-if-already-exists
3252 keep-date)
3253 (if cont
3254 (ange-ftp-call-cont cont t "Copied locally")))
3255 ;; one or both files are remote.
3256 (let* ((f-host (and f-parsed (nth 0 f-parsed)))
3257 (f-user (and f-parsed (nth 1 f-parsed)))
3258 (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed))))
3259 (f-abbr (ange-ftp-abbreviate-filename filename))
3260 (t-host (and t-parsed (nth 0 t-parsed)))
3261 (t-user (and t-parsed (nth 1 t-parsed)))
3262 (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed))))
3263 (t-abbr (ange-ftp-abbreviate-filename newname filename))
3264 (binary (or (ange-ftp-binary-file filename)
3265 (ange-ftp-binary-file newname)
3266 (and (eq (ange-ftp-host-type f-host f-user) 'unix)
3267 (eq (ange-ftp-host-type t-host t-user) 'unix))))
3268 temp1
3269 temp2)
3270
3271 ;; check to see if we can overwrite
3272 (if (or (not ok-if-already-exists)
3273 (numberp ok-if-already-exists))
3274 (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3275 (numberp ok-if-already-exists)))
3276
3277 ;; do the copying.
3278 (if f-parsed
3279
3280 ;; filename was remote.
3281 (progn
3282 (if (or (ange-ftp-use-gateway-p f-host)
3283 t-parsed)
3284 ;; have to use intermediate file if we are getting via
3285 ;; gateway machine or we are doing a remote to remote copy.
3286 (setq temp1 (ange-ftp-make-tmp-name f-host)))
3287
3288 (if binary
3289 (ange-ftp-set-binary-mode f-host f-user))
3290
3291 (ange-ftp-send-cmd
3292 f-host
3293 f-user
3294 (list 'get f-name (or temp1 newname))
3295 (or msg
3296 (if (and temp1 t-parsed)
3297 (format "Getting %s" f-abbr)
3298 (format "Copying %s to %s" f-abbr t-abbr)))
3299 (list (function ange-ftp-cf1)
3300 filename newname binary msg
3301 f-parsed f-host f-user f-name f-abbr
3302 t-parsed t-host t-user t-name t-abbr
3303 temp1 temp2 cont nowait)
3304 nowait))
3305
3306 ;; filename wasn't remote. newname must be remote. call the
3307 ;; function which does the remainder of the copying work.
3308 (ange-ftp-cf1 t nil
3309 filename newname binary msg
3310 f-parsed f-host f-user f-name f-abbr
3311 t-parsed t-host t-user t-name t-abbr
3312 nil nil cont nowait))))))
3313
3314 ;; next part of copying routine.
3315 (defun ange-ftp-cf1 (result line
3316 filename newname binary msg
3317 f-parsed f-host f-user f-name f-abbr
3318 t-parsed t-host t-user t-name t-abbr
3319 temp1 temp2 cont nowait)
3320 (if line
3321 ;; filename must have been remote, and we must have just done a GET.
3322 (unwind-protect
3323 (or result
3324 ;; GET failed for some reason. Clean up and get out.
3325 (progn
3326 (and temp1 (ange-ftp-del-tmp-name temp1))
3327 (or cont
3328 (signal 'ftp-error (list "Opening input file"
3329 (format "FTP Error: \"%s\"" line)
3330 filename)))))
3331 ;; cleanup
3332 (if binary
3333 (ange-ftp-set-ascii-mode f-host f-user))))
3334
3335 (if result
3336 ;; We now have to copy either temp1 or filename to newname.
3337 (if t-parsed
3338
3339 ;; newname was remote.
3340 (progn
3341 (if (ange-ftp-use-gateway-p t-host)
3342 (setq temp2 (ange-ftp-make-tmp-name t-host)))
3343
3344 ;; make sure data is moved into the right place for the
3345 ;; outgoing transfer. gateway temporary files complicate
3346 ;; things nicely.
3347 (if temp1
3348 (if temp2
3349 (if (string-equal temp1 temp2)
3350 (setq temp1 nil)
3351 (ange-ftp-real-copy-file temp1 temp2 t))
3352 (setq temp2 temp1 temp1 nil))
3353 (if temp2
3354 (ange-ftp-real-copy-file filename temp2 t)))
3355
3356 (if binary
3357 (ange-ftp-set-binary-mode t-host t-user))
3358
3359 ;; tell the process filter what size the file is.
3360 (let ((attr (file-attributes (or temp2 filename))))
3361 (if attr
3362 (ange-ftp-set-xfer-size t-host t-user (nth 7 attr))))
3363
3364 (ange-ftp-send-cmd
3365 t-host
3366 t-user
3367 (list 'put (or temp2 filename) t-name)
3368 (or msg
3369 (if (and temp2 f-parsed)
3370 (format "Putting %s" newname)
3371 (format "Copying %s to %s" f-abbr t-abbr)))
3372 (list (function ange-ftp-cf2)
3373 newname t-host t-user binary temp1 temp2 cont)
3374 nowait))
3375
3376 ;; newname wasn't remote.
3377 (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont))
3378
3379 ;; first copy failed, tell caller
3380 (ange-ftp-call-cont cont result line)))
3381
3382 ;; last part of copying routine.
3383 (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont)
3384 (unwind-protect
3385 (if line
3386 ;; result from doing a local to remote copy.
3387 (unwind-protect
3388 (progn
3389 (or result
3390 (or cont
3391 (signal 'ftp-error
3392 (list "Opening output file"
3393 (format "FTP Error: \"%s\"" line)
3394 newname))))
3395
3396 (ange-ftp-add-file-entry newname))
3397
3398 ;; cleanup.
3399 (if binary
3400 (ange-ftp-set-ascii-mode t-host t-user)))
3401
3402 ;; newname was local.
3403 (if temp1
3404 (ange-ftp-real-copy-file temp1 newname t)))
3405
3406 ;; clean up
3407 (and temp1 (ange-ftp-del-tmp-name temp1))
3408 (and temp2 (ange-ftp-del-tmp-name temp2))
3409 (ange-ftp-call-cont cont result line)))
3410
3411 (defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists
3412 keep-date)
3413 (interactive "fCopy file: \nFCopy %s to file: \np")
3414 (ange-ftp-copy-file-internal filename
3415 newname
3416 ok-if-already-exists
3417 keep-date
3418 nil
3419 nil
3420 (interactive-p)))
3421 \f
3422 ;;;; ------------------------------------------------------------
3423 ;;;; File renaming support.
3424 ;;;; ------------------------------------------------------------
3425
3426 (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed)
3427 "Rename remote file FILE to remote file NEWNAME."
3428 (let ((f-host (nth 0 f-parsed))
3429 (f-user (nth 1 f-parsed))
3430 (t-host (nth 0 t-parsed))
3431 (t-user (nth 1 t-parsed)))
3432 (if (and (string-equal f-host t-host)
3433 (string-equal f-user t-user))
3434 (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed)))
3435 (t-name (ange-ftp-quote-string (nth 2 t-parsed)))
3436 (cmd (list 'rename f-name t-name))
3437 (fabbr (ange-ftp-abbreviate-filename filename))
3438 (nabbr (ange-ftp-abbreviate-filename newname filename))
3439 (result (ange-ftp-send-cmd f-host f-user cmd
3440 (format "Renaming %s to %s"
3441 fabbr
3442 nabbr))))
3443 (or (car result)
3444 (signal 'ftp-error
3445 (list
3446 "Renaming"
3447 (format "FTP Error: \"%s\"" (cdr result))
3448 filename
3449 newname)))
3450 (ange-ftp-add-file-entry newname)
3451 (ange-ftp-delete-file-entry filename))
3452 (ange-ftp-copy-file-internal filename newname t nil)
3453 (delete-file filename))))
3454
3455 (defun ange-ftp-rename-local-to-remote (filename newname)
3456 "Rename local FILENAME to remote file NEWNAME."
3457 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3458 (nabbr (ange-ftp-abbreviate-filename newname filename))
3459 (msg (format "Renaming %s to %s" fabbr nabbr)))
3460 (ange-ftp-copy-file-internal filename newname t nil msg)
3461 (let (ange-ftp-process-verbose)
3462 (delete-file filename))))
3463
3464 (defun ange-ftp-rename-remote-to-local (filename newname)
3465 "Rename remote file FILENAME to local file NEWNAME."
3466 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3467 (nabbr (ange-ftp-abbreviate-filename newname filename))
3468 (msg (format "Renaming %s to %s" fabbr nabbr)))
3469 (ange-ftp-copy-file-internal filename newname t nil msg)
3470 (let (ange-ftp-process-verbose)
3471 (delete-file filename))))
3472
3473 (defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists)
3474 (interactive "fRename file: \nFRename %s to file: \np")
3475 (setq filename (expand-file-name filename))
3476 (setq newname (expand-file-name newname))
3477 (let* ((f-parsed (ange-ftp-ftp-name filename))
3478 (t-parsed (ange-ftp-ftp-name newname)))
3479 (if (and (or f-parsed t-parsed)
3480 (or (not ok-if-already-exists)
3481 (numberp ok-if-already-exists)))
3482 (ange-ftp-barf-or-query-if-file-exists
3483 newname
3484 "rename to it"
3485 (numberp ok-if-already-exists)))
3486 (if f-parsed
3487 (if t-parsed
3488 (ange-ftp-rename-remote-to-remote filename newname f-parsed
3489 t-parsed)
3490 (ange-ftp-rename-remote-to-local filename newname))
3491 (if t-parsed
3492 (ange-ftp-rename-local-to-remote filename newname)
3493 (ange-ftp-real-rename-file filename newname ok-if-already-exists)))))
3494 \f
3495 ;;;; ------------------------------------------------------------
3496 ;;;; File name completion support.
3497 ;;;; ------------------------------------------------------------
3498
3499 ;; If the file entry SYM is a symlink, returns whether its file exists.
3500 ;; Note that `ange-ftp-this-dir' is used as a free variable.
3501 (defun ange-ftp-file-entry-active-p (sym)
3502 (let ((val (get sym 'val)))
3503 (or (not (stringp val))
3504 (file-exists-p (ange-ftp-expand-symlink val ange-ftp-this-dir)))))
3505
3506 ;; If the file entry is not a directory (nor a symlink pointing to a directory)
3507 ;; returns whether the file (or file pointed to by the symlink) is ignored
3508 ;; by completion-ignored-extensions.
3509 ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern'
3510 ;; are used as free variables.
3511 (defun ange-ftp-file-entry-not-ignored-p (sym)
3512 (let ((val (get sym 'val))
3513 (symname (symbol-name sym)))
3514 (if (stringp val)
3515 (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir)))
3516 (or (file-directory-p file)
3517 (and (file-exists-p file)
3518 (not (string-match ange-ftp-completion-ignored-pattern
3519 symname)))))
3520 (or val ; is a directory name
3521 (not (string-match ange-ftp-completion-ignored-pattern symname))))))
3522
3523 (defun ange-ftp-file-name-all-completions (file dir)
3524 (let ((ange-ftp-this-dir (expand-file-name dir)))
3525 (if (ange-ftp-ftp-name ange-ftp-this-dir)
3526 (progn
3527 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3528 (setq ange-ftp-this-dir
3529 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir))
3530 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3531 (completions
3532 (all-completions file tbl
3533 (function ange-ftp-file-entry-active-p))))
3534
3535 ;; see whether each matching file is a directory or not...
3536 (mapcar
3537 (function
3538 (lambda (file)
3539 (let ((ent (ange-ftp-get-hash-entry file tbl)))
3540 (if (and ent
3541 (or (not (stringp ent))
3542 (file-directory-p
3543 (ange-ftp-expand-symlink ent
3544 ange-ftp-this-dir))))
3545 (concat file "/")
3546 file))))
3547 completions)))
3548
3549 (if (string-equal "/" ange-ftp-this-dir)
3550 (nconc (all-completions file (ange-ftp-generate-root-prefixes))
3551 (ange-ftp-real-file-name-all-completions file
3552 ange-ftp-this-dir))
3553 (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir)))))
3554
3555 (defun ange-ftp-file-name-completion (file dir)
3556 (let ((ange-ftp-this-dir (expand-file-name dir)))
3557 (if (ange-ftp-ftp-name ange-ftp-this-dir)
3558 (progn
3559 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3560 (if (equal file "")
3561 ""
3562 (setq ange-ftp-this-dir
3563 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real?
3564 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3565 (ange-ftp-completion-ignored-pattern
3566 (mapconcat (function
3567 (lambda (s) (if (stringp s)
3568 (concat (regexp-quote s) "$")
3569 "/"))) ; / never in filename
3570 completion-ignored-extensions
3571 "\\|")))
3572 (save-match-data
3573 (or (ange-ftp-file-name-completion-1
3574 file tbl ange-ftp-this-dir
3575 (function ange-ftp-file-entry-not-ignored-p))
3576 (ange-ftp-file-name-completion-1
3577 file tbl ange-ftp-this-dir
3578 (function ange-ftp-file-entry-active-p)))))))
3579
3580 (if (string-equal "/" ange-ftp-this-dir)
3581 (try-completion
3582 file
3583 (nconc (ange-ftp-generate-root-prefixes)
3584 (mapcar 'list
3585 (ange-ftp-real-file-name-all-completions file "/"))))
3586 (ange-ftp-real-file-name-completion file ange-ftp-this-dir)))))
3587
3588
3589 (defun ange-ftp-file-name-completion-1 (file tbl dir predicate)
3590 (let ((bestmatch (try-completion file tbl predicate)))
3591 (if bestmatch
3592 (if (eq bestmatch t)
3593 (if (file-directory-p (expand-file-name file dir))
3594 (concat file "/")
3595 t)
3596 (if (and (eq (try-completion bestmatch tbl predicate) t)
3597 (file-directory-p
3598 (expand-file-name bestmatch dir)))
3599 (concat bestmatch "/")
3600 bestmatch)))))
3601
3602 ;; Put these lines uncommmented in your .emacs if you want C-r to refresh
3603 ;; ange-ftp's cache whilst doing filename completion.
3604 ;;
3605 ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir)
3606 ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir)
3607
3608 ;; Force a re-read of the directory DIR. If DIR is omitted then it defaults
3609 ;; to the directory part of the contents of the current buffer.
3610 (defun ange-ftp-re-read-dir (&optional dir)
3611 (interactive)
3612 (if dir
3613 (setq dir (expand-file-name dir))
3614 (setq dir (file-name-directory (expand-file-name (buffer-string)))))
3615 (if (ange-ftp-ftp-name dir)
3616 (progn
3617 (setq ange-ftp-ls-cache-file nil)
3618 (ange-ftp-del-hash-entry dir ange-ftp-files-hashtable)
3619 (ange-ftp-get-files dir t))))
3620 \f
3621 (defun ange-ftp-make-directory (dir &optional parents)
3622 (interactive (list (expand-file-name (read-file-name "Make directory: "))))
3623 (if parents
3624 (let ((parent (file-name-directory (directory-file-name dir))))
3625 (or (file-exists-p parent)
3626 (ange-ftp-make-directory parent parents))))
3627 (if (file-exists-p dir)
3628 (error "Cannot make directory %s: file already exists" dir)
3629 (let ((parsed (ange-ftp-ftp-name dir)))
3630 (if parsed
3631 (let* ((host (nth 0 parsed))
3632 (user (nth 1 parsed))
3633 ;; Some ftp's on unix machines (at least on Suns)
3634 ;; insist that mkdir take a filename, and not a
3635 ;; directory-name name as an arg. Argh!! This is a bug.
3636 ;; Non-unix machines will probably always insist
3637 ;; that mkdir takes a directory-name as an arg
3638 ;; (as the ftp man page says it should).
3639 (name (ange-ftp-quote-string
3640 (if (eq (ange-ftp-host-type host) 'unix)
3641 (ange-ftp-real-directory-file-name (nth 2 parsed))
3642 (ange-ftp-real-file-name-as-directory
3643 (nth 2 parsed)))))
3644 (abbr (ange-ftp-abbreviate-filename dir))
3645 (result (ange-ftp-send-cmd host user
3646 (list 'mkdir name)
3647 (format "Making directory %s"
3648 abbr))))
3649 (or (car result)
3650 (ange-ftp-error host user
3651 (format "Could not make directory %s: %s"
3652 dir
3653 (cdr result))))
3654 (ange-ftp-add-file-entry dir t))
3655 (ange-ftp-real-make-directory dir)))))
3656
3657 (defun ange-ftp-delete-directory (dir)
3658 (if (file-directory-p dir)
3659 (let ((parsed (ange-ftp-ftp-name dir)))
3660 (if parsed
3661 (let* ((host (nth 0 parsed))
3662 (user (nth 1 parsed))
3663 ;; Some ftp's on unix machines (at least on Suns)
3664 ;; insist that rmdir take a filename, and not a
3665 ;; directory-name name as an arg. Argh!! This is a bug.
3666 ;; Non-unix machines will probably always insist
3667 ;; that rmdir takes a directory-name as an arg
3668 ;; (as the ftp man page says it should).
3669 (name (ange-ftp-quote-string
3670 (if (eq (ange-ftp-host-type host) 'unix)
3671 (ange-ftp-real-directory-file-name
3672 (nth 2 parsed))
3673 (ange-ftp-real-file-name-as-directory
3674 (nth 2 parsed)))))
3675 (abbr (ange-ftp-abbreviate-filename dir))
3676 (result (ange-ftp-send-cmd host user
3677 (list 'rmdir name)
3678 (format "Removing directory %s"
3679 abbr))))
3680 (or (car result)
3681 (ange-ftp-error host user
3682 (format "Could not remove directory %s: %s"
3683 dir
3684 (cdr result))))
3685 (ange-ftp-delete-file-entry dir t))
3686 (ange-ftp-real-delete-directory dir)))
3687 (error "Not a directory: %s" dir)))
3688 \f
3689 ;; Make a local copy of FILE and return its name.
3690
3691 (defun ange-ftp-file-local-copy (file)
3692 (let* ((fn1 (expand-file-name file))
3693 (pa1 (ange-ftp-ftp-name fn1)))
3694 (if pa1
3695 (let ((tmp1 (ange-ftp-make-tmp-name (car pa1))))
3696 (ange-ftp-copy-file-internal fn1 tmp1 t nil
3697 (format "Getting %s" fn1))
3698 tmp1))))
3699
3700 (defun ange-ftp-load (file &optional noerror nomessage nosuffix)
3701 (if (ange-ftp-ftp-name file)
3702 (let ((tryfiles (if nosuffix
3703 (list file)
3704 (list (concat file ".elc") (concat file ".el") file)))
3705 copy)
3706 (while (and tryfiles (not copy))
3707 (condition-case error
3708 (setq copy (ange-ftp-file-local-copy (car tryfiles)))
3709 (ftp-error nil))
3710 (setq tryfiles (cdr tryfiles)))
3711 (if copy
3712 (unwind-protect
3713 (funcall 'load copy noerror nomessage nosuffix)
3714 (delete-file copy))
3715 (or noerror
3716 (signal 'file-error (list "Cannot open load file" file)))))
3717 (ange-ftp-real-load file noerror nomessage nosuffix)))
3718
3719 ;; Calculate default-unhandled-directory for a given ange-ftp buffer.
3720 (defun ange-ftp-unhandled-file-name-directory (filename)
3721 (file-name-directory ange-ftp-tmp-name-template))
3722
3723 \f
3724 ;; Need the following functions for making filenames of compressed
3725 ;; files, because some OS's (unlike UNIX) do not allow a filename to
3726 ;; have two extensions.
3727
3728 (defvar ange-ftp-make-compressed-filename-alist nil
3729 "Alist of host-type-specific functions to process file names for compression.
3730 Each element has the form (TYPE . FUNC).
3731 FUNC should take one argument, a file name, and return a list
3732 of the form (COMPRESSING NEWNAME).
3733 COMPRESSING should be t if the specified file should be compressed,
3734 and nil if it should be uncompressed (that is, if it is a compressed file).
3735 NEWNAME should be the name to give the new compressed or uncompressed file.")
3736
3737 (defun ange-ftp-dired-compress-file (name)
3738 (let ((parsed (ange-ftp-ftp-name name))
3739 conversion-func)
3740 (if (and parsed
3741 (setq conversion-func
3742 (cdr (assq (ange-ftp-host-type (car parsed))
3743 ange-ftp-make-compressed-filename-alist))))
3744 (let* ((decision
3745 (save-match-data (funcall conversion-func name)))
3746 (compressing (car decision))
3747 (newfile (nth 1 decision)))
3748 (if compressing
3749 (ange-ftp-compress name newfile)
3750 (ange-ftp-uncompress name newfile)))
3751 (let (file-name-handler-alist)
3752 (dired-compress-file name)))))
3753
3754 ;; Copy FILE to this machine, compress it, and copy out to NFILE.
3755 (defun ange-ftp-compress (file nfile)
3756 (let* ((parsed (ange-ftp-ftp-name file))
3757 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
3758 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
3759 (abbr (ange-ftp-abbreviate-filename file))
3760 (nabbr (ange-ftp-abbreviate-filename nfile))
3761 (msg1 (format "Getting %s" abbr))
3762 (msg2 (format "Putting %s" nabbr)))
3763 (unwind-protect
3764 (progn
3765 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
3766 (and ange-ftp-process-verbose
3767 (ange-ftp-message "Compressing %s..." abbr))
3768 (call-process-region (point)
3769 (point)
3770 shell-file-name
3771 nil
3772 t
3773 nil
3774 "-c"
3775 (format "compress -f -c < %s > %s" tmp1 tmp2))
3776 (and ange-ftp-process-verbose
3777 (ange-ftp-message "Compressing %s...done" abbr))
3778 (if (zerop (buffer-size))
3779 (progn
3780 (let (ange-ftp-process-verbose)
3781 (delete-file file))
3782 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
3783 (ange-ftp-del-tmp-name tmp1)
3784 (ange-ftp-del-tmp-name tmp2))))
3785
3786 ;; Copy FILE to this machine, uncompress it, and copy out to NFILE.
3787 (defun ange-ftp-uncompress (file nfile)
3788 (let* ((parsed (ange-ftp-ftp-name file))
3789 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
3790 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
3791 (abbr (ange-ftp-abbreviate-filename file))
3792 (nabbr (ange-ftp-abbreviate-filename nfile))
3793 (msg1 (format "Getting %s" abbr))
3794 (msg2 (format "Putting %s" nabbr))
3795 ;; ;; Cheap hack because of problems with binary file transfers from
3796 ;; ;; VMS hosts.
3797 ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed)))))
3798 )
3799 (unwind-protect
3800 (progn
3801 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
3802 (and ange-ftp-process-verbose
3803 (ange-ftp-message "Uncompressing %s..." abbr))
3804 (call-process-region (point)
3805 (point)
3806 shell-file-name
3807 nil
3808 t
3809 nil
3810 "-c"
3811 (format "uncompress -c < %s > %s" tmp1 tmp2))
3812 (and ange-ftp-process-verbose
3813 (ange-ftp-message "Uncompressing %s...done" abbr))
3814 (if (zerop (buffer-size))
3815 (progn
3816 (let (ange-ftp-process-verbose)
3817 (delete-file file))
3818 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
3819 (ange-ftp-del-tmp-name tmp1)
3820 (ange-ftp-del-tmp-name tmp2))))
3821
3822 (defun ange-ftp-find-backup-file-name (fn)
3823 ;; Either return the ordinary backup name, etc.,
3824 ;; or return nil meaning don't make a backup.
3825 (if ange-ftp-make-backup-files
3826 (ange-ftp-real-find-backup-file-name fn)))
3827 \f
3828 ;;; Define the handler for special file names
3829 ;;; that causes ange-ftp to be invoked.
3830
3831 ;;;###autoload
3832 (defun ange-ftp-hook-function (operation &rest args)
3833 (let ((fn (get operation 'ange-ftp)))
3834 (if fn (apply fn args)
3835 (ange-ftp-run-real-handler operation args))))
3836
3837
3838 ;;; This regexp takes care of real ange-ftp file names (with a slash
3839 ;;; and colon).
3840 ;;; Don't allow the host name to end in a period--some systems use /.:
3841 ;;;###autoload
3842 (or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist)
3843 (setq file-name-handler-alist
3844 (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function)
3845 file-name-handler-alist)))
3846
3847 ;;; This regexp recognizes and absolute filenames with only one component,
3848 ;;; for the sake of hostname completion.
3849 ;;;###autoload
3850 (or (assoc "^/[^/:]*\\'" file-name-handler-alist)
3851 (setq file-name-handler-alist
3852 (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function)
3853 file-name-handler-alist)))
3854
3855 ;;; The above two forms are sufficient to cause this file to be loaded
3856 ;;; if the user ever uses a file name with a colon in it.
3857
3858 ;;; This sets the mode
3859 (or (memq 'ange-ftp-set-buffer-mode find-file-hooks)
3860 (setq find-file-hooks
3861 (cons 'ange-ftp-set-buffer-mode find-file-hooks)))
3862
3863 ;;; Now say where to find the handlers for particular operations.
3864
3865 (put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory)
3866 (put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory)
3867 (put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory)
3868 (put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name)
3869 (put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name)
3870 (put 'make-directory 'ange-ftp 'ange-ftp-make-directory)
3871 (put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory)
3872 (put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents)
3873 (put 'directory-files 'ange-ftp 'ange-ftp-directory-files)
3874 (put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p)
3875 (put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p)
3876 (put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p)
3877 (put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p)
3878 (put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p)
3879 (put 'delete-file 'ange-ftp 'ange-ftp-delete-file)
3880 (put 'read-file-name-internal 'ange-ftp 'ange-ftp-read-file-name-internal)
3881 (put 'verify-visited-file-modtime 'ange-ftp
3882 'ange-ftp-verify-visited-file-modtime)
3883 (put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p)
3884 (put 'write-region 'ange-ftp 'ange-ftp-write-region)
3885 (put 'backup-buffer 'ange-ftp 'ange-ftp-backup-buffer)
3886 (put 'copy-file 'ange-ftp 'ange-ftp-copy-file)
3887 (put 'rename-file 'ange-ftp 'ange-ftp-rename-file)
3888 (put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes)
3889 (put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions)
3890 (put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion)
3891 (put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory)
3892 (put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy)
3893 (put 'unhandled-file-name-directory 'ange-ftp
3894 'ange-ftp-unhandled-file-name-directory)
3895 (put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions)
3896 (put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache)
3897 (put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file)
3898 (put 'load 'ange-ftp 'ange-ftp-load)
3899 (put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name)
3900
3901 ;; Turn off truename processing to save time.
3902 ;; Treat each name as its own truename.
3903 (put 'file-truename 'ange-ftp 'identity)
3904
3905 ;; Turn off RCS/SCCS processing to save time.
3906 ;; This returns nil for any file name as argument.
3907 (put 'vc-registered 'ange-ftp 'null)
3908 \f
3909 ;;; Define ways of getting at unmodified Emacs primitives,
3910 ;;; turning off our handler.
3911
3912 (defun ange-ftp-run-real-handler (operation args)
3913 (let ((inhibit-file-name-handlers
3914 (cons 'ange-ftp-hook-function
3915 (cons 'ange-ftp-completion-hook-function
3916 (and (eq inhibit-file-name-operation operation)
3917 inhibit-file-name-handlers))))
3918 (inhibit-file-name-operation operation))
3919 (apply operation args)))
3920
3921 (defun ange-ftp-real-file-name-directory (&rest args)
3922 (ange-ftp-run-real-handler 'file-name-directory args))
3923 (defun ange-ftp-real-file-name-nondirectory (&rest args)
3924 (ange-ftp-run-real-handler 'file-name-nondirectory args))
3925 (defun ange-ftp-real-file-name-as-directory (&rest args)
3926 (ange-ftp-run-real-handler 'file-name-as-directory args))
3927 (defun ange-ftp-real-directory-file-name (&rest args)
3928 (ange-ftp-run-real-handler 'directory-file-name args))
3929 (defun ange-ftp-real-expand-file-name (&rest args)
3930 (ange-ftp-run-real-handler 'expand-file-name args))
3931 (defun ange-ftp-real-make-directory (&rest args)
3932 (ange-ftp-run-real-handler 'make-directory args))
3933 (defun ange-ftp-real-delete-directory (&rest args)
3934 (ange-ftp-run-real-handler 'delete-directory args))
3935 (defun ange-ftp-real-insert-file-contents (&rest args)
3936 (ange-ftp-run-real-handler 'insert-file-contents args))
3937 (defun ange-ftp-real-directory-files (&rest args)
3938 (ange-ftp-run-real-handler 'directory-files args))
3939 (defun ange-ftp-real-file-directory-p (&rest args)
3940 (ange-ftp-run-real-handler 'file-directory-p args))
3941 (defun ange-ftp-real-file-writable-p (&rest args)
3942 (ange-ftp-run-real-handler 'file-writable-p args))
3943 (defun ange-ftp-real-file-readable-p (&rest args)
3944 (ange-ftp-run-real-handler 'file-readable-p args))
3945 (defun ange-ftp-real-file-executable-p (&rest args)
3946 (ange-ftp-run-real-handler 'file-executable-p args))
3947 (defun ange-ftp-real-file-symlink-p (&rest args)
3948 (ange-ftp-run-real-handler 'file-symlink-p args))
3949 (defun ange-ftp-real-delete-file (&rest args)
3950 (ange-ftp-run-real-handler 'delete-file args))
3951 (defun ange-ftp-real-read-file-name-internal (&rest args)
3952 (ange-ftp-run-real-handler 'read-file-name-internal args))
3953 (defun ange-ftp-real-verify-visited-file-modtime (&rest args)
3954 (ange-ftp-run-real-handler 'verify-visited-file-modtime args))
3955 (defun ange-ftp-real-file-exists-p (&rest args)
3956 (ange-ftp-run-real-handler 'file-exists-p args))
3957 (defun ange-ftp-real-write-region (&rest args)
3958 (ange-ftp-run-real-handler 'write-region args))
3959 (defun ange-ftp-real-backup-buffer (&rest args)
3960 (ange-ftp-run-real-handler 'backup-buffer args))
3961 (defun ange-ftp-real-copy-file (&rest args)
3962 (ange-ftp-run-real-handler 'copy-file args))
3963 (defun ange-ftp-real-rename-file (&rest args)
3964 (ange-ftp-run-real-handler 'rename-file args))
3965 (defun ange-ftp-real-file-attributes (&rest args)
3966 (ange-ftp-run-real-handler 'file-attributes args))
3967 (defun ange-ftp-real-file-name-all-completions (&rest args)
3968 (ange-ftp-run-real-handler 'file-name-all-completions args))
3969 (defun ange-ftp-real-file-name-completion (&rest args)
3970 (ange-ftp-run-real-handler 'file-name-completion args))
3971 (defun ange-ftp-real-insert-directory (&rest args)
3972 (ange-ftp-run-real-handler 'insert-directory args))
3973 (defun ange-ftp-real-file-name-sans-versions (&rest args)
3974 (ange-ftp-run-real-handler 'file-name-sans-versions args))
3975 (defun ange-ftp-real-shell-command (&rest args)
3976 (ange-ftp-run-real-handler 'shell-command args))
3977 (defun ange-ftp-real-load (&rest args)
3978 (ange-ftp-run-real-handler 'load args))
3979 (defun ange-ftp-real-find-backup-file-name (&rest args)
3980 (ange-ftp-run-real-handler 'find-backup-file-name args))
3981 \f
3982 ;; Here we support using dired on remote hosts.
3983 ;; I have turned off the support for using dired on foreign directory formats.
3984 ;; That involves too many unclean hooks.
3985 ;; It would be cleaner to support such operations by
3986 ;; converting the foreign directory format to something dired can understand;
3987 ;; something close to ls -l output.
3988 ;; The logical place to do this is in the functions ange-ftp-parse-...-listing.
3989
3990 ;; Some of the old dired hooks would still be needed even if this is done.
3991 ;; I have preserved (and modernized) those hooks.
3992 ;; So the format conversion should be all that is needed.
3993
3994 (defun ange-ftp-insert-directory (file switches &optional wildcard full)
3995 (let ((short (ange-ftp-abbreviate-filename file))
3996 (parsed (ange-ftp-ftp-name (expand-file-name file))))
3997 (if parsed
3998 (insert
3999 (if wildcard
4000 (let ((default-directory (file-name-directory file)))
4001 (ange-ftp-ls (file-name-nondirectory file) switches nil nil t))
4002 (ange-ftp-ls file switches full)))
4003 (ange-ftp-real-insert-directory file switches wildcard full))))
4004
4005 (defun ange-ftp-dired-uncache (dir)
4006 (if (ange-ftp-ftp-name (expand-file-name dir))
4007 (setq ange-ftp-ls-cache-file nil)))
4008
4009 (defvar ange-ftp-sans-version-alist nil
4010 "Alist of mapping host type into function to remove file version numbers.")
4011
4012 (defun ange-ftp-file-name-sans-versions (file keep-backup-version)
4013 (setq file (ange-ftp-abbreviate-filename file))
4014 (let ((parsed (ange-ftp-ftp-name file))
4015 host-type func)
4016 (if parsed
4017 (setq host-type (ange-ftp-host-type (car parsed))
4018 func (cdr (assq (ange-ftp-host-type (car parsed))
4019 ange-ftp-sans-version-alist))))
4020 (if func (funcall func file keep-backup-version)
4021 (ange-ftp-real-file-name-sans-versions file keep-backup-version))))
4022
4023 ;;; This doesn't work yet; a new hook needs to be created.
4024 ;;; Maybe the new hook should be in call-process.
4025 (defun ange-ftp-shell-command (command)
4026 (let* ((parsed (ange-ftp-ftp-name default-directory))
4027 (host (nth 0 parsed))
4028 (user (nth 1 parsed))
4029 (name (nth 2 parsed)))
4030 (if (not parsed)
4031 (ange-ftp-real-shell-command command)
4032 (if (> (length name) 0) ; else it's $HOME
4033 (setq command (concat "cd " name "; " command)))
4034 (setq command
4035 (format "%s %s \"%s\"" ; remsh -l USER does not work well
4036 ; on a hp-ux machine I tried
4037 remote-shell-program host command))
4038 (ange-ftp-message "Remote command '%s' ..." command)
4039 ;; Cannot call ange-ftp-real-dired-run-shell-command here as it
4040 ;; would prepend "cd default-directory" --- which bombs because
4041 ;; default-directory is in ange-ftp syntax for remote file names.
4042 (ange-ftp-real-shell-command command))))
4043
4044 ;;; Thisis not hooked up yet.
4045 (defun ange-ftp-dired-call-process (program discard &rest arguments)
4046 ;; PROGRAM is always one of those below in the cond in dired.el.
4047 ;; The ARGUMENTS are (nearly) always files.
4048 (if (ange-ftp-ftp-name default-directory)
4049 ;; Can't use ange-ftp-dired-host-type here because the current
4050 ;; buffer is *dired-check-process output*
4051 (condition-case oops
4052 (cond ((equal "chmod" program)
4053 (ange-ftp-call-chmod arguments))
4054 ;; ((equal "chgrp" program))
4055 ;; ((equal dired-chown-program program))
4056 (t (error "Unknown remote command: %s" program)))
4057 (ftp-error (insert (format "%s: %s, %s\n"
4058 (nth 1 oops)
4059 (nth 2 oops)
4060 (nth 3 oops))))
4061 (error (insert (format "%s\n" (nth 1 oops)))))
4062 (apply 'call-process program nil (not discard) nil arguments)))
4063
4064 ;;; This currently does not work; it is never called.
4065 (defun ange-ftp-call-chmod (args)
4066 (if (< (length args) 2)
4067 (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args))
4068 (let ((mode (car args)))
4069 (mapcar
4070 (function
4071 (lambda (file)
4072 (setq file (expand-file-name file))
4073 (let ((parsed (ange-ftp-ftp-name file)))
4074 (if parsed
4075 (let* ((host (nth 0 parsed))
4076 (user (nth 1 parsed))
4077 (name (ange-ftp-quote-string (nth 2 parsed)))
4078 (abbr (ange-ftp-abbreviate-filename file))
4079 (result (ange-ftp-send-cmd host user
4080 (list 'chmod mode name)
4081 (format "doing chmod %s"
4082 abbr))))
4083 (or (car result)
4084 (ange-ftp-error host user
4085 (format "chmod: %s: \"%s\""
4086 file
4087 (cdr result)))))))))
4088 (cdr args)))
4089 (setq ange-ftp-ls-cache-file nil)) ;stop confusing dired
4090 \f
4091 ;;; This is turned off because it has nothing properly to do
4092 ;;; with dired. It could be reasonable to adapt this to
4093 ;;; replace ange-ftp-copy-file.
4094
4095 ;;;;; ------------------------------------------------------------
4096 ;;;;; Noddy support for async copy-file within dired.
4097 ;;;;; ------------------------------------------------------------
4098
4099 ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait)
4100 ;; "Documented as original."
4101 ;; (dired-handle-overwrite to)
4102 ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil
4103 ;; cont nowait))
4104
4105 ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg
4106 ;; &optional marker-char op1
4107 ;; how-to)
4108 ;; "Documented as original."
4109 ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly
4110 ;; ;; called it rather than somebody else.
4111 ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is
4112 ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation
4113 ;; arg marker-char op1 how-to)))
4114
4115 ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor
4116 ;; &optional marker-char)
4117 ;; "Documented as original."
4118 ;; (if (and (boundp 'ange-ftp-dired-do-create-files)
4119 ;; ;; called from ange-ftp-dired-do-create-files?
4120 ;; ange-ftp-dired-do-create-files
4121 ;; ;; any files worth copying?
4122 ;; fn-list
4123 ;; ;; we only support async copy-file at the mo.
4124 ;; (eq file-creator 'dired-copy-file)
4125 ;; ;; it is only worth calling the alternative function for remote files
4126 ;; ;; as we tie ourself in recursive knots otherwise.
4127 ;; (or (ange-ftp-ftp-name (car fn-list))
4128 ;; ;; we can only call the name constructor for dired-do-create-files
4129 ;; ;; since the one for regexps starts prompting here, there and
4130 ;; ;; everywhere.
4131 ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list)))))
4132 ;; ;; use the process-filter driven routine rather than the iterative one.
4133 ;; (ange-ftp-dcf-1 file-creator
4134 ;; operation
4135 ;; fn-list
4136 ;; name-constructor
4137 ;; (and (boundp 'target) target) ;dynamically bound
4138 ;; marker-char
4139 ;; (current-buffer)
4140 ;; nil ;overwrite-query
4141 ;; nil ;overwrite-backup-query
4142 ;; nil ;failures
4143 ;; nil ;skipped
4144 ;; 0 ;success-count
4145 ;; (length fn-list) ;total
4146 ;; )
4147 ;; ;; normal case... use the interactive routine... much cheaper.
4148 ;; (ange-ftp-real-dired-create-files file-creator operation fn-list
4149 ;; name-constructor marker-char)))
4150
4151 ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor
4152 ;; target marker-char buffer overwrite-query
4153 ;; overwrite-backup-query failures skipped
4154 ;; success-count total)
4155 ;; (let ((old-buf (current-buffer)))
4156 ;; (unwind-protect
4157 ;; (progn
4158 ;; (set-buffer buffer)
4159 ;; (if (null fn-list)
4160 ;; (ange-ftp-dcf-3 failures operation total skipped
4161 ;; success-count buffer)
4162
4163 ;; (let* ((from (car fn-list))
4164 ;; (to (funcall name-constructor from)))
4165 ;; (if (equal to from)
4166 ;; (progn
4167 ;; (setq to nil)
4168 ;; (dired-log "Cannot %s to same file: %s\n"
4169 ;; (downcase operation) from)))
4170 ;; (if (not to)
4171 ;; (ange-ftp-dcf-1 file-creator
4172 ;; operation
4173 ;; (cdr fn-list)
4174 ;; name-constructor
4175 ;; target
4176 ;; marker-char
4177 ;; buffer
4178 ;; overwrite-query
4179 ;; overwrite-backup-query
4180 ;; failures
4181 ;; (cons (dired-make-relative from) skipped)
4182 ;; success-count
4183 ;; total)
4184 ;; (let* ((overwrite (file-exists-p to))
4185 ;; (overwrite-confirmed ; for dired-handle-overwrite
4186 ;; (and overwrite
4187 ;; (let ((help-form '(format "\
4188 ;;Type SPC or `y' to overwrite file `%s',
4189 ;;DEL or `n' to skip to next,
4190 ;;ESC or `q' to not overwrite any of the remaining files,
4191 ;;`!' to overwrite all remaining files with no more questions." to)))
4192 ;; (dired-query 'overwrite-query
4193 ;; "Overwrite `%s'?" to))))
4194 ;; ;; must determine if FROM is marked before file-creator
4195 ;; ;; gets a chance to delete it (in case of a move).
4196 ;; (actual-marker-char
4197 ;; (cond ((integerp marker-char) marker-char)
4198 ;; (marker-char (dired-file-marker from)) ; slow
4199 ;; (t nil))))
4200 ;; (condition-case err
4201 ;; (funcall file-creator from to overwrite-confirmed
4202 ;; (list (function ange-ftp-dcf-2)
4203 ;; nil ;err
4204 ;; file-creator operation fn-list
4205 ;; name-constructor
4206 ;; target
4207 ;; marker-char actual-marker-char
4208 ;; buffer to from
4209 ;; overwrite
4210 ;; overwrite-confirmed
4211 ;; overwrite-query
4212 ;; overwrite-backup-query
4213 ;; failures skipped success-count
4214 ;; total)
4215 ;; t)
4216 ;; (file-error ; FILE-CREATOR aborted
4217 ;; (ange-ftp-dcf-2 nil ;result
4218 ;; nil ;line
4219 ;; err
4220 ;; file-creator operation fn-list
4221 ;; name-constructor
4222 ;; target
4223 ;; marker-char actual-marker-char
4224 ;; buffer to from
4225 ;; overwrite
4226 ;; overwrite-confirmed
4227 ;; overwrite-query
4228 ;; overwrite-backup-query
4229 ;; failures skipped success-count
4230 ;; total))))))))
4231 ;; (set-buffer old-buf))))
4232
4233 ;;(defun ange-ftp-dcf-2 (result line err
4234 ;; file-creator operation fn-list
4235 ;; name-constructor
4236 ;; target
4237 ;; marker-char actual-marker-char
4238 ;; buffer to from
4239 ;; overwrite
4240 ;; overwrite-confirmed
4241 ;; overwrite-query
4242 ;; overwrite-backup-query
4243 ;; failures skipped success-count
4244 ;; total)
4245 ;; (let ((old-buf (current-buffer)))
4246 ;; (unwind-protect
4247 ;; (progn
4248 ;; (set-buffer buffer)
4249 ;; (if (or err (not result))
4250 ;; (progn
4251 ;; (setq failures (cons (dired-make-relative from) failures))
4252 ;; (dired-log "%s `%s' to `%s' failed:\n%s\n"
4253 ;; operation from to (or err line)))
4254 ;; (if overwrite
4255 ;; ;; If we get here, file-creator hasn't been aborted
4256 ;; ;; and the old entry (if any) has to be deleted
4257 ;; ;; before adding the new entry.
4258 ;; (dired-remove-file to))
4259 ;; (setq success-count (1+ success-count))
4260 ;; (message "%s: %d of %d" operation success-count total)
4261 ;; (dired-add-file to actual-marker-char))
4262
4263 ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list)
4264 ;; name-constructor
4265 ;; target
4266 ;; marker-char
4267 ;; buffer
4268 ;; overwrite-query
4269 ;; overwrite-backup-query
4270 ;; failures skipped success-count
4271 ;; total))
4272 ;; (set-buffer old-buf))))
4273
4274 ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count
4275 ;; buffer)
4276 ;; (let ((old-buf (current-buffer)))
4277 ;; (unwind-protect
4278 ;; (progn
4279 ;; (set-buffer buffer)
4280 ;; (cond
4281 ;; (failures
4282 ;; (dired-log-summary
4283 ;; (message "%s failed for %d of %d file%s %s"
4284 ;; operation (length failures) total
4285 ;; (dired-plural-s total) failures)))
4286 ;; (skipped
4287 ;; (dired-log-summary
4288 ;; (message "%s: %d of %d file%s skipped %s"
4289 ;; operation (length skipped) total
4290 ;; (dired-plural-s total) skipped)))
4291 ;; (t
4292 ;; (message "%s: %s file%s."
4293 ;; operation success-count (dired-plural-s success-count))))
4294 ;; (dired-move-to-filename))
4295 ;; (set-buffer old-buf))))
4296 \f
4297 ;;;; -----------------------------------------------
4298 ;;;; Unix Descriptive Listing (dl) Support
4299 ;;;; -----------------------------------------------
4300
4301 ;; This is turned off because nothing uses it currently
4302 ;; and because I don't understand what it's supposed to be for. --rms.
4303
4304 ;;(defconst ange-ftp-dired-dl-re-dir
4305 ;; "^. [^ /]+/[ \n]"
4306 ;; "Regular expression to use to search for dl directories.")
4307
4308 ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist)
4309 ;; (setq ange-ftp-dired-re-dir-alist
4310 ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir)
4311 ;; ange-ftp-dired-re-dir-alist)))
4312
4313 ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol)
4314 ;; "In dired, move to the first character of the filename on this line."
4315 ;; ;; This is the Unix dl version.
4316 ;; (or eol (setq eol (progn (end-of-line) (point))))
4317 ;; (let (case-fold-search)
4318 ;; (beginning-of-line)
4319 ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ")
4320 ;; (goto-char (+ (point) 2))
4321 ;; (if raise-error
4322 ;; (error "No file on this line")
4323 ;; nil))))
4324
4325 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist)
4326 ;; (setq ange-ftp-dired-move-to-filename-alist
4327 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename)
4328 ;; ange-ftp-dired-move-to-filename-alist)))
4329
4330 ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol)
4331 ;; ;; Assumes point is at beginning of filename.
4332 ;; ;; So, it should be called only after (dired-move-to-filename t).
4333 ;; ;; On failure, signals an error or returns nil.
4334 ;; ;; This is the Unix dl version.
4335 ;; (let ((opoint (point))
4336 ;; case-fold-search hidden)
4337 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4338 ;; (setq hidden (and selective-display
4339 ;; (save-excursion
4340 ;; (search-forward "\r" eol t))))
4341 ;; (if hidden
4342 ;; (if no-error
4343 ;; nil
4344 ;; (error
4345 ;; (substitute-command-keys
4346 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
4347 ;; (skip-chars-forward "^ /" eol)
4348 ;; (if (eq opoint (point))
4349 ;; (if no-error
4350 ;; nil
4351 ;; (error "No file on this line"))
4352 ;; (point)))))
4353
4354 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist)
4355 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4356 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename)
4357 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4358 \f
4359 ;;;; ------------------------------------------------------------
4360 ;;;; VOS support (VOS support is probably broken,
4361 ;;;; but I don't know anything about VOS.)
4362 ;;;; ------------------------------------------------------------
4363 ;
4364 ;(defun ange-ftp-fix-name-for-vos (name &optional reverse)
4365 ; (setq name (copy-sequence name))
4366 ; (let ((from (if reverse ?\> ?\/))
4367 ; (to (if reverse ?\/ ?\>))
4368 ; (i (1- (length name))))
4369 ; (while (>= i 0)
4370 ; (if (= (aref name i) from)
4371 ; (aset name i to))
4372 ; (setq i (1- i)))
4373 ; name))
4374 ;
4375 ;(or (assq 'vos ange-ftp-fix-name-func-alist)
4376 ; (setq ange-ftp-fix-name-func-alist
4377 ; (cons '(vos . ange-ftp-fix-name-for-vos)
4378 ; ange-ftp-fix-name-func-alist)))
4379 ;
4380 ;(or (memq 'vos ange-ftp-dumb-host-types)
4381 ; (setq ange-ftp-dumb-host-types
4382 ; (cons 'vos ange-ftp-dumb-host-types)))
4383 ;
4384 ;(defun ange-ftp-fix-dir-name-for-vos (dir-name)
4385 ; (ange-ftp-fix-name-for-vos
4386 ; (concat dir-name
4387 ; (if (eq ?/ (aref dir-name (1- (length dir-name))))
4388 ; "" "/")
4389 ; "*")))
4390 ;
4391 ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist)
4392 ; (setq ange-ftp-fix-dir-name-func-alist
4393 ; (cons '(vos . ange-ftp-fix-dir-name-for-vos)
4394 ; ange-ftp-fix-dir-name-func-alist)))
4395 ;
4396 ;(defvar ange-ftp-vos-host-regexp nil
4397 ; "If a host matches this regexp then it is assumed to be running VOS.")
4398 ;
4399 ;(defun ange-ftp-vos-host (host)
4400 ; (and ange-ftp-vos-host-regexp
4401 ; (save-match-data
4402 ; (string-match ange-ftp-vos-host-regexp host))))
4403 ;
4404 ;(defun ange-ftp-parse-vos-listing ()
4405 ; "Parse the current buffer which is assumed to be in VOS list -all
4406 ;format, and return a hashtable as the result."
4407 ; (let ((tbl (ange-ftp-make-hashtable))
4408 ; (type-list
4409 ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40)
4410 ; ("^Dirs: [0-9]+\n+" t 30)))
4411 ; type-regexp type-is-dir type-col file)
4412 ; (goto-char (point-min))
4413 ; (save-match-data
4414 ; (while type-list
4415 ; (setq type-regexp (car (car type-list))
4416 ; type-is-dir (nth 1 (car type-list))
4417 ; type-col (nth 2 (car type-list))
4418 ; type-list (cdr type-list))
4419 ; (if (re-search-forward type-regexp nil t)
4420 ; (while (eq (char-after (point)) ? )
4421 ; (move-to-column type-col)
4422 ; (setq file (buffer-substring (point)
4423 ; (progn
4424 ; (end-of-line 1)
4425 ; (point))))
4426 ; (ange-ftp-put-hash-entry file type-is-dir tbl)
4427 ; (forward-line 1))))
4428 ; (ange-ftp-put-hash-entry "." 'vosdir tbl)
4429 ; (ange-ftp-put-hash-entry ".." 'vosdir tbl))
4430 ; tbl))
4431 ;
4432 ;(or (assq 'vos ange-ftp-parse-list-func-alist)
4433 ; (setq ange-ftp-parse-list-func-alist
4434 ; (cons '(vos . ange-ftp-parse-vos-listing)
4435 ; ange-ftp-parse-list-func-alist)))
4436 \f
4437 ;;;; ------------------------------------------------------------
4438 ;;;; VMS support.
4439 ;;;; ------------------------------------------------------------
4440
4441 ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS
4442 ;; to UNIX-ish.
4443 (defun ange-ftp-fix-name-for-vms (name &optional reverse)
4444 (save-match-data
4445 (if reverse
4446 (if (string-match "^\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)$" name)
4447 (let (drive dir file)
4448 (if (match-beginning 1)
4449 (setq drive (substring name
4450 (match-beginning 1)
4451 (match-end 1))))
4452 (if (match-beginning 2)
4453 (setq dir
4454 (substring name (match-beginning 2) (match-end 2))))
4455 (if (match-beginning 3)
4456 (setq file
4457 (substring name (match-beginning 3) (match-end 3))))
4458 (and dir
4459 (setq dir (apply (function concat)
4460 (mapcar (function
4461 (lambda (char)
4462 (if (= char ?.)
4463 (vector ?/)
4464 (vector char))))
4465 (substring dir 1 -1)))))
4466 (concat (and drive
4467 (concat "/" drive "/"))
4468 dir (and dir "/")
4469 file))
4470 (error "name %s didn't match" name))
4471 (let (drive dir file tmp)
4472 (if (string-match "^/[^:]+:/" name)
4473 (setq drive (substring name 1
4474 (1- (match-end 0)))
4475 name (substring name (match-end 0))))
4476 (setq tmp (file-name-directory name))
4477 (if tmp
4478 (setq dir (apply (function concat)
4479 (mapcar (function
4480 (lambda (char)
4481 (if (= char ?/)
4482 (vector ?.)
4483 (vector char))))
4484 (substring tmp 0 -1)))))
4485 (setq file (file-name-nondirectory name))
4486 (concat drive
4487 (and dir (concat "[" (if drive nil ".") dir "]"))
4488 file)))))
4489
4490 ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1")
4491 ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t)
4492
4493 (or (assq 'vms ange-ftp-fix-name-func-alist)
4494 (setq ange-ftp-fix-name-func-alist
4495 (cons '(vms . ange-ftp-fix-name-for-vms)
4496 ange-ftp-fix-name-func-alist)))
4497
4498 (or (memq 'vms ange-ftp-dumb-host-types)
4499 (setq ange-ftp-dumb-host-types
4500 (cons 'vms ange-ftp-dumb-host-types)))
4501
4502 ;; It is important that this function barf for directories for which we know
4503 ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/".
4504 ;; This is because it saves an unnecessary FTP error, or possibly the listing
4505 ;; might succeed, but give erroneous info. This last case is particularly
4506 ;; likely for OS's (like MTS) for which we need to use a wildcard in order
4507 ;; to list a directory.
4508
4509 ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing.
4510 (defun ange-ftp-fix-dir-name-for-vms (dir-name)
4511 ;; Should there be entries for .. -> [-] and . -> [] below. Don't
4512 ;; think so, because expand-filename should have already short-circuited
4513 ;; them.
4514 (cond ((string-equal dir-name "/")
4515 (error "Cannot get listing for fictitious \"/\" directory."))
4516 ((string-match "^/[-A-Z0-9_$]+:/$" dir-name)
4517 (error "Cannot get listing for device."))
4518 ((ange-ftp-fix-name-for-vms dir-name))))
4519
4520 (or (assq 'vms ange-ftp-fix-dir-name-func-alist)
4521 (setq ange-ftp-fix-dir-name-func-alist
4522 (cons '(vms . ange-ftp-fix-dir-name-for-vms)
4523 ange-ftp-fix-dir-name-func-alist)))
4524
4525 (defvar ange-ftp-vms-host-regexp nil)
4526
4527 ;; Return non-nil if HOST is running VMS.
4528 (defun ange-ftp-vms-host (host)
4529 (and ange-ftp-vms-host-regexp
4530 (save-match-data
4531 (string-match ange-ftp-vms-host-regexp host))))
4532
4533 ;; Because some VMS ftp servers convert filenames to lower case
4534 ;; we allow a-z in the filename regexp. I'm not too happy about this.
4535
4536 (defconst ange-ftp-vms-filename-regexp
4537 (concat
4538 "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\."
4539 "[-_A-Za-z0-9$]*;+[0-9]*\\)")
4540 "Regular expression to match for a valid VMS file name in Dired buffer.
4541 Stupid freaking bug! Position of _ and $ shouldn't matter but they do.
4542 Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX
4543 Other orders of $ and _ seem to all work just fine.")
4544
4545 ;; These parsing functions are as general as possible because the syntax
4546 ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that
4547 ;; the VMS filename syntax is so rigid. If they bomb on a listing in the
4548 ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing
4549 ;; from vms.weird.net, then too bad.
4550
4551 ;; Extract the next filename from a VMS dired-like listing.
4552 (defun ange-ftp-parse-vms-filename ()
4553 (if (re-search-forward
4554 ange-ftp-vms-filename-regexp
4555 nil t)
4556 (buffer-substring (match-beginning 0) (match-end 0))))
4557
4558 ;; Parse the current buffer which is assumed to be in MultiNet FTP dir
4559 ;; format, and return a hashtable as the result.
4560 (defun ange-ftp-parse-vms-listing ()
4561 (let ((tbl (ange-ftp-make-hashtable))
4562 file)
4563 (goto-char (point-min))
4564 (save-match-data
4565 (while (setq file (ange-ftp-parse-vms-filename))
4566 (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file)
4567 ;; deal with directories
4568 (ange-ftp-put-hash-entry
4569 (substring file 0 (match-beginning 0)) t tbl)
4570 (ange-ftp-put-hash-entry file nil tbl)
4571 (if (string-match ";[0-9]+$" file) ; deal with extension
4572 ;; sans extension
4573 (ange-ftp-put-hash-entry
4574 (substring file 0 (match-beginning 0)) nil tbl)))
4575 (forward-line 1))
4576 ;; Would like to look for a "Total" line, or a "Directory" line to
4577 ;; make sure that the listing isn't complete garbage before putting
4578 ;; in "." and "..", but we can't even count on all VAX's giving us
4579 ;; either of these.
4580 (ange-ftp-put-hash-entry "." t tbl)
4581 (ange-ftp-put-hash-entry ".." t tbl))
4582 tbl))
4583
4584 (or (assq 'vms ange-ftp-parse-list-func-alist)
4585 (setq ange-ftp-parse-list-func-alist
4586 (cons '(vms . ange-ftp-parse-vms-listing)
4587 ange-ftp-parse-list-func-alist)))
4588
4589 ;; This version only deletes file entries which have
4590 ;; explicit version numbers, because that is all VMS allows.
4591
4592 ;; Can the following two functions be speeded up using file
4593 ;; completion functions?
4594
4595 (defun ange-ftp-vms-delete-file-entry (name &optional dir-p)
4596 (if dir-p
4597 (ange-ftp-internal-delete-file-entry name t)
4598 (save-match-data
4599 (let ((file (ange-ftp-get-file-part name)))
4600 (if (string-match ";[0-9]+$" file)
4601 ;; In VMS you can't delete a file without an explicit
4602 ;; version number, or wild-card (e.g. FOO;*)
4603 ;; For now, we give up on wildcards.
4604 (let ((files (ange-ftp-get-hash-entry
4605 (file-name-directory name)
4606 ange-ftp-files-hashtable)))
4607 (if files
4608 (let* ((root (substring file 0
4609 (match-beginning 0)))
4610 (regexp (concat "^"
4611 (regexp-quote root)
4612 ";[0-9]+$"))
4613 versions)
4614 (ange-ftp-del-hash-entry file files)
4615 ;; Now we need to check if there are any
4616 ;; versions left. If not, then delete the
4617 ;; root entry.
4618 (mapatoms
4619 '(lambda (sym)
4620 (and (string-match regexp (get sym 'key))
4621 (setq versions t)))
4622 files)
4623 (or versions
4624 (ange-ftp-del-hash-entry root files))))))))))
4625
4626 (or (assq 'vms ange-ftp-delete-file-entry-alist)
4627 (setq ange-ftp-delete-file-entry-alist
4628 (cons '(vms . ange-ftp-vms-delete-file-entry)
4629 ange-ftp-delete-file-entry-alist)))
4630
4631 (defun ange-ftp-vms-add-file-entry (name &optional dir-p)
4632 (if dir-p
4633 (ange-ftp-internal-add-file-entry name t)
4634 (let ((files (ange-ftp-get-hash-entry
4635 (file-name-directory name)
4636 ange-ftp-files-hashtable)))
4637 (if files
4638 (let ((file (ange-ftp-get-file-part name)))
4639 (save-match-data
4640 (if (string-match ";[0-9]+$" file)
4641 (ange-ftp-put-hash-entry
4642 (substring file 0 (match-beginning 0))
4643 nil files)
4644 ;; Need to figure out what version of the file
4645 ;; is being added.
4646 (let ((regexp (concat "^"
4647 (regexp-quote file)
4648 ";\\([0-9]+\\)$"))
4649 (version 0))
4650 (mapatoms
4651 '(lambda (sym)
4652 (let ((name (get sym 'key)))
4653 (and (string-match regexp name)
4654 (setq version
4655 (max version
4656 (string-to-int
4657 (substring name
4658 (match-beginning 1)
4659 (match-end 1))))))))
4660 files)
4661 (setq version (1+ version))
4662 (ange-ftp-put-hash-entry
4663 (concat file ";" (int-to-string version))
4664 nil files))))
4665 (ange-ftp-put-hash-entry file nil files))))))
4666
4667 (or (assq 'vms ange-ftp-add-file-entry-alist)
4668 (setq ange-ftp-add-file-entry-alist
4669 (cons '(vms . ange-ftp-vms-add-file-entry)
4670 ange-ftp-add-file-entry-alist)))
4671
4672
4673 (defun ange-ftp-add-vms-host (host)
4674 "Mark HOST as the name of a machine running VMS."
4675 (interactive
4676 (list (read-string "Host: "
4677 (let ((name (or (buffer-file-name) default-directory)))
4678 (and name (car (ange-ftp-ftp-name name)))))))
4679 (if (not (ange-ftp-vms-host host))
4680 (setq ange-ftp-vms-host-regexp
4681 (concat "^" (regexp-quote host) "$"
4682 (and ange-ftp-vms-host-regexp "\\|")
4683 ange-ftp-vms-host-regexp)
4684 ange-ftp-host-cache nil)))
4685
4686
4687 (defun ange-ftp-vms-file-name-as-directory (name)
4688 (save-match-data
4689 (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?$" name)
4690 (setq name (substring name 0 (match-beginning 0))))
4691 (ange-ftp-real-file-name-as-directory name)))
4692
4693 (or (assq 'vms ange-ftp-file-name-as-directory-alist)
4694 (setq ange-ftp-file-name-as-directory-alist
4695 (cons '(vms . ange-ftp-vms-file-name-as-directory)
4696 ange-ftp-file-name-as-directory-alist)))
4697
4698 ;;; Tree dired support:
4699
4700 ;; For this code I have borrowed liberally from Sebastian Kremer's
4701 ;; dired-vms.el
4702
4703
4704 ;;;; These regexps must be anchored to beginning of line.
4705 ;;;; Beware that the ftpd may put the device in front of the filename.
4706
4707 ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]"
4708 ;; "Regular expression to use to search for VMS executable files.")
4709
4710 ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]"
4711 ;; "Regular expression to use to search for VMS directories.")
4712
4713 ;;(or (assq 'vms ange-ftp-dired-re-exe-alist)
4714 ;; (setq ange-ftp-dired-re-exe-alist
4715 ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe)
4716 ;; ange-ftp-dired-re-exe-alist)))
4717
4718 ;;(or (assq 'vms ange-ftp-dired-re-dir-alist)
4719 ;; (setq ange-ftp-dired-re-dir-alist
4720 ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir)
4721 ;; ange-ftp-dired-re-dir-alist)))
4722
4723 ;;(defun ange-ftp-dired-vms-insert-headerline (dir)
4724 ;; ;; VMS inserts a headerline. I would prefer the headerline
4725 ;; ;; to be in ange-ftp format. This version tries to
4726 ;; ;; be careful, because we can't count on a headerline
4727 ;; ;; over ftp, and we wouldn't want to delete anything
4728 ;; ;; important.
4729 ;; (save-excursion
4730 ;; (if (looking-at "^ wildcard ")
4731 ;; (forward-line 1))
4732 ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n")
4733 ;; (delete-region (point) (match-end 0))))
4734 ;; (ange-ftp-real-dired-insert-headerline dir))
4735
4736 ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist)
4737 ;; (setq ange-ftp-dired-insert-headerline-alist
4738 ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline)
4739 ;; ange-ftp-dired-insert-headerline-alist)))
4740
4741 ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol)
4742 ;; "In dired, move to first char of filename on this line.
4743 ;;Returns position (point) or nil if no filename on this line."
4744 ;; ;; This is the VMS version.
4745 ;; (let (case-fold-search)
4746 ;; (or eol (setq eol (progn (end-of-line) (point))))
4747 ;; (beginning-of-line)
4748 ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t)
4749 ;; (goto-char (match-beginning 1))
4750 ;; (if raise-error
4751 ;; (error "No file on this line")
4752 ;; nil))))
4753
4754 ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist)
4755 ;; (setq ange-ftp-dired-move-to-filename-alist
4756 ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename)
4757 ;; ange-ftp-dired-move-to-filename-alist)))
4758
4759 ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol)
4760 ;; ;; Assumes point is at beginning of filename.
4761 ;; ;; So, it should be called only after (dired-move-to-filename t).
4762 ;; ;; case-fold-search must be nil, at least for VMS.
4763 ;; ;; On failure, signals an error or returns nil.
4764 ;; ;; This is the VMS version.
4765 ;; (let (opoint hidden case-fold-search)
4766 ;; (setq opoint (point))
4767 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4768 ;; (setq hidden (and selective-display
4769 ;; (save-excursion (search-forward "\r" eol t))))
4770 ;; (if hidden
4771 ;; nil
4772 ;; (re-search-forward ange-ftp-vms-filename-regexp eol t))
4773 ;; (or no-error
4774 ;; (not (eq opoint (point)))
4775 ;; (error
4776 ;; (if hidden
4777 ;; (substitute-command-keys
4778 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
4779 ;; "No file on this line")))
4780 ;; (if (eq opoint (point))
4781 ;; nil
4782 ;; (point))))
4783
4784 ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist)
4785 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4786 ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename)
4787 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4788
4789 ;;(defun ange-ftp-dired-vms-between-files ()
4790 ;; (save-excursion
4791 ;; (beginning-of-line)
4792 ;; (or (equal (following-char) 10) ; newline
4793 ;; (equal (following-char) 9) ; tab
4794 ;; (progn (forward-char 2)
4795 ;; (or (looking-at "Total of")
4796 ;; (equal (following-char) 32))))))
4797
4798 ;;(or (assq 'vms ange-ftp-dired-between-files-alist)
4799 ;; (setq ange-ftp-dired-between-files-alist
4800 ;; (cons '(vms . ange-ftp-dired-vms-between-files)
4801 ;; ange-ftp-dired-between-files-alist)))
4802
4803 ;; Beware! In VMS filenames must be of the form "FILE.TYPE".
4804 ;; Therefore, we cannot just append a ".Z" to filenames for
4805 ;; compressed files. Instead, we turn "FILE.TYPE" into
4806 ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do.
4807
4808 (defun ange-ftp-vms-make-compressed-filename (name &optional reverse)
4809 (cond
4810 ((string-match "-Z;[0-9]+$" name)
4811 (list nil (substring name 0 (match-beginning 0))))
4812 ((string-match ";[0-9]+$" name)
4813 (list nil (substring name 0 (match-beginning 0))))
4814 ((string-match "-Z$" name)
4815 (list nil (substring name 0 -2)))
4816 (t
4817 (list t
4818 (if (string-match ";[0-9]+$" name)
4819 (concat (substring name 0 (match-beginning 0))
4820 "-Z")
4821 (concat name "-Z"))))))
4822
4823 (or (assq 'vms ange-ftp-make-compressed-filename-alist)
4824 (setq ange-ftp-make-compressed-filename-alist
4825 (cons '(vms . ange-ftp-vms-make-compressed-filename)
4826 ange-ftp-make-compressed-filename-alist)))
4827
4828 ;;;; When the filename is too long, VMS will use two lines to list a file
4829 ;;;; (damn them!) This will confuse dired. To solve this, need to convince
4830 ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of
4831 ;;;; (forward-line 1). This would require a number of changes to dired.el.
4832 ;;;; If dired gets confused, revert-buffer will fix it.
4833
4834 ;;(defun ange-ftp-dired-vms-ls-trim ()
4835 ;; (goto-char (point-min))
4836 ;; (let ((case-fold-search nil))
4837 ;; (re-search-forward ange-ftp-vms-filename-regexp))
4838 ;; (beginning-of-line)
4839 ;; (delete-region (point-min) (point))
4840 ;; (forward-line 1)
4841 ;; (delete-region (point) (point-max)))
4842
4843
4844 ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist)
4845 ;; (setq ange-ftp-dired-ls-trim-alist
4846 ;; (cons '(vms . ange-ftp-dired-vms-ls-trim)
4847 ;; ange-ftp-dired-ls-trim-alist)))
4848
4849 (defun ange-ftp-vms-sans-version (name &rest args)
4850 (save-match-data
4851 (if (string-match ";[0-9]+$" name)
4852 (substring name 0 (match-beginning 0))
4853 name)))
4854
4855 (or (assq 'vms ange-ftp-sans-version-alist)
4856 (setq ange-ftp-sans-version-alist
4857 (cons '(vms . ange-ftp-vms-sans-version)
4858 ange-ftp-sans-version-alist)))
4859
4860 ;;(defvar ange-ftp-file-version-alist)
4861
4862 ;;;;; The vms version of clean-directory has 2 more optional args
4863 ;;;;; than the usual dired version. This is so that it can be used by
4864 ;;;;; ange-ftp-dired-vms-flag-backup-files.
4865
4866 ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg)
4867 ;; "Flag numerical backups for deletion.
4868 ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
4869 ;;Positive prefix arg KEEP overrides `dired-kept-versions';
4870 ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
4871
4872 ;;To clear the flags on these files, you can use \\[dired-flag-backup-files]
4873 ;;with a prefix argument."
4874 ;;; (interactive "P") ; Never actually called interactively.
4875 ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions)))
4876 ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
4877 ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS!
4878 ;; ;; This could wipe ALL copies of the file.
4879 ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep)))
4880 ;; (action (or msg "Cleaning"))
4881 ;; (ange-ftp-trample-marker (or marker dired-del-marker))
4882 ;; (ange-ftp-file-version-alist ()))
4883 ;; (message (concat action
4884 ;; " numerical backups (keeping %d late, %d old)...")
4885 ;; late-retention early-retention)
4886 ;; ;; Look at each file.
4887 ;; ;; If the file has numeric backup versions,
4888 ;; ;; put on ange-ftp-file-version-alist an element of the form
4889 ;; ;; (FILENAME . VERSION-NUMBER-LIST)
4890 ;; (dired-map-dired-file-lines (function
4891 ;; ange-ftp-dired-vms-collect-file-versions))
4892 ;; ;; Sort each VERSION-NUMBER-LIST,
4893 ;; ;; and remove the versions not to be deleted.
4894 ;; (let ((fval ange-ftp-file-version-alist))
4895 ;; (while fval
4896 ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
4897 ;; (v-count (length sorted-v-list)))
4898 ;; (if (> v-count (+ early-retention late-retention))
4899 ;; (rplacd (nthcdr early-retention sorted-v-list)
4900 ;; (nthcdr (- v-count late-retention)
4901 ;; sorted-v-list)))
4902 ;; (rplacd (car fval)
4903 ;; (cdr sorted-v-list)))
4904 ;; (setq fval (cdr fval))))
4905 ;; ;; Look at each file. If it is a numeric backup file,
4906 ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
4907 ;; (dired-map-dired-file-lines
4908 ;; (function
4909 ;; ange-ftp-dired-vms-trample-file-versions mark))
4910 ;; (message (concat action " numerical backups...done"))))
4911
4912 ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist)
4913 ;; (setq ange-ftp-dired-clean-directory-alist
4914 ;; (cons '(vms . ange-ftp-dired-vms-clean-directory)
4915 ;; ange-ftp-dired-clean-directory-alist)))
4916
4917 ;;(defun ange-ftp-dired-vms-collect-file-versions (fn)
4918 ;; ;; "If it looks like file FN has versions, return a list of the versions.
4919 ;; ;;That is a list of strings which are file names.
4920 ;; ;;The caller may want to flag some of these files for deletion."
4921 ;;(let ((name (nth 2 (ange-ftp-ftp-name fn))))
4922 ;; (if (string-match ";[0-9]+$" name)
4923 ;; (let* ((name (substring name 0 (match-beginning 0)))
4924 ;; (fn (ange-ftp-replace-name-component fn name)))
4925 ;; (if (not (assq fn ange-ftp-file-version-alist))
4926 ;; (let* ((base-versions
4927 ;; (concat (file-name-nondirectory name) ";"))
4928 ;; (bv-length (length base-versions))
4929 ;; (possibilities (file-name-all-completions
4930 ;; base-versions
4931 ;; (file-name-directory fn)))
4932 ;; (versions (mapcar
4933 ;; '(lambda (arg)
4934 ;; (if (and (string-match
4935 ;; "[0-9]+$" arg bv-length)
4936 ;; (= (match-beginning 0) bv-length))
4937 ;; (string-to-int (substring arg bv-length))
4938 ;; 0))
4939 ;; possibilities)))
4940 ;; (if versions
4941 ;; (setq
4942 ;; ange-ftp-file-version-alist
4943 ;; (cons (cons fn versions)
4944 ;; ange-ftp-file-version-alist)))))))))
4945
4946 ;;(defun ange-ftp-dired-vms-trample-file-versions (fn)
4947 ;; (let* ((start-vn (string-match ";[0-9]+$" fn))
4948 ;; base-version-list)
4949 ;; (and start-vn
4950 ;; (setq base-version-list ; there was a base version to which
4951 ;; (assoc (substring fn 0 start-vn) ; this looks like a
4952 ;; ange-ftp-file-version-alist)) ; subversion
4953 ;; (not (memq (string-to-int (substring fn (1+ start-vn)))
4954 ;; base-version-list)) ; this one doesn't make the cut
4955 ;; (progn (beginning-of-line)
4956 ;; (delete-char 1)
4957 ;; (insert ange-ftp-trample-marker)))))
4958
4959 ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p)
4960 ;; (let ((dired-kept-versions 1)
4961 ;; (kept-old-versions 0)
4962 ;; marker msg)
4963 ;; (if unflag-p
4964 ;; (setq marker ?\040 msg "Unflagging")
4965 ;; (setq marker dired-del-marker msg "Cleaning"))
4966 ;; (ange-ftp-dired-vms-clean-directory nil marker msg)))
4967
4968 ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist)
4969 ;; (setq ange-ftp-dired-flag-backup-files-alist
4970 ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files)
4971 ;; ange-ftp-dired-flag-backup-files-alist)))
4972
4973 ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches)
4974 ;; (let ((file (dired-get-filename 'no-dir))
4975 ;; bak)
4976 ;; (if (and (string-match ";[0-9]+$" file)
4977 ;; ;; Find most recent previous version.
4978 ;; (let ((root (substring file 0 (match-beginning 0)))
4979 ;; (ver
4980 ;; (string-to-int (substring file (1+ (match-beginning 0)))))
4981 ;; found)
4982 ;; (setq ver (1- ver))
4983 ;; (while (and (> ver 0) (not found))
4984 ;; (setq bak (concat root ";" (int-to-string ver)))
4985 ;; (and (file-exists-p bak) (setq found t))
4986 ;; (setq ver (1- ver)))
4987 ;; found))
4988 ;; (if switches
4989 ;; (diff (expand-file-name bak) (expand-file-name file) switches)
4990 ;; (diff (expand-file-name bak) (expand-file-name file)))
4991 ;; (error "No previous version found for %s" file))))
4992
4993 ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist)
4994 ;; (setq ange-ftp-dired-backup-diff-alist
4995 ;; (cons '(vms . ange-ftp-dired-vms-backup-diff)
4996 ;; ange-ftp-dired-backup-diff-alist)))
4997
4998 \f
4999 ;;;; ------------------------------------------------------------
5000 ;;;; MTS support
5001 ;;;; ------------------------------------------------------------
5002
5003
5004 ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from
5005 ;; MTS to UNIX-ish.
5006 (defun ange-ftp-fix-name-for-mts (name &optional reverse)
5007 (save-match-data
5008 (if reverse
5009 (if (string-match "^\\([^:]+:\\)?\\(.*\\)$" name)
5010 (let (acct file)
5011 (if (match-beginning 1)
5012 (setq acct (substring name 0 (match-end 1))))
5013 (if (match-beginning 2)
5014 (setq file (substring name
5015 (match-beginning 2) (match-end 2))))
5016 (concat (and acct (concat "/" acct "/"))
5017 file))
5018 (error "name %s didn't match" name))
5019 (if (string-match "^/\\([^:]+:\\)/\\(.*\\)$" name)
5020 (concat (substring name 1 (match-end 1))
5021 (substring name (match-beginning 2) (match-end 2)))
5022 ;; Let's hope that mts will recognize it anyway.
5023 name))))
5024
5025 (or (assq 'mts ange-ftp-fix-name-func-alist)
5026 (setq ange-ftp-fix-name-func-alist
5027 (cons '(mts . ange-ftp-fix-name-for-mts)
5028 ange-ftp-fix-name-func-alist)))
5029
5030 ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing.
5031 ;; Remember that there are no directories in MTS.
5032 (defun ange-ftp-fix-dir-name-for-mts (dir-name)
5033 (if (string-equal dir-name "/")
5034 (error "Cannot get listing for fictitious \"/\" directory.")
5035 (let ((dir-name (ange-ftp-fix-name-for-mts dir-name)))
5036 (cond
5037 ((string-equal dir-name "")
5038 "?")
5039 ((string-match ":$" dir-name)
5040 (concat dir-name "?"))
5041 (dir-name))))) ; It's just a single file.
5042
5043 (or (assq 'mts ange-ftp-fix-dir-name-func-alist)
5044 (setq ange-ftp-fix-dir-name-func-alist
5045 (cons '(mts . ange-ftp-fix-dir-name-for-mts)
5046 ange-ftp-fix-dir-name-func-alist)))
5047
5048 (or (memq 'mts ange-ftp-dumb-host-types)
5049 (setq ange-ftp-dumb-host-types
5050 (cons 'mts ange-ftp-dumb-host-types)))
5051
5052 (defvar ange-ftp-mts-host-regexp nil)
5053
5054 ;; Return non-nil if HOST is running MTS.
5055 (defun ange-ftp-mts-host (host)
5056 (and ange-ftp-mts-host-regexp
5057 (save-match-data
5058 (string-match ange-ftp-mts-host-regexp host))))
5059
5060 ;; Parse the current buffer which is assumed to be in mts ftp dir format.
5061 (defun ange-ftp-parse-mts-listing ()
5062 (let ((tbl (ange-ftp-make-hashtable)))
5063 (goto-char (point-min))
5064 (save-match-data
5065 (while (re-search-forward ange-ftp-date-regexp nil t)
5066 (end-of-line)
5067 (skip-chars-backward " ")
5068 (let ((end (point)))
5069 (skip-chars-backward "-A-Z0-9_.!")
5070 (ange-ftp-put-hash-entry (buffer-substring (point) end) nil tbl))
5071 (forward-line 1)))
5072 ;; Don't need to bother with ..
5073 (ange-ftp-put-hash-entry "." t tbl)
5074 tbl))
5075
5076 (or (assq 'mts ange-ftp-parse-list-func-alist)
5077 (setq ange-ftp-parse-list-func-alist
5078 (cons '(mts . ange-ftp-parse-mts-listing)
5079 ange-ftp-parse-list-func-alist)))
5080
5081 (defun ange-ftp-add-mts-host (host)
5082 "Mark HOST as the name of a machine running MTS."
5083 (interactive
5084 (list (read-string "Host: "
5085 (let ((name (or (buffer-file-name) default-directory)))
5086 (and name (car (ange-ftp-ftp-name name)))))))
5087 (if (not (ange-ftp-mts-host host))
5088 (setq ange-ftp-mts-host-regexp
5089 (concat "^" (regexp-quote host) "$"
5090 (and ange-ftp-mts-host-regexp "\\|")
5091 ange-ftp-mts-host-regexp)
5092 ange-ftp-host-cache nil)))
5093
5094 ;;; Tree dired support:
5095
5096 ;;;; There aren't too many systems left that use MTS. This dired support will
5097 ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems
5098 ;;;; implement ftp in the same way. If not, it might be necessary to make the
5099 ;;;; following more flexible.
5100
5101 ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol)
5102 ;; "In dired, move to first char of filename on this line.
5103 ;;Returns position (point) or nil if no filename on this line."
5104 ;; ;; This is the MTS version.
5105 ;; (or eol (setq eol (progn (end-of-line) (point))))
5106 ;; (beginning-of-line)
5107 ;; (if (re-search-forward
5108 ;; ange-ftp-date-regexp eol t)
5109 ;; (progn
5110 ;; (skip-chars-forward " ") ; Eat blanks after date
5111 ;; (skip-chars-forward "0-9:" eol) ; Eat time or year
5112 ;; (skip-chars-forward " " eol) ; one space before filename
5113 ;; ;; When listing an account other than the users own account it appends
5114 ;; ;; ACCT: to the beginning of the filename. Skip over this.
5115 ;; (and (looking-at "[A-Z0-9_.]+:")
5116 ;; (goto-char (match-end 0)))
5117 ;; (point))
5118 ;; (if raise-error
5119 ;; (error "No file on this line")
5120 ;; nil)))
5121
5122 ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist)
5123 ;; (setq ange-ftp-dired-move-to-filename-alist
5124 ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename)
5125 ;; ange-ftp-dired-move-to-filename-alist)))
5126
5127 ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol)
5128 ;; ;; Assumes point is at beginning of filename.
5129 ;; ;; So, it should be called only after (dired-move-to-filename t).
5130 ;; ;; On failure, signals an error or returns nil.
5131 ;; ;; This is the MTS version.
5132 ;; (let (opoint hidden case-fold-search)
5133 ;; (setq opoint (point)
5134 ;; eol (save-excursion (end-of-line) (point))
5135 ;; hidden (and selective-display
5136 ;; (save-excursion (search-forward "\r" eol t))))
5137 ;; (if hidden
5138 ;; nil
5139 ;; (skip-chars-forward "-A-Z0-9._!" eol))
5140 ;; (or no-error
5141 ;; (not (eq opoint (point)))
5142 ;; (error
5143 ;; (if hidden
5144 ;; (substitute-command-keys
5145 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5146 ;; "No file on this line")))
5147 ;; (if (eq opoint (point))
5148 ;; nil
5149 ;; (point))))
5150
5151 ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist)
5152 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5153 ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename)
5154 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5155 \f
5156 ;;;; ------------------------------------------------------------
5157 ;;;; CMS support
5158 ;;;; ------------------------------------------------------------
5159
5160 ;; Since CMS doesn't have any full file name syntax, we have to fudge
5161 ;; things with cd's. We actually send too many cd's, but it's dangerous
5162 ;; to try to remember the current minidisk, because if the connection
5163 ;; is closed and needs to be reopened, we will find ourselves back in
5164 ;; the default minidisk. This is fairly likely since CMS ftp servers
5165 ;; usually close the connection after 5 minutes of inactivity.
5166
5167 ;; Have I got the filename character set right?
5168
5169 (defun ange-ftp-fix-name-for-cms (name &optional reverse)
5170 (save-match-data
5171 (if reverse
5172 ;; Since we only convert output from a pwd in this direction,
5173 ;; we'll assume that it's a minidisk, and make it into a
5174 ;; directory file name. Note that the expand-dir-hashtable
5175 ;; stores directories without the trailing /. Is this
5176 ;; consistent?
5177 (concat "/" name)
5178 (if (string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$"
5179 name)
5180 (let ((minidisk (substring name 1 (match-end 1))))
5181 (if (match-beginning 2)
5182 (let ((file (substring name (match-beginning 2)
5183 (match-end 2)))
5184 (cmd (concat "cd " minidisk))
5185
5186 ;; Note that host and user are bound in the call
5187 ;; to ange-ftp-send-cmd
5188 (proc (ange-ftp-get-process ange-ftp-this-host
5189 ange-ftp-this-user)))
5190
5191 ;; Must use ange-ftp-raw-send-cmd here to avoid
5192 ;; an infinite loop.
5193 (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg))
5194 file
5195 ;; failed... try ONCE more.
5196 (setq proc (ange-ftp-get-process ange-ftp-this-host
5197 ange-ftp-this-user))
5198 (let ((result (ange-ftp-raw-send-cmd proc cmd
5199 ange-ftp-this-msg)))
5200 (if (car result)
5201 file
5202 ;; failed. give up.
5203 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5204 (format "cd to minidisk %s failed: %s"
5205 minidisk (cdr result)))))))
5206 ;; return the minidisk
5207 minidisk))
5208 (error "Invalid CMS filename")))))
5209
5210 (or (assq 'cms ange-ftp-fix-name-func-alist)
5211 (setq ange-ftp-fix-name-func-alist
5212 (cons '(cms . ange-ftp-fix-name-for-cms)
5213 ange-ftp-fix-name-func-alist)))
5214
5215 (or (memq 'cms ange-ftp-dumb-host-types)
5216 (setq ange-ftp-dumb-host-types
5217 (cons 'cms ange-ftp-dumb-host-types)))
5218
5219 ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing.
5220 (defun ange-ftp-fix-dir-name-for-cms (dir-name)
5221 (cond
5222 ((string-equal "/" dir-name)
5223 (error "Cannot get listing for fictitious \"/\" directory."))
5224 ((string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$" dir-name)
5225 (let* ((minidisk (substring dir-name (match-beginning 1) (match-end 1)))
5226 ;; host and user are bound in the call to ange-ftp-send-cmd
5227 (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user))
5228 (cmd (concat "cd " minidisk))
5229 (file (if (match-beginning 2)
5230 ;; it's a single file
5231 (substring dir-name (match-beginning 2)
5232 (match-end 2))
5233 ;; use the wild-card
5234 "*")))
5235 (if (car (ange-ftp-raw-send-cmd proc cmd))
5236 file
5237 ;; try again...
5238 (setq proc (ange-ftp-get-process ange-ftp-this-host
5239 ange-ftp-this-user))
5240 (let ((result (ange-ftp-raw-send-cmd proc cmd)))
5241 (if (car result)
5242 file
5243 ;; give up
5244 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5245 (format "cd to minidisk %s failed: "
5246 minidisk (cdr result))))))))
5247 (t (error "Invalid CMS file name"))))
5248
5249 (or (assq 'cms ange-ftp-fix-dir-name-func-alist)
5250 (setq ange-ftp-fix-dir-name-func-alist
5251 (cons '(cms . ange-ftp-fix-dir-name-for-cms)
5252 ange-ftp-fix-dir-name-func-alist)))
5253
5254 (defvar ange-ftp-cms-host-regexp nil
5255 "Regular expression to match hosts running the CMS operating system.")
5256
5257 ;; Return non-nil if HOST is running CMS.
5258 (defun ange-ftp-cms-host (host)
5259 (and ange-ftp-cms-host-regexp
5260 (save-match-data
5261 (string-match ange-ftp-cms-host-regexp host))))
5262
5263 (defun ange-ftp-add-cms-host (host)
5264 "Mark HOST as the name of a CMS host."
5265 (interactive
5266 (list (read-string "Host: "
5267 (let ((name (or (buffer-file-name) default-directory)))
5268 (and name (car (ange-ftp-ftp-name name)))))))
5269 (if (not (ange-ftp-cms-host host))
5270 (setq ange-ftp-cms-host-regexp
5271 (concat "^" (regexp-quote host) "$"
5272 (and ange-ftp-cms-host-regexp "\\|")
5273 ange-ftp-cms-host-regexp)
5274 ange-ftp-host-cache nil)))
5275
5276 (defun ange-ftp-parse-cms-listing ()
5277 ;; Parse the current buffer which is assumed to be a CMS directory listing.
5278 ;; If we succeed in getting a listing, then we will assume that the minidisk
5279 ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work
5280 ;; because ange-ftp doesn't know that the root hashtable has only part of
5281 ;; the info. It will assume that if a minidisk isn't in it, then it doesn't
5282 ;; exist. It would be nice if completion worked for minidisks, as we
5283 ;; discover them.
5284 ; (let* ((dir-file (directory-file-name file))
5285 ; (root (file-name-directory dir-file))
5286 ; (minidisk (ange-ftp-get-file-part dir-file))
5287 ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable)))
5288 ; (if root-tbl
5289 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5290 ; (setq root-tbl (ange-ftp-make-hashtable))
5291 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5292 ; (ange-ftp-put-hash-entry "." t root-tbl)
5293 ; (ange-ftp-set-files root root-tbl)))
5294 ;; Now do the usual parsing
5295 (let ((tbl (ange-ftp-make-hashtable)))
5296 (goto-char (point-min))
5297 (save-match-data
5298 (while
5299 (re-search-forward
5300 "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t)
5301 (ange-ftp-put-hash-entry
5302 (concat (buffer-substring (match-beginning 1)
5303 (match-end 1))
5304 "."
5305 (buffer-substring (match-beginning 2)
5306 (match-end 2)))
5307 nil tbl)
5308 (forward-line 1))
5309 (ange-ftp-put-hash-entry "." t tbl))
5310 tbl))
5311
5312 (or (assq 'cms ange-ftp-parse-list-func-alist)
5313 (setq ange-ftp-parse-list-func-alist
5314 (cons '(cms . ange-ftp-parse-cms-listing)
5315 ange-ftp-parse-list-func-alist)))
5316
5317 ;;;;; Tree dired support:
5318
5319 ;;(defconst ange-ftp-dired-cms-re-exe
5320 ;; "^. [-A-Z0-9$_]+ +EXEC "
5321 ;; "Regular expression to use to search for CMS executables.")
5322
5323 ;;(or (assq 'cms ange-ftp-dired-re-exe-alist)
5324 ;; (setq ange-ftp-dired-re-exe-alist
5325 ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe)
5326 ;; ange-ftp-dired-re-exe-alist)))
5327
5328
5329 ;;(defun ange-ftp-dired-cms-insert-headerline (dir)
5330 ;; ;; CMS has no total line, so we insert a blank line for
5331 ;; ;; aesthetics.
5332 ;; (insert "\n")
5333 ;; (forward-char -1)
5334 ;; (ange-ftp-real-dired-insert-headerline dir))
5335
5336 ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist)
5337 ;; (setq ange-ftp-dired-insert-headerline-alist
5338 ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline)
5339 ;; ange-ftp-dired-insert-headerline-alist)))
5340
5341 ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol)
5342 ;; "In dired, move to the first char of filename on this line."
5343 ;; ;; This is the CMS version.
5344 ;; (or eol (setq eol (progn (end-of-line) (point))))
5345 ;; (let (case-fold-search)
5346 ;; (beginning-of-line)
5347 ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t)
5348 ;; (goto-char (1+ (match-beginning 0)))
5349 ;; (if raise-error
5350 ;; (error "No file on this line")
5351 ;; nil))))
5352
5353 ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist)
5354 ;; (setq ange-ftp-dired-move-to-filename-alist
5355 ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename)
5356 ;; ange-ftp-dired-move-to-filename-alist)))
5357
5358 ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol)
5359 ;; ;; Assumes point is at beginning of filename.
5360 ;; ;; So, it should be called only after (dired-move-to-filename t).
5361 ;; ;; case-fold-search must be nil, at least for VMS.
5362 ;; ;; On failure, signals an error or returns nil.
5363 ;; ;; This is the CMS version.
5364 ;; (let ((opoint (point))
5365 ;; case-fold-search hidden)
5366 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
5367 ;; (setq hidden (and selective-display
5368 ;; (save-excursion
5369 ;; (search-forward "\r" eol t))))
5370 ;; (if hidden
5371 ;; (if no-error
5372 ;; nil
5373 ;; (error
5374 ;; (substitute-command-keys
5375 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
5376 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5377 ;; (skip-chars-forward " " eol)
5378 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5379 ;; (if (eq opoint (point))
5380 ;; (if no-error
5381 ;; nil
5382 ;; (error "No file on this line"))
5383 ;; (point)))))
5384
5385 ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist)
5386 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5387 ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename)
5388 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5389
5390 (defun ange-ftp-cms-make-compressed-filename (name &optional reverse)
5391 (if (string-match "-Z$" name)
5392 (list nil (substring name 0 -2))
5393 (list t (concat name "-Z"))))
5394
5395 (or (assq 'cms ange-ftp-make-compressed-filename-alist)
5396 (setq ange-ftp-make-compressed-filename-alist
5397 (cons '(cms . ange-ftp-cms-make-compressed-filename)
5398 ange-ftp-make-compressed-filename-alist)))
5399
5400 ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep)
5401 ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep)))
5402 ;; (and name
5403 ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name)
5404 ;; (concat (substring name 0 (match-end 1))
5405 ;; "."
5406 ;; (substring name (match-beginning 2) (match-end 2)))
5407 ;; name))))
5408
5409 ;;(or (assq 'cms ange-ftp-dired-get-filename-alist)
5410 ;; (setq ange-ftp-dired-get-filename-alist
5411 ;; (cons '(cms . ange-ftp-dired-cms-get-filename)
5412 ;; ange-ftp-dired-get-filename-alist)))
5413 \f
5414 ;;;; ------------------------------------------------------------
5415 ;;;; Finally provide package.
5416 ;;;; ------------------------------------------------------------
5417
5418 (provide 'ange-ftp)
5419
5420 ;;; ange-ftp.el ends here