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