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