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