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