1 ;;; ange-ftp.el --- transparent FTP support for GNU Emacs
3 ;; Copyright (C) 1989,90,91,92,93,94,95,96,98 Free Software Foundation, Inc.
5 ;; Author: Andy Norman (ange@hplb.hpl.hp.com)
9 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
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'.
39 ;; For example: if find-file is given a filename of:
41 ;; /ange@anorman:/tmp/notes
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.
48 ;; Extended filename syntax:
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.
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.
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.
63 ;; Passwords for user "anonymous":
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.
74 ;; The FTP servers on some UNIX machines have problems if the 'ls' command is
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.
85 ;; File name completion:
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.
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.
98 ;; Killing the "*ftp user@host*" buffer also kills the ftp process.
99 ;; This should not cause ange-ftp any grief.
101 ;; Binary file transfers:
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.
107 ;; Account passwords:
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.
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.
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.
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.
137 ;; ange-ftp has support for running the ftp process on a different (gateway)
138 ;; machine. The way it works is as follows:
140 ;; 1) Set the variable 'ange-ftp-gateway-host' to the name of a machine
141 ;; that doesn't have the access restrictions.
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
148 ;; "\\.hp\\.com$\\|^[^.]*$"
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.
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.
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:
161 ;; "/nfs/hplose/ange/ange-ftp"
163 ;; where /nfs/hplose/ange is a directory that is shared between the
164 ;; gateway machine and the local machine.
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.
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.
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.
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.
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
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:
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
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:
204 ;; "stty -onlcr -echo"
206 ;; will work on HP-UX machines, whereas:
210 ;; appears to work for some Sun machines.
212 ;; That's all there is to it.
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.
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.
228 ;; Tips for using ange-ftp:
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.
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.
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.
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.
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?
272 ;; ---------------------------------------------------------------------
274 ;; ---------------------------------------------------------------------
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.
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
295 ;; C-x C-f /anonymous@ymir.claremont.edu:CSV/POLICY/RULES.MEM
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
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
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
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
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.
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
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
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.
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.
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
385 ;; ------------------------------------------------------------------
387 ;; ------------------------------------------------------------------
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.
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.
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
412 ;; 4. Null (blank) passwords confuse both ange-ftp and some FTP daemons.
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.
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.
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.
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?
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...).
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.
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
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.
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.
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.
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
483 ;; To [un]subscribe to ange-ftp-lovers, or to report mailer problems with the
484 ;; list, please mail one of the following addresses:
486 ;; ange-ftp-lovers-request@anorman.hpl.hp.com
488 ;; ange-ftp-lovers-request%anorman.hpl.hp.com@hplb.hpl.hp.com
490 ;; Please don't forget the -request part.
492 ;; For mail to be posted directly to ange-ftp-lovers, send to one of the
493 ;; following addresses:
495 ;; ange-ftp-lovers@anorman.hpl.hp.com
497 ;; ange-ftp-lovers%anorman.hpl.hp.com@hplb.hpl.hp.com
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.
504 ;; The latest version of ange-ftp can usually be obtained via anonymous ftp
506 ;; alpha.gnu.ai.mit.edu:ange-ftp/ange-ftp.tar.Z
508 ;; ugle.unit.no:/pub/gnu/emacs-lisp/ange-ftp.tar.Z
510 ;; archive.cis.ohio-state.edu:pub/gnu/emacs/elisp-archive/packages/ange-ftp.tar.Z
512 ;; The archives for ange-ftp-lovers can be found via anonymous ftp under:
514 ;; ftp.reed.edu:pub/mailing-lists/ange-ftp/
516 ;; -----------------------------------------------------------
517 ;; Technical information on this package:
518 ;; -----------------------------------------------------------
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.
524 ;; Checklist for adding non-UNIX support for TYPE
526 ;; The following functions may need TYPE versions:
527 ;; (not all functions will be needed for every OS)
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
542 ;; ange-ftp-TYPE-host-regexp
543 ;; May need to add TYPE to ange-ftp-dumb-host-types
545 ;; Check the following functions for OS dependent coding:
547 ;; ange-ftp-host-type
548 ;; ange-ftp-guess-host-type
549 ;; ange-ftp-allow-child-lookup
551 ;; Host type conventions:
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.
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.
562 ;; t = a remote host of unknown type. Think t as in true, it's remote.
563 ;; Currently, `unix' is used as the default remote host type.
564 ;; Maybe we should use t.
566 ;; TYPE = a remote host of TYPE type.
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'.
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
582 ;; 1: See ange-ftp-ls
585 ;; -----------------------------------------------------------
587 ;; -----------------------------------------------------------
589 ;; Thanks to Roland McGrath for improving the filename syntax handling,
590 ;; for suggesting many enhancements and for numerous cleanups to the code.
592 ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways.
594 ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and
595 ;; dired / shell auto-loading.
597 ;; Thanks to Sebastian Kremer for dired support and for many ideas and
600 ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support,
601 ;; VOS support, and hostname completion.
603 ;; Thanks to Nakagawa Takayuki for many good ideas, filename-completion, help
604 ;; with file-name expansion, efficiency worries, stylistic concerns and many
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.
611 ;; Thanks to Dave Smith who wrote the info file for ange-ftp.
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
626 (defvar comint-last-output-start nil)
627 (defvar comint-last-input-start nil)
628 (defvar comint-last-input-end nil))
630 ;;;; ------------------------------------------------------------
631 ;;;; User customization variables.
632 ;;;; ------------------------------------------------------------
634 (defgroup ange-ftp nil
635 "Accessing remote files and directories using FTP
636 made as simple and transparent as possible."
640 (defcustom ange-ftp-name-format
641 '("^/\\(\\([^@/:]*\\)@\\)?\\([^@/:]*[^@/:.]\\):\\(.*\\)" . (3 2 4))
642 "*Format of a fully expanded remote file name.
644 This is a list of the form \(REGEXP HOST USER NAME\),
645 where REGEXP is a regular expression matching
646 the full remote name, and HOST, USER, and NAME are the numbers of
647 parenthesized expressions in REGEXP for the components (in that order)."
650 (integer :tag "Host group")
651 (integer :tag "User group")
652 (integer :tag "Name group")))
654 ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of
655 ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs.
656 ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out.
658 (defvar ange-ftp-multi-msgs
659 "^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-"
660 "*Regular expression matching the start of a multiline ftp reply.")
662 (defvar ange-ftp-good-msgs
663 "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark"
664 "*Regular expression matching ftp \"success\" messages.")
666 ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT.
667 ;; Also CMS machines use a multiline 550- reply to say that you
668 ;; don't have write permission. ange-ftp gets into multi-line skip
669 ;; mode and hangs. Have it ignore 550- instead. It will then barf
670 ;; when it gets the 550 line, as it should.
672 (defcustom ange-ftp-skip-msgs
673 (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|"
674 "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|"
675 "^Data connection \\|"
676 "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye\\|"
678 "*Regular expression matching ftp messages that can be ignored."
682 (defcustom ange-ftp-fatal-msgs
683 (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|"
684 "^No control connection\\|unknown host\\|^lost connection")
685 "*Regular expression matching ftp messages that indicate serious errors.
687 These mean that the FTP process should (or already has) been killed."
691 (defcustom ange-ftp-gateway-fatal-msgs
692 "No route to host\\|Connection closed\\|No such host\\|Login incorrect"
693 "*Regular expression matching login failure messages from rlogin/telnet."
697 (defcustom ange-ftp-xfer-size-msgs
698 "^150 .* connection for .* (\\([0-9]+\\) bytes)"
699 "*Regular expression used to determine the number of bytes in a FTP transfer."
703 (defcustom ange-ftp-tmp-name-template
704 (expand-file-name "ange-ftp" temporary-file-directory)
705 "*Template used to create temporary files."
709 (defcustom ange-ftp-gateway-tmp-name-template "/tmp/ange-ftp"
710 "*Template used to create temporary files when ftp-ing through a gateway.
712 Files starting with this prefix need to be accessible from BOTH the local
713 machine and the gateway machine, and need to have the SAME name on both
714 machines, that is, /tmp is probably NOT what you want, since that is rarely
719 (defcustom ange-ftp-netrc-filename "~/.netrc"
720 "*File in .netrc format to search for passwords."
724 (defcustom ange-ftp-disable-netrc-security-check (eq system-type 'windows-nt)
725 "*If non-nil avoid checking permissions on the .netrc file."
729 (defcustom ange-ftp-default-user nil
730 "*User name to use when none is specified in a file name.
732 If non-nil but not a string, you are prompted for the name.
733 If nil, the value of `ange-ftp-netrc-default-user' is used.
734 If that is nil too, then your login name is used.
736 Once a connection to a given host has been initiated, the user name
737 and password information for that host are cached and re-used by
738 ange-ftp. Use \\[ange-ftp-set-user] to change the cached values,
739 since setting `ange-ftp-default-user' directly does not affect
740 the cached information."
742 :type '(choice (const :tag "Default" nil)
744 (other :tag "Prompt" t)))
746 (defcustom ange-ftp-netrc-default-user nil
747 "Alternate default user name to use when none is specified.
749 This variable is set from the `default' command in your `.netrc' file,
752 :type '(choice (const :tag "Default" nil)
755 (defcustom ange-ftp-default-password nil
756 "*Password to use when the user name equals `ange-ftp-default-user'."
758 :type '(choice (const :tag "Default" nil)
761 (defcustom ange-ftp-default-account nil
762 "*Account to use when the user name equals `ange-ftp-default-user'."
764 :type '(choice (const :tag "Default" nil)
767 (defcustom ange-ftp-netrc-default-password nil
768 "*Password to use when the user name equals `ange-ftp-netrc-default-user'."
770 :type '(choice (const :tag "Default" nil)
773 (defcustom ange-ftp-netrc-default-account nil
774 "*Account to use when the user name equals `ange-ftp-netrc-default-user'."
776 :type '(choice (const :tag "Default" nil)
779 (defcustom ange-ftp-generate-anonymous-password t
780 "*If t, use value of `user-mail-address' as password for anonymous ftp.
782 If a string, then use that string as the password.
783 If nil, prompt the user for a password."
785 :type '(choice (const :tag "Prompt" nil)
787 (other :tag "User address" t)))
789 (defcustom ange-ftp-dumb-unix-host-regexp nil
790 "*If non-nil, regexp matching hosts on which `dir' command lists directory."
792 :type '(choice (const :tag "Default" nil)
795 (defcustom ange-ftp-binary-file-name-regexp
796 (concat "\\.[zZ]$\\|\\.lzh$\\|\\.arc$\\|\\.zip$\\|\\.zoo$\\|\\.tar$\\|"
797 "\\.dvi$\\|\\.ps$\\|\\.elc$\\|TAGS$\\|\\.gif$\\|"
798 "\\.EXE\\(;[0-9]+\\)?$\\|\\.[zZ]-part-..$\\|\\.gz$\\|"
800 "*If a file matches this regexp then it is transferred in binary mode."
804 (defcustom ange-ftp-gateway-host nil
805 "*Name of host to use as gateway machine when local FTP isn't possible."
807 :type '(choice (const :tag "Default" nil)
810 (defcustom ange-ftp-local-host-regexp ".*"
811 "*Regexp selecting hosts which can be reached directly with ftp.
813 For other hosts the FTP process is started on \`ange-ftp-gateway-host\'
814 instead, and/or reached via \`ange-ftp-gateway-ftp-program-name\'."
818 (defcustom ange-ftp-gateway-program-interactive nil
819 "*If non-nil then the gateway program should give a shell prompt.
821 Both telnet and rlogin do something like this."
825 (defcustom ange-ftp-gateway-program remote-shell-program
826 "*Name of program to spawn a shell on the gateway machine.
828 Valid candidates are rsh (remsh on some systems), telnet and rlogin. See
829 also the gateway variable above."
831 :type '(choice (const "rsh")
836 (defcustom ange-ftp-gateway-prompt-pattern "^[^#$%>;\n]*[#$%>;] *"
837 "*Regexp matching prompt after complete login sequence on gateway machine.
839 A match for this means the shell is now awaiting input. Make this regexp as
840 strict as possible; it shouldn't match *anything* at all except the user's
841 initial prompt. The above string will fail under most SUN-3's since it
842 matches the login banner."
846 (defvar ange-ftp-gateway-setup-term-command
847 (if (eq system-type 'hpux)
848 "stty -onlcr -echo\n"
850 "*Set up terminal after logging in to the gateway machine.
851 This command should stop the terminal from echoing each command, and
852 arrange to strip out trailing ^M characters.")
854 (defcustom ange-ftp-smart-gateway nil
855 "*Non-nil means the ftp gateway and/or the gateway ftp program is smart.
857 Don't bother telnetting, etc., already connected to desired host transparently,
858 or just issue a user@host command in case \`ange-ftp-gateway-host\' is non-nil."
862 (defcustom ange-ftp-smart-gateway-port "21"
863 "*Port on gateway machine to use when smart gateway is in operation."
867 (defcustom ange-ftp-send-hash t
868 "*If non-nil, send the HASH command to the FTP client."
872 (defcustom ange-ftp-binary-hash-mark-size nil
873 "*Default size, in bytes, between hash-marks when transferring a binary file.
874 If nil, this variable will be locally overridden if the FTP client outputs a
875 suitable response to the HASH command. If non-nil, this value takes
876 precedence over the local value."
878 :type '(choice (const :tag "Overridden" nil)
881 (defcustom ange-ftp-ascii-hash-mark-size 1024
882 "*Default size, in bytes, between hash-marks when transferring an ASCII file.
883 This variable is buffer-local and will be locally overridden if the FTP client
884 outputs a suitable response to the HASH command."
888 (defcustom ange-ftp-process-verbose t
889 "*If non-nil then be chatty about interaction with the FTP process."
893 (defcustom ange-ftp-ftp-program-name "ftp"
894 "*Name of FTP program to run."
898 (defcustom ange-ftp-gateway-ftp-program-name "ftp"
899 "*Name of FTP program to run when accessing non-local hosts.
901 Some AT&T folks claim to use something called `pftp' here."
905 (defcustom ange-ftp-ftp-program-args '("-i" "-n" "-g" "-v")
906 "*A list of arguments passed to the FTP program when started."
908 :type '(repeat string))
910 (defcustom ange-ftp-nslookup-program nil
911 "*If non-nil, this is a string naming the nslookup program."
913 :type '(choice (const :tag "None" nil)
916 (defcustom ange-ftp-make-backup-files ()
917 "*Non-nil means make backup files for \"magic\" remote files."
921 (defcustom ange-ftp-retry-time 5
922 "*Number of seconds to wait before retry if file or listing doesn't arrive.
923 This might need to be increased for very slow connections."
927 (defcustom ange-ftp-auto-save 0
928 "If 1, allow ange-ftp files to be auto-saved.
929 If 0, inhibit auto-saving of ange-ftp files.
930 Don't use any other value."
932 :type '(choice (const :tag "Suppress" 0)
933 (const :tag "Allow" 1)))
935 ;;;; ------------------------------------------------------------
936 ;;;; Hash table support.
937 ;;;; ------------------------------------------------------------
941 (defun ange-ftp-make-hashtable (&optional size)
942 "Make an obarray suitable for use as a hashtable.
943 SIZE, if supplied, should be a prime number."
944 (make-vector (or size 31) 0))
946 (defun ange-ftp-map-hashtable (fun tbl)
947 "Call FUNCTION on each key and value in HASHTABLE."
951 (funcall fun (get sym 'key) (get sym 'val))))
954 (defmacro ange-ftp-make-hash-key (key)
955 "Convert KEY into a suitable key for a hashtable."
956 (` (if (stringp (, key))
958 (prin1-to-string (, key)))))
960 (defun ange-ftp-get-hash-entry (key tbl)
961 "Return the value associated with KEY in HASHTABLE."
962 (let ((sym (intern-soft (ange-ftp-make-hash-key key) tbl)))
963 (and sym (get sym 'val))))
965 (defun ange-ftp-put-hash-entry (key val tbl)
966 "Record an association between KEY and VALUE in HASHTABLE."
967 (let ((sym (intern (ange-ftp-make-hash-key key) tbl)))
971 (defun ange-ftp-del-hash-entry (key tbl)
972 "Copy all symbols except KEY in HASHTABLE and return modified hashtable."
973 (let* ((len (length tbl))
974 (new-tbl (ange-ftp-make-hashtable len))
976 (ange-ftp-map-hashtable
980 (ange-ftp-put-hash-entry k v new-tbl))))
983 (aset tbl i (aref new-tbl i))
987 (defun ange-ftp-hash-entry-exists-p (key tbl)
988 "Return whether there is an association for KEY in TABLE."
989 (intern-soft (ange-ftp-make-hash-key key) tbl))
991 (defun ange-ftp-hash-table-keys (tbl)
992 "Return a sorted list of all the active keys in TABLE, as strings."
993 (sort (all-completions "" tbl)
994 (function string-lessp)))
996 ;;;; ------------------------------------------------------------
997 ;;;; Internal variables.
998 ;;;; ------------------------------------------------------------
1000 (defvar ange-ftp-data-buffer-name " *ftp data*"
1001 "Buffer name to hold directory listing data received from ftp process.")
1003 (defvar ange-ftp-netrc-modtime nil
1004 "Last modified time of the netrc file from file-attributes.")
1006 (defvar ange-ftp-user-hashtable (ange-ftp-make-hashtable)
1007 "Hash table holding associations between HOST, USER pairs.")
1009 (defvar ange-ftp-passwd-hashtable (ange-ftp-make-hashtable)
1010 "Mapping between a HOST, USER pair and a PASSWORD for them.
1011 All HOST values should be in lower case.")
1013 (defvar ange-ftp-account-hashtable (ange-ftp-make-hashtable)
1014 "Mapping between a HOST, USER pair and a ACCOUNT password for them.")
1016 (defvar ange-ftp-files-hashtable (ange-ftp-make-hashtable 97)
1017 "Hash table for storing directories and their respective files.")
1019 (defvar ange-ftp-inodes-hashtable (ange-ftp-make-hashtable 97)
1020 "Hash table for storing file names and their \"inode numbers\".")
1022 (defvar ange-ftp-next-inode-number 1
1023 "Next \"inode number\" value. We give each file name a unique number.")
1025 (defvar ange-ftp-ls-cache-lsargs nil
1026 "Last set of args used by ange-ftp-ls.")
1028 (defvar ange-ftp-ls-cache-file nil
1029 "Last file passed to ange-ftp-ls.")
1031 (defvar ange-ftp-ls-cache-res nil
1032 "Last result returned from ange-ftp-ls.")
1034 (defconst ange-ftp-expand-dir-hashtable (ange-ftp-make-hashtable))
1036 (defconst ange-ftp-expand-dir-regexp "^5.0 \\([^: ]+\\):")
1038 ;; These are local variables in each FTP process buffer.
1039 (defvar ange-ftp-hash-mark-unit nil)
1040 (defvar ange-ftp-hash-mark-count nil)
1041 (defvar ange-ftp-xfer-size nil)
1042 (defvar ange-ftp-process-string nil)
1043 (defvar ange-ftp-process-result-line nil)
1044 (defvar ange-ftp-process-busy nil)
1045 (defvar ange-ftp-process-result nil)
1046 (defvar ange-ftp-process-multi-skip nil)
1047 (defvar ange-ftp-process-msg nil)
1048 (defvar ange-ftp-process-continue nil)
1049 (defvar ange-ftp-last-percent nil)
1051 ;; These variables are bound by one function and examined by another.
1052 ;; Leave them void globally for error checking.
1053 (defvar ange-ftp-this-file)
1054 (defvar ange-ftp-this-dir)
1055 (defvar ange-ftp-this-user)
1056 (defvar ange-ftp-this-host)
1057 (defvar ange-ftp-this-msg)
1058 (defvar ange-ftp-completion-ignored-pattern)
1059 (defvar ange-ftp-trample-marker)
1061 ;; New error symbols.
1062 (put 'ftp-error 'error-conditions '(ftp-error file-error error))
1063 ;; (put 'ftp-error 'error-message "FTP error")
1065 ;;; ------------------------------------------------------------
1066 ;;; Enhanced message support.
1067 ;;; ------------------------------------------------------------
1069 (defun ange-ftp-message (fmt &rest args)
1070 "Display message in echo area, but indicate if truncated.
1071 Args are as in `message': a format string, plus arguments to be formatted."
1072 (let ((msg (apply (function format) fmt args))
1073 (max (window-width (minibuffer-window))))
1076 (if (>= (length msg) max)
1077 ;; Take just the last MAX - 3 chars of the string.
1078 (setq msg (concat "> " (substring msg (- 3 max)))))
1079 (message "%s" msg))))
1081 (defun ange-ftp-abbreviate-filename (file &optional new)
1082 "Abbreviate the file name FILE relative to the default-directory.
1083 If the optional parameter NEW is given and the non-directory parts match,
1084 only return the directory part of FILE."
1086 (if (and default-directory
1087 (string-match (concat "^"
1088 (regexp-quote default-directory)
1090 (setq file (substring file (1- (match-end 0)))))
1092 (string-equal (file-name-nondirectory file)
1093 (file-name-nondirectory new)))
1094 (setq file (file-name-directory file)))
1097 ;;;; ------------------------------------------------------------
1098 ;;;; User / Host mapping support.
1099 ;;;; ------------------------------------------------------------
1101 (defun ange-ftp-set-user (host user)
1102 "For a given HOST, set or change the default USER."
1103 (interactive "sHost: \nsUser: ")
1104 (ange-ftp-put-hash-entry host user ange-ftp-user-hashtable))
1106 (defun ange-ftp-get-user (host)
1107 "Given a HOST, return the default USER."
1108 (ange-ftp-parse-netrc)
1109 (let ((user (ange-ftp-get-hash-entry host ange-ftp-user-hashtable)))
1113 (cond ((stringp ange-ftp-default-user)
1114 ;; We have a default name. Use it.
1115 ange-ftp-default-user)
1116 (ange-ftp-default-user
1118 (let ((enable-recursive-minibuffers t))
1119 (read-string (format "User for %s: " host)
1120 (user-login-name))))
1121 (ange-ftp-netrc-default-user)
1122 ;; Default to the user's login name.
1124 (user-login-name))))
1125 (ange-ftp-set-user host user)))))
1127 ;;;; ------------------------------------------------------------
1128 ;;;; Password support.
1129 ;;;; ------------------------------------------------------------
1131 (defun ange-ftp-read-passwd (prompt &optional default)
1132 "Read a password, echoing `.' for each character typed.
1133 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1134 Optional DEFAULT is password to start with."
1138 (cursor-in-echo-area t))
1139 (while (progn (message "%s%s"
1141 (make-string (length pass) ?.))
1142 (setq c (read-char))
1143 (and (/= c ?\r) (/= c ?\n) (/= c ?\e)))
1146 (if (and (/= c ?\b) (/= c ?\177))
1147 (setq pass (concat pass (char-to-string c)))
1148 (if (> (length pass) 0)
1149 (setq pass (substring pass 0 -1))))))
1151 (ange-ftp-repaint-minibuffer)
1152 (or pass default "")))
1154 (defmacro ange-ftp-generate-passwd-key (host user)
1155 (` (concat (downcase (, host)) "/" (, user))))
1157 (defmacro ange-ftp-lookup-passwd (host user)
1158 (` (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key (, host) (, user))
1159 ange-ftp-passwd-hashtable)))
1161 (defun ange-ftp-set-passwd (host user passwd)
1162 "For a given HOST and USER, set or change the associated PASSWORD."
1163 (interactive (list (read-string "Host: ")
1164 (read-string "User: ")
1165 (ange-ftp-read-passwd "Password: ")))
1166 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user)
1168 ange-ftp-passwd-hashtable))
1170 (defun ange-ftp-get-host-with-passwd (user)
1171 "Given a USER, return a host we know the password for."
1172 (ange-ftp-parse-netrc)
1174 (ange-ftp-map-hashtable
1175 (function (lambda (host val)
1176 (if (ange-ftp-lookup-passwd host user)
1177 (throw 'found-one host))))
1178 ange-ftp-user-hashtable)
1180 (ange-ftp-map-hashtable
1183 (if (string-match "^[^/]*\\(/\\).*$" key)
1184 (let ((host (substring key 0 (match-beginning 1))))
1185 (if (and (string-equal user (substring key (match-end 1)))
1187 (throw 'found-one host))))))
1188 ange-ftp-passwd-hashtable))
1191 (defun ange-ftp-get-passwd (host user)
1192 "Return the password for specified HOST and USER, asking user if necessary."
1193 (ange-ftp-parse-netrc)
1195 ;; look up password in the hash table first; user might have overridden the
1197 (cond ((ange-ftp-lookup-passwd host user))
1199 ;; See if default user and password set.
1200 ((and (stringp ange-ftp-default-user)
1201 ange-ftp-default-password
1202 (string-equal user ange-ftp-default-user))
1203 ange-ftp-default-password)
1205 ;; See if default user and password set from .netrc file.
1206 ((and (stringp ange-ftp-netrc-default-user)
1207 ange-ftp-netrc-default-password
1208 (string-equal user ange-ftp-netrc-default-user))
1209 ange-ftp-netrc-default-password)
1211 ;; anonymous ftp password is handled specially since there is an
1212 ;; unwritten rule about how that is used on the Internet.
1213 ((and (or (string-equal user "anonymous")
1214 (string-equal user "ftp"))
1215 ange-ftp-generate-anonymous-password)
1216 (if (stringp ange-ftp-generate-anonymous-password)
1217 ange-ftp-generate-anonymous-password
1220 ;; see if same user has logged in to other hosts; if so then prompt
1221 ;; with the password that was used there.
1223 (let* ((other (ange-ftp-get-host-with-passwd user))
1226 ;; found another machine with the same user.
1227 ;; Try that account.
1228 (ange-ftp-read-passwd
1229 (format "passwd for %s@%s (default same as %s@%s): "
1230 user host user other)
1231 (ange-ftp-lookup-passwd other user))
1233 ;; I give up. Ask the user for the password.
1234 (ange-ftp-read-passwd
1235 (format "Password for %s@%s: " user host)))))
1236 (ange-ftp-set-passwd host user passwd)
1239 ;;;; ------------------------------------------------------------
1240 ;;;; Account support
1241 ;;;; ------------------------------------------------------------
1243 ;; Account passwords must be either specified in the .netrc file, or set
1244 ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't
1245 ;; check to see whether the FTP process is actually prompting for an account
1248 (defun ange-ftp-set-account (host user account)
1249 "For a given HOST and USER, set or change the associated ACCOUNT password."
1250 (interactive (list (read-string "Host: ")
1251 (read-string "User: ")
1252 (ange-ftp-read-passwd "Account password: ")))
1253 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user)
1255 ange-ftp-account-hashtable))
1257 (defun ange-ftp-get-account (host user)
1258 "Given a HOST and USER, return the FTP account."
1259 (ange-ftp-parse-netrc)
1260 (or (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key host user)
1261 ange-ftp-account-hashtable)
1262 (and (stringp ange-ftp-default-user)
1263 (string-equal user ange-ftp-default-user)
1264 ange-ftp-default-account)
1265 (and (stringp ange-ftp-netrc-default-user)
1266 (string-equal user ange-ftp-netrc-default-user)
1267 ange-ftp-netrc-default-account)))
1269 ;;;; ------------------------------------------------------------
1270 ;;;; ~/.netrc support
1271 ;;;; ------------------------------------------------------------
1273 (defun ange-ftp-chase-symlinks (file)
1274 "Return the filename that FILE references, following all symbolic links."
1276 (while (setq temp (ange-ftp-real-file-symlink-p file))
1278 (if (file-name-absolute-p temp)
1280 (concat (file-name-directory file) temp)))))
1283 ;; Move along current line looking for the value of the TOKEN.
1284 ;; Valid separators between TOKEN and its value are commas and
1285 ;; whitespace. Second arg LIMIT is a limit for the search.
1287 (defun ange-ftp-parse-netrc-token (token limit)
1288 (if (search-forward token limit t)
1290 (skip-chars-forward ", \t\r\n" limit)
1291 (if (eq (following-char) ?\") ;quoted token value
1292 (progn (forward-char 1)
1294 (skip-chars-forward "^\"" limit)
1296 (buffer-substring beg (1- (point))))
1298 (skip-chars-forward "^, \t\r\n" limit)
1299 (buffer-substring beg (point))))))
1301 ;; Extract the values for the tokens `machine', `login',
1302 ;; `password' and `account' in the current buffer. If successful,
1303 ;; record the information found.
1305 (defun ange-ftp-parse-netrc-group ()
1306 (let ((start (point))
1307 (end (save-excursion
1308 (if (looking-at "machine\\>")
1309 ;; Skip `machine' and the machine name that follows.
1311 (skip-chars-forward "^ \t\r\n")
1312 (skip-chars-forward " \t\r\n")
1313 (skip-chars-forward "^ \t\r\n"))
1315 (skip-chars-forward "^ \t\r\n"))
1316 ;; Find start of the next `machine' or `default'
1317 ;; or the end of the buffer.
1318 (if (re-search-forward "machine\\>\\|default\\>" nil t)
1321 machine login password account)
1322 (setq machine (ange-ftp-parse-netrc-token "machine" end)
1323 login (ange-ftp-parse-netrc-token "login" end)
1324 password (ange-ftp-parse-netrc-token "password" end)
1325 account (ange-ftp-parse-netrc-token "account" end))
1326 (if (and machine login)
1327 ;; found a `machine` token.
1329 (ange-ftp-set-user machine login)
1330 (ange-ftp-set-passwd machine login password)
1332 (ange-ftp-set-account machine login account)))
1334 (if (search-forward "default" end t)
1335 ;; found a `default' token
1337 (setq login (ange-ftp-parse-netrc-token "login" end)
1338 password (ange-ftp-parse-netrc-token "password" end)
1339 account (ange-ftp-parse-netrc-token "account" end))
1341 (setq ange-ftp-netrc-default-user login))
1343 (setq ange-ftp-netrc-default-password password))
1345 (setq ange-ftp-netrc-default-account account)))))
1348 ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has
1349 ;; the correct permissions then extract the \`machine\', \`login\',
1350 ;; \`password\' and \`account\' information from within.
1352 (defun ange-ftp-parse-netrc ()
1353 ;; We set this before actually doing it to avoid the possibility
1354 ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file.
1357 (let ((default-directory "/"))
1358 (setq file (ange-ftp-chase-symlinks
1359 (ange-ftp-real-expand-file-name ange-ftp-netrc-filename)))
1360 (setq attr (ange-ftp-real-file-attributes file)))
1361 (if (and attr ; file exists.
1362 (not (equal (nth 5 attr) ange-ftp-netrc-modtime))) ; file changed
1364 (if (or ange-ftp-disable-netrc-security-check
1365 (and (eq (nth 2 attr) (user-uid)) ; Same uids.
1366 (string-match ".r..------" (nth 8 attr))))
1368 ;; we are cheating a bit here. I'm trying to do the equivalent
1369 ;; of find-file on the .netrc file, but then nuke it afterwards.
1370 ;; with the bit of logic below we should be able to have
1371 ;; encrypted .netrc files.
1372 (set-buffer (generate-new-buffer "*ftp-.netrc*"))
1373 (ange-ftp-real-insert-file-contents file)
1374 (setq buffer-file-name file)
1375 (setq default-directory (file-name-directory file))
1377 (mapcar 'funcall find-file-hooks)
1378 (setq buffer-file-name nil)
1379 (goto-char (point-min))
1380 (skip-chars-forward " \t\r\n")
1382 (ange-ftp-parse-netrc-group))
1383 (kill-buffer (current-buffer)))
1384 (ange-ftp-message "%s either not owned by you or badly protected."
1385 ange-ftp-netrc-filename)
1387 (setq ange-ftp-netrc-modtime (nth 5 attr))))))
1389 ;; Return a list of prefixes of the form 'user@host:' to be used when
1390 ;; completion is done in the root directory.
1392 (defun ange-ftp-generate-root-prefixes ()
1393 (ange-ftp-parse-netrc)
1396 (ange-ftp-map-hashtable
1399 (if (string-match "^[^/]*\\(/\\).*$" key)
1400 (let ((host (substring key 0 (match-beginning 1)))
1401 (user (substring key (match-end 1))))
1402 (setq res (cons (list (concat user "@" host ":"))
1404 ange-ftp-passwd-hashtable)
1405 (ange-ftp-map-hashtable
1406 (function (lambda (host user)
1407 (setq res (cons (list (concat host ":"))
1409 ange-ftp-user-hashtable)
1410 (or res (list nil)))))
1412 ;;;; ------------------------------------------------------------
1413 ;;;; Remote file name syntax support.
1414 ;;;; ------------------------------------------------------------
1416 (defmacro ange-ftp-ftp-name-component (n ns name)
1417 "Extract the Nth ftp file name component from NS."
1418 (` (let ((elt (nth (, n) (, ns))))
1419 (if (match-beginning elt)
1420 (substring (, name) (match-beginning elt) (match-end elt))))))
1422 (defvar ange-ftp-ftp-name-arg "")
1423 (defvar ange-ftp-ftp-name-res nil)
1425 ;; Parse NAME according to `ange-ftp-name-format' (which see).
1426 ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format.
1427 (defun ange-ftp-ftp-name (name)
1428 (if (string-equal name ange-ftp-ftp-name-arg)
1429 ange-ftp-ftp-name-res
1430 (setq ange-ftp-ftp-name-arg name
1431 ange-ftp-ftp-name-res
1433 (if (posix-string-match (car ange-ftp-name-format) name)
1434 (let* ((ns (cdr ange-ftp-name-format))
1435 (host (ange-ftp-ftp-name-component 0 ns name))
1436 (user (ange-ftp-ftp-name-component 1 ns name))
1437 (name (ange-ftp-ftp-name-component 2 ns name)))
1438 (if (zerop (length user))
1439 (setq user (ange-ftp-get-user host)))
1440 (list host user name))
1443 ;; Take a FULLNAME that matches according to ange-ftp-name-format and
1444 ;; replace the name component with NAME.
1445 (defun ange-ftp-replace-name-component (fullname name)
1447 (if (posix-string-match (car ange-ftp-name-format) fullname)
1448 (let* ((ns (cdr ange-ftp-name-format))
1450 (concat (substring fullname 0 (match-beginning elt))
1452 (substring fullname (match-end elt)))))))
1454 ;;;; ------------------------------------------------------------
1455 ;;;; Miscellaneous utils.
1456 ;;;; ------------------------------------------------------------
1458 ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap))
1459 ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer)
1461 (defun ange-ftp-repaint-minibuffer ()
1462 "Clear any existing minibuffer message; let the minibuffer contents show."
1465 ;; Return the name of the buffer that collects output from the ftp process
1466 ;; connected to the given HOST and USER pair.
1467 (defun ange-ftp-ftp-process-buffer (host user)
1468 (concat "*ftp " user "@" host "*"))
1470 ;; Display the last chunk of output from the ftp process for the given HOST
1471 ;; USER pair, and signal an error including MSG in the text.
1472 (defun ange-ftp-error (host user msg)
1473 (let ((cur (selected-window))
1477 (ange-ftp-ftp-process-buffer host user)))
1478 (goto-char (point-max))
1479 (select-window cur))
1480 (signal 'ftp-error (list (format "FTP Error: %s" msg))))
1482 (defun ange-ftp-set-buffer-mode ()
1483 "Set correct modes for the current buffer if visiting a remote file."
1484 (if (and (stringp buffer-file-name)
1485 (ange-ftp-ftp-name buffer-file-name))
1486 (auto-save-mode ange-ftp-auto-save)))
1488 (defun ange-ftp-kill-ftp-process (&optional buffer)
1489 "Kill the FTP process associated with BUFFER (the current buffer, if nil).
1490 If the BUFFER's visited filename or default-directory is an ftp filename
1491 then kill the related ftp process."
1492 (interactive "bKill FTP process associated with buffer: ")
1494 (setq buffer (current-buffer))
1495 (setq buffer (get-buffer buffer)))
1496 (let ((file (or (buffer-file-name buffer)
1497 (save-excursion (set-buffer buffer) default-directory))))
1499 (let ((parsed (ange-ftp-ftp-name (expand-file-name file))))
1501 (let ((host (nth 0 parsed))
1502 (user (nth 1 parsed)))
1503 (kill-buffer (get-buffer (ange-ftp-ftp-process-buffer host user)))))))))
1505 (defun ange-ftp-quote-string (string)
1506 "Quote any characters in STRING that may confuse the ftp process."
1507 (apply (function concat)
1509 ;; This is said to be wrong; ftp is said to
1510 ;; need quoting only for ", and that by doubling it.
1511 ;; But experiment says this kind of quoting is correct
1512 ;; when talking to ftp on GNU/Linux systems.
1514 (if (or (<= char ? )
1522 (defun ange-ftp-barf-if-not-directory (directory)
1523 (or (file-directory-p directory)
1525 (list "Opening directory"
1526 (if (file-exists-p directory)
1528 "no such file or directory")
1531 ;;;; ------------------------------------------------------------
1532 ;;;; FTP process filter support.
1533 ;;;; ------------------------------------------------------------
1535 (defun ange-ftp-process-handle-line (line proc)
1536 "Look at the given LINE from the ftp process PROC.
1537 Try to categorize it into one of four categories:
1538 good, skip, fatal, or unknown."
1539 (cond ((string-match ange-ftp-xfer-size-msgs line)
1540 (setq ange-ftp-xfer-size
1541 (ash (string-to-int (substring line
1545 ((string-match ange-ftp-skip-msgs line)
1547 ((string-match ange-ftp-good-msgs line)
1548 (setq ange-ftp-process-busy nil
1549 ange-ftp-process-result t
1550 ange-ftp-process-result-line line))
1551 ;; Check this before checking for errors.
1552 ;; Otherwise the last line of these three seems to be an error:
1553 ;; 230-see a significant impact from the move. For those of you who can't
1554 ;; 230-use DNS to resolve hostnames and get an error message like
1555 ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be...
1556 ((string-match ange-ftp-multi-msgs line)
1557 (setq ange-ftp-process-multi-skip t))
1558 ((string-match ange-ftp-fatal-msgs line)
1559 (delete-process proc)
1560 (setq ange-ftp-process-busy nil
1561 ange-ftp-process-result-line line))
1562 (ange-ftp-process-multi-skip
1565 (setq ange-ftp-process-busy nil
1566 ange-ftp-process-result-line line))))
1568 (defun ange-ftp-set-xfer-size (host user bytes)
1569 "Set the size of the next FTP transfer in bytes."
1570 (let ((proc (ange-ftp-get-process host user)))
1572 (let ((buf (process-buffer proc)))
1576 (setq ange-ftp-xfer-size (ash bytes -10))))))))
1578 (defun ange-ftp-process-handle-hash (str)
1579 "Remove hash marks from STRING and display count so far."
1580 (setq str (concat (substring str 0 (match-beginning 0))
1581 (substring str (match-end 0)))
1582 ange-ftp-hash-mark-count (+ (- (match-end 0)
1583 (match-beginning 0))
1584 ange-ftp-hash-mark-count))
1585 (and ange-ftp-hash-mark-unit
1586 ange-ftp-process-msg
1587 ange-ftp-process-verbose
1588 (not (eq (selected-window) (minibuffer-window)))
1589 (not (boundp 'search-message)) ;screws up isearch otherwise
1590 (not cursor-in-echo-area) ;screws up y-or-n-p otherwise
1591 (let ((kbytes (ash (* ange-ftp-hash-mark-unit
1592 ange-ftp-hash-mark-count)
1594 (if (zerop ange-ftp-xfer-size)
1595 (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes)
1596 (let ((percent (/ (* 100 kbytes) ange-ftp-xfer-size)))
1597 ;; cut out the redisplay of identical %-age messages.
1598 (if (not (eq percent ange-ftp-last-percent))
1600 (setq ange-ftp-last-percent percent)
1601 (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent)))))))
1604 ;; Call the function specified by CONT. CONT can be either a function
1605 ;; or a list of a function and some args. The first two parameters
1606 ;; passed to the function will be RESULT and LINE. The remaining args
1607 ;; will be taken from CONT if a list was passed.
1609 (defun ange-ftp-call-cont (cont result line)
1611 (if (and (listp cont)
1612 (not (eq (car cont) 'lambda)))
1613 (apply (car cont) result line (cdr cont))
1614 (funcall cont result line))))
1616 ;; Build up a complete line of output from the ftp PROCESS and pass it
1617 ;; on to ange-ftp-process-handle-line to deal with.
1619 (defun ange-ftp-process-filter (proc str)
1620 (let ((buffer (process-buffer proc))
1621 (old-buffer (current-buffer)))
1624 (while (string-match "\000+" str)
1625 (setq str (replace-match "" nil nil str)))
1627 ;; see if the buffer is still around... it could have been deleted.
1628 (if (buffer-name buffer)
1631 (set-buffer (process-buffer proc))
1633 ;; handle hash mark printing
1634 (and ange-ftp-process-busy
1635 (string-match "^#+$" str)
1636 (setq str (ange-ftp-process-handle-hash str)))
1637 (comint-output-filter proc str)
1638 ;; Replace STR by the result of the comint processing.
1639 (setq str (buffer-substring comint-last-output-start
1640 (process-mark proc)))
1641 (if ange-ftp-process-busy
1643 (setq ange-ftp-process-string (concat ange-ftp-process-string
1646 ;; if we gave an empty password to the USER command earlier
1647 ;; then we should send a null password now.
1648 (if (string-match "Password: *$" ange-ftp-process-string)
1649 (send-string proc "\n"))))
1650 (while (and ange-ftp-process-busy
1651 (string-match "\n" ange-ftp-process-string))
1652 (let ((line (substring ange-ftp-process-string
1654 (match-beginning 0))))
1655 (setq ange-ftp-process-string (substring ange-ftp-process-string
1657 (while (string-match "^ftp> *" line)
1658 (setq line (substring line (match-end 0))))
1659 (ange-ftp-process-handle-line line proc)))
1661 ;; has the ftp client finished? if so then do some clean-up
1663 (if (not ange-ftp-process-busy)
1665 ;; reset the xfer size
1666 (setq ange-ftp-xfer-size 0)
1668 ;; issue the "done" message since we've finished.
1669 (if (and ange-ftp-process-msg
1670 ange-ftp-process-verbose
1671 ange-ftp-process-result)
1673 (ange-ftp-message "%s...done" ange-ftp-process-msg)
1674 (ange-ftp-repaint-minibuffer)
1675 (setq ange-ftp-process-msg nil)))
1677 ;; is there a continuation we should be calling? if so,
1678 ;; we'd better call it, making sure we only call it once.
1679 (if ange-ftp-process-continue
1680 (let ((cont ange-ftp-process-continue))
1681 (setq ange-ftp-process-continue nil)
1682 (ange-ftp-call-cont cont
1683 ange-ftp-process-result
1684 ange-ftp-process-result-line))))))
1685 (set-buffer old-buffer)))))
1687 (defun ange-ftp-process-sentinel (proc str)
1688 "When ftp process changes state, nuke all file-entries in cache."
1689 (let ((name (process-name proc)))
1690 (if (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name)
1691 (let ((user (substring name (match-beginning 1) (match-end 1)))
1692 (host (substring name (match-beginning 2) (match-end 2))))
1693 (ange-ftp-wipe-file-entries host user))))
1694 (setq ange-ftp-ls-cache-file nil))
1696 ;;;; ------------------------------------------------------------
1697 ;;;; Gateway support.
1698 ;;;; ------------------------------------------------------------
1700 (defun ange-ftp-use-gateway-p (host)
1701 "Returns whether to access this host via a normal (non-smart) gateway."
1702 ;; yes, I know that I could simplify the following expression, but it is
1703 ;; clearer (to me at least) this way.
1704 (and (not ange-ftp-smart-gateway)
1706 (not (string-match ange-ftp-local-host-regexp host)))))
1708 (defun ange-ftp-use-smart-gateway-p (host)
1709 "Returns whether to access this host via a smart gateway."
1710 (and ange-ftp-smart-gateway
1712 (not (string-match ange-ftp-local-host-regexp host)))))
1715 ;;; ------------------------------------------------------------
1716 ;;; Temporary file location and deletion...
1717 ;;; ------------------------------------------------------------
1719 (defvar ange-ftp-tmp-name-files ())
1720 (defvar ange-ftp-tmp-name-hashtable (ange-ftp-make-hashtable 10))
1721 (defvar ange-ftp-pid nil)
1723 (defun ange-ftp-get-pid ()
1724 "Half-hearted attempt to get the current process's id."
1725 (setq ange-ftp-pid (substring (make-temp-name "") 1)))
1727 (defun ange-ftp-make-tmp-name (host)
1728 "This routine will return the name of a new file."
1729 (let* ((template (if (ange-ftp-use-gateway-p host)
1730 ange-ftp-gateway-tmp-name-template
1731 ange-ftp-tmp-name-template))
1732 (pid (or ange-ftp-pid (ange-ftp-get-pid)))
1737 (setq file (format "%s%c%s" template start pid))
1738 (setq entry (intern file ange-ftp-tmp-name-hashtable))
1739 (or (memq entry ange-ftp-tmp-name-files)
1740 (ange-ftp-real-file-exists-p file)))
1741 (if (> (setq start (1+ start)) ?z)
1743 (setq template (concat template "X"))
1745 (setq ange-ftp-tmp-name-files
1746 (cons entry ange-ftp-tmp-name-files))
1749 (defun ange-ftp-del-tmp-name (temp)
1750 (setq ange-ftp-tmp-name-files
1751 (delq (intern temp ange-ftp-tmp-name-hashtable)
1752 ange-ftp-tmp-name-files))
1754 (ange-ftp-real-delete-file temp)
1757 ;;;; ------------------------------------------------------------
1758 ;;;; Interactive gateway program support.
1759 ;;;; ------------------------------------------------------------
1761 (defvar ange-ftp-gwp-running t)
1762 (defvar ange-ftp-gwp-status nil)
1764 (defun ange-ftp-gwp-sentinel (proc str)
1765 (setq ange-ftp-gwp-running nil))
1767 (defun ange-ftp-gwp-filter (proc str)
1768 (comint-output-filter proc str)
1770 (set-buffer (process-buffer proc))
1771 ;; Replace STR by the result of the comint processing.
1772 (setq str (buffer-substring comint-last-output-start (process-mark proc))))
1773 (cond ((string-match "login: *$" str)
1776 (let ((ange-ftp-default-user t))
1777 (ange-ftp-get-user ange-ftp-gateway-host))
1779 ((string-match "Password: *$" str)
1782 (ange-ftp-get-passwd ange-ftp-gateway-host
1784 ange-ftp-gateway-host))
1786 ((string-match ange-ftp-gateway-fatal-msgs str)
1787 (delete-process proc)
1788 (setq ange-ftp-gwp-running nil))
1789 ((string-match ange-ftp-gateway-prompt-pattern str)
1790 (setq ange-ftp-gwp-running nil
1791 ange-ftp-gwp-status t))))
1793 (defun ange-ftp-gwp-start (host user name args)
1794 "Login to the gateway machine and fire up an ftp process."
1795 (let* ((gw-user (ange-ftp-get-user ange-ftp-gateway-host))
1796 ;; It would be nice to make process-connection-type nil,
1797 ;; but that doesn't work: ftp never responds.
1798 ;; Can anyone find a fix for that?
1799 (proc (let ((process-connection-type t))
1800 (start-process name name
1801 ange-ftp-gateway-program
1802 ange-ftp-gateway-host)))
1803 (ftp (mapconcat (function identity) args " ")))
1804 (process-kill-without-query proc)
1805 (set-process-sentinel proc (function ange-ftp-gwp-sentinel))
1806 (set-process-filter proc (function ange-ftp-gwp-filter))
1808 (set-buffer (process-buffer proc))
1809 (goto-char (point-max))
1810 (set-marker (process-mark proc) (point)))
1811 (setq ange-ftp-gwp-running t
1812 ange-ftp-gwp-status nil)
1813 (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host)
1814 (while ange-ftp-gwp-running ;perform login sequence
1815 (accept-process-output proc))
1816 (if (not ange-ftp-gwp-status)
1817 (ange-ftp-error host user "unable to login to gateway"))
1818 (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host)
1819 (setq ange-ftp-gwp-running t
1820 ange-ftp-gwp-status nil)
1821 (process-send-string proc ange-ftp-gateway-setup-term-command)
1822 (while ange-ftp-gwp-running ;zap ^M's and double echoing.
1823 (accept-process-output proc))
1824 (if (not ange-ftp-gwp-status)
1825 (ange-ftp-error host user "unable to set terminal modes on gateway"))
1826 (setq ange-ftp-gwp-running t
1827 ange-ftp-gwp-status nil)
1828 (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process
1831 ;;;; ------------------------------------------------------------
1832 ;;;; Support for sending commands to the ftp process.
1833 ;;;; ------------------------------------------------------------
1835 (defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait)
1836 "Low-level routine to send the given ftp CMD to the ftp PROCESS.
1837 MSG is an optional message to output before and after the command.
1838 If CONT is non-nil then it is either a function or a list of function and
1839 some arguments. The function will be called when the ftp command has completed.
1840 If CONT is nil then this routine will return \( RESULT . LINE \) where RESULT
1841 is whether the command was successful, and LINE is the line from the FTP
1842 process that caused the command to complete.
1843 If NOWAIT is given then the routine will return immediately the command has
1844 been queued with no result. CONT will still be called, however."
1845 (if (memq (process-status proc) '(run open))
1847 (set-buffer (process-buffer proc))
1848 (ange-ftp-wait-not-busy proc)
1849 (setq ange-ftp-process-string ""
1850 ange-ftp-process-result-line ""
1851 ange-ftp-process-busy t
1852 ange-ftp-process-result nil
1853 ange-ftp-process-multi-skip nil
1854 ange-ftp-process-msg msg
1855 ange-ftp-process-continue cont
1856 ange-ftp-hash-mark-count 0
1857 ange-ftp-last-percent -1
1858 cmd (concat cmd "\n"))
1859 (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg))
1860 (goto-char (point-max))
1861 (move-marker comint-last-input-start (point))
1862 ;; don't insert the password into the buffer on the USER command.
1864 (if (string-match "^user \"[^\"]*\"" cmd)
1865 (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n")
1867 (move-marker comint-last-input-end (point))
1868 (send-string proc cmd)
1869 (set-marker (process-mark proc) (point))
1872 (ange-ftp-wait-not-busy proc)
1874 nil ;cont has already been called
1875 (cons ange-ftp-process-result ange-ftp-process-result-line))))))
1877 ;; Wait for the ange-ftp process PROC not to be busy.
1878 (defun ange-ftp-wait-not-busy (proc)
1880 (set-buffer (process-buffer proc))
1882 ;; This is a kludge to let user quit in case ftp gets hung.
1883 ;; It matters because this function can be called from the filter.
1884 ;; It is bad to allow quitting in a filter, but getting hung
1885 ;; is worse. By binding quit-flag to nil, we might avoid
1886 ;; most of the probability of getting screwed because the user
1887 ;; wants to quit some command.
1888 (let ((quit-flag nil)
1890 (while ange-ftp-process-busy
1891 (accept-process-output proc)))
1893 ;; If the user does quit out of this,
1894 ;; kill the process. That stops any transfer in progress.
1895 ;; The next operation will open a new ftp connection.
1896 (delete-process proc)
1897 (signal 'quit nil)))))
1899 (defun ange-ftp-nslookup-host (host)
1900 "Attempt to resolve the given HOSTNAME using nslookup if possible."
1901 (interactive "sHost: ")
1902 (if ange-ftp-nslookup-program
1903 (let ((default-directory
1904 (if (file-accessible-directory-p default-directory)
1907 ;; It would be nice to make process-connection-type nil,
1908 ;; but that doesn't work: ftp never responds.
1909 ;; Can anyone find a fix for that?
1910 (proc (let ((process-connection-type t))
1911 (start-process " *nslookup*" " *nslookup*"
1912 ange-ftp-nslookup-program host)))
1914 (process-kill-without-query proc)
1916 (set-buffer (process-buffer proc))
1917 (while (memq (process-status proc) '(run open))
1918 (accept-process-output proc))
1919 (goto-char (point-min))
1920 (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t)
1921 (setq res (buffer-substring (match-beginning 1)
1923 (kill-buffer (current-buffer)))
1927 (defun ange-ftp-start-process (host user name)
1928 "Spawn a new ftp process ready to connect to machine HOST and give it NAME.
1929 If HOST is only ftp-able through a gateway machine then spawn a shell
1930 on the gateway machine to do the ftp instead."
1931 (let* ((use-gateway (ange-ftp-use-gateway-p host))
1932 (use-smart-ftp (and (not ange-ftp-gateway-host)
1933 (ange-ftp-use-smart-gateway-p host)))
1934 (ftp-prog (if (or use-gateway
1936 ange-ftp-gateway-ftp-program-name
1937 ange-ftp-ftp-program-name))
1938 (args (append (list ftp-prog) ange-ftp-ftp-program-args))
1939 ;; Without the following binding, ange-ftp-start-process
1940 ;; recurses on file-accessible-directory-p, since it needs to
1941 ;; restart its process in order to determine anything about
1942 ;; default-directory.
1943 (file-name-handler-alist)
1945 (if (file-accessible-directory-p default-directory)
1949 ;; It would be nice to make process-connection-type nil,
1950 ;; but that doesn't work: ftp never responds.
1951 ;; Can anyone find a fix for that?
1952 (let ((process-connection-type t)
1953 (process-environment process-environment)
1954 (buffer (get-buffer-create name)))
1957 (internal-ange-ftp-mode))
1958 ;; This tells GNU ftp not to output any fancy escape sequences.
1959 (setenv "TERM" "dumb")
1961 (if ange-ftp-gateway-program-interactive
1962 (setq proc (ange-ftp-gwp-start host user name args))
1963 (setq proc (apply 'start-process name name
1964 (append (list ange-ftp-gateway-program
1965 ange-ftp-gateway-host)
1967 (setq proc (apply 'start-process name name args))))
1969 (set-buffer (process-buffer proc))
1970 (goto-char (point-max))
1971 (set-marker (process-mark proc) (point)))
1972 (process-kill-without-query proc)
1973 (set-process-sentinel proc (function ange-ftp-process-sentinel))
1974 (set-process-filter proc (function ange-ftp-process-filter))
1975 ;; On Windows, the standard ftp client buffers its output (because
1976 ;; stdout is a pipe handle) so the startup message may never appear:
1977 ;; `accept-process-output' at this point would hang indefinitely.
1978 ;; However, sending an innocuous command ("help foo") forces some
1979 ;; output that will be ignored, which is just as good. Once we
1980 ;; start sending normal commands, the output no longer appears to be
1981 ;; buffered, and everything works correctly. My guess is that the
1982 ;; output of interest is being sent to stderr which is not buffered.
1983 (when (eq system-type 'windows-nt)
1984 ;; force ftp output to be treated as DOS text, otherwise the
1985 ;; output of "help foo" confuses the EOL detection logic.
1986 (set-process-coding-system proc 'raw-text-dos)
1987 (process-send-string proc "help foo\n"))
1988 (accept-process-output proc) ;wait for ftp startup message
1991 (put 'internal-ange-ftp-mode 'mode-class 'special)
1993 (defun internal-ange-ftp-mode ()
1994 "Major mode for interacting with the FTP process.
1996 \\{comint-mode-map}"
1999 (setq major-mode 'internal-ange-ftp-mode)
2000 (setq mode-name "Internal Ange-ftp")
2001 (let ((proc (get-buffer-process (current-buffer))))
2002 (make-local-variable 'ange-ftp-process-string)
2003 (setq ange-ftp-process-string "")
2004 (make-local-variable 'ange-ftp-process-busy)
2005 (make-local-variable 'ange-ftp-process-result)
2006 (make-local-variable 'ange-ftp-process-msg)
2007 (make-local-variable 'ange-ftp-process-multi-skip)
2008 (make-local-variable 'ange-ftp-process-result-line)
2009 (make-local-variable 'ange-ftp-process-continue)
2010 (make-local-variable 'ange-ftp-hash-mark-count)
2011 (make-local-variable 'ange-ftp-binary-hash-mark-size)
2012 (make-local-variable 'ange-ftp-ascii-hash-mark-size)
2013 (make-local-variable 'ange-ftp-hash-mark-unit)
2014 (make-local-variable 'ange-ftp-xfer-size)
2015 (make-local-variable 'ange-ftp-last-percent)
2016 (setq ange-ftp-hash-mark-count 0)
2017 (setq ange-ftp-xfer-size 0)
2018 (setq ange-ftp-process-result-line "")
2020 (setq comint-prompt-regexp "^ftp> ")
2021 (make-local-variable 'comint-password-prompt-regexp)
2022 ;; This is a regexp that can't match anything.
2023 ;; ange-ftp has its own ways of handling passwords.
2024 (setq comint-password-prompt-regexp "^a\\'z")
2025 (make-local-variable 'paragraph-start)
2026 (setq paragraph-start comint-prompt-regexp)))
2028 (defun ange-ftp-smart-login (host user pass account proc)
2029 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
2030 PROC is the FTP-client's process. This routine uses the smart-gateway
2031 host specified in ``ange-ftp-gateway-host''."
2032 (let ((result (ange-ftp-raw-send-cmd
2034 (format "open %s %s"
2035 (ange-ftp-nslookup-host ange-ftp-gateway-host)
2036 ange-ftp-smart-gateway-port)
2037 (format "Opening FTP connection to %s via %s"
2039 ange-ftp-gateway-host))))
2041 (ange-ftp-error host user
2042 (concat "OPEN request failed: "
2044 (setq result (ange-ftp-raw-send-cmd
2045 proc (format "user \"%s\"@%s %s %s"
2047 (ange-ftp-nslookup-host host)
2050 (format "Logging in as user %s@%s"
2054 (ange-ftp-set-passwd host user nil) ; reset password
2055 (ange-ftp-set-account host user nil) ; reset account
2056 (ange-ftp-error host user
2057 (concat "USER request failed: "
2060 (defun ange-ftp-normal-login (host user pass account proc)
2061 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
2062 PROC is the process to the FTP-client."
2063 (let* ((nshost (ange-ftp-nslookup-host host))
2064 (result (ange-ftp-raw-send-cmd
2066 (format "open %s" nshost)
2067 (format "Opening FTP connection to %s" host))))
2069 (ange-ftp-error host user
2070 (concat "OPEN request failed: "
2072 (setq result (ange-ftp-raw-send-cmd
2074 (if (and (ange-ftp-use-smart-gateway-p host)
2075 ange-ftp-gateway-host)
2076 (format "user \"%s\"@%s %s %s" user nshost pass account)
2077 (format "user \"%s\" %s %s" user pass account))
2078 (format "Logging in as user %s@%s" user host)))
2081 (ange-ftp-set-passwd host user nil) ;reset password.
2082 (ange-ftp-set-account host user nil) ;reset account.
2083 (ange-ftp-error host user
2084 (concat "USER request failed: "
2087 ;; ange@hplb.hpl.hp.com says this should not be changed.
2088 (defvar ange-ftp-hash-mark-msgs
2089 "[hH]ash mark [^0-9]*\\([0-9]+\\)"
2090 "*Regexp matching the FTP client's output upon doing a HASH command.")
2092 (defun ange-ftp-guess-hash-mark-size (proc)
2093 (if ange-ftp-send-hash
2095 (set-buffer (process-buffer proc))
2096 (let* ((status (ange-ftp-raw-send-cmd proc "hash"))
2097 (result (car status))
2098 (line (cdr status)))
2100 (if (string-match ange-ftp-hash-mark-msgs line)
2101 (let ((size (string-to-int
2105 (setq ange-ftp-ascii-hash-mark-size size
2106 ange-ftp-hash-mark-unit (ash size -4))
2108 ;; if a default value for this is set, use that value.
2109 (or ange-ftp-binary-hash-mark-size
2110 (setq ange-ftp-binary-hash-mark-size size)))))))))
2112 (defun ange-ftp-get-process (host user)
2113 "Return an FTP subprocess connected to HOST and logged in as USER.
2114 Create a new process if needed."
2115 (let* ((name (ange-ftp-ftp-process-buffer host user))
2116 (proc (get-process name)))
2117 (if (and proc (memq (process-status proc) '(run open)))
2119 ;; Must delete dead process so that new process can reuse the name.
2120 (if proc (delete-process proc))
2121 (let ((pass (ange-ftp-quote-string
2122 (ange-ftp-get-passwd host user)))
2123 (account (ange-ftp-quote-string
2124 (ange-ftp-get-account host user))))
2125 ;; grab a suitable process.
2126 (setq proc (ange-ftp-start-process host user name))
2128 ;; login to FTP server.
2129 (if (and (ange-ftp-use-smart-gateway-p host)
2130 ange-ftp-gateway-host)
2131 (ange-ftp-smart-login host user pass account proc)
2132 (ange-ftp-normal-login host user pass account proc))
2134 ;; Tell client to send back hash-marks as progress. It isn't usually
2135 ;; fatal if this command fails.
2136 (ange-ftp-guess-hash-mark-size proc)
2138 ;; Guess at the host type.
2139 (ange-ftp-guess-host-type host user)
2141 ;; Run any user-specified hooks. Note that proc, host and user are
2142 ;; dynamically bound at this point.
2143 (run-hooks 'ange-ftp-process-startup-hook))
2146 ;; Variables for caching host and host-type
2147 (defvar ange-ftp-host-cache nil)
2148 (defvar ange-ftp-host-type-cache nil)
2150 ;; If ange-ftp-host-type is called with the optional user
2151 ;; argument, it will attempt to guess the host type by connecting
2152 ;; as user, if necessary. For efficiency, I have tried to give this
2153 ;; optional second argument only when necessary. Have I missed any calls
2154 ;; to ange-ftp-host-type where it should have been supplied?
2156 (defun ange-ftp-host-type (host &optional user)
2157 "Return a symbol which represents the type of the HOST given.
2158 If the optional argument USER is given, attempts to guess the
2159 host-type by logging in as USER."
2160 (cond ((null host) 'unix)
2161 ;; Return `unix' if HOST is nil, since that's the most vanilla
2162 ;; possible return value.
2163 ((eq host ange-ftp-host-cache)
2164 ange-ftp-host-type-cache)
2165 ;; Trigger an ftp connection, in case we need to guess at the host type.
2166 ((and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache))
2167 ange-ftp-host-type-cache)
2169 (setq ange-ftp-host-cache host
2170 ange-ftp-host-type-cache
2171 (cond ((ange-ftp-dumb-unix-host host)
2173 ;; ((and (fboundp 'ange-ftp-vos-host)
2174 ;; (ange-ftp-vos-host host))
2176 ((and (fboundp 'ange-ftp-vms-host)
2177 (ange-ftp-vms-host host))
2179 ((and (fboundp 'ange-ftp-mts-host)
2180 (ange-ftp-mts-host host))
2182 ((and (fboundp 'ange-ftp-cms-host)
2183 (ange-ftp-cms-host host))
2188 ;; It would be nice to abstract the functions ange-ftp-TYPE-host and
2189 ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions
2190 ;; without sacrificing speed. Also, having separate variables
2191 ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to
2192 ;; set an alist to indicate that a host is of a given type. Even with
2193 ;; automatic host type recognition, setting a regexp is still a good idea
2194 ;; (for efficiency) if you log into a particular non-UNIX host frequently.
2196 (defvar ange-ftp-fix-name-func-alist nil
2197 "Alist saying how to convert file name to the host's syntax.
2198 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2199 which can change a UNIX file name into a name more suitable for a host of type
2202 (defvar ange-ftp-fix-dir-name-func-alist nil
2203 "Alist saying how to convert directory name to the host's syntax.
2204 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2205 which can change UNIX directory name into a directory name more suitable
2206 for a host of type TYPE.")
2208 ;; *** Perhaps the sense of this variable should be inverted, since there
2209 ;; *** is only 1 host type that can take ls-style listing options.
2210 (defvar ange-ftp-dumb-host-types '(dumb-unix)
2211 "List of host types that can't take UNIX ls-style listing options.")
2213 (defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait)
2214 "Find an ftp process connected to HOST logged in as USER and send it CMD.
2215 MSG is an optional status message to be output before and after issuing the
2217 See the documentation for ange-ftp-raw-send-cmd for a description of CONT
2219 ;; Handle conversion to remote file name syntax and remote ls option
2221 (let ((cmd0 (car cmd))
2223 (ange-ftp-this-user user)
2224 (ange-ftp-this-host host)
2225 (ange-ftp-this-msg msg)
2226 cmd2 cmd3 host-type fix-name-func)
2230 ;; pwd case (We don't care what host-type.)
2233 ;; cmd == 'dir "remote-name" "local-name" "ls-switches"
2235 (setq cmd2 (nth 2 cmd)
2236 host-type (ange-ftp-host-type host user))
2237 ;; This will trigger an FTP login, if one doesn't exist
2240 (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist))
2244 ;; Need to deal with the HP-UX ftp bug. This should also allow
2245 ;; us to resolve symlinks to directories on SysV machines. (Sebastian will
2247 (and (eq host-type 'unix)
2248 (string-match "/$" cmd1)
2249 (not (string-match "R" cmd3))
2250 (setq cmd1 (concat cmd1 ".")))
2252 ;; If the dir name contains a space, some ftp servers will
2253 ;; refuse to list it. We instead change directory to the
2254 ;; directory in question and ls ".".
2255 (when (string-match " " cmd1)
2256 (ange-ftp-cd host user (nth 1 cmd))
2259 ;; If the remote ls can take switches, put them in
2260 (or (memq host-type ange-ftp-dumb-host-types)
2262 cmd1 (format "\"%s %s\"" cmd3 cmd1))))
2264 ;; First argument is the remote name
2266 (setq fix-name-func (or (cdr (assq host-type
2267 ange-ftp-fix-name-func-alist))
2269 (memq cmd0 '(get delete mkdir rmdir cd)))
2270 (setq cmd1 (funcall fix-name-func cmd1)))
2272 ;; Second argument is the remote name
2273 ((memq cmd0 '(append put chmod))
2274 (setq cmd2 (funcall fix-name-func cmd2)))
2276 ;; Both arguments are remote names
2278 (setq cmd1 (funcall fix-name-func cmd1)
2279 cmd2 (funcall fix-name-func cmd2))))
2281 ;; Turn the command into one long string
2282 (setq cmd0 (symbol-name cmd0))
2283 (setq cmd (concat cmd0
2284 (and cmd1 (concat " " cmd1))
2285 (and cmd2 (concat " " cmd2))))
2287 ;; Actually send the resulting command.
2290 (ange-ftp-raw-send-cmd
2291 (ange-ftp-get-process host user)
2295 (function (lambda (result line host user
2296 cmd msg cont nowait)
2298 (setq afsc-result result
2301 (ange-ftp-call-cont cont result line)
2302 (ange-ftp-raw-send-cmd
2303 (ange-ftp-get-process host user)
2307 (function (lambda (result line cont)
2309 (setq afsc-result result
2311 (ange-ftp-call-cont cont result line)))
2314 host user cmd msg cont nowait)
2321 (cons afsc-result afsc-line))))))
2323 ;; It might be nice to message users about the host type identified,
2324 ;; but there is so much other messaging going on, it would not be
2325 ;; seen. No point in slowing things down just so users can read
2326 ;; a host type message.
2328 (defconst ange-ftp-cms-name-template
2330 "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?"
2331 "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$"))
2332 (defconst ange-ftp-vms-name-template
2333 "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$")
2334 (defconst ange-ftp-mts-name-template
2335 "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$")
2337 (defun ange-ftp-guess-host-type (host user)
2338 "Guess at the the host type of HOST.
2339 Works by doing a pwd and examining the directory syntax."
2340 (let ((host-type (ange-ftp-host-type host))
2341 (key (concat host "/" user "/~")))
2342 (if (eq host-type 'unix)
2343 ;; Note that ange-ftp-host-type returns unix as the default value.
2345 (let* ((result (ange-ftp-get-pwd host user))
2349 (message "Warning! Unable to get home directory")
2352 "^450 No current working directory defined$"
2355 ;; We'll assume that if pwd bombs with this
2356 ;; error message, then it's CMS.
2358 (ange-ftp-add-cms-host host)
2359 (setq ange-ftp-host-cache host
2360 ange-ftp-host-type-cache 'cms))))
2363 ((string-match ange-ftp-vms-name-template dir)
2364 (ange-ftp-add-vms-host host)
2365 ;; The add-host functions clear the host type cache.
2366 ;; Therefore, need to set the cache afterwards.
2367 (setq ange-ftp-host-cache host
2368 ange-ftp-host-type-cache 'vms))
2371 ((string-match ange-ftp-mts-name-template dir)
2372 (ange-ftp-add-mts-host host)
2373 (setq ange-ftp-host-cache host
2374 ange-ftp-host-type-cache 'mts))
2377 ((string-match ange-ftp-cms-name-template dir)
2378 (ange-ftp-add-cms-host host)
2379 (setq ange-ftp-host-cache host
2380 ange-ftp-host-type-cache 'cms))
2384 (setq ange-ftp-host-cache host
2385 ange-ftp-host-type-cache 'unix)))
2387 ;; Now that we have done a pwd, might as well put it in
2388 ;; the expand-dir hashtable.
2389 (let ((ange-ftp-this-user user)
2390 (ange-ftp-this-host host))
2391 (setq fix-name-func (cdr (assq ange-ftp-host-type-cache
2392 ange-ftp-fix-name-func-alist)))
2394 (setq dir (funcall fix-name-func dir 'reverse))))
2395 (ange-ftp-put-hash-entry key dir
2396 ange-ftp-expand-dir-hashtable))))
2398 ;; In the special case of CMS make sure that know the
2399 ;; expansion of the home minidisk now, because we will
2400 ;; be doing a lot of cd's.
2401 (if (and (eq host-type 'cms)
2402 (not (ange-ftp-hash-entry-exists-p
2403 key ange-ftp-expand-dir-hashtable)))
2404 (let ((dir (car (ange-ftp-get-pwd host user))))
2406 (ange-ftp-put-hash-entry key (concat "/" dir)
2407 ange-ftp-expand-dir-hashtable)
2408 (message "Warning! Unable to get home directory")
2412 ;;;; ------------------------------------------------------------
2413 ;;;; Remote file and directory listing support.
2414 ;;;; ------------------------------------------------------------
2416 ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands
2417 ;; to take switch arguments.
2418 (defun ange-ftp-dumb-unix-host (host)
2419 (and host ange-ftp-dumb-unix-host-regexp
2421 (string-match ange-ftp-dumb-unix-host-regexp host))))
2423 (defun ange-ftp-add-dumb-unix-host (host)
2424 "Interactively adds a given HOST to ange-ftp-dumb-unix-host-regexp."
2426 (list (read-string "Host: "
2427 (let ((name (or (buffer-file-name) default-directory)))
2428 (and name (car (ange-ftp-ftp-name name)))))))
2429 (if (not (ange-ftp-dumb-unix-host host))
2430 (setq ange-ftp-dumb-unix-host-regexp
2431 (concat "^" (regexp-quote host) "$"
2432 (and ange-ftp-dumb-unix-host-regexp "\\|")
2433 ange-ftp-dumb-unix-host-regexp)
2434 ange-ftp-host-cache nil)))
2436 (defvar ange-ftp-parse-list-func-alist nil
2437 "Alist saying how to parse directory listings for certain OS types.
2438 Association list of \( TYPE \. FUNC \) pairs. The FUNC is a routine
2439 which can parse the output from a DIR listing for a host of type TYPE.")
2441 ;; With no-error nil, this function returns:
2442 ;; an error if file is not an ange-ftp-name
2443 ;; (This should never happen.)
2444 ;; an error if either the listing is unreadable or there is an ftp error.
2445 ;; the listing (a string), if everything works.
2447 ;; With no-error t, it returns:
2448 ;; an error if not an ange-ftp-name
2449 ;; error if listing is unreadable (most likely caused by a slow connection)
2450 ;; nil if ftp error (this is because although asking to list a nonexistent
2451 ;; directory on a remote unix machine usually (except
2452 ;; maybe for dumb hosts) returns an ls error, but no
2453 ;; ftp error, if the same is done on a VMS machine,
2454 ;; an ftp error is returned. Need to trap the error
2455 ;; so we can go on and try to list the parent.)
2456 ;; the listing, if everything works.
2458 ;; If WILDCARD is non-nil, then this implements the guts of insert-directory
2459 ;; in the wildcard case. Then we make a relative directory listing
2460 ;; of FILE within the directory specified by `default-directory'.
2462 (defvar ange-ftp-before-parse-ls-hook nil
2463 "Normal hook run before parsing the text of an ftp directory listing.")
2465 (defun ange-ftp-ls (file lsargs parse &optional no-error wildcard)
2466 "Return the output of an `DIR' or `ls' command done over ftp.
2467 FILE is the full name of the remote file, LSARGS is any args to pass to the
2468 `ls' command, and PARSE specifies that the output should be parsed and stored
2469 away in the internal cache."
2470 ;; If parse is t, we assume that file is a directory. i.e. we only parse
2471 ;; full directory listings.
2472 (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file))
2473 (parsed (ange-ftp-ftp-name ange-ftp-this-file)))
2475 (let* ((host (nth 0 parsed))
2476 (user (nth 1 parsed))
2477 (name (ange-ftp-quote-string (nth 2 parsed)))
2478 (key (directory-file-name ange-ftp-this-file))
2479 (host-type (ange-ftp-host-type host user))
2480 (dumb (memq host-type ange-ftp-dumb-host-types))
2484 (if (string-equal name "")
2486 (ange-ftp-real-file-name-as-directory
2487 (ange-ftp-expand-dir host user "~"))))
2488 (if (and ange-ftp-ls-cache-file
2489 (string-equal key ange-ftp-ls-cache-file)
2490 ;; Don't care about lsargs for dumb hosts.
2491 (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs)))
2492 ange-ftp-ls-cache-res
2493 (setq temp (ange-ftp-make-tmp-name host))
2496 (ange-ftp-cd host user (file-name-directory name))
2497 (setq lscmd (list 'dir file temp lsargs)))
2498 (setq lscmd (list 'dir name temp lsargs)))
2500 (if (car (setq result (ange-ftp-send-cmd
2504 (format "Listing %s"
2505 (ange-ftp-abbreviate-filename
2506 ange-ftp-this-file)))))
2508 (set-buffer (get-buffer-create
2509 ange-ftp-data-buffer-name))
2511 (if (ange-ftp-real-file-readable-p temp)
2512 (ange-ftp-real-insert-file-contents temp)
2513 (sleep-for ange-ftp-retry-time)
2514 ;wait for file to possibly appear
2515 (if (ange-ftp-real-file-readable-p temp)
2517 (ange-ftp-real-insert-file-contents temp)
2518 (ange-ftp-error host user
2520 "list data file %s not readable"
2522 (run-hooks 'ange-ftp-before-parse-ls-hook)
2528 (cdr (assq host-type
2529 ange-ftp-parse-list-func-alist)))
2530 (funcall parse-func)
2531 (ange-ftp-parse-dired-listing lsargs))))
2532 (setq ange-ftp-ls-cache-file key
2533 ange-ftp-ls-cache-lsargs lsargs
2534 ; For dumb hosts-types this is
2535 ; meaningless but harmless.
2536 ange-ftp-ls-cache-res (buffer-string))
2537 ;; (kill-buffer (current-buffer))
2538 ange-ftp-ls-cache-res)
2541 (ange-ftp-error host user
2542 (concat "DIR failed: " (cdr result)))))
2543 (ange-ftp-del-tmp-name temp))))
2544 (error "Should never happen. Please report. Bug ref. no.: 1"))))
2546 ;;;; ------------------------------------------------------------
2547 ;;;; Directory information caching support.
2548 ;;;; ------------------------------------------------------------
2550 (defconst ange-ftp-date-regexp
2551 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2552 ;; In some locales, month abbreviations are as short as 2 letters,
2553 ;; and they can be padded on the right with spaces.
2554 (month (concat l l "+ *"))
2555 ;; Recognize any non-ASCII character.
2556 ;; The purpose is to match a Kanji character.
2561 (western (concat "\\(" month s dd "\\|" dd s month "\\)"))
2562 (japanese (concat mm k s dd k)))
2563 ;; Require the previous column to end in a digit.
2564 ;; This avoids recognizing `1 may 1997' as a date in the line:
2565 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
2566 (concat "[0-9]" s "\\(" western "\\|" japanese "\\)" s))
2567 "Regular expression to match up to the column before the file name in a
2568 directory listing. This regular expression is designed to recognize dates
2569 regardless of the language.")
2571 (defvar ange-ftp-add-file-entry-alist nil
2572 "Alist saying how to add file entries on certain OS types.
2573 Association list of pairs \( TYPE \. FUNC \), where FUNC
2574 is a function to be used to add a file entry for the OS TYPE. The
2575 main reason for this alist is to deal with file versions in VMS.")
2577 (defvar ange-ftp-delete-file-entry-alist nil
2578 "Alist saying how to delete files on certain OS types.
2579 Association list of pairs \( TYPE \. FUNC \), where FUNC
2580 is a function to be used to delete a file entry for the OS TYPE.
2581 The main reason for this alist is to deal with file versions in VMS.")
2583 (defun ange-ftp-add-file-entry (name &optional dir-p)
2584 "Add a file entry for file NAME, if its directory info exists."
2585 (funcall (or (cdr (assq (ange-ftp-host-type
2586 (car (ange-ftp-ftp-name name)))
2587 ange-ftp-add-file-entry-alist))
2588 'ange-ftp-internal-add-file-entry)
2590 (setq ange-ftp-ls-cache-file nil))
2592 (defun ange-ftp-delete-file-entry (name &optional dir-p)
2593 "Delete the file entry for file NAME, if its directory info exists."
2594 (funcall (or (cdr (assq (ange-ftp-host-type
2595 (car (ange-ftp-ftp-name name)))
2596 ange-ftp-delete-file-entry-alist))
2597 'ange-ftp-internal-delete-file-entry)
2599 (setq ange-ftp-ls-cache-file nil))
2601 (defmacro ange-ftp-parse-filename ()
2602 ;;Extract the filename from the current line of a dired-like listing.
2603 (` (let ((eol (progn (end-of-line) (point))))
2605 (if (re-search-forward ange-ftp-date-regexp eol t)
2607 (skip-chars-forward " ")
2608 (skip-chars-forward "^ " eol)
2609 (skip-chars-forward " " eol)
2610 ;; We bomb on filenames starting with a space.
2611 (buffer-substring (point) eol))))))
2613 ;; This deals with the F switch. Should also do something about
2614 ;; unquoting names obtained with the SysV b switch and the GNU Q
2615 ;; switch. See Sebastian's dired-get-filename.
2617 (defmacro ange-ftp-ls-parser ()
2618 ;; Note that switches is dynamically bound.
2619 ;; Meant to be called by ange-ftp-parse-dired-listing
2620 (` (let ((tbl (ange-ftp-make-hashtable))
2621 (used-F (and (stringp switches)
2622 (string-match "F" switches)))
2623 file-type symlink directory file)
2624 (while (setq file (ange-ftp-parse-filename))
2626 (skip-chars-forward "\t 0-9")
2627 (setq file-type (following-char)
2628 directory (eq file-type ?d))
2629 (if (eq file-type ?l)
2630 (if (string-match " -> " file)
2631 (setq symlink (substring file (match-end 0))
2632 file (substring file 0 (match-beginning 0)))
2636 ;; Only do a costly regexp search if the F switch was used.
2638 (not (string-equal file ""))
2640 ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"))
2641 (let ((socket (eq file-type ?s))
2643 (and (not symlink) ; x bits don't mean a thing for symlinks
2644 (string-match "[xst]"
2655 ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX)
2656 ;; and others don't. (sigh...) Beware, that some Unix's don't
2657 ;; seem to believe in the F-switch
2658 (if (or (and symlink (string-match "@$" file))
2659 (and directory (string-match "/$" file))
2660 (and executable (string-match "*$" file))
2661 (and socket (string-match "=$" file)))
2662 (setq file (substring file 0 -1)))))
2663 (ange-ftp-put-hash-entry file (or symlink directory) tbl)
2665 (ange-ftp-put-hash-entry "." t tbl)
2666 (ange-ftp-put-hash-entry ".." t tbl)
2669 ;;; The dl stuff for descriptive listings
2671 (defvar ange-ftp-dl-dir-regexp nil
2672 "Regexp matching directories which are listed in dl format.
2673 This regexp should not be anchored with a trailing `$', because it should
2674 match subdirectories as well.")
2676 (defun ange-ftp-add-dl-dir (dir)
2677 "Interactively adds a DIR to ange-ftp-dl-dir-regexp."
2679 (list (read-string "Directory: "
2680 (let ((name (or (buffer-file-name) default-directory)))
2681 (and name (ange-ftp-ftp-name name)
2682 (file-name-directory name))))))
2683 (if (not (and ange-ftp-dl-dir-regexp
2684 (string-match ange-ftp-dl-dir-regexp dir)))
2685 (setq ange-ftp-dl-dir-regexp
2686 (concat "^" (regexp-quote dir)
2687 (and ange-ftp-dl-dir-regexp "\\|")
2688 ange-ftp-dl-dir-regexp))))
2690 (defmacro ange-ftp-dl-parser ()
2691 ;; Parse the current buffer, which is assumed to be a descriptive
2692 ;; listing, and return a hashtable.
2693 (` (let ((tbl (ange-ftp-make-hashtable)))
2695 (ange-ftp-put-hash-entry
2696 (buffer-substring (point)
2698 (skip-chars-forward "^ /\n")
2700 (eq (following-char) ?/)
2703 (ange-ftp-put-hash-entry "." t tbl)
2704 (ange-ftp-put-hash-entry ".." t tbl)
2707 ;; Parse the current buffer which is assumed to be in a dired-like listing
2708 ;; format, and return a hashtable as the result. If the listing is not really
2709 ;; a listing, then return nil.
2711 (defun ange-ftp-parse-dired-listing (&optional switches)
2714 ((looking-at "^total [0-9]+$")
2716 ;; Some systems put in a blank line here.
2717 (if (eolp) (forward-line 1))
2718 (ange-ftp-ls-parser))
2719 ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'")
2720 ;; It's an ls error message.
2722 ((eobp) ; i.e. (zerop (buffer-size))
2723 ;; This could be one of:
2724 ;; (1) An Ultrix ls error message
2725 ;; (2) A listing with the A switch of an empty directory
2726 ;; on a machine which doesn't give a total line.
2727 ;; (3) The twilight zone.
2728 ;; We'll assume (1) for now.
2730 ((re-search-forward ange-ftp-date-regexp nil t)
2732 (ange-ftp-ls-parser))
2733 ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t)
2734 ;; It's a dl listing (I hope).
2735 ;; file is bound by the call to ange-ftp-ls
2736 (ange-ftp-add-dl-dir ange-ftp-this-file)
2738 (ange-ftp-dl-parser))
2741 (defun ange-ftp-set-files (directory files)
2742 "For a given DIRECTORY, set or change the associated FILES hashtable."
2743 (and files (ange-ftp-put-hash-entry (file-name-as-directory directory)
2744 files ange-ftp-files-hashtable)))
2746 (defun ange-ftp-get-files (directory &optional no-error)
2747 "Given a given DIRECTORY, return a hashtable of file entries.
2748 This will give an error or return nil, depending on the value of
2749 NO-ERROR, if a listing for DIRECTORY cannot be obtained."
2750 (setq directory (file-name-as-directory directory)) ;normalize
2751 (or (ange-ftp-get-hash-entry directory ange-ftp-files-hashtable)
2753 (and (ange-ftp-ls directory
2754 ;; This is an efficiency hack. We try to
2755 ;; anticipate what sort of listing dired
2756 ;; might want, and cache just such a listing.
2757 (if (and (boundp 'dired-actual-switches)
2758 (stringp dired-actual-switches)
2759 ;; We allow the A switch, which lists
2760 ;; all files except "." and "..".
2761 ;; This is OK because we manually
2762 ;; insert these entries
2763 ;; in the hash table.
2765 "[aA]" dired-actual-switches)
2767 "l" dired-actual-switches)
2769 "R" dired-actual-switches)))
2770 dired-actual-switches
2771 (if (and (boundp 'dired-listing-switches)
2772 (stringp dired-listing-switches)
2774 "[aA]" dired-listing-switches)
2776 "l" dired-listing-switches)
2778 "R" dired-listing-switches)))
2779 dired-listing-switches
2782 (ange-ftp-get-hash-entry
2783 directory ange-ftp-files-hashtable)))))
2785 ;; Given NAME, return the file part that can be used for looking up the
2786 ;; file's entry in a hashtable.
2787 (defmacro ange-ftp-get-file-part (name)
2788 (` (let ((file (file-name-nondirectory (, name))))
2789 (if (string-equal file "")
2793 ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are
2794 ;; allowed to determine if NAME is a sub-directory by listing it directly,
2795 ;; rather than listing its parent directory. This is used for efficiency so
2796 ;; that a wasted listing is not done:
2797 ;; 1. When looking for a .dired file in dired-x.el.
2798 ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid
2799 ;; subdirectory. This is of course an OS dependent judgement.
2801 (defmacro ange-ftp-allow-child-lookup (dir file)
2803 (let* ((efile (, file)) ; expand once.
2805 (parsed (ange-ftp-ftp-name edir))
2806 (host-type (ange-ftp-host-type
2810 (and (boundp 'dired-local-variables-file) ; in the dired-x package
2811 (stringp dired-local-variables-file)
2812 (string-equal dired-local-variables-file efile))
2813 ;; No dots in dir names in vms.
2814 (and (eq host-type 'vms)
2815 (string-match "\\." efile))
2816 ;; No subdirs in mts of cms.
2817 (and (memq host-type '(mts cms))
2818 (not (string-equal "/" (nth 2 parsed)))))))))
2820 (defun ange-ftp-file-entry-p (name)
2821 "Given NAME, return whether there is a file entry for it."
2822 (let* ((name (directory-file-name name))
2823 (dir (file-name-directory name))
2824 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
2825 (file (ange-ftp-get-file-part name)))
2827 (ange-ftp-hash-entry-exists-p file ent)
2828 (or (and (ange-ftp-allow-child-lookup dir file)
2829 (setq ent (ange-ftp-get-files name t))
2830 ;; Try a child lookup. i.e. try to list file as a
2831 ;; subdirectory of dir. This is a good idea because
2832 ;; we may not have read permission for file's parent. Also,
2833 ;; people tend to work down directory trees anyway. We use
2834 ;; no-error ;; because if file does not exist as a subdir.,
2835 ;; then dumb hosts will give an ftp error. Smart unix hosts
2836 ;; will simply send back the ls
2838 (ange-ftp-get-hash-entry "." ent))
2839 ;; Child lookup failed, so try the parent.
2840 (let ((table (ange-ftp-get-files dir)))
2841 ;; If the dir doesn't exist, don't use it as a hash table.
2843 (ange-ftp-hash-entry-exists-p file
2846 (defun ange-ftp-get-file-entry (name)
2847 "Given NAME, return the given file entry.
2848 The entry will be either t for a directory, nil for a normal file,
2849 or a string for a symlink. If the file isn't in the hashtable,
2850 this also returns nil."
2851 (let* ((name (directory-file-name name))
2852 (dir (file-name-directory name))
2853 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable))
2854 (file (ange-ftp-get-file-part name)))
2856 (ange-ftp-get-hash-entry file ent)
2857 (or (and (ange-ftp-allow-child-lookup dir file)
2858 (setq ent (ange-ftp-get-files name t))
2859 (ange-ftp-get-hash-entry "." ent))
2860 ;; i.e. it's a directory by child lookup
2861 (ange-ftp-get-hash-entry file
2862 (ange-ftp-get-files dir))))))
2864 (defun ange-ftp-internal-delete-file-entry (name &optional dir-p)
2867 (setq name (file-name-as-directory name))
2868 (ange-ftp-del-hash-entry name ange-ftp-files-hashtable)
2869 (setq name (directory-file-name name))))
2870 ;; Note that file-name-as-directory followed by directory-file-name
2871 ;; serves to canonicalize directory file names to their unix form.
2872 ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO
2873 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2874 ange-ftp-files-hashtable)))
2876 (ange-ftp-del-hash-entry (ange-ftp-get-file-part name)
2879 (defun ange-ftp-internal-add-file-entry (name &optional dir-p)
2881 (setq name (directory-file-name name)))
2882 (let ((files (ange-ftp-get-hash-entry (file-name-directory name)
2883 ange-ftp-files-hashtable)))
2885 (ange-ftp-put-hash-entry (ange-ftp-get-file-part name)
2889 (defun ange-ftp-wipe-file-entries (host user)
2890 "Get rid of entry for HOST, USER pair from file entry information hashtable."
2891 (let ((new-tbl (ange-ftp-make-hashtable (length ange-ftp-files-hashtable))))
2892 (ange-ftp-map-hashtable
2895 (let ((parsed (ange-ftp-ftp-name key)))
2897 (let ((h (nth 0 parsed))
2899 (or (and (equal host h) (equal user u))
2900 (ange-ftp-put-hash-entry key val new-tbl)))))))
2901 ange-ftp-files-hashtable)
2902 (setq ange-ftp-files-hashtable new-tbl)))
2904 ;;;; ------------------------------------------------------------
2905 ;;;; File transfer mode support.
2906 ;;;; ------------------------------------------------------------
2908 (defun ange-ftp-set-binary-mode (host user)
2909 "Tell the ftp process for the given HOST & USER to switch to binary mode."
2910 (let ((result (ange-ftp-send-cmd host user '(type "binary"))))
2911 (if (not (car result))
2912 (ange-ftp-error host user (concat "BINARY failed: " (cdr result)))
2914 (set-buffer (process-buffer (ange-ftp-get-process host user)))
2915 (and ange-ftp-binary-hash-mark-size
2916 (setq ange-ftp-hash-mark-unit
2917 (ash ange-ftp-binary-hash-mark-size -4)))))))
2919 (defun ange-ftp-set-ascii-mode (host user)
2920 "Tell the ftp process for the given HOST & USER to switch to ascii mode."
2921 (let ((result (ange-ftp-send-cmd host user '(type "ascii"))))
2922 (if (not (car result))
2923 (ange-ftp-error host user (concat "ASCII failed: " (cdr result)))
2925 (set-buffer (process-buffer (ange-ftp-get-process host user)))
2926 (and ange-ftp-ascii-hash-mark-size
2927 (setq ange-ftp-hash-mark-unit
2928 (ash ange-ftp-ascii-hash-mark-size -4)))))))
2930 (defun ange-ftp-cd (host user dir)
2931 (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD")))
2933 (ange-ftp-error host user (concat "CD failed: " (cdr result))))))
2935 (defun ange-ftp-get-pwd (host user)
2936 "Attempts to get the current working directory for the given HOST/USER pair.
2937 Returns \( DIR . LINE \) where DIR is either the directory or nil if not found,
2938 and LINE is the relevant success or fail line from the FTP-client."
2939 (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD"))
2944 (and (or (string-match "\"\\([^\"]*\\)\"" line)
2945 (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers!
2946 (setq dir (substring line
2951 ;;; ------------------------------------------------------------
2952 ;;; expand-file-name and friends...which currently don't work
2953 ;;; ------------------------------------------------------------
2955 (defun ange-ftp-expand-dir (host user dir)
2956 "Return the result of doing a PWD in the current FTP session.
2957 Use the connection to machine HOST
2958 logged in as user USER and cd'd to directory DIR."
2959 (let* ((host-type (ange-ftp-host-type host user))
2960 ;; It is more efficient to call ange-ftp-host-type
2961 ;; before binding res, because ange-ftp-host-type sometimes
2962 ;; adds to the info in the expand-dir-hashtable.
2964 (cdr (assq host-type ange-ftp-fix-name-func-alist)))
2965 (key (concat host "/" user "/" dir))
2966 (res (ange-ftp-get-hash-entry key ange-ftp-expand-dir-hashtable)))
2970 (string-equal user "anonymous")
2971 (string-equal user "ftp")
2972 (not (eq host-type 'unix))
2973 (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp
2975 ange-ftp-good-msgs))
2976 (result (ange-ftp-send-cmd host user
2977 (list 'get dir null-device)
2978 (format "expanding %s" dir)))
2979 (line (cdr result)))
2981 (if (string-match ange-ftp-expand-dir-regexp line)
2986 (if (string-equal dir "~")
2987 (setq res (car (ange-ftp-get-pwd host user)))
2988 (let ((home (ange-ftp-expand-dir host user "~")))
2990 (and (ange-ftp-cd host user dir)
2991 (setq res (car (ange-ftp-get-pwd host user))))
2992 (ange-ftp-cd host user home)))))
2994 (let ((ange-ftp-this-user user)
2995 (ange-ftp-this-host host))
2997 (setq res (funcall fix-name-func res 'reverse)))
2998 (ange-ftp-put-hash-entry
2999 key res ange-ftp-expand-dir-hashtable)))
3002 (defun ange-ftp-canonize-filename (n)
3003 "Take a string and short-circuit //, /. and /.."
3004 (if (string-match "[^:]+//" n) ;don't upset Apollo users
3005 (setq n (substring n (1- (match-end 0)))))
3006 (let ((parsed (ange-ftp-ftp-name n)))
3008 (let ((host (car parsed))
3009 (user (nth 1 parsed))
3010 (name (nth 2 parsed)))
3012 ;; See if remote name is absolute. If so then just expand it and
3013 ;; replace the name component of the overall name.
3014 (cond ((string-match "^/" name)
3017 ;; Name starts with ~ or ~user. Resolve that part of the name
3018 ;; making it absolute then re-expand it.
3019 ((string-match "^~[^/]*" name)
3020 (let* ((tilda (substring name
3023 (rest (substring name (match-end 0)))
3024 (dir (ange-ftp-expand-dir host user tilda)))
3026 (setq name (concat dir rest))
3027 (error "User \"%s\" is not known"
3028 (substring tilda 1)))))
3030 ;; relative name. Tack on homedir and re-expand.
3032 (let ((dir (ange-ftp-expand-dir host user "~")))
3035 (ange-ftp-real-file-name-as-directory dir)
3037 (error "Unable to obtain CWD")))))
3039 ;; If name starts with //, preserve that, for apollo system.
3040 (if (not (string-match "^//" name))
3042 (setq name (ange-ftp-real-expand-file-name name))
3043 ;; Strip off drive specifier added on windows-nt
3044 (if (and (eq system-type 'windows-nt)
3045 (string-match "^[a-zA-Z]:" name))
3046 (setq name (substring name 2)))
3047 (if (string-match "^//" name)
3048 (setq name (substring name 1)))))
3050 ;; Now substitute the expanded name back into the overall filename.
3051 (ange-ftp-replace-name-component n name))
3053 ;; non-ange-ftp name. Just expand normally.
3054 (if (eq (string-to-char n) ?/)
3055 (ange-ftp-real-expand-file-name n)
3056 (ange-ftp-real-expand-file-name
3057 (ange-ftp-real-file-name-nondirectory n)
3058 (ange-ftp-real-file-name-directory n))))))
3060 (defun ange-ftp-expand-file-name (name &optional default)
3061 "Documented as original."
3063 (setq default (or default default-directory))
3064 (cond ((eq (string-to-char name) ?~)
3065 (ange-ftp-real-expand-file-name name))
3066 ((eq (string-to-char name) ?/)
3067 (ange-ftp-canonize-filename name))
3068 ((and (eq system-type 'windows-nt)
3069 (or (string-match "^[a-zA-Z]:" name)
3070 (string-match "^[a-zA-Z]:" default)))
3071 (ange-ftp-real-expand-file-name name default))
3072 ((zerop (length name))
3073 (ange-ftp-canonize-filename default))
3074 ((ange-ftp-canonize-filename
3075 (concat (file-name-as-directory default) name))))))
3077 ;;; These are problems--they are currently not enabled.
3079 (defvar ange-ftp-file-name-as-directory-alist nil
3080 "Association list of \( TYPE \. FUNC \) pairs.
3081 FUNC converts a filename to a directory name for the operating
3084 (defun ange-ftp-file-name-as-directory (name)
3085 "Documented as original."
3086 (let ((parsed (ange-ftp-ftp-name name)))
3088 (if (string-equal (nth 2 parsed) "")
3090 (funcall (or (cdr (assq
3091 (ange-ftp-host-type (car parsed))
3092 ange-ftp-file-name-as-directory-alist))
3093 'ange-ftp-real-file-name-as-directory)
3095 (ange-ftp-real-file-name-as-directory name))))
3097 (defun ange-ftp-file-name-directory (name)
3098 "Documented as original."
3099 (let ((parsed (ange-ftp-ftp-name name)))
3101 (let ((filename (nth 2 parsed)))
3102 (if (save-match-data
3103 (string-match "^~[^/]*$" filename))
3105 (ange-ftp-replace-name-component
3107 (ange-ftp-real-file-name-directory filename))))
3108 (ange-ftp-real-file-name-directory name))))
3110 (defun ange-ftp-file-name-nondirectory (name)
3111 "Documented as original."
3112 (let ((parsed (ange-ftp-ftp-name name)))
3114 (let ((filename (nth 2 parsed)))
3115 (if (save-match-data
3116 (string-match "^~[^/]*$" filename))
3118 (ange-ftp-real-file-name-nondirectory name)))
3119 (ange-ftp-real-file-name-nondirectory name))))
3121 (defun ange-ftp-directory-file-name (dir)
3122 "Documented as original."
3123 (let ((parsed (ange-ftp-ftp-name dir)))
3125 (ange-ftp-replace-name-component
3127 (ange-ftp-real-directory-file-name (nth 2 parsed)))
3128 (ange-ftp-real-directory-file-name dir))))
3131 ;;; Hooks that handle Emacs primitives.
3133 ;; Returns non-nil if should transfer FILE in binary mode.
3134 (defun ange-ftp-binary-file (file)
3136 (string-match ange-ftp-binary-file-name-regexp file)))
3138 (defun ange-ftp-write-region (start end filename &optional append visit)
3139 (setq filename (expand-file-name filename))
3140 (let ((parsed (ange-ftp-ftp-name filename)))
3142 (let* ((host (nth 0 parsed))
3143 (user (nth 1 parsed))
3144 (name (ange-ftp-quote-string (nth 2 parsed)))
3145 (temp (ange-ftp-make-tmp-name host))
3146 ;; What we REALLY need here is a way to determine if the mode
3147 ;; of the transfer is irrelevant, i.e. we can use binary mode
3148 ;; regardless. Maybe a system-type to host-type lookup?
3149 (binary (or (ange-ftp-binary-file filename)
3150 (memq (ange-ftp-host-type host user)
3151 '(unix dumb-unix))))
3152 (cmd (if append 'append 'put))
3153 (abbr (ange-ftp-abbreviate-filename filename))
3154 ;; we need to reset `last-coding-system-used' to its
3155 ;; value immediately after calling the real write-region,
3156 ;; so that `basic-save-buffer' doesn't see whatever value
3157 ;; might be used when communicating with the ftp process.
3158 (coding-system-used last-coding-system-used))
3161 (let ((executing-kbd-macro t)
3162 (filename (buffer-file-name))
3163 (mod-p (buffer-modified-p)))
3165 (ange-ftp-real-write-region start end temp nil visit)
3167 (setq buffer-file-name filename)
3168 (set-buffer-modified-p mod-p)))
3169 ;; save value used by the real write-region
3170 (setq coding-system-used last-coding-system-used)
3172 (ange-ftp-set-binary-mode host user))
3174 ;; tell the process filter what size the transfer will be.
3175 (let ((attr (file-attributes temp)))
3177 (ange-ftp-set-xfer-size host user (nth 7 attr))))
3179 ;; put or append the file.
3180 (let ((result (ange-ftp-send-cmd host user
3181 (list cmd temp name)
3182 (format "Writing %s" abbr))))
3186 "Opening output file"
3187 (format "FTP Error: \"%s\"" (cdr result))
3189 (ange-ftp-del-tmp-name temp)
3191 (ange-ftp-set-ascii-mode host user)))
3194 (set-visited-file-modtime '(0 0))
3195 (ange-ftp-set-buffer-mode)
3196 (setq buffer-file-name filename)
3197 (set-buffer-modified-p nil)))
3198 ;; ensure `last-coding-system-used' has an appropriate value
3199 (setq last-coding-system-used coding-system-used)
3200 (ange-ftp-message "Wrote %s" abbr)
3201 (ange-ftp-add-file-entry filename))
3202 (ange-ftp-real-write-region start end filename append visit))))
3204 (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace)
3205 (barf-if-buffer-read-only)
3206 (setq filename (expand-file-name filename))
3207 (let ((parsed (ange-ftp-ftp-name filename)))
3211 (setq buffer-file-name filename))
3212 (if (or (file-exists-p filename)
3214 (setq ange-ftp-ls-cache-file nil)
3215 (ange-ftp-del-hash-entry (file-name-directory filename)
3216 ange-ftp-files-hashtable)
3217 (file-exists-p filename)))
3218 (let* ((host (nth 0 parsed))
3219 (user (nth 1 parsed))
3220 (name (ange-ftp-quote-string (nth 2 parsed)))
3221 (temp (ange-ftp-make-tmp-name host))
3222 (binary (or (ange-ftp-binary-file filename)
3223 (eq (ange-ftp-host-type host user) 'unix)))
3224 (abbr (ange-ftp-abbreviate-filename filename))
3229 (ange-ftp-set-binary-mode host user))
3230 (let ((result (ange-ftp-send-cmd host user
3231 (list 'get name temp)
3232 (format "Retrieving %s" abbr))))
3236 "Opening input file"
3237 (format "FTP Error: \"%s\"" (cdr result))
3239 (if (or (ange-ftp-real-file-readable-p temp)
3240 (sleep-for ange-ftp-retry-time)
3241 ;; Wait for file to hopefully appear.
3242 (ange-ftp-real-file-readable-p temp))
3245 (nth 1 (ange-ftp-real-insert-file-contents
3246 temp visit beg end replace))
3247 ;; override autodetection of buffer file type
3248 ;; to ensure buffer is saved in DOS format
3249 buffer-file-type binary)
3252 "Opening input file:"
3254 "FTP Error: %s not arrived or readable"
3257 (ange-ftp-set-ascii-mode host user))
3258 (ange-ftp-del-tmp-name temp))
3261 (set-visited-file-modtime '(0 0))
3262 (setq buffer-file-name filename)))
3263 (list filename size))
3266 "Opening input file"
3268 (ange-ftp-real-insert-file-contents filename visit beg end replace))))
3270 (defun ange-ftp-expand-symlink (file dir)
3271 (if (file-name-absolute-p file)
3272 (ange-ftp-replace-name-component dir file)
3273 (expand-file-name file dir)))
3275 (defun ange-ftp-file-symlink-p (file)
3276 ;; call ange-ftp-expand-file-name rather than the normal
3277 ;; expand-file-name to stop loops when using a package that
3278 ;; redefines both file-symlink-p and expand-file-name.
3279 (setq file (ange-ftp-expand-file-name file))
3280 (if (ange-ftp-ftp-name file)
3282 (ange-ftp-get-hash-entry
3283 (ange-ftp-get-file-part file)
3284 (ange-ftp-get-files (file-name-directory file)))))
3285 (if (stringp file-ent)
3286 (if (file-name-absolute-p file-ent)
3287 (ange-ftp-replace-name-component
3288 (file-name-directory file) file-ent)
3290 (ange-ftp-real-file-symlink-p file)))
3292 (defun ange-ftp-file-exists-p (name)
3293 (setq name (expand-file-name name))
3294 (if (ange-ftp-ftp-name name)
3295 (if (ange-ftp-file-entry-p name)
3296 (let ((file-ent (ange-ftp-get-file-entry name)))
3297 (if (stringp file-ent)
3299 (ange-ftp-expand-symlink file-ent
3300 (file-name-directory
3301 (directory-file-name name))))
3303 (ange-ftp-real-file-exists-p name)))
3305 (defun ange-ftp-file-directory-p (name)
3306 (setq name (expand-file-name name))
3307 (if (ange-ftp-ftp-name name)
3308 ;; We do a file-name-as-directory on name here because some
3309 ;; machines (VMS) use a .DIR to indicate the filename associated
3310 ;; with a directory. This needs to be canonicalized.
3311 (let ((file-ent (ange-ftp-get-file-entry
3312 (ange-ftp-file-name-as-directory name))))
3313 (if (stringp file-ent)
3315 (ange-ftp-expand-symlink file-ent
3316 (file-name-directory
3317 (directory-file-name name))))
3319 (ange-ftp-real-file-directory-p name)))
3321 (defun ange-ftp-directory-files (directory &optional full match
3323 (setq directory (expand-file-name directory))
3324 (if (ange-ftp-ftp-name directory)
3326 (ange-ftp-barf-if-not-directory directory)
3327 (let ((tail (ange-ftp-hash-table-keys
3328 (ange-ftp-get-files directory)))
3330 (setq directory (file-name-as-directory directory))
3335 (if (or (not match) (string-match match f))
3337 (cons (if full (concat directory f) f) files)))))
3339 (apply 'ange-ftp-real-directory-files directory full match v19-args)))
3341 (defun ange-ftp-file-attributes (file)
3342 (setq file (expand-file-name file))
3343 (let ((parsed (ange-ftp-ftp-name file)))
3345 (let ((part (ange-ftp-get-file-part file))
3346 (files (ange-ftp-get-files (file-name-directory file))))
3347 (if (ange-ftp-hash-entry-exists-p part files)
3348 (let ((host (nth 0 parsed))
3349 (user (nth 1 parsed))
3350 (name (nth 2 parsed))
3351 (dirp (ange-ftp-get-hash-entry part files))
3352 (inode (ange-ftp-get-hash-entry
3353 file ange-ftp-inodes-hashtable)))
3355 (setq inode ange-ftp-next-inode-number
3356 ange-ftp-next-inode-number (1+ inode))
3357 (ange-ftp-put-hash-entry file inode ange-ftp-inodes-hashtable))
3358 (list (if (and (stringp dirp) (file-name-absolute-p dirp))
3359 (ange-ftp-expand-symlink dirp
3360 (file-name-directory file))
3369 (concat (if (stringp dirp) "l" (if dirp "d" "-"))
3370 "?????????") ;8 mode
3372 inode ;10 "inode number".
3373 -1 ;11 device number [v19 only]
3375 (ange-ftp-real-file-attributes file))))
3377 (defun ange-ftp-file-writable-p (file)
3378 (setq file (expand-file-name file))
3379 (if (ange-ftp-ftp-name file)
3380 (or (file-exists-p file) ;guess here for speed
3381 (file-directory-p (file-name-directory file)))
3382 (ange-ftp-real-file-writable-p file)))
3384 (defun ange-ftp-file-readable-p (file)
3385 (setq file (expand-file-name file))
3386 (if (ange-ftp-ftp-name file)
3387 (file-exists-p file)
3388 (ange-ftp-real-file-readable-p file)))
3390 (defun ange-ftp-file-executable-p (file)
3391 (setq file (expand-file-name file))
3392 (if (ange-ftp-ftp-name file)
3393 (file-exists-p file)
3394 (ange-ftp-real-file-executable-p file)))
3396 (defun ange-ftp-delete-file (file)
3397 (interactive "fDelete file: ")
3398 (setq file (expand-file-name file))
3399 (let ((parsed (ange-ftp-ftp-name file)))
3401 (let* ((host (nth 0 parsed))
3402 (user (nth 1 parsed))
3403 (name (ange-ftp-quote-string (nth 2 parsed)))
3404 (abbr (ange-ftp-abbreviate-filename file))
3405 (result (ange-ftp-send-cmd host user
3407 (format "Deleting %s" abbr))))
3412 (format "FTP Error: \"%s\"" (cdr result))
3414 (ange-ftp-delete-file-entry file))
3415 (ange-ftp-real-delete-file file))))
3417 (defun ange-ftp-verify-visited-file-modtime (buf)
3418 (let ((name (buffer-file-name buf)))
3419 (if (and (stringp name) (ange-ftp-ftp-name name))
3421 (ange-ftp-real-verify-visited-file-modtime buf))))
3423 ;;;; ------------------------------------------------------------
3424 ;;;; File copying support... totally re-written 6/24/92.
3425 ;;;; ------------------------------------------------------------
3427 (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive)
3428 (if (file-exists-p absname)
3429 (if (not interactive)
3430 (signal 'file-already-exists (list absname))
3431 (if (not (yes-or-no-p (format "File %s already exists; %s anyway? "
3432 absname querystring)))
3433 (signal 'file-already-exists (list absname))))))
3435 ;; async local copy commented out for now since I don't seem to get
3436 ;; the process sentinel called for some processes.
3438 ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists
3440 ;; "Kludge to copy a local file and call a continuation when the copy
3442 ;; ;; check to see if we can overwrite
3443 ;; (if (or (not ok-if-already-exists)
3444 ;; (numberp ok-if-already-exists))
3445 ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3446 ;; (numberp ok-if-already-exists)))
3447 ;; (let ((proc (start-process " *copy*"
3448 ;; (generate-new-buffer "*copy*")
3453 ;; (set-process-sentinel proc (function ange-ftp-copy-file-locally-sentinel))
3454 ;; (process-kill-without-query proc)
3456 ;; (set-buffer (process-buffer proc))
3457 ;; (make-variable-buffer-local 'copy-cont)
3458 ;; (setq copy-cont cont))))
3460 ;; (defun ange-ftp-copy-file-locally-sentinel (proc status)
3462 ;; (set-buffer (process-buffer proc))
3463 ;; (let ((cont copy-cont)
3464 ;; (result (buffer-string)))
3466 ;; (if (and (string-equal status "finished\n")
3467 ;; (zerop (length result)))
3468 ;; (ange-ftp-call-cont cont t nil)
3469 ;; (ange-ftp-call-cont cont
3471 ;; (if (zerop (length result))
3472 ;; (substring status 0 -1)
3473 ;; (substring result 0 -1))))
3474 ;; (kill-buffer (current-buffer))))))
3476 ;; this is the extended version of ange-ftp-copy-file-internal that works
3477 ;; asynchronously if asked nicely.
3478 (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists
3479 keep-date &optional msg cont nowait)
3480 (setq filename (expand-file-name filename)
3481 newname (expand-file-name newname))
3483 ;; canonicalize newname if a directory.
3484 (if (file-directory-p newname)
3485 (setq newname (expand-file-name (file-name-nondirectory filename) newname)))
3487 (let ((f-parsed (ange-ftp-ftp-name filename))
3488 (t-parsed (ange-ftp-ftp-name newname)))
3490 ;; local file to local file copy?
3491 (if (and (not f-parsed) (not t-parsed))
3493 (ange-ftp-real-copy-file filename newname ok-if-already-exists
3496 (ange-ftp-call-cont cont t "Copied locally")))
3497 ;; one or both files are remote.
3498 (let* ((f-host (and f-parsed (nth 0 f-parsed)))
3499 (f-user (and f-parsed (nth 1 f-parsed)))
3500 (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed))))
3501 (f-abbr (ange-ftp-abbreviate-filename filename))
3502 (t-host (and t-parsed (nth 0 t-parsed)))
3503 (t-user (and t-parsed (nth 1 t-parsed)))
3504 (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed))))
3505 (t-abbr (ange-ftp-abbreviate-filename newname filename))
3506 (binary (or (ange-ftp-binary-file filename)
3507 (ange-ftp-binary-file newname)
3508 (and (eq (ange-ftp-host-type f-host f-user) 'unix)
3509 (eq (ange-ftp-host-type t-host t-user) 'unix))))
3513 ;; check to see if we can overwrite
3514 (if (or (not ok-if-already-exists)
3515 (numberp ok-if-already-exists))
3516 (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3517 (numberp ok-if-already-exists)))
3522 ;; filename was remote.
3524 (if (or (ange-ftp-use-gateway-p f-host)
3526 ;; have to use intermediate file if we are getting via
3527 ;; gateway machine or we are doing a remote to remote copy.
3528 (setq temp1 (ange-ftp-make-tmp-name f-host)))
3531 (ange-ftp-set-binary-mode f-host f-user))
3536 (list 'get f-name (or temp1 newname))
3538 (if (and temp1 t-parsed)
3539 (format "Getting %s" f-abbr)
3540 (format "Copying %s to %s" f-abbr t-abbr)))
3541 (list (function ange-ftp-cf1)
3542 filename newname binary msg
3543 f-parsed f-host f-user f-name f-abbr
3544 t-parsed t-host t-user t-name t-abbr
3545 temp1 temp2 cont nowait)
3548 ;; filename wasn't remote. newname must be remote. call the
3549 ;; function which does the remainder of the copying work.
3551 filename newname binary msg
3552 f-parsed f-host f-user f-name f-abbr
3553 t-parsed t-host t-user t-name t-abbr
3554 nil nil cont nowait))))))
3556 ;; next part of copying routine.
3557 (defun ange-ftp-cf1 (result line
3558 filename newname binary msg
3559 f-parsed f-host f-user f-name f-abbr
3560 t-parsed t-host t-user t-name t-abbr
3561 temp1 temp2 cont nowait)
3563 ;; filename must have been remote, and we must have just done a GET.
3566 ;; GET failed for some reason. Clean up and get out.
3568 (and temp1 (ange-ftp-del-tmp-name temp1))
3570 (if ange-ftp-waiting-flag
3571 (throw 'ftp-error t)
3573 (list "Opening input file"
3574 (format "FTP Error: \"%s\"" line)
3578 (ange-ftp-set-ascii-mode f-host f-user))))
3581 ;; We now have to copy either temp1 or filename to newname.
3584 ;; newname was remote.
3586 (if (ange-ftp-use-gateway-p t-host)
3587 (setq temp2 (ange-ftp-make-tmp-name t-host)))
3589 ;; make sure data is moved into the right place for the
3590 ;; outgoing transfer. gateway temporary files complicate
3594 (if (string-equal temp1 temp2)
3596 (ange-ftp-real-copy-file temp1 temp2 t))
3597 (setq temp2 temp1 temp1 nil))
3599 (ange-ftp-real-copy-file filename temp2 t)))
3602 (ange-ftp-set-binary-mode t-host t-user))
3604 ;; tell the process filter what size the file is.
3605 (let ((attr (file-attributes (or temp2 filename))))
3607 (ange-ftp-set-xfer-size t-host t-user (nth 7 attr))))
3612 (list 'put (or temp2 filename) t-name)
3614 (if (and temp2 f-parsed)
3615 (format "Putting %s" newname)
3616 (format "Copying %s to %s" f-abbr t-abbr)))
3617 (list (function ange-ftp-cf2)
3618 newname t-host t-user binary temp1 temp2 cont)
3621 ;; newname wasn't remote.
3622 (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont))
3624 ;; first copy failed, tell caller
3625 (ange-ftp-call-cont cont result line)))
3627 ;; last part of copying routine.
3628 (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont)
3631 ;; result from doing a local to remote copy.
3636 (if ange-ftp-waiting-flag
3637 (throw 'ftp-error t)
3639 (list "Opening output file"
3640 (format "FTP Error: \"%s\"" line)
3643 (ange-ftp-add-file-entry newname))
3647 (ange-ftp-set-ascii-mode t-host t-user)))
3649 ;; newname was local.
3651 (ange-ftp-real-copy-file temp1 newname t)))
3654 (and temp1 (ange-ftp-del-tmp-name temp1))
3655 (and temp2 (ange-ftp-del-tmp-name temp2))
3656 (ange-ftp-call-cont cont result line)))
3658 (defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists
3660 (interactive "fCopy file: \nFCopy %s to file: \np")
3661 (ange-ftp-copy-file-internal filename
3663 ok-if-already-exists
3669 ;;;; ------------------------------------------------------------
3670 ;;;; File renaming support.
3671 ;;;; ------------------------------------------------------------
3673 (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed)
3674 "Rename remote file FILE to remote file NEWNAME."
3675 (let ((f-host (nth 0 f-parsed))
3676 (f-user (nth 1 f-parsed))
3677 (t-host (nth 0 t-parsed))
3678 (t-user (nth 1 t-parsed)))
3679 (if (and (string-equal f-host t-host)
3680 (string-equal f-user t-user))
3681 (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed)))
3682 (t-name (ange-ftp-quote-string (nth 2 t-parsed)))
3683 (cmd (list 'rename f-name t-name))
3684 (fabbr (ange-ftp-abbreviate-filename filename))
3685 (nabbr (ange-ftp-abbreviate-filename newname filename))
3686 (result (ange-ftp-send-cmd f-host f-user cmd
3687 (format "Renaming %s to %s"
3694 (format "FTP Error: \"%s\"" (cdr result))
3697 (ange-ftp-add-file-entry newname)
3698 (ange-ftp-delete-file-entry filename))
3699 (ange-ftp-copy-file-internal filename newname t nil)
3700 (delete-file filename))))
3702 (defun ange-ftp-rename-local-to-remote (filename newname)
3703 "Rename local FILENAME to remote file NEWNAME."
3704 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3705 (nabbr (ange-ftp-abbreviate-filename newname filename))
3706 (msg (format "Renaming %s to %s" fabbr nabbr)))
3707 (ange-ftp-copy-file-internal filename newname t nil msg)
3708 (let (ange-ftp-process-verbose)
3709 (delete-file filename))))
3711 (defun ange-ftp-rename-remote-to-local (filename newname)
3712 "Rename remote file FILENAME to local file NEWNAME."
3713 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3714 (nabbr (ange-ftp-abbreviate-filename newname filename))
3715 (msg (format "Renaming %s to %s" fabbr nabbr)))
3716 (ange-ftp-copy-file-internal filename newname t nil msg)
3717 (let (ange-ftp-process-verbose)
3718 (delete-file filename))))
3720 (defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists)
3721 (interactive "fRename file: \nFRename %s to file: \np")
3722 (setq filename (expand-file-name filename))
3723 (setq newname (expand-file-name newname))
3724 (let* ((f-parsed (ange-ftp-ftp-name filename))
3725 (t-parsed (ange-ftp-ftp-name newname)))
3726 (if (and (or f-parsed t-parsed)
3727 (or (not ok-if-already-exists)
3728 (numberp ok-if-already-exists)))
3729 (ange-ftp-barf-or-query-if-file-exists
3732 (numberp ok-if-already-exists)))
3735 (ange-ftp-rename-remote-to-remote filename newname f-parsed
3737 (ange-ftp-rename-remote-to-local filename newname))
3739 (ange-ftp-rename-local-to-remote filename newname)
3740 (ange-ftp-real-rename-file filename newname ok-if-already-exists)))))
3742 ;;;; ------------------------------------------------------------
3743 ;;;; File name completion support.
3744 ;;;; ------------------------------------------------------------
3746 ;; If the file entry SYM is a symlink, returns whether its file exists.
3747 ;; Note that `ange-ftp-this-dir' is used as a free variable.
3748 (defun ange-ftp-file-entry-active-p (sym)
3749 (let ((val (get sym 'val)))
3750 (or (not (stringp val))
3751 (file-exists-p (ange-ftp-expand-symlink val ange-ftp-this-dir)))))
3753 ;; If the file entry is not a directory (nor a symlink pointing to a directory)
3754 ;; returns whether the file (or file pointed to by the symlink) is ignored
3755 ;; by completion-ignored-extensions.
3756 ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern'
3757 ;; are used as free variables.
3758 (defun ange-ftp-file-entry-not-ignored-p (sym)
3759 (let ((val (get sym 'val))
3760 (symname (symbol-name sym)))
3762 (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir)))
3763 (or (file-directory-p file)
3764 (and (file-exists-p file)
3765 (not (string-match ange-ftp-completion-ignored-pattern
3767 (or val ; is a directory name
3768 (not (string-match ange-ftp-completion-ignored-pattern symname))))))
3770 (defun ange-ftp-file-name-all-completions (file dir)
3771 (let ((ange-ftp-this-dir (expand-file-name dir)))
3772 (if (ange-ftp-ftp-name ange-ftp-this-dir)
3774 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3775 (setq ange-ftp-this-dir
3776 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir))
3777 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3779 (all-completions file tbl
3780 (function ange-ftp-file-entry-active-p))))
3782 ;; see whether each matching file is a directory or not...
3786 (let ((ent (ange-ftp-get-hash-entry file tbl)))
3788 (or (not (stringp ent))
3790 (ange-ftp-expand-symlink ent
3791 ange-ftp-this-dir))))
3796 (if (or (and (eq system-type 'windows-nt)
3797 (string-match "^[a-zA-Z]:[/\\]$" ange-ftp-this-dir))
3798 (string-equal "/" ange-ftp-this-dir))
3799 (nconc (all-completions file (ange-ftp-generate-root-prefixes))
3800 (ange-ftp-real-file-name-all-completions file
3802 (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir)))))
3804 (defun ange-ftp-file-name-completion (file dir)
3805 (let ((ange-ftp-this-dir (expand-file-name dir)))
3806 (if (ange-ftp-ftp-name ange-ftp-this-dir)
3808 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3811 (setq ange-ftp-this-dir
3812 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real?
3813 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3814 (ange-ftp-completion-ignored-pattern
3815 (mapconcat (function
3816 (lambda (s) (if (stringp s)
3817 (concat (regexp-quote s) "$")
3818 "/"))) ; / never in filename
3819 completion-ignored-extensions
3822 (or (ange-ftp-file-name-completion-1
3823 file tbl ange-ftp-this-dir
3824 (function ange-ftp-file-entry-not-ignored-p))
3825 (ange-ftp-file-name-completion-1
3826 file tbl ange-ftp-this-dir
3827 (function ange-ftp-file-entry-active-p)))))))
3829 (if (or (and (eq system-type 'windows-nt)
3830 (string-match "^[a-zA-Z]:[/\\]$" ange-ftp-this-dir))
3831 (string-equal "/" ange-ftp-this-dir))
3834 (nconc (ange-ftp-generate-root-prefixes)
3836 (ange-ftp-real-file-name-all-completions
3837 file ange-ftp-this-dir))))
3838 (ange-ftp-real-file-name-completion file ange-ftp-this-dir)))))
3841 (defun ange-ftp-file-name-completion-1 (file tbl dir predicate)
3842 (let ((bestmatch (try-completion file tbl predicate)))
3844 (if (eq bestmatch t)
3845 (if (file-directory-p (expand-file-name file dir))
3848 (if (and (eq (try-completion bestmatch tbl predicate) t)
3850 (expand-file-name bestmatch dir)))
3851 (concat bestmatch "/")
3854 ;; Put these lines uncommmented in your .emacs if you want C-r to refresh
3855 ;; ange-ftp's cache whilst doing filename completion.
3857 ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir)
3858 ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir)
3860 ;; The autoload cookie is to make sure the doc is always available.
3861 ;;;###autoload (defalias 'ange-ftp-re-read-dir 'ange-ftp-reread-dir)
3863 (defun ange-ftp-reread-dir (&optional dir)
3864 "Reread remote directory DIR to update the directory cache.
3865 The implementation of remote ftp file names caches directory contents
3866 for speed. Therefore, when new remote files are created, Emacs
3867 may not know they exist. You can use this command to reread a specific
3868 directory, so that Emacs will know its current contents."
3871 (setq dir (expand-file-name dir))
3872 (setq dir (file-name-directory (expand-file-name (buffer-string)))))
3873 (if (ange-ftp-ftp-name dir)
3875 (setq ange-ftp-ls-cache-file nil)
3876 (ange-ftp-del-hash-entry dir ange-ftp-files-hashtable)
3877 (ange-ftp-get-files dir t))))
3879 (defun ange-ftp-make-directory (dir &optional parents)
3880 (interactive (list (expand-file-name (read-file-name "Make directory: "))))
3882 (let ((parent (file-name-directory (directory-file-name dir))))
3883 (or (file-exists-p parent)
3884 (ange-ftp-make-directory parent parents))))
3885 (if (file-exists-p dir)
3886 (error "Cannot make directory %s: file already exists" dir)
3887 (let ((parsed (ange-ftp-ftp-name dir)))
3889 (let* ((host (nth 0 parsed))
3890 (user (nth 1 parsed))
3891 ;; Some ftp's on unix machines (at least on Suns)
3892 ;; insist that mkdir take a filename, and not a
3893 ;; directory-name name as an arg. Argh!! This is a bug.
3894 ;; Non-unix machines will probably always insist
3895 ;; that mkdir takes a directory-name as an arg
3896 ;; (as the ftp man page says it should).
3897 (name (ange-ftp-quote-string
3898 (if (eq (ange-ftp-host-type host) 'unix)
3899 (ange-ftp-real-directory-file-name (nth 2 parsed))
3900 (ange-ftp-real-file-name-as-directory
3902 (abbr (ange-ftp-abbreviate-filename dir))
3903 (result (ange-ftp-send-cmd host user
3905 (format "Making directory %s"
3908 (ange-ftp-error host user
3909 (format "Could not make directory %s: %s"
3912 (ange-ftp-add-file-entry dir t))
3913 (ange-ftp-real-make-directory dir)))))
3915 (defun ange-ftp-delete-directory (dir)
3916 (if (file-directory-p dir)
3917 (let ((parsed (ange-ftp-ftp-name dir)))
3919 (let* ((host (nth 0 parsed))
3920 (user (nth 1 parsed))
3921 ;; Some ftp's on unix machines (at least on Suns)
3922 ;; insist that rmdir take a filename, and not a
3923 ;; directory-name name as an arg. Argh!! This is a bug.
3924 ;; Non-unix machines will probably always insist
3925 ;; that rmdir takes a directory-name as an arg
3926 ;; (as the ftp man page says it should).
3927 (name (ange-ftp-quote-string
3928 (if (eq (ange-ftp-host-type host) 'unix)
3929 (ange-ftp-real-directory-file-name
3931 (ange-ftp-real-file-name-as-directory
3933 (abbr (ange-ftp-abbreviate-filename dir))
3934 (result (ange-ftp-send-cmd host user
3936 (format "Removing directory %s"
3939 (ange-ftp-error host user
3940 (format "Could not remove directory %s: %s"
3943 (ange-ftp-delete-file-entry dir t))
3944 (ange-ftp-real-delete-directory dir)))
3945 (error "Not a directory: %s" dir)))
3947 ;; Make a local copy of FILE and return its name.
3949 (defun ange-ftp-file-local-copy (file)
3950 (let* ((fn1 (expand-file-name file))
3951 (pa1 (ange-ftp-ftp-name fn1)))
3953 (let ((tmp1 (ange-ftp-make-tmp-name (car pa1))))
3954 (ange-ftp-copy-file-internal fn1 tmp1 t nil
3955 (format "Getting %s" fn1))
3958 (defvar ange-ftp-waiting-flag nil)
3960 (defun ange-ftp-load (file &optional noerror nomessage nosuffix)
3961 (if (ange-ftp-ftp-name file)
3962 (let ((tryfiles (if nosuffix
3964 (list (concat file ".elc") (concat file ".el") file)))
3966 (while (and tryfiles (not copy))
3968 (let ((ange-ftp-waiting-flag t))
3969 (condition-case error
3970 (setq copy (ange-ftp-file-local-copy (car tryfiles)))
3972 (setq tryfiles (cdr tryfiles)))
3975 (funcall 'load copy noerror nomessage nosuffix)
3978 (signal 'file-error (list "Cannot open load file" file)))
3980 (ange-ftp-real-load file noerror nomessage nosuffix)))
3982 ;; Calculate default-unhandled-directory for a given ange-ftp buffer.
3983 (defun ange-ftp-unhandled-file-name-directory (filename)
3984 (file-name-directory ange-ftp-tmp-name-template))
3987 ;; Need the following functions for making filenames of compressed
3988 ;; files, because some OS's (unlike UNIX) do not allow a filename to
3989 ;; have two extensions.
3991 (defvar ange-ftp-make-compressed-filename-alist nil
3992 "Alist of host-type-specific functions to process file names for compression.
3993 Each element has the form (TYPE . FUNC).
3994 FUNC should take one argument, a file name, and return a list
3995 of the form (COMPRESSING NEWNAME).
3996 COMPRESSING should be t if the specified file should be compressed,
3997 and nil if it should be uncompressed (that is, if it is a compressed file).
3998 NEWNAME should be the name to give the new compressed or uncompressed file.")
4000 (defun ange-ftp-dired-compress-file (name)
4001 (let ((parsed (ange-ftp-ftp-name name))
4004 (setq conversion-func
4005 (cdr (assq (ange-ftp-host-type (car parsed))
4006 ange-ftp-make-compressed-filename-alist))))
4008 (save-match-data (funcall conversion-func name)))
4009 (compressing (car decision))
4010 (newfile (nth 1 decision)))
4012 (ange-ftp-compress name newfile)
4013 (ange-ftp-uncompress name newfile)))
4014 (let (file-name-handler-alist)
4015 (dired-compress-file name)))))
4017 ;; Copy FILE to this machine, compress it, and copy out to NFILE.
4018 (defun ange-ftp-compress (file nfile)
4019 (let* ((parsed (ange-ftp-ftp-name file))
4020 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
4021 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
4022 (abbr (ange-ftp-abbreviate-filename file))
4023 (nabbr (ange-ftp-abbreviate-filename nfile))
4024 (msg1 (format "Getting %s" abbr))
4025 (msg2 (format "Putting %s" nabbr)))
4028 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
4029 (and ange-ftp-process-verbose
4030 (ange-ftp-message "Compressing %s..." abbr))
4031 (call-process-region (point)
4038 (format "compress -f -c < %s > %s" tmp1 tmp2))
4039 (and ange-ftp-process-verbose
4040 (ange-ftp-message "Compressing %s...done" abbr))
4041 (if (zerop (buffer-size))
4043 (let (ange-ftp-process-verbose)
4045 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
4046 (ange-ftp-del-tmp-name tmp1)
4047 (ange-ftp-del-tmp-name tmp2))))
4049 ;; Copy FILE to this machine, uncompress it, and copy out to NFILE.
4050 (defun ange-ftp-uncompress (file nfile)
4051 (let* ((parsed (ange-ftp-ftp-name file))
4052 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
4053 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
4054 (abbr (ange-ftp-abbreviate-filename file))
4055 (nabbr (ange-ftp-abbreviate-filename nfile))
4056 (msg1 (format "Getting %s" abbr))
4057 (msg2 (format "Putting %s" nabbr))
4058 ;; ;; Cheap hack because of problems with binary file transfers from
4060 ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed)))))
4064 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
4065 (and ange-ftp-process-verbose
4066 (ange-ftp-message "Uncompressing %s..." abbr))
4067 (call-process-region (point)
4074 (format "uncompress -c < %s > %s" tmp1 tmp2))
4075 (and ange-ftp-process-verbose
4076 (ange-ftp-message "Uncompressing %s...done" abbr))
4077 (if (zerop (buffer-size))
4079 (let (ange-ftp-process-verbose)
4081 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
4082 (ange-ftp-del-tmp-name tmp1)
4083 (ange-ftp-del-tmp-name tmp2))))
4085 (defun ange-ftp-find-backup-file-name (fn)
4086 ;; Either return the ordinary backup name, etc.,
4087 ;; or return nil meaning don't make a backup.
4088 (if ange-ftp-make-backup-files
4089 (ange-ftp-real-find-backup-file-name fn)))
4091 ;;; Define the handler for special file names
4092 ;;; that causes ange-ftp to be invoked.
4095 (defun ange-ftp-hook-function (operation &rest args)
4096 (let ((fn (get operation 'ange-ftp)))
4097 (if fn (apply fn args)
4098 (ange-ftp-run-real-handler operation args))))
4101 ;;; This regexp takes care of real ange-ftp file names (with a slash
4103 ;;; Don't allow the host name to end in a period--some systems use /.:
4105 (or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist)
4106 (setq file-name-handler-alist
4107 (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function)
4108 file-name-handler-alist)))
4110 ;;; This regexp recognizes absolute filenames with only one component,
4111 ;;; for the sake of hostname completion.
4113 (or (assoc "^/[^/:]*\\'" file-name-handler-alist)
4114 (setq file-name-handler-alist
4115 (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function)
4116 file-name-handler-alist)))
4118 ;;; This regexp recognizes absolute filenames with only one component
4119 ;;; on Windows, for the sake of hostname completion.
4120 ;;; NB. Do not mark this as autoload, because it is very common to
4121 ;;; do completions in the root directory of drives on Windows.
4122 (and (memq system-type '(ms-dos windows-nt))
4123 (or (assoc "^[a-zA-Z]:/[^/:]*\\'" file-name-handler-alist)
4124 (setq file-name-handler-alist
4125 (cons '("^[a-zA-Z]:/[^/:]*\\'" .
4126 ange-ftp-completion-hook-function)
4127 file-name-handler-alist))))
4129 ;;; The above two forms are sufficient to cause this file to be loaded
4130 ;;; if the user ever uses a file name with a colon in it.
4132 ;;; This sets the mode
4133 (or (memq 'ange-ftp-set-buffer-mode find-file-hooks)
4134 (setq find-file-hooks
4135 (cons 'ange-ftp-set-buffer-mode find-file-hooks)))
4137 ;;; Now say where to find the handlers for particular operations.
4139 (put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory)
4140 (put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory)
4141 (put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory)
4142 (put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name)
4143 (put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name)
4144 (put 'make-directory 'ange-ftp 'ange-ftp-make-directory)
4145 (put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory)
4146 (put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents)
4147 (put 'directory-files 'ange-ftp 'ange-ftp-directory-files)
4148 (put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p)
4149 (put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p)
4150 (put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p)
4151 (put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p)
4152 (put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p)
4153 (put 'delete-file 'ange-ftp 'ange-ftp-delete-file)
4154 (put 'read-file-name-internal 'ange-ftp 'ange-ftp-read-file-name-internal)
4155 (put 'verify-visited-file-modtime 'ange-ftp
4156 'ange-ftp-verify-visited-file-modtime)
4157 (put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p)
4158 (put 'write-region 'ange-ftp 'ange-ftp-write-region)
4159 (put 'backup-buffer 'ange-ftp 'ange-ftp-backup-buffer)
4160 (put 'copy-file 'ange-ftp 'ange-ftp-copy-file)
4161 (put 'rename-file 'ange-ftp 'ange-ftp-rename-file)
4162 (put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes)
4163 (put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions)
4164 (put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion)
4165 (put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory)
4166 (put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy)
4167 (put 'unhandled-file-name-directory 'ange-ftp
4168 'ange-ftp-unhandled-file-name-directory)
4169 (put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions)
4170 (put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache)
4171 (put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file)
4172 (put 'load 'ange-ftp 'ange-ftp-load)
4173 (put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name)
4175 ;; Turn off truename processing to save time.
4176 ;; Treat each name as its own truename.
4177 (put 'file-truename 'ange-ftp 'identity)
4179 ;; Turn off RCS/SCCS processing to save time.
4180 ;; This returns nil for any file name as argument.
4181 (put 'vc-registered 'ange-ftp 'null)
4183 (put 'dired-call-process 'ange-ftp 'ange-ftp-dired-call-process)
4184 (put 'shell-command 'ange-ftp 'ange-ftp-shell-command)
4186 ;;; Define ways of getting at unmodified Emacs primitives,
4187 ;;; turning off our handler.
4189 (defun ange-ftp-run-real-handler (operation args)
4190 (let ((inhibit-file-name-handlers
4191 (cons 'ange-ftp-hook-function
4192 (cons 'ange-ftp-completion-hook-function
4193 (and (eq inhibit-file-name-operation operation)
4194 inhibit-file-name-handlers))))
4195 (inhibit-file-name-operation operation))
4196 (apply operation args)))
4198 (defun ange-ftp-real-file-name-directory (&rest args)
4199 (ange-ftp-run-real-handler 'file-name-directory args))
4200 (defun ange-ftp-real-file-name-nondirectory (&rest args)
4201 (ange-ftp-run-real-handler 'file-name-nondirectory args))
4202 (defun ange-ftp-real-file-name-as-directory (&rest args)
4203 (ange-ftp-run-real-handler 'file-name-as-directory args))
4204 (defun ange-ftp-real-directory-file-name (&rest args)
4205 (ange-ftp-run-real-handler 'directory-file-name args))
4206 (defun ange-ftp-real-expand-file-name (&rest args)
4207 (ange-ftp-run-real-handler 'expand-file-name args))
4208 (defun ange-ftp-real-make-directory (&rest args)
4209 (ange-ftp-run-real-handler 'make-directory args))
4210 (defun ange-ftp-real-delete-directory (&rest args)
4211 (ange-ftp-run-real-handler 'delete-directory args))
4212 (defun ange-ftp-real-insert-file-contents (&rest args)
4213 (ange-ftp-run-real-handler 'insert-file-contents args))
4214 (defun ange-ftp-real-directory-files (&rest args)
4215 (ange-ftp-run-real-handler 'directory-files args))
4216 (defun ange-ftp-real-file-directory-p (&rest args)
4217 (ange-ftp-run-real-handler 'file-directory-p args))
4218 (defun ange-ftp-real-file-writable-p (&rest args)
4219 (ange-ftp-run-real-handler 'file-writable-p args))
4220 (defun ange-ftp-real-file-readable-p (&rest args)
4221 (ange-ftp-run-real-handler 'file-readable-p args))
4222 (defun ange-ftp-real-file-executable-p (&rest args)
4223 (ange-ftp-run-real-handler 'file-executable-p args))
4224 (defun ange-ftp-real-file-symlink-p (&rest args)
4225 (ange-ftp-run-real-handler 'file-symlink-p args))
4226 (defun ange-ftp-real-delete-file (&rest args)
4227 (ange-ftp-run-real-handler 'delete-file args))
4228 (defun ange-ftp-real-read-file-name-internal (&rest args)
4229 (ange-ftp-run-real-handler 'read-file-name-internal args))
4230 (defun ange-ftp-real-verify-visited-file-modtime (&rest args)
4231 (ange-ftp-run-real-handler 'verify-visited-file-modtime args))
4232 (defun ange-ftp-real-file-exists-p (&rest args)
4233 (ange-ftp-run-real-handler 'file-exists-p args))
4234 (defun ange-ftp-real-write-region (&rest args)
4235 (ange-ftp-run-real-handler 'write-region args))
4236 (defun ange-ftp-real-backup-buffer (&rest args)
4237 (ange-ftp-run-real-handler 'backup-buffer args))
4238 (defun ange-ftp-real-copy-file (&rest args)
4239 (ange-ftp-run-real-handler 'copy-file args))
4240 (defun ange-ftp-real-rename-file (&rest args)
4241 (ange-ftp-run-real-handler 'rename-file args))
4242 (defun ange-ftp-real-file-attributes (&rest args)
4243 (ange-ftp-run-real-handler 'file-attributes args))
4244 (defun ange-ftp-real-file-name-all-completions (&rest args)
4245 (ange-ftp-run-real-handler 'file-name-all-completions args))
4246 (defun ange-ftp-real-file-name-completion (&rest args)
4247 (ange-ftp-run-real-handler 'file-name-completion args))
4248 (defun ange-ftp-real-insert-directory (&rest args)
4249 (ange-ftp-run-real-handler 'insert-directory args))
4250 (defun ange-ftp-real-file-name-sans-versions (&rest args)
4251 (ange-ftp-run-real-handler 'file-name-sans-versions args))
4252 (defun ange-ftp-real-shell-command (&rest args)
4253 (ange-ftp-run-real-handler 'shell-command args))
4254 (defun ange-ftp-real-load (&rest args)
4255 (ange-ftp-run-real-handler 'load args))
4256 (defun ange-ftp-real-find-backup-file-name (&rest args)
4257 (ange-ftp-run-real-handler 'find-backup-file-name args))
4259 ;; Here we support using dired on remote hosts.
4260 ;; I have turned off the support for using dired on foreign directory formats.
4261 ;; That involves too many unclean hooks.
4262 ;; It would be cleaner to support such operations by
4263 ;; converting the foreign directory format to something dired can understand;
4264 ;; something close to ls -l output.
4265 ;; The logical place to do this is in the functions ange-ftp-parse-...-listing.
4267 ;; Some of the old dired hooks would still be needed even if this is done.
4268 ;; I have preserved (and modernized) those hooks.
4269 ;; So the format conversion should be all that is needed.
4271 (defun ange-ftp-insert-directory (file switches &optional wildcard full)
4272 (let ((short (ange-ftp-abbreviate-filename file))
4273 (parsed (ange-ftp-ftp-name (expand-file-name file))))
4277 (let ((default-directory (file-name-directory file)))
4278 (ange-ftp-ls (file-name-nondirectory file) switches nil nil t))
4279 (ange-ftp-ls file switches full)))
4280 (ange-ftp-real-insert-directory file switches wildcard full))))
4282 (defun ange-ftp-dired-uncache (dir)
4283 (if (ange-ftp-ftp-name (expand-file-name dir))
4284 (setq ange-ftp-ls-cache-file nil)))
4286 (defvar ange-ftp-sans-version-alist nil
4287 "Alist of mapping host type into function to remove file version numbers.")
4289 (defun ange-ftp-file-name-sans-versions (file keep-backup-version)
4290 (let* ((short (ange-ftp-abbreviate-filename file))
4291 (parsed (ange-ftp-ftp-name short))
4294 (setq host-type (ange-ftp-host-type (car parsed))
4295 func (cdr (assq (ange-ftp-host-type (car parsed))
4296 ange-ftp-sans-version-alist))))
4297 (if func (funcall func file keep-backup-version)
4298 (ange-ftp-real-file-name-sans-versions file keep-backup-version))))
4300 ;; This is the handler for shell-command.
4301 (defun ange-ftp-shell-command (command &optional output-buffer)
4302 (let* ((parsed (ange-ftp-ftp-name default-directory))
4303 (host (nth 0 parsed))
4304 (user (nth 1 parsed))
4305 (name (nth 2 parsed)))
4307 (ange-ftp-real-shell-command command output-buffer)
4308 (if (> (length name) 0) ; else it's $HOME
4309 (setq command (concat "cd " name "; " command)))
4311 (format "%s %s \"%s\"" ; remsh -l USER does not work well
4312 ; on a hp-ux machine I tried
4313 remote-shell-program host command))
4314 (ange-ftp-message "Remote command '%s' ..." command)
4315 ;; Cannot call ange-ftp-real-dired-run-shell-command here as it
4316 ;; would prepend "cd default-directory" --- which bombs because
4317 ;; default-directory is in ange-ftp syntax for remote file names.
4318 (ange-ftp-real-shell-command command output-buffer))))
4320 ;;; This is the handler for call-process.
4321 (defun ange-ftp-dired-call-process (program discard &rest arguments)
4322 ;; PROGRAM is always one of those below in the cond in dired.el.
4323 ;; The ARGUMENTS are (nearly) always files.
4324 (if (ange-ftp-ftp-name default-directory)
4325 ;; Can't use ange-ftp-dired-host-type here because the current
4326 ;; buffer is *dired-check-process output*
4327 (condition-case oops
4328 (cond ((equal dired-chmod-program program)
4329 (ange-ftp-call-chmod arguments))
4330 ;; ((equal "chgrp" program))
4331 ;; ((equal dired-chown-program program))
4332 (t (error "Unknown remote command: %s" program)))
4333 (ftp-error (insert (format "%s: %s, %s\n"
4337 ;; Caller expects nonzero value to mean failure.
4339 (error (insert (format "%s\n" (nth 1 oops)))
4341 (apply 'call-process program nil (not discard) nil arguments)))
4343 (defvar ange-ftp-remote-shell "rsh"
4344 "Remote shell to use for chmod, if FTP server rejects the `chmod' command.")
4346 ;; Handle an attempt to run chmod on a remote file
4347 ;; by using the ftp chmod command.
4348 (defun ange-ftp-call-chmod (args)
4349 (if (< (length args) 2)
4350 (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args))
4351 (let ((mode (car args))
4353 (if (equal "--" (car rest))
4354 (setq rest (cdr rest)))
4358 (setq file (expand-file-name file))
4359 (let ((parsed (ange-ftp-ftp-name file)))
4361 (let* ((host (nth 0 parsed))
4362 (user (nth 1 parsed))
4363 (name (ange-ftp-quote-string (nth 2 parsed)))
4364 (abbr (ange-ftp-abbreviate-filename file))
4365 (result (ange-ftp-send-cmd host user
4366 (list 'chmod mode name)
4367 (format "doing chmod %s"
4371 ange-ftp-remote-shell
4372 nil t nil host dired-chmod-program mode name)))))))
4374 (setq ange-ftp-ls-cache-file nil) ;Stop confusing Dired.
4377 ;;; This is turned off because it has nothing properly to do
4378 ;;; with dired. It could be reasonable to adapt this to
4379 ;;; replace ange-ftp-copy-file.
4381 ;;;;; ------------------------------------------------------------
4382 ;;;;; Noddy support for async copy-file within dired.
4383 ;;;;; ------------------------------------------------------------
4385 ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait)
4386 ;; "Documented as original."
4387 ;; (dired-handle-overwrite to)
4388 ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil
4391 ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg
4392 ;; &optional marker-char op1
4394 ;; "Documented as original."
4395 ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly
4396 ;; ;; called it rather than somebody else.
4397 ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is
4398 ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation
4399 ;; arg marker-char op1 how-to)))
4401 ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor
4402 ;; &optional marker-char)
4403 ;; "Documented as original."
4404 ;; (if (and (boundp 'ange-ftp-dired-do-create-files)
4405 ;; ;; called from ange-ftp-dired-do-create-files?
4406 ;; ange-ftp-dired-do-create-files
4407 ;; ;; any files worth copying?
4409 ;; ;; we only support async copy-file at the mo.
4410 ;; (eq file-creator 'dired-copy-file)
4411 ;; ;; it is only worth calling the alternative function for remote files
4412 ;; ;; as we tie ourself in recursive knots otherwise.
4413 ;; (or (ange-ftp-ftp-name (car fn-list))
4414 ;; ;; we can only call the name constructor for dired-do-create-files
4415 ;; ;; since the one for regexps starts prompting here, there and
4417 ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list)))))
4418 ;; ;; use the process-filter driven routine rather than the iterative one.
4419 ;; (ange-ftp-dcf-1 file-creator
4423 ;; (and (boundp 'target) target) ;dynamically bound
4426 ;; nil ;overwrite-query
4427 ;; nil ;overwrite-backup-query
4431 ;; (length fn-list) ;total
4433 ;; ;; normal case... use the interactive routine... much cheaper.
4434 ;; (ange-ftp-real-dired-create-files file-creator operation fn-list
4435 ;; name-constructor marker-char)))
4437 ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor
4438 ;; target marker-char buffer overwrite-query
4439 ;; overwrite-backup-query failures skipped
4440 ;; success-count total)
4441 ;; (let ((old-buf (current-buffer)))
4444 ;; (set-buffer buffer)
4445 ;; (if (null fn-list)
4446 ;; (ange-ftp-dcf-3 failures operation total skipped
4447 ;; success-count buffer)
4449 ;; (let* ((from (car fn-list))
4450 ;; (to (funcall name-constructor from)))
4451 ;; (if (equal to from)
4454 ;; (dired-log "Cannot %s to same file: %s\n"
4455 ;; (downcase operation) from)))
4457 ;; (ange-ftp-dcf-1 file-creator
4465 ;; overwrite-backup-query
4467 ;; (cons (dired-make-relative from) skipped)
4470 ;; (let* ((overwrite (file-exists-p to))
4471 ;; (overwrite-confirmed ; for dired-handle-overwrite
4473 ;; (let ((help-form '(format "\
4474 ;;Type SPC or `y' to overwrite file `%s',
4475 ;;DEL or `n' to skip to next,
4476 ;;ESC or `q' to not overwrite any of the remaining files,
4477 ;;`!' to overwrite all remaining files with no more questions." to)))
4478 ;; (dired-query 'overwrite-query
4479 ;; "Overwrite `%s'?" to))))
4480 ;; ;; must determine if FROM is marked before file-creator
4481 ;; ;; gets a chance to delete it (in case of a move).
4482 ;; (actual-marker-char
4483 ;; (cond ((integerp marker-char) marker-char)
4484 ;; (marker-char (dired-file-marker from)) ; slow
4486 ;; (condition-case err
4487 ;; (funcall file-creator from to overwrite-confirmed
4488 ;; (list (function ange-ftp-dcf-2)
4490 ;; file-creator operation fn-list
4493 ;; marker-char actual-marker-char
4496 ;; overwrite-confirmed
4498 ;; overwrite-backup-query
4499 ;; failures skipped success-count
4502 ;; (file-error ; FILE-CREATOR aborted
4503 ;; (ange-ftp-dcf-2 nil ;result
4506 ;; file-creator operation fn-list
4509 ;; marker-char actual-marker-char
4512 ;; overwrite-confirmed
4514 ;; overwrite-backup-query
4515 ;; failures skipped success-count
4517 ;; (set-buffer old-buf))))
4519 ;;(defun ange-ftp-dcf-2 (result line err
4520 ;; file-creator operation fn-list
4523 ;; marker-char actual-marker-char
4526 ;; overwrite-confirmed
4528 ;; overwrite-backup-query
4529 ;; failures skipped success-count
4531 ;; (let ((old-buf (current-buffer)))
4534 ;; (set-buffer buffer)
4535 ;; (if (or err (not result))
4537 ;; (setq failures (cons (dired-make-relative from) failures))
4538 ;; (dired-log "%s `%s' to `%s' failed:\n%s\n"
4539 ;; operation from to (or err line)))
4541 ;; ;; If we get here, file-creator hasn't been aborted
4542 ;; ;; and the old entry (if any) has to be deleted
4543 ;; ;; before adding the new entry.
4544 ;; (dired-remove-file to))
4545 ;; (setq success-count (1+ success-count))
4546 ;; (message "%s: %d of %d" operation success-count total)
4547 ;; (dired-add-file to actual-marker-char))
4549 ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list)
4555 ;; overwrite-backup-query
4556 ;; failures skipped success-count
4558 ;; (set-buffer old-buf))))
4560 ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count
4562 ;; (let ((old-buf (current-buffer)))
4565 ;; (set-buffer buffer)
4568 ;; (dired-log-summary
4569 ;; (message "%s failed for %d of %d file%s %s"
4570 ;; operation (length failures) total
4571 ;; (dired-plural-s total) failures)))
4573 ;; (dired-log-summary
4574 ;; (message "%s: %d of %d file%s skipped %s"
4575 ;; operation (length skipped) total
4576 ;; (dired-plural-s total) skipped)))
4578 ;; (message "%s: %s file%s."
4579 ;; operation success-count (dired-plural-s success-count))))
4580 ;; (dired-move-to-filename))
4581 ;; (set-buffer old-buf))))
4583 ;;;; -----------------------------------------------
4584 ;;;; Unix Descriptive Listing (dl) Support
4585 ;;;; -----------------------------------------------
4587 ;; This is turned off because nothing uses it currently
4588 ;; and because I don't understand what it's supposed to be for. --rms.
4590 ;;(defconst ange-ftp-dired-dl-re-dir
4591 ;; "^. [^ /]+/[ \n]"
4592 ;; "Regular expression to use to search for dl directories.")
4594 ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist)
4595 ;; (setq ange-ftp-dired-re-dir-alist
4596 ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir)
4597 ;; ange-ftp-dired-re-dir-alist)))
4599 ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol)
4600 ;; "In dired, move to the first character of the filename on this line."
4601 ;; ;; This is the Unix dl version.
4602 ;; (or eol (setq eol (progn (end-of-line) (point))))
4603 ;; (let (case-fold-search)
4604 ;; (beginning-of-line)
4605 ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ")
4606 ;; (goto-char (+ (point) 2))
4608 ;; (error "No file on this line")
4611 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist)
4612 ;; (setq ange-ftp-dired-move-to-filename-alist
4613 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename)
4614 ;; ange-ftp-dired-move-to-filename-alist)))
4616 ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol)
4617 ;; ;; Assumes point is at beginning of filename.
4618 ;; ;; So, it should be called only after (dired-move-to-filename t).
4619 ;; ;; On failure, signals an error or returns nil.
4620 ;; ;; This is the Unix dl version.
4621 ;; (let ((opoint (point))
4622 ;; case-fold-search hidden)
4623 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4624 ;; (setq hidden (and selective-display
4626 ;; (search-forward "\r" eol t))))
4631 ;; (substitute-command-keys
4632 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
4633 ;; (skip-chars-forward "^ /" eol)
4634 ;; (if (eq opoint (point))
4637 ;; (error "No file on this line"))
4640 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist)
4641 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4642 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename)
4643 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4645 ;;;; ------------------------------------------------------------
4646 ;;;; VOS support (VOS support is probably broken,
4647 ;;;; but I don't know anything about VOS.)
4648 ;;;; ------------------------------------------------------------
4650 ;(defun ange-ftp-fix-name-for-vos (name &optional reverse)
4651 ; (setq name (copy-sequence name))
4652 ; (let ((from (if reverse ?\> ?\/))
4653 ; (to (if reverse ?\/ ?\>))
4654 ; (i (1- (length name))))
4656 ; (if (= (aref name i) from)
4661 ;(or (assq 'vos ange-ftp-fix-name-func-alist)
4662 ; (setq ange-ftp-fix-name-func-alist
4663 ; (cons '(vos . ange-ftp-fix-name-for-vos)
4664 ; ange-ftp-fix-name-func-alist)))
4666 ;(or (memq 'vos ange-ftp-dumb-host-types)
4667 ; (setq ange-ftp-dumb-host-types
4668 ; (cons 'vos ange-ftp-dumb-host-types)))
4670 ;(defun ange-ftp-fix-dir-name-for-vos (dir-name)
4671 ; (ange-ftp-fix-name-for-vos
4673 ; (if (eq ?/ (aref dir-name (1- (length dir-name))))
4677 ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist)
4678 ; (setq ange-ftp-fix-dir-name-func-alist
4679 ; (cons '(vos . ange-ftp-fix-dir-name-for-vos)
4680 ; ange-ftp-fix-dir-name-func-alist)))
4682 ;(defvar ange-ftp-vos-host-regexp nil
4683 ; "If a host matches this regexp then it is assumed to be running VOS.")
4685 ;(defun ange-ftp-vos-host (host)
4686 ; (and ange-ftp-vos-host-regexp
4688 ; (string-match ange-ftp-vos-host-regexp host))))
4690 ;(defun ange-ftp-parse-vos-listing ()
4691 ; "Parse the current buffer which is assumed to be in VOS list -all
4692 ;format, and return a hashtable as the result."
4693 ; (let ((tbl (ange-ftp-make-hashtable))
4695 ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40)
4696 ; ("^Dirs: [0-9]+\n+" t 30)))
4697 ; type-regexp type-is-dir type-col file)
4698 ; (goto-char (point-min))
4701 ; (setq type-regexp (car (car type-list))
4702 ; type-is-dir (nth 1 (car type-list))
4703 ; type-col (nth 2 (car type-list))
4704 ; type-list (cdr type-list))
4705 ; (if (re-search-forward type-regexp nil t)
4706 ; (while (eq (char-after (point)) ? )
4707 ; (move-to-column type-col)
4708 ; (setq file (buffer-substring (point)
4712 ; (ange-ftp-put-hash-entry file type-is-dir tbl)
4713 ; (forward-line 1))))
4714 ; (ange-ftp-put-hash-entry "." 'vosdir tbl)
4715 ; (ange-ftp-put-hash-entry ".." 'vosdir tbl))
4718 ;(or (assq 'vos ange-ftp-parse-list-func-alist)
4719 ; (setq ange-ftp-parse-list-func-alist
4720 ; (cons '(vos . ange-ftp-parse-vos-listing)
4721 ; ange-ftp-parse-list-func-alist)))
4723 ;;;; ------------------------------------------------------------
4725 ;;;; ------------------------------------------------------------
4727 ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS
4729 (defun ange-ftp-fix-name-for-vms (name &optional reverse)
4732 (if (string-match "^\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)$" name)
4733 (let (drive dir file)
4734 (if (match-beginning 1)
4735 (setq drive (substring name
4738 (if (match-beginning 2)
4740 (substring name (match-beginning 2) (match-end 2))))
4741 (if (match-beginning 3)
4743 (substring name (match-beginning 3) (match-end 3))))
4745 (setq dir (apply (function concat)
4751 (substring dir 1 -1)))))
4753 (concat "/" drive "/"))
4756 (error "name %s didn't match" name))
4757 (let (drive dir file tmp)
4758 (if (string-match "^/[^:]+:/" name)
4759 (setq drive (substring name 1
4761 name (substring name (match-end 0))))
4762 (setq tmp (file-name-directory name))
4764 (setq dir (apply (function concat)
4770 (substring tmp 0 -1)))))
4771 (setq file (file-name-nondirectory name))
4773 (and dir (concat "[" (if drive nil ".") dir "]"))
4776 ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1")
4777 ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t)
4779 (or (assq 'vms ange-ftp-fix-name-func-alist)
4780 (setq ange-ftp-fix-name-func-alist
4781 (cons '(vms . ange-ftp-fix-name-for-vms)
4782 ange-ftp-fix-name-func-alist)))
4784 (or (memq 'vms ange-ftp-dumb-host-types)
4785 (setq ange-ftp-dumb-host-types
4786 (cons 'vms ange-ftp-dumb-host-types)))
4788 ;; It is important that this function barf for directories for which we know
4789 ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/".
4790 ;; This is because it saves an unnecessary FTP error, or possibly the listing
4791 ;; might succeed, but give erroneous info. This last case is particularly
4792 ;; likely for OS's (like MTS) for which we need to use a wildcard in order
4793 ;; to list a directory.
4795 ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing.
4796 (defun ange-ftp-fix-dir-name-for-vms (dir-name)
4797 ;; Should there be entries for .. -> [-] and . -> [] below. Don't
4798 ;; think so, because expand-filename should have already short-circuited
4800 (cond ((string-equal dir-name "/")
4801 (error "Cannot get listing for fictitious \"/\" directory."))
4802 ((string-match "^/[-A-Z0-9_$]+:/$" dir-name)
4803 (error "Cannot get listing for device."))
4804 ((ange-ftp-fix-name-for-vms dir-name))))
4806 (or (assq 'vms ange-ftp-fix-dir-name-func-alist)
4807 (setq ange-ftp-fix-dir-name-func-alist
4808 (cons '(vms . ange-ftp-fix-dir-name-for-vms)
4809 ange-ftp-fix-dir-name-func-alist)))
4811 (defvar ange-ftp-vms-host-regexp nil)
4813 ;; Return non-nil if HOST is running VMS.
4814 (defun ange-ftp-vms-host (host)
4815 (and ange-ftp-vms-host-regexp
4817 (string-match ange-ftp-vms-host-regexp host))))
4819 ;; Because some VMS ftp servers convert filenames to lower case
4820 ;; we allow a-z in the filename regexp. I'm not too happy about this.
4822 (defconst ange-ftp-vms-filename-regexp
4824 "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\."
4825 "[-_A-Za-z0-9$]*;+[0-9]*\\)")
4826 "Regular expression to match for a valid VMS file name in Dired buffer.
4827 Stupid freaking bug! Position of _ and $ shouldn't matter but they do.
4828 Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX
4829 Other orders of $ and _ seem to all work just fine.")
4831 ;; These parsing functions are as general as possible because the syntax
4832 ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that
4833 ;; the VMS filename syntax is so rigid. If they bomb on a listing in the
4834 ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing
4835 ;; from vms.weird.net, then too bad.
4837 ;; Extract the next filename from a VMS dired-like listing.
4838 (defun ange-ftp-parse-vms-filename ()
4839 (if (re-search-forward
4840 ange-ftp-vms-filename-regexp
4842 (buffer-substring (match-beginning 0) (match-end 0))))
4844 ;; Parse the current buffer which is assumed to be in MultiNet FTP dir
4845 ;; format, and return a hashtable as the result.
4846 (defun ange-ftp-parse-vms-listing ()
4847 (let ((tbl (ange-ftp-make-hashtable))
4849 (goto-char (point-min))
4851 (while (setq file (ange-ftp-parse-vms-filename))
4852 (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file)
4853 ;; deal with directories
4854 (ange-ftp-put-hash-entry
4855 (substring file 0 (match-beginning 0)) t tbl)
4856 (ange-ftp-put-hash-entry file nil tbl)
4857 (if (string-match ";[0-9]+$" file) ; deal with extension
4859 (ange-ftp-put-hash-entry
4860 (substring file 0 (match-beginning 0)) nil tbl)))
4862 ;; Would like to look for a "Total" line, or a "Directory" line to
4863 ;; make sure that the listing isn't complete garbage before putting
4864 ;; in "." and "..", but we can't even count on all VAX's giving us
4866 (ange-ftp-put-hash-entry "." t tbl)
4867 (ange-ftp-put-hash-entry ".." t tbl))
4870 (or (assq 'vms ange-ftp-parse-list-func-alist)
4871 (setq ange-ftp-parse-list-func-alist
4872 (cons '(vms . ange-ftp-parse-vms-listing)
4873 ange-ftp-parse-list-func-alist)))
4875 ;; This version only deletes file entries which have
4876 ;; explicit version numbers, because that is all VMS allows.
4878 ;; Can the following two functions be speeded up using file
4879 ;; completion functions?
4881 (defun ange-ftp-vms-delete-file-entry (name &optional dir-p)
4883 (ange-ftp-internal-delete-file-entry name t)
4885 (let ((file (ange-ftp-get-file-part name)))
4886 (if (string-match ";[0-9]+$" file)
4887 ;; In VMS you can't delete a file without an explicit
4888 ;; version number, or wild-card (e.g. FOO;*)
4889 ;; For now, we give up on wildcards.
4890 (let ((files (ange-ftp-get-hash-entry
4891 (file-name-directory name)
4892 ange-ftp-files-hashtable)))
4894 (let* ((root (substring file 0
4895 (match-beginning 0)))
4900 (ange-ftp-del-hash-entry file files)
4901 ;; Now we need to check if there are any
4902 ;; versions left. If not, then delete the
4906 (and (string-match regexp (get sym 'key))
4910 (ange-ftp-del-hash-entry root files))))))))))
4912 (or (assq 'vms ange-ftp-delete-file-entry-alist)
4913 (setq ange-ftp-delete-file-entry-alist
4914 (cons '(vms . ange-ftp-vms-delete-file-entry)
4915 ange-ftp-delete-file-entry-alist)))
4917 (defun ange-ftp-vms-add-file-entry (name &optional dir-p)
4919 (ange-ftp-internal-add-file-entry name t)
4920 (let ((files (ange-ftp-get-hash-entry
4921 (file-name-directory name)
4922 ange-ftp-files-hashtable)))
4924 (let ((file (ange-ftp-get-file-part name)))
4926 (if (string-match ";[0-9]+$" file)
4927 (ange-ftp-put-hash-entry
4928 (substring file 0 (match-beginning 0))
4930 ;; Need to figure out what version of the file
4932 (let ((regexp (concat "^"
4938 (let ((name (get sym 'key)))
4939 (and (string-match regexp name)
4945 (match-end 1))))))))
4947 (setq version (1+ version))
4948 (ange-ftp-put-hash-entry
4949 (concat file ";" (int-to-string version))
4951 (ange-ftp-put-hash-entry file nil files))))))
4953 (or (assq 'vms ange-ftp-add-file-entry-alist)
4954 (setq ange-ftp-add-file-entry-alist
4955 (cons '(vms . ange-ftp-vms-add-file-entry)
4956 ange-ftp-add-file-entry-alist)))
4959 (defun ange-ftp-add-vms-host (host)
4960 "Mark HOST as the name of a machine running VMS."
4962 (list (read-string "Host: "
4963 (let ((name (or (buffer-file-name) default-directory)))
4964 (and name (car (ange-ftp-ftp-name name)))))))
4965 (if (not (ange-ftp-vms-host host))
4966 (setq ange-ftp-vms-host-regexp
4967 (concat "^" (regexp-quote host) "$"
4968 (and ange-ftp-vms-host-regexp "\\|")
4969 ange-ftp-vms-host-regexp)
4970 ange-ftp-host-cache nil)))
4973 (defun ange-ftp-vms-file-name-as-directory (name)
4975 (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?$" name)
4976 (setq name (substring name 0 (match-beginning 0))))
4977 (ange-ftp-real-file-name-as-directory name)))
4979 (or (assq 'vms ange-ftp-file-name-as-directory-alist)
4980 (setq ange-ftp-file-name-as-directory-alist
4981 (cons '(vms . ange-ftp-vms-file-name-as-directory)
4982 ange-ftp-file-name-as-directory-alist)))
4984 ;;; Tree dired support:
4986 ;; For this code I have borrowed liberally from Sebastian Kremer's
4990 ;;;; These regexps must be anchored to beginning of line.
4991 ;;;; Beware that the ftpd may put the device in front of the filename.
4993 ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]"
4994 ;; "Regular expression to use to search for VMS executable files.")
4996 ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]"
4997 ;; "Regular expression to use to search for VMS directories.")
4999 ;;(or (assq 'vms ange-ftp-dired-re-exe-alist)
5000 ;; (setq ange-ftp-dired-re-exe-alist
5001 ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe)
5002 ;; ange-ftp-dired-re-exe-alist)))
5004 ;;(or (assq 'vms ange-ftp-dired-re-dir-alist)
5005 ;; (setq ange-ftp-dired-re-dir-alist
5006 ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir)
5007 ;; ange-ftp-dired-re-dir-alist)))
5009 ;;(defun ange-ftp-dired-vms-insert-headerline (dir)
5010 ;; ;; VMS inserts a headerline. I would prefer the headerline
5011 ;; ;; to be in ange-ftp format. This version tries to
5012 ;; ;; be careful, because we can't count on a headerline
5013 ;; ;; over ftp, and we wouldn't want to delete anything
5016 ;; (if (looking-at "^ wildcard ")
5017 ;; (forward-line 1))
5018 ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n")
5019 ;; (delete-region (point) (match-end 0))))
5020 ;; (ange-ftp-real-dired-insert-headerline dir))
5022 ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist)
5023 ;; (setq ange-ftp-dired-insert-headerline-alist
5024 ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline)
5025 ;; ange-ftp-dired-insert-headerline-alist)))
5027 ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol)
5028 ;; "In dired, move to first char of filename on this line.
5029 ;;Returns position (point) or nil if no filename on this line."
5030 ;; ;; This is the VMS version.
5031 ;; (let (case-fold-search)
5032 ;; (or eol (setq eol (progn (end-of-line) (point))))
5033 ;; (beginning-of-line)
5034 ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t)
5035 ;; (goto-char (match-beginning 1))
5037 ;; (error "No file on this line")
5040 ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist)
5041 ;; (setq ange-ftp-dired-move-to-filename-alist
5042 ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename)
5043 ;; ange-ftp-dired-move-to-filename-alist)))
5045 ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol)
5046 ;; ;; Assumes point is at beginning of filename.
5047 ;; ;; So, it should be called only after (dired-move-to-filename t).
5048 ;; ;; case-fold-search must be nil, at least for VMS.
5049 ;; ;; On failure, signals an error or returns nil.
5050 ;; ;; This is the VMS version.
5051 ;; (let (opoint hidden case-fold-search)
5052 ;; (setq opoint (point))
5053 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
5054 ;; (setq hidden (and selective-display
5055 ;; (save-excursion (search-forward "\r" eol t))))
5058 ;; (re-search-forward ange-ftp-vms-filename-regexp eol t))
5060 ;; (not (eq opoint (point)))
5063 ;; (substitute-command-keys
5064 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5065 ;; "No file on this line")))
5066 ;; (if (eq opoint (point))
5070 ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist)
5071 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5072 ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename)
5073 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5075 ;;(defun ange-ftp-dired-vms-between-files ()
5077 ;; (beginning-of-line)
5078 ;; (or (equal (following-char) 10) ; newline
5079 ;; (equal (following-char) 9) ; tab
5080 ;; (progn (forward-char 2)
5081 ;; (or (looking-at "Total of")
5082 ;; (equal (following-char) 32))))))
5084 ;;(or (assq 'vms ange-ftp-dired-between-files-alist)
5085 ;; (setq ange-ftp-dired-between-files-alist
5086 ;; (cons '(vms . ange-ftp-dired-vms-between-files)
5087 ;; ange-ftp-dired-between-files-alist)))
5089 ;; Beware! In VMS filenames must be of the form "FILE.TYPE".
5090 ;; Therefore, we cannot just append a ".Z" to filenames for
5091 ;; compressed files. Instead, we turn "FILE.TYPE" into
5092 ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do.
5094 (defun ange-ftp-vms-make-compressed-filename (name &optional reverse)
5096 ((string-match "-Z;[0-9]+$" name)
5097 (list nil (substring name 0 (match-beginning 0))))
5098 ((string-match ";[0-9]+$" name)
5099 (list nil (substring name 0 (match-beginning 0))))
5100 ((string-match "-Z$" name)
5101 (list nil (substring name 0 -2)))
5104 (if (string-match ";[0-9]+$" name)
5105 (concat (substring name 0 (match-beginning 0))
5107 (concat name "-Z"))))))
5109 (or (assq 'vms ange-ftp-make-compressed-filename-alist)
5110 (setq ange-ftp-make-compressed-filename-alist
5111 (cons '(vms . ange-ftp-vms-make-compressed-filename)
5112 ange-ftp-make-compressed-filename-alist)))
5114 ;;;; When the filename is too long, VMS will use two lines to list a file
5115 ;;;; (damn them!) This will confuse dired. To solve this, need to convince
5116 ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of
5117 ;;;; (forward-line 1). This would require a number of changes to dired.el.
5118 ;;;; If dired gets confused, revert-buffer will fix it.
5120 ;;(defun ange-ftp-dired-vms-ls-trim ()
5121 ;; (goto-char (point-min))
5122 ;; (let ((case-fold-search nil))
5123 ;; (re-search-forward ange-ftp-vms-filename-regexp))
5124 ;; (beginning-of-line)
5125 ;; (delete-region (point-min) (point))
5127 ;; (delete-region (point) (point-max)))
5130 ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist)
5131 ;; (setq ange-ftp-dired-ls-trim-alist
5132 ;; (cons '(vms . ange-ftp-dired-vms-ls-trim)
5133 ;; ange-ftp-dired-ls-trim-alist)))
5135 (defun ange-ftp-vms-sans-version (name &rest args)
5137 (if (string-match ";[0-9]+$" name)
5138 (substring name 0 (match-beginning 0))
5141 (or (assq 'vms ange-ftp-sans-version-alist)
5142 (setq ange-ftp-sans-version-alist
5143 (cons '(vms . ange-ftp-vms-sans-version)
5144 ange-ftp-sans-version-alist)))
5146 ;;(defvar ange-ftp-file-version-alist)
5148 ;;;;; The vms version of clean-directory has 2 more optional args
5149 ;;;;; than the usual dired version. This is so that it can be used by
5150 ;;;;; ange-ftp-dired-vms-flag-backup-files.
5152 ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg)
5153 ;; "Flag numerical backups for deletion.
5154 ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
5155 ;;Positive prefix arg KEEP overrides `dired-kept-versions';
5156 ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
5158 ;;To clear the flags on these files, you can use \\[dired-flag-backup-files]
5159 ;;with a prefix argument."
5160 ;;; (interactive "P") ; Never actually called interactively.
5161 ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions)))
5162 ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
5163 ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS!
5164 ;; ;; This could wipe ALL copies of the file.
5165 ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep)))
5166 ;; (action (or msg "Cleaning"))
5167 ;; (ange-ftp-trample-marker (or marker dired-del-marker))
5168 ;; (ange-ftp-file-version-alist ()))
5169 ;; (message (concat action
5170 ;; " numerical backups (keeping %d late, %d old)...")
5171 ;; late-retention early-retention)
5172 ;; ;; Look at each file.
5173 ;; ;; If the file has numeric backup versions,
5174 ;; ;; put on ange-ftp-file-version-alist an element of the form
5175 ;; ;; (FILENAME . VERSION-NUMBER-LIST)
5176 ;; (dired-map-dired-file-lines (function
5177 ;; ange-ftp-dired-vms-collect-file-versions))
5178 ;; ;; Sort each VERSION-NUMBER-LIST,
5179 ;; ;; and remove the versions not to be deleted.
5180 ;; (let ((fval ange-ftp-file-version-alist))
5182 ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
5183 ;; (v-count (length sorted-v-list)))
5184 ;; (if (> v-count (+ early-retention late-retention))
5185 ;; (rplacd (nthcdr early-retention sorted-v-list)
5186 ;; (nthcdr (- v-count late-retention)
5188 ;; (rplacd (car fval)
5189 ;; (cdr sorted-v-list)))
5190 ;; (setq fval (cdr fval))))
5191 ;; ;; Look at each file. If it is a numeric backup file,
5192 ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
5193 ;; (dired-map-dired-file-lines
5195 ;; ange-ftp-dired-vms-trample-file-versions mark))
5196 ;; (message (concat action " numerical backups...done"))))
5198 ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist)
5199 ;; (setq ange-ftp-dired-clean-directory-alist
5200 ;; (cons '(vms . ange-ftp-dired-vms-clean-directory)
5201 ;; ange-ftp-dired-clean-directory-alist)))
5203 ;;(defun ange-ftp-dired-vms-collect-file-versions (fn)
5204 ;; ;; "If it looks like file FN has versions, return a list of the versions.
5205 ;; ;;That is a list of strings which are file names.
5206 ;; ;;The caller may want to flag some of these files for deletion."
5207 ;;(let ((name (nth 2 (ange-ftp-ftp-name fn))))
5208 ;; (if (string-match ";[0-9]+$" name)
5209 ;; (let* ((name (substring name 0 (match-beginning 0)))
5210 ;; (fn (ange-ftp-replace-name-component fn name)))
5211 ;; (if (not (assq fn ange-ftp-file-version-alist))
5212 ;; (let* ((base-versions
5213 ;; (concat (file-name-nondirectory name) ";"))
5214 ;; (bv-length (length base-versions))
5215 ;; (possibilities (file-name-all-completions
5217 ;; (file-name-directory fn)))
5218 ;; (versions (mapcar
5220 ;; (if (and (string-match
5221 ;; "[0-9]+$" arg bv-length)
5222 ;; (= (match-beginning 0) bv-length))
5223 ;; (string-to-int (substring arg bv-length))
5228 ;; ange-ftp-file-version-alist
5229 ;; (cons (cons fn versions)
5230 ;; ange-ftp-file-version-alist)))))))))
5232 ;;(defun ange-ftp-dired-vms-trample-file-versions (fn)
5233 ;; (let* ((start-vn (string-match ";[0-9]+$" fn))
5234 ;; base-version-list)
5236 ;; (setq base-version-list ; there was a base version to which
5237 ;; (assoc (substring fn 0 start-vn) ; this looks like a
5238 ;; ange-ftp-file-version-alist)) ; subversion
5239 ;; (not (memq (string-to-int (substring fn (1+ start-vn)))
5240 ;; base-version-list)) ; this one doesn't make the cut
5241 ;; (progn (beginning-of-line)
5243 ;; (insert ange-ftp-trample-marker)))))
5245 ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p)
5246 ;; (let ((dired-kept-versions 1)
5247 ;; (kept-old-versions 0)
5250 ;; (setq marker ?\040 msg "Unflagging")
5251 ;; (setq marker dired-del-marker msg "Cleaning"))
5252 ;; (ange-ftp-dired-vms-clean-directory nil marker msg)))
5254 ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist)
5255 ;; (setq ange-ftp-dired-flag-backup-files-alist
5256 ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files)
5257 ;; ange-ftp-dired-flag-backup-files-alist)))
5259 ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches)
5260 ;; (let ((file (dired-get-filename 'no-dir))
5262 ;; (if (and (string-match ";[0-9]+$" file)
5263 ;; ;; Find most recent previous version.
5264 ;; (let ((root (substring file 0 (match-beginning 0)))
5266 ;; (string-to-int (substring file (1+ (match-beginning 0)))))
5268 ;; (setq ver (1- ver))
5269 ;; (while (and (> ver 0) (not found))
5270 ;; (setq bak (concat root ";" (int-to-string ver)))
5271 ;; (and (file-exists-p bak) (setq found t))
5272 ;; (setq ver (1- ver)))
5275 ;; (diff (expand-file-name bak) (expand-file-name file) switches)
5276 ;; (diff (expand-file-name bak) (expand-file-name file)))
5277 ;; (error "No previous version found for %s" file))))
5279 ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist)
5280 ;; (setq ange-ftp-dired-backup-diff-alist
5281 ;; (cons '(vms . ange-ftp-dired-vms-backup-diff)
5282 ;; ange-ftp-dired-backup-diff-alist)))
5285 ;;;; ------------------------------------------------------------
5287 ;;;; ------------------------------------------------------------
5290 ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from
5292 (defun ange-ftp-fix-name-for-mts (name &optional reverse)
5295 (if (string-match "^\\([^:]+:\\)?\\(.*\\)$" name)
5297 (if (match-beginning 1)
5298 (setq acct (substring name 0 (match-end 1))))
5299 (if (match-beginning 2)
5300 (setq file (substring name
5301 (match-beginning 2) (match-end 2))))
5302 (concat (and acct (concat "/" acct "/"))
5304 (error "name %s didn't match" name))
5305 (if (string-match "^/\\([^:]+:\\)/\\(.*\\)$" name)
5306 (concat (substring name 1 (match-end 1))
5307 (substring name (match-beginning 2) (match-end 2)))
5308 ;; Let's hope that mts will recognize it anyway.
5311 (or (assq 'mts ange-ftp-fix-name-func-alist)
5312 (setq ange-ftp-fix-name-func-alist
5313 (cons '(mts . ange-ftp-fix-name-for-mts)
5314 ange-ftp-fix-name-func-alist)))
5316 ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing.
5317 ;; Remember that there are no directories in MTS.
5318 (defun ange-ftp-fix-dir-name-for-mts (dir-name)
5319 (if (string-equal dir-name "/")
5320 (error "Cannot get listing for fictitious \"/\" directory.")
5321 (let ((dir-name (ange-ftp-fix-name-for-mts dir-name)))
5323 ((string-equal dir-name "")
5325 ((string-match ":$" dir-name)
5326 (concat dir-name "?"))
5327 (dir-name))))) ; It's just a single file.
5329 (or (assq 'mts ange-ftp-fix-dir-name-func-alist)
5330 (setq ange-ftp-fix-dir-name-func-alist
5331 (cons '(mts . ange-ftp-fix-dir-name-for-mts)
5332 ange-ftp-fix-dir-name-func-alist)))
5334 (or (memq 'mts ange-ftp-dumb-host-types)
5335 (setq ange-ftp-dumb-host-types
5336 (cons 'mts ange-ftp-dumb-host-types)))
5338 (defvar ange-ftp-mts-host-regexp nil)
5340 ;; Return non-nil if HOST is running MTS.
5341 (defun ange-ftp-mts-host (host)
5342 (and ange-ftp-mts-host-regexp
5344 (string-match ange-ftp-mts-host-regexp host))))
5346 ;; Parse the current buffer which is assumed to be in mts ftp dir format.
5347 (defun ange-ftp-parse-mts-listing ()
5348 (let ((tbl (ange-ftp-make-hashtable)))
5349 (goto-char (point-min))
5351 (while (re-search-forward ange-ftp-date-regexp nil t)
5353 (skip-chars-backward " ")
5354 (let ((end (point)))
5355 (skip-chars-backward "-A-Z0-9_.!")
5356 (ange-ftp-put-hash-entry (buffer-substring (point) end) nil tbl))
5358 ;; Don't need to bother with ..
5359 (ange-ftp-put-hash-entry "." t tbl)
5362 (or (assq 'mts ange-ftp-parse-list-func-alist)
5363 (setq ange-ftp-parse-list-func-alist
5364 (cons '(mts . ange-ftp-parse-mts-listing)
5365 ange-ftp-parse-list-func-alist)))
5367 (defun ange-ftp-add-mts-host (host)
5368 "Mark HOST as the name of a machine running MTS."
5370 (list (read-string "Host: "
5371 (let ((name (or (buffer-file-name) default-directory)))
5372 (and name (car (ange-ftp-ftp-name name)))))))
5373 (if (not (ange-ftp-mts-host host))
5374 (setq ange-ftp-mts-host-regexp
5375 (concat "^" (regexp-quote host) "$"
5376 (and ange-ftp-mts-host-regexp "\\|")
5377 ange-ftp-mts-host-regexp)
5378 ange-ftp-host-cache nil)))
5380 ;;; Tree dired support:
5382 ;;;; There aren't too many systems left that use MTS. This dired support will
5383 ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems
5384 ;;;; implement ftp in the same way. If not, it might be necessary to make the
5385 ;;;; following more flexible.
5387 ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol)
5388 ;; "In dired, move to first char of filename on this line.
5389 ;;Returns position (point) or nil if no filename on this line."
5390 ;; ;; This is the MTS version.
5391 ;; (or eol (setq eol (progn (end-of-line) (point))))
5392 ;; (beginning-of-line)
5393 ;; (if (re-search-forward
5394 ;; ange-ftp-date-regexp eol t)
5396 ;; (skip-chars-forward " ") ; Eat blanks after date
5397 ;; (skip-chars-forward "0-9:" eol) ; Eat time or year
5398 ;; (skip-chars-forward " " eol) ; one space before filename
5399 ;; ;; When listing an account other than the users own account it appends
5400 ;; ;; ACCT: to the beginning of the filename. Skip over this.
5401 ;; (and (looking-at "[A-Z0-9_.]+:")
5402 ;; (goto-char (match-end 0)))
5405 ;; (error "No file on this line")
5408 ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist)
5409 ;; (setq ange-ftp-dired-move-to-filename-alist
5410 ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename)
5411 ;; ange-ftp-dired-move-to-filename-alist)))
5413 ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol)
5414 ;; ;; Assumes point is at beginning of filename.
5415 ;; ;; So, it should be called only after (dired-move-to-filename t).
5416 ;; ;; On failure, signals an error or returns nil.
5417 ;; ;; This is the MTS version.
5418 ;; (let (opoint hidden case-fold-search)
5419 ;; (setq opoint (point)
5420 ;; eol (save-excursion (end-of-line) (point))
5421 ;; hidden (and selective-display
5422 ;; (save-excursion (search-forward "\r" eol t))))
5425 ;; (skip-chars-forward "-A-Z0-9._!" eol))
5427 ;; (not (eq opoint (point)))
5430 ;; (substitute-command-keys
5431 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5432 ;; "No file on this line")))
5433 ;; (if (eq opoint (point))
5437 ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist)
5438 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5439 ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename)
5440 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5442 ;;;; ------------------------------------------------------------
5444 ;;;; ------------------------------------------------------------
5446 ;; Since CMS doesn't have any full file name syntax, we have to fudge
5447 ;; things with cd's. We actually send too many cd's, but it's dangerous
5448 ;; to try to remember the current minidisk, because if the connection
5449 ;; is closed and needs to be reopened, we will find ourselves back in
5450 ;; the default minidisk. This is fairly likely since CMS ftp servers
5451 ;; usually close the connection after 5 minutes of inactivity.
5453 ;; Have I got the filename character set right?
5455 (defun ange-ftp-fix-name-for-cms (name &optional reverse)
5458 ;; Since we only convert output from a pwd in this direction,
5459 ;; we'll assume that it's a minidisk, and make it into a
5460 ;; directory file name. Note that the expand-dir-hashtable
5461 ;; stores directories without the trailing /. Is this
5464 (if (string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$"
5466 (let ((minidisk (substring name 1 (match-end 1))))
5467 (if (match-beginning 2)
5468 (let ((file (substring name (match-beginning 2)
5470 (cmd (concat "cd " minidisk))
5472 ;; Note that host and user are bound in the call
5473 ;; to ange-ftp-send-cmd
5474 (proc (ange-ftp-get-process ange-ftp-this-host
5475 ange-ftp-this-user)))
5477 ;; Must use ange-ftp-raw-send-cmd here to avoid
5478 ;; an infinite loop.
5479 (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg))
5481 ;; failed... try ONCE more.
5482 (setq proc (ange-ftp-get-process ange-ftp-this-host
5483 ange-ftp-this-user))
5484 (let ((result (ange-ftp-raw-send-cmd proc cmd
5485 ange-ftp-this-msg)))
5489 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5490 (format "cd to minidisk %s failed: %s"
5491 minidisk (cdr result)))))))
5492 ;; return the minidisk
5494 (error "Invalid CMS filename")))))
5496 (or (assq 'cms ange-ftp-fix-name-func-alist)
5497 (setq ange-ftp-fix-name-func-alist
5498 (cons '(cms . ange-ftp-fix-name-for-cms)
5499 ange-ftp-fix-name-func-alist)))
5501 (or (memq 'cms ange-ftp-dumb-host-types)
5502 (setq ange-ftp-dumb-host-types
5503 (cons 'cms ange-ftp-dumb-host-types)))
5505 ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing.
5506 (defun ange-ftp-fix-dir-name-for-cms (dir-name)
5508 ((string-equal "/" dir-name)
5509 (error "Cannot get listing for fictitious \"/\" directory."))
5510 ((string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$" dir-name)
5511 (let* ((minidisk (substring dir-name (match-beginning 1) (match-end 1)))
5512 ;; host and user are bound in the call to ange-ftp-send-cmd
5513 (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user))
5514 (cmd (concat "cd " minidisk))
5515 (file (if (match-beginning 2)
5516 ;; it's a single file
5517 (substring dir-name (match-beginning 2)
5519 ;; use the wild-card
5521 (if (car (ange-ftp-raw-send-cmd proc cmd))
5524 (setq proc (ange-ftp-get-process ange-ftp-this-host
5525 ange-ftp-this-user))
5526 (let ((result (ange-ftp-raw-send-cmd proc cmd)))
5530 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5531 (format "cd to minidisk %s failed: %s"
5532 minidisk (cdr result))))))))
5533 (t (error "Invalid CMS file name"))))
5535 (or (assq 'cms ange-ftp-fix-dir-name-func-alist)
5536 (setq ange-ftp-fix-dir-name-func-alist
5537 (cons '(cms . ange-ftp-fix-dir-name-for-cms)
5538 ange-ftp-fix-dir-name-func-alist)))
5540 (defvar ange-ftp-cms-host-regexp nil
5541 "Regular expression to match hosts running the CMS operating system.")
5543 ;; Return non-nil if HOST is running CMS.
5544 (defun ange-ftp-cms-host (host)
5545 (and ange-ftp-cms-host-regexp
5547 (string-match ange-ftp-cms-host-regexp host))))
5549 (defun ange-ftp-add-cms-host (host)
5550 "Mark HOST as the name of a CMS host."
5552 (list (read-string "Host: "
5553 (let ((name (or (buffer-file-name) default-directory)))
5554 (and name (car (ange-ftp-ftp-name name)))))))
5555 (if (not (ange-ftp-cms-host host))
5556 (setq ange-ftp-cms-host-regexp
5557 (concat "^" (regexp-quote host) "$"
5558 (and ange-ftp-cms-host-regexp "\\|")
5559 ange-ftp-cms-host-regexp)
5560 ange-ftp-host-cache nil)))
5562 (defun ange-ftp-parse-cms-listing ()
5563 ;; Parse the current buffer which is assumed to be a CMS directory listing.
5564 ;; If we succeed in getting a listing, then we will assume that the minidisk
5565 ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work
5566 ;; because ange-ftp doesn't know that the root hashtable has only part of
5567 ;; the info. It will assume that if a minidisk isn't in it, then it doesn't
5568 ;; exist. It would be nice if completion worked for minidisks, as we
5570 ; (let* ((dir-file (directory-file-name file))
5571 ; (root (file-name-directory dir-file))
5572 ; (minidisk (ange-ftp-get-file-part dir-file))
5573 ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable)))
5575 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5576 ; (setq root-tbl (ange-ftp-make-hashtable))
5577 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5578 ; (ange-ftp-put-hash-entry "." t root-tbl)
5579 ; (ange-ftp-set-files root root-tbl)))
5580 ;; Now do the usual parsing
5581 (let ((tbl (ange-ftp-make-hashtable)))
5582 (goto-char (point-min))
5586 "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t)
5587 (ange-ftp-put-hash-entry
5588 (concat (buffer-substring (match-beginning 1)
5591 (buffer-substring (match-beginning 2)
5595 (ange-ftp-put-hash-entry "." t tbl))
5598 (or (assq 'cms ange-ftp-parse-list-func-alist)
5599 (setq ange-ftp-parse-list-func-alist
5600 (cons '(cms . ange-ftp-parse-cms-listing)
5601 ange-ftp-parse-list-func-alist)))
5603 ;;;;; Tree dired support:
5605 ;;(defconst ange-ftp-dired-cms-re-exe
5606 ;; "^. [-A-Z0-9$_]+ +EXEC "
5607 ;; "Regular expression to use to search for CMS executables.")
5609 ;;(or (assq 'cms ange-ftp-dired-re-exe-alist)
5610 ;; (setq ange-ftp-dired-re-exe-alist
5611 ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe)
5612 ;; ange-ftp-dired-re-exe-alist)))
5615 ;;(defun ange-ftp-dired-cms-insert-headerline (dir)
5616 ;; ;; CMS has no total line, so we insert a blank line for
5619 ;; (forward-char -1)
5620 ;; (ange-ftp-real-dired-insert-headerline dir))
5622 ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist)
5623 ;; (setq ange-ftp-dired-insert-headerline-alist
5624 ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline)
5625 ;; ange-ftp-dired-insert-headerline-alist)))
5627 ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol)
5628 ;; "In dired, move to the first char of filename on this line."
5629 ;; ;; This is the CMS version.
5630 ;; (or eol (setq eol (progn (end-of-line) (point))))
5631 ;; (let (case-fold-search)
5632 ;; (beginning-of-line)
5633 ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t)
5634 ;; (goto-char (1+ (match-beginning 0)))
5636 ;; (error "No file on this line")
5639 ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist)
5640 ;; (setq ange-ftp-dired-move-to-filename-alist
5641 ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename)
5642 ;; ange-ftp-dired-move-to-filename-alist)))
5644 ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol)
5645 ;; ;; Assumes point is at beginning of filename.
5646 ;; ;; So, it should be called only after (dired-move-to-filename t).
5647 ;; ;; case-fold-search must be nil, at least for VMS.
5648 ;; ;; On failure, signals an error or returns nil.
5649 ;; ;; This is the CMS version.
5650 ;; (let ((opoint (point))
5651 ;; case-fold-search hidden)
5652 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
5653 ;; (setq hidden (and selective-display
5655 ;; (search-forward "\r" eol t))))
5660 ;; (substitute-command-keys
5661 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
5662 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5663 ;; (skip-chars-forward " " eol)
5664 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5665 ;; (if (eq opoint (point))
5668 ;; (error "No file on this line"))
5671 ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist)
5672 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5673 ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename)
5674 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5676 (defun ange-ftp-cms-make-compressed-filename (name &optional reverse)
5677 (if (string-match "-Z$" name)
5678 (list nil (substring name 0 -2))
5679 (list t (concat name "-Z"))))
5681 (or (assq 'cms ange-ftp-make-compressed-filename-alist)
5682 (setq ange-ftp-make-compressed-filename-alist
5683 (cons '(cms . ange-ftp-cms-make-compressed-filename)
5684 ange-ftp-make-compressed-filename-alist)))
5686 ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep)
5687 ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep)))
5689 ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name)
5690 ;; (concat (substring name 0 (match-end 1))
5692 ;; (substring name (match-beginning 2) (match-end 2)))
5695 ;;(or (assq 'cms ange-ftp-dired-get-filename-alist)
5696 ;; (setq ange-ftp-dired-get-filename-alist
5697 ;; (cons '(cms . ange-ftp-dired-cms-get-filename)
5698 ;; ange-ftp-dired-get-filename-alist)))
5700 ;;;; ------------------------------------------------------------
5701 ;;;; Finally provide package.
5702 ;;;; ------------------------------------------------------------
5706 ;;; ange-ftp.el ends here