(undigestify-rmail-message): Better error messages.
[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 1603 (comint-output-filter proc str)
6d766abc
RS
1604 (save-excursion
1605 (set-buffer (process-buffer proc))
1606 ;; Replace STR by the result of the comint processing.
1607 (setq str (buffer-substring comint-last-output-start (process-mark proc))))
65135ec2
RS
1608 (cond ((string-match "login: *$" str)
1609 (send-string proc
1610 (concat
1611 (let ((ange-ftp-default-user t))
1612 (ange-ftp-get-user ange-ftp-gateway-host))
1613 "\n")))
1614 ((string-match "Password: *$" str)
1615 (send-string proc
1616 (concat
1617 (ange-ftp-get-passwd ange-ftp-gateway-host
1618 (ange-ftp-get-user
1619 ange-ftp-gateway-host))
1620 "\n")))
1621 ((string-match ange-ftp-gateway-fatal-msgs str)
1622 (delete-process proc)
1623 (setq ange-ftp-gwp-running nil))
1624 ((string-match ange-ftp-gateway-prompt-pattern str)
1625 (setq ange-ftp-gwp-running nil
1626 ange-ftp-gwp-status t))))
2f7ea155
RS
1627
1628(defun ange-ftp-gwp-start (host user name args)
1629 "Login to the gateway machine and fire up an ftp process."
1630 (let* ((gw-user (ange-ftp-get-user ange-ftp-gateway-host))
888b812e
RS
1631 ;; It would be nice to make process-connection-type nil,
1632 ;; but that doesn't work: ftp never responds.
1633 ;; Can anyone find a fix for that?
1634 (proc (let ((process-connection-type t))
68eabf10 1635 (start-process name name
888b812e
RS
1636 ange-ftp-gateway-program
1637 ange-ftp-gateway-host)))
2f7ea155
RS
1638 (ftp (mapconcat (function identity) args " ")))
1639 (process-kill-without-query proc)
1640 (set-process-sentinel proc (function ange-ftp-gwp-sentinel))
1641 (set-process-filter proc (function ange-ftp-gwp-filter))
68eabf10
RS
1642 (save-excursion
1643 (set-buffer (process-buffer proc))
1644 (internal-ange-ftp-mode)
1645 (set-marker (process-mark proc) (point)))
2f7ea155
RS
1646 (setq ange-ftp-gwp-running t
1647 ange-ftp-gwp-status nil)
1648 (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host)
1649 (while ange-ftp-gwp-running ;perform login sequence
1650 (accept-process-output proc))
1651 (if (not ange-ftp-gwp-status)
1652 (ange-ftp-error host user "unable to login to gateway"))
1653 (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host)
1654 (setq ange-ftp-gwp-running t
1655 ange-ftp-gwp-status nil)
1656 (process-send-string proc ange-ftp-gateway-setup-term-command)
1657 (while ange-ftp-gwp-running ;zap ^M's and double echoing.
1658 (accept-process-output proc))
1659 (if (not ange-ftp-gwp-status)
1660 (ange-ftp-error host user "unable to set terminal modes on gateway"))
1661 (setq ange-ftp-gwp-running t
1662 ange-ftp-gwp-status nil)
1663 (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process
1664 proc))
1665\f
1666;;;; ------------------------------------------------------------
1667;;;; Support for sending commands to the ftp process.
1668;;;; ------------------------------------------------------------
1669
1670(defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait)
1671 "Low-level routine to send the given ftp CMD to the ftp PROCESS.
1672MSG is an optional message to output before and after the command.
1673If CONT is non-NIL then it is either a function or a list of function and
1674some arguments. The function will be called when the ftp command has completed.
1675If CONT is NIL then this routine will return \( RESULT . LINE \) where RESULT
1676is whether the command was successful, and LINE is the line from the FTP
1677process that caused the command to complete.
1678If NOWAIT is given then the routine will return immediately the command has
1679been queued with no result. CONT will still be called, however."
1680 (if (memq (process-status proc) '(run open))
1681 (save-excursion
1682 (set-buffer (process-buffer proc))
1683 (while ange-ftp-process-busy
c7a464d0
RS
1684 ;; This is a kludge to let user quit in case ftp gets hung.
1685 ;; It matters because this function can be called from the filter.
1686 ;; It is bad to allow quitting in a filter, but getting hung
1687 ;; is worse. By binding quit-flag to nil, we might avoid
1688 ;; most of the probability of getting screwed because the user
1689 ;; wants to quit some command.
1690 (let ((quit-flag nil)
1691 (inhibit-quit nil))
1692 (accept-process-output)))
2f7ea155
RS
1693 (setq ange-ftp-process-string ""
1694 ange-ftp-process-result-line ""
1695 ange-ftp-process-busy t
1696 ange-ftp-process-result nil
1697 ange-ftp-process-multi-skip nil
1698 ange-ftp-process-msg msg
1699 ange-ftp-process-continue cont
1700 ange-ftp-hash-mark-count 0
1701 ange-ftp-last-percent -1
1702 cmd (concat cmd "\n"))
1703 (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg))
1704 (goto-char (point-max))
d0bc419e 1705 (move-marker comint-last-input-start (point))
2f7ea155 1706 ;; don't insert the password into the buffer on the USER command.
65135ec2 1707 (save-match-data
2f7ea155
RS
1708 (if (string-match "^user \"[^\"]*\"" cmd)
1709 (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n")
1710 (insert cmd)))
d0bc419e 1711 (move-marker comint-last-input-end (point))
2f7ea155
RS
1712 (send-string proc cmd)
1713 (set-marker (process-mark proc) (point))
1714 (if nowait
1715 nil
1716 ;; hang around for command to complete
1717 (while ange-ftp-process-busy
c7a464d0
RS
1718 ;; This is a kludge to let user quit in case ftp gets hung.
1719 ;; It matters because this function can be called from the filter.
1720 (let ((quit-flag nil)
1721 (inhibit-quit nil))
1722 (accept-process-output proc)))
2f7ea155
RS
1723 (if cont
1724 nil ;cont has already been called
1725 (cons ange-ftp-process-result ange-ftp-process-result-line))))))
1726
1727(defun ange-ftp-nslookup-host (host)
1728 "Attempt to resolve the given HOSTNAME using nslookup if possible."
1729 (interactive "sHost: ")
1730 (if ange-ftp-nslookup-program
17b85a9b
RS
1731 (let ((default-directory
1732 (if (file-accessible-directory-p default-directory)
1733 default-directory
1734 exec-directory))
888b812e
RS
1735 ;; It would be nice to make process-connection-type nil,
1736 ;; but that doesn't work: ftp never responds.
1737 ;; Can anyone find a fix for that?
1738 (proc (let ((process-connection-type t))
1739 (start-process " *nslookup*" " *nslookup*"
1740 ange-ftp-nslookup-program host)))
2f7ea155
RS
1741 (res host))
1742 (process-kill-without-query proc)
1743 (save-excursion
1744 (set-buffer (process-buffer proc))
1745 (while (memq (process-status proc) '(run open))
1746 (accept-process-output proc))
1747 (goto-char (point-min))
1748 (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t)
1749 (setq res (buffer-substring (match-beginning 1)
1750 (match-end 1))))
1751 (kill-buffer (current-buffer)))
1752 res)
1753 host))
1754
1755(defun ange-ftp-start-process (host user name)
1756 "Spawn a new ftp process ready to connect to machine HOST and give it NAME.
1757If HOST is only ftp-able through a gateway machine then spawn a shell
1758on the gateway machine to do the ftp instead."
1759 (let* ((use-gateway (ange-ftp-use-gateway-p host))
deec9e74
RS
1760 (use-smart-ftp (and (not ange-ftp-gateway-host)
1761 (ange-ftp-use-smart-gateway-p host)))
1762 (ftp-prog (if (or use-gateway
1763 use-smart-ftp)
2f7ea155
RS
1764 ange-ftp-gateway-ftp-program-name
1765 ange-ftp-ftp-program-name))
1766 (args (append (list ftp-prog) ange-ftp-ftp-program-args))
a9864baf
RS
1767 ;; Without the following binding, ange-ftp-start-process
1768 ;; recurses on file-accessible-directory-p, since it needs to
1769 ;; restart its process in order to determine anything about
1770 ;; default-directory.
1771 (file-name-handler-alist)
17b85a9b
RS
1772 (default-directory
1773 (if (file-accessible-directory-p default-directory)
1774 default-directory
1775 exec-directory))
2f7ea155 1776 proc)
888b812e
RS
1777 ;; It would be nice to make process-connection-type nil,
1778 ;; but that doesn't work: ftp never responds.
1779 ;; Can anyone find a fix for that?
1780 (let ((process-connection-type t))
1781 (if use-gateway
1782 (if ange-ftp-gateway-program-interactive
1783 (setq proc (ange-ftp-gwp-start host user name args))
1784 (setq proc (apply 'start-process name name
1785 (append (list ange-ftp-gateway-program
1786 ange-ftp-gateway-host)
1787 args))))
1788 (setq proc (apply 'start-process name name args))))
2f7ea155 1789 (process-kill-without-query proc)
2f7ea155
RS
1790 (save-excursion
1791 (set-buffer (process-buffer proc))
e066c2ae 1792 (internal-ange-ftp-mode))
2f7ea155
RS
1793 (set-process-sentinel proc (function ange-ftp-process-sentinel))
1794 (set-process-filter proc (function ange-ftp-process-filter))
1795 (accept-process-output proc) ;wait for ftp startup message
1796 proc))
1797
e066c2ae 1798(defun internal-ange-ftp-mode ()
d0a54f0f
RS
1799 "Major mode for interacting with the FTP process.
1800
1801\\{comint-mode-map}"
d0bc419e
RS
1802 (interactive)
1803 (comint-mode)
e066c2ae
RS
1804 (setq major-mode 'internal-ange-ftp-mode)
1805 (setq mode-name "Internal Ange-ftp")
2f7ea155 1806 (let ((proc (get-buffer-process (current-buffer))))
2f7ea155
RS
1807 (goto-char (point-max))
1808 (set-marker (process-mark proc) (point))
1809 (make-local-variable 'ange-ftp-process-string)
1810 (setq ange-ftp-process-string "")
1811 (make-local-variable 'ange-ftp-process-busy)
1812 (make-local-variable 'ange-ftp-process-result)
1813 (make-local-variable 'ange-ftp-process-msg)
1814 (make-local-variable 'ange-ftp-process-multi-skip)
1815 (make-local-variable 'ange-ftp-process-result-line)
1816 (make-local-variable 'ange-ftp-process-continue)
1817 (make-local-variable 'ange-ftp-hash-mark-count)
1818 (make-local-variable 'ange-ftp-binary-hash-mark-size)
1819 (make-local-variable 'ange-ftp-ascii-hash-mark-size)
1820 (make-local-variable 'ange-ftp-hash-mark-unit)
1821 (make-local-variable 'ange-ftp-xfer-size)
1822 (make-local-variable 'ange-ftp-last-percent)
1823 (setq ange-ftp-hash-mark-count 0)
1824 (setq ange-ftp-xfer-size 0)
d0a54f0f
RS
1825 (setq ange-ftp-process-result-line "")
1826
1827 (setq comint-prompt-regexp "^ftp> ")
1828 (make-local-variable 'paragraph-start)
1829 (setq paragraph-start comint-prompt-regexp)))
2f7ea155
RS
1830
1831(defun ange-ftp-smart-login (host user pass account proc)
1832 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1833PROC is the FTP-client's process. This routine uses the smart-gateway
1834host specified in ``ange-ftp-gateway-host''."
1835 (let ((result (ange-ftp-raw-send-cmd
1836 proc
1837 (format "open %s %s"
1838 (ange-ftp-nslookup-host ange-ftp-gateway-host)
1839 ange-ftp-smart-gateway-port)
1840 (format "Opening FTP connection to %s via %s"
1841 host
1842 ange-ftp-gateway-host))))
1843 (or (car result)
1844 (ange-ftp-error host user
1845 (concat "OPEN request failed: "
1846 (cdr result))))
1847 (setq result (ange-ftp-raw-send-cmd
1848 proc (format "user \"%s\"@%s %s %s"
1849 user
1850 (ange-ftp-nslookup-host host)
1851 pass
1852 account)
1853 (format "Logging in as user %s@%s"
1854 user host)))
1855 (or (car result)
1856 (progn
1857 (ange-ftp-set-passwd host user nil) ; reset password
1858 (ange-ftp-set-account host user nil) ; reset account
1859 (ange-ftp-error host user
1860 (concat "USER request failed: "
1861 (cdr result)))))))
1862
1863(defun ange-ftp-normal-login (host user pass account proc)
1864 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1865PROC is the process to the FTP-client."
222e97c1
RS
1866 (let* ((nshost (ange-ftp-nslookup-host host))
1867 (result (ange-ftp-raw-send-cmd
2f7ea155 1868 proc
222e97c1 1869 (format "open %s" nshost)
2f7ea155
RS
1870 (format "Opening FTP connection to %s" host))))
1871 (or (car result)
1872 (ange-ftp-error host user
1873 (concat "OPEN request failed: "
1874 (cdr result))))
1875 (setq result (ange-ftp-raw-send-cmd
1876 proc
222e97c1
RS
1877 (if (ange-ftp-use-smart-gateway-p host)
1878 (format "user \"%s\"@%s %s %s" user nshost pass account)
1879 (format "user \"%s\" %s %s" user pass account))
2f7ea155
RS
1880 (format "Logging in as user %s@%s" user host)))
1881 (or (car result)
1882 (progn
1883 (ange-ftp-set-passwd host user nil) ;reset password.
1884 (ange-ftp-set-account host user nil) ;reset account.
1885 (ange-ftp-error host user
1886 (concat "USER request failed: "
1887 (cdr result)))))))
1888
812daf81 1889;; ange@hplb.hpl.hp.com says this should not be changed.
2f7ea155 1890(defvar ange-ftp-hash-mark-msgs
812daf81 1891 "[hH]ash mark [^0-9]*\\([0-9]+\\)"
2f7ea155
RS
1892 "*Regexp matching the FTP client's output upon doing a HASH command.")
1893
1894(defun ange-ftp-guess-hash-mark-size (proc)
1895 (if ange-ftp-send-hash
1896 (save-excursion
1897 (set-buffer (process-buffer proc))
1898 (let* ((status (ange-ftp-raw-send-cmd proc "hash"))
1899 (result (car status))
1900 (line (cdr status)))
65135ec2 1901 (save-match-data
2f7ea155
RS
1902 (if (string-match ange-ftp-hash-mark-msgs line)
1903 (let ((size (string-to-int
1904 (substring line
1905 (match-beginning 1)
1906 (match-end 1)))))
1907 (setq ange-ftp-ascii-hash-mark-size size
1908 ange-ftp-hash-mark-unit (ash size -4))
1909
1910 ;; if a default value for this is set, use that value.
1911 (or ange-ftp-binary-hash-mark-size
1912 (setq ange-ftp-binary-hash-mark-size size)))))))))
1913
1914(defun ange-ftp-get-process (host user)
888b812e
RS
1915 "Return an FTP subprocess connected to HOST and logged in as USER.
1916Create a new process if needed."
2f7ea155
RS
1917 (let* ((name (ange-ftp-ftp-process-buffer host user))
1918 (proc (get-process name)))
1919 (if (and proc (memq (process-status proc) '(run open)))
1920 proc
1921 (let ((pass (ange-ftp-quote-string
1922 (ange-ftp-get-passwd host user)))
1923 (account (ange-ftp-quote-string
1924 (ange-ftp-get-account host user))))
1925 ;; grab a suitable process.
1926 (setq proc (ange-ftp-start-process host user name))
1927
1928 ;; login to FTP server.
deec9e74
RS
1929 (if (and (ange-ftp-use-smart-gateway-p host)
1930 ange-ftp-gateway-host)
2f7ea155
RS
1931 (ange-ftp-smart-login host user pass account proc)
1932 (ange-ftp-normal-login host user pass account proc))
1933
1934 ;; Tell client to send back hash-marks as progress. It isn't usually
1935 ;; fatal if this command fails.
1936 (ange-ftp-guess-hash-mark-size proc)
1937
1938 ;; Guess at the host type.
1939 (ange-ftp-guess-host-type host user)
1940
1941 ;; Run any user-specified hooks. Note that proc, host and user are
1942 ;; dynamically bound at this point.
1943 (run-hooks 'ange-ftp-process-startup-hook))
1944 proc)))
1945
1946;; Variables for caching host and host-type
1947(defvar ange-ftp-host-cache nil)
1948(defvar ange-ftp-host-type-cache nil)
1949
1950;; If ange-ftp-host-type is called with the optional user
1951;; argument, it will attempt to guess the host type by connecting
1952;; as user, if necessary. For efficiency, I have tried to give this
1953;; optional second argument only when necessary. Have I missed any calls
1954;; to ange-ftp-host-type where it should have been supplied?
1955
1956(defun ange-ftp-host-type (host &optional user)
1957 "Return a symbol which represents the type of the HOST given.
1958If the optional argument USER is given, attempts to guess the
1959host-type by logging in as USER."
1960 (if (eq host ange-ftp-host-cache)
1961 ange-ftp-host-type-cache
1962 ;; Trigger an ftp connection, in case we need to guess at the host type.
1963 (if (and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache))
1964 ange-ftp-host-type-cache
1965 (setq ange-ftp-host-cache host
1966 ange-ftp-host-type-cache
1967 (cond ((ange-ftp-dumb-unix-host host)
1968 'dumb-unix)
d0bc419e
RS
1969;; ((and (fboundp 'ange-ftp-vos-host)
1970;; (ange-ftp-vos-host host))
1971;; 'vos)
2f7ea155
RS
1972 ((and (fboundp 'ange-ftp-vms-host)
1973 (ange-ftp-vms-host host))
1974 'vms)
1975 ((and (fboundp 'ange-ftp-mts-host)
1976 (ange-ftp-mts-host host))
1977 'mts)
1978 ((and (fboundp 'ange-ftp-cms-host)
1979 (ange-ftp-cms-host host))
1980 'cms)
1981 (t
1982 'unix))))))
1983
1984;; It would be nice to abstract the functions ange-ftp-TYPE-host and
1985;; ange-ftp-add-TYPE-host. The trick is to abstract these functions
1986;; without sacrificing speed. Also, having separate variables
1987;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to
1988;; set an alist to indicate that a host is of a given type. Even with
1989;; automatic host type recognition, setting a regexp is still a good idea
1990;; (for efficiency) if you log into a particular non-UNIX host frequently.
1991
d0bc419e 1992(defvar ange-ftp-fix-name-func-alist nil
888b812e
RS
1993 "Alist saying how to convert file name to the host's syntax.
1994Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
d0bc419e 1995which can change a UNIX file name into a name more suitable for a host of type
2f7ea155
RS
1996TYPE.")
1997
d0bc419e 1998(defvar ange-ftp-fix-dir-name-func-alist nil
888b812e
RS
1999 "Alist saying how to convert directory name to the host's syntax.
2000Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
d0bc419e 2001which can change UNIX directory name into a directory name more suitable
2f7ea155
RS
2002for a host of type TYPE.")
2003
2004;; *** Perhaps the sense of this variable should be inverted, since there
2005;; *** is only 1 host type that can take ls-style listing options.
2006(defvar ange-ftp-dumb-host-types '(dumb-unix)
2007 "List of host types that can't take UNIX ls-style listing options.")
2008
2009(defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait)
2010 "Find an ftp process connected to HOST logged in as USER and send it CMD.
2011MSG is an optional status message to be output before and after issuing the
2012command.
2013See the documentation for ange-ftp-raw-send-cmd for a description of CONT
2014and NOWAIT."
d0bc419e 2015 ;; Handle conversion to remote file name syntax and remote ls option
2f7ea155
RS
2016 ;; capability.
2017 (let ((cmd0 (car cmd))
2018 (cmd1 (nth 1 cmd))
98deaf97
RS
2019 (ange-ftp-this-user user)
2020 (ange-ftp-this-host host)
2021 (ange-ftp-this-msg msg)
d0bc419e 2022 cmd2 cmd3 host-type fix-name-func)
2f7ea155
RS
2023
2024 (cond
2025
2026 ;; pwd case (We don't care what host-type.)
2027 ((null cmd1))
2028
d0bc419e 2029 ;; cmd == 'dir "remote-name" "local-name" "ls-switches"
2f7ea155
RS
2030 ((progn
2031 (setq cmd2 (nth 2 cmd)
2032 host-type (ange-ftp-host-type host user))
2033 ;; This will trigger an FTP login, if one doesn't exist
2034 (eq cmd0 'dir))
2035 (setq cmd1 (funcall
d0bc419e 2036 (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist))
2f7ea155
RS
2037 'identity)
2038 cmd1)
2039 cmd3 (nth 3 cmd))
2040 ;; Need to deal with the HP-UX ftp bug. This should also allow
2041 ;; us to resolve symlinks to directories on SysV machines. (Sebastian will
2042 ;; be happy.)
2043 (and (eq host-type 'unix)
2044 (string-match "/$" cmd1)
2045 (not (string-match "R" cmd3))
2046 (setq cmd1 (concat cmd1 ".")))
2047 ;; If the remote ls can take switches, put them in
2048 (or (memq host-type ange-ftp-dumb-host-types)
2049 (setq cmd0 'ls
2050 cmd1 (format "\"%s %s\"" cmd3 cmd1))))
2051
d0bc419e 2052 ;; First argument is the remote name
98deaf97 2053 ((progn
d0bc419e
RS
2054 (setq fix-name-func (or (cdr (assq host-type
2055 ange-ftp-fix-name-func-alist))
2056 'identity))
2f7ea155 2057 (memq cmd0 '(get delete mkdir rmdir cd)))
d0bc419e 2058 (setq cmd1 (funcall fix-name-func cmd1)))
2f7ea155 2059
d0bc419e 2060 ;; Second argument is the remote name
2f7ea155 2061 ((memq cmd0 '(append put chmod))
d0bc419e 2062 (setq cmd2 (funcall fix-name-func cmd2)))
2f7ea155 2063
d0bc419e 2064 ;; Both arguments are remote names
2f7ea155 2065 ((eq cmd0 'rename)
d0bc419e
RS
2066 (setq cmd1 (funcall fix-name-func cmd1)
2067 cmd2 (funcall fix-name-func cmd2))))
2f7ea155
RS
2068
2069 ;; Turn the command into one long string
2070 (setq cmd0 (symbol-name cmd0))
2071 (setq cmd (concat cmd0
2072 (and cmd1 (concat " " cmd1))
2073 (and cmd2 (concat " " cmd2))))
2074
2075 ;; Actually send the resulting command.
2076 (let (afsc-result
2077 afsc-line)
2078 (ange-ftp-raw-send-cmd
2079 (ange-ftp-get-process host user)
2080 cmd
2081 msg
2082 (list
2083 (function (lambda (result line host user
2084 cmd msg cont nowait)
2085 (or cont
2086 (setq afsc-result result
2087 afsc-line line))
2088 (if result
2089 (ange-ftp-call-cont cont result line)
2090 (ange-ftp-raw-send-cmd
2091 (ange-ftp-get-process host user)
2092 cmd
2093 msg
2094 (list
2095 (function (lambda (result line cont)
2096 (or cont
2097 (setq afsc-result result
2098 afsc-line line))
2099 (ange-ftp-call-cont cont result line)))
2100 cont)
2101 nowait))))
2102 host user cmd msg cont nowait)
2103 nowait)
2104
2105 (if nowait
2106 nil
2107 (if cont
2108 nil
2109 (cons afsc-result afsc-line))))))
2110
2111;; It might be nice to message users about the host type identified,
2112;; but there is so much other messaging going on, it would not be
2113;; seen. No point in slowing things down just so users can read
2114;; a host type message.
2115
d0bc419e 2116(defconst ange-ftp-cms-name-template
2f7ea155
RS
2117 (concat
2118 "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?"
2119 "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$"))
d0bc419e 2120(defconst ange-ftp-vms-name-template
2f7ea155 2121 "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$")
d0bc419e 2122(defconst ange-ftp-mts-name-template
2f7ea155
RS
2123 "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$")
2124
2125(defun ange-ftp-guess-host-type (host user)
888b812e
RS
2126 "Guess at the the host type of HOST.
2127Works by doing a pwd and examining the directory syntax."
2f7ea155
RS
2128 (let ((host-type (ange-ftp-host-type host))
2129 (key (concat host "/" user "/~")))
2130 (if (eq host-type 'unix)
2131 ;; Note that ange-ftp-host-type returns unix as the default value.
65135ec2 2132 (save-match-data
2f7ea155
RS
2133 (let* ((result (ange-ftp-get-pwd host user))
2134 (dir (car result))
d0bc419e 2135 fix-name-func)
2f7ea155
RS
2136 (cond ((null dir)
2137 (message "Warning! Unable to get home directory")
2138 (sit-for 1)
2139 (if (string-match
2140 "^450 No current working directory defined$"
2141 (cdr result))
2142
2143 ;; We'll assume that if pwd bombs with this
2144 ;; error message, then it's CMS.
2145 (progn
2146 (ange-ftp-add-cms-host host)
2147 (setq ange-ftp-host-cache host
2148 ange-ftp-host-type-cache 'cms))))
2149
2150 ;; try for VMS
d0bc419e 2151 ((string-match ange-ftp-vms-name-template dir)
2f7ea155
RS
2152 (ange-ftp-add-vms-host host)
2153 ;; The add-host functions clear the host type cache.
2154 ;; Therefore, need to set the cache afterwards.
2155 (setq ange-ftp-host-cache host
2156 ange-ftp-host-type-cache 'vms))
2157
2158 ;; try for MTS
d0bc419e 2159 ((string-match ange-ftp-mts-name-template dir)
2f7ea155
RS
2160 (ange-ftp-add-mts-host host)
2161 (setq ange-ftp-host-cache host
2162 ange-ftp-host-type-cache 'mts))
2163
2164 ;; try for CMS
d0bc419e 2165 ((string-match ange-ftp-cms-name-template dir)
2f7ea155
RS
2166 (ange-ftp-add-cms-host host)
2167 (setq ange-ftp-host-cache host
2168 ange-ftp-host-type-cache 'cms))
2169
2170 ;; assume UN*X
2171 (t
2172 (setq ange-ftp-host-cache host
2173 ange-ftp-host-type-cache 'unix)))
2174
2175 ;; Now that we have done a pwd, might as well put it in
2176 ;; the expand-dir hashtable.
2177 (let ((ange-ftp-this-user user)
2178 (ange-ftp-this-host host))
d0bc419e
RS
2179 (setq fix-name-func (cdr (assq ange-ftp-host-type-cache
2180 ange-ftp-fix-name-func-alist)))
2181 (if fix-name-func
2182 (setq dir (funcall fix-name-func dir 'reverse))))
2f7ea155
RS
2183 (ange-ftp-put-hash-entry key dir
2184 ange-ftp-expand-dir-hashtable))))
2185
2186 ;; In the special case of CMS make sure that know the
2187 ;; expansion of the home minidisk now, because we will
2188 ;; be doing a lot of cd's.
2189 (if (and (eq host-type 'cms)
2190 (not (ange-ftp-hash-entry-exists-p
2191 key ange-ftp-expand-dir-hashtable)))
2192 (let ((dir (car (ange-ftp-get-pwd host user))))
2193 (if dir
2194 (ange-ftp-put-hash-entry key (concat "/" dir)
2195 ange-ftp-expand-dir-hashtable)
2196 (message "Warning! Unable to get home directory")
2197 (sit-for 1))))))
2198
2199\f
2200;;;; ------------------------------------------------------------
2201;;;; Remote file and directory listing support.
2202;;;; ------------------------------------------------------------
2203
888b812e
RS
2204;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands
2205;; to take switch arguments.
2f7ea155 2206(defun ange-ftp-dumb-unix-host (host)
2f7ea155 2207 (and ange-ftp-dumb-unix-host-regexp
65135ec2 2208 (save-match-data
2f7ea155
RS
2209 (string-match ange-ftp-dumb-unix-host-regexp host))))
2210
2211(defun ange-ftp-add-dumb-unix-host (host)
2212 "Interactively adds a given HOST to ange-ftp-dumb-unix-host-regexp."
2213 (interactive
2214 (list (read-string "Host: "
68f5eb5a 2215 (let ((name (or (buffer-file-name) default-directory)))
d0bc419e 2216 (and name (car (ange-ftp-ftp-name name)))))))
2f7ea155
RS
2217 (if (not (ange-ftp-dumb-unix-host host))
2218 (setq ange-ftp-dumb-unix-host-regexp
2219 (concat "^" (regexp-quote host) "$"
2220 (and ange-ftp-dumb-unix-host-regexp "\\|")
2221 ange-ftp-dumb-unix-host-regexp)
2222 ange-ftp-host-cache nil)))
2223
2224(defvar ange-ftp-parse-list-func-alist nil
888b812e
RS
2225 "Alist saying how to parse directory listings for certain OS types.
2226Association list of \( TYPE \. FUNC \) pairs. The FUNC is a routine
2f7ea155
RS
2227which can parse the output from a DIR listing for a host of type TYPE.")
2228
2229;; With no-error nil, this function returns:
d0bc419e 2230;; an error if file is not an ange-ftp-name
2f7ea155
RS
2231;; (This should never happen.)
2232;; an error if either the listing is unreadable or there is an ftp error.
2233;; the listing (a string), if everything works.
2234;;
2235;; With no-error t, it returns:
d0bc419e 2236;; an error if not an ange-ftp-name
2f7ea155
RS
2237;; error if listing is unreable (most likely caused by a slow connection)
2238;; nil if ftp error (this is because although asking to list a nonexistent
2239;; directory on a remote unix machine usually (except
2240;; maybe for dumb hosts) returns an ls error, but no
2241;; ftp error, if the same is done on a VMS machine,
2242;; an ftp error is returned. Need to trap the error
2243;; so we can go on and try to list the parent.)
2244;; the listing, if everything works.
2245
d0bc419e
RS
2246;; If WILDCARD is non-nil, then this implements the guts of insert-directory
2247;; in the wildcard case. Then we make a relative directory listing
2248;; of FILE within the directory specified by `default-directory'.
2249
2250(defun ange-ftp-ls (file lsargs parse &optional no-error wildcard)
2f7ea155
RS
2251 "Return the output of an `DIR' or `ls' command done over ftp.
2252FILE is the full name of the remote file, LSARGS is any args to pass to the
2253`ls' command, and PARSE specifies that the output should be parsed and stored
2254away in the internal cache."
2255 ;; If parse is t, we assume that file is a directory. i.e. we only parse
2256 ;; full directory listings.
2257 (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file))
d0bc419e 2258 (parsed (ange-ftp-ftp-name ange-ftp-this-file)))
2f7ea155
RS
2259 (if parsed
2260 (let* ((host (nth 0 parsed))
2261 (user (nth 1 parsed))
d0bc419e 2262 (name (ange-ftp-quote-string (nth 2 parsed)))
2f7ea155
RS
2263 (key (directory-file-name ange-ftp-this-file))
2264 (host-type (ange-ftp-host-type host user))
2265 (dumb (memq host-type ange-ftp-dumb-host-types))
2266 result
2267 temp
2268 lscmd parse-func)
d0bc419e
RS
2269 (if (string-equal name "")
2270 (setq name
2f7ea155
RS
2271 (ange-ftp-real-file-name-as-directory
2272 (ange-ftp-expand-dir host user "~"))))
2273 (if (and ange-ftp-ls-cache-file
2274 (string-equal key ange-ftp-ls-cache-file)
2275 ;; Don't care about lsargs for dumb hosts.
2276 (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs)))
2277 ange-ftp-ls-cache-res
2278 (setq temp (ange-ftp-make-tmp-name host))
d0bc419e
RS
2279 (if wildcard
2280 (progn
2281 (ange-ftp-cd host user (file-name-directory name))
2282 (setq lscmd (list 'dir file temp lsargs)))
2283 (setq lscmd (list 'dir name temp lsargs)))
2f7ea155
RS
2284 (unwind-protect
2285 (if (car (setq result (ange-ftp-send-cmd
2286 host
2287 user
2288 lscmd
2289 (format "Listing %s"
2290 (ange-ftp-abbreviate-filename
2291 ange-ftp-this-file)))))
2292 (save-excursion
2293 (set-buffer (get-buffer-create
2294 ange-ftp-data-buffer-name))
2295 (erase-buffer)
2296 (if (ange-ftp-real-file-readable-p temp)
2297 (ange-ftp-real-insert-file-contents temp)
2298 (sleep-for ange-ftp-retry-time)
2299 ;wait for file to possibly appear
2300 (if (ange-ftp-real-file-readable-p temp)
2301 ;; Try again.
2302 (ange-ftp-real-insert-file-contents temp)
2303 (ange-ftp-error host user
2304 (format
2305 "list data file %s not readable"
2306 temp))))
2307 (if parse
2308 (ange-ftp-set-files
2309 ange-ftp-this-file
2310 (if (setq
2311 parse-func
2312 (cdr (assq host-type
2313 ange-ftp-parse-list-func-alist)))
2314 (funcall parse-func)
2315 (ange-ftp-parse-dired-listing lsargs))))
2316 (setq ange-ftp-ls-cache-file key
2317 ange-ftp-ls-cache-lsargs lsargs
2318 ; For dumb hosts-types this is
2319 ; meaningless but harmless.
2320 ange-ftp-ls-cache-res (buffer-string))
2321 ;; (kill-buffer (current-buffer))
2322 ange-ftp-ls-cache-res)
2323 (if no-error
2324 nil
2325 (ange-ftp-error host user
2326 (concat "DIR failed: " (cdr result)))))
2327 (ange-ftp-del-tmp-name temp))))
2328 (error "Should never happen. Please report. Bug ref. no.: 1"))))
2329\f
2330;;;; ------------------------------------------------------------
2331;;;; Directory information caching support.
2332;;;; ------------------------------------------------------------
2333
2334(defconst ange-ftp-date-regexp
2335 (concat
2336 " \\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct"
2337 "\\|Nov\\|Dec\\) +[0-3]?[0-9] "))
2338
2339(defvar ange-ftp-add-file-entry-alist nil
085fa795 2340 "Alist saying how to add file entries on certain OS types.
888b812e 2341Association list of pairs \( TYPE \. FUNC \), where FUNC
2f7ea155
RS
2342is a function to be used to add a file entry for the OS TYPE. The
2343main reason for this alist is to deal with file versions in VMS.")
2344
2345(defvar ange-ftp-delete-file-entry-alist nil
888b812e
RS
2346 "Alist saying how to delete files on certain OS types.
2347Association list of pairs \( TYPE \. FUNC \), where FUNC
2f7ea155 2348is a function to be used to delete a file entry for the OS TYPE.
888b812e 2349The main reason for this alist is to deal with file versions in VMS.")
2f7ea155 2350
d0bc419e
RS
2351(defun ange-ftp-add-file-entry (name &optional dir-p)
2352 "Add a file entry for file NAME, if its directory info exists."
2f7ea155 2353 (funcall (or (cdr (assq (ange-ftp-host-type
d0bc419e 2354 (car (ange-ftp-ftp-name name)))
2f7ea155
RS
2355 ange-ftp-add-file-entry-alist))
2356 'ange-ftp-internal-add-file-entry)
d0bc419e 2357 name dir-p)
2f7ea155
RS
2358 (setq ange-ftp-ls-cache-file nil))
2359
d0bc419e
RS
2360(defun ange-ftp-delete-file-entry (name &optional dir-p)
2361 "Delete the file entry for file NAME, if its directory info exists."
2f7ea155 2362 (funcall (or (cdr (assq (ange-ftp-host-type
d0bc419e 2363 (car (ange-ftp-ftp-name name)))
2f7ea155
RS
2364 ange-ftp-delete-file-entry-alist))
2365 'ange-ftp-internal-delete-file-entry)
d0bc419e 2366 name dir-p)
2f7ea155
RS
2367 (setq ange-ftp-ls-cache-file nil))
2368
2369(defmacro ange-ftp-parse-filename ()
2370 ;;Extract the filename from the current line of a dired-like listing.
2371 (` (let ((eol (progn (end-of-line) (point))))
2372 (beginning-of-line)
2373 (if (re-search-forward ange-ftp-date-regexp eol t)
2374 (progn
2375 (skip-chars-forward " ")
2376 (skip-chars-forward "^ " eol)
2377 (skip-chars-forward " " eol)
2378 ;; We bomb on filenames starting with a space.
2379 (buffer-substring (point) eol))))))
2380
2381;; This deals with the F switch. Should also do something about
2382;; unquoting names obtained with the SysV b switch and the GNU Q
2383;; switch. See Sebastian's dired-get-filename.
2384
2385(defmacro ange-ftp-ls-parser ()
2386 ;; Note that switches is dynamically bound.
2387 ;; Meant to be called by ange-ftp-parse-dired-listing
2388 (` (let ((tbl (ange-ftp-make-hashtable))
2389 (used-F (and (stringp switches)
2390 (string-match "F" switches)))
2391 file-type symlink directory file)
2392 (while (setq file (ange-ftp-parse-filename))
2393 (beginning-of-line)
2394 (skip-chars-forward "\t 0-9")
2395 (setq file-type (following-char)
2396 directory (eq file-type ?d))
2397 (if (eq file-type ?l)
2398 (if (string-match " -> " file)
2399 (setq symlink (substring file (match-end 0))
2400 file (substring file 0 (match-beginning 0)))
2401 ;; Shouldn't happen
2402 (setq symlink ""))
2403 (setq symlink nil))
2404 ;; Only do a costly regexp search if the F switch was used.
2405 (if (and used-F
2406 (not (string-equal file ""))
2407 (looking-at
2408 ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"))
2409 (let ((socket (eq file-type ?s))
2410 (executable
2411 (and (not symlink) ; x bits don't mean a thing for symlinks
2412 (string-match "[xst]"
2413 (concat
2414 (buffer-substring
2415 (match-beginning 1)
2416 (match-end 1))
2417 (buffer-substring
2418 (match-beginning 2)
2419 (match-end 2))
2420 (buffer-substring
2421 (match-beginning 3)
2422 (match-end 3)))))))
2423 ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX)
2424 ;; and others don't. (sigh...) Beware, that some Unix's don't
2425 ;; seem to believe in the F-switch
2426 (if (or (and symlink (string-match "@$" file))
2427 (and directory (string-match "/$" file))
2428 (and executable (string-match "*$" file))
2429 (and socket (string-match "=$" file)))
2430 (setq file (substring file 0 -1)))))
2431 (ange-ftp-put-hash-entry file (or symlink directory) tbl)
2432 (forward-line 1))
2433 (ange-ftp-put-hash-entry "." t tbl)
2434 (ange-ftp-put-hash-entry ".." t tbl)
2435 tbl)))
2436
2437;;; The dl stuff for descriptive listings
2438
2439(defvar ange-ftp-dl-dir-regexp nil
888b812e
RS
2440 "Regexp matching directories which are listed in dl format.
2441This regexp should not be anchored with a trailing `$', because it should
2442match subdirectories as well.")
2f7ea155
RS
2443
2444(defun ange-ftp-add-dl-dir (dir)
c8fa98cc 2445 "Interactively adds a DIR to ange-ftp-dl-dir-regexp."
2f7ea155
RS
2446 (interactive
2447 (list (read-string "Directory: "
68f5eb5a 2448 (let ((name (or (buffer-file-name) default-directory)))
d0bc419e 2449 (and name (ange-ftp-ftp-name name)
2f7ea155
RS
2450 (file-name-directory name))))))
2451 (if (not (and ange-ftp-dl-dir-regexp
2452 (string-match ange-ftp-dl-dir-regexp dir)))
2453 (setq ange-ftp-dl-dir-regexp
2454 (concat "^" (regexp-quote dir)
2455 (and ange-ftp-dl-dir-regexp "\\|")
2456 ange-ftp-dl-dir-regexp))))
2457
2458(defmacro ange-ftp-dl-parser ()
2459 ;; Parse the current buffer, which is assumed to be a descriptive
2460 ;; listing, and return a hashtable.
2461 (` (let ((tbl (ange-ftp-make-hashtable)))
2462 (while (not (eobp))
2463 (ange-ftp-put-hash-entry
2464 (buffer-substring (point)
2465 (progn
2466 (skip-chars-forward "^ /\n")
2467 (point)))
2468 (eq (following-char) ?/)
2469 tbl)
2470 (forward-line 1))
2471 (ange-ftp-put-hash-entry "." t tbl)
2472 (ange-ftp-put-hash-entry ".." t tbl)
2473 tbl)))
2474
888b812e
RS
2475;; Parse the current buffer which is assumed to be in a dired-like listing
2476;; format, and return a hashtable as the result. If the listing is not really
2477;; a listing, then return nil.
2478
2f7ea155 2479(defun ange-ftp-parse-dired-listing (&optional switches)
65135ec2 2480 (save-match-data
2f7ea155
RS
2481 (cond
2482 ((looking-at "^total [0-9]+$")
2483 (forward-line 1)
7ce370e1
RS
2484 ;; Some systems put in a blank line here.
2485 (if (eolp) (forward-line 1))
2f7ea155
RS
2486 (ange-ftp-ls-parser))
2487 ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'")
2488 ;; It's an ls error message.
2489 nil)
2490 ((eobp) ; i.e. (zerop (buffer-size))
2491 ;; This could be one of:
2492 ;; (1) An Ultrix ls error message
2493 ;; (2) A listing with the A switch of an empty directory
2494 ;; on a machine which doesn't give a total line.
2495 ;; (3) The twilight zone.
2496 ;; We'll assume (1) for now.
2497 nil)
2498 ((re-search-forward ange-ftp-date-regexp nil t)
2499 (beginning-of-line)
2500 (ange-ftp-ls-parser))
2501 ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t)
2502 ;; It's a dl listing (I hope).
2503 ;; file is bound by the call to ange-ftp-ls
2504 (ange-ftp-add-dl-dir ange-ftp-this-file)
2505 (beginning-of-line)
2506 (ange-ftp-dl-parser))
2507 (t nil))))
2508
2509(defun ange-ftp-set-files (directory files)
2510 "For a given DIRECTORY, set or change the associated FILES hashtable."
2511 (and files (ange-ftp-put-hash-entry (file-name-as-directory directory)
2512 files ange-ftp-files-hashtable)))
2513
2514(defun ange-ftp-get-files (directory &optional no-error)
2515 "Given a given DIRECTORY, return a hashtable of file entries.
2516This will give an error or return nil, depending on the value of
2517NO-ERROR, if a listing for DIRECTORY cannot be obtained."
2518 (setq directory (file-name-as-directory directory)) ;normalize
2519 (or (ange-ftp-get-hash-entry directory ange-ftp-files-hashtable)
65135ec2 2520 (save-match-data
2f7ea155
RS
2521 (and (ange-ftp-ls directory
2522 ;; This is an efficiency hack. We try to
2523 ;; anticipate what sort of listing dired
2524 ;; might want, and cache just such a listing.
2525 (if (and (boundp 'dired-actual-switches)
2526 (stringp dired-actual-switches)
2527 ;; We allow the A switch, which lists
2528 ;; all files except "." and "..".
2529 ;; This is OK because we manually
2530 ;; insert these entries
2531 ;; in the hash table.
2532 (string-match
2533 "[aA]" dired-actual-switches)
2534 (string-match
2535 "l" dired-actual-switches)
2536 (not (string-match
2537 "R" dired-actual-switches)))
2538 dired-actual-switches
2539 (if (and (boundp 'dired-listing-switches)
2540 (stringp dired-listing-switches)
2541 (string-match
2542 "[aA]" dired-listing-switches)
2543 (string-match
2544 "l" dired-listing-switches)
2545 (not (string-match
2546 "R" dired-listing-switches)))
2547 dired-listing-switches
2548 "-al"))
2549 t no-error)
2550 (ange-ftp-get-hash-entry
2551 directory ange-ftp-files-hashtable)))))
2552
888b812e
RS
2553;; Given NAME, return the file part that can be used for looking up the
2554;; file's entry in a hashtable.
d0bc419e 2555(defmacro ange-ftp-get-file-part (name)
d0bc419e 2556 (` (let ((file (file-name-nondirectory (, name))))
2f7ea155
RS
2557 (if (string-equal file "")
2558 "."
2559 file))))
2560
888b812e
RS
2561;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are
2562;; allowed to determine if NAME is a sub-directory by listing it directly,
2563;; rather than listing its parent directory. This is used for efficiency so
2564;; that a wasted listing is not done:
2565;; 1. When looking for a .dired file in dired-x.el.
2566;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid
2567;; subdirectory. This is of course an OS dependent judgement.
2568
2f7ea155 2569(defmacro ange-ftp-allow-child-lookup (dir file)
2f7ea155
RS
2570 (` (not
2571 (let* ((efile (, file)) ; expand once.
2572 (edir (, dir))
d0bc419e 2573 (parsed (ange-ftp-ftp-name edir))
2f7ea155
RS
2574 (host-type (ange-ftp-host-type
2575 (car parsed))))
2576 (or
68f5eb5a
RS
2577;;; This variable seems not to exist in Emacs 19 -- rms.
2578;;; ;; Deal with dired
2579;;; (and (boundp 'dired-local-variables-file)
2580;;; (stringp dired-local-variables-file)
2581;;; (string-equal dired-local-variables-file efile))
2f7ea155
RS
2582 ;; No dots in dir names in vms.
2583 (and (eq host-type 'vms)
2584 (string-match "\\." efile))
2585 ;; No subdirs in mts of cms.
2586 (and (memq host-type '(mts cms))
2587 (not (string-equal "/" (nth 2 parsed)))))))))
2588
d0bc419e
RS
2589(defun ange-ftp-file-entry-p (name)
2590 "Given NAME, return whether there is a file entry for it."
2591 (let* ((name (directory-file-name name))
2592 (dir (file-name-directory name))
2f7ea155 2593 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
d0bc419e 2594 (file (ange-ftp-get-file-part name)))
2f7ea155
RS
2595 (if ent
2596 (ange-ftp-hash-entry-exists-p file ent)
2597 (or (and (ange-ftp-allow-child-lookup dir file)
d0bc419e 2598 (setq ent (ange-ftp-get-files name t))
2f7ea155
RS
2599 ;; Try a child lookup. i.e. try to list file as a
2600 ;; subdirectory of dir. This is a good idea because
2601 ;; we may not have read permission for file's parent. Also,
2602 ;; people tend to work down directory trees anyway. We use
2603 ;; no-error ;; because if file does not exist as a subdir.,
2604 ;; then dumb hosts will give an ftp error. Smart unix hosts
2605 ;; will simply send back the ls
2606 ;; error message.
2607 (ange-ftp-get-hash-entry "." ent))
2608 ;; Child lookup failed. Try the parent. If this bombs,
2609 ;; we are at wits end -- signal an error.
2610 ;; Problem: If this signals an error, the error message
2611 ;; may not have a lot to do with what went wrong.
2612 (ange-ftp-hash-entry-exists-p file
2613 (ange-ftp-get-files dir))))))
2614
d0bc419e 2615(defun ange-ftp-get-file-entry (name)
c8fa98cc
CZ
2616 "Given NAME, return the given file entry.
2617The entry will be either t for a directory, nil for a normal file,
2618or a string for a symlink. If the file isn't in the hashtable,
2619this also returns nil."
d0bc419e
RS
2620 (let* ((name (directory-file-name name))
2621 (dir (file-name-directory name))
2f7ea155 2622 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
d0bc419e 2623 (file (ange-ftp-get-file-part name)))
2f7ea155
RS
2624 (if ent
2625 (ange-ftp-get-hash-entry file ent)
2626 (or (and (ange-ftp-allow-child-lookup dir file)
d0bc419e 2627 (setq ent (ange-ftp-get-files name t))
2f7ea155
RS
2628 (ange-ftp-get-hash-entry "." ent))
2629 ;; i.e. it's a directory by child lookup
2630 (ange-ftp-get-hash-entry file
2631 (ange-ftp-get-files dir))))))
2632
d0bc419e 2633(defun ange-ftp-internal-delete-file-entry (name &optional dir-p)
2f7ea155
RS
2634 (if dir-p
2635 (progn
d0bc419e
RS
2636 (setq name (file-name-as-directory name))
2637 (ange-ftp-del-hash-entry name ange-ftp-files-hashtable)
2638 (setq name (directory-file-name name))))
2f7ea155
RS
2639 ;; Note that file-name-as-directory followed by directory-file-name
2640 ;; serves to canonicalize directory file names to their unix form.
2641 ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO
d0bc419e 2642 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2f7ea155
RS
2643 ange-ftp-files-hashtable)))
2644 (if files
d0bc419e 2645 (ange-ftp-del-hash-entry (ange-ftp-get-file-part name)
2f7ea155
RS
2646 files))))
2647
d0bc419e 2648(defun ange-ftp-internal-add-file-entry (name &optional dir-p)
2f7ea155 2649 (and dir-p
d0bc419e
RS
2650 (setq name (directory-file-name name)))
2651 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2f7ea155
RS
2652 ange-ftp-files-hashtable)))
2653 (if files
d0bc419e 2654 (ange-ftp-put-hash-entry (ange-ftp-get-file-part name)
2f7ea155
RS
2655 dir-p
2656 files))))
2657
2658(defun ange-ftp-wipe-file-entries (host user)
888b812e 2659 "Get rid of entry for HOST, USER pair from file entry information hashtable."
2f7ea155
RS
2660 (let ((new-tbl (ange-ftp-make-hashtable (length ange-ftp-files-hashtable))))
2661 (ange-ftp-map-hashtable
2662 (function
2663 (lambda (key val)
d0bc419e 2664 (let ((parsed (ange-ftp-ftp-name key)))
2f7ea155
RS
2665 (if parsed
2666 (let ((h (nth 0 parsed))
2667 (u (nth 1 parsed)))
2668 (or (and (equal host h) (equal user u))
2669 (ange-ftp-put-hash-entry key val new-tbl)))))))
2670 ange-ftp-files-hashtable)
2671 (setq ange-ftp-files-hashtable new-tbl)))
2672\f
2673;;;; ------------------------------------------------------------
2674;;;; File transfer mode support.
2675;;;; ------------------------------------------------------------
2676
2677(defun ange-ftp-set-binary-mode (host user)
2678 "Tell the ftp process for the given HOST & USER to switch to binary mode."
2679 (let ((result (ange-ftp-send-cmd host user '(type "binary"))))
2680 (if (not (car result))
2681 (ange-ftp-error host user (concat "BINARY failed: " (cdr result)))
2682 (save-excursion
2683 (set-buffer (process-buffer (ange-ftp-get-process host user)))
cf18c844
KH
2684 (and ange-ftp-binary-hash-mark-size
2685 (setq ange-ftp-hash-mark-unit
2686 (ash ange-ftp-binary-hash-mark-size -4)))))))
2f7ea155
RS
2687
2688(defun ange-ftp-set-ascii-mode (host user)
2689 "Tell the ftp process for the given HOST & USER to switch to ascii mode."
2690 (let ((result (ange-ftp-send-cmd host user '(type "ascii"))))
2691 (if (not (car result))
2692 (ange-ftp-error host user (concat "ASCII failed: " (cdr result)))
2693 (save-excursion
2694 (set-buffer (process-buffer (ange-ftp-get-process host user)))
cf18c844
KH
2695 (and ange-ftp-ascii-hash-mark-size
2696 (setq ange-ftp-hash-mark-unit
2697 (ash ange-ftp-ascii-hash-mark-size -4)))))))
2f7ea155
RS
2698\f
2699(defun ange-ftp-cd (host user dir)
2700 (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD")))
2701 (or (car result)
2702 (ange-ftp-error host user (concat "CD failed: " (cdr result))))))
2703
2704(defun ange-ftp-get-pwd (host user)
2705 "Attempts to get the current working directory for the given HOST/USER pair.
2706Returns \( DIR . LINE \) where DIR is either the directory or NIL if not found,
2707and LINE is the relevant success or fail line from the FTP-client."
2708 (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD"))
2709 (line (cdr result))
2710 dir)
2711 (if (car result)
65135ec2 2712 (save-match-data
2f7ea155
RS
2713 (and (or (string-match "\"\\([^\"]*\\)\"" line)
2714 (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers!
2715 (setq dir (substring line
2716 (match-beginning 1)
2717 (match-end 1))))))
2718 (cons dir line)))
2719\f
2720;;; ------------------------------------------------------------
2721;;; expand-file-name and friends...which currently don't work
2722;;; ------------------------------------------------------------
2723
2724(defun ange-ftp-expand-dir (host user dir)
888b812e
RS
2725 "Return the result of doing a PWD in the current FTP session.
2726Use the connection to machine HOST
2f7ea155
RS
2727logged in as user USER and cd'd to directory DIR."
2728 (let* ((host-type (ange-ftp-host-type host user))
2729 ;; It is more efficient to call ange-ftp-host-type
2730 ;; before binding res, because ange-ftp-host-type sometimes
2731 ;; adds to the info in the expand-dir-hashtable.
d0bc419e
RS
2732 (fix-name-func
2733 (cdr (assq host-type ange-ftp-fix-name-func-alist)))
2f7ea155
RS
2734 (key (concat host "/" user "/" dir))
2735 (res (ange-ftp-get-hash-entry key ange-ftp-expand-dir-hashtable)))
2736 (or res
2737 (progn
2738 (or
2739 (string-equal user "anonymous")
2740 (string-equal user "ftp")
2741 (not (eq host-type 'unix))
2742 (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp
2743 "\\|"
2744 ange-ftp-good-msgs))
2745 (result (ange-ftp-send-cmd host user
2746 (list 'get dir "/dev/null")
2747 (format "expanding %s" dir)))
2748 (line (cdr result)))
2749 (setq res
2750 (if (string-match ange-ftp-expand-dir-regexp line)
2751 (substring line
2752 (match-beginning 1)
2753 (match-end 1))))))
2754 (or res
2755 (if (string-equal dir "~")
2756 (setq res (car (ange-ftp-get-pwd host user)))
2757 (let ((home (ange-ftp-expand-dir host user "~")))
2758 (unwind-protect
2759 (and (ange-ftp-cd host user dir)
2760 (setq res (car (ange-ftp-get-pwd host user))))
2761 (ange-ftp-cd host user home)))))
2762 (if res
2763 (let ((ange-ftp-this-user user)
2764 (ange-ftp-this-host host))
d0bc419e
RS
2765 (if fix-name-func
2766 (setq res (funcall fix-name-func res 'reverse)))
2f7ea155
RS
2767 (ange-ftp-put-hash-entry
2768 key res ange-ftp-expand-dir-hashtable)))
2769 res))))
2770
2771(defun ange-ftp-canonize-filename (n)
2772 "Take a string and short-circuit //, /. and /.."
23553df0 2773 (if (string-match "[^:]+//" n) ;don't upset Apollo users
2f7ea155 2774 (setq n (substring n (1- (match-end 0)))))
d0bc419e 2775 (let ((parsed (ange-ftp-ftp-name n)))
2f7ea155
RS
2776 (if parsed
2777 (let ((host (car parsed))
2778 (user (nth 1 parsed))
d0bc419e 2779 (name (nth 2 parsed)))
2f7ea155 2780
d0bc419e
RS
2781 ;; See if remote name is absolute. If so then just expand it and
2782 ;; replace the name component of the overall name.
2783 (cond ((string-match "^/" name)
2784 name)
2f7ea155 2785
d0bc419e 2786 ;; Name starts with ~ or ~user. Resolve that part of the name
2f7ea155 2787 ;; making it absolute then re-expand it.
d0bc419e
RS
2788 ((string-match "^~[^/]*" name)
2789 (let* ((tilda (substring name
2f7ea155
RS
2790 (match-beginning 0)
2791 (match-end 0)))
d0bc419e 2792 (rest (substring name (match-end 0)))
2f7ea155
RS
2793 (dir (ange-ftp-expand-dir host user tilda)))
2794 (if dir
d0bc419e 2795 (setq name (concat dir rest))
2f7ea155
RS
2796 (error "User \"%s\" is not known"
2797 (substring tilda 1)))))
2798
d0bc419e 2799 ;; relative name. Tack on homedir and re-expand.
2f7ea155
RS
2800 (t
2801 (let ((dir (ange-ftp-expand-dir host user "~")))
2802 (if dir
d0bc419e 2803 (setq name (concat
2f7ea155 2804 (ange-ftp-real-file-name-as-directory dir)
d0bc419e 2805 name))
2f7ea155
RS
2806 (error "Unable to obtain CWD")))))
2807
23553df0 2808 ;; If name starts with //, preserve that, for apollo system.
97c6019c 2809 (if (not (string-match "^//" name))
23553df0 2810 (progn
97c6019c 2811 (setq name (ange-ftp-real-expand-file-name name))
23553df0 2812
97c6019c
RS
2813 (if (string-match "^//" name)
2814 (setq name (substring name 1)))))
2f7ea155 2815
d0bc419e
RS
2816 ;; Now substitute the expanded name back into the overall filename.
2817 (ange-ftp-replace-name-component n name))
2f7ea155 2818
d0bc419e 2819 ;; non-ange-ftp name. Just expand normally.
2f7ea155
RS
2820 (if (eq (string-to-char n) ?/)
2821 (ange-ftp-real-expand-file-name n)
2822 (ange-ftp-real-expand-file-name
2823 (ange-ftp-real-file-name-nondirectory n)
2824 (ange-ftp-real-file-name-directory n))))))
2825
2826(defun ange-ftp-expand-file-name (name &optional default)
2827 "Documented as original."
65135ec2 2828 (save-match-data
2f7ea155 2829 (if (eq (string-to-char name) ?/)
23553df0 2830 (while (cond ((string-match "[^:]+//" name) ;don't upset Apollo users
2f7ea155
RS
2831 (setq name (substring name (1- (match-end 0)))))
2832 ((string-match "/~" name)
2833 (setq name (substring name (1- (match-end 0))))))))
2834 (cond ((eq (string-to-char name) ?~)
2835 (ange-ftp-real-expand-file-name name))
2836 ((eq (string-to-char name) ?/)
2837 (ange-ftp-canonize-filename name))
2838 ((zerop (length name))
2839 (ange-ftp-canonize-filename (or default default-directory)))
2840 ((ange-ftp-canonize-filename
2841 (concat (file-name-as-directory (or default default-directory))
2842 name))))))
2843\f
2844;;; These are problems--they are currently not enabled.
2845
2846(defvar ange-ftp-file-name-as-directory-alist nil
888b812e 2847 "Association list of \( TYPE \. FUNC \) pairs.
2f7ea155
RS
2848FUNC converts a filename to a directory name for the operating
2849system TYPE.")
2850
2851(defun ange-ftp-file-name-as-directory (name)
2852 "Documented as original."
d0bc419e 2853 (let ((parsed (ange-ftp-ftp-name name)))
2f7ea155
RS
2854 (if parsed
2855 (if (string-equal (nth 2 parsed) "")
2856 name
2857 (funcall (or (cdr (assq
2858 (ange-ftp-host-type (car parsed))
2859 ange-ftp-file-name-as-directory-alist))
2860 'ange-ftp-real-file-name-as-directory)
2861 name))
2862 (ange-ftp-real-file-name-as-directory name))))
2863
2864(defun ange-ftp-file-name-directory (name)
2865 "Documented as original."
d0bc419e 2866 (let ((parsed (ange-ftp-ftp-name name)))
2f7ea155 2867 (if parsed
d0bc419e 2868 (let ((filename (nth 2 parsed)))
65135ec2 2869 (if (save-match-data
d0bc419e 2870 (string-match "^~[^/]*$" filename))
2f7ea155 2871 name
d0bc419e 2872 (ange-ftp-replace-name-component
2f7ea155 2873 name
d0bc419e 2874 (ange-ftp-real-file-name-directory filename))))
2f7ea155
RS
2875 (ange-ftp-real-file-name-directory name))))
2876
2877(defun ange-ftp-file-name-nondirectory (name)
2878 "Documented as original."
d0bc419e 2879 (let ((parsed (ange-ftp-ftp-name name)))
2f7ea155 2880 (if parsed
8feebd07 2881 (let ((filename (nth 2 parsed)))
65135ec2 2882 (if (save-match-data
8feebd07 2883 (string-match "^~[^/]*$" filename))
2f7ea155 2884 ""
d0bc419e 2885 (ange-ftp-real-file-name-nondirectory name)))
2f7ea155
RS
2886 (ange-ftp-real-file-name-nondirectory name))))
2887
2888(defun ange-ftp-directory-file-name (dir)
2889 "Documented as original."
d0bc419e 2890 (let ((parsed (ange-ftp-ftp-name dir)))
2f7ea155 2891 (if parsed
d0bc419e 2892 (ange-ftp-replace-name-component
2f7ea155
RS
2893 dir
2894 (ange-ftp-real-directory-file-name (nth 2 parsed)))
2895 (ange-ftp-real-directory-file-name dir))))
2896
2897\f
2898;;; Hooks that handle Emacs primitives.
2899
d0bc419e 2900;; Returns non-nil if should transfer FILE in binary mode.
2f7ea155 2901(defun ange-ftp-binary-file (file)
65135ec2 2902 (save-match-data
2f7ea155
RS
2903 (string-match ange-ftp-binary-file-name-regexp file)))
2904
2905(defun ange-ftp-write-region (start end filename &optional append visit)
2f7ea155 2906 (setq filename (expand-file-name filename))
d0bc419e 2907 (let ((parsed (ange-ftp-ftp-name filename)))
2f7ea155
RS
2908 (if parsed
2909 (let* ((host (nth 0 parsed))
2910 (user (nth 1 parsed))
d0bc419e 2911 (name (ange-ftp-quote-string (nth 2 parsed)))
2f7ea155 2912 (temp (ange-ftp-make-tmp-name host))
6807c701
RS
2913 (binary (or (ange-ftp-binary-file filename)
2914 (eq (ange-ftp-host-type host user) 'unix)))
2f7ea155
RS
2915 (cmd (if append 'append 'put))
2916 (abbr (ange-ftp-abbreviate-filename filename)))
2917 (unwind-protect
2918 (progn
2919 (let ((executing-macro t)
2920 (filename (buffer-file-name))
2921 (mod-p (buffer-modified-p)))
2922 (unwind-protect
2923 (ange-ftp-real-write-region start end temp nil visit)
2924 ;; cleanup forms
2925 (setq buffer-file-name filename)
2926 (set-buffer-modified-p mod-p)))
2927 (if binary
2928 (ange-ftp-set-binary-mode host user))
2929
2930 ;; tell the process filter what size the transfer will be.
2931 (let ((attr (file-attributes temp)))
2932 (if attr
2933 (ange-ftp-set-xfer-size host user (nth 7 attr))))
2934
2935 ;; put or append the file.
2936 (let ((result (ange-ftp-send-cmd host user
d0bc419e 2937 (list cmd temp name)
2f7ea155
RS
2938 (format "Writing %s" abbr))))
2939 (or (car result)
2940 (signal 'ftp-error
2941 (list
2942 "Opening output file"
2943 (format "FTP Error: \"%s\"" (cdr result))
2944 filename)))))
2945 (ange-ftp-del-tmp-name temp)
2946 (if binary
2947 (ange-ftp-set-ascii-mode host user)))
2948 (if (eq visit t)
2949 (progn
aec81cb6 2950 (set-visited-file-modtime '(0 0))
2f7ea155
RS
2951 (ange-ftp-set-buffer-mode)
2952 (setq buffer-file-name filename)
2953 (set-buffer-modified-p nil)))
2954 (ange-ftp-message "Wrote %s" abbr)
2955 (ange-ftp-add-file-entry filename))
2956 (ange-ftp-real-write-region start end filename append visit))))
2957
21cbf919 2958(defun ange-ftp-insert-file-contents (filename &optional visit beg end replace)
2f7ea155
RS
2959 (barf-if-buffer-read-only)
2960 (setq filename (expand-file-name filename))
d0bc419e 2961 (let ((parsed (ange-ftp-ftp-name filename)))
2f7ea155
RS
2962 (if parsed
2963 (progn
2964 (if visit
2965 (setq buffer-file-name filename))
2966 (if (or (file-exists-p filename)
2967 (progn
2968 (setq ange-ftp-ls-cache-file nil)
2969 (ange-ftp-del-hash-entry (file-name-directory filename)
2970 ange-ftp-files-hashtable)
2971 (file-exists-p filename)))
2972 (let* ((host (nth 0 parsed))
2973 (user (nth 1 parsed))
d0bc419e 2974 (name (ange-ftp-quote-string (nth 2 parsed)))
2f7ea155 2975 (temp (ange-ftp-make-tmp-name host))
6807c701
RS
2976 (binary (or (ange-ftp-binary-file filename)
2977 (eq (ange-ftp-host-type host user) 'unix)))
2f7ea155
RS
2978 (abbr (ange-ftp-abbreviate-filename filename))
2979 size)
2980 (unwind-protect
2981 (progn
2982 (if binary
2983 (ange-ftp-set-binary-mode host user))
2984 (let ((result (ange-ftp-send-cmd host user
d0bc419e 2985 (list 'get name temp)
2f7ea155
RS
2986 (format "Retrieving %s" abbr))))
2987 (or (car result)
2988 (signal 'ftp-error
2989 (list
2990 "Opening input file"
2991 (format "FTP Error: \"%s\"" (cdr result))
2992 filename))))
2993 (if (or (ange-ftp-real-file-readable-p temp)
2994 (sleep-for ange-ftp-retry-time)
2995 ;; Wait for file to hopefully appear.
2996 (ange-ftp-real-file-readable-p temp))
2997 (setq
2998 size
21cbf919
RS
2999 (nth 1 (ange-ftp-real-insert-file-contents
3000 temp visit beg end replace)))
2f7ea155
RS
3001 (signal 'ftp-error
3002 (list
3003 "Opening input file:"
3004 (format
3005 "FTP Error: %s not arrived or readable"
3006 filename)))))
3007 (if binary
3008 (ange-ftp-set-ascii-mode host user))
3009 (ange-ftp-del-tmp-name temp))
3010 (if visit
aec81cb6
RS
3011 (progn
3012 (set-visited-file-modtime '(0 0))
3013 (setq buffer-file-name filename)))
2f7ea155
RS
3014 (list filename size))
3015 (signal 'file-error
3016 (list
3017 "Opening input file"
3018 filename))))
21cbf919 3019 (ange-ftp-real-insert-file-contents filename visit beg end replace))))
2f7ea155 3020
2f7ea155
RS
3021(defun ange-ftp-expand-symlink (file dir)
3022 (if (file-name-absolute-p file)
d0bc419e 3023 (ange-ftp-replace-name-component dir file)
2f7ea155
RS
3024 (expand-file-name file dir)))
3025
3026(defun ange-ftp-file-symlink-p (file)
2f7ea155
RS
3027 ;; call ange-ftp-expand-file-name rather than the normal
3028 ;; expand-file-name to stop loops when using a package that
3029 ;; redefines both file-symlink-p and expand-file-name.
3030 (setq file (ange-ftp-expand-file-name file))
d0bc419e 3031 (if (ange-ftp-ftp-name file)
2f7ea155
RS
3032 (let ((file-ent
3033 (ange-ftp-get-hash-entry
3034 (ange-ftp-get-file-part file)
3035 (ange-ftp-get-files (file-name-directory file)))))
3036 (if (stringp file-ent)
3037 (if (file-name-absolute-p file-ent)
d0bc419e 3038 (ange-ftp-replace-name-component
2f7ea155
RS
3039 (file-name-directory file) file-ent)
3040 file-ent)))
3041 (ange-ftp-real-file-symlink-p file)))
3042
d0bc419e
RS
3043(defun ange-ftp-file-exists-p (name)
3044 (setq name (expand-file-name name))
3045 (if (ange-ftp-ftp-name name)
3046 (if (ange-ftp-file-entry-p name)
3047 (let ((file-ent (ange-ftp-get-file-entry name)))
2f7ea155
RS
3048 (if (stringp file-ent)
3049 (file-exists-p
3050 (ange-ftp-expand-symlink file-ent
3051 (file-name-directory
d0bc419e 3052 (directory-file-name name))))
2f7ea155 3053 t)))
d0bc419e 3054 (ange-ftp-real-file-exists-p name)))
2f7ea155 3055
d0bc419e
RS
3056(defun ange-ftp-file-directory-p (name)
3057 (setq name (expand-file-name name))
3058 (if (ange-ftp-ftp-name name)
3059 ;; We do a file-name-as-directory on name here because some
2f7ea155
RS
3060 ;; machines (VMS) use a .DIR to indicate the filename associated
3061 ;; with a directory. This needs to be canonicalized.
3062 (let ((file-ent (ange-ftp-get-file-entry
d0bc419e 3063 (ange-ftp-file-name-as-directory name))))
2f7ea155
RS
3064 (if (stringp file-ent)
3065 (file-directory-p
3066 (ange-ftp-expand-symlink file-ent
3067 (file-name-directory
d0bc419e 3068 (directory-file-name name))))
2f7ea155 3069 file-ent))
d0bc419e 3070 (ange-ftp-real-file-directory-p name)))
2f7ea155
RS
3071
3072(defun ange-ftp-directory-files (directory &optional full match
3073 &rest v19-args)
2f7ea155 3074 (setq directory (expand-file-name directory))
d0bc419e 3075 (if (ange-ftp-ftp-name directory)
2f7ea155
RS
3076 (progn
3077 (ange-ftp-barf-if-not-directory directory)
3078 (let ((tail (ange-ftp-hash-table-keys
3079 (ange-ftp-get-files directory)))
3080 files f)
3081 (setq directory (file-name-as-directory directory))
65135ec2 3082 (save-match-data
2f7ea155
RS
3083 (while tail
3084 (setq f (car tail)
3085 tail (cdr tail))
3086 (if (or (not match) (string-match match f))
3087 (setq files
3088 (cons (if full (concat directory f) f) files)))))
3089 (nreverse files)))
3090 (apply 'ange-ftp-real-directory-files directory full match v19-args)))
3091
3092(defun ange-ftp-file-attributes (file)
2f7ea155 3093 (setq file (expand-file-name file))
d0bc419e 3094 (let ((parsed (ange-ftp-ftp-name file)))
2f7ea155
RS
3095 (if parsed
3096 (let ((part (ange-ftp-get-file-part file))
3097 (files (ange-ftp-get-files (file-name-directory file))))
3098 (if (ange-ftp-hash-entry-exists-p part files)
3099 (let ((host (nth 0 parsed))
3100 (user (nth 1 parsed))
d0bc419e 3101 (name (nth 2 parsed))
2f7ea155
RS
3102 (dirp (ange-ftp-get-hash-entry part files)))
3103 (list (if (and (stringp dirp) (file-name-absolute-p dirp))
3104 (ange-ftp-expand-symlink dirp
3105 (file-name-directory file))
3106 dirp) ;0 file type
3107 -1 ;1 link count
3108 -1 ;2 uid
3109 -1 ;3 gid
3110 '(0 0) ;4 atime
3111 '(0 0) ;5 mtime
3112 '(0 0) ;6 ctime
3113 -1 ;7 size
3114 (concat (if (stringp dirp) "l" (if dirp "d" "-"))
3115 "?????????") ;8 mode
3116 nil ;9 gid weird
3117 ;; Hack to give remote files a unique "inode number".
3118 ;; It's actually the sum of the characters in its name.
3119 (apply '+ (nconc (mapcar 'identity host)
3120 (mapcar 'identity user)
3121 (mapcar 'identity
d0bc419e 3122 (directory-file-name name))))
2f7ea155
RS
3123 -1 ;11 device number [v19 only]
3124 ))))
3125 (ange-ftp-real-file-attributes file))))
3126
3127(defun ange-ftp-file-writable-p (file)
2f7ea155 3128 (setq file (expand-file-name file))
d0bc419e 3129 (if (ange-ftp-ftp-name file)
2f7ea155
RS
3130 (or (file-exists-p file) ;guess here for speed
3131 (file-directory-p (file-name-directory file)))
3132 (ange-ftp-real-file-writable-p file)))
3133
3134(defun ange-ftp-file-readable-p (file)
2f7ea155 3135 (setq file (expand-file-name file))
d0bc419e 3136 (if (ange-ftp-ftp-name file)
2f7ea155
RS
3137 (file-exists-p file)
3138 (ange-ftp-real-file-readable-p file)))
3139
f8f418d8
RM
3140(defun ange-ftp-file-executable-p (file)
3141 (setq file (expand-file-name file))
3142 (if (ange-ftp-ftp-name file)
3143 (file-exists-p file)
3144 (ange-ftp-real-file-executable-p file)))
3145
2f7ea155 3146(defun ange-ftp-delete-file (file)
2f7ea155
RS
3147 (interactive "fDelete file: ")
3148 (setq file (expand-file-name file))
d0bc419e 3149 (let ((parsed (ange-ftp-ftp-name file)))
2f7ea155
RS
3150 (if parsed
3151 (let* ((host (nth 0 parsed))
3152 (user (nth 1 parsed))
d0bc419e 3153 (name (ange-ftp-quote-string (nth 2 parsed)))
2f7ea155
RS
3154 (abbr (ange-ftp-abbreviate-filename file))
3155 (result (ange-ftp-send-cmd host user
d0bc419e 3156 (list 'delete name)
2f7ea155
RS
3157 (format "Deleting %s" abbr))))
3158 (or (car result)
3159 (signal 'ftp-error
3160 (list
3161 "Removing old name"
3162 (format "FTP Error: \"%s\"" (cdr result))
3163 file)))
3164 (ange-ftp-delete-file-entry file))
3165 (ange-ftp-real-delete-file file))))
3166
3167(defun ange-ftp-verify-visited-file-modtime (buf)
2f7ea155 3168 (let ((name (buffer-file-name buf)))
d0bc419e 3169 (if (and (stringp name) (ange-ftp-ftp-name name))
2f7ea155
RS
3170 t
3171 (ange-ftp-real-verify-visited-file-modtime buf))))
2f7ea155
RS
3172\f
3173;;;; ------------------------------------------------------------
3174;;;; File copying support... totally re-written 6/24/92.
3175;;;; ------------------------------------------------------------
3176
3177(defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive)
3178 (if (file-exists-p absname)
3179 (if (not interactive)
3180 (signal 'file-already-exists (list absname))
3181 (if (not (yes-or-no-p (format "File %s already exists; %s anyway? "
3182 absname querystring)))
3183 (signal 'file-already-exists (list absname))))))
3184
3185;; async local copy commented out for now since I don't seem to get
3186;; the process sentinel called for some processes.
3187;;
3188;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists
3189;; keep-date cont)
3190;; "Kludge to copy a local file and call a continuation when the copy
3191;; finishes."
3192;; ;; check to see if we can overwrite
3193;; (if (or (not ok-if-already-exists)
3194;; (numberp ok-if-already-exists))
3195;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3196;; (numberp ok-if-already-exists)))
3197;; (let ((proc (start-process " *copy*"
3198;; (generate-new-buffer "*copy*")
3199;; "cp"
3200;; filename
3201;; newname))
3202;; res)
3203;; (set-process-sentinel proc (function ange-ftp-copy-file-locally-sentinel))
3204;; (process-kill-without-query proc)
3205;; (save-excursion
3206;; (set-buffer (process-buffer proc))
3207;; (make-variable-buffer-local 'copy-cont)
3208;; (setq copy-cont cont))))
3209;;
3210;; (defun ange-ftp-copy-file-locally-sentinel (proc status)
3211;; (save-excursion
3212;; (set-buffer (process-buffer proc))
3213;; (let ((cont copy-cont)
3214;; (result (buffer-string)))
3215;; (unwind-protect
3216;; (if (and (string-equal status "finished\n")
3217;; (zerop (length result)))
3218;; (ange-ftp-call-cont cont t nil)
3219;; (ange-ftp-call-cont cont
3220;; nil
3221;; (if (zerop (length result))
3222;; (substring status 0 -1)
3223;; (substring result 0 -1))))
3224;; (kill-buffer (current-buffer))))))
3225
3226;; this is the extended version of ange-ftp-copy-file-internal that works
eb8c3be9 3227;; asynchronously if asked nicely.
2f7ea155
RS
3228(defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists
3229 keep-date &optional msg cont nowait)
3230 (setq filename (expand-file-name filename)
3231 newname (expand-file-name newname))
3232
3233 ;; canonicalize newname if a directory.
3234 (if (file-directory-p newname)
3235 (setq newname (expand-file-name (file-name-nondirectory filename) newname)))
3236
d0bc419e
RS
3237 (let ((f-parsed (ange-ftp-ftp-name filename))
3238 (t-parsed (ange-ftp-ftp-name newname)))
2f7ea155
RS
3239
3240 ;; local file to local file copy?
3241 (if (and (not f-parsed) (not t-parsed))
3242 (progn
3243 (ange-ftp-real-copy-file filename newname ok-if-already-exists
3244 keep-date)
3245 (if cont
3246 (ange-ftp-call-cont cont t "Copied locally")))
3247 ;; one or both files are remote.
3248 (let* ((f-host (and f-parsed (nth 0 f-parsed)))
3249 (f-user (and f-parsed (nth 1 f-parsed)))
d0bc419e 3250 (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed))))
2f7ea155
RS
3251 (f-abbr (ange-ftp-abbreviate-filename filename))
3252 (t-host (and t-parsed (nth 0 t-parsed)))
3253 (t-user (and t-parsed (nth 1 t-parsed)))
d0bc419e 3254 (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed))))
2f7ea155
RS
3255 (t-abbr (ange-ftp-abbreviate-filename newname filename))
3256 (binary (or (ange-ftp-binary-file filename)
6807c701
RS
3257 (ange-ftp-binary-file newname)
3258 (and (eq (ange-ftp-host-type f-host f-user) 'unix)
3259 (eq (ange-ftp-host-type t-host t-user) 'unix))))
2f7ea155
RS
3260 temp1
3261 temp2)
3262
3263 ;; check to see if we can overwrite
3264 (if (or (not ok-if-already-exists)
3265 (numberp ok-if-already-exists))
3266 (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3267 (numberp ok-if-already-exists)))
3268
3269 ;; do the copying.
3270 (if f-parsed
3271
3272 ;; filename was remote.
3273 (progn
3274 (if (or (ange-ftp-use-gateway-p f-host)
3275 t-parsed)
3276 ;; have to use intermediate file if we are getting via
3277 ;; gateway machine or we are doing a remote to remote copy.
3278 (setq temp1 (ange-ftp-make-tmp-name f-host)))
3279
3280 (if binary
3281 (ange-ftp-set-binary-mode f-host f-user))
3282
3283 (ange-ftp-send-cmd
3284 f-host
3285 f-user
d0bc419e 3286 (list 'get f-name (or temp1 newname))
2f7ea155
RS
3287 (or msg
3288 (if (and temp1 t-parsed)
3289 (format "Getting %s" f-abbr)
3290 (format "Copying %s to %s" f-abbr t-abbr)))
3291 (list (function ange-ftp-cf1)
3292 filename newname binary msg
d0bc419e
RS
3293 f-parsed f-host f-user f-name f-abbr
3294 t-parsed t-host t-user t-name t-abbr
2f7ea155
RS
3295 temp1 temp2 cont nowait)
3296 nowait))
3297
3298 ;; filename wasn't remote. newname must be remote. call the
3299 ;; function which does the remainder of the copying work.
3300 (ange-ftp-cf1 t nil
3301 filename newname binary msg
d0bc419e
RS
3302 f-parsed f-host f-user f-name f-abbr
3303 t-parsed t-host t-user t-name t-abbr
2f7ea155
RS
3304 nil nil cont nowait))))))
3305
3306;; next part of copying routine.
3307(defun ange-ftp-cf1 (result line
3308 filename newname binary msg
d0bc419e
RS
3309 f-parsed f-host f-user f-name f-abbr
3310 t-parsed t-host t-user t-name t-abbr
2f7ea155
RS
3311 temp1 temp2 cont nowait)
3312 (if line
3313 ;; filename must have been remote, and we must have just done a GET.
3314 (unwind-protect
3315 (or result
3316 ;; GET failed for some reason. Clean up and get out.
3317 (progn
3318 (and temp1 (ange-ftp-del-tmp-name temp1))
3319 (or cont
3320 (signal 'ftp-error (list "Opening input file"
3321 (format "FTP Error: \"%s\"" line)
3322 filename)))))
3323 ;; cleanup
3324 (if binary
3325 (ange-ftp-set-ascii-mode f-host f-user))))
3326
3327 (if result
3328 ;; We now have to copy either temp1 or filename to newname.
3329 (if t-parsed
3330
3331 ;; newname was remote.
3332 (progn
3333 (if (ange-ftp-use-gateway-p t-host)
3334 (setq temp2 (ange-ftp-make-tmp-name t-host)))
3335
3336 ;; make sure data is moved into the right place for the
3337 ;; outgoing transfer. gateway temporary files complicate
3338 ;; things nicely.
3339 (if temp1
3340 (if temp2
3341 (if (string-equal temp1 temp2)
3342 (setq temp1 nil)
3343 (ange-ftp-real-copy-file temp1 temp2 t))
3344 (setq temp2 temp1 temp1 nil))
3345 (if temp2
3346 (ange-ftp-real-copy-file filename temp2 t)))
3347
3348 (if binary
3349 (ange-ftp-set-binary-mode t-host t-user))
3350
3351 ;; tell the process filter what size the file is.
3352 (let ((attr (file-attributes (or temp2 filename))))
3353 (if attr
3354 (ange-ftp-set-xfer-size t-host t-user (nth 7 attr))))
3355
3356 (ange-ftp-send-cmd
3357 t-host
3358 t-user
d0bc419e 3359 (list 'put (or temp2 filename) t-name)
2f7ea155
RS
3360 (or msg
3361 (if (and temp2 f-parsed)
3362 (format "Putting %s" newname)
3363 (format "Copying %s to %s" f-abbr t-abbr)))
3364 (list (function ange-ftp-cf2)
3365 newname t-host t-user binary temp1 temp2 cont)
3366 nowait))
3367
3368 ;; newname wasn't remote.
3369 (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont))
3370
3371 ;; first copy failed, tell caller
3372 (ange-ftp-call-cont cont result line)))
3373
3374;; last part of copying routine.
3375(defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont)
3376 (unwind-protect
3377 (if line
3378 ;; result from doing a local to remote copy.
3379 (unwind-protect
3380 (progn
3381 (or result
3382 (or cont
3383 (signal 'ftp-error
3384 (list "Opening output file"
3385 (format "FTP Error: \"%s\"" line)
3386 newname))))
3387
3388 (ange-ftp-add-file-entry newname))
3389
3390 ;; cleanup.
3391 (if binary
3392 (ange-ftp-set-ascii-mode t-host t-user)))
3393
3394 ;; newname was local.
3395 (if temp1
3396 (ange-ftp-real-copy-file temp1 newname t)))
3397
3398 ;; clean up
3399 (and temp1 (ange-ftp-del-tmp-name temp1))
3400 (and temp2 (ange-ftp-del-tmp-name temp2))
3401 (ange-ftp-call-cont cont result line)))
3402
3403(defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists
3404 keep-date)
2f7ea155
RS
3405 (interactive "fCopy file: \nFCopy %s to file: \np")
3406 (ange-ftp-copy-file-internal filename
3407 newname
3408 ok-if-already-exists
3409 keep-date
3410 nil
3411 nil
3412 (interactive-p)))
3413\f
3414;;;; ------------------------------------------------------------
3415;;;; File renaming support.
3416;;;; ------------------------------------------------------------
3417
6807c701 3418(defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed)
2f7ea155
RS
3419 "Rename remote file FILE to remote file NEWNAME."
3420 (let ((f-host (nth 0 f-parsed))
3421 (f-user (nth 1 f-parsed))
3422 (t-host (nth 0 t-parsed))
3423 (t-user (nth 1 t-parsed)))
3424 (if (and (string-equal f-host t-host)
3425 (string-equal f-user t-user))
d0bc419e
RS
3426 (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed)))
3427 (t-name (ange-ftp-quote-string (nth 2 t-parsed)))
3428 (cmd (list 'rename f-name t-name))
2f7ea155
RS
3429 (fabbr (ange-ftp-abbreviate-filename filename))
3430 (nabbr (ange-ftp-abbreviate-filename newname filename))
3431 (result (ange-ftp-send-cmd f-host f-user cmd
3432 (format "Renaming %s to %s"
3433 fabbr
3434 nabbr))))
3435 (or (car result)
3436 (signal 'ftp-error
3437 (list
3438 "Renaming"
3439 (format "FTP Error: \"%s\"" (cdr result))
3440 filename
3441 newname)))
3442 (ange-ftp-add-file-entry newname)
3443 (ange-ftp-delete-file-entry filename))
3444 (ange-ftp-copy-file-internal filename newname t nil)
3445 (delete-file filename))))
3446
3447(defun ange-ftp-rename-local-to-remote (filename newname)
c8fa98cc 3448 "Rename local FILENAME to remote file NEWNAME."
2f7ea155
RS
3449 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3450 (nabbr (ange-ftp-abbreviate-filename newname filename))
3451 (msg (format "Renaming %s to %s" fabbr nabbr)))
3452 (ange-ftp-copy-file-internal filename newname t nil msg)
3453 (let (ange-ftp-process-verbose)
3454 (delete-file filename))))
3455
3456(defun ange-ftp-rename-remote-to-local (filename newname)
c8fa98cc 3457 "Rename remote file FILENAME to local file NEWNAME."
2f7ea155
RS
3458 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3459 (nabbr (ange-ftp-abbreviate-filename newname filename))
3460 (msg (format "Renaming %s to %s" fabbr nabbr)))
3461 (ange-ftp-copy-file-internal filename newname t nil msg)
3462 (let (ange-ftp-process-verbose)
3463 (delete-file filename))))
3464
3465(defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists)
2f7ea155
RS
3466 (interactive "fRename file: \nFRename %s to file: \np")
3467 (setq filename (expand-file-name filename))
3468 (setq newname (expand-file-name newname))
d0bc419e 3469 (let* ((f-parsed (ange-ftp-ftp-name filename))
6807c701 3470 (t-parsed (ange-ftp-ftp-name newname)))
2f7ea155
RS
3471 (if (and (or f-parsed t-parsed)
3472 (or (not ok-if-already-exists)
3473 (numberp ok-if-already-exists)))
3474 (ange-ftp-barf-or-query-if-file-exists
3475 newname
3476 "rename to it"
3477 (numberp ok-if-already-exists)))
3478 (if f-parsed
3479 (if t-parsed
3480 (ange-ftp-rename-remote-to-remote filename newname f-parsed
6807c701 3481 t-parsed)
2f7ea155
RS
3482 (ange-ftp-rename-remote-to-local filename newname))
3483 (if t-parsed
3484 (ange-ftp-rename-local-to-remote filename newname)
3485 (ange-ftp-real-rename-file filename newname ok-if-already-exists)))))
3486\f
3487;;;; ------------------------------------------------------------
3488;;;; File name completion support.
3489;;;; ------------------------------------------------------------
3490
d0bc419e
RS
3491;; If the file entry SYM is a symlink, returns whether its file exists.
3492;; Note that `ange-ftp-this-dir' is used as a free variable.
2f7ea155 3493(defun ange-ftp-file-entry-active-p (sym)
2f7ea155
RS
3494 (let ((val (get sym 'val)))
3495 (or (not (stringp val))
3496 (file-exists-p (ange-ftp-expand-symlink val ange-ftp-this-dir)))))
3497
d0bc419e
RS
3498;; If the file entry is not a directory (nor a symlink pointing to a directory)
3499;; returns whether the file (or file pointed to by the symlink) is ignored
3500;; by completion-ignored-extensions.
3501;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern'
3502;; are used as free variables.
2f7ea155 3503(defun ange-ftp-file-entry-not-ignored-p (sym)
2f7ea155
RS
3504 (let ((val (get sym 'val))
3505 (symname (symbol-name sym)))
3506 (if (stringp val)
3507 (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir)))
3508 (or (file-directory-p file)
3509 (and (file-exists-p file)
3510 (not (string-match ange-ftp-completion-ignored-pattern
3511 symname)))))
3512 (or val ; is a directory name
3513 (not (string-match ange-ftp-completion-ignored-pattern symname))))))
3514
3515(defun ange-ftp-file-name-all-completions (file dir)
2f7ea155 3516 (let ((ange-ftp-this-dir (expand-file-name dir)))
d0bc419e 3517 (if (ange-ftp-ftp-name ange-ftp-this-dir)
2f7ea155
RS
3518 (progn
3519 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3520 (setq ange-ftp-this-dir
3521 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir))
3522 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3523 (completions
3524 (all-completions file tbl
3525 (function ange-ftp-file-entry-active-p))))
3526
3527 ;; see whether each matching file is a directory or not...
3528 (mapcar
3529 (function
3530 (lambda (file)
3531 (let ((ent (ange-ftp-get-hash-entry file tbl)))
3532 (if (and ent
3533 (or (not (stringp ent))
3534 (file-directory-p
3535 (ange-ftp-expand-symlink ent
3536 ange-ftp-this-dir))))
3537 (concat file "/")
3538 file))))
3539 completions)))
3540
3541 (if (string-equal "/" ange-ftp-this-dir)
3542 (nconc (all-completions file (ange-ftp-generate-root-prefixes))
3543 (ange-ftp-real-file-name-all-completions file
3544 ange-ftp-this-dir))
3545 (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir)))))
3546
3547(defun ange-ftp-file-name-completion (file dir)
2f7ea155 3548 (let ((ange-ftp-this-dir (expand-file-name dir)))
d0bc419e 3549 (if (ange-ftp-ftp-name ange-ftp-this-dir)
2f7ea155
RS
3550 (progn
3551 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3552 (if (equal file "")
3553 ""
3554 (setq ange-ftp-this-dir
3555 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real?
3556 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3557 (ange-ftp-completion-ignored-pattern
3558 (mapconcat (function
3559 (lambda (s) (if (stringp s)
3560 (concat (regexp-quote s) "$")
3561 "/"))) ; / never in filename
3562 completion-ignored-extensions
3563 "\\|")))
65135ec2 3564 (save-match-data
2f7ea155
RS
3565 (or (ange-ftp-file-name-completion-1
3566 file tbl ange-ftp-this-dir
3567 (function ange-ftp-file-entry-not-ignored-p))
3568 (ange-ftp-file-name-completion-1
3569 file tbl ange-ftp-this-dir
3570 (function ange-ftp-file-entry-active-p)))))))
3571
3572 (if (string-equal "/" ange-ftp-this-dir)
3573 (try-completion
3574 file
3575 (nconc (ange-ftp-generate-root-prefixes)
3576 (mapcar 'list
3577 (ange-ftp-real-file-name-all-completions file "/"))))
3578 (ange-ftp-real-file-name-completion file ange-ftp-this-dir)))))
3579
3580
3581(defun ange-ftp-file-name-completion-1 (file tbl dir predicate)
2f7ea155
RS
3582 (let ((bestmatch (try-completion file tbl predicate)))
3583 (if bestmatch
3584 (if (eq bestmatch t)
3585 (if (file-directory-p (expand-file-name file dir))
3586 (concat file "/")
3587 t)
3588 (if (and (eq (try-completion bestmatch tbl predicate) t)
3589 (file-directory-p
3590 (expand-file-name bestmatch dir)))
3591 (concat bestmatch "/")
3592 bestmatch)))))
3593
2f7ea155
RS
3594;; Put these lines uncommmented in your .emacs if you want C-r to refresh
3595;; ange-ftp's cache whilst doing filename completion.
3596;;
3597;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir)
3598;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir)
3599
d0bc419e
RS
3600;; Force a re-read of the directory DIR. If DIR is omitted then it defaults
3601;; to the directory part of the contents of the current buffer.
2f7ea155 3602(defun ange-ftp-re-read-dir (&optional dir)
2f7ea155
RS
3603 (interactive)
3604 (if dir
3605 (setq dir (expand-file-name dir))
3606 (setq dir (file-name-directory (expand-file-name (buffer-string)))))
d0bc419e 3607 (if (ange-ftp-ftp-name dir)
2f7ea155
RS
3608 (progn
3609 (setq ange-ftp-ls-cache-file nil)
3610 (ange-ftp-del-hash-entry dir ange-ftp-files-hashtable)
3611 (ange-ftp-get-files dir t))))
3612\f
92b28133 3613(defun ange-ftp-make-directory (dir &optional parents)
d0bc419e 3614 (interactive (list (expand-file-name (read-file-name "Make directory: "))))
92b28133
JB
3615 (if parents
3616 (let ((parent (file-name-directory (directory-file-name dir))))
3617 (or (file-exists-p parent)
3618 (ange-ftp-make-directory parent parents))))
d0bc419e
RS
3619 (if (file-exists-p dir)
3620 (error "Cannot make directory %s: file already exists" dir)
3621 (let ((parsed (ange-ftp-ftp-name dir)))
3622 (if parsed
3623 (let* ((host (nth 0 parsed))
3624 (user (nth 1 parsed))
3625 ;; Some ftp's on unix machines (at least on Suns)
3626 ;; insist that mkdir take a filename, and not a
3627 ;; directory-name name as an arg. Argh!! This is a bug.
3628 ;; Non-unix machines will probably always insist
3629 ;; that mkdir takes a directory-name as an arg
3630 ;; (as the ftp man page says it should).
3631 (name (ange-ftp-quote-string
3632 (if (eq (ange-ftp-host-type host) 'unix)
3633 (ange-ftp-real-directory-file-name (nth 2 parsed))
3634 (ange-ftp-real-file-name-as-directory
3635 (nth 2 parsed)))))
3636 (abbr (ange-ftp-abbreviate-filename dir))
3637 (result (ange-ftp-send-cmd host user
3638 (list 'mkdir name)
3639 (format "Making directory %s"
3640 abbr))))
3641 (or (car result)
3642 (ange-ftp-error host user
3643 (format "Could not make directory %s: %s"
3644 dir
3645 (cdr result))))
3646 (ange-ftp-add-file-entry dir t))
3647 (ange-ftp-real-make-directory dir)))))
3648
3649(defun ange-ftp-delete-directory (dir)
3650 (if (file-directory-p dir)
3651 (let ((parsed (ange-ftp-ftp-name dir)))
3652 (if parsed
3653 (let* ((host (nth 0 parsed))
3654 (user (nth 1 parsed))
3655 ;; Some ftp's on unix machines (at least on Suns)
3656 ;; insist that rmdir take a filename, and not a
3657 ;; directory-name name as an arg. Argh!! This is a bug.
3658 ;; Non-unix machines will probably always insist
3659 ;; that rmdir takes a directory-name as an arg
3660 ;; (as the ftp man page says it should).
3661 (name (ange-ftp-quote-string
3662 (if (eq (ange-ftp-host-type host) 'unix)
3663 (ange-ftp-real-directory-file-name
3664 (nth 2 parsed))
3665 (ange-ftp-real-file-name-as-directory
3666 (nth 2 parsed)))))
3667 (abbr (ange-ftp-abbreviate-filename dir))
3668 (result (ange-ftp-send-cmd host user
3669 (list 'rmdir name)
3670 (format "Removing directory %s"
3671 abbr))))
3672 (or (car result)
3673 (ange-ftp-error host user
3674 (format "Could not remove directory %s: %s"
3675 dir
3676 (cdr result))))
3677 (ange-ftp-delete-file-entry dir t))
3678 (ange-ftp-real-delete-directory dir)))
3679 (error "Not a directory: %s" dir)))
3680\f
8feebd07 3681;; Make a local copy of FILE and return its name.
d0bc419e 3682
8feebd07 3683(defun ange-ftp-file-local-copy (file)
d0bc419e
RS
3684 (let* ((fn1 (expand-file-name file))
3685 (pa1 (ange-ftp-ftp-name fn1)))
3686 (if pa1
6807c701 3687 (let ((tmp1 (ange-ftp-make-tmp-name (car pa1))))
d0bc419e
RS
3688 (ange-ftp-copy-file-internal fn1 tmp1 t nil
3689 (format "Getting %s" fn1))
8feebd07 3690 tmp1))))
724db75f 3691
1a7ffe17 3692(defun ange-ftp-load (file &optional noerror nomessage nosuffix)
724db75f 3693 (if (ange-ftp-ftp-name file)
1a7ffe17
KH
3694 (let ((tryfiles (if nosuffix
3695 (list file)
3696 (list (concat file ".elc") (concat file ".el") file)))
3697 copy)
3698 (while (and tryfiles (not copy))
3699 (condition-case error
3700 (setq copy (ange-ftp-file-local-copy (car tryfiles)))
3701 (ftp-error nil)))
3702 (if copy
3703 (unwind-protect
3704 (funcall 'load copy noerror nomessage nosuffix)
3705 (delete-file copy))
3706 (or noerror
3707 (signal 'file-error (list "Cannot open load file" file)))))
3708 (ange-ftp-real-load file noerror nomessage nosuffix)))
724db75f 3709
9ca74466
JB
3710;; Calculate default-unhandled-directory for a given ange-ftp buffer.
3711(defun ange-ftp-unhandled-file-name-directory (filename)
3712 (file-name-directory ange-ftp-tmp-name-template))
3713
3714\f
d0bc419e
RS
3715;; Need the following functions for making filenames of compressed
3716;; files, because some OS's (unlike UNIX) do not allow a filename to
3717;; have two extensions.
3718
3719(defvar ange-ftp-make-compressed-filename-alist nil
3720 "Alist of host-type-specific functions to process file names for compression.
3721Each element has the form (TYPE . FUNC).
3722FUNC should take one argument, a file name, and return a list
3723of the form (COMPRESSING NEWNAME).
3724COMPRESSING should be t if the specified file should be compressed,
3725and nil if it should be uncompressed (that is, if it is a compressed file).
3726NEWNAME should be the name to give the new compressed or uncompressed file.")
3727
3728(defun ange-ftp-dired-compress-file (name)
3729 (let ((parsed (ange-ftp-ftp-name name))
3730 conversion-func)
3731 (if (and parsed
3732 (setq conversion-func
3733 (cdr (assq (ange-ftp-host-type (car parsed))
3734 ange-ftp-make-compressed-filename-alist))))
3735 (let* ((decision
65135ec2 3736 (save-match-data (funcall conversion-func name)))
d0bc419e
RS
3737 (compressing (car decision))
3738 (newfile (nth 1 decision)))
3739 (if compressing
3740 (ange-ftp-compress name newfile)
3741 (ange-ftp-uncompress name newfile)))
3742 (let (file-name-handler-alist)
e70fd492 3743 (dired-compress-file name)))))
d0bc419e
RS
3744
3745;; Copy FILE to this machine, compress it, and copy out to NFILE.
3746(defun ange-ftp-compress (file nfile)
3747 (let* ((parsed (ange-ftp-ftp-name file))
3748 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
3749 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
3750 (abbr (ange-ftp-abbreviate-filename file))
3751 (nabbr (ange-ftp-abbreviate-filename nfile))
3752 (msg1 (format "Getting %s" abbr))
3753 (msg2 (format "Putting %s" nabbr)))
3754 (unwind-protect
3755 (progn
3756 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
3757 (and ange-ftp-process-verbose
3758 (ange-ftp-message "Compressing %s..." abbr))
3759 (call-process-region (point)
3760 (point)
3761 shell-file-name
3762 nil
3763 t
3764 nil
3765 "-c"
3766 (format "compress -f -c < %s > %s" tmp1 tmp2))
3767 (and ange-ftp-process-verbose
3768 (ange-ftp-message "Compressing %s...done" abbr))
3769 (if (zerop (buffer-size))
3770 (progn
3771 (let (ange-ftp-process-verbose)
3772 (delete-file file))
3773 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
3774 (ange-ftp-del-tmp-name tmp1)
3775 (ange-ftp-del-tmp-name tmp2))))
3776
3777;; Copy FILE to this machine, uncompress it, and copy out to NFILE.
3778(defun ange-ftp-uncompress (file nfile)
3779 (let* ((parsed (ange-ftp-ftp-name file))
3780 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
3781 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
3782 (abbr (ange-ftp-abbreviate-filename file))
3783 (nabbr (ange-ftp-abbreviate-filename nfile))
3784 (msg1 (format "Getting %s" abbr))
3785 (msg2 (format "Putting %s" nabbr))
3786;; ;; Cheap hack because of problems with binary file transfers from
3787;; ;; VMS hosts.
3788;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed)))))
3789 )
3790 (unwind-protect
3791 (progn
3792 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
3793 (and ange-ftp-process-verbose
3794 (ange-ftp-message "Uncompressing %s..." abbr))
3795 (call-process-region (point)
3796 (point)
3797 shell-file-name
3798 nil
3799 t
3800 nil
3801 "-c"
3802 (format "uncompress -c < %s > %s" tmp1 tmp2))
3803 (and ange-ftp-process-verbose
3804 (ange-ftp-message "Uncompressing %s...done" abbr))
3805 (if (zerop (buffer-size))
3806 (progn
3807 (let (ange-ftp-process-verbose)
3808 (delete-file file))
3809 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
3810 (ange-ftp-del-tmp-name tmp1)
3811 (ange-ftp-del-tmp-name tmp2))))
dae0ae5d
RS
3812
3813(defun ange-ftp-find-backup-file-name (fn)
3814 ;; Either return the ordinary backup name, etc.,
3815 ;; or return nil meaning don't make a backup.
3816 (if ange-ftp-make-backup-files
3817 (ange-ftp-real-find-backup-file-name fn)))
d0bc419e 3818\f
2f7ea155
RS
3819;;; Define the handler for special file names
3820;;; that causes ange-ftp to be invoked.
3821
26aaadf3
RS
3822;;;###autoload
3823(defun ange-ftp-hook-function (operation &rest args)
3824 (let ((fn (get operation 'ange-ftp)))
3825 (if fn (apply fn args)
fe8fd409 3826 (ange-ftp-run-real-handler operation args))))
26aaadf3 3827
712a1694
JB
3828
3829;;; This regexp takes care of real ange-ftp file names (with a slash
0628c764 3830;;; and colon).
c86bd65b 3831;;; Don't allow the host name to end in a period--some systems use /.:
26aaadf3 3832;;;###autoload
c86bd65b 3833(or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist)
26aaadf3 3834 (setq file-name-handler-alist
c86bd65b 3835 (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function)
0628c764
RS
3836 file-name-handler-alist)))
3837
3838;;; This regexp recognizes and absolute filenames with only one component,
3839;;; for the sake of hostname completion.
3840;;;###autoload
3841(or (assoc "^/[^/:]*\\'" file-name-handler-alist)
3842 (setq file-name-handler-alist
3843 (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function)
26aaadf3
RS
3844 file-name-handler-alist)))
3845
3846;;; The above two forms are sufficient to cause this file to be loaded
3847;;; if the user ever uses a file name with a colon in it.
3848
3849;;; This sets the mode
3850(or (memq 'ange-ftp-set-buffer-mode find-file-hooks)
3851 (setq find-file-hooks
3852 (cons 'ange-ftp-set-buffer-mode find-file-hooks)))
3853
3854;;; Now say where to find the handlers for particular operations.
2f7ea155
RS
3855
3856(put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory)
3857(put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory)
3858(put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory)
3859(put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name)
3860(put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name)
2f7ea155
RS
3861(put 'make-directory 'ange-ftp 'ange-ftp-make-directory)
3862(put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory)
3863(put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents)
3864(put 'directory-files 'ange-ftp 'ange-ftp-directory-files)
3865(put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p)
3866(put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p)
3867(put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p)
f8f418d8 3868(put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p)
2f7ea155
RS
3869(put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p)
3870(put 'delete-file 'ange-ftp 'ange-ftp-delete-file)
3871(put 'read-file-name-internal 'ange-ftp 'ange-ftp-read-file-name-internal)
3872(put 'verify-visited-file-modtime 'ange-ftp
3873 'ange-ftp-verify-visited-file-modtime)
3874(put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p)
3875(put 'write-region 'ange-ftp 'ange-ftp-write-region)
3876(put 'backup-buffer 'ange-ftp 'ange-ftp-backup-buffer)
3877(put 'copy-file 'ange-ftp 'ange-ftp-copy-file)
3878(put 'rename-file 'ange-ftp 'ange-ftp-rename-file)
3879(put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes)
3880(put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions)
3881(put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion)
c3554e95 3882(put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory)
8feebd07 3883(put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy)
9ca74466
JB
3884(put 'unhandled-file-name-directory 'ange-ftp
3885 'ange-ftp-unhandled-file-name-directory)
d0bc419e
RS
3886(put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions)
3887(put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache)
3888(put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file)
724db75f 3889(put 'load 'ange-ftp 'ange-ftp-load)
dae0ae5d 3890(put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name)
243e5206
RS
3891
3892;; Turn off truename processing to save time.
3893;; Treat each name as its own truename.
3894(put 'file-truename 'ange-ftp 'identity)
3895
3896;; Turn off RCS/SCCS processing to save time.
3897;; This returns nil for any file name as argument.
3898(put 'vc-registered 'ange-ftp 'null)
26aaadf3
RS
3899\f
3900;;; Define ways of getting at unmodified Emacs primitives,
3901;;; turning off our handler.
2f7ea155 3902
888b812e
RS
3903(defun ange-ftp-run-real-handler (operation args)
3904 (let ((inhibit-file-name-handlers
3905 (cons 'ange-ftp-hook-function
fe8fd409
RS
3906 (cons 'ange-ftp-completion-hook-function
3907 (and (eq inhibit-file-name-operation operation)
3908 inhibit-file-name-handlers))))
888b812e
RS
3909 (inhibit-file-name-operation operation))
3910 (apply operation args)))
3911
2f7ea155 3912(defun ange-ftp-real-file-name-directory (&rest args)
888b812e 3913 (ange-ftp-run-real-handler 'file-name-directory args))
2f7ea155 3914(defun ange-ftp-real-file-name-nondirectory (&rest args)
888b812e 3915 (ange-ftp-run-real-handler 'file-name-nondirectory args))
2f7ea155 3916(defun ange-ftp-real-file-name-as-directory (&rest args)
888b812e 3917 (ange-ftp-run-real-handler 'file-name-as-directory args))
2f7ea155 3918(defun ange-ftp-real-directory-file-name (&rest args)
888b812e 3919 (ange-ftp-run-real-handler 'directory-file-name args))
2f7ea155 3920(defun ange-ftp-real-expand-file-name (&rest args)
888b812e 3921 (ange-ftp-run-real-handler 'expand-file-name args))
2f7ea155 3922(defun ange-ftp-real-make-directory (&rest args)
888b812e 3923 (ange-ftp-run-real-handler 'make-directory args))
2f7ea155 3924(defun ange-ftp-real-delete-directory (&rest args)
888b812e 3925 (ange-ftp-run-real-handler 'delete-directory args))
2f7ea155 3926(defun ange-ftp-real-insert-file-contents (&rest args)
888b812e 3927 (ange-ftp-run-real-handler 'insert-file-contents args))
2f7ea155 3928(defun ange-ftp-real-directory-files (&rest args)
888b812e 3929 (ange-ftp-run-real-handler 'directory-files args))
2f7ea155 3930(defun ange-ftp-real-file-directory-p (&rest args)
888b812e 3931 (ange-ftp-run-real-handler 'file-directory-p args))
2f7ea155 3932(defun ange-ftp-real-file-writable-p (&rest args)
888b812e 3933 (ange-ftp-run-real-handler 'file-writable-p args))
2f7ea155 3934(defun ange-ftp-real-file-readable-p (&rest args)
888b812e 3935 (ange-ftp-run-real-handler 'file-readable-p args))
f8f418d8 3936(defun ange-ftp-real-file-executable-p (&rest args)
888b812e 3937 (ange-ftp-run-real-handler 'file-executable-p args))
2f7ea155 3938(defun ange-ftp-real-file-symlink-p (&rest args)
888b812e 3939 (ange-ftp-run-real-handler 'file-symlink-p args))
2f7ea155 3940(defun ange-ftp-real-delete-file (&rest args)
888b812e 3941 (ange-ftp-run-real-handler 'delete-file args))
2f7ea155 3942(defun ange-ftp-real-read-file-name-internal (&rest args)
888b812e 3943 (ange-ftp-run-real-handler 'read-file-name-internal args))
2f7ea155 3944(defun ange-ftp-real-verify-visited-file-modtime (&rest args)
888b812e 3945 (ange-ftp-run-real-handler 'verify-visited-file-modtime args))
2f7ea155 3946(defun ange-ftp-real-file-exists-p (&rest args)
888b812e 3947 (ange-ftp-run-real-handler 'file-exists-p args))
2f7ea155 3948(defun ange-ftp-real-write-region (&rest args)
888b812e 3949 (ange-ftp-run-real-handler 'write-region args))
2f7ea155 3950(defun ange-ftp-real-backup-buffer (&rest args)
888b812e 3951 (ange-ftp-run-real-handler 'backup-buffer args))
2f7ea155 3952(defun ange-ftp-real-copy-file (&rest args)
888b812e 3953 (ange-ftp-run-real-handler 'copy-file args))
2f7ea155 3954(defun ange-ftp-real-rename-file (&rest args)
888b812e 3955 (ange-ftp-run-real-handler 'rename-file args))
2f7ea155 3956(defun ange-ftp-real-file-attributes (&rest args)
888b812e 3957 (ange-ftp-run-real-handler 'file-attributes args))
2f7ea155 3958(defun ange-ftp-real-file-name-all-completions (&rest args)
888b812e 3959 (ange-ftp-run-real-handler 'file-name-all-completions args))
2f7ea155 3960(defun ange-ftp-real-file-name-completion (&rest args)
888b812e 3961 (ange-ftp-run-real-handler 'file-name-completion args))
c3554e95 3962(defun ange-ftp-real-insert-directory (&rest args)
888b812e 3963 (ange-ftp-run-real-handler 'insert-directory args))
d0bc419e 3964(defun ange-ftp-real-file-name-sans-versions (&rest args)
888b812e 3965 (ange-ftp-run-real-handler 'file-name-sans-versions args))
d0bc419e 3966(defun ange-ftp-real-shell-command (&rest args)
888b812e 3967 (ange-ftp-run-real-handler 'shell-command args))
724db75f 3968(defun ange-ftp-real-load (&rest args)
888b812e 3969 (ange-ftp-run-real-handler 'load args))
dae0ae5d
RS
3970(defun ange-ftp-real-find-backup-file-name (&rest args)
3971 (ange-ftp-run-real-handler 'find-backup-file-name args))
2f7ea155 3972\f
d0bc419e
RS
3973;; Here we support using dired on remote hosts.
3974;; I have turned off the support for using dired on foreign directory formats.
3975;; That involves too many unclean hooks.
3976;; It would be cleaner to support such operations by
3977;; converting the foreign directory format to something dired can understand;
3978;; something close to ls -l output.
3979;; The logical place to do this is in the functions ange-ftp-parse-...-listing.
3980
3981;; Some of the old dired hooks would still be needed even if this is done.
3982;; I have preserved (and modernized) those hooks.
3983;; So the format conversion should be all that is needed.
2f7ea155 3984
c3554e95 3985(defun ange-ftp-insert-directory (file switches &optional wildcard full)
d0bc419e 3986 (let ((short (ange-ftp-abbreviate-filename file))
a2702d99 3987 (parsed (ange-ftp-ftp-name (expand-file-name file))))
c3554e95 3988 (if parsed
d0bc419e
RS
3989 (insert
3990 (if wildcard
3991 (let ((default-directory (file-name-directory file)))
3992 (ange-ftp-ls (file-name-nondirectory file) switches nil nil t))
3993 (ange-ftp-ls file switches full)))
c3554e95 3994 (ange-ftp-real-insert-directory file switches wildcard full))))
2f7ea155 3995
d0bc419e 3996(defun ange-ftp-dired-uncache (dir)
625eb78e
BF
3997 (if (ange-ftp-ftp-name (expand-file-name dir))
3998 (setq ange-ftp-ls-cache-file nil)))
2f7ea155 3999
c3554e95
RS
4000(defvar ange-ftp-sans-version-alist nil
4001 "Alist of mapping host type into function to remove file version numbers.")
2f7ea155 4002
c3554e95 4003(defun ange-ftp-file-name-sans-versions (file keep-backup-version)
c3554e95 4004 (setq file (ange-ftp-abbreviate-filename file))
d0bc419e 4005 (let ((parsed (ange-ftp-ftp-name file))
c3554e95
RS
4006 host-type func)
4007 (if parsed
4008 (setq host-type (ange-ftp-host-type (car parsed))
d0bc419e 4009 func (cdr (assq (ange-ftp-host-type (car parsed))
c3554e95
RS
4010 ange-ftp-sans-version-alist))))
4011 (if func (funcall func file keep-backup-version)
4012 (ange-ftp-real-file-name-sans-versions file keep-backup-version))))
2f7ea155 4013
d0bc419e
RS
4014;;; This doesn't work yet; a new hook needs to be created.
4015;;; Maybe the new hook should be in call-process.
4016(defun ange-ftp-shell-command (command)
4017 (let* ((parsed (ange-ftp-ftp-name default-directory))
2f7ea155
RS
4018 (host (nth 0 parsed))
4019 (user (nth 1 parsed))
d0bc419e 4020 (name (nth 2 parsed)))
2f7ea155 4021 (if (not parsed)
d0bc419e
RS
4022 (ange-ftp-real-shell-command command)
4023 (if (> (length name) 0) ; else it's $HOME
4024 (setq command (concat "cd " name "; " command)))
2f7ea155
RS
4025 (setq command
4026 (format "%s %s \"%s\"" ; remsh -l USER does not work well
4027 ; on a hp-ux machine I tried
29f83886 4028 remote-shell-program host command))
2f7ea155
RS
4029 (ange-ftp-message "Remote command '%s' ..." command)
4030 ;; Cannot call ange-ftp-real-dired-run-shell-command here as it
4031 ;; would prepend "cd default-directory" --- which bombs because
d0bc419e
RS
4032 ;; default-directory is in ange-ftp syntax for remote file names.
4033 (ange-ftp-real-shell-command command))))
2f7ea155 4034
d0bc419e 4035;;; Thisis not hooked up yet.
2f7ea155 4036(defun ange-ftp-dired-call-process (program discard &rest arguments)
2f7ea155
RS
4037 ;; PROGRAM is always one of those below in the cond in dired.el.
4038 ;; The ARGUMENTS are (nearly) always files.
d0bc419e 4039 (if (ange-ftp-ftp-name default-directory)
2f7ea155
RS
4040 ;; Can't use ange-ftp-dired-host-type here because the current
4041 ;; buffer is *dired-check-process output*
4042 (condition-case oops
d0bc419e 4043 (cond ((equal "chmod" program)
2f7ea155
RS
4044 (ange-ftp-call-chmod arguments))
4045 ;; ((equal "chgrp" program))
4046 ;; ((equal dired-chown-program program))
4047 (t (error "Unknown remote command: %s" program)))
4048 (ftp-error (insert (format "%s: %s, %s\n"
4049 (nth 1 oops)
4050 (nth 2 oops)
4051 (nth 3 oops))))
4052 (error (insert (format "%s\n" (nth 1 oops)))))
4053 (apply 'call-process program nil (not discard) nil arguments)))
4054
d0bc419e 4055;;; This currently does not work; it is never called.
2f7ea155
RS
4056(defun ange-ftp-call-chmod (args)
4057 (if (< (length args) 2)
4058 (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args))
4059 (let ((mode (car args)))
4060 (mapcar
4061 (function
4062 (lambda (file)
4063 (setq file (expand-file-name file))
d0bc419e 4064 (let ((parsed (ange-ftp-ftp-name file)))
2f7ea155
RS
4065 (if parsed
4066 (let* ((host (nth 0 parsed))
4067 (user (nth 1 parsed))
d0bc419e 4068 (name (ange-ftp-quote-string (nth 2 parsed)))
2f7ea155
RS
4069 (abbr (ange-ftp-abbreviate-filename file))
4070 (result (ange-ftp-send-cmd host user
d0bc419e 4071 (list 'chmod mode name)
2f7ea155
RS
4072 (format "doing chmod %s"
4073 abbr))))
4074 (or (car result)
4075 (ange-ftp-error host user
4076 (format "chmod: %s: \"%s\""
4077 file
4078 (cdr result)))))))))
4079 (cdr args)))
4080 (setq ange-ftp-ls-cache-file nil)) ;stop confusing dired
2f7ea155 4081\f
d0bc419e
RS
4082;;; This is turned off because it has nothing properly to do
4083;;; with dired. It could be reasonable to adapt this to
4084;;; replace ange-ftp-copy-file.
4085
4086;;;;; ------------------------------------------------------------
4087;;;;; Noddy support for async copy-file within dired.
4088;;;;; ------------------------------------------------------------
4089
4090;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait)
4091;; "Documented as original."
4092;; (dired-handle-overwrite to)
4093;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil
4094;; cont nowait))
4095
4096;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg
4097;; &optional marker-char op1
4098;; how-to)
4099;; "Documented as original."
4100;; ;; we need to let ange-ftp-dired-create-files know that we indirectly
4101;; ;; called it rather than somebody else.
4102;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is
4103;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation
4104;; arg marker-char op1 how-to)))
4105
4106;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor
4107;; &optional marker-char)
4108;; "Documented as original."
4109;; (if (and (boundp 'ange-ftp-dired-do-create-files)
4110;; ;; called from ange-ftp-dired-do-create-files?
4111;; ange-ftp-dired-do-create-files
4112;; ;; any files worth copying?
4113;; fn-list
4114;; ;; we only support async copy-file at the mo.
4115;; (eq file-creator 'dired-copy-file)
4116;; ;; it is only worth calling the alternative function for remote files
4117;; ;; as we tie ourself in recursive knots otherwise.
4118;; (or (ange-ftp-ftp-name (car fn-list))
4119;; ;; we can only call the name constructor for dired-do-create-files
4120;; ;; since the one for regexps starts prompting here, there and
4121;; ;; everywhere.
4122;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list)))))
4123;; ;; use the process-filter driven routine rather than the iterative one.
4124;; (ange-ftp-dcf-1 file-creator
4125;; operation
4126;; fn-list
4127;; name-constructor
4128;; (and (boundp 'target) target) ;dynamically bound
4129;; marker-char
4130;; (current-buffer)
4131;; nil ;overwrite-query
4132;; nil ;overwrite-backup-query
4133;; nil ;failures
4134;; nil ;skipped
4135;; 0 ;success-count
4136;; (length fn-list) ;total
4137;; )
eb8c3be9 4138;; ;; normal case... use the interactive routine... much cheaper.
d0bc419e
RS
4139;; (ange-ftp-real-dired-create-files file-creator operation fn-list
4140;; name-constructor marker-char)))
4141
4142;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor
4143;; target marker-char buffer overwrite-query
4144;; overwrite-backup-query failures skipped
4145;; success-count total)
4146;; (let ((old-buf (current-buffer)))
4147;; (unwind-protect
4148;; (progn
4149;; (set-buffer buffer)
4150;; (if (null fn-list)
4151;; (ange-ftp-dcf-3 failures operation total skipped
4152;; success-count buffer)
2f7ea155 4153
d0bc419e
RS
4154;; (let* ((from (car fn-list))
4155;; (to (funcall name-constructor from)))
4156;; (if (equal to from)
4157;; (progn
4158;; (setq to nil)
4159;; (dired-log "Cannot %s to same file: %s\n"
4160;; (downcase operation) from)))
4161;; (if (not to)
4162;; (ange-ftp-dcf-1 file-creator
4163;; operation
4164;; (cdr fn-list)
4165;; name-constructor
4166;; target
4167;; marker-char
4168;; buffer
4169;; overwrite-query
4170;; overwrite-backup-query
4171;; failures
4172;; (cons (dired-make-relative from) skipped)
4173;; success-count
4174;; total)
4175;; (let* ((overwrite (file-exists-p to))
4176;; (overwrite-confirmed ; for dired-handle-overwrite
4177;; (and overwrite
4178;; (let ((help-form '(format "\
4179;;Type SPC or `y' to overwrite file `%s',
4180;;DEL or `n' to skip to next,
4181;;ESC or `q' to not overwrite any of the remaining files,
4182;;`!' to overwrite all remaining files with no more questions." to)))
4183;; (dired-query 'overwrite-query
4184;; "Overwrite `%s'?" to))))
4185;; ;; must determine if FROM is marked before file-creator
4186;; ;; gets a chance to delete it (in case of a move).
4187;; (actual-marker-char
4188;; (cond ((integerp marker-char) marker-char)
4189;; (marker-char (dired-file-marker from)) ; slow
4190;; (t nil))))
4191;; (condition-case err
4192;; (funcall file-creator from to overwrite-confirmed
4193;; (list (function ange-ftp-dcf-2)
4194;; nil ;err
4195;; file-creator operation fn-list
4196;; name-constructor
4197;; target
4198;; marker-char actual-marker-char
4199;; buffer to from
4200;; overwrite
4201;; overwrite-confirmed
4202;; overwrite-query
4203;; overwrite-backup-query
4204;; failures skipped success-count
4205;; total)
4206;; t)
4207;; (file-error ; FILE-CREATOR aborted
4208;; (ange-ftp-dcf-2 nil ;result
4209;; nil ;line
4210;; err
4211;; file-creator operation fn-list
4212;; name-constructor
4213;; target
4214;; marker-char actual-marker-char
4215;; buffer to from
4216;; overwrite
4217;; overwrite-confirmed
4218;; overwrite-query
4219;; overwrite-backup-query
4220;; failures skipped success-count
4221;; total))))))))
4222;; (set-buffer old-buf))))
4223
4224;;(defun ange-ftp-dcf-2 (result line err
4225;; file-creator operation fn-list
4226;; name-constructor
4227;; target
4228;; marker-char actual-marker-char
4229;; buffer to from
4230;; overwrite
4231;; overwrite-confirmed
4232;; overwrite-query
4233;; overwrite-backup-query
4234;; failures skipped success-count
4235;; total)
4236;; (let ((old-buf (current-buffer)))
4237;; (unwind-protect
4238;; (progn
4239;; (set-buffer buffer)
4240;; (if (or err (not result))
4241;; (progn
4242;; (setq failures (cons (dired-make-relative from) failures))
4243;; (dired-log "%s `%s' to `%s' failed:\n%s\n"
4244;; operation from to (or err line)))
4245;; (if overwrite
4246;; ;; If we get here, file-creator hasn't been aborted
4247;; ;; and the old entry (if any) has to be deleted
4248;; ;; before adding the new entry.
4249;; (dired-remove-file to))
4250;; (setq success-count (1+ success-count))
4251;; (message "%s: %d of %d" operation success-count total)
4252;; (dired-add-file to actual-marker-char))
2f7ea155 4253
d0bc419e
RS
4254;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list)
4255;; name-constructor
4256;; target
4257;; marker-char
4258;; buffer
4259;; overwrite-query
4260;; overwrite-backup-query
4261;; failures skipped success-count
4262;; total))
4263;; (set-buffer old-buf))))
4264
4265;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count
4266;; buffer)
4267;; (let ((old-buf (current-buffer)))
4268;; (unwind-protect
4269;; (progn
4270;; (set-buffer buffer)
4271;; (cond
4272;; (failures
4273;; (dired-log-summary
4274;; (message "%s failed for %d of %d file%s %s"
4275;; operation (length failures) total
4276;; (dired-plural-s total) failures)))
4277;; (skipped
4278;; (dired-log-summary
4279;; (message "%s: %d of %d file%s skipped %s"
4280;; operation (length skipped) total
4281;; (dired-plural-s total) skipped)))
4282;; (t
4283;; (message "%s: %s file%s."
4284;; operation success-count (dired-plural-s success-count))))
4285;; (dired-move-to-filename))
4286;; (set-buffer old-buf))))
2f7ea155
RS
4287\f
4288;;;; -----------------------------------------------
4289;;;; Unix Descriptive Listing (dl) Support
4290;;;; -----------------------------------------------
4291
d0bc419e
RS
4292;; This is turned off because nothing uses it currently
4293;; and because I don't understand what it's supposed to be for. --rms.
4294
4295;;(defconst ange-ftp-dired-dl-re-dir
4296;; "^. [^ /]+/[ \n]"
4297;; "Regular expression to use to search for dl directories.")
4298
4299;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist)
4300;; (setq ange-ftp-dired-re-dir-alist
4301;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir)
4302;; ange-ftp-dired-re-dir-alist)))
4303
4304;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol)
4305;; "In dired, move to the first character of the filename on this line."
4306;; ;; This is the Unix dl version.
4307;; (or eol (setq eol (progn (end-of-line) (point))))
4308;; (let (case-fold-search)
4309;; (beginning-of-line)
4310;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ")
4311;; (goto-char (+ (point) 2))
4312;; (if raise-error
4313;; (error "No file on this line")
4314;; nil))))
4315
4316;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist)
4317;; (setq ange-ftp-dired-move-to-filename-alist
4318;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename)
4319;; ange-ftp-dired-move-to-filename-alist)))
4320
4321;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol)
4322;; ;; Assumes point is at beginning of filename.
4323;; ;; So, it should be called only after (dired-move-to-filename t).
4324;; ;; On failure, signals an error or returns nil.
4325;; ;; This is the Unix dl version.
4326;; (let ((opoint (point))
4327;; case-fold-search hidden)
4328;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4329;; (setq hidden (and selective-display
4330;; (save-excursion
4331;; (search-forward "\r" eol t))))
4332;; (if hidden
4333;; (if no-error
4334;; nil
4335;; (error
4336;; (substitute-command-keys
4337;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
4338;; (skip-chars-forward "^ /" eol)
4339;; (if (eq opoint (point))
4340;; (if no-error
4341;; nil
4342;; (error "No file on this line"))
4343;; (point)))))
4344
4345;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist)
4346;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4347;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename)
4348;; ange-ftp-dired-move-to-end-of-filename-alist)))
2f7ea155
RS
4349\f
4350;;;; ------------------------------------------------------------
4351;;;; VOS support (VOS support is probably broken,
4352;;;; but I don't know anything about VOS.)
4353;;;; ------------------------------------------------------------
4354;
d0bc419e
RS
4355;(defun ange-ftp-fix-name-for-vos (name &optional reverse)
4356; (setq name (copy-sequence name))
2f7ea155
RS
4357; (let ((from (if reverse ?\> ?\/))
4358; (to (if reverse ?\/ ?\>))
d0bc419e 4359; (i (1- (length name))))
2f7ea155 4360; (while (>= i 0)
d0bc419e
RS
4361; (if (= (aref name i) from)
4362; (aset name i to))
2f7ea155 4363; (setq i (1- i)))
d0bc419e 4364; name))
2f7ea155 4365;
d0bc419e
RS
4366;(or (assq 'vos ange-ftp-fix-name-func-alist)
4367; (setq ange-ftp-fix-name-func-alist
4368; (cons '(vos . ange-ftp-fix-name-for-vos)
4369; ange-ftp-fix-name-func-alist)))
2f7ea155
RS
4370;
4371;(or (memq 'vos ange-ftp-dumb-host-types)
4372; (setq ange-ftp-dumb-host-types
4373; (cons 'vos ange-ftp-dumb-host-types)))
4374;
d0bc419e
RS
4375;(defun ange-ftp-fix-dir-name-for-vos (dir-name)
4376; (ange-ftp-fix-name-for-vos
4377; (concat dir-name
4378; (if (eq ?/ (aref dir-name (1- (length dir-name))))
2f7ea155
RS
4379; "" "/")
4380; "*")))
4381;
d0bc419e
RS
4382;(or (assq 'vos ange-ftp-fix-dir-name-func-alist)
4383; (setq ange-ftp-fix-dir-name-func-alist
4384; (cons '(vos . ange-ftp-fix-dir-name-for-vos)
4385; ange-ftp-fix-dir-name-func-alist)))
2f7ea155
RS
4386;
4387;(defvar ange-ftp-vos-host-regexp nil
4388; "If a host matches this regexp then it is assumed to be running VOS.")
4389;
4390;(defun ange-ftp-vos-host (host)
4391; (and ange-ftp-vos-host-regexp
65135ec2 4392; (save-match-data
2f7ea155
RS
4393; (string-match ange-ftp-vos-host-regexp host))))
4394;
4395;(defun ange-ftp-parse-vos-listing ()
4396; "Parse the current buffer which is assumed to be in VOS list -all
4397;format, and return a hashtable as the result."
4398; (let ((tbl (ange-ftp-make-hashtable))
4399; (type-list
4400; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40)
4401; ("^Dirs: [0-9]+\n+" t 30)))
4402; type-regexp type-is-dir type-col file)
4403; (goto-char (point-min))
65135ec2 4404; (save-match-data
2f7ea155
RS
4405; (while type-list
4406; (setq type-regexp (car (car type-list))
4407; type-is-dir (nth 1 (car type-list))
4408; type-col (nth 2 (car type-list))
4409; type-list (cdr type-list))
4410; (if (re-search-forward type-regexp nil t)
4411; (while (eq (char-after (point)) ? )
4412; (move-to-column type-col)
4413; (setq file (buffer-substring (point)
4414; (progn
4415; (end-of-line 1)
4416; (point))))
4417; (ange-ftp-put-hash-entry file type-is-dir tbl)
4418; (forward-line 1))))
4419; (ange-ftp-put-hash-entry "." 'vosdir tbl)
4420; (ange-ftp-put-hash-entry ".." 'vosdir tbl))
4421; tbl))
4422;
4423;(or (assq 'vos ange-ftp-parse-list-func-alist)
4424; (setq ange-ftp-parse-list-func-alist
4425; (cons '(vos . ange-ftp-parse-vos-listing)
4426; ange-ftp-parse-list-func-alist)))
4427\f
4428;;;; ------------------------------------------------------------
4429;;;; VMS support.
4430;;;; ------------------------------------------------------------
4431
d0bc419e
RS
4432;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS
4433;; to UNIX-ish.
4434(defun ange-ftp-fix-name-for-vms (name &optional reverse)
65135ec2 4435 (save-match-data
2f7ea155 4436 (if reverse
d0bc419e 4437 (if (string-match "^\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)$" name)
2f7ea155
RS
4438 (let (drive dir file)
4439 (if (match-beginning 1)
d0bc419e 4440 (setq drive (substring name
2f7ea155
RS
4441 (match-beginning 1)
4442 (match-end 1))))
4443 (if (match-beginning 2)
4444 (setq dir
d0bc419e 4445 (substring name (match-beginning 2) (match-end 2))))
2f7ea155
RS
4446 (if (match-beginning 3)
4447 (setq file
d0bc419e 4448 (substring name (match-beginning 3) (match-end 3))))
2f7ea155
RS
4449 (and dir
4450 (setq dir (apply (function concat)
4451 (mapcar (function
4452 (lambda (char)
4453 (if (= char ?.)
4454 (vector ?/)
4455 (vector char))))
4456 (substring dir 1 -1)))))
4457 (concat (and drive
4458 (concat "/" drive "/"))
4459 dir (and dir "/")
4460 file))
d0bc419e 4461 (error "name %s didn't match" name))
2f7ea155 4462 (let (drive dir file tmp)
d0bc419e
RS
4463 (if (string-match "^/[^:]+:/" name)
4464 (setq drive (substring name 1
2f7ea155 4465 (1- (match-end 0)))
d0bc419e
RS
4466 name (substring name (match-end 0))))
4467 (setq tmp (file-name-directory name))
2f7ea155
RS
4468 (if tmp
4469 (setq dir (apply (function concat)
4470 (mapcar (function
4471 (lambda (char)
4472 (if (= char ?/)
4473 (vector ?.)
4474 (vector char))))
4475 (substring tmp 0 -1)))))
d0bc419e 4476 (setq file (file-name-nondirectory name))
2f7ea155
RS
4477 (concat drive
4478 (and dir (concat "[" (if drive nil ".") dir "]"))
4479 file)))))
4480
d0bc419e
RS
4481;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1")
4482;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t)
2f7ea155 4483
d0bc419e
RS
4484(or (assq 'vms ange-ftp-fix-name-func-alist)
4485 (setq ange-ftp-fix-name-func-alist
4486 (cons '(vms . ange-ftp-fix-name-for-vms)
4487 ange-ftp-fix-name-func-alist)))
2f7ea155
RS
4488
4489(or (memq 'vms ange-ftp-dumb-host-types)
4490 (setq ange-ftp-dumb-host-types
4491 (cons 'vms ange-ftp-dumb-host-types)))
4492
4493;; It is important that this function barf for directories for which we know
4494;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/".
4495;; This is because it saves an unnecessary FTP error, or possibly the listing
4496;; might succeed, but give erroneous info. This last case is particularly
4497;; likely for OS's (like MTS) for which we need to use a wildcard in order
4498;; to list a directory.
4499
d0bc419e
RS
4500;; Convert name from UNIX-ish to VMS ready for a DIRectory listing.
4501(defun ange-ftp-fix-dir-name-for-vms (dir-name)
2f7ea155
RS
4502 ;; Should there be entries for .. -> [-] and . -> [] below. Don't
4503 ;; think so, because expand-filename should have already short-circuited
4504 ;; them.
d0bc419e 4505 (cond ((string-equal dir-name "/")
2f7ea155 4506 (error "Cannot get listing for fictitious \"/\" directory."))
d0bc419e 4507 ((string-match "^/[-A-Z0-9_$]+:/$" dir-name)
2f7ea155 4508 (error "Cannot get listing for device."))
d0bc419e 4509 ((ange-ftp-fix-name-for-vms dir-name))))
2f7ea155 4510
d0bc419e
RS
4511(or (assq 'vms ange-ftp-fix-dir-name-func-alist)
4512 (setq ange-ftp-fix-dir-name-func-alist
4513 (cons '(vms . ange-ftp-fix-dir-name-for-vms)
4514 ange-ftp-fix-dir-name-func-alist)))
2f7ea155
RS
4515
4516(defvar ange-ftp-vms-host-regexp nil)
4517
d0bc419e 4518;; Return non-nil if HOST is running VMS.
2f7ea155 4519(defun ange-ftp-vms-host (host)
2f7ea155 4520 (and ange-ftp-vms-host-regexp
65135ec2 4521 (save-match-data
2f7ea155
RS
4522 (string-match ange-ftp-vms-host-regexp host))))
4523
4524;; Because some VMS ftp servers convert filenames to lower case
4525;; we allow a-z in the filename regexp. I'm not too happy about this.
4526
4527(defconst ange-ftp-vms-filename-regexp
4528 (concat
26add1bf
KH
4529 "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\."
4530 "[-_A-Za-z0-9$]*;+[0-9]*\\)")
2f7ea155
RS
4531 "Regular expression to match for a valid VMS file name in Dired buffer.
4532Stupid freaking bug! Position of _ and $ shouldn't matter but they do.
4533Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX
4534Other orders of $ and _ seem to all work just fine.")
4535
4536;; These parsing functions are as general as possible because the syntax
4537;; of ftp listings from VMS hosts is a bit erratic. What saves us is that
4538;; the VMS filename syntax is so rigid. If they bomb on a listing in the
4539;; standard VMS Multinet format, then this is a bug. If they bomb on a listing
4540;; from vms.weird.net, then too bad.
4541
d0bc419e 4542;; Extract the next filename from a VMS dired-like listing.
2f7ea155 4543(defun ange-ftp-parse-vms-filename ()
2f7ea155
RS
4544 (if (re-search-forward
4545 ange-ftp-vms-filename-regexp
4546 nil t)
4547 (buffer-substring (match-beginning 0) (match-end 0))))
4548
d0bc419e
RS
4549;; Parse the current buffer which is assumed to be in MultiNet FTP dir
4550;; format, and return a hashtable as the result.
2f7ea155 4551(defun ange-ftp-parse-vms-listing ()
2f7ea155
RS
4552 (let ((tbl (ange-ftp-make-hashtable))
4553 file)
4554 (goto-char (point-min))
65135ec2 4555 (save-match-data
2f7ea155
RS
4556 (while (setq file (ange-ftp-parse-vms-filename))
4557 (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file)
4558 ;; deal with directories
4559 (ange-ftp-put-hash-entry
4560 (substring file 0 (match-beginning 0)) t tbl)
4561 (ange-ftp-put-hash-entry file nil tbl)
4562 (if (string-match ";[0-9]+$" file) ; deal with extension
4563 ;; sans extension
4564 (ange-ftp-put-hash-entry
4565 (substring file 0 (match-beginning 0)) nil tbl)))
4566 (forward-line 1))
4567 ;; Would like to look for a "Total" line, or a "Directory" line to
4568 ;; make sure that the listing isn't complete garbage before putting
4569 ;; in "." and "..", but we can't even count on all VAX's giving us
4570 ;; either of these.
4571 (ange-ftp-put-hash-entry "." t tbl)
4572 (ange-ftp-put-hash-entry ".." t tbl))
4573 tbl))
4574
4575(or (assq 'vms ange-ftp-parse-list-func-alist)
4576 (setq ange-ftp-parse-list-func-alist
4577 (cons '(vms . ange-ftp-parse-vms-listing)
4578 ange-ftp-parse-list-func-alist)))
4579
4580;; This version only deletes file entries which have
4581;; explicit version numbers, because that is all VMS allows.
4582
4583;; Can the following two functions be speeded up using file
4584;; completion functions?
4585
d0bc419e 4586(defun ange-ftp-vms-delete-file-entry (name &optional dir-p)
2f7ea155 4587 (if dir-p
d0bc419e 4588 (ange-ftp-internal-delete-file-entry name t)
65135ec2 4589 (save-match-data
d0bc419e 4590 (let ((file (ange-ftp-get-file-part name)))
2f7ea155
RS
4591 (if (string-match ";[0-9]+$" file)
4592 ;; In VMS you can't delete a file without an explicit
4593 ;; version number, or wild-card (e.g. FOO;*)
4594 ;; For now, we give up on wildcards.
4595 (let ((files (ange-ftp-get-hash-entry
d0bc419e 4596 (file-name-directory name)
2f7ea155
RS
4597 ange-ftp-files-hashtable)))
4598 (if files
4599 (let* ((root (substring file 0
4600 (match-beginning 0)))
4601 (regexp (concat "^"
4602 (regexp-quote root)
4603 ";[0-9]+$"))
4604 versions)
4605 (ange-ftp-del-hash-entry file files)
4606 ;; Now we need to check if there are any
4607 ;; versions left. If not, then delete the
4608 ;; root entry.
4609 (mapatoms
4610 '(lambda (sym)
4611 (and (string-match regexp (get sym 'key))
4612 (setq versions t)))
4613 files)
4614 (or versions
4615 (ange-ftp-del-hash-entry root files))))))))))
4616
4617(or (assq 'vms ange-ftp-delete-file-entry-alist)
4618 (setq ange-ftp-delete-file-entry-alist
4619 (cons '(vms . ange-ftp-vms-delete-file-entry)
4620 ange-ftp-delete-file-entry-alist)))
4621
d0bc419e 4622(defun ange-ftp-vms-add-file-entry (name &optional dir-p)
2f7ea155 4623 (if dir-p
d0bc419e 4624 (ange-ftp-internal-add-file-entry name t)
2f7ea155 4625 (let ((files (ange-ftp-get-hash-entry
d0bc419e 4626 (file-name-directory name)
2f7ea155
RS
4627 ange-ftp-files-hashtable)))
4628 (if files
d0bc419e 4629 (let ((file (ange-ftp-get-file-part name)))
65135ec2 4630 (save-match-data
2f7ea155
RS
4631 (if (string-match ";[0-9]+$" file)
4632 (ange-ftp-put-hash-entry
4633 (substring file 0 (match-beginning 0))
4634 nil files)
4635 ;; Need to figure out what version of the file
4636 ;; is being added.
4637 (let ((regexp (concat "^"
4638 (regexp-quote file)
4639 ";\\([0-9]+\\)$"))
4640 (version 0))
4641 (mapatoms
4642 '(lambda (sym)
4643 (let ((name (get sym 'key)))
4644 (and (string-match regexp name)
4645 (setq version
4646 (max version
4647 (string-to-int
4648 (substring name
4649 (match-beginning 1)
4650 (match-end 1))))))))
4651 files)
4652 (setq version (1+ version))
4653 (ange-ftp-put-hash-entry
4654 (concat file ";" (int-to-string version))
4655 nil files))))
4656 (ange-ftp-put-hash-entry file nil files))))))
4657
4658(or (assq 'vms ange-ftp-add-file-entry-alist)
4659 (setq ange-ftp-add-file-entry-alist
4660 (cons '(vms . ange-ftp-vms-add-file-entry)
4661 ange-ftp-add-file-entry-alist)))
4662
4663
4664(defun ange-ftp-add-vms-host (host)
d0bc419e 4665 "Mark HOST as the name of a machine running VMS."
2f7ea155
RS
4666 (interactive
4667 (list (read-string "Host: "
68f5eb5a 4668 (let ((name (or (buffer-file-name) default-directory)))
d0bc419e 4669 (and name (car (ange-ftp-ftp-name name)))))))
2f7ea155
RS
4670 (if (not (ange-ftp-vms-host host))
4671 (setq ange-ftp-vms-host-regexp
4672 (concat "^" (regexp-quote host) "$"
4673 (and ange-ftp-vms-host-regexp "\\|")
4674 ange-ftp-vms-host-regexp)
4675 ange-ftp-host-cache nil)))
4676
4677
4678(defun ange-ftp-vms-file-name-as-directory (name)
65135ec2 4679 (save-match-data
2f7ea155
RS
4680 (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?$" name)
4681 (setq name (substring name 0 (match-beginning 0))))
4682 (ange-ftp-real-file-name-as-directory name)))
4683
4684(or (assq 'vms ange-ftp-file-name-as-directory-alist)
4685 (setq ange-ftp-file-name-as-directory-alist
4686 (cons '(vms . ange-ftp-vms-file-name-as-directory)
4687 ange-ftp-file-name-as-directory-alist)))
4688
4689;;; Tree dired support:
4690
4691;; For this code I have borrowed liberally from Sebastian Kremer's
4692;; dired-vms.el
4693
4694
d0bc419e
RS
4695;;;; These regexps must be anchored to beginning of line.
4696;;;; Beware that the ftpd may put the device in front of the filename.
4697
4698;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]"
4699;; "Regular expression to use to search for VMS executable files.")
4700
4701;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]"
4702;; "Regular expression to use to search for VMS directories.")
4703
4704;;(or (assq 'vms ange-ftp-dired-re-exe-alist)
4705;; (setq ange-ftp-dired-re-exe-alist
4706;; (cons (cons 'vms ange-ftp-dired-vms-re-exe)
4707;; ange-ftp-dired-re-exe-alist)))
4708
4709;;(or (assq 'vms ange-ftp-dired-re-dir-alist)
4710;; (setq ange-ftp-dired-re-dir-alist
4711;; (cons (cons 'vms ange-ftp-dired-vms-re-dir)
4712;; ange-ftp-dired-re-dir-alist)))
4713
4714;;(defun ange-ftp-dired-vms-insert-headerline (dir)
4715;; ;; VMS inserts a headerline. I would prefer the headerline
4716;; ;; to be in ange-ftp format. This version tries to
4717;; ;; be careful, because we can't count on a headerline
4718;; ;; over ftp, and we wouldn't want to delete anything
4719;; ;; important.
4720;; (save-excursion
4721;; (if (looking-at "^ wildcard ")
4722;; (forward-line 1))
4723;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n")
4724;; (delete-region (point) (match-end 0))))
4725;; (ange-ftp-real-dired-insert-headerline dir))
4726
4727;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist)
4728;; (setq ange-ftp-dired-insert-headerline-alist
4729;; (cons '(vms . ange-ftp-dired-vms-insert-headerline)
4730;; ange-ftp-dired-insert-headerline-alist)))
4731
4732;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol)
4733;; "In dired, move to first char of filename on this line.
4734;;Returns position (point) or nil if no filename on this line."
4735;; ;; This is the VMS version.
4736;; (let (case-fold-search)
4737;; (or eol (setq eol (progn (end-of-line) (point))))
4738;; (beginning-of-line)
4739;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t)
4740;; (goto-char (match-beginning 1))
4741;; (if raise-error
4742;; (error "No file on this line")
4743;; nil))))
4744
4745;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist)
4746;; (setq ange-ftp-dired-move-to-filename-alist
4747;; (cons '(vms . ange-ftp-dired-vms-move-to-filename)
4748;; ange-ftp-dired-move-to-filename-alist)))
4749
4750;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol)
4751;; ;; Assumes point is at beginning of filename.
4752;; ;; So, it should be called only after (dired-move-to-filename t).
4753;; ;; case-fold-search must be nil, at least for VMS.
4754;; ;; On failure, signals an error or returns nil.
4755;; ;; This is the VMS version.
4756;; (let (opoint hidden case-fold-search)
4757;; (setq opoint (point))
4758;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4759;; (setq hidden (and selective-display
4760;; (save-excursion (search-forward "\r" eol t))))
4761;; (if hidden
4762;; nil
4763;; (re-search-forward ange-ftp-vms-filename-regexp eol t))
4764;; (or no-error
4765;; (not (eq opoint (point)))
4766;; (error
4767;; (if hidden
4768;; (substitute-command-keys
4769;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
4770;; "No file on this line")))
4771;; (if (eq opoint (point))
4772;; nil
4773;; (point))))
4774
4775;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist)
4776;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4777;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename)
4778;; ange-ftp-dired-move-to-end-of-filename-alist)))
4779
4780;;(defun ange-ftp-dired-vms-between-files ()
4781;; (save-excursion
4782;; (beginning-of-line)
4783;; (or (equal (following-char) 10) ; newline
4784;; (equal (following-char) 9) ; tab
4785;; (progn (forward-char 2)
4786;; (or (looking-at "Total of")
4787;; (equal (following-char) 32))))))
4788
4789;;(or (assq 'vms ange-ftp-dired-between-files-alist)
4790;; (setq ange-ftp-dired-between-files-alist
4791;; (cons '(vms . ange-ftp-dired-vms-between-files)
4792;; ange-ftp-dired-between-files-alist)))
2f7ea155
RS
4793
4794;; Beware! In VMS filenames must be of the form "FILE.TYPE".
4795;; Therefore, we cannot just append a ".Z" to filenames for
4796;; compressed files. Instead, we turn "FILE.TYPE" into
4797;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do.
4798
4799(defun ange-ftp-vms-make-compressed-filename (name &optional reverse)
d0bc419e
RS
4800 (cond
4801 ((string-match "-Z;[0-9]+$" name)
4802 (list nil (substring name 0 (match-beginning 0))))
4803 ((string-match ";[0-9]+$" name)
4804 (list nil (substring name 0 (match-beginning 0))))
4805 ((string-match "-Z$" name)
4806 (list nil (substring name 0 -2)))
4807 (t
4808 (list t
4809 (if (string-match ";[0-9]+$" name)
4810 (concat (substring name 0 (match-beginning 0))
4811 "-Z")
4812 (concat name "-Z"))))))
4813
4814(or (assq 'vms ange-ftp-make-compressed-filename-alist)
4815 (setq ange-ftp-make-compressed-filename-alist
2f7ea155 4816 (cons '(vms . ange-ftp-vms-make-compressed-filename)
d0bc419e
RS
4817 ange-ftp-make-compressed-filename-alist)))
4818
4819;;;; When the filename is too long, VMS will use two lines to list a file
4820;;;; (damn them!) This will confuse dired. To solve this, need to convince
4821;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of
4822;;;; (forward-line 1). This would require a number of changes to dired.el.
4823;;;; If dired gets confused, revert-buffer will fix it.
4824
4825;;(defun ange-ftp-dired-vms-ls-trim ()
4826;; (goto-char (point-min))
4827;; (let ((case-fold-search nil))
4828;; (re-search-forward ange-ftp-vms-filename-regexp))
4829;; (beginning-of-line)
4830;; (delete-region (point-min) (point))
4831;; (forward-line 1)
4832;; (delete-region (point) (point-max)))
4833
4834
4835;;(or (assq 'vms ange-ftp-dired-ls-trim-alist)
4836;; (setq ange-ftp-dired-ls-trim-alist
4837;; (cons '(vms . ange-ftp-dired-vms-ls-trim)
4838;; ange-ftp-dired-ls-trim-alist)))
4839
007f0260 4840(defun ange-ftp-vms-sans-version (name &rest args)
65135ec2 4841 (save-match-data
2f7ea155
RS
4842 (if (string-match ";[0-9]+$" name)
4843 (substring name 0 (match-beginning 0))
4844 name)))
4845
d0bc419e
RS
4846(or (assq 'vms ange-ftp-sans-version-alist)
4847 (setq ange-ftp-sans-version-alist
4848 (cons '(vms . ange-ftp-vms-sans-version)
4849 ange-ftp-sans-version-alist)))
4850
4851;;(defvar ange-ftp-file-version-alist)
4852
4853;;;;; The vms version of clean-directory has 2 more optional args
4854;;;;; than the usual dired version. This is so that it can be used by
4855;;;;; ange-ftp-dired-vms-flag-backup-files.
4856
4857;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg)
4858;; "Flag numerical backups for deletion.
4859;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
4860;;Positive prefix arg KEEP overrides `dired-kept-versions';
4861;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
4862
4863;;To clear the flags on these files, you can use \\[dired-flag-backup-files]
4864;;with a prefix argument."
4865;;; (interactive "P") ; Never actually called interactively.
4866;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions)))
4867;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
4868;; ;; late-retention must NEVER be allowed to be less than 1 in VMS!
4869;; ;; This could wipe ALL copies of the file.
4870;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep)))
4871;; (action (or msg "Cleaning"))
4872;; (ange-ftp-trample-marker (or marker dired-del-marker))
4873;; (ange-ftp-file-version-alist ()))
4874;; (message (concat action
4875;; " numerical backups (keeping %d late, %d old)...")
4876;; late-retention early-retention)
4877;; ;; Look at each file.
4878;; ;; If the file has numeric backup versions,
4879;; ;; put on ange-ftp-file-version-alist an element of the form
4880;; ;; (FILENAME . VERSION-NUMBER-LIST)
4881;; (dired-map-dired-file-lines (function
4882;; ange-ftp-dired-vms-collect-file-versions))
4883;; ;; Sort each VERSION-NUMBER-LIST,
4884;; ;; and remove the versions not to be deleted.
4885;; (let ((fval ange-ftp-file-version-alist))
4886;; (while fval
4887;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
4888;; (v-count (length sorted-v-list)))
4889;; (if (> v-count (+ early-retention late-retention))
4890;; (rplacd (nthcdr early-retention sorted-v-list)
4891;; (nthcdr (- v-count late-retention)
4892;; sorted-v-list)))
4893;; (rplacd (car fval)
4894;; (cdr sorted-v-list)))
4895;; (setq fval (cdr fval))))
4896;; ;; Look at each file. If it is a numeric backup file,
4897;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
4898;; (dired-map-dired-file-lines
4899;; (function
4900;; ange-ftp-dired-vms-trample-file-versions mark))
4901;; (message (concat action " numerical backups...done"))))
4902
4903;;(or (assq 'vms ange-ftp-dired-clean-directory-alist)
4904;; (setq ange-ftp-dired-clean-directory-alist
4905;; (cons '(vms . ange-ftp-dired-vms-clean-directory)
4906;; ange-ftp-dired-clean-directory-alist)))
4907
4908;;(defun ange-ftp-dired-vms-collect-file-versions (fn)
4909;; ;; "If it looks like file FN has versions, return a list of the versions.
4910;; ;;That is a list of strings which are file names.
4911;; ;;The caller may want to flag some of these files for deletion."
4912;;(let ((name (nth 2 (ange-ftp-ftp-name fn))))
4913;; (if (string-match ";[0-9]+$" name)
4914;; (let* ((name (substring name 0 (match-beginning 0)))
4915;; (fn (ange-ftp-replace-name-component fn name)))
4916;; (if (not (assq fn ange-ftp-file-version-alist))
4917;; (let* ((base-versions
4918;; (concat (file-name-nondirectory name) ";"))
4919;; (bv-length (length base-versions))
4920;; (possibilities (file-name-all-completions
4921;; base-versions
4922;; (file-name-directory fn)))
4923;; (versions (mapcar
4924;; '(lambda (arg)
4925;; (if (and (string-match
4926;; "[0-9]+$" arg bv-length)
4927;; (= (match-beginning 0) bv-length))
4928;; (string-to-int (substring arg bv-length))
4929;; 0))
4930;; possibilities)))
4931;; (if versions
4932;; (setq
4933;; ange-ftp-file-version-alist
4934;; (cons (cons fn versions)
4935;; ange-ftp-file-version-alist)))))))))
4936
4937;;(defun ange-ftp-dired-vms-trample-file-versions (fn)
4938;; (let* ((start-vn (string-match ";[0-9]+$" fn))
4939;; base-version-list)
4940;; (and start-vn
4941;; (setq base-version-list ; there was a base version to which
4942;; (assoc (substring fn 0 start-vn) ; this looks like a
4943;; ange-ftp-file-version-alist)) ; subversion
4944;; (not (memq (string-to-int (substring fn (1+ start-vn)))
4945;; base-version-list)) ; this one doesn't make the cut
4946;; (progn (beginning-of-line)
4947;; (delete-char 1)
4948;; (insert ange-ftp-trample-marker)))))
4949
4950;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p)
4951;; (let ((dired-kept-versions 1)
4952;; (kept-old-versions 0)
4953;; marker msg)
4954;; (if unflag-p
4955;; (setq marker ?\040 msg "Unflagging")
4956;; (setq marker dired-del-marker msg "Cleaning"))
4957;; (ange-ftp-dired-vms-clean-directory nil marker msg)))
4958
4959;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist)
4960;; (setq ange-ftp-dired-flag-backup-files-alist
4961;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files)
4962;; ange-ftp-dired-flag-backup-files-alist)))
4963
4964;;(defun ange-ftp-dired-vms-backup-diff (&optional switches)
4965;; (let ((file (dired-get-filename 'no-dir))
4966;; bak)
4967;; (if (and (string-match ";[0-9]+$" file)
4968;; ;; Find most recent previous version.
4969;; (let ((root (substring file 0 (match-beginning 0)))
4970;; (ver
4971;; (string-to-int (substring file (1+ (match-beginning 0)))))
4972;; found)
4973;; (setq ver (1- ver))
4974;; (while (and (> ver 0) (not found))
4975;; (setq bak (concat root ";" (int-to-string ver)))
4976;; (and (file-exists-p bak) (setq found t))
4977;; (setq ver (1- ver)))
4978;; found))
4979;; (if switches
4980;; (diff (expand-file-name bak) (expand-file-name file) switches)
4981;; (diff (expand-file-name bak) (expand-file-name file)))
4982;; (error "No previous version found for %s" file))))
4983
4984;;(or (assq 'vms ange-ftp-dired-backup-diff-alist)
4985;; (setq ange-ftp-dired-backup-diff-alist
4986;; (cons '(vms . ange-ftp-dired-vms-backup-diff)
4987;; ange-ftp-dired-backup-diff-alist)))
2f7ea155
RS
4988
4989\f
4990;;;; ------------------------------------------------------------
4991;;;; MTS support
4992;;;; ------------------------------------------------------------
4993
4994
d0bc419e
RS
4995;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from
4996;; MTS to UNIX-ish.
4997(defun ange-ftp-fix-name-for-mts (name &optional reverse)
65135ec2 4998 (save-match-data
2f7ea155 4999 (if reverse
d0bc419e 5000 (if (string-match "^\\([^:]+:\\)?\\(.*\\)$" name)
2f7ea155
RS
5001 (let (acct file)
5002 (if (match-beginning 1)
d0bc419e 5003 (setq acct (substring name 0 (match-end 1))))
2f7ea155 5004 (if (match-beginning 2)
d0bc419e 5005 (setq file (substring name
2f7ea155
RS
5006 (match-beginning 2) (match-end 2))))
5007 (concat (and acct (concat "/" acct "/"))
5008 file))
d0bc419e
RS
5009 (error "name %s didn't match" name))
5010 (if (string-match "^/\\([^:]+:\\)/\\(.*\\)$" name)
5011 (concat (substring name 1 (match-end 1))
5012 (substring name (match-beginning 2) (match-end 2)))
2f7ea155 5013 ;; Let's hope that mts will recognize it anyway.
d0bc419e 5014 name))))
2f7ea155 5015
d0bc419e
RS
5016(or (assq 'mts ange-ftp-fix-name-func-alist)
5017 (setq ange-ftp-fix-name-func-alist
5018 (cons '(mts . ange-ftp-fix-name-for-mts)
5019 ange-ftp-fix-name-func-alist)))
2f7ea155 5020
d0bc419e
RS
5021;; Convert name from UNIX-ish to MTS ready for a DIRectory listing.
5022;; Remember that there are no directories in MTS.
5023(defun ange-ftp-fix-dir-name-for-mts (dir-name)
5024 (if (string-equal dir-name "/")
2f7ea155 5025 (error "Cannot get listing for fictitious \"/\" directory.")
d0bc419e 5026 (let ((dir-name (ange-ftp-fix-name-for-mts dir-name)))
2f7ea155 5027 (cond
d0bc419e 5028 ((string-equal dir-name "")
2f7ea155 5029 "?")
d0bc419e
RS
5030 ((string-match ":$" dir-name)
5031 (concat dir-name "?"))
5032 (dir-name))))) ; It's just a single file.
2f7ea155 5033
d0bc419e
RS
5034(or (assq 'mts ange-ftp-fix-dir-name-func-alist)
5035 (setq ange-ftp-fix-dir-name-func-alist
5036 (cons '(mts . ange-ftp-fix-dir-name-for-mts)
5037 ange-ftp-fix-dir-name-func-alist)))
2f7ea155
RS
5038
5039(or (memq 'mts ange-ftp-dumb-host-types)
5040 (setq ange-ftp-dumb-host-types
5041 (cons 'mts ange-ftp-dumb-host-types)))
5042
5043(defvar ange-ftp-mts-host-regexp nil)
5044
d0bc419e 5045;; Return non-nil if HOST is running MTS.
2f7ea155 5046(defun ange-ftp-mts-host (host)
2f7ea155 5047 (and ange-ftp-mts-host-regexp
65135ec2 5048 (save-match-data
2f7ea155
RS
5049 (string-match ange-ftp-mts-host-regexp host))))
5050
d0bc419e 5051;; Parse the current buffer which is assumed to be in mts ftp dir format.
2f7ea155 5052(defun ange-ftp-parse-mts-listing ()
2f7ea155
RS
5053 (let ((tbl (ange-ftp-make-hashtable)))
5054 (goto-char (point-min))
65135ec2 5055 (save-match-data
2f7ea155
RS
5056 (while (re-search-forward ange-ftp-date-regexp nil t)
5057 (end-of-line)
5058 (skip-chars-backward " ")
5059 (let ((end (point)))
5060 (skip-chars-backward "-A-Z0-9_.!")
5061 (ange-ftp-put-hash-entry (buffer-substring (point) end) nil tbl))
5062 (forward-line 1)))
5063 ;; Don't need to bother with ..
5064 (ange-ftp-put-hash-entry "." t tbl)
5065 tbl))
5066
5067(or (assq 'mts ange-ftp-parse-list-func-alist)
5068 (setq ange-ftp-parse-list-func-alist
5069 (cons '(mts . ange-ftp-parse-mts-listing)
5070 ange-ftp-parse-list-func-alist)))
5071
5072(defun ange-ftp-add-mts-host (host)
d0bc419e 5073 "Mark HOST as the name of a machine running MTS."
2f7ea155
RS
5074 (interactive
5075 (list (read-string "Host: "
68f5eb5a 5076 (let ((name (or (buffer-file-name) default-directory)))
d0bc419e 5077 (and name (car (ange-ftp-ftp-name name)))))))
2f7ea155
RS
5078 (if (not (ange-ftp-mts-host host))
5079 (setq ange-ftp-mts-host-regexp
5080 (concat "^" (regexp-quote host) "$"
5081 (and ange-ftp-mts-host-regexp "\\|")
5082 ange-ftp-mts-host-regexp)
5083 ange-ftp-host-cache nil)))
5084
5085;;; Tree dired support:
5086
d0bc419e
RS
5087;;;; There aren't too many systems left that use MTS. This dired support will
5088;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems
5089;;;; implement ftp in the same way. If not, it might be necessary to make the
5090;;;; following more flexible.
5091
5092;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol)
5093;; "In dired, move to first char of filename on this line.
5094;;Returns position (point) or nil if no filename on this line."
5095;; ;; This is the MTS version.
5096;; (or eol (setq eol (progn (end-of-line) (point))))
5097;; (beginning-of-line)
5098;; (if (re-search-forward
5099;; ange-ftp-date-regexp eol t)
5100;; (progn
5101;; (skip-chars-forward " ") ; Eat blanks after date
5102;; (skip-chars-forward "0-9:" eol) ; Eat time or year
5103;; (skip-chars-forward " " eol) ; one space before filename
5104;; ;; When listing an account other than the users own account it appends
5105;; ;; ACCT: to the beginning of the filename. Skip over this.
5106;; (and (looking-at "[A-Z0-9_.]+:")
5107;; (goto-char (match-end 0)))
5108;; (point))
5109;; (if raise-error
5110;; (error "No file on this line")
5111;; nil)))
5112
5113;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist)
5114;; (setq ange-ftp-dired-move-to-filename-alist
5115;; (cons '(mts . ange-ftp-dired-mts-move-to-filename)
5116;; ange-ftp-dired-move-to-filename-alist)))
5117
5118;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol)
5119;; ;; Assumes point is at beginning of filename.
5120;; ;; So, it should be called only after (dired-move-to-filename t).
5121;; ;; On failure, signals an error or returns nil.
5122;; ;; This is the MTS version.
5123;; (let (opoint hidden case-fold-search)
5124;; (setq opoint (point)
5125;; eol (save-excursion (end-of-line) (point))
5126;; hidden (and selective-display
5127;; (save-excursion (search-forward "\r" eol t))))
5128;; (if hidden
5129;; nil
5130;; (skip-chars-forward "-A-Z0-9._!" eol))
5131;; (or no-error
5132;; (not (eq opoint (point)))
5133;; (error
5134;; (if hidden
5135;; (substitute-command-keys
5136;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5137;; "No file on this line")))
5138;; (if (eq opoint (point))
5139;; nil
5140;; (point))))
5141
5142;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist)
5143;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5144;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename)
5145;; ange-ftp-dired-move-to-end-of-filename-alist)))
2f7ea155
RS
5146\f
5147;;;; ------------------------------------------------------------
5148;;;; CMS support
5149;;;; ------------------------------------------------------------
5150
d0bc419e 5151;; Since CMS doesn't have any full file name syntax, we have to fudge
98deaf97 5152;; things with cd's. We actually send too many cd's, but it's dangerous
2f7ea155
RS
5153;; to try to remember the current minidisk, because if the connection
5154;; is closed and needs to be reopened, we will find ourselves back in
5155;; the default minidisk. This is fairly likely since CMS ftp servers
5156;; usually close the connection after 5 minutes of inactivity.
5157
5158;; Have I got the filename character set right?
5159
d0bc419e 5160(defun ange-ftp-fix-name-for-cms (name &optional reverse)
65135ec2 5161 (save-match-data
2f7ea155
RS
5162 (if reverse
5163 ;; Since we only convert output from a pwd in this direction,
5164 ;; we'll assume that it's a minidisk, and make it into a
5165 ;; directory file name. Note that the expand-dir-hashtable
5166 ;; stores directories without the trailing /. Is this
5167 ;; consistent?
d0bc419e 5168 (concat "/" name)
2f7ea155 5169 (if (string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$"
d0bc419e
RS
5170 name)
5171 (let ((minidisk (substring name 1 (match-end 1))))
2f7ea155 5172 (if (match-beginning 2)
d0bc419e 5173 (let ((file (substring name (match-beginning 2)
2f7ea155
RS
5174 (match-end 2)))
5175 (cmd (concat "cd " minidisk))
5176
5177 ;; Note that host and user are bound in the call
5178 ;; to ange-ftp-send-cmd
5179 (proc (ange-ftp-get-process ange-ftp-this-host
5180 ange-ftp-this-user)))
5181
5182 ;; Must use ange-ftp-raw-send-cmd here to avoid
5183 ;; an infinite loop.
d0bc419e 5184 (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg))
2f7ea155
RS
5185 file
5186 ;; failed... try ONCE more.
5187 (setq proc (ange-ftp-get-process ange-ftp-this-host
5188 ange-ftp-this-user))
d0bc419e
RS
5189 (let ((result (ange-ftp-raw-send-cmd proc cmd
5190 ange-ftp-this-msg)))
2f7ea155
RS
5191 (if (car result)
5192 file
5193 ;; failed. give up.
5194 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5195 (format "cd to minidisk %s failed: %s"
5196 minidisk (cdr result)))))))
5197 ;; return the minidisk
5198 minidisk))
5199 (error "Invalid CMS filename")))))
5200
d0bc419e
RS
5201(or (assq 'cms ange-ftp-fix-name-func-alist)
5202 (setq ange-ftp-fix-name-func-alist
5203 (cons '(cms . ange-ftp-fix-name-for-cms)
5204 ange-ftp-fix-name-func-alist)))
2f7ea155
RS
5205
5206(or (memq 'cms ange-ftp-dumb-host-types)
5207 (setq ange-ftp-dumb-host-types
5208 (cons 'cms ange-ftp-dumb-host-types)))
5209
d0bc419e
RS
5210;; Convert name from UNIX-ish to CMS ready for a DIRectory listing.
5211(defun ange-ftp-fix-dir-name-for-cms (dir-name)
2f7ea155 5212 (cond
d0bc419e 5213 ((string-equal "/" dir-name)
2f7ea155 5214 (error "Cannot get listing for fictitious \"/\" directory."))
d0bc419e
RS
5215 ((string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$" dir-name)
5216 (let* ((minidisk (substring dir-name (match-beginning 1) (match-end 1)))
2f7ea155 5217 ;; host and user are bound in the call to ange-ftp-send-cmd
d0bc419e 5218 (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user))
2f7ea155
RS
5219 (cmd (concat "cd " minidisk))
5220 (file (if (match-beginning 2)
5221 ;; it's a single file
d0bc419e 5222 (substring dir-name (match-beginning 2)
2f7ea155
RS
5223 (match-end 2))
5224 ;; use the wild-card
5225 "*")))
5226 (if (car (ange-ftp-raw-send-cmd proc cmd))
5227 file
5228 ;; try again...
d0bc419e
RS
5229 (setq proc (ange-ftp-get-process ange-ftp-this-host
5230 ange-ftp-this-user))
2f7ea155
RS
5231 (let ((result (ange-ftp-raw-send-cmd proc cmd)))
5232 (if (car result)
5233 file
5234 ;; give up
d0bc419e 5235 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
2f7ea155
RS
5236 (format "cd to minidisk %s failed: "
5237 minidisk (cdr result))))))))
d0bc419e 5238 (t (error "Invalid CMS file name"))))
2f7ea155 5239
d0bc419e
RS
5240(or (assq 'cms ange-ftp-fix-dir-name-func-alist)
5241 (setq ange-ftp-fix-dir-name-func-alist
5242 (cons '(cms . ange-ftp-fix-dir-name-for-cms)
5243 ange-ftp-fix-dir-name-func-alist)))
2f7ea155
RS
5244
5245(defvar ange-ftp-cms-host-regexp nil
5246 "Regular expression to match hosts running the CMS operating system.")
5247
d0bc419e 5248;; Return non-nil if HOST is running CMS.
2f7ea155 5249(defun ange-ftp-cms-host (host)
2f7ea155 5250 (and ange-ftp-cms-host-regexp
65135ec2 5251 (save-match-data
2f7ea155
RS
5252 (string-match ange-ftp-cms-host-regexp host))))
5253
5254(defun ange-ftp-add-cms-host (host)
d0bc419e 5255 "Mark HOST as the name of a CMS host."
2f7ea155
RS
5256 (interactive
5257 (list (read-string "Host: "
68f5eb5a 5258 (let ((name (or (buffer-file-name) default-directory)))
d0bc419e 5259 (and name (car (ange-ftp-ftp-name name)))))))
2f7ea155
RS
5260 (if (not (ange-ftp-cms-host host))
5261 (setq ange-ftp-cms-host-regexp
5262 (concat "^" (regexp-quote host) "$"
5263 (and ange-ftp-cms-host-regexp "\\|")
5264 ange-ftp-cms-host-regexp)
5265 ange-ftp-host-cache nil)))
5266
5267(defun ange-ftp-parse-cms-listing ()
d0bc419e 5268 ;; Parse the current buffer which is assumed to be a CMS directory listing.
2f7ea155
RS
5269 ;; If we succeed in getting a listing, then we will assume that the minidisk
5270 ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work
5271 ;; because ange-ftp doesn't know that the root hashtable has only part of
5272 ;; the info. It will assume that if a minidisk isn't in it, then it doesn't
5273 ;; exist. It would be nice if completion worked for minidisks, as we
5274 ;; discover them.
5275; (let* ((dir-file (directory-file-name file))
5276; (root (file-name-directory dir-file))
5277; (minidisk (ange-ftp-get-file-part dir-file))
5278; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable)))
5279; (if root-tbl
5280; (ange-ftp-put-hash-entry minidisk t root-tbl)
5281; (setq root-tbl (ange-ftp-make-hashtable))
5282; (ange-ftp-put-hash-entry minidisk t root-tbl)
5283; (ange-ftp-put-hash-entry "." t root-tbl)
5284; (ange-ftp-set-files root root-tbl)))
5285 ;; Now do the usual parsing
5286 (let ((tbl (ange-ftp-make-hashtable)))
5287 (goto-char (point-min))
65135ec2 5288 (save-match-data
2f7ea155
RS
5289 (while
5290 (re-search-forward
5291 "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t)
5292 (ange-ftp-put-hash-entry
5293 (concat (buffer-substring (match-beginning 1)
5294 (match-end 1))
5295 "."
5296 (buffer-substring (match-beginning 2)
5297 (match-end 2)))
5298 nil tbl)
5299 (forward-line 1))
5300 (ange-ftp-put-hash-entry "." t tbl))
5301 tbl))
5302
5303(or (assq 'cms ange-ftp-parse-list-func-alist)
5304 (setq ange-ftp-parse-list-func-alist
5305 (cons '(cms . ange-ftp-parse-cms-listing)
5306 ange-ftp-parse-list-func-alist)))
5307
d0bc419e
RS
5308;;;;; Tree dired support:
5309
5310;;(defconst ange-ftp-dired-cms-re-exe
5311;; "^. [-A-Z0-9$_]+ +EXEC "
5312;; "Regular expression to use to search for CMS executables.")
5313
5314;;(or (assq 'cms ange-ftp-dired-re-exe-alist)
5315;; (setq ange-ftp-dired-re-exe-alist
5316;; (cons (cons 'cms ange-ftp-dired-cms-re-exe)
5317;; ange-ftp-dired-re-exe-alist)))
5318
5319
5320;;(defun ange-ftp-dired-cms-insert-headerline (dir)
5321;; ;; CMS has no total line, so we insert a blank line for
5322;; ;; aesthetics.
5323;; (insert "\n")
5324;; (forward-char -1)
5325;; (ange-ftp-real-dired-insert-headerline dir))
5326
5327;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist)
5328;; (setq ange-ftp-dired-insert-headerline-alist
5329;; (cons '(cms . ange-ftp-dired-cms-insert-headerline)
5330;; ange-ftp-dired-insert-headerline-alist)))
5331
5332;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol)
5333;; "In dired, move to the first char of filename on this line."
5334;; ;; This is the CMS version.
5335;; (or eol (setq eol (progn (end-of-line) (point))))
5336;; (let (case-fold-search)
5337;; (beginning-of-line)
5338;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t)
5339;; (goto-char (1+ (match-beginning 0)))
5340;; (if raise-error
5341;; (error "No file on this line")
5342;; nil))))
5343
5344;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist)
5345;; (setq ange-ftp-dired-move-to-filename-alist
5346;; (cons '(cms . ange-ftp-dired-cms-move-to-filename)
5347;; ange-ftp-dired-move-to-filename-alist)))
5348
5349;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol)
5350;; ;; Assumes point is at beginning of filename.
5351;; ;; So, it should be called only after (dired-move-to-filename t).
5352;; ;; case-fold-search must be nil, at least for VMS.
5353;; ;; On failure, signals an error or returns nil.
5354;; ;; This is the CMS version.
5355;; (let ((opoint (point))
5356;; case-fold-search hidden)
5357;; (or eol (setq eol (save-excursion (end-of-line) (point))))
5358;; (setq hidden (and selective-display
5359;; (save-excursion
5360;; (search-forward "\r" eol t))))
5361;; (if hidden
5362;; (if no-error
5363;; nil
5364;; (error
5365;; (substitute-command-keys
5366;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
5367;; (skip-chars-forward "-A-Z0-9$_" eol)
5368;; (skip-chars-forward " " eol)
5369;; (skip-chars-forward "-A-Z0-9$_" eol)
5370;; (if (eq opoint (point))
5371;; (if no-error
5372;; nil
5373;; (error "No file on this line"))
5374;; (point)))))
5375
5376;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist)
5377;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5378;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename)
5379;; ange-ftp-dired-move-to-end-of-filename-alist)))
2f7ea155
RS
5380
5381(defun ange-ftp-cms-make-compressed-filename (name &optional reverse)
d0bc419e
RS
5382 (if (string-match "-Z$" name)
5383 (list nil (substring name 0 -2))
5384 (list t (concat name "-Z"))))
5385
5386(or (assq 'cms ange-ftp-make-compressed-filename-alist)
5387 (setq ange-ftp-make-compressed-filename-alist
2f7ea155 5388 (cons '(cms . ange-ftp-cms-make-compressed-filename)
d0bc419e
RS
5389 ange-ftp-make-compressed-filename-alist)))
5390
5391;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep)
5392;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep)))
5393;; (and name
5394;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name)
5395;; (concat (substring name 0 (match-end 1))
5396;; "."
5397;; (substring name (match-beginning 2) (match-end 2)))
5398;; name))))
5399
5400;;(or (assq 'cms ange-ftp-dired-get-filename-alist)
5401;; (setq ange-ftp-dired-get-filename-alist
5402;; (cons '(cms . ange-ftp-dired-cms-get-filename)
5403;; ange-ftp-dired-get-filename-alist)))
2f7ea155
RS
5404\f
5405;;;; ------------------------------------------------------------
5406;;;; Finally provide package.
5407;;;; ------------------------------------------------------------
5408
5409(provide 'ange-ftp)
c8472948
ER
5410
5411;;; ange-ftp.el ends here