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