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