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