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