1 ;;; ange-ftp.el --- transparent FTP support for GNU Emacs
3 ;; Copyright (C) 1989,90,91,92,93,94,95,96 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 is 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
625 ;;;; ------------------------------------------------------------
626 ;;;; User customization variables.
627 ;;;; ------------------------------------------------------------
629 (defvar ange-ftp-name-format
630 '("^/\\(\\([^@/:]*\\)@\\)?\\([^@/:]*[^@/:.]\\):\\(.*\\)" .
(3 2 4))
631 "*Format of a fully expanded remote file name.
632 This is a list of the form \(REGEXP HOST USER NAME\),
633 where REGEXP is a regular expression matching
634 the full remote name, and HOST, USER, and NAME are the numbers of
635 parenthesized expressions in REGEXP for the components (in that order).")
637 ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of
638 ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs.
639 ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out.
641 (defvar ange-ftp-multi-msgs
642 "^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-"
643 "*Regular expression matching the start of a multiline ftp reply.")
645 (defvar ange-ftp-good-msgs
646 "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark"
647 "*Regular expression matching ftp \"success\" messages.")
649 ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT.
650 ;; Also CMS machines use a multiline 550- reply to say that you
651 ;; don't have write permission. ange-ftp gets into multi-line skip
652 ;; mode and hangs. Have it ignore 550- instead. It will then barf
653 ;; when it gets the 550 line, as it should.
655 (defvar ange-ftp-skip-msgs
656 (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|"
657 "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|"
658 "^Data connection \\|"
659 "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye")
660 "*Regular expression matching ftp messages that can be ignored.")
662 (defvar ange-ftp-fatal-msgs
663 (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|"
664 "^No control connection\\|unknown host\\|^lost connection")
665 "*Regular expression matching ftp messages that indicate serious errors.
666 These mean that the FTP process should (or already has) been killed.")
668 (defvar ange-ftp-gateway-fatal-msgs
669 "No route to host\\|Connection closed\\|No such host\\|Login incorrect"
670 "*Regular expression matching login failure messages from rlogin/telnet.")
672 (defvar ange-ftp-xfer-size-msgs
673 "^150 .* connection for .* (\\([0-9]+\\) bytes)"
674 "*Regular expression used to determine the number of bytes in a FTP transfer.")
676 (defvar ange-ftp-tmp-name-template
"/tmp/ange-ftp"
677 "*Template used to create temporary files.")
679 (defvar ange-ftp-gateway-tmp-name-template
"/tmp/ange-ftp"
680 "*Template used to create temporary files when ftp-ing through a gateway.
681 Files starting with this prefix need to be accessible from BOTH the local
682 machine and the gateway machine, and need to have the SAME name on both
683 machines, that is, /tmp is probably NOT what you want, since that is rarely
686 (defvar ange-ftp-netrc-filename
"~/.netrc"
687 "*File in .netrc format to search for passwords.")
689 (defvar ange-ftp-disable-netrc-security-check nil
690 "*If non-nil avoid checking permissions on the .netrc file.")
692 (defvar ange-ftp-default-user nil
693 "*User name to use when none is specified in a file name.
694 If non-nil but not a string, you are prompted for the name.
695 If nil, the value of `ange-ftp-netrc-default-user' is used.
696 If that is nil too, then your login name is used.
698 Once a connection to a given host has been initiated, the user name
699 and password information for that host are cached and re-used by
700 ange-ftp. Use `ange-ftp-set-user' to change the cached values,
701 since setting `ange-ftp-default-user' directly does not affect
702 the cached information.")
704 (defvar ange-ftp-netrc-default-user nil
705 "Alternate default user name to use when none is specified.
706 This variable is set from the `default' command in your `.netrc' file,
709 (defvar ange-ftp-default-password nil
710 "*Password to use when the user name equals `ange-ftp-default-user'.")
712 (defvar ange-ftp-default-account nil
713 "*Account to use when the user name equals `ange-ftp-default-user'.")
715 (defvar ange-ftp-netrc-default-password nil
716 "*Password to use when the user name equals `ange-ftp-netrc-default-user'.")
718 (defvar ange-ftp-netrc-default-account nil
719 "*Account to use when the user name equals `ange-ftp-netrc-default-user'.")
721 (defvar ange-ftp-generate-anonymous-password t
722 "*If t, use value of `user-mail-address' as password for anonymous ftp.
723 If a string, then use that string as the password.
724 If nil, prompt the user for a password.")
726 (defvar ange-ftp-dumb-unix-host-regexp nil
727 "*If non-nil, regexp matching hosts on which `dir' command lists directory.")
729 (defvar ange-ftp-binary-file-name-regexp
730 (concat "\\.[zZ]$\\|\\.lzh$\\|\\.arc$\\|\\.zip$\\|\\.zoo$\\|\\.tar$\\|"
731 "\\.dvi$\\|\\.ps$\\|\\.elc$\\|TAGS$\\|\\.gif$\\|"
732 "\\.EXE\\(;[0-9]+\\)?$\\|\\.[zZ]-part-..$\\|\\.gz$\\|"
734 "*If a file matches this regexp then it is transferred in binary mode.")
736 (defvar ange-ftp-gateway-host nil
737 "*Name of host to use as gateway machine when local FTP isn't possible.")
739 (defvar ange-ftp-local-host-regexp
".*"
740 "*Regexp selecting hosts which can be reached directly with ftp.
741 For other hosts the FTP process is started on \`ange-ftp-gateway-host\'
742 instead, and/or reached via \`ange-ftp-gateway-ftp-program-name\'.")
744 (defvar ange-ftp-gateway-program-interactive nil
745 "*If non-nil then the gateway program should give a shell prompt.
746 Both telnet and rlogin do something like this.")
748 (defvar ange-ftp-gateway-program remote-shell-program
749 "*Name of program to spawn a shell on the gateway machine.
750 Valid candidates are rsh (remsh on some systems), telnet and rlogin. See
751 also the gateway variable above.")
753 (defvar ange-ftp-gateway-prompt-pattern
"^[^#$%>;\n]*[#$%>;] *"
754 "*Regexp matching prompt after complete login sequence on gateway machine.
755 A match for this means the shell is now awaiting input. Make this regexp as
756 strict as possible; it shouldn't match *anything* at all except the user's
757 initial prompt. The above string will fail under most SUN-3's since it
758 matches the login banner.")
760 (defvar ange-ftp-gateway-setup-term-command
761 (if (eq system-type
'hpux
)
762 "stty -onlcr -echo\n"
764 "*Set up terminal after logging in to the gateway machine.
765 This command should stop the terminal from echoing each command, and
766 arrange to strip out trailing ^M characters.")
768 (defvar ange-ftp-smart-gateway nil
769 "*Non-nil means the ftp gateway and/or the gateway ftp program is smart.
770 Don't bother telnetting, etc., already connected to desired host transparently,
771 or just issue a user@host command in case \`ange-ftp-gateway-host\' is non-nil.")
773 (defvar ange-ftp-smart-gateway-port
"21"
774 "*Port on gateway machine to use when smart gateway is in operation.")
776 (defvar ange-ftp-send-hash t
777 "*If non-nil, send the HASH command to the FTP client.")
779 (defvar ange-ftp-binary-hash-mark-size nil
780 "*Default size, in bytes, between hash-marks when transferring a binary file.
781 If NIL, this variable will be locally overridden if the FTP client outputs a
782 suitable response to the HASH command. If non-NIL then this value takes
783 precedence over the local value.")
785 (defvar ange-ftp-ascii-hash-mark-size
1024
786 "*Default size, in bytes, between hash-marks when transferring an ASCII file.
787 This variable is buffer-local and will be locally overridden if the FTP client
788 outputs a suitable response to the HASH command.")
790 (defvar ange-ftp-process-verbose t
791 "*If non-NIL then be chatty about interaction with the FTP process.")
793 (defvar ange-ftp-ftp-program-name
"ftp"
794 "*Name of FTP program to run.")
796 (defvar ange-ftp-gateway-ftp-program-name
"ftp"
797 "*Name of FTP program to run when accessing non-local hosts.
798 Some AT&T folks claim to use something called `pftp' here.")
800 (defvar ange-ftp-ftp-program-args
'("-i" "-n" "-g" "-v")
801 "*A list of arguments passed to the FTP program when started.")
803 (defvar ange-ftp-nslookup-program nil
804 "*If non-NIL then a string naming nslookup program." )
806 (defvar ange-ftp-make-backup-files
()
807 "*Non-nil means make backup files for \"magic\" remote files.")
809 (defvar ange-ftp-retry-time
5
810 "*Number of seconds to wait before retry if file or listing doesn't arrive.
811 This might need to be increased for very slow connections.")
813 (defvar ange-ftp-auto-save
0
814 "If 1, allows ange-ftp files to be auto-saved.
815 If 0, suppresses auto-saving of ange-ftp files.
816 Don't use any other value.")
818 ;;;; ------------------------------------------------------------
819 ;;;; Hash table support.
820 ;;;; ------------------------------------------------------------
824 (defun ange-ftp-make-hashtable (&optional size
)
825 "Make an obarray suitable for use as a hashtable.
826 SIZE, if supplied, should be a prime number."
827 (make-vector (or size
31) 0))
829 (defun ange-ftp-map-hashtable (fun tbl
)
830 "Call FUNCTION on each key and value in HASHTABLE."
834 (funcall fun
(get sym
'key
) (get sym
'val
))))
837 (defmacro ange-ftp-make-hash-key
(key)
838 "Convert KEY into a suitable key for a hashtable."
839 (` (if (stringp (, key
))
841 (prin1-to-string (, key
)))))
843 (defun ange-ftp-get-hash-entry (key tbl
)
844 "Return the value associated with KEY in HASHTABLE."
845 (let ((sym (intern-soft (ange-ftp-make-hash-key key
) tbl
)))
846 (and sym
(get sym
'val
))))
848 (defun ange-ftp-put-hash-entry (key val tbl
)
849 "Record an association between KEY and VALUE in HASHTABLE."
850 (let ((sym (intern (ange-ftp-make-hash-key key
) tbl
)))
854 (defun ange-ftp-del-hash-entry (key tbl
)
855 "Copy all symbols except KEY in HASHTABLE and return modified hashtable."
856 (let* ((len (length tbl
))
857 (new-tbl (ange-ftp-make-hashtable len
))
859 (ange-ftp-map-hashtable
863 (ange-ftp-put-hash-entry k v new-tbl
))))
866 (aset tbl i
(aref new-tbl i
))
870 (defun ange-ftp-hash-entry-exists-p (key tbl
)
871 "Return whether there is an association for KEY in TABLE."
872 (intern-soft (ange-ftp-make-hash-key key
) tbl
))
874 (defun ange-ftp-hash-table-keys (tbl)
875 "Return a sorted list of all the active keys in TABLE, as strings."
876 (sort (all-completions "" tbl
)
877 (function string-lessp
)))
879 ;;;; ------------------------------------------------------------
880 ;;;; Internal variables.
881 ;;;; ------------------------------------------------------------
883 (defvar ange-ftp-data-buffer-name
" *ftp data*"
884 "Buffer name to hold directory listing data received from ftp process.")
886 (defvar ange-ftp-netrc-modtime nil
887 "Last modified time of the netrc file from file-attributes.")
889 (defvar ange-ftp-user-hashtable
(ange-ftp-make-hashtable)
890 "Hash table holding associations between HOST, USER pairs.")
892 (defvar ange-ftp-passwd-hashtable
(ange-ftp-make-hashtable)
893 "Mapping between a HOST, USER pair and a PASSWORD for them.")
895 (defvar ange-ftp-account-hashtable
(ange-ftp-make-hashtable)
896 "Mapping between a HOST, USER pair and a ACCOUNT password for them.")
898 (defvar ange-ftp-files-hashtable
(ange-ftp-make-hashtable 97)
899 "Hash table for storing directories and their respective files.")
901 (defvar ange-ftp-ls-cache-lsargs nil
902 "Last set of args used by ange-ftp-ls.")
904 (defvar ange-ftp-ls-cache-file nil
905 "Last file passed to ange-ftp-ls.")
907 (defvar ange-ftp-ls-cache-res nil
908 "Last result returned from ange-ftp-ls.")
910 (defconst ange-ftp-expand-dir-hashtable
(ange-ftp-make-hashtable))
912 (defconst ange-ftp-expand-dir-regexp
"^5.0 \\([^: ]+\\):")
914 ;; These are local variables in each FTP process buffer.
915 (defvar ange-ftp-hash-mark-unit nil
)
916 (defvar ange-ftp-hash-mark-count nil
)
917 (defvar ange-ftp-xfer-size nil
)
918 (defvar ange-ftp-process-string nil
)
919 (defvar ange-ftp-process-result-line nil
)
920 (defvar ange-ftp-process-busy nil
)
921 (defvar ange-ftp-process-result nil
)
922 (defvar ange-ftp-process-multi-skip nil
)
923 (defvar ange-ftp-process-msg nil
)
924 (defvar ange-ftp-process-continue nil
)
925 (defvar ange-ftp-last-percent nil
)
927 ;; These variables are bound by one function and examined by another.
928 ;; Leave them void globally for error checking.
929 (defvar ange-ftp-this-file
)
930 (defvar ange-ftp-this-dir
)
931 (defvar ange-ftp-this-user
)
932 (defvar ange-ftp-this-host
)
933 (defvar ange-ftp-this-msg
)
934 (defvar ange-ftp-completion-ignored-pattern
)
935 (defvar ange-ftp-trample-marker
)
937 ;; New error symbols.
938 (put 'ftp-error
'error-conditions
'(ftp-error file-error error
))
939 ;; (put 'ftp-error 'error-message "FTP error")
941 ;;; ------------------------------------------------------------
942 ;;; Enhanced message support.
943 ;;; ------------------------------------------------------------
945 (defun ange-ftp-message (fmt &rest args
)
946 "Display message in echo area, but indicate if truncated.
947 Args are as in `message': a format string, plus arguments to be formatted."
948 (let ((msg (apply (function format
) fmt args
))
949 (max (window-width (minibuffer-window))))
952 (if (>= (length msg
) max
)
953 ;; Take just the last MAX - 3 chars of the string.
954 (setq msg
(concat "> " (substring msg
(- 3 max
)))))
955 (message "%s" msg
))))
957 (defun ange-ftp-abbreviate-filename (file &optional new
)
958 "Abbreviate the file name FILE relative to the default-directory.
959 If the optional parameter NEW is given and the non-directory parts match,
960 only return the directory part of FILE."
962 (if (and default-directory
963 (string-match (concat "^"
964 (regexp-quote default-directory
)
966 (setq file
(substring file
(1- (match-end 0)))))
968 (string-equal (file-name-nondirectory file
)
969 (file-name-nondirectory new
)))
970 (setq file
(file-name-directory file
)))
973 ;;;; ------------------------------------------------------------
974 ;;;; User / Host mapping support.
975 ;;;; ------------------------------------------------------------
977 (defun ange-ftp-set-user (host user
)
978 "For a given HOST, set or change the default USER."
979 (interactive "sHost: \nsUser: ")
980 (ange-ftp-put-hash-entry host user ange-ftp-user-hashtable
))
982 (defun ange-ftp-get-user (host)
983 "Given a HOST, return the default USER."
984 (ange-ftp-parse-netrc)
985 (let ((user (ange-ftp-get-hash-entry host ange-ftp-user-hashtable
)))
989 (cond ((stringp ange-ftp-default-user
)
990 ;; We have a default name. Use it.
991 ange-ftp-default-user
)
992 (ange-ftp-default-user
994 (let ((enable-recursive-minibuffers t
))
995 (read-string (format "User for %s: " host
)
997 (ange-ftp-netrc-default-user)
998 ;; Default to the user's login name.
1000 (user-login-name))))
1001 (ange-ftp-set-user host user
)))))
1003 ;;;; ------------------------------------------------------------
1004 ;;;; Password support.
1005 ;;;; ------------------------------------------------------------
1007 (defun ange-ftp-read-passwd (prompt &optional default
)
1008 "Read a password, echoing `.' for each character typed.
1009 End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line.
1010 Optional DEFAULT is password to start with."
1011 (let ((pass (if default default
""))
1014 (cursor-in-echo-area t
))
1015 (while (progn (message "%s%s"
1017 (make-string (length pass
) ?.
))
1018 (setq c
(read-char))
1019 (and (/= c ?
\r) (/= c ?
\n) (/= c ?\e
)))
1022 (if (and (/= c ?
\b) (/= c ?
\177))
1023 (setq pass
(concat pass
(char-to-string c
)))
1024 (if (> (length pass
) 0)
1025 (setq pass
(substring pass
0 -
1))))))
1027 (ange-ftp-repaint-minibuffer)
1030 (defmacro ange-ftp-generate-passwd-key
(host user
)
1031 (` (concat (, host
) "/" (, user
))))
1033 (defmacro ange-ftp-lookup-passwd
(host user
)
1034 (` (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key (, host
) (, user
))
1035 ange-ftp-passwd-hashtable
)))
1037 (defun ange-ftp-set-passwd (host user passwd
)
1038 "For a given HOST and USER, set or change the associated PASSWORD."
1039 (interactive (list (read-string "Host: ")
1040 (read-string "User: ")
1041 (ange-ftp-read-passwd "Password: ")))
1042 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user
)
1044 ange-ftp-passwd-hashtable
))
1046 (defun ange-ftp-get-host-with-passwd (user)
1047 "Given a USER, return a host we know the password for."
1048 (ange-ftp-parse-netrc)
1050 (ange-ftp-map-hashtable
1051 (function (lambda (host val
)
1052 (if (ange-ftp-lookup-passwd host user
)
1053 (throw 'found-one host
))))
1054 ange-ftp-user-hashtable
)
1056 (ange-ftp-map-hashtable
1059 (if (string-match "^[^/]*\\(/\\).*$" key
)
1060 (let ((host (substring key
0 (match-beginning 1))))
1061 (if (and (string-equal user
(substring key
(match-end 1)))
1063 (throw 'found-one host
))))))
1064 ange-ftp-passwd-hashtable
))
1067 (defun ange-ftp-get-passwd (host user
)
1068 "Return the password for specified HOST and USER, asking user if necessary."
1069 (ange-ftp-parse-netrc)
1071 ;; look up password in the hash table first; user might have overridden the
1073 (cond ((ange-ftp-lookup-passwd host user
))
1075 ;; See if default user and password set.
1076 ((and (stringp ange-ftp-default-user
)
1077 ange-ftp-default-password
1078 (string-equal user ange-ftp-default-user
))
1079 ange-ftp-default-password
)
1081 ;; See if default user and password set from .netrc file.
1082 ((and (stringp ange-ftp-netrc-default-user
)
1083 ange-ftp-netrc-default-password
1084 (string-equal user ange-ftp-netrc-default-user
))
1085 ange-ftp-netrc-default-password
)
1087 ;; anonymous ftp password is handled specially since there is an
1088 ;; unwritten rule about how that is used on the Internet.
1089 ((and (or (string-equal user
"anonymous")
1090 (string-equal user
"ftp"))
1091 ange-ftp-generate-anonymous-password
)
1092 (if (stringp ange-ftp-generate-anonymous-password
)
1093 ange-ftp-generate-anonymous-password
1096 ;; see if same user has logged in to other hosts; if so then prompt
1097 ;; with the password that was used there.
1099 (let* ((other (ange-ftp-get-host-with-passwd user
))
1102 ;; found another machine with the same user.
1103 ;; Try that account.
1104 (ange-ftp-read-passwd
1105 (format "passwd for %s@%s (same as %s@%s): "
1106 user host user other
)
1107 (ange-ftp-lookup-passwd other user
))
1109 ;; I give up. Ask the user for the password.
1110 (ange-ftp-read-passwd
1111 (format "Password for %s@%s: " user host
)))))
1112 (ange-ftp-set-passwd host user passwd
)
1115 ;;;; ------------------------------------------------------------
1116 ;;;; Account support
1117 ;;;; ------------------------------------------------------------
1119 ;; Account passwords must be either specified in the .netrc file, or set
1120 ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't
1121 ;; check to see whether the FTP process is actually prompting for an account
1124 (defun ange-ftp-set-account (host user account
)
1125 "For a given HOST and USER, set or change the associated ACCOUNT password."
1126 (interactive (list (read-string "Host: ")
1127 (read-string "User: ")
1128 (ange-ftp-read-passwd "Account password: ")))
1129 (ange-ftp-put-hash-entry (ange-ftp-generate-passwd-key host user
)
1131 ange-ftp-account-hashtable
))
1133 (defun ange-ftp-get-account (host user
)
1134 "Given a HOST and USER, return the FTP account."
1135 (ange-ftp-parse-netrc)
1136 (or (ange-ftp-get-hash-entry (ange-ftp-generate-passwd-key host user
)
1137 ange-ftp-account-hashtable
)
1138 (and (stringp ange-ftp-default-user
)
1139 (string-equal user ange-ftp-default-user
)
1140 ange-ftp-default-account
)
1141 (and (stringp ange-ftp-netrc-default-user
)
1142 (string-equal user ange-ftp-netrc-default-user
)
1143 ange-ftp-netrc-default-account
)))
1145 ;;;; ------------------------------------------------------------
1146 ;;;; ~/.netrc support
1147 ;;;; ------------------------------------------------------------
1149 (defun ange-ftp-chase-symlinks (file)
1150 "Return the filename that FILE references, following all symbolic links."
1152 (while (setq temp
(ange-ftp-real-file-symlink-p file
))
1154 (if (file-name-absolute-p temp
)
1156 (concat (file-name-directory file
) temp
)))))
1159 ;; Move along current line looking for the value of the TOKEN.
1160 ;; Valid separators between TOKEN and its value are commas and
1161 ;; whitespace. Second arg LIMIT is a limit for the search.
1163 (defun ange-ftp-parse-netrc-token (token limit
)
1164 (if (search-forward token limit t
)
1166 (skip-chars-forward ", \t\r\n" limit
)
1167 (if (eq (following-char) ?
\") ;quoted token value
1168 (progn (forward-char 1)
1170 (skip-chars-forward "^\"" limit
)
1172 (buffer-substring beg
(1- (point))))
1174 (skip-chars-forward "^, \t\r\n" limit
)
1175 (buffer-substring beg
(point))))))
1177 ;; Extract the values for the tokens `machine', `login',
1178 ;; `password' and `account' in the current buffer. If successful,
1179 ;; record the information found.
1181 (defun ange-ftp-parse-netrc-group ()
1182 (let ((start (point))
1183 (end (save-excursion
1184 (if (looking-at "machine\\>")
1185 ;; Skip `machine' and the machine name that follows.
1187 (skip-chars-forward "^ \t\n")
1188 (skip-chars-forward " \t\n")
1189 (skip-chars-forward "^ \t\n"))
1191 (skip-chars-forward "^ \t\n"))
1192 ;; Find start of the next `machine' or `default'
1193 ;; or the end of the buffer.
1194 (if (re-search-forward "machine\\>\\|default\\>" nil t
)
1197 machine login password account
)
1198 (setq machine
(ange-ftp-parse-netrc-token "machine" end
)
1199 login
(ange-ftp-parse-netrc-token "login" end
)
1200 password
(ange-ftp-parse-netrc-token "password" end
)
1201 account
(ange-ftp-parse-netrc-token "account" end
))
1202 (if (and machine login
)
1203 ;; found a `machine` token.
1205 (ange-ftp-set-user machine login
)
1206 (ange-ftp-set-passwd machine login password
)
1208 (ange-ftp-set-account machine login account
)))
1210 (if (search-forward "default" end t
)
1211 ;; found a `default' token
1213 (setq login
(ange-ftp-parse-netrc-token "login" end
)
1214 password
(ange-ftp-parse-netrc-token "password" end
)
1215 account
(ange-ftp-parse-netrc-token "account" end
))
1217 (setq ange-ftp-netrc-default-user login
))
1219 (setq ange-ftp-netrc-default-password password
))
1221 (setq ange-ftp-netrc-default-account account
)))))
1224 ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has
1225 ;; the correct permissions then extract the \`machine\', \`login\',
1226 ;; \`password\' and \`account\' information from within.
1228 (defun ange-ftp-parse-netrc ()
1229 ;; We set this before actually doing it to avoid the possibility
1230 ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file.
1233 (let ((default-directory "/"))
1234 (setq file
(ange-ftp-chase-symlinks
1235 (ange-ftp-real-expand-file-name ange-ftp-netrc-filename
)))
1236 (setq attr
(ange-ftp-real-file-attributes file
)))
1237 (if (and attr
; file exists.
1238 (not (equal (nth 5 attr
) ange-ftp-netrc-modtime
))) ; file changed
1240 (if (or ange-ftp-disable-netrc-security-check
1241 (and (eq (nth 2 attr
) (user-uid)) ; Same uids.
1242 (string-match ".r..------" (nth 8 attr
))))
1244 ;; we are cheating a bit here. I'm trying to do the equivalent
1245 ;; of find-file on the .netrc file, but then nuke it afterwards.
1246 ;; with the bit of logic below we should be able to have
1247 ;; encrypted .netrc files.
1248 (set-buffer (generate-new-buffer "*ftp-.netrc*"))
1249 (ange-ftp-real-insert-file-contents file
)
1250 (setq buffer-file-name file
)
1251 (setq default-directory
(file-name-directory file
))
1253 (mapcar 'funcall find-file-hooks
)
1254 (setq buffer-file-name nil
)
1255 (goto-char (point-min))
1256 (skip-chars-forward " \t\n")
1258 (ange-ftp-parse-netrc-group))
1259 (kill-buffer (current-buffer)))
1260 (ange-ftp-message "%s either not owned by you or badly protected."
1261 ange-ftp-netrc-filename
)
1263 (setq ange-ftp-netrc-modtime
(nth 5 attr
))))))
1265 ;; Return a list of prefixes of the form 'user@host:' to be used when
1266 ;; completion is done in the root directory.
1268 (defun ange-ftp-generate-root-prefixes ()
1269 (ange-ftp-parse-netrc)
1272 (ange-ftp-map-hashtable
1275 (if (string-match "^[^/]*\\(/\\).*$" key
)
1276 (let ((host (substring key
0 (match-beginning 1)))
1277 (user (substring key
(match-end 1))))
1278 (setq res
(cons (list (concat user
"@" host
":"))
1280 ange-ftp-passwd-hashtable
)
1281 (ange-ftp-map-hashtable
1282 (function (lambda (host user
)
1283 (setq res
(cons (list (concat host
":"))
1285 ange-ftp-user-hashtable
)
1286 (or res
(list nil
)))))
1288 ;;;; ------------------------------------------------------------
1289 ;;;; Remote file name syntax support.
1290 ;;;; ------------------------------------------------------------
1292 (defmacro ange-ftp-ftp-name-component
(n ns name
)
1293 "Extract the Nth ftp file name component from NS."
1294 (` (let ((elt (nth (, n
) (, ns
))))
1295 (if (match-beginning elt
)
1296 (substring (, name
) (match-beginning elt
) (match-end elt
))))))
1298 (defvar ange-ftp-ftp-name-arg
"")
1299 (defvar ange-ftp-ftp-name-res nil
)
1301 ;; Parse NAME according to `ange-ftp-name-format' (which see).
1302 ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format.
1303 (defun ange-ftp-ftp-name (name)
1304 (if (string-equal name ange-ftp-ftp-name-arg
)
1305 ange-ftp-ftp-name-res
1306 (setq ange-ftp-ftp-name-arg name
1307 ange-ftp-ftp-name-res
1309 (if (posix-string-match (car ange-ftp-name-format
) name
)
1310 (let* ((ns (cdr ange-ftp-name-format
))
1311 (host (ange-ftp-ftp-name-component 0 ns name
))
1312 (user (ange-ftp-ftp-name-component 1 ns name
))
1313 (name (ange-ftp-ftp-name-component 2 ns name
)))
1314 (if (zerop (length user
))
1315 (setq user
(ange-ftp-get-user host
)))
1316 (list host user name
))
1319 ;; Take a FULLNAME that matches according to ange-ftp-name-format and
1320 ;; replace the name component with NAME.
1321 (defun ange-ftp-replace-name-component (fullname name
)
1323 (if (posix-string-match (car ange-ftp-name-format
) fullname
)
1324 (let* ((ns (cdr ange-ftp-name-format
))
1326 (concat (substring fullname
0 (match-beginning elt
))
1328 (substring fullname
(match-end elt
)))))))
1330 ;;;; ------------------------------------------------------------
1331 ;;;; Miscellaneous utils.
1332 ;;;; ------------------------------------------------------------
1334 ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap))
1335 ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer)
1337 (defun ange-ftp-repaint-minibuffer ()
1338 "Clear any existing minibuffer message; let the minibuffer contents show."
1341 ;; Return the name of the buffer that collects output from the ftp process
1342 ;; connected to the given HOST and USER pair.
1343 (defun ange-ftp-ftp-process-buffer (host user
)
1344 (concat "*ftp " user
"@" host
"*"))
1346 ;; Display the last chunk of output from the ftp process for the given HOST
1347 ;; USER pair, and signal an error including MSG in the text.
1348 (defun ange-ftp-error (host user msg
)
1349 (let ((cur (selected-window))
1353 (ange-ftp-ftp-process-buffer host user
)))
1354 (goto-char (point-max))
1355 (select-window cur
))
1356 (signal 'ftp-error
(list (format "FTP Error: %s" msg
))))
1358 (defun ange-ftp-set-buffer-mode ()
1359 "Set correct modes for the current buffer if visiting a remote file."
1360 (if (and (stringp buffer-file-name
)
1361 (ange-ftp-ftp-name buffer-file-name
))
1362 (auto-save-mode ange-ftp-auto-save
)))
1364 (defun ange-ftp-kill-ftp-process (buffer)
1365 "Kill the FTP process associated with BUFFER.
1366 If the BUFFER's visited filename or default-directory is an ftp filename
1367 then kill the related ftp process."
1368 (interactive "bKill FTP process associated with buffer: ")
1370 (setq buffer
(current-buffer)))
1371 (let ((file (or (buffer-file-name) default-directory
)))
1373 (let ((parsed (ange-ftp-ftp-name (expand-file-name file
))))
1375 (let ((host (nth 0 parsed
))
1376 (user (nth 1 parsed
)))
1377 (kill-buffer (ange-ftp-ftp-process-buffer host user
))))))))
1379 (defun ange-ftp-quote-string (string)
1380 "Quote any characters in STRING that may confuse the ftp process."
1381 (apply (function concat
)
1384 (if (or (<= char ?
)
1392 (defun ange-ftp-barf-if-not-directory (directory)
1393 (or (file-directory-p directory
)
1395 (list "Opening directory"
1396 (if (file-exists-p directory
)
1398 "no such file or directory")
1401 ;;;; ------------------------------------------------------------
1402 ;;;; FTP process filter support.
1403 ;;;; ------------------------------------------------------------
1405 (defun ange-ftp-process-handle-line (line proc
)
1406 "Look at the given LINE from the ftp process PROC.
1407 Try to categorize it into one of four categories:
1408 good, skip, fatal, or unknown."
1409 (cond ((string-match ange-ftp-xfer-size-msgs line
)
1410 (setq ange-ftp-xfer-size
1411 (ash (string-to-int (substring line
1415 ((string-match ange-ftp-skip-msgs line
)
1417 ((string-match ange-ftp-good-msgs line
)
1418 (setq ange-ftp-process-busy nil
1419 ange-ftp-process-result t
1420 ange-ftp-process-result-line line
))
1421 ;; Check this before checking for errors.
1422 ;; Otherwise the last line of these three seems to be an error:
1423 ;; 230-see a significant impact from the move. For those of you who can't
1424 ;; 230-use DNS to resolve hostnames and get an error message like
1425 ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be...
1426 ((string-match ange-ftp-multi-msgs line
)
1427 (setq ange-ftp-process-multi-skip t
))
1428 ((string-match ange-ftp-fatal-msgs line
)
1429 (delete-process proc
)
1430 (setq ange-ftp-process-busy nil
1431 ange-ftp-process-result-line line
))
1432 (ange-ftp-process-multi-skip
1435 (setq ange-ftp-process-busy nil
1436 ange-ftp-process-result-line line
))))
1438 (defun ange-ftp-set-xfer-size (host user bytes
)
1439 "Set the size of the next FTP transfer in bytes."
1440 (let ((proc (ange-ftp-get-process host user
)))
1442 (let ((buf (process-buffer proc
)))
1446 (setq ange-ftp-xfer-size
(ash bytes -
10))))))))
1448 (defun ange-ftp-process-handle-hash (str)
1449 "Remove hash marks from STRING and display count so far."
1450 (setq str
(concat (substring str
0 (match-beginning 0))
1451 (substring str
(match-end 0)))
1452 ange-ftp-hash-mark-count
(+ (- (match-end 0)
1453 (match-beginning 0))
1454 ange-ftp-hash-mark-count
))
1455 (and ange-ftp-hash-mark-unit
1456 ange-ftp-process-msg
1457 ange-ftp-process-verbose
1458 (not (eq (selected-window) (minibuffer-window)))
1459 (not (boundp 'search-message
)) ;screws up isearch otherwise
1460 (not cursor-in-echo-area
) ;screws up y-or-n-p otherwise
1461 (let ((kbytes (ash (* ange-ftp-hash-mark-unit
1462 ange-ftp-hash-mark-count
)
1464 (if (zerop ange-ftp-xfer-size
)
1465 (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes
)
1466 (let ((percent (/ (* 100 kbytes
) ange-ftp-xfer-size
)))
1467 ;; cut out the redisplay of identical %-age messages.
1468 (if (not (eq percent ange-ftp-last-percent
))
1470 (setq ange-ftp-last-percent percent
)
1471 (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent
)))))))
1474 ;; Call the function specified by CONT. CONT can be either a function
1475 ;; or a list of a function and some args. The first two parameters
1476 ;; passed to the function will be RESULT and LINE. The remaining args
1477 ;; will be taken from CONT if a list was passed.
1479 (defun ange-ftp-call-cont (cont result line
)
1481 (if (and (listp cont
)
1482 (not (eq (car cont
) 'lambda
)))
1483 (apply (car cont
) result line
(cdr cont
))
1484 (funcall cont result line
))))
1486 ;; Build up a complete line of output from the ftp PROCESS and pass it
1487 ;; on to ange-ftp-process-handle-line to deal with.
1489 (defun ange-ftp-process-filter (proc str
)
1490 (let ((buffer (process-buffer proc
))
1491 (old-buffer (current-buffer)))
1493 ;; see if the buffer is still around... it could have been deleted.
1494 (if (buffer-name buffer
)
1497 (set-buffer (process-buffer proc
))
1499 ;; handle hash mark printing
1500 (and ange-ftp-process-busy
1501 (string-match "^#+$" str
)
1502 (setq str
(ange-ftp-process-handle-hash str
)))
1503 (comint-output-filter proc str
)
1504 ;; Replace STR by the result of the comint processing.
1505 (setq str
(buffer-substring comint-last-output-start
1506 (process-mark proc
)))
1507 (if ange-ftp-process-busy
1509 (setq ange-ftp-process-string
(concat ange-ftp-process-string
1512 ;; if we gave an empty password to the USER command earlier
1513 ;; then we should send a null password now.
1514 (if (string-match "Password: *$" ange-ftp-process-string
)
1515 (send-string proc
"\n"))))
1516 (while (and ange-ftp-process-busy
1517 (string-match "\n" ange-ftp-process-string
))
1518 (let ((line (substring ange-ftp-process-string
1520 (match-beginning 0))))
1521 (setq ange-ftp-process-string
(substring ange-ftp-process-string
1523 (while (string-match "^ftp> *" line
)
1524 (setq line
(substring line
(match-end 0))))
1525 (ange-ftp-process-handle-line line proc
)))
1527 ;; has the ftp client finished? if so then do some clean-up
1529 (if (not ange-ftp-process-busy
)
1531 ;; reset the xfer size
1532 (setq ange-ftp-xfer-size
0)
1534 ;; issue the "done" message since we've finished.
1535 (if (and ange-ftp-process-msg
1536 ange-ftp-process-verbose
1537 ange-ftp-process-result
)
1539 (ange-ftp-message "%s...done" ange-ftp-process-msg
)
1540 (ange-ftp-repaint-minibuffer)
1541 (setq ange-ftp-process-msg nil
)))
1543 ;; is there a continuation we should be calling? if so,
1544 ;; we'd better call it, making sure we only call it once.
1545 (if ange-ftp-process-continue
1546 (let ((cont ange-ftp-process-continue
))
1547 (setq ange-ftp-process-continue nil
)
1548 (ange-ftp-call-cont cont
1549 ange-ftp-process-result
1550 ange-ftp-process-result-line
))))))
1551 (set-buffer old-buffer
)))))
1553 (defun ange-ftp-process-sentinel (proc str
)
1554 "When ftp process changes state, nuke all file-entries in cache."
1555 (let ((name (process-name proc
)))
1556 (if (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name
)
1557 (let ((user (substring name
(match-beginning 1) (match-end 1)))
1558 (host (substring name
(match-beginning 2) (match-end 2))))
1559 (ange-ftp-wipe-file-entries host user
))))
1560 (setq ange-ftp-ls-cache-file nil
))
1562 ;;;; ------------------------------------------------------------
1563 ;;;; Gateway support.
1564 ;;;; ------------------------------------------------------------
1566 (defun ange-ftp-use-gateway-p (host)
1567 "Returns whether to access this host via a normal (non-smart) gateway."
1568 ;; yes, I know that I could simplify the following expression, but it is
1569 ;; clearer (to me at least) this way.
1570 (and (not ange-ftp-smart-gateway
)
1572 (not (string-match ange-ftp-local-host-regexp host
)))))
1574 (defun ange-ftp-use-smart-gateway-p (host)
1575 "Returns whether to access this host via a smart gateway."
1576 (and ange-ftp-smart-gateway
1578 (not (string-match ange-ftp-local-host-regexp host
)))))
1581 ;;; ------------------------------------------------------------
1582 ;;; Temporary file location and deletion...
1583 ;;; ------------------------------------------------------------
1585 (defvar ange-ftp-tmp-name-files
())
1586 (defvar ange-ftp-tmp-name-hashtable
(ange-ftp-make-hashtable 10))
1587 (defvar ange-ftp-pid nil
)
1589 (defun ange-ftp-get-pid ()
1590 "Half-hearted attempt to get the current process's id."
1591 (setq ange-ftp-pid
(substring (make-temp-name "") 1)))
1593 (defun ange-ftp-make-tmp-name (host)
1594 "This routine will return the name of a new file."
1595 (let* ((template (if (ange-ftp-use-gateway-p host
)
1596 ange-ftp-gateway-tmp-name-template
1597 ange-ftp-tmp-name-template
))
1598 (pid (or ange-ftp-pid
(ange-ftp-get-pid)))
1603 (setq file
(format "%s%c%s" template start pid
))
1604 (setq entry
(intern file ange-ftp-tmp-name-hashtable
))
1605 (or (memq entry ange-ftp-tmp-name-files
)
1606 (ange-ftp-real-file-exists-p file
)))
1607 (if (> (setq start
(1+ start
)) ?z
)
1609 (setq template
(concat template
"X"))
1611 (setq ange-ftp-tmp-name-files
1612 (cons entry ange-ftp-tmp-name-files
))
1615 (defun ange-ftp-del-tmp-name (temp)
1616 (setq ange-ftp-tmp-name-files
1617 (delq (intern temp ange-ftp-tmp-name-hashtable
)
1618 ange-ftp-tmp-name-files
))
1620 (ange-ftp-real-delete-file temp
)
1623 ;;;; ------------------------------------------------------------
1624 ;;;; Interactive gateway program support.
1625 ;;;; ------------------------------------------------------------
1627 (defvar ange-ftp-gwp-running t
)
1628 (defvar ange-ftp-gwp-status nil
)
1630 (defun ange-ftp-gwp-sentinel (proc str
)
1631 (setq ange-ftp-gwp-running nil
))
1633 (defun ange-ftp-gwp-filter (proc str
)
1634 (comint-output-filter proc str
)
1636 (set-buffer (process-buffer proc
))
1637 ;; Replace STR by the result of the comint processing.
1638 (setq str
(buffer-substring comint-last-output-start
(process-mark proc
))))
1639 (cond ((string-match "login: *$" str
)
1642 (let ((ange-ftp-default-user t
))
1643 (ange-ftp-get-user ange-ftp-gateway-host
))
1645 ((string-match "Password: *$" str
)
1648 (ange-ftp-get-passwd ange-ftp-gateway-host
1650 ange-ftp-gateway-host
))
1652 ((string-match ange-ftp-gateway-fatal-msgs str
)
1653 (delete-process proc
)
1654 (setq ange-ftp-gwp-running nil
))
1655 ((string-match ange-ftp-gateway-prompt-pattern str
)
1656 (setq ange-ftp-gwp-running nil
1657 ange-ftp-gwp-status t
))))
1659 (defun ange-ftp-gwp-start (host user name args
)
1660 "Login to the gateway machine and fire up an ftp process."
1661 (let* ((gw-user (ange-ftp-get-user ange-ftp-gateway-host
))
1662 ;; It would be nice to make process-connection-type nil,
1663 ;; but that doesn't work: ftp never responds.
1664 ;; Can anyone find a fix for that?
1665 (proc (let ((process-connection-type t
))
1666 (start-process name name
1667 ange-ftp-gateway-program
1668 ange-ftp-gateway-host
)))
1669 (ftp (mapconcat (function identity
) args
" ")))
1670 (process-kill-without-query proc
)
1671 (set-process-sentinel proc
(function ange-ftp-gwp-sentinel
))
1672 (set-process-filter proc
(function ange-ftp-gwp-filter
))
1674 (set-buffer (process-buffer proc
))
1675 (internal-ange-ftp-mode)
1676 (set-marker (process-mark proc
) (point)))
1677 (setq ange-ftp-gwp-running t
1678 ange-ftp-gwp-status nil
)
1679 (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host
)
1680 (while ange-ftp-gwp-running
;perform login sequence
1681 (accept-process-output proc
))
1682 (if (not ange-ftp-gwp-status
)
1683 (ange-ftp-error host user
"unable to login to gateway"))
1684 (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host
)
1685 (setq ange-ftp-gwp-running t
1686 ange-ftp-gwp-status nil
)
1687 (process-send-string proc ange-ftp-gateway-setup-term-command
)
1688 (while ange-ftp-gwp-running
;zap ^M's and double echoing.
1689 (accept-process-output proc
))
1690 (if (not ange-ftp-gwp-status
)
1691 (ange-ftp-error host user
"unable to set terminal modes on gateway"))
1692 (setq ange-ftp-gwp-running t
1693 ange-ftp-gwp-status nil
)
1694 (process-send-string proc
(concat "exec " ftp
"\n")) ;spawn ftp process
1697 ;;;; ------------------------------------------------------------
1698 ;;;; Support for sending commands to the ftp process.
1699 ;;;; ------------------------------------------------------------
1701 (defun ange-ftp-raw-send-cmd (proc cmd
&optional msg cont nowait
)
1702 "Low-level routine to send the given ftp CMD to the ftp PROCESS.
1703 MSG is an optional message to output before and after the command.
1704 If CONT is non-NIL then it is either a function or a list of function and
1705 some arguments. The function will be called when the ftp command has completed.
1706 If CONT is NIL then this routine will return \( RESULT . LINE \) where RESULT
1707 is whether the command was successful, and LINE is the line from the FTP
1708 process that caused the command to complete.
1709 If NOWAIT is given then the routine will return immediately the command has
1710 been queued with no result. CONT will still be called, however."
1711 (if (memq (process-status proc
) '(run open
))
1713 (set-buffer (process-buffer proc
))
1714 (while ange-ftp-process-busy
1715 ;; This is a kludge to let user quit in case ftp gets hung.
1716 ;; It matters because this function can be called from the filter.
1717 ;; It is bad to allow quitting in a filter, but getting hung
1718 ;; is worse. By binding quit-flag to nil, we might avoid
1719 ;; most of the probability of getting screwed because the user
1720 ;; wants to quit some command.
1721 (let ((quit-flag nil
)
1723 (accept-process-output)))
1724 (setq ange-ftp-process-string
""
1725 ange-ftp-process-result-line
""
1726 ange-ftp-process-busy t
1727 ange-ftp-process-result nil
1728 ange-ftp-process-multi-skip nil
1729 ange-ftp-process-msg msg
1730 ange-ftp-process-continue cont
1731 ange-ftp-hash-mark-count
0
1732 ange-ftp-last-percent -
1
1733 cmd
(concat cmd
"\n"))
1734 (and msg ange-ftp-process-verbose
(ange-ftp-message "%s..." msg
))
1735 (goto-char (point-max))
1736 (move-marker comint-last-input-start
(point))
1737 ;; don't insert the password into the buffer on the USER command.
1739 (if (string-match "^user \"[^\"]*\"" cmd
)
1740 (insert (substring cmd
0 (match-end 0)) " Turtle Power!\n")
1742 (move-marker comint-last-input-end
(point))
1743 (send-string proc cmd
)
1744 (set-marker (process-mark proc
) (point))
1747 ;; hang around for command to complete
1748 (while ange-ftp-process-busy
1749 ;; This is a kludge to let user quit in case ftp gets hung.
1750 ;; It matters because this function can be called from the filter.
1751 (let ((quit-flag nil
)
1753 (accept-process-output proc
)))
1755 nil
;cont has already been called
1756 (cons ange-ftp-process-result ange-ftp-process-result-line
))))))
1758 (defun ange-ftp-nslookup-host (host)
1759 "Attempt to resolve the given HOSTNAME using nslookup if possible."
1760 (interactive "sHost: ")
1761 (if ange-ftp-nslookup-program
1762 (let ((default-directory
1763 (if (file-accessible-directory-p default-directory
)
1766 ;; It would be nice to make process-connection-type nil,
1767 ;; but that doesn't work: ftp never responds.
1768 ;; Can anyone find a fix for that?
1769 (proc (let ((process-connection-type t
))
1770 (start-process " *nslookup*" " *nslookup*"
1771 ange-ftp-nslookup-program host
)))
1773 (process-kill-without-query proc
)
1775 (set-buffer (process-buffer proc
))
1776 (while (memq (process-status proc
) '(run open
))
1777 (accept-process-output proc
))
1778 (goto-char (point-min))
1779 (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t
)
1780 (setq res
(buffer-substring (match-beginning 1)
1782 (kill-buffer (current-buffer)))
1786 (defun ange-ftp-start-process (host user name
)
1787 "Spawn a new ftp process ready to connect to machine HOST and give it NAME.
1788 If HOST is only ftp-able through a gateway machine then spawn a shell
1789 on the gateway machine to do the ftp instead."
1790 (let* ((use-gateway (ange-ftp-use-gateway-p host
))
1791 (use-smart-ftp (and (not ange-ftp-gateway-host
)
1792 (ange-ftp-use-smart-gateway-p host
)))
1793 (ftp-prog (if (or use-gateway
1795 ange-ftp-gateway-ftp-program-name
1796 ange-ftp-ftp-program-name
))
1797 (args (append (list ftp-prog
) ange-ftp-ftp-program-args
))
1798 ;; Without the following binding, ange-ftp-start-process
1799 ;; recurses on file-accessible-directory-p, since it needs to
1800 ;; restart its process in order to determine anything about
1801 ;; default-directory.
1802 (file-name-handler-alist)
1804 (if (file-accessible-directory-p default-directory
)
1808 ;; It would be nice to make process-connection-type nil,
1809 ;; but that doesn't work: ftp never responds.
1810 ;; Can anyone find a fix for that?
1811 (let ((process-connection-type t
)
1812 (process-environment process-environment
))
1813 ;; This tells GNU ftp not to output any fancy escape sequences.
1814 (setenv "TERM" "dumb")
1816 (if ange-ftp-gateway-program-interactive
1817 (setq proc
(ange-ftp-gwp-start host user name args
))
1818 (setq proc
(apply 'start-process name name
1819 (append (list ange-ftp-gateway-program
1820 ange-ftp-gateway-host
)
1822 (setq proc
(apply 'start-process name name args
))))
1823 (process-kill-without-query proc
)
1825 (set-buffer (process-buffer proc
))
1826 (internal-ange-ftp-mode))
1827 (set-process-sentinel proc
(function ange-ftp-process-sentinel
))
1828 (set-process-filter proc
(function ange-ftp-process-filter
))
1829 (accept-process-output proc
) ;wait for ftp startup message
1832 (defun internal-ange-ftp-mode ()
1833 "Major mode for interacting with the FTP process.
1835 \\{comint-mode-map}"
1838 (setq major-mode
'internal-ange-ftp-mode
)
1839 (setq mode-name
"Internal Ange-ftp")
1840 (let ((proc (get-buffer-process (current-buffer))))
1841 (goto-char (point-max))
1842 (set-marker (process-mark proc
) (point))
1843 (make-local-variable 'ange-ftp-process-string
)
1844 (setq ange-ftp-process-string
"")
1845 (make-local-variable 'ange-ftp-process-busy
)
1846 (make-local-variable 'ange-ftp-process-result
)
1847 (make-local-variable 'ange-ftp-process-msg
)
1848 (make-local-variable 'ange-ftp-process-multi-skip
)
1849 (make-local-variable 'ange-ftp-process-result-line
)
1850 (make-local-variable 'ange-ftp-process-continue
)
1851 (make-local-variable 'ange-ftp-hash-mark-count
)
1852 (make-local-variable 'ange-ftp-binary-hash-mark-size
)
1853 (make-local-variable 'ange-ftp-ascii-hash-mark-size
)
1854 (make-local-variable 'ange-ftp-hash-mark-unit
)
1855 (make-local-variable 'ange-ftp-xfer-size
)
1856 (make-local-variable 'ange-ftp-last-percent
)
1857 (setq ange-ftp-hash-mark-count
0)
1858 (setq ange-ftp-xfer-size
0)
1859 (setq ange-ftp-process-result-line
"")
1861 (setq comint-prompt-regexp
"^ftp> ")
1862 (make-local-variable 'comint-password-prompt-regexp
)
1863 ;; This is a regexp that can't match anything.
1864 ;; ange-ftp has its own ways of handling passwords.
1865 (setq comint-password-prompt-regexp
"^a\\'z")
1866 (make-local-variable 'paragraph-start
)
1867 (setq paragraph-start comint-prompt-regexp
)))
1869 (defun ange-ftp-smart-login (host user pass account proc
)
1870 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1871 PROC is the FTP-client's process. This routine uses the smart-gateway
1872 host specified in ``ange-ftp-gateway-host''."
1873 (let ((result (ange-ftp-raw-send-cmd
1875 (format "open %s %s"
1876 (ange-ftp-nslookup-host ange-ftp-gateway-host
)
1877 ange-ftp-smart-gateway-port
)
1878 (format "Opening FTP connection to %s via %s"
1880 ange-ftp-gateway-host
))))
1882 (ange-ftp-error host user
1883 (concat "OPEN request failed: "
1885 (setq result
(ange-ftp-raw-send-cmd
1886 proc
(format "user \"%s\"@%s %s %s"
1888 (ange-ftp-nslookup-host host
)
1891 (format "Logging in as user %s@%s"
1895 (ange-ftp-set-passwd host user nil
) ; reset password
1896 (ange-ftp-set-account host user nil
) ; reset account
1897 (ange-ftp-error host user
1898 (concat "USER request failed: "
1901 (defun ange-ftp-normal-login (host user pass account proc
)
1902 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
1903 PROC is the process to the FTP-client."
1904 (let* ((nshost (ange-ftp-nslookup-host host
))
1905 (result (ange-ftp-raw-send-cmd
1907 (format "open %s" nshost
)
1908 (format "Opening FTP connection to %s" host
))))
1910 (ange-ftp-error host user
1911 (concat "OPEN request failed: "
1913 (setq result
(ange-ftp-raw-send-cmd
1915 (if (ange-ftp-use-smart-gateway-p host
)
1916 (format "user \"%s\"@%s %s %s" user nshost pass account
)
1917 (format "user \"%s\" %s %s" user pass account
))
1918 (format "Logging in as user %s@%s" user host
)))
1921 (ange-ftp-set-passwd host user nil
) ;reset password.
1922 (ange-ftp-set-account host user nil
) ;reset account.
1923 (ange-ftp-error host user
1924 (concat "USER request failed: "
1927 ;; ange@hplb.hpl.hp.com says this should not be changed.
1928 (defvar ange-ftp-hash-mark-msgs
1929 "[hH]ash mark [^0-9]*\\([0-9]+\\)"
1930 "*Regexp matching the FTP client's output upon doing a HASH command.")
1932 (defun ange-ftp-guess-hash-mark-size (proc)
1933 (if ange-ftp-send-hash
1935 (set-buffer (process-buffer proc
))
1936 (let* ((status (ange-ftp-raw-send-cmd proc
"hash"))
1937 (result (car status
))
1938 (line (cdr status
)))
1940 (if (string-match ange-ftp-hash-mark-msgs line
)
1941 (let ((size (string-to-int
1945 (setq ange-ftp-ascii-hash-mark-size size
1946 ange-ftp-hash-mark-unit
(ash size -
4))
1948 ;; if a default value for this is set, use that value.
1949 (or ange-ftp-binary-hash-mark-size
1950 (setq ange-ftp-binary-hash-mark-size size
)))))))))
1952 (defun ange-ftp-get-process (host user
)
1953 "Return an FTP subprocess connected to HOST and logged in as USER.
1954 Create a new process if needed."
1955 (let* ((name (ange-ftp-ftp-process-buffer host user
))
1956 (proc (get-process name
)))
1957 (if (and proc
(memq (process-status proc
) '(run open
)))
1959 (let ((pass (ange-ftp-quote-string
1960 (ange-ftp-get-passwd host user
)))
1961 (account (ange-ftp-quote-string
1962 (ange-ftp-get-account host user
))))
1963 ;; grab a suitable process.
1964 (setq proc
(ange-ftp-start-process host user name
))
1966 ;; login to FTP server.
1967 (if (and (ange-ftp-use-smart-gateway-p host
)
1968 ange-ftp-gateway-host
)
1969 (ange-ftp-smart-login host user pass account proc
)
1970 (ange-ftp-normal-login host user pass account proc
))
1972 ;; Tell client to send back hash-marks as progress. It isn't usually
1973 ;; fatal if this command fails.
1974 (ange-ftp-guess-hash-mark-size proc
)
1976 ;; Guess at the host type.
1977 (ange-ftp-guess-host-type host user
)
1979 ;; Run any user-specified hooks. Note that proc, host and user are
1980 ;; dynamically bound at this point.
1981 (run-hooks 'ange-ftp-process-startup-hook
))
1984 ;; Variables for caching host and host-type
1985 (defvar ange-ftp-host-cache nil
)
1986 (defvar ange-ftp-host-type-cache nil
)
1988 ;; If ange-ftp-host-type is called with the optional user
1989 ;; argument, it will attempt to guess the host type by connecting
1990 ;; as user, if necessary. For efficiency, I have tried to give this
1991 ;; optional second argument only when necessary. Have I missed any calls
1992 ;; to ange-ftp-host-type where it should have been supplied?
1994 (defun ange-ftp-host-type (host &optional user
)
1995 "Return a symbol which represents the type of the HOST given.
1996 If the optional argument USER is given, attempts to guess the
1997 host-type by logging in as USER."
1998 (if (eq host ange-ftp-host-cache
)
1999 ange-ftp-host-type-cache
2000 ;; Trigger an ftp connection, in case we need to guess at the host type.
2001 (if (and user
(ange-ftp-get-process host user
) (eq host ange-ftp-host-cache
))
2002 ange-ftp-host-type-cache
2003 (setq ange-ftp-host-cache host
2004 ange-ftp-host-type-cache
2005 (cond ((ange-ftp-dumb-unix-host host
)
2007 ;; ((and (fboundp 'ange-ftp-vos-host)
2008 ;; (ange-ftp-vos-host host))
2010 ((and (fboundp 'ange-ftp-vms-host
)
2011 (ange-ftp-vms-host host
))
2013 ((and (fboundp 'ange-ftp-mts-host
)
2014 (ange-ftp-mts-host host
))
2016 ((and (fboundp 'ange-ftp-cms-host
)
2017 (ange-ftp-cms-host host
))
2022 ;; It would be nice to abstract the functions ange-ftp-TYPE-host and
2023 ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions
2024 ;; without sacrificing speed. Also, having separate variables
2025 ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to
2026 ;; set an alist to indicate that a host is of a given type. Even with
2027 ;; automatic host type recognition, setting a regexp is still a good idea
2028 ;; (for efficiency) if you log into a particular non-UNIX host frequently.
2030 (defvar ange-ftp-fix-name-func-alist nil
2031 "Alist saying how to convert file name to the host's syntax.
2032 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2033 which can change a UNIX file name into a name more suitable for a host of type
2036 (defvar ange-ftp-fix-dir-name-func-alist nil
2037 "Alist saying how to convert directory name to the host's syntax.
2038 Association list of \( TYPE \. FUNC \) pairs, where FUNC is a routine
2039 which can change UNIX directory name into a directory name more suitable
2040 for a host of type TYPE.")
2042 ;; *** Perhaps the sense of this variable should be inverted, since there
2043 ;; *** is only 1 host type that can take ls-style listing options.
2044 (defvar ange-ftp-dumb-host-types
'(dumb-unix)
2045 "List of host types that can't take UNIX ls-style listing options.")
2047 (defun ange-ftp-send-cmd (host user cmd
&optional msg cont nowait
)
2048 "Find an ftp process connected to HOST logged in as USER and send it CMD.
2049 MSG is an optional status message to be output before and after issuing the
2051 See the documentation for ange-ftp-raw-send-cmd for a description of CONT
2053 ;; Handle conversion to remote file name syntax and remote ls option
2055 (let ((cmd0 (car cmd
))
2057 (ange-ftp-this-user user
)
2058 (ange-ftp-this-host host
)
2059 (ange-ftp-this-msg msg
)
2060 cmd2 cmd3 host-type fix-name-func
)
2064 ;; pwd case (We don't care what host-type.)
2067 ;; cmd == 'dir "remote-name" "local-name" "ls-switches"
2069 (setq cmd2
(nth 2 cmd
)
2070 host-type
(ange-ftp-host-type host user
))
2071 ;; This will trigger an FTP login, if one doesn't exist
2074 (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist
))
2078 ;; Need to deal with the HP-UX ftp bug. This should also allow
2079 ;; us to resolve symlinks to directories on SysV machines. (Sebastian will
2081 (and (eq host-type
'unix
)
2082 (string-match "/$" cmd1
)
2083 (not (string-match "R" cmd3
))
2084 (setq cmd1
(concat cmd1
".")))
2085 ;; If the remote ls can take switches, put them in
2086 (or (memq host-type ange-ftp-dumb-host-types
)
2088 cmd1
(format "\"%s %s\"" cmd3 cmd1
))))
2090 ;; First argument is the remote name
2092 (setq fix-name-func
(or (cdr (assq host-type
2093 ange-ftp-fix-name-func-alist
))
2095 (memq cmd0
'(get delete mkdir rmdir cd
)))
2096 (setq cmd1
(funcall fix-name-func cmd1
)))
2098 ;; Second argument is the remote name
2099 ((memq cmd0
'(append put chmod
))
2100 (setq cmd2
(funcall fix-name-func cmd2
)))
2102 ;; Both arguments are remote names
2104 (setq cmd1
(funcall fix-name-func cmd1
)
2105 cmd2
(funcall fix-name-func cmd2
))))
2107 ;; Turn the command into one long string
2108 (setq cmd0
(symbol-name cmd0
))
2109 (setq cmd
(concat cmd0
2110 (and cmd1
(concat " " cmd1
))
2111 (and cmd2
(concat " " cmd2
))))
2113 ;; Actually send the resulting command.
2116 (ange-ftp-raw-send-cmd
2117 (ange-ftp-get-process host user
)
2121 (function (lambda (result line host user
2122 cmd msg cont nowait
)
2124 (setq afsc-result result
2127 (ange-ftp-call-cont cont result line
)
2128 (ange-ftp-raw-send-cmd
2129 (ange-ftp-get-process host user
)
2133 (function (lambda (result line cont
)
2135 (setq afsc-result result
2137 (ange-ftp-call-cont cont result line
)))
2140 host user cmd msg cont nowait
)
2147 (cons afsc-result afsc-line
))))))
2149 ;; It might be nice to message users about the host type identified,
2150 ;; but there is so much other messaging going on, it would not be
2151 ;; seen. No point in slowing things down just so users can read
2152 ;; a host type message.
2154 (defconst ange-ftp-cms-name-template
2156 "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?"
2157 "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$"))
2158 (defconst ange-ftp-vms-name-template
2159 "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$")
2160 (defconst ange-ftp-mts-name-template
2161 "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$")
2163 (defun ange-ftp-guess-host-type (host user
)
2164 "Guess at the the host type of HOST.
2165 Works by doing a pwd and examining the directory syntax."
2166 (let ((host-type (ange-ftp-host-type host
))
2167 (key (concat host
"/" user
"/~")))
2168 (if (eq host-type
'unix
)
2169 ;; Note that ange-ftp-host-type returns unix as the default value.
2171 (let* ((result (ange-ftp-get-pwd host user
))
2175 (message "Warning! Unable to get home directory")
2178 "^450 No current working directory defined$"
2181 ;; We'll assume that if pwd bombs with this
2182 ;; error message, then it's CMS.
2184 (ange-ftp-add-cms-host host
)
2185 (setq ange-ftp-host-cache host
2186 ange-ftp-host-type-cache
'cms
))))
2189 ((string-match ange-ftp-vms-name-template dir
)
2190 (ange-ftp-add-vms-host host
)
2191 ;; The add-host functions clear the host type cache.
2192 ;; Therefore, need to set the cache afterwards.
2193 (setq ange-ftp-host-cache host
2194 ange-ftp-host-type-cache
'vms
))
2197 ((string-match ange-ftp-mts-name-template dir
)
2198 (ange-ftp-add-mts-host host
)
2199 (setq ange-ftp-host-cache host
2200 ange-ftp-host-type-cache
'mts
))
2203 ((string-match ange-ftp-cms-name-template dir
)
2204 (ange-ftp-add-cms-host host
)
2205 (setq ange-ftp-host-cache host
2206 ange-ftp-host-type-cache
'cms
))
2210 (setq ange-ftp-host-cache host
2211 ange-ftp-host-type-cache
'unix
)))
2213 ;; Now that we have done a pwd, might as well put it in
2214 ;; the expand-dir hashtable.
2215 (let ((ange-ftp-this-user user
)
2216 (ange-ftp-this-host host
))
2217 (setq fix-name-func
(cdr (assq ange-ftp-host-type-cache
2218 ange-ftp-fix-name-func-alist
)))
2220 (setq dir
(funcall fix-name-func dir
'reverse
))))
2221 (ange-ftp-put-hash-entry key dir
2222 ange-ftp-expand-dir-hashtable
))))
2224 ;; In the special case of CMS make sure that know the
2225 ;; expansion of the home minidisk now, because we will
2226 ;; be doing a lot of cd's.
2227 (if (and (eq host-type
'cms
)
2228 (not (ange-ftp-hash-entry-exists-p
2229 key ange-ftp-expand-dir-hashtable
)))
2230 (let ((dir (car (ange-ftp-get-pwd host user
))))
2232 (ange-ftp-put-hash-entry key
(concat "/" dir
)
2233 ange-ftp-expand-dir-hashtable
)
2234 (message "Warning! Unable to get home directory")
2238 ;;;; ------------------------------------------------------------
2239 ;;;; Remote file and directory listing support.
2240 ;;;; ------------------------------------------------------------
2242 ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands
2243 ;; to take switch arguments.
2244 (defun ange-ftp-dumb-unix-host (host)
2245 (and host ange-ftp-dumb-unix-host-regexp
2247 (string-match ange-ftp-dumb-unix-host-regexp host
))))
2249 (defun ange-ftp-add-dumb-unix-host (host)
2250 "Interactively adds a given HOST to ange-ftp-dumb-unix-host-regexp."
2252 (list (read-string "Host: "
2253 (let ((name (or (buffer-file-name) default-directory
)))
2254 (and name
(car (ange-ftp-ftp-name name
)))))))
2255 (if (not (ange-ftp-dumb-unix-host host
))
2256 (setq ange-ftp-dumb-unix-host-regexp
2257 (concat "^" (regexp-quote host
) "$"
2258 (and ange-ftp-dumb-unix-host-regexp
"\\|")
2259 ange-ftp-dumb-unix-host-regexp
)
2260 ange-ftp-host-cache nil
)))
2262 (defvar ange-ftp-parse-list-func-alist nil
2263 "Alist saying how to parse directory listings for certain OS types.
2264 Association list of \( TYPE \. FUNC \) pairs. The FUNC is a routine
2265 which can parse the output from a DIR listing for a host of type TYPE.")
2267 ;; With no-error nil, this function returns:
2268 ;; an error if file is not an ange-ftp-name
2269 ;; (This should never happen.)
2270 ;; an error if either the listing is unreadable or there is an ftp error.
2271 ;; the listing (a string), if everything works.
2273 ;; With no-error t, it returns:
2274 ;; an error if not an ange-ftp-name
2275 ;; error if listing is unreadable (most likely caused by a slow connection)
2276 ;; nil if ftp error (this is because although asking to list a nonexistent
2277 ;; directory on a remote unix machine usually (except
2278 ;; maybe for dumb hosts) returns an ls error, but no
2279 ;; ftp error, if the same is done on a VMS machine,
2280 ;; an ftp error is returned. Need to trap the error
2281 ;; so we can go on and try to list the parent.)
2282 ;; the listing, if everything works.
2284 ;; If WILDCARD is non-nil, then this implements the guts of insert-directory
2285 ;; in the wildcard case. Then we make a relative directory listing
2286 ;; of FILE within the directory specified by `default-directory'.
2288 (defun ange-ftp-ls (file lsargs parse
&optional no-error wildcard
)
2289 "Return the output of an `DIR' or `ls' command done over ftp.
2290 FILE is the full name of the remote file, LSARGS is any args to pass to the
2291 `ls' command, and PARSE specifies that the output should be parsed and stored
2292 away in the internal cache."
2293 ;; If parse is t, we assume that file is a directory. i.e. we only parse
2294 ;; full directory listings.
2295 (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file
))
2296 (parsed (ange-ftp-ftp-name ange-ftp-this-file
)))
2298 (let* ((host (nth 0 parsed
))
2299 (user (nth 1 parsed
))
2300 (name (ange-ftp-quote-string (nth 2 parsed
)))
2301 (key (directory-file-name ange-ftp-this-file
))
2302 (host-type (ange-ftp-host-type host user
))
2303 (dumb (memq host-type ange-ftp-dumb-host-types
))
2307 (if (string-equal name
"")
2309 (ange-ftp-real-file-name-as-directory
2310 (ange-ftp-expand-dir host user
"~"))))
2311 (if (and ange-ftp-ls-cache-file
2312 (string-equal key ange-ftp-ls-cache-file
)
2313 ;; Don't care about lsargs for dumb hosts.
2314 (or dumb
(string-equal lsargs ange-ftp-ls-cache-lsargs
)))
2315 ange-ftp-ls-cache-res
2316 (setq temp
(ange-ftp-make-tmp-name host
))
2319 (ange-ftp-cd host user
(file-name-directory name
))
2320 (setq lscmd
(list 'dir file temp lsargs
)))
2321 (setq lscmd
(list 'dir name temp lsargs
)))
2323 (if (car (setq result
(ange-ftp-send-cmd
2327 (format "Listing %s"
2328 (ange-ftp-abbreviate-filename
2329 ange-ftp-this-file
)))))
2331 (set-buffer (get-buffer-create
2332 ange-ftp-data-buffer-name
))
2334 (if (ange-ftp-real-file-readable-p temp
)
2335 (ange-ftp-real-insert-file-contents temp
)
2336 (sleep-for ange-ftp-retry-time
)
2337 ;wait for file to possibly appear
2338 (if (ange-ftp-real-file-readable-p temp
)
2340 (ange-ftp-real-insert-file-contents temp
)
2341 (ange-ftp-error host user
2343 "list data file %s not readable"
2350 (cdr (assq host-type
2351 ange-ftp-parse-list-func-alist
)))
2352 (funcall parse-func
)
2353 (ange-ftp-parse-dired-listing lsargs
))))
2354 (setq ange-ftp-ls-cache-file key
2355 ange-ftp-ls-cache-lsargs lsargs
2356 ; For dumb hosts-types this is
2357 ; meaningless but harmless.
2358 ange-ftp-ls-cache-res
(buffer-string))
2359 ;; (kill-buffer (current-buffer))
2360 ange-ftp-ls-cache-res
)
2363 (ange-ftp-error host user
2364 (concat "DIR failed: " (cdr result
)))))
2365 (ange-ftp-del-tmp-name temp
))))
2366 (error "Should never happen. Please report. Bug ref. no.: 1"))))
2368 ;;;; ------------------------------------------------------------
2369 ;;;; Directory information caching support.
2370 ;;;; ------------------------------------------------------------
2372 (defconst ange-ftp-date-regexp
2374 " \\(Jan\\|Feb\\|Mar\\|Apr\\|May\\|Jun\\|Jul\\|Aug\\|Sep\\|Oct"
2375 "\\|Nov\\|Dec\\) +[0-3]?[0-9] "))
2377 (defvar ange-ftp-add-file-entry-alist nil
2378 "Alist saying how to add file entries on certain OS types.
2379 Association list of pairs \( TYPE \. FUNC \), where FUNC
2380 is a function to be used to add a file entry for the OS TYPE. The
2381 main reason for this alist is to deal with file versions in VMS.")
2383 (defvar ange-ftp-delete-file-entry-alist nil
2384 "Alist saying how to delete files on certain OS types.
2385 Association list of pairs \( TYPE \. FUNC \), where FUNC
2386 is a function to be used to delete a file entry for the OS TYPE.
2387 The main reason for this alist is to deal with file versions in VMS.")
2389 (defun ange-ftp-add-file-entry (name &optional dir-p
)
2390 "Add a file entry for file NAME, if its directory info exists."
2391 (funcall (or (cdr (assq (ange-ftp-host-type
2392 (car (ange-ftp-ftp-name name
)))
2393 ange-ftp-add-file-entry-alist
))
2394 'ange-ftp-internal-add-file-entry
)
2396 (setq ange-ftp-ls-cache-file nil
))
2398 (defun ange-ftp-delete-file-entry (name &optional dir-p
)
2399 "Delete the file entry for file NAME, if its directory info exists."
2400 (funcall (or (cdr (assq (ange-ftp-host-type
2401 (car (ange-ftp-ftp-name name
)))
2402 ange-ftp-delete-file-entry-alist
))
2403 'ange-ftp-internal-delete-file-entry
)
2405 (setq ange-ftp-ls-cache-file nil
))
2407 (defmacro ange-ftp-parse-filename
()
2408 ;;Extract the filename from the current line of a dired-like listing.
2409 (` (let ((eol (progn (end-of-line) (point))))
2411 (if (re-search-forward ange-ftp-date-regexp eol t
)
2413 (skip-chars-forward " ")
2414 (skip-chars-forward "^ " eol
)
2415 (skip-chars-forward " " eol
)
2416 ;; We bomb on filenames starting with a space.
2417 (buffer-substring (point) eol
))))))
2419 ;; This deals with the F switch. Should also do something about
2420 ;; unquoting names obtained with the SysV b switch and the GNU Q
2421 ;; switch. See Sebastian's dired-get-filename.
2423 (defmacro ange-ftp-ls-parser
()
2424 ;; Note that switches is dynamically bound.
2425 ;; Meant to be called by ange-ftp-parse-dired-listing
2426 (` (let ((tbl (ange-ftp-make-hashtable))
2427 (used-F (and (stringp switches
)
2428 (string-match "F" switches
)))
2429 file-type symlink directory file
)
2430 (while (setq file
(ange-ftp-parse-filename))
2432 (skip-chars-forward "\t 0-9")
2433 (setq file-type
(following-char)
2434 directory
(eq file-type ?d
))
2435 (if (eq file-type ?l
)
2436 (if (string-match " -> " file
)
2437 (setq symlink
(substring file
(match-end 0))
2438 file
(substring file
0 (match-beginning 0)))
2442 ;; Only do a costly regexp search if the F switch was used.
2444 (not (string-equal file
""))
2446 ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"))
2447 (let ((socket (eq file-type ?s
))
2449 (and (not symlink
) ; x bits don't mean a thing for symlinks
2450 (string-match "[xst]"
2461 ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX)
2462 ;; and others don't. (sigh...) Beware, that some Unix's don't
2463 ;; seem to believe in the F-switch
2464 (if (or (and symlink
(string-match "@$" file
))
2465 (and directory
(string-match "/$" file
))
2466 (and executable
(string-match "*$" file
))
2467 (and socket
(string-match "=$" file
)))
2468 (setq file
(substring file
0 -
1)))))
2469 (ange-ftp-put-hash-entry file
(or symlink directory
) tbl
)
2471 (ange-ftp-put-hash-entry "." t tbl
)
2472 (ange-ftp-put-hash-entry ".." t tbl
)
2475 ;;; The dl stuff for descriptive listings
2477 (defvar ange-ftp-dl-dir-regexp nil
2478 "Regexp matching directories which are listed in dl format.
2479 This regexp should not be anchored with a trailing `$', because it should
2480 match subdirectories as well.")
2482 (defun ange-ftp-add-dl-dir (dir)
2483 "Interactively adds a DIR to ange-ftp-dl-dir-regexp."
2485 (list (read-string "Directory: "
2486 (let ((name (or (buffer-file-name) default-directory
)))
2487 (and name
(ange-ftp-ftp-name name
)
2488 (file-name-directory name
))))))
2489 (if (not (and ange-ftp-dl-dir-regexp
2490 (string-match ange-ftp-dl-dir-regexp dir
)))
2491 (setq ange-ftp-dl-dir-regexp
2492 (concat "^" (regexp-quote dir
)
2493 (and ange-ftp-dl-dir-regexp
"\\|")
2494 ange-ftp-dl-dir-regexp
))))
2496 (defmacro ange-ftp-dl-parser
()
2497 ;; Parse the current buffer, which is assumed to be a descriptive
2498 ;; listing, and return a hashtable.
2499 (` (let ((tbl (ange-ftp-make-hashtable)))
2501 (ange-ftp-put-hash-entry
2502 (buffer-substring (point)
2504 (skip-chars-forward "^ /\n")
2506 (eq (following-char) ?
/)
2509 (ange-ftp-put-hash-entry "." t tbl
)
2510 (ange-ftp-put-hash-entry ".." t tbl
)
2513 ;; Parse the current buffer which is assumed to be in a dired-like listing
2514 ;; format, and return a hashtable as the result. If the listing is not really
2515 ;; a listing, then return nil.
2517 (defun ange-ftp-parse-dired-listing (&optional switches
)
2520 ((looking-at "^total [0-9]+$")
2522 ;; Some systems put in a blank line here.
2523 (if (eolp) (forward-line 1))
2524 (ange-ftp-ls-parser))
2525 ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'")
2526 ;; It's an ls error message.
2528 ((eobp) ; i.e. (zerop (buffer-size))
2529 ;; This could be one of:
2530 ;; (1) An Ultrix ls error message
2531 ;; (2) A listing with the A switch of an empty directory
2532 ;; on a machine which doesn't give a total line.
2533 ;; (3) The twilight zone.
2534 ;; We'll assume (1) for now.
2536 ((re-search-forward ange-ftp-date-regexp nil t
)
2538 (ange-ftp-ls-parser))
2539 ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t
)
2540 ;; It's a dl listing (I hope).
2541 ;; file is bound by the call to ange-ftp-ls
2542 (ange-ftp-add-dl-dir ange-ftp-this-file
)
2544 (ange-ftp-dl-parser))
2547 (defun ange-ftp-set-files (directory files
)
2548 "For a given DIRECTORY, set or change the associated FILES hashtable."
2549 (and files
(ange-ftp-put-hash-entry (file-name-as-directory directory
)
2550 files ange-ftp-files-hashtable
)))
2552 (defun ange-ftp-get-files (directory &optional no-error
)
2553 "Given a given DIRECTORY, return a hashtable of file entries.
2554 This will give an error or return nil, depending on the value of
2555 NO-ERROR, if a listing for DIRECTORY cannot be obtained."
2556 (setq directory
(file-name-as-directory directory
)) ;normalize
2557 (or (ange-ftp-get-hash-entry directory ange-ftp-files-hashtable
)
2559 (and (ange-ftp-ls directory
2560 ;; This is an efficiency hack. We try to
2561 ;; anticipate what sort of listing dired
2562 ;; might want, and cache just such a listing.
2563 (if (and (boundp 'dired-actual-switches
)
2564 (stringp dired-actual-switches
)
2565 ;; We allow the A switch, which lists
2566 ;; all files except "." and "..".
2567 ;; This is OK because we manually
2568 ;; insert these entries
2569 ;; in the hash table.
2571 "[aA]" dired-actual-switches
)
2573 "l" dired-actual-switches
)
2575 "R" dired-actual-switches
)))
2576 dired-actual-switches
2577 (if (and (boundp 'dired-listing-switches
)
2578 (stringp dired-listing-switches
)
2580 "[aA]" dired-listing-switches
)
2582 "l" dired-listing-switches
)
2584 "R" dired-listing-switches
)))
2585 dired-listing-switches
2588 (ange-ftp-get-hash-entry
2589 directory ange-ftp-files-hashtable
)))))
2591 ;; Given NAME, return the file part that can be used for looking up the
2592 ;; file's entry in a hashtable.
2593 (defmacro ange-ftp-get-file-part
(name)
2594 (` (let ((file (file-name-nondirectory (, name
))))
2595 (if (string-equal file
"")
2599 ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are
2600 ;; allowed to determine if NAME is a sub-directory by listing it directly,
2601 ;; rather than listing its parent directory. This is used for efficiency so
2602 ;; that a wasted listing is not done:
2603 ;; 1. When looking for a .dired file in dired-x.el.
2604 ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid
2605 ;; subdirectory. This is of course an OS dependent judgement.
2607 (defmacro ange-ftp-allow-child-lookup
(dir file
)
2609 (let* ((efile (, file
)) ; expand once.
2611 (parsed (ange-ftp-ftp-name edir
))
2612 (host-type (ange-ftp-host-type
2615 ;;; This variable seems not to exist in Emacs 19 -- rms.
2616 ;;; ;; Deal with dired
2617 ;;; (and (boundp 'dired-local-variables-file)
2618 ;;; (stringp dired-local-variables-file)
2619 ;;; (string-equal dired-local-variables-file efile))
2620 ;; No dots in dir names in vms.
2621 (and (eq host-type
'vms
)
2622 (string-match "\\." efile
))
2623 ;; No subdirs in mts of cms.
2624 (and (memq host-type
'(mts cms
))
2625 (not (string-equal "/" (nth 2 parsed
)))))))))
2627 (defun ange-ftp-file-entry-p (name)
2628 "Given NAME, return whether there is a file entry for it."
2629 (let* ((name (directory-file-name name
))
2630 (dir (file-name-directory name
))
2631 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable
))
2632 (file (ange-ftp-get-file-part name
)))
2634 (ange-ftp-hash-entry-exists-p file ent
)
2635 (or (and (ange-ftp-allow-child-lookup dir file
)
2636 (setq ent
(ange-ftp-get-files name t
))
2637 ;; Try a child lookup. i.e. try to list file as a
2638 ;; subdirectory of dir. This is a good idea because
2639 ;; we may not have read permission for file's parent. Also,
2640 ;; people tend to work down directory trees anyway. We use
2641 ;; no-error ;; because if file does not exist as a subdir.,
2642 ;; then dumb hosts will give an ftp error. Smart unix hosts
2643 ;; will simply send back the ls
2645 (ange-ftp-get-hash-entry "." ent
))
2646 ;; Child lookup failed. Try the parent. If this bombs,
2647 ;; we are at wits end -- signal an error.
2648 ;; Problem: If this signals an error, the error message
2649 ;; may not have a lot to do with what went wrong.
2650 (ange-ftp-hash-entry-exists-p file
2651 (ange-ftp-get-files dir
))))))
2653 (defun ange-ftp-get-file-entry (name)
2654 "Given NAME, return the given file entry.
2655 The entry will be either t for a directory, nil for a normal file,
2656 or a string for a symlink. If the file isn't in the hashtable,
2657 this also returns nil."
2658 (let* ((name (directory-file-name name
))
2659 (dir (file-name-directory name
))
2660 (ent (ange-ftp-get-hash-entry dir ange-ftp-files-hashtable
))
2661 (file (ange-ftp-get-file-part name
)))
2663 (ange-ftp-get-hash-entry file ent
)
2664 (or (and (ange-ftp-allow-child-lookup dir file
)
2665 (setq ent
(ange-ftp-get-files name t
))
2666 (ange-ftp-get-hash-entry "." ent
))
2667 ;; i.e. it's a directory by child lookup
2668 (ange-ftp-get-hash-entry file
2669 (ange-ftp-get-files dir
))))))
2671 (defun ange-ftp-internal-delete-file-entry (name &optional dir-p
)
2674 (setq name
(file-name-as-directory name
))
2675 (ange-ftp-del-hash-entry name ange-ftp-files-hashtable
)
2676 (setq name
(directory-file-name name
))))
2677 ;; Note that file-name-as-directory followed by directory-file-name
2678 ;; serves to canonicalize directory file names to their unix form.
2679 ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO
2680 (let ((files (ange-ftp-get-hash-entry (file-name-directory name
)
2681 ange-ftp-files-hashtable
)))
2683 (ange-ftp-del-hash-entry (ange-ftp-get-file-part name
)
2686 (defun ange-ftp-internal-add-file-entry (name &optional dir-p
)
2688 (setq name
(directory-file-name name
)))
2689 (let ((files (ange-ftp-get-hash-entry (file-name-directory name
)
2690 ange-ftp-files-hashtable
)))
2692 (ange-ftp-put-hash-entry (ange-ftp-get-file-part name
)
2696 (defun ange-ftp-wipe-file-entries (host user
)
2697 "Get rid of entry for HOST, USER pair from file entry information hashtable."
2698 (let ((new-tbl (ange-ftp-make-hashtable (length ange-ftp-files-hashtable
))))
2699 (ange-ftp-map-hashtable
2702 (let ((parsed (ange-ftp-ftp-name key
)))
2704 (let ((h (nth 0 parsed
))
2706 (or (and (equal host h
) (equal user u
))
2707 (ange-ftp-put-hash-entry key val new-tbl
)))))))
2708 ange-ftp-files-hashtable
)
2709 (setq ange-ftp-files-hashtable new-tbl
)))
2711 ;;;; ------------------------------------------------------------
2712 ;;;; File transfer mode support.
2713 ;;;; ------------------------------------------------------------
2715 (defun ange-ftp-set-binary-mode (host user
)
2716 "Tell the ftp process for the given HOST & USER to switch to binary mode."
2717 (let ((result (ange-ftp-send-cmd host user
'(type "binary"))))
2718 (if (not (car result
))
2719 (ange-ftp-error host user
(concat "BINARY failed: " (cdr result
)))
2721 (set-buffer (process-buffer (ange-ftp-get-process host user
)))
2722 (and ange-ftp-binary-hash-mark-size
2723 (setq ange-ftp-hash-mark-unit
2724 (ash ange-ftp-binary-hash-mark-size -
4)))))))
2726 (defun ange-ftp-set-ascii-mode (host user
)
2727 "Tell the ftp process for the given HOST & USER to switch to ascii mode."
2728 (let ((result (ange-ftp-send-cmd host user
'(type "ascii"))))
2729 (if (not (car result
))
2730 (ange-ftp-error host user
(concat "ASCII failed: " (cdr result
)))
2732 (set-buffer (process-buffer (ange-ftp-get-process host user
)))
2733 (and ange-ftp-ascii-hash-mark-size
2734 (setq ange-ftp-hash-mark-unit
2735 (ash ange-ftp-ascii-hash-mark-size -
4)))))))
2737 (defun ange-ftp-cd (host user dir
)
2738 (let ((result (ange-ftp-send-cmd host user
(list 'cd dir
) "Doing CD")))
2740 (ange-ftp-error host user
(concat "CD failed: " (cdr result
))))))
2742 (defun ange-ftp-get-pwd (host user
)
2743 "Attempts to get the current working directory for the given HOST/USER pair.
2744 Returns \( DIR . LINE \) where DIR is either the directory or NIL if not found,
2745 and LINE is the relevant success or fail line from the FTP-client."
2746 (let* ((result (ange-ftp-send-cmd host user
'(pwd) "Getting PWD"))
2751 (and (or (string-match "\"\\([^\"]*\\)\"" line
)
2752 (string-match " \\([^ ]+\\) " line
)) ; stone-age VMS servers!
2753 (setq dir
(substring line
2758 ;;; ------------------------------------------------------------
2759 ;;; expand-file-name and friends...which currently don't work
2760 ;;; ------------------------------------------------------------
2762 (defun ange-ftp-expand-dir (host user dir
)
2763 "Return the result of doing a PWD in the current FTP session.
2764 Use the connection to machine HOST
2765 logged in as user USER and cd'd to directory DIR."
2766 (let* ((host-type (ange-ftp-host-type host user
))
2767 ;; It is more efficient to call ange-ftp-host-type
2768 ;; before binding res, because ange-ftp-host-type sometimes
2769 ;; adds to the info in the expand-dir-hashtable.
2771 (cdr (assq host-type ange-ftp-fix-name-func-alist
)))
2772 (key (concat host
"/" user
"/" dir
))
2773 (res (ange-ftp-get-hash-entry key ange-ftp-expand-dir-hashtable
)))
2777 (string-equal user
"anonymous")
2778 (string-equal user
"ftp")
2779 (not (eq host-type
'unix
))
2780 (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp
2782 ange-ftp-good-msgs
))
2783 (result (ange-ftp-send-cmd host user
2784 (list 'get dir
"/dev/null")
2785 (format "expanding %s" dir
)))
2786 (line (cdr result
)))
2788 (if (string-match ange-ftp-expand-dir-regexp line
)
2793 (if (string-equal dir
"~")
2794 (setq res
(car (ange-ftp-get-pwd host user
)))
2795 (let ((home (ange-ftp-expand-dir host user
"~")))
2797 (and (ange-ftp-cd host user dir
)
2798 (setq res
(car (ange-ftp-get-pwd host user
))))
2799 (ange-ftp-cd host user home
)))))
2801 (let ((ange-ftp-this-user user
)
2802 (ange-ftp-this-host host
))
2804 (setq res
(funcall fix-name-func res
'reverse
)))
2805 (ange-ftp-put-hash-entry
2806 key res ange-ftp-expand-dir-hashtable
)))
2809 (defun ange-ftp-canonize-filename (n)
2810 "Take a string and short-circuit //, /. and /.."
2811 (if (string-match "[^:]+//" n
) ;don't upset Apollo users
2812 (setq n
(substring n
(1- (match-end 0)))))
2813 (let ((parsed (ange-ftp-ftp-name n
)))
2815 (let ((host (car parsed
))
2816 (user (nth 1 parsed
))
2817 (name (nth 2 parsed
)))
2819 ;; See if remote name is absolute. If so then just expand it and
2820 ;; replace the name component of the overall name.
2821 (cond ((string-match "^/" name
)
2824 ;; Name starts with ~ or ~user. Resolve that part of the name
2825 ;; making it absolute then re-expand it.
2826 ((string-match "^~[^/]*" name
)
2827 (let* ((tilda (substring name
2830 (rest (substring name
(match-end 0)))
2831 (dir (ange-ftp-expand-dir host user tilda
)))
2833 (setq name
(concat dir rest
))
2834 (error "User \"%s\" is not known"
2835 (substring tilda
1)))))
2837 ;; relative name. Tack on homedir and re-expand.
2839 (let ((dir (ange-ftp-expand-dir host user
"~")))
2842 (ange-ftp-real-file-name-as-directory dir
)
2844 (error "Unable to obtain CWD")))))
2846 ;; If name starts with //, preserve that, for apollo system.
2847 (if (not (string-match "^//" name
))
2849 (setq name
(ange-ftp-real-expand-file-name name
))
2851 (if (string-match "^//" name
)
2852 (setq name
(substring name
1)))))
2854 ;; Now substitute the expanded name back into the overall filename.
2855 (ange-ftp-replace-name-component n name
))
2857 ;; non-ange-ftp name. Just expand normally.
2858 (if (eq (string-to-char n
) ?
/)
2859 (ange-ftp-real-expand-file-name n
)
2860 (ange-ftp-real-expand-file-name
2861 (ange-ftp-real-file-name-nondirectory n
)
2862 (ange-ftp-real-file-name-directory n
))))))
2864 (defun ange-ftp-expand-file-name (name &optional default
)
2865 "Documented as original."
2867 (if (eq (string-to-char name
) ?
/)
2868 (while (cond ((string-match "[^:]+//" name
) ;don't upset Apollo users
2869 (setq name
(substring name
(1- (match-end 0)))))
2870 ((string-match "/~" name
)
2871 (setq name
(substring name
(1- (match-end 0))))))))
2872 (cond ((eq (string-to-char name
) ?~
)
2873 (ange-ftp-real-expand-file-name name
))
2874 ((eq (string-to-char name
) ?
/)
2875 (ange-ftp-canonize-filename name
))
2876 ((zerop (length name
))
2877 (ange-ftp-canonize-filename (or default default-directory
)))
2878 ((ange-ftp-canonize-filename
2879 (concat (file-name-as-directory (or default default-directory
))
2882 ;;; These are problems--they are currently not enabled.
2884 (defvar ange-ftp-file-name-as-directory-alist nil
2885 "Association list of \( TYPE \. FUNC \) pairs.
2886 FUNC converts a filename to a directory name for the operating
2889 (defun ange-ftp-file-name-as-directory (name)
2890 "Documented as original."
2891 (let ((parsed (ange-ftp-ftp-name name
)))
2893 (if (string-equal (nth 2 parsed
) "")
2895 (funcall (or (cdr (assq
2896 (ange-ftp-host-type (car parsed
))
2897 ange-ftp-file-name-as-directory-alist
))
2898 'ange-ftp-real-file-name-as-directory
)
2900 (ange-ftp-real-file-name-as-directory name
))))
2902 (defun ange-ftp-file-name-directory (name)
2903 "Documented as original."
2904 (let ((parsed (ange-ftp-ftp-name name
)))
2906 (let ((filename (nth 2 parsed
)))
2907 (if (save-match-data
2908 (string-match "^~[^/]*$" filename
))
2910 (ange-ftp-replace-name-component
2912 (ange-ftp-real-file-name-directory filename
))))
2913 (ange-ftp-real-file-name-directory name
))))
2915 (defun ange-ftp-file-name-nondirectory (name)
2916 "Documented as original."
2917 (let ((parsed (ange-ftp-ftp-name name
)))
2919 (let ((filename (nth 2 parsed
)))
2920 (if (save-match-data
2921 (string-match "^~[^/]*$" filename
))
2923 (ange-ftp-real-file-name-nondirectory name
)))
2924 (ange-ftp-real-file-name-nondirectory name
))))
2926 (defun ange-ftp-directory-file-name (dir)
2927 "Documented as original."
2928 (let ((parsed (ange-ftp-ftp-name dir
)))
2930 (ange-ftp-replace-name-component
2932 (ange-ftp-real-directory-file-name (nth 2 parsed
)))
2933 (ange-ftp-real-directory-file-name dir
))))
2936 ;;; Hooks that handle Emacs primitives.
2938 ;; Returns non-nil if should transfer FILE in binary mode.
2939 (defun ange-ftp-binary-file (file)
2941 (string-match ange-ftp-binary-file-name-regexp file
)))
2943 (defun ange-ftp-write-region (start end filename
&optional append visit
)
2944 (setq filename
(expand-file-name filename
))
2945 (let ((parsed (ange-ftp-ftp-name filename
)))
2947 (let* ((host (nth 0 parsed
))
2948 (user (nth 1 parsed
))
2949 (name (ange-ftp-quote-string (nth 2 parsed
)))
2950 (temp (ange-ftp-make-tmp-name host
))
2951 (binary (or (ange-ftp-binary-file filename
)
2952 (eq (ange-ftp-host-type host user
) 'unix
)))
2953 (cmd (if append
'append
'put
))
2954 (abbr (ange-ftp-abbreviate-filename filename
)))
2957 (let ((executing-kbd-macro t
)
2958 (filename (buffer-file-name))
2959 (mod-p (buffer-modified-p)))
2961 (ange-ftp-real-write-region start end temp nil visit
)
2963 (setq buffer-file-name filename
)
2964 (set-buffer-modified-p mod-p
)))
2966 (ange-ftp-set-binary-mode host user
))
2968 ;; tell the process filter what size the transfer will be.
2969 (let ((attr (file-attributes temp
)))
2971 (ange-ftp-set-xfer-size host user
(nth 7 attr
))))
2973 ;; put or append the file.
2974 (let ((result (ange-ftp-send-cmd host user
2975 (list cmd temp name
)
2976 (format "Writing %s" abbr
))))
2980 "Opening output file"
2981 (format "FTP Error: \"%s\"" (cdr result
))
2983 (ange-ftp-del-tmp-name temp
)
2985 (ange-ftp-set-ascii-mode host user
)))
2988 (set-visited-file-modtime '(0 0))
2989 (ange-ftp-set-buffer-mode)
2990 (setq buffer-file-name filename
)
2991 (set-buffer-modified-p nil
)))
2992 (ange-ftp-message "Wrote %s" abbr
)
2993 (ange-ftp-add-file-entry filename
))
2994 (ange-ftp-real-write-region start end filename append visit
))))
2996 (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace
)
2997 (barf-if-buffer-read-only)
2998 (setq filename
(expand-file-name filename
))
2999 (let ((parsed (ange-ftp-ftp-name filename
)))
3003 (setq buffer-file-name filename
))
3004 (if (or (file-exists-p filename
)
3006 (setq ange-ftp-ls-cache-file nil
)
3007 (ange-ftp-del-hash-entry (file-name-directory filename
)
3008 ange-ftp-files-hashtable
)
3009 (file-exists-p filename
)))
3010 (let* ((host (nth 0 parsed
))
3011 (user (nth 1 parsed
))
3012 (name (ange-ftp-quote-string (nth 2 parsed
)))
3013 (temp (ange-ftp-make-tmp-name host
))
3014 (binary (or (ange-ftp-binary-file filename
)
3015 (eq (ange-ftp-host-type host user
) 'unix
)))
3016 (abbr (ange-ftp-abbreviate-filename filename
))
3021 (ange-ftp-set-binary-mode host user
))
3022 (let ((result (ange-ftp-send-cmd host user
3023 (list 'get name temp
)
3024 (format "Retrieving %s" abbr
))))
3028 "Opening input file"
3029 (format "FTP Error: \"%s\"" (cdr result
))
3031 (if (or (ange-ftp-real-file-readable-p temp
)
3032 (sleep-for ange-ftp-retry-time
)
3033 ;; Wait for file to hopefully appear.
3034 (ange-ftp-real-file-readable-p temp
))
3037 (nth 1 (ange-ftp-real-insert-file-contents
3038 temp visit beg end replace
)))
3041 "Opening input file:"
3043 "FTP Error: %s not arrived or readable"
3046 (ange-ftp-set-ascii-mode host user
))
3047 (ange-ftp-del-tmp-name temp
))
3050 (set-visited-file-modtime '(0 0))
3051 (setq buffer-file-name filename
)))
3052 (list filename size
))
3055 "Opening input file"
3057 (ange-ftp-real-insert-file-contents filename visit beg end replace
))))
3059 (defun ange-ftp-expand-symlink (file dir
)
3060 (if (file-name-absolute-p file
)
3061 (ange-ftp-replace-name-component dir file
)
3062 (expand-file-name file dir
)))
3064 (defun ange-ftp-file-symlink-p (file)
3065 ;; call ange-ftp-expand-file-name rather than the normal
3066 ;; expand-file-name to stop loops when using a package that
3067 ;; redefines both file-symlink-p and expand-file-name.
3068 (setq file
(ange-ftp-expand-file-name file
))
3069 (if (ange-ftp-ftp-name file
)
3071 (ange-ftp-get-hash-entry
3072 (ange-ftp-get-file-part file
)
3073 (ange-ftp-get-files (file-name-directory file
)))))
3074 (if (stringp file-ent
)
3075 (if (file-name-absolute-p file-ent
)
3076 (ange-ftp-replace-name-component
3077 (file-name-directory file
) file-ent
)
3079 (ange-ftp-real-file-symlink-p file
)))
3081 (defun ange-ftp-file-exists-p (name)
3082 (setq name
(expand-file-name name
))
3083 (if (ange-ftp-ftp-name name
)
3084 (if (ange-ftp-file-entry-p name
)
3085 (let ((file-ent (ange-ftp-get-file-entry name
)))
3086 (if (stringp file-ent
)
3088 (ange-ftp-expand-symlink file-ent
3089 (file-name-directory
3090 (directory-file-name name
))))
3092 (ange-ftp-real-file-exists-p name
)))
3094 (defun ange-ftp-file-directory-p (name)
3095 (setq name
(expand-file-name name
))
3096 (if (ange-ftp-ftp-name name
)
3097 ;; We do a file-name-as-directory on name here because some
3098 ;; machines (VMS) use a .DIR to indicate the filename associated
3099 ;; with a directory. This needs to be canonicalized.
3100 (let ((file-ent (ange-ftp-get-file-entry
3101 (ange-ftp-file-name-as-directory name
))))
3102 (if (stringp file-ent
)
3104 (ange-ftp-expand-symlink file-ent
3105 (file-name-directory
3106 (directory-file-name name
))))
3108 (ange-ftp-real-file-directory-p name
)))
3110 (defun ange-ftp-directory-files (directory &optional full match
3112 (setq directory
(expand-file-name directory
))
3113 (if (ange-ftp-ftp-name directory
)
3115 (ange-ftp-barf-if-not-directory directory
)
3116 (let ((tail (ange-ftp-hash-table-keys
3117 (ange-ftp-get-files directory
)))
3119 (setq directory
(file-name-as-directory directory
))
3124 (if (or (not match
) (string-match match f
))
3126 (cons (if full
(concat directory f
) f
) files
)))))
3128 (apply 'ange-ftp-real-directory-files directory full match v19-args
)))
3130 (defun ange-ftp-file-attributes (file)
3131 (setq file
(expand-file-name file
))
3132 (let ((parsed (ange-ftp-ftp-name file
)))
3134 (let ((part (ange-ftp-get-file-part file
))
3135 (files (ange-ftp-get-files (file-name-directory file
))))
3136 (if (ange-ftp-hash-entry-exists-p part files
)
3137 (let ((host (nth 0 parsed
))
3138 (user (nth 1 parsed
))
3139 (name (nth 2 parsed
))
3140 (dirp (ange-ftp-get-hash-entry part files
)))
3141 (list (if (and (stringp dirp
) (file-name-absolute-p dirp
))
3142 (ange-ftp-expand-symlink dirp
3143 (file-name-directory file
))
3152 (concat (if (stringp dirp
) "l" (if dirp
"d" "-"))
3153 "?????????") ;8 mode
3155 ;; Hack to give remote files a unique "inode number".
3156 ;; It's actually the sum of the characters in its name.
3157 (apply '+ (nconc (mapcar 'identity host
)
3158 (mapcar 'identity user
)
3160 (directory-file-name name
))))
3161 -
1 ;11 device number [v19 only]
3163 (ange-ftp-real-file-attributes file
))))
3165 (defun ange-ftp-file-writable-p (file)
3166 (setq file
(expand-file-name file
))
3167 (if (ange-ftp-ftp-name file
)
3168 (or (file-exists-p file
) ;guess here for speed
3169 (file-directory-p (file-name-directory file
)))
3170 (ange-ftp-real-file-writable-p file
)))
3172 (defun ange-ftp-file-readable-p (file)
3173 (setq file
(expand-file-name file
))
3174 (if (ange-ftp-ftp-name file
)
3175 (file-exists-p file
)
3176 (ange-ftp-real-file-readable-p file
)))
3178 (defun ange-ftp-file-executable-p (file)
3179 (setq file
(expand-file-name file
))
3180 (if (ange-ftp-ftp-name file
)
3181 (file-exists-p file
)
3182 (ange-ftp-real-file-executable-p file
)))
3184 (defun ange-ftp-delete-file (file)
3185 (interactive "fDelete file: ")
3186 (setq file
(expand-file-name file
))
3187 (let ((parsed (ange-ftp-ftp-name file
)))
3189 (let* ((host (nth 0 parsed
))
3190 (user (nth 1 parsed
))
3191 (name (ange-ftp-quote-string (nth 2 parsed
)))
3192 (abbr (ange-ftp-abbreviate-filename file
))
3193 (result (ange-ftp-send-cmd host user
3195 (format "Deleting %s" abbr
))))
3200 (format "FTP Error: \"%s\"" (cdr result
))
3202 (ange-ftp-delete-file-entry file
))
3203 (ange-ftp-real-delete-file file
))))
3205 (defun ange-ftp-verify-visited-file-modtime (buf)
3206 (let ((name (buffer-file-name buf
)))
3207 (if (and (stringp name
) (ange-ftp-ftp-name name
))
3209 (ange-ftp-real-verify-visited-file-modtime buf
))))
3211 ;;;; ------------------------------------------------------------
3212 ;;;; File copying support... totally re-written 6/24/92.
3213 ;;;; ------------------------------------------------------------
3215 (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive
)
3216 (if (file-exists-p absname
)
3217 (if (not interactive
)
3218 (signal 'file-already-exists
(list absname
))
3219 (if (not (yes-or-no-p (format "File %s already exists; %s anyway? "
3220 absname querystring
)))
3221 (signal 'file-already-exists
(list absname
))))))
3223 ;; async local copy commented out for now since I don't seem to get
3224 ;; the process sentinel called for some processes.
3226 ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists
3228 ;; "Kludge to copy a local file and call a continuation when the copy
3230 ;; ;; check to see if we can overwrite
3231 ;; (if (or (not ok-if-already-exists)
3232 ;; (numberp ok-if-already-exists))
3233 ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3234 ;; (numberp ok-if-already-exists)))
3235 ;; (let ((proc (start-process " *copy*"
3236 ;; (generate-new-buffer "*copy*")
3241 ;; (set-process-sentinel proc (function ange-ftp-copy-file-locally-sentinel))
3242 ;; (process-kill-without-query proc)
3244 ;; (set-buffer (process-buffer proc))
3245 ;; (make-variable-buffer-local 'copy-cont)
3246 ;; (setq copy-cont cont))))
3248 ;; (defun ange-ftp-copy-file-locally-sentinel (proc status)
3250 ;; (set-buffer (process-buffer proc))
3251 ;; (let ((cont copy-cont)
3252 ;; (result (buffer-string)))
3254 ;; (if (and (string-equal status "finished\n")
3255 ;; (zerop (length result)))
3256 ;; (ange-ftp-call-cont cont t nil)
3257 ;; (ange-ftp-call-cont cont
3259 ;; (if (zerop (length result))
3260 ;; (substring status 0 -1)
3261 ;; (substring result 0 -1))))
3262 ;; (kill-buffer (current-buffer))))))
3264 ;; this is the extended version of ange-ftp-copy-file-internal that works
3265 ;; asynchronously if asked nicely.
3266 (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists
3267 keep-date
&optional msg cont nowait
)
3268 (setq filename
(expand-file-name filename
)
3269 newname
(expand-file-name newname
))
3271 ;; canonicalize newname if a directory.
3272 (if (file-directory-p newname
)
3273 (setq newname
(expand-file-name (file-name-nondirectory filename
) newname
)))
3275 (let ((f-parsed (ange-ftp-ftp-name filename
))
3276 (t-parsed (ange-ftp-ftp-name newname
)))
3278 ;; local file to local file copy?
3279 (if (and (not f-parsed
) (not t-parsed
))
3281 (ange-ftp-real-copy-file filename newname ok-if-already-exists
3284 (ange-ftp-call-cont cont t
"Copied locally")))
3285 ;; one or both files are remote.
3286 (let* ((f-host (and f-parsed
(nth 0 f-parsed
)))
3287 (f-user (and f-parsed
(nth 1 f-parsed
)))
3288 (f-name (and f-parsed
(ange-ftp-quote-string (nth 2 f-parsed
))))
3289 (f-abbr (ange-ftp-abbreviate-filename filename
))
3290 (t-host (and t-parsed
(nth 0 t-parsed
)))
3291 (t-user (and t-parsed
(nth 1 t-parsed
)))
3292 (t-name (and t-parsed
(ange-ftp-quote-string (nth 2 t-parsed
))))
3293 (t-abbr (ange-ftp-abbreviate-filename newname filename
))
3294 (binary (or (ange-ftp-binary-file filename
)
3295 (ange-ftp-binary-file newname
)
3296 (and (eq (ange-ftp-host-type f-host f-user
) 'unix
)
3297 (eq (ange-ftp-host-type t-host t-user
) 'unix
))))
3301 ;; check to see if we can overwrite
3302 (if (or (not ok-if-already-exists
)
3303 (numberp ok-if-already-exists
))
3304 (ange-ftp-barf-or-query-if-file-exists newname
"copy to it"
3305 (numberp ok-if-already-exists
)))
3310 ;; filename was remote.
3312 (if (or (ange-ftp-use-gateway-p f-host
)
3314 ;; have to use intermediate file if we are getting via
3315 ;; gateway machine or we are doing a remote to remote copy.
3316 (setq temp1
(ange-ftp-make-tmp-name f-host
)))
3319 (ange-ftp-set-binary-mode f-host f-user
))
3324 (list 'get f-name
(or temp1 newname
))
3326 (if (and temp1 t-parsed
)
3327 (format "Getting %s" f-abbr
)
3328 (format "Copying %s to %s" f-abbr t-abbr
)))
3329 (list (function ange-ftp-cf1
)
3330 filename newname binary msg
3331 f-parsed f-host f-user f-name f-abbr
3332 t-parsed t-host t-user t-name t-abbr
3333 temp1 temp2 cont nowait
)
3336 ;; filename wasn't remote. newname must be remote. call the
3337 ;; function which does the remainder of the copying work.
3339 filename newname binary msg
3340 f-parsed f-host f-user f-name f-abbr
3341 t-parsed t-host t-user t-name t-abbr
3342 nil nil cont nowait
))))))
3344 ;; next part of copying routine.
3345 (defun ange-ftp-cf1 (result line
3346 filename newname binary msg
3347 f-parsed f-host f-user f-name f-abbr
3348 t-parsed t-host t-user t-name t-abbr
3349 temp1 temp2 cont nowait
)
3351 ;; filename must have been remote, and we must have just done a GET.
3354 ;; GET failed for some reason. Clean up and get out.
3356 (and temp1
(ange-ftp-del-tmp-name temp1
))
3358 (signal 'ftp-error
(list "Opening input file"
3359 (format "FTP Error: \"%s\"" line
)
3363 (ange-ftp-set-ascii-mode f-host f-user
))))
3366 ;; We now have to copy either temp1 or filename to newname.
3369 ;; newname was remote.
3371 (if (ange-ftp-use-gateway-p t-host
)
3372 (setq temp2
(ange-ftp-make-tmp-name t-host
)))
3374 ;; make sure data is moved into the right place for the
3375 ;; outgoing transfer. gateway temporary files complicate
3379 (if (string-equal temp1 temp2
)
3381 (ange-ftp-real-copy-file temp1 temp2 t
))
3382 (setq temp2 temp1 temp1 nil
))
3384 (ange-ftp-real-copy-file filename temp2 t
)))
3387 (ange-ftp-set-binary-mode t-host t-user
))
3389 ;; tell the process filter what size the file is.
3390 (let ((attr (file-attributes (or temp2 filename
))))
3392 (ange-ftp-set-xfer-size t-host t-user
(nth 7 attr
))))
3397 (list 'put
(or temp2 filename
) t-name
)
3399 (if (and temp2 f-parsed
)
3400 (format "Putting %s" newname
)
3401 (format "Copying %s to %s" f-abbr t-abbr
)))
3402 (list (function ange-ftp-cf2
)
3403 newname t-host t-user binary temp1 temp2 cont
)
3406 ;; newname wasn't remote.
3407 (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont
))
3409 ;; first copy failed, tell caller
3410 (ange-ftp-call-cont cont result line
)))
3412 ;; last part of copying routine.
3413 (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont
)
3416 ;; result from doing a local to remote copy.
3422 (list "Opening output file"
3423 (format "FTP Error: \"%s\"" line
)
3426 (ange-ftp-add-file-entry newname
))
3430 (ange-ftp-set-ascii-mode t-host t-user
)))
3432 ;; newname was local.
3434 (ange-ftp-real-copy-file temp1 newname t
)))
3437 (and temp1
(ange-ftp-del-tmp-name temp1
))
3438 (and temp2
(ange-ftp-del-tmp-name temp2
))
3439 (ange-ftp-call-cont cont result line
)))
3441 (defun ange-ftp-copy-file (filename newname
&optional ok-if-already-exists
3443 (interactive "fCopy file: \nFCopy %s to file: \np")
3444 (ange-ftp-copy-file-internal filename
3446 ok-if-already-exists
3452 ;;;; ------------------------------------------------------------
3453 ;;;; File renaming support.
3454 ;;;; ------------------------------------------------------------
3456 (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed
)
3457 "Rename remote file FILE to remote file NEWNAME."
3458 (let ((f-host (nth 0 f-parsed
))
3459 (f-user (nth 1 f-parsed
))
3460 (t-host (nth 0 t-parsed
))
3461 (t-user (nth 1 t-parsed
)))
3462 (if (and (string-equal f-host t-host
)
3463 (string-equal f-user t-user
))
3464 (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed
)))
3465 (t-name (ange-ftp-quote-string (nth 2 t-parsed
)))
3466 (cmd (list 'rename f-name t-name
))
3467 (fabbr (ange-ftp-abbreviate-filename filename
))
3468 (nabbr (ange-ftp-abbreviate-filename newname filename
))
3469 (result (ange-ftp-send-cmd f-host f-user cmd
3470 (format "Renaming %s to %s"
3477 (format "FTP Error: \"%s\"" (cdr result
))
3480 (ange-ftp-add-file-entry newname
)
3481 (ange-ftp-delete-file-entry filename
))
3482 (ange-ftp-copy-file-internal filename newname t nil
)
3483 (delete-file filename
))))
3485 (defun ange-ftp-rename-local-to-remote (filename newname
)
3486 "Rename local FILENAME to remote file NEWNAME."
3487 (let* ((fabbr (ange-ftp-abbreviate-filename filename
))
3488 (nabbr (ange-ftp-abbreviate-filename newname filename
))
3489 (msg (format "Renaming %s to %s" fabbr nabbr
)))
3490 (ange-ftp-copy-file-internal filename newname t nil msg
)
3491 (let (ange-ftp-process-verbose)
3492 (delete-file filename
))))
3494 (defun ange-ftp-rename-remote-to-local (filename newname
)
3495 "Rename remote file FILENAME to local file NEWNAME."
3496 (let* ((fabbr (ange-ftp-abbreviate-filename filename
))
3497 (nabbr (ange-ftp-abbreviate-filename newname filename
))
3498 (msg (format "Renaming %s to %s" fabbr nabbr
)))
3499 (ange-ftp-copy-file-internal filename newname t nil msg
)
3500 (let (ange-ftp-process-verbose)
3501 (delete-file filename
))))
3503 (defun ange-ftp-rename-file (filename newname
&optional ok-if-already-exists
)
3504 (interactive "fRename file: \nFRename %s to file: \np")
3505 (setq filename
(expand-file-name filename
))
3506 (setq newname
(expand-file-name newname
))
3507 (let* ((f-parsed (ange-ftp-ftp-name filename
))
3508 (t-parsed (ange-ftp-ftp-name newname
)))
3509 (if (and (or f-parsed t-parsed
)
3510 (or (not ok-if-already-exists
)
3511 (numberp ok-if-already-exists
)))
3512 (ange-ftp-barf-or-query-if-file-exists
3515 (numberp ok-if-already-exists
)))
3518 (ange-ftp-rename-remote-to-remote filename newname f-parsed
3520 (ange-ftp-rename-remote-to-local filename newname
))
3522 (ange-ftp-rename-local-to-remote filename newname
)
3523 (ange-ftp-real-rename-file filename newname ok-if-already-exists
)))))
3525 ;;;; ------------------------------------------------------------
3526 ;;;; File name completion support.
3527 ;;;; ------------------------------------------------------------
3529 ;; If the file entry SYM is a symlink, returns whether its file exists.
3530 ;; Note that `ange-ftp-this-dir' is used as a free variable.
3531 (defun ange-ftp-file-entry-active-p (sym)
3532 (let ((val (get sym
'val
)))
3533 (or (not (stringp val
))
3534 (file-exists-p (ange-ftp-expand-symlink val ange-ftp-this-dir
)))))
3536 ;; If the file entry is not a directory (nor a symlink pointing to a directory)
3537 ;; returns whether the file (or file pointed to by the symlink) is ignored
3538 ;; by completion-ignored-extensions.
3539 ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern'
3540 ;; are used as free variables.
3541 (defun ange-ftp-file-entry-not-ignored-p (sym)
3542 (let ((val (get sym
'val
))
3543 (symname (symbol-name sym
)))
3545 (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir
)))
3546 (or (file-directory-p file
)
3547 (and (file-exists-p file
)
3548 (not (string-match ange-ftp-completion-ignored-pattern
3550 (or val
; is a directory name
3551 (not (string-match ange-ftp-completion-ignored-pattern symname
))))))
3553 (defun ange-ftp-file-name-all-completions (file dir
)
3554 (let ((ange-ftp-this-dir (expand-file-name dir
)))
3555 (if (ange-ftp-ftp-name ange-ftp-this-dir
)
3557 (ange-ftp-barf-if-not-directory ange-ftp-this-dir
)
3558 (setq ange-ftp-this-dir
3559 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir
))
3560 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir
))
3562 (all-completions file tbl
3563 (function ange-ftp-file-entry-active-p
))))
3565 ;; see whether each matching file is a directory or not...
3569 (let ((ent (ange-ftp-get-hash-entry file tbl
)))
3571 (or (not (stringp ent
))
3573 (ange-ftp-expand-symlink ent
3574 ange-ftp-this-dir
))))
3579 (if (string-equal "/" ange-ftp-this-dir
)
3580 (nconc (all-completions file
(ange-ftp-generate-root-prefixes))
3581 (ange-ftp-real-file-name-all-completions file
3583 (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir
)))))
3585 (defun ange-ftp-file-name-completion (file dir
)
3586 (let ((ange-ftp-this-dir (expand-file-name dir
)))
3587 (if (ange-ftp-ftp-name ange-ftp-this-dir
)
3589 (ange-ftp-barf-if-not-directory ange-ftp-this-dir
)
3592 (setq ange-ftp-this-dir
3593 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir
)) ;real?
3594 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir
))
3595 (ange-ftp-completion-ignored-pattern
3596 (mapconcat (function
3597 (lambda (s) (if (stringp s
)
3598 (concat (regexp-quote s
) "$")
3599 "/"))) ; / never in filename
3600 completion-ignored-extensions
3603 (or (ange-ftp-file-name-completion-1
3604 file tbl ange-ftp-this-dir
3605 (function ange-ftp-file-entry-not-ignored-p
))
3606 (ange-ftp-file-name-completion-1
3607 file tbl ange-ftp-this-dir
3608 (function ange-ftp-file-entry-active-p
)))))))
3610 (if (string-equal "/" ange-ftp-this-dir
)
3613 (nconc (ange-ftp-generate-root-prefixes)
3615 (ange-ftp-real-file-name-all-completions file
"/"))))
3616 (ange-ftp-real-file-name-completion file ange-ftp-this-dir
)))))
3619 (defun ange-ftp-file-name-completion-1 (file tbl dir predicate
)
3620 (let ((bestmatch (try-completion file tbl predicate
)))
3622 (if (eq bestmatch t
)
3623 (if (file-directory-p (expand-file-name file dir
))
3626 (if (and (eq (try-completion bestmatch tbl predicate
) t
)
3628 (expand-file-name bestmatch dir
)))
3629 (concat bestmatch
"/")
3632 ;; Put these lines uncommmented in your .emacs if you want C-r to refresh
3633 ;; ange-ftp's cache whilst doing filename completion.
3635 ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir)
3636 ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir)
3638 ;; Force a re-read of the directory DIR. If DIR is omitted then it defaults
3639 ;; to the directory part of the contents of the current buffer.
3640 (defun ange-ftp-re-read-dir (&optional dir
)
3643 (setq dir
(expand-file-name dir
))
3644 (setq dir
(file-name-directory (expand-file-name (buffer-string)))))
3645 (if (ange-ftp-ftp-name dir
)
3647 (setq ange-ftp-ls-cache-file nil
)
3648 (ange-ftp-del-hash-entry dir ange-ftp-files-hashtable
)
3649 (ange-ftp-get-files dir t
))))
3651 (defun ange-ftp-make-directory (dir &optional parents
)
3652 (interactive (list (expand-file-name (read-file-name "Make directory: "))))
3654 (let ((parent (file-name-directory (directory-file-name dir
))))
3655 (or (file-exists-p parent
)
3656 (ange-ftp-make-directory parent parents
))))
3657 (if (file-exists-p dir
)
3658 (error "Cannot make directory %s: file already exists" dir
)
3659 (let ((parsed (ange-ftp-ftp-name dir
)))
3661 (let* ((host (nth 0 parsed
))
3662 (user (nth 1 parsed
))
3663 ;; Some ftp's on unix machines (at least on Suns)
3664 ;; insist that mkdir take a filename, and not a
3665 ;; directory-name name as an arg. Argh!! This is a bug.
3666 ;; Non-unix machines will probably always insist
3667 ;; that mkdir takes a directory-name as an arg
3668 ;; (as the ftp man page says it should).
3669 (name (ange-ftp-quote-string
3670 (if (eq (ange-ftp-host-type host
) 'unix
)
3671 (ange-ftp-real-directory-file-name (nth 2 parsed
))
3672 (ange-ftp-real-file-name-as-directory
3674 (abbr (ange-ftp-abbreviate-filename dir
))
3675 (result (ange-ftp-send-cmd host user
3677 (format "Making directory %s"
3680 (ange-ftp-error host user
3681 (format "Could not make directory %s: %s"
3684 (ange-ftp-add-file-entry dir t
))
3685 (ange-ftp-real-make-directory dir
)))))
3687 (defun ange-ftp-delete-directory (dir)
3688 (if (file-directory-p dir
)
3689 (let ((parsed (ange-ftp-ftp-name dir
)))
3691 (let* ((host (nth 0 parsed
))
3692 (user (nth 1 parsed
))
3693 ;; Some ftp's on unix machines (at least on Suns)
3694 ;; insist that rmdir take a filename, and not a
3695 ;; directory-name name as an arg. Argh!! This is a bug.
3696 ;; Non-unix machines will probably always insist
3697 ;; that rmdir takes a directory-name as an arg
3698 ;; (as the ftp man page says it should).
3699 (name (ange-ftp-quote-string
3700 (if (eq (ange-ftp-host-type host
) 'unix
)
3701 (ange-ftp-real-directory-file-name
3703 (ange-ftp-real-file-name-as-directory
3705 (abbr (ange-ftp-abbreviate-filename dir
))
3706 (result (ange-ftp-send-cmd host user
3708 (format "Removing directory %s"
3711 (ange-ftp-error host user
3712 (format "Could not remove directory %s: %s"
3715 (ange-ftp-delete-file-entry dir t
))
3716 (ange-ftp-real-delete-directory dir
)))
3717 (error "Not a directory: %s" dir
)))
3719 ;; Make a local copy of FILE and return its name.
3721 (defun ange-ftp-file-local-copy (file)
3722 (let* ((fn1 (expand-file-name file
))
3723 (pa1 (ange-ftp-ftp-name fn1
)))
3725 (let ((tmp1 (ange-ftp-make-tmp-name (car pa1
))))
3726 (ange-ftp-copy-file-internal fn1 tmp1 t nil
3727 (format "Getting %s" fn1
))
3730 (defun ange-ftp-load (file &optional noerror nomessage nosuffix
)
3731 (if (ange-ftp-ftp-name file
)
3732 (let ((tryfiles (if nosuffix
3734 (list (concat file
".elc") (concat file
".el") file
)))
3736 (while (and tryfiles
(not copy
))
3737 (condition-case error
3738 (setq copy
(ange-ftp-file-local-copy (car tryfiles
)))
3740 (setq tryfiles
(cdr tryfiles
)))
3743 (funcall 'load copy noerror nomessage nosuffix
)
3746 (signal 'file-error
(list "Cannot open load file" file
)))))
3747 (ange-ftp-real-load file noerror nomessage nosuffix
)))
3749 ;; Calculate default-unhandled-directory for a given ange-ftp buffer.
3750 (defun ange-ftp-unhandled-file-name-directory (filename)
3751 (file-name-directory ange-ftp-tmp-name-template
))
3754 ;; Need the following functions for making filenames of compressed
3755 ;; files, because some OS's (unlike UNIX) do not allow a filename to
3756 ;; have two extensions.
3758 (defvar ange-ftp-make-compressed-filename-alist nil
3759 "Alist of host-type-specific functions to process file names for compression.
3760 Each element has the form (TYPE . FUNC).
3761 FUNC should take one argument, a file name, and return a list
3762 of the form (COMPRESSING NEWNAME).
3763 COMPRESSING should be t if the specified file should be compressed,
3764 and nil if it should be uncompressed (that is, if it is a compressed file).
3765 NEWNAME should be the name to give the new compressed or uncompressed file.")
3767 (defun ange-ftp-dired-compress-file (name)
3768 (let ((parsed (ange-ftp-ftp-name name
))
3771 (setq conversion-func
3772 (cdr (assq (ange-ftp-host-type (car parsed
))
3773 ange-ftp-make-compressed-filename-alist
))))
3775 (save-match-data (funcall conversion-func name
)))
3776 (compressing (car decision
))
3777 (newfile (nth 1 decision
)))
3779 (ange-ftp-compress name newfile
)
3780 (ange-ftp-uncompress name newfile
)))
3781 (let (file-name-handler-alist)
3782 (dired-compress-file name
)))))
3784 ;; Copy FILE to this machine, compress it, and copy out to NFILE.
3785 (defun ange-ftp-compress (file nfile
)
3786 (let* ((parsed (ange-ftp-ftp-name file
))
3787 (tmp1 (ange-ftp-make-tmp-name (car parsed
)))
3788 (tmp2 (ange-ftp-make-tmp-name (car parsed
)))
3789 (abbr (ange-ftp-abbreviate-filename file
))
3790 (nabbr (ange-ftp-abbreviate-filename nfile
))
3791 (msg1 (format "Getting %s" abbr
))
3792 (msg2 (format "Putting %s" nabbr
)))
3795 (ange-ftp-copy-file-internal file tmp1 t nil msg1
)
3796 (and ange-ftp-process-verbose
3797 (ange-ftp-message "Compressing %s..." abbr
))
3798 (call-process-region (point)
3805 (format "compress -f -c < %s > %s" tmp1 tmp2
))
3806 (and ange-ftp-process-verbose
3807 (ange-ftp-message "Compressing %s...done" abbr
))
3808 (if (zerop (buffer-size))
3810 (let (ange-ftp-process-verbose)
3812 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2
))))
3813 (ange-ftp-del-tmp-name tmp1
)
3814 (ange-ftp-del-tmp-name tmp2
))))
3816 ;; Copy FILE to this machine, uncompress it, and copy out to NFILE.
3817 (defun ange-ftp-uncompress (file nfile
)
3818 (let* ((parsed (ange-ftp-ftp-name file
))
3819 (tmp1 (ange-ftp-make-tmp-name (car parsed
)))
3820 (tmp2 (ange-ftp-make-tmp-name (car parsed
)))
3821 (abbr (ange-ftp-abbreviate-filename file
))
3822 (nabbr (ange-ftp-abbreviate-filename nfile
))
3823 (msg1 (format "Getting %s" abbr
))
3824 (msg2 (format "Putting %s" nabbr
))
3825 ;; ;; Cheap hack because of problems with binary file transfers from
3827 ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed)))))
3831 (ange-ftp-copy-file-internal file tmp1 t nil msg1
)
3832 (and ange-ftp-process-verbose
3833 (ange-ftp-message "Uncompressing %s..." abbr
))
3834 (call-process-region (point)
3841 (format "uncompress -c < %s > %s" tmp1 tmp2
))
3842 (and ange-ftp-process-verbose
3843 (ange-ftp-message "Uncompressing %s...done" abbr
))
3844 (if (zerop (buffer-size))
3846 (let (ange-ftp-process-verbose)
3848 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2
))))
3849 (ange-ftp-del-tmp-name tmp1
)
3850 (ange-ftp-del-tmp-name tmp2
))))
3852 (defun ange-ftp-find-backup-file-name (fn)
3853 ;; Either return the ordinary backup name, etc.,
3854 ;; or return nil meaning don't make a backup.
3855 (if ange-ftp-make-backup-files
3856 (ange-ftp-real-find-backup-file-name fn
)))
3858 ;;; Define the handler for special file names
3859 ;;; that causes ange-ftp to be invoked.
3862 (defun ange-ftp-hook-function (operation &rest args
)
3863 (let ((fn (get operation
'ange-ftp
)))
3864 (if fn
(apply fn args
)
3865 (ange-ftp-run-real-handler operation args
))))
3868 ;;; This regexp takes care of real ange-ftp file names (with a slash
3870 ;;; Don't allow the host name to end in a period--some systems use /.:
3872 (or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist
)
3873 (setq file-name-handler-alist
3874 (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function
)
3875 file-name-handler-alist
)))
3877 ;;; This regexp recognizes and absolute filenames with only one component,
3878 ;;; for the sake of hostname completion.
3880 (or (assoc "^/[^/:]*\\'" file-name-handler-alist
)
3881 (setq file-name-handler-alist
3882 (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function
)
3883 file-name-handler-alist
)))
3885 ;;; The above two forms are sufficient to cause this file to be loaded
3886 ;;; if the user ever uses a file name with a colon in it.
3888 ;;; This sets the mode
3889 (or (memq 'ange-ftp-set-buffer-mode find-file-hooks
)
3890 (setq find-file-hooks
3891 (cons 'ange-ftp-set-buffer-mode find-file-hooks
)))
3893 ;;; Now say where to find the handlers for particular operations.
3895 (put 'file-name-directory
'ange-ftp
'ange-ftp-file-name-directory
)
3896 (put 'file-name-nondirectory
'ange-ftp
'ange-ftp-file-name-nondirectory
)
3897 (put 'file-name-as-directory
'ange-ftp
'ange-ftp-file-name-as-directory
)
3898 (put 'directory-file-name
'ange-ftp
'ange-ftp-directory-file-name
)
3899 (put 'expand-file-name
'ange-ftp
'ange-ftp-expand-file-name
)
3900 (put 'make-directory
'ange-ftp
'ange-ftp-make-directory
)
3901 (put 'delete-directory
'ange-ftp
'ange-ftp-delete-directory
)
3902 (put 'insert-file-contents
'ange-ftp
'ange-ftp-insert-file-contents
)
3903 (put 'directory-files
'ange-ftp
'ange-ftp-directory-files
)
3904 (put 'file-directory-p
'ange-ftp
'ange-ftp-file-directory-p
)
3905 (put 'file-writable-p
'ange-ftp
'ange-ftp-file-writable-p
)
3906 (put 'file-readable-p
'ange-ftp
'ange-ftp-file-readable-p
)
3907 (put 'file-executable-p
'ange-ftp
'ange-ftp-file-executable-p
)
3908 (put 'file-symlink-p
'ange-ftp
'ange-ftp-file-symlink-p
)
3909 (put 'delete-file
'ange-ftp
'ange-ftp-delete-file
)
3910 (put 'read-file-name-internal
'ange-ftp
'ange-ftp-read-file-name-internal
)
3911 (put 'verify-visited-file-modtime
'ange-ftp
3912 'ange-ftp-verify-visited-file-modtime
)
3913 (put 'file-exists-p
'ange-ftp
'ange-ftp-file-exists-p
)
3914 (put 'write-region
'ange-ftp
'ange-ftp-write-region
)
3915 (put 'backup-buffer
'ange-ftp
'ange-ftp-backup-buffer
)
3916 (put 'copy-file
'ange-ftp
'ange-ftp-copy-file
)
3917 (put 'rename-file
'ange-ftp
'ange-ftp-rename-file
)
3918 (put 'file-attributes
'ange-ftp
'ange-ftp-file-attributes
)
3919 (put 'file-name-all-completions
'ange-ftp
'ange-ftp-file-name-all-completions
)
3920 (put 'file-name-completion
'ange-ftp
'ange-ftp-file-name-completion
)
3921 (put 'insert-directory
'ange-ftp
'ange-ftp-insert-directory
)
3922 (put 'file-local-copy
'ange-ftp
'ange-ftp-file-local-copy
)
3923 (put 'unhandled-file-name-directory
'ange-ftp
3924 'ange-ftp-unhandled-file-name-directory
)
3925 (put 'file-name-sans-versions
'ange-ftp
'ange-ftp-file-name-sans-versions
)
3926 (put 'dired-uncache
'ange-ftp
'ange-ftp-dired-uncache
)
3927 (put 'dired-compress-file
'ange-ftp
'ange-ftp-dired-compress-file
)
3928 (put 'load
'ange-ftp
'ange-ftp-load
)
3929 (put 'find-backup-file-name
'ange-ftp
'ange-ftp-find-backup-file-name
)
3931 ;; Turn off truename processing to save time.
3932 ;; Treat each name as its own truename.
3933 (put 'file-truename
'ange-ftp
'identity
)
3935 ;; Turn off RCS/SCCS processing to save time.
3936 ;; This returns nil for any file name as argument.
3937 (put 'vc-registered
'ange-ftp
'null
)
3939 (put 'dired-call-process
'ange-ftp
'ange-ftp-dired-call-process
)
3941 ;;; Define ways of getting at unmodified Emacs primitives,
3942 ;;; turning off our handler.
3944 (defun ange-ftp-run-real-handler (operation args
)
3945 (let ((inhibit-file-name-handlers
3946 (cons 'ange-ftp-hook-function
3947 (cons 'ange-ftp-completion-hook-function
3948 (and (eq inhibit-file-name-operation operation
)
3949 inhibit-file-name-handlers
))))
3950 (inhibit-file-name-operation operation
))
3951 (apply operation args
)))
3953 (defun ange-ftp-real-file-name-directory (&rest args
)
3954 (ange-ftp-run-real-handler 'file-name-directory args
))
3955 (defun ange-ftp-real-file-name-nondirectory (&rest args
)
3956 (ange-ftp-run-real-handler 'file-name-nondirectory args
))
3957 (defun ange-ftp-real-file-name-as-directory (&rest args
)
3958 (ange-ftp-run-real-handler 'file-name-as-directory args
))
3959 (defun ange-ftp-real-directory-file-name (&rest args
)
3960 (ange-ftp-run-real-handler 'directory-file-name args
))
3961 (defun ange-ftp-real-expand-file-name (&rest args
)
3962 (ange-ftp-run-real-handler 'expand-file-name args
))
3963 (defun ange-ftp-real-make-directory (&rest args
)
3964 (ange-ftp-run-real-handler 'make-directory args
))
3965 (defun ange-ftp-real-delete-directory (&rest args
)
3966 (ange-ftp-run-real-handler 'delete-directory args
))
3967 (defun ange-ftp-real-insert-file-contents (&rest args
)
3968 (ange-ftp-run-real-handler 'insert-file-contents args
))
3969 (defun ange-ftp-real-directory-files (&rest args
)
3970 (ange-ftp-run-real-handler 'directory-files args
))
3971 (defun ange-ftp-real-file-directory-p (&rest args
)
3972 (ange-ftp-run-real-handler 'file-directory-p args
))
3973 (defun ange-ftp-real-file-writable-p (&rest args
)
3974 (ange-ftp-run-real-handler 'file-writable-p args
))
3975 (defun ange-ftp-real-file-readable-p (&rest args
)
3976 (ange-ftp-run-real-handler 'file-readable-p args
))
3977 (defun ange-ftp-real-file-executable-p (&rest args
)
3978 (ange-ftp-run-real-handler 'file-executable-p args
))
3979 (defun ange-ftp-real-file-symlink-p (&rest args
)
3980 (ange-ftp-run-real-handler 'file-symlink-p args
))
3981 (defun ange-ftp-real-delete-file (&rest args
)
3982 (ange-ftp-run-real-handler 'delete-file args
))
3983 (defun ange-ftp-real-read-file-name-internal (&rest args
)
3984 (ange-ftp-run-real-handler 'read-file-name-internal args
))
3985 (defun ange-ftp-real-verify-visited-file-modtime (&rest args
)
3986 (ange-ftp-run-real-handler 'verify-visited-file-modtime args
))
3987 (defun ange-ftp-real-file-exists-p (&rest args
)
3988 (ange-ftp-run-real-handler 'file-exists-p args
))
3989 (defun ange-ftp-real-write-region (&rest args
)
3990 (ange-ftp-run-real-handler 'write-region args
))
3991 (defun ange-ftp-real-backup-buffer (&rest args
)
3992 (ange-ftp-run-real-handler 'backup-buffer args
))
3993 (defun ange-ftp-real-copy-file (&rest args
)
3994 (ange-ftp-run-real-handler 'copy-file args
))
3995 (defun ange-ftp-real-rename-file (&rest args
)
3996 (ange-ftp-run-real-handler 'rename-file args
))
3997 (defun ange-ftp-real-file-attributes (&rest args
)
3998 (ange-ftp-run-real-handler 'file-attributes args
))
3999 (defun ange-ftp-real-file-name-all-completions (&rest args
)
4000 (ange-ftp-run-real-handler 'file-name-all-completions args
))
4001 (defun ange-ftp-real-file-name-completion (&rest args
)
4002 (ange-ftp-run-real-handler 'file-name-completion args
))
4003 (defun ange-ftp-real-insert-directory (&rest args
)
4004 (ange-ftp-run-real-handler 'insert-directory args
))
4005 (defun ange-ftp-real-file-name-sans-versions (&rest args
)
4006 (ange-ftp-run-real-handler 'file-name-sans-versions args
))
4007 (defun ange-ftp-real-shell-command (&rest args
)
4008 (ange-ftp-run-real-handler 'shell-command args
))
4009 (defun ange-ftp-real-load (&rest args
)
4010 (ange-ftp-run-real-handler 'load args
))
4011 (defun ange-ftp-real-find-backup-file-name (&rest args
)
4012 (ange-ftp-run-real-handler 'find-backup-file-name args
))
4014 ;; Here we support using dired on remote hosts.
4015 ;; I have turned off the support for using dired on foreign directory formats.
4016 ;; That involves too many unclean hooks.
4017 ;; It would be cleaner to support such operations by
4018 ;; converting the foreign directory format to something dired can understand;
4019 ;; something close to ls -l output.
4020 ;; The logical place to do this is in the functions ange-ftp-parse-...-listing.
4022 ;; Some of the old dired hooks would still be needed even if this is done.
4023 ;; I have preserved (and modernized) those hooks.
4024 ;; So the format conversion should be all that is needed.
4026 (defun ange-ftp-insert-directory (file switches
&optional wildcard full
)
4027 (let ((short (ange-ftp-abbreviate-filename file
))
4028 (parsed (ange-ftp-ftp-name (expand-file-name file
))))
4032 (let ((default-directory (file-name-directory file
)))
4033 (ange-ftp-ls (file-name-nondirectory file
) switches nil nil t
))
4034 (ange-ftp-ls file switches full
)))
4035 (ange-ftp-real-insert-directory file switches wildcard full
))))
4037 (defun ange-ftp-dired-uncache (dir)
4038 (if (ange-ftp-ftp-name (expand-file-name dir
))
4039 (setq ange-ftp-ls-cache-file nil
)))
4041 (defvar ange-ftp-sans-version-alist nil
4042 "Alist of mapping host type into function to remove file version numbers.")
4044 (defun ange-ftp-file-name-sans-versions (file keep-backup-version
)
4045 (setq file
(ange-ftp-abbreviate-filename file
))
4046 (let ((parsed (ange-ftp-ftp-name file
))
4049 (setq host-type
(ange-ftp-host-type (car parsed
))
4050 func
(cdr (assq (ange-ftp-host-type (car parsed
))
4051 ange-ftp-sans-version-alist
))))
4052 (if func
(funcall func file keep-backup-version
)
4053 (ange-ftp-real-file-name-sans-versions file keep-backup-version
))))
4055 ;;; This doesn't work yet; a new hook needs to be created.
4056 ;;; Maybe the new hook should be in call-process.
4057 (defun ange-ftp-shell-command (command)
4058 (let* ((parsed (ange-ftp-ftp-name default-directory
))
4059 (host (nth 0 parsed
))
4060 (user (nth 1 parsed
))
4061 (name (nth 2 parsed
)))
4063 (ange-ftp-real-shell-command command
)
4064 (if (> (length name
) 0) ; else it's $HOME
4065 (setq command
(concat "cd " name
"; " command
)))
4067 (format "%s %s \"%s\"" ; remsh -l USER does not work well
4068 ; on a hp-ux machine I tried
4069 remote-shell-program host command
))
4070 (ange-ftp-message "Remote command '%s' ..." command
)
4071 ;; Cannot call ange-ftp-real-dired-run-shell-command here as it
4072 ;; would prepend "cd default-directory" --- which bombs because
4073 ;; default-directory is in ange-ftp syntax for remote file names.
4074 (ange-ftp-real-shell-command command
))))
4076 ;;; This is the handler for call-process.
4077 (defun ange-ftp-dired-call-process (program discard
&rest arguments
)
4078 ;; PROGRAM is always one of those below in the cond in dired.el.
4079 ;; The ARGUMENTS are (nearly) always files.
4080 (if (ange-ftp-ftp-name default-directory
)
4081 ;; Can't use ange-ftp-dired-host-type here because the current
4082 ;; buffer is *dired-check-process output*
4083 (condition-case oops
4084 (cond ((equal "chmod" program
)
4085 (ange-ftp-call-chmod arguments
))
4086 ;; ((equal "chgrp" program))
4087 ;; ((equal dired-chown-program program))
4088 (t (error "Unknown remote command: %s" program
)))
4089 (ftp-error (insert (format "%s: %s, %s\n"
4093 (error (insert (format "%s\n" (nth 1 oops
)))))
4094 (apply 'call-process program nil
(not discard
) nil arguments
)))
4096 ;;; This currently does not work; it is never called.
4097 (defun ange-ftp-call-chmod (args)
4098 (if (< (length args
) 2)
4099 (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args
))
4100 (let ((mode (car args
)))
4104 (setq file
(expand-file-name file
))
4105 (let ((parsed (ange-ftp-ftp-name file
)))
4107 (let* ((host (nth 0 parsed
))
4108 (user (nth 1 parsed
))
4109 (name (ange-ftp-quote-string (nth 2 parsed
)))
4110 (abbr (ange-ftp-abbreviate-filename file
))
4111 (result (ange-ftp-send-cmd host user
4112 (list 'chmod mode name
)
4113 (format "doing chmod %s"
4116 (ange-ftp-error host user
4117 (format "chmod: %s: \"%s\""
4119 (cdr result
)))))))))
4121 (setq ange-ftp-ls-cache-file nil
)) ;stop confusing dired
4123 ;;; This is turned off because it has nothing properly to do
4124 ;;; with dired. It could be reasonable to adapt this to
4125 ;;; replace ange-ftp-copy-file.
4127 ;;;;; ------------------------------------------------------------
4128 ;;;;; Noddy support for async copy-file within dired.
4129 ;;;;; ------------------------------------------------------------
4131 ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait)
4132 ;; "Documented as original."
4133 ;; (dired-handle-overwrite to)
4134 ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil
4137 ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg
4138 ;; &optional marker-char op1
4140 ;; "Documented as original."
4141 ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly
4142 ;; ;; called it rather than somebody else.
4143 ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is
4144 ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation
4145 ;; arg marker-char op1 how-to)))
4147 ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor
4148 ;; &optional marker-char)
4149 ;; "Documented as original."
4150 ;; (if (and (boundp 'ange-ftp-dired-do-create-files)
4151 ;; ;; called from ange-ftp-dired-do-create-files?
4152 ;; ange-ftp-dired-do-create-files
4153 ;; ;; any files worth copying?
4155 ;; ;; we only support async copy-file at the mo.
4156 ;; (eq file-creator 'dired-copy-file)
4157 ;; ;; it is only worth calling the alternative function for remote files
4158 ;; ;; as we tie ourself in recursive knots otherwise.
4159 ;; (or (ange-ftp-ftp-name (car fn-list))
4160 ;; ;; we can only call the name constructor for dired-do-create-files
4161 ;; ;; since the one for regexps starts prompting here, there and
4163 ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list)))))
4164 ;; ;; use the process-filter driven routine rather than the iterative one.
4165 ;; (ange-ftp-dcf-1 file-creator
4169 ;; (and (boundp 'target) target) ;dynamically bound
4172 ;; nil ;overwrite-query
4173 ;; nil ;overwrite-backup-query
4177 ;; (length fn-list) ;total
4179 ;; ;; normal case... use the interactive routine... much cheaper.
4180 ;; (ange-ftp-real-dired-create-files file-creator operation fn-list
4181 ;; name-constructor marker-char)))
4183 ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor
4184 ;; target marker-char buffer overwrite-query
4185 ;; overwrite-backup-query failures skipped
4186 ;; success-count total)
4187 ;; (let ((old-buf (current-buffer)))
4190 ;; (set-buffer buffer)
4191 ;; (if (null fn-list)
4192 ;; (ange-ftp-dcf-3 failures operation total skipped
4193 ;; success-count buffer)
4195 ;; (let* ((from (car fn-list))
4196 ;; (to (funcall name-constructor from)))
4197 ;; (if (equal to from)
4200 ;; (dired-log "Cannot %s to same file: %s\n"
4201 ;; (downcase operation) from)))
4203 ;; (ange-ftp-dcf-1 file-creator
4211 ;; overwrite-backup-query
4213 ;; (cons (dired-make-relative from) skipped)
4216 ;; (let* ((overwrite (file-exists-p to))
4217 ;; (overwrite-confirmed ; for dired-handle-overwrite
4219 ;; (let ((help-form '(format "\
4220 ;;Type SPC or `y' to overwrite file `%s',
4221 ;;DEL or `n' to skip to next,
4222 ;;ESC or `q' to not overwrite any of the remaining files,
4223 ;;`!' to overwrite all remaining files with no more questions." to)))
4224 ;; (dired-query 'overwrite-query
4225 ;; "Overwrite `%s'?" to))))
4226 ;; ;; must determine if FROM is marked before file-creator
4227 ;; ;; gets a chance to delete it (in case of a move).
4228 ;; (actual-marker-char
4229 ;; (cond ((integerp marker-char) marker-char)
4230 ;; (marker-char (dired-file-marker from)) ; slow
4232 ;; (condition-case err
4233 ;; (funcall file-creator from to overwrite-confirmed
4234 ;; (list (function ange-ftp-dcf-2)
4236 ;; file-creator operation fn-list
4239 ;; marker-char actual-marker-char
4242 ;; overwrite-confirmed
4244 ;; overwrite-backup-query
4245 ;; failures skipped success-count
4248 ;; (file-error ; FILE-CREATOR aborted
4249 ;; (ange-ftp-dcf-2 nil ;result
4252 ;; file-creator operation fn-list
4255 ;; marker-char actual-marker-char
4258 ;; overwrite-confirmed
4260 ;; overwrite-backup-query
4261 ;; failures skipped success-count
4263 ;; (set-buffer old-buf))))
4265 ;;(defun ange-ftp-dcf-2 (result line err
4266 ;; file-creator operation fn-list
4269 ;; marker-char actual-marker-char
4272 ;; overwrite-confirmed
4274 ;; overwrite-backup-query
4275 ;; failures skipped success-count
4277 ;; (let ((old-buf (current-buffer)))
4280 ;; (set-buffer buffer)
4281 ;; (if (or err (not result))
4283 ;; (setq failures (cons (dired-make-relative from) failures))
4284 ;; (dired-log "%s `%s' to `%s' failed:\n%s\n"
4285 ;; operation from to (or err line)))
4287 ;; ;; If we get here, file-creator hasn't been aborted
4288 ;; ;; and the old entry (if any) has to be deleted
4289 ;; ;; before adding the new entry.
4290 ;; (dired-remove-file to))
4291 ;; (setq success-count (1+ success-count))
4292 ;; (message "%s: %d of %d" operation success-count total)
4293 ;; (dired-add-file to actual-marker-char))
4295 ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list)
4301 ;; overwrite-backup-query
4302 ;; failures skipped success-count
4304 ;; (set-buffer old-buf))))
4306 ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count
4308 ;; (let ((old-buf (current-buffer)))
4311 ;; (set-buffer buffer)
4314 ;; (dired-log-summary
4315 ;; (message "%s failed for %d of %d file%s %s"
4316 ;; operation (length failures) total
4317 ;; (dired-plural-s total) failures)))
4319 ;; (dired-log-summary
4320 ;; (message "%s: %d of %d file%s skipped %s"
4321 ;; operation (length skipped) total
4322 ;; (dired-plural-s total) skipped)))
4324 ;; (message "%s: %s file%s."
4325 ;; operation success-count (dired-plural-s success-count))))
4326 ;; (dired-move-to-filename))
4327 ;; (set-buffer old-buf))))
4329 ;;;; -----------------------------------------------
4330 ;;;; Unix Descriptive Listing (dl) Support
4331 ;;;; -----------------------------------------------
4333 ;; This is turned off because nothing uses it currently
4334 ;; and because I don't understand what it's supposed to be for. --rms.
4336 ;;(defconst ange-ftp-dired-dl-re-dir
4337 ;; "^. [^ /]+/[ \n]"
4338 ;; "Regular expression to use to search for dl directories.")
4340 ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist)
4341 ;; (setq ange-ftp-dired-re-dir-alist
4342 ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir)
4343 ;; ange-ftp-dired-re-dir-alist)))
4345 ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol)
4346 ;; "In dired, move to the first character of the filename on this line."
4347 ;; ;; This is the Unix dl version.
4348 ;; (or eol (setq eol (progn (end-of-line) (point))))
4349 ;; (let (case-fold-search)
4350 ;; (beginning-of-line)
4351 ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ")
4352 ;; (goto-char (+ (point) 2))
4354 ;; (error "No file on this line")
4357 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist)
4358 ;; (setq ange-ftp-dired-move-to-filename-alist
4359 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename)
4360 ;; ange-ftp-dired-move-to-filename-alist)))
4362 ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol)
4363 ;; ;; Assumes point is at beginning of filename.
4364 ;; ;; So, it should be called only after (dired-move-to-filename t).
4365 ;; ;; On failure, signals an error or returns nil.
4366 ;; ;; This is the Unix dl version.
4367 ;; (let ((opoint (point))
4368 ;; case-fold-search hidden)
4369 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4370 ;; (setq hidden (and selective-display
4372 ;; (search-forward "\r" eol t))))
4377 ;; (substitute-command-keys
4378 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
4379 ;; (skip-chars-forward "^ /" eol)
4380 ;; (if (eq opoint (point))
4383 ;; (error "No file on this line"))
4386 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist)
4387 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4388 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename)
4389 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4391 ;;;; ------------------------------------------------------------
4392 ;;;; VOS support (VOS support is probably broken,
4393 ;;;; but I don't know anything about VOS.)
4394 ;;;; ------------------------------------------------------------
4396 ;(defun ange-ftp-fix-name-for-vos (name &optional reverse)
4397 ; (setq name (copy-sequence name))
4398 ; (let ((from (if reverse ?\> ?\/))
4399 ; (to (if reverse ?\/ ?\>))
4400 ; (i (1- (length name))))
4402 ; (if (= (aref name i) from)
4407 ;(or (assq 'vos ange-ftp-fix-name-func-alist)
4408 ; (setq ange-ftp-fix-name-func-alist
4409 ; (cons '(vos . ange-ftp-fix-name-for-vos)
4410 ; ange-ftp-fix-name-func-alist)))
4412 ;(or (memq 'vos ange-ftp-dumb-host-types)
4413 ; (setq ange-ftp-dumb-host-types
4414 ; (cons 'vos ange-ftp-dumb-host-types)))
4416 ;(defun ange-ftp-fix-dir-name-for-vos (dir-name)
4417 ; (ange-ftp-fix-name-for-vos
4419 ; (if (eq ?/ (aref dir-name (1- (length dir-name))))
4423 ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist)
4424 ; (setq ange-ftp-fix-dir-name-func-alist
4425 ; (cons '(vos . ange-ftp-fix-dir-name-for-vos)
4426 ; ange-ftp-fix-dir-name-func-alist)))
4428 ;(defvar ange-ftp-vos-host-regexp nil
4429 ; "If a host matches this regexp then it is assumed to be running VOS.")
4431 ;(defun ange-ftp-vos-host (host)
4432 ; (and ange-ftp-vos-host-regexp
4434 ; (string-match ange-ftp-vos-host-regexp host))))
4436 ;(defun ange-ftp-parse-vos-listing ()
4437 ; "Parse the current buffer which is assumed to be in VOS list -all
4438 ;format, and return a hashtable as the result."
4439 ; (let ((tbl (ange-ftp-make-hashtable))
4441 ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40)
4442 ; ("^Dirs: [0-9]+\n+" t 30)))
4443 ; type-regexp type-is-dir type-col file)
4444 ; (goto-char (point-min))
4447 ; (setq type-regexp (car (car type-list))
4448 ; type-is-dir (nth 1 (car type-list))
4449 ; type-col (nth 2 (car type-list))
4450 ; type-list (cdr type-list))
4451 ; (if (re-search-forward type-regexp nil t)
4452 ; (while (eq (char-after (point)) ? )
4453 ; (move-to-column type-col)
4454 ; (setq file (buffer-substring (point)
4458 ; (ange-ftp-put-hash-entry file type-is-dir tbl)
4459 ; (forward-line 1))))
4460 ; (ange-ftp-put-hash-entry "." 'vosdir tbl)
4461 ; (ange-ftp-put-hash-entry ".." 'vosdir tbl))
4464 ;(or (assq 'vos ange-ftp-parse-list-func-alist)
4465 ; (setq ange-ftp-parse-list-func-alist
4466 ; (cons '(vos . ange-ftp-parse-vos-listing)
4467 ; ange-ftp-parse-list-func-alist)))
4469 ;;;; ------------------------------------------------------------
4471 ;;;; ------------------------------------------------------------
4473 ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS
4475 (defun ange-ftp-fix-name-for-vms (name &optional reverse
)
4478 (if (string-match "^\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)$" name
)
4479 (let (drive dir file
)
4480 (if (match-beginning 1)
4481 (setq drive
(substring name
4484 (if (match-beginning 2)
4486 (substring name
(match-beginning 2) (match-end 2))))
4487 (if (match-beginning 3)
4489 (substring name
(match-beginning 3) (match-end 3))))
4491 (setq dir
(apply (function concat
)
4497 (substring dir
1 -
1)))))
4499 (concat "/" drive
"/"))
4502 (error "name %s didn't match" name
))
4503 (let (drive dir file tmp
)
4504 (if (string-match "^/[^:]+:/" name
)
4505 (setq drive
(substring name
1
4507 name
(substring name
(match-end 0))))
4508 (setq tmp
(file-name-directory name
))
4510 (setq dir
(apply (function concat
)
4516 (substring tmp
0 -
1)))))
4517 (setq file
(file-name-nondirectory name
))
4519 (and dir
(concat "[" (if drive nil
".") dir
"]"))
4522 ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1")
4523 ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t)
4525 (or (assq 'vms ange-ftp-fix-name-func-alist
)
4526 (setq ange-ftp-fix-name-func-alist
4527 (cons '(vms . ange-ftp-fix-name-for-vms
)
4528 ange-ftp-fix-name-func-alist
)))
4530 (or (memq 'vms ange-ftp-dumb-host-types
)
4531 (setq ange-ftp-dumb-host-types
4532 (cons 'vms ange-ftp-dumb-host-types
)))
4534 ;; It is important that this function barf for directories for which we know
4535 ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/".
4536 ;; This is because it saves an unnecessary FTP error, or possibly the listing
4537 ;; might succeed, but give erroneous info. This last case is particularly
4538 ;; likely for OS's (like MTS) for which we need to use a wildcard in order
4539 ;; to list a directory.
4541 ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing.
4542 (defun ange-ftp-fix-dir-name-for-vms (dir-name)
4543 ;; Should there be entries for .. -> [-] and . -> [] below. Don't
4544 ;; think so, because expand-filename should have already short-circuited
4546 (cond ((string-equal dir-name
"/")
4547 (error "Cannot get listing for fictitious \"/\" directory."))
4548 ((string-match "^/[-A-Z0-9_$]+:/$" dir-name
)
4549 (error "Cannot get listing for device."))
4550 ((ange-ftp-fix-name-for-vms dir-name
))))
4552 (or (assq 'vms ange-ftp-fix-dir-name-func-alist
)
4553 (setq ange-ftp-fix-dir-name-func-alist
4554 (cons '(vms . ange-ftp-fix-dir-name-for-vms
)
4555 ange-ftp-fix-dir-name-func-alist
)))
4557 (defvar ange-ftp-vms-host-regexp nil
)
4559 ;; Return non-nil if HOST is running VMS.
4560 (defun ange-ftp-vms-host (host)
4561 (and ange-ftp-vms-host-regexp
4563 (string-match ange-ftp-vms-host-regexp host
))))
4565 ;; Because some VMS ftp servers convert filenames to lower case
4566 ;; we allow a-z in the filename regexp. I'm not too happy about this.
4568 (defconst ange-ftp-vms-filename-regexp
4570 "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\."
4571 "[-_A-Za-z0-9$]*;+[0-9]*\\)")
4572 "Regular expression to match for a valid VMS file name in Dired buffer.
4573 Stupid freaking bug! Position of _ and $ shouldn't matter but they do.
4574 Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX
4575 Other orders of $ and _ seem to all work just fine.")
4577 ;; These parsing functions are as general as possible because the syntax
4578 ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that
4579 ;; the VMS filename syntax is so rigid. If they bomb on a listing in the
4580 ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing
4581 ;; from vms.weird.net, then too bad.
4583 ;; Extract the next filename from a VMS dired-like listing.
4584 (defun ange-ftp-parse-vms-filename ()
4585 (if (re-search-forward
4586 ange-ftp-vms-filename-regexp
4588 (buffer-substring (match-beginning 0) (match-end 0))))
4590 ;; Parse the current buffer which is assumed to be in MultiNet FTP dir
4591 ;; format, and return a hashtable as the result.
4592 (defun ange-ftp-parse-vms-listing ()
4593 (let ((tbl (ange-ftp-make-hashtable))
4595 (goto-char (point-min))
4597 (while (setq file
(ange-ftp-parse-vms-filename))
4598 (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file
)
4599 ;; deal with directories
4600 (ange-ftp-put-hash-entry
4601 (substring file
0 (match-beginning 0)) t tbl
)
4602 (ange-ftp-put-hash-entry file nil tbl
)
4603 (if (string-match ";[0-9]+$" file
) ; deal with extension
4605 (ange-ftp-put-hash-entry
4606 (substring file
0 (match-beginning 0)) nil tbl
)))
4608 ;; Would like to look for a "Total" line, or a "Directory" line to
4609 ;; make sure that the listing isn't complete garbage before putting
4610 ;; in "." and "..", but we can't even count on all VAX's giving us
4612 (ange-ftp-put-hash-entry "." t tbl
)
4613 (ange-ftp-put-hash-entry ".." t tbl
))
4616 (or (assq 'vms ange-ftp-parse-list-func-alist
)
4617 (setq ange-ftp-parse-list-func-alist
4618 (cons '(vms . ange-ftp-parse-vms-listing
)
4619 ange-ftp-parse-list-func-alist
)))
4621 ;; This version only deletes file entries which have
4622 ;; explicit version numbers, because that is all VMS allows.
4624 ;; Can the following two functions be speeded up using file
4625 ;; completion functions?
4627 (defun ange-ftp-vms-delete-file-entry (name &optional dir-p
)
4629 (ange-ftp-internal-delete-file-entry name t
)
4631 (let ((file (ange-ftp-get-file-part name
)))
4632 (if (string-match ";[0-9]+$" file
)
4633 ;; In VMS you can't delete a file without an explicit
4634 ;; version number, or wild-card (e.g. FOO;*)
4635 ;; For now, we give up on wildcards.
4636 (let ((files (ange-ftp-get-hash-entry
4637 (file-name-directory name
)
4638 ange-ftp-files-hashtable
)))
4640 (let* ((root (substring file
0
4641 (match-beginning 0)))
4646 (ange-ftp-del-hash-entry file files
)
4647 ;; Now we need to check if there are any
4648 ;; versions left. If not, then delete the
4652 (and (string-match regexp
(get sym
'key
))
4656 (ange-ftp-del-hash-entry root files
))))))))))
4658 (or (assq 'vms ange-ftp-delete-file-entry-alist
)
4659 (setq ange-ftp-delete-file-entry-alist
4660 (cons '(vms . ange-ftp-vms-delete-file-entry
)
4661 ange-ftp-delete-file-entry-alist
)))
4663 (defun ange-ftp-vms-add-file-entry (name &optional dir-p
)
4665 (ange-ftp-internal-add-file-entry name t
)
4666 (let ((files (ange-ftp-get-hash-entry
4667 (file-name-directory name
)
4668 ange-ftp-files-hashtable
)))
4670 (let ((file (ange-ftp-get-file-part name
)))
4672 (if (string-match ";[0-9]+$" file
)
4673 (ange-ftp-put-hash-entry
4674 (substring file
0 (match-beginning 0))
4676 ;; Need to figure out what version of the file
4678 (let ((regexp (concat "^"
4684 (let ((name (get sym
'key
)))
4685 (and (string-match regexp name
)
4691 (match-end 1))))))))
4693 (setq version
(1+ version
))
4694 (ange-ftp-put-hash-entry
4695 (concat file
";" (int-to-string version
))
4697 (ange-ftp-put-hash-entry file nil files
))))))
4699 (or (assq 'vms ange-ftp-add-file-entry-alist
)
4700 (setq ange-ftp-add-file-entry-alist
4701 (cons '(vms . ange-ftp-vms-add-file-entry
)
4702 ange-ftp-add-file-entry-alist
)))
4705 (defun ange-ftp-add-vms-host (host)
4706 "Mark HOST as the name of a machine running VMS."
4708 (list (read-string "Host: "
4709 (let ((name (or (buffer-file-name) default-directory
)))
4710 (and name
(car (ange-ftp-ftp-name name
)))))))
4711 (if (not (ange-ftp-vms-host host
))
4712 (setq ange-ftp-vms-host-regexp
4713 (concat "^" (regexp-quote host
) "$"
4714 (and ange-ftp-vms-host-regexp
"\\|")
4715 ange-ftp-vms-host-regexp
)
4716 ange-ftp-host-cache nil
)))
4719 (defun ange-ftp-vms-file-name-as-directory (name)
4721 (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?$" name
)
4722 (setq name
(substring name
0 (match-beginning 0))))
4723 (ange-ftp-real-file-name-as-directory name
)))
4725 (or (assq 'vms ange-ftp-file-name-as-directory-alist
)
4726 (setq ange-ftp-file-name-as-directory-alist
4727 (cons '(vms . ange-ftp-vms-file-name-as-directory
)
4728 ange-ftp-file-name-as-directory-alist
)))
4730 ;;; Tree dired support:
4732 ;; For this code I have borrowed liberally from Sebastian Kremer's
4736 ;;;; These regexps must be anchored to beginning of line.
4737 ;;;; Beware that the ftpd may put the device in front of the filename.
4739 ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]"
4740 ;; "Regular expression to use to search for VMS executable files.")
4742 ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]"
4743 ;; "Regular expression to use to search for VMS directories.")
4745 ;;(or (assq 'vms ange-ftp-dired-re-exe-alist)
4746 ;; (setq ange-ftp-dired-re-exe-alist
4747 ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe)
4748 ;; ange-ftp-dired-re-exe-alist)))
4750 ;;(or (assq 'vms ange-ftp-dired-re-dir-alist)
4751 ;; (setq ange-ftp-dired-re-dir-alist
4752 ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir)
4753 ;; ange-ftp-dired-re-dir-alist)))
4755 ;;(defun ange-ftp-dired-vms-insert-headerline (dir)
4756 ;; ;; VMS inserts a headerline. I would prefer the headerline
4757 ;; ;; to be in ange-ftp format. This version tries to
4758 ;; ;; be careful, because we can't count on a headerline
4759 ;; ;; over ftp, and we wouldn't want to delete anything
4762 ;; (if (looking-at "^ wildcard ")
4763 ;; (forward-line 1))
4764 ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n")
4765 ;; (delete-region (point) (match-end 0))))
4766 ;; (ange-ftp-real-dired-insert-headerline dir))
4768 ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist)
4769 ;; (setq ange-ftp-dired-insert-headerline-alist
4770 ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline)
4771 ;; ange-ftp-dired-insert-headerline-alist)))
4773 ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol)
4774 ;; "In dired, move to first char of filename on this line.
4775 ;;Returns position (point) or nil if no filename on this line."
4776 ;; ;; This is the VMS version.
4777 ;; (let (case-fold-search)
4778 ;; (or eol (setq eol (progn (end-of-line) (point))))
4779 ;; (beginning-of-line)
4780 ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t)
4781 ;; (goto-char (match-beginning 1))
4783 ;; (error "No file on this line")
4786 ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist)
4787 ;; (setq ange-ftp-dired-move-to-filename-alist
4788 ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename)
4789 ;; ange-ftp-dired-move-to-filename-alist)))
4791 ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol)
4792 ;; ;; Assumes point is at beginning of filename.
4793 ;; ;; So, it should be called only after (dired-move-to-filename t).
4794 ;; ;; case-fold-search must be nil, at least for VMS.
4795 ;; ;; On failure, signals an error or returns nil.
4796 ;; ;; This is the VMS version.
4797 ;; (let (opoint hidden case-fold-search)
4798 ;; (setq opoint (point))
4799 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
4800 ;; (setq hidden (and selective-display
4801 ;; (save-excursion (search-forward "\r" eol t))))
4804 ;; (re-search-forward ange-ftp-vms-filename-regexp eol t))
4806 ;; (not (eq opoint (point)))
4809 ;; (substitute-command-keys
4810 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
4811 ;; "No file on this line")))
4812 ;; (if (eq opoint (point))
4816 ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist)
4817 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4818 ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename)
4819 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4821 ;;(defun ange-ftp-dired-vms-between-files ()
4823 ;; (beginning-of-line)
4824 ;; (or (equal (following-char) 10) ; newline
4825 ;; (equal (following-char) 9) ; tab
4826 ;; (progn (forward-char 2)
4827 ;; (or (looking-at "Total of")
4828 ;; (equal (following-char) 32))))))
4830 ;;(or (assq 'vms ange-ftp-dired-between-files-alist)
4831 ;; (setq ange-ftp-dired-between-files-alist
4832 ;; (cons '(vms . ange-ftp-dired-vms-between-files)
4833 ;; ange-ftp-dired-between-files-alist)))
4835 ;; Beware! In VMS filenames must be of the form "FILE.TYPE".
4836 ;; Therefore, we cannot just append a ".Z" to filenames for
4837 ;; compressed files. Instead, we turn "FILE.TYPE" into
4838 ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do.
4840 (defun ange-ftp-vms-make-compressed-filename (name &optional reverse
)
4842 ((string-match "-Z;[0-9]+$" name
)
4843 (list nil
(substring name
0 (match-beginning 0))))
4844 ((string-match ";[0-9]+$" name
)
4845 (list nil
(substring name
0 (match-beginning 0))))
4846 ((string-match "-Z$" name
)
4847 (list nil
(substring name
0 -
2)))
4850 (if (string-match ";[0-9]+$" name
)
4851 (concat (substring name
0 (match-beginning 0))
4853 (concat name
"-Z"))))))
4855 (or (assq 'vms ange-ftp-make-compressed-filename-alist
)
4856 (setq ange-ftp-make-compressed-filename-alist
4857 (cons '(vms . ange-ftp-vms-make-compressed-filename
)
4858 ange-ftp-make-compressed-filename-alist
)))
4860 ;;;; When the filename is too long, VMS will use two lines to list a file
4861 ;;;; (damn them!) This will confuse dired. To solve this, need to convince
4862 ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of
4863 ;;;; (forward-line 1). This would require a number of changes to dired.el.
4864 ;;;; If dired gets confused, revert-buffer will fix it.
4866 ;;(defun ange-ftp-dired-vms-ls-trim ()
4867 ;; (goto-char (point-min))
4868 ;; (let ((case-fold-search nil))
4869 ;; (re-search-forward ange-ftp-vms-filename-regexp))
4870 ;; (beginning-of-line)
4871 ;; (delete-region (point-min) (point))
4873 ;; (delete-region (point) (point-max)))
4876 ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist)
4877 ;; (setq ange-ftp-dired-ls-trim-alist
4878 ;; (cons '(vms . ange-ftp-dired-vms-ls-trim)
4879 ;; ange-ftp-dired-ls-trim-alist)))
4881 (defun ange-ftp-vms-sans-version (name &rest args
)
4883 (if (string-match ";[0-9]+$" name
)
4884 (substring name
0 (match-beginning 0))
4887 (or (assq 'vms ange-ftp-sans-version-alist
)
4888 (setq ange-ftp-sans-version-alist
4889 (cons '(vms . ange-ftp-vms-sans-version
)
4890 ange-ftp-sans-version-alist
)))
4892 ;;(defvar ange-ftp-file-version-alist)
4894 ;;;;; The vms version of clean-directory has 2 more optional args
4895 ;;;;; than the usual dired version. This is so that it can be used by
4896 ;;;;; ange-ftp-dired-vms-flag-backup-files.
4898 ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg)
4899 ;; "Flag numerical backups for deletion.
4900 ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
4901 ;;Positive prefix arg KEEP overrides `dired-kept-versions';
4902 ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
4904 ;;To clear the flags on these files, you can use \\[dired-flag-backup-files]
4905 ;;with a prefix argument."
4906 ;;; (interactive "P") ; Never actually called interactively.
4907 ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions)))
4908 ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
4909 ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS!
4910 ;; ;; This could wipe ALL copies of the file.
4911 ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep)))
4912 ;; (action (or msg "Cleaning"))
4913 ;; (ange-ftp-trample-marker (or marker dired-del-marker))
4914 ;; (ange-ftp-file-version-alist ()))
4915 ;; (message (concat action
4916 ;; " numerical backups (keeping %d late, %d old)...")
4917 ;; late-retention early-retention)
4918 ;; ;; Look at each file.
4919 ;; ;; If the file has numeric backup versions,
4920 ;; ;; put on ange-ftp-file-version-alist an element of the form
4921 ;; ;; (FILENAME . VERSION-NUMBER-LIST)
4922 ;; (dired-map-dired-file-lines (function
4923 ;; ange-ftp-dired-vms-collect-file-versions))
4924 ;; ;; Sort each VERSION-NUMBER-LIST,
4925 ;; ;; and remove the versions not to be deleted.
4926 ;; (let ((fval ange-ftp-file-version-alist))
4928 ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
4929 ;; (v-count (length sorted-v-list)))
4930 ;; (if (> v-count (+ early-retention late-retention))
4931 ;; (rplacd (nthcdr early-retention sorted-v-list)
4932 ;; (nthcdr (- v-count late-retention)
4934 ;; (rplacd (car fval)
4935 ;; (cdr sorted-v-list)))
4936 ;; (setq fval (cdr fval))))
4937 ;; ;; Look at each file. If it is a numeric backup file,
4938 ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
4939 ;; (dired-map-dired-file-lines
4941 ;; ange-ftp-dired-vms-trample-file-versions mark))
4942 ;; (message (concat action " numerical backups...done"))))
4944 ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist)
4945 ;; (setq ange-ftp-dired-clean-directory-alist
4946 ;; (cons '(vms . ange-ftp-dired-vms-clean-directory)
4947 ;; ange-ftp-dired-clean-directory-alist)))
4949 ;;(defun ange-ftp-dired-vms-collect-file-versions (fn)
4950 ;; ;; "If it looks like file FN has versions, return a list of the versions.
4951 ;; ;;That is a list of strings which are file names.
4952 ;; ;;The caller may want to flag some of these files for deletion."
4953 ;;(let ((name (nth 2 (ange-ftp-ftp-name fn))))
4954 ;; (if (string-match ";[0-9]+$" name)
4955 ;; (let* ((name (substring name 0 (match-beginning 0)))
4956 ;; (fn (ange-ftp-replace-name-component fn name)))
4957 ;; (if (not (assq fn ange-ftp-file-version-alist))
4958 ;; (let* ((base-versions
4959 ;; (concat (file-name-nondirectory name) ";"))
4960 ;; (bv-length (length base-versions))
4961 ;; (possibilities (file-name-all-completions
4963 ;; (file-name-directory fn)))
4964 ;; (versions (mapcar
4966 ;; (if (and (string-match
4967 ;; "[0-9]+$" arg bv-length)
4968 ;; (= (match-beginning 0) bv-length))
4969 ;; (string-to-int (substring arg bv-length))
4974 ;; ange-ftp-file-version-alist
4975 ;; (cons (cons fn versions)
4976 ;; ange-ftp-file-version-alist)))))))))
4978 ;;(defun ange-ftp-dired-vms-trample-file-versions (fn)
4979 ;; (let* ((start-vn (string-match ";[0-9]+$" fn))
4980 ;; base-version-list)
4982 ;; (setq base-version-list ; there was a base version to which
4983 ;; (assoc (substring fn 0 start-vn) ; this looks like a
4984 ;; ange-ftp-file-version-alist)) ; subversion
4985 ;; (not (memq (string-to-int (substring fn (1+ start-vn)))
4986 ;; base-version-list)) ; this one doesn't make the cut
4987 ;; (progn (beginning-of-line)
4989 ;; (insert ange-ftp-trample-marker)))))
4991 ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p)
4992 ;; (let ((dired-kept-versions 1)
4993 ;; (kept-old-versions 0)
4996 ;; (setq marker ?\040 msg "Unflagging")
4997 ;; (setq marker dired-del-marker msg "Cleaning"))
4998 ;; (ange-ftp-dired-vms-clean-directory nil marker msg)))
5000 ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist)
5001 ;; (setq ange-ftp-dired-flag-backup-files-alist
5002 ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files)
5003 ;; ange-ftp-dired-flag-backup-files-alist)))
5005 ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches)
5006 ;; (let ((file (dired-get-filename 'no-dir))
5008 ;; (if (and (string-match ";[0-9]+$" file)
5009 ;; ;; Find most recent previous version.
5010 ;; (let ((root (substring file 0 (match-beginning 0)))
5012 ;; (string-to-int (substring file (1+ (match-beginning 0)))))
5014 ;; (setq ver (1- ver))
5015 ;; (while (and (> ver 0) (not found))
5016 ;; (setq bak (concat root ";" (int-to-string ver)))
5017 ;; (and (file-exists-p bak) (setq found t))
5018 ;; (setq ver (1- ver)))
5021 ;; (diff (expand-file-name bak) (expand-file-name file) switches)
5022 ;; (diff (expand-file-name bak) (expand-file-name file)))
5023 ;; (error "No previous version found for %s" file))))
5025 ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist)
5026 ;; (setq ange-ftp-dired-backup-diff-alist
5027 ;; (cons '(vms . ange-ftp-dired-vms-backup-diff)
5028 ;; ange-ftp-dired-backup-diff-alist)))
5031 ;;;; ------------------------------------------------------------
5033 ;;;; ------------------------------------------------------------
5036 ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from
5038 (defun ange-ftp-fix-name-for-mts (name &optional reverse
)
5041 (if (string-match "^\\([^:]+:\\)?\\(.*\\)$" name
)
5043 (if (match-beginning 1)
5044 (setq acct
(substring name
0 (match-end 1))))
5045 (if (match-beginning 2)
5046 (setq file
(substring name
5047 (match-beginning 2) (match-end 2))))
5048 (concat (and acct
(concat "/" acct
"/"))
5050 (error "name %s didn't match" name
))
5051 (if (string-match "^/\\([^:]+:\\)/\\(.*\\)$" name
)
5052 (concat (substring name
1 (match-end 1))
5053 (substring name
(match-beginning 2) (match-end 2)))
5054 ;; Let's hope that mts will recognize it anyway.
5057 (or (assq 'mts ange-ftp-fix-name-func-alist
)
5058 (setq ange-ftp-fix-name-func-alist
5059 (cons '(mts . ange-ftp-fix-name-for-mts
)
5060 ange-ftp-fix-name-func-alist
)))
5062 ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing.
5063 ;; Remember that there are no directories in MTS.
5064 (defun ange-ftp-fix-dir-name-for-mts (dir-name)
5065 (if (string-equal dir-name
"/")
5066 (error "Cannot get listing for fictitious \"/\" directory.")
5067 (let ((dir-name (ange-ftp-fix-name-for-mts dir-name
)))
5069 ((string-equal dir-name
"")
5071 ((string-match ":$" dir-name
)
5072 (concat dir-name
"?"))
5073 (dir-name))))) ; It's just a single file.
5075 (or (assq 'mts ange-ftp-fix-dir-name-func-alist
)
5076 (setq ange-ftp-fix-dir-name-func-alist
5077 (cons '(mts . ange-ftp-fix-dir-name-for-mts
)
5078 ange-ftp-fix-dir-name-func-alist
)))
5080 (or (memq 'mts ange-ftp-dumb-host-types
)
5081 (setq ange-ftp-dumb-host-types
5082 (cons 'mts ange-ftp-dumb-host-types
)))
5084 (defvar ange-ftp-mts-host-regexp nil
)
5086 ;; Return non-nil if HOST is running MTS.
5087 (defun ange-ftp-mts-host (host)
5088 (and ange-ftp-mts-host-regexp
5090 (string-match ange-ftp-mts-host-regexp host
))))
5092 ;; Parse the current buffer which is assumed to be in mts ftp dir format.
5093 (defun ange-ftp-parse-mts-listing ()
5094 (let ((tbl (ange-ftp-make-hashtable)))
5095 (goto-char (point-min))
5097 (while (re-search-forward ange-ftp-date-regexp nil t
)
5099 (skip-chars-backward " ")
5100 (let ((end (point)))
5101 (skip-chars-backward "-A-Z0-9_.!")
5102 (ange-ftp-put-hash-entry (buffer-substring (point) end
) nil tbl
))
5104 ;; Don't need to bother with ..
5105 (ange-ftp-put-hash-entry "." t tbl
)
5108 (or (assq 'mts ange-ftp-parse-list-func-alist
)
5109 (setq ange-ftp-parse-list-func-alist
5110 (cons '(mts . ange-ftp-parse-mts-listing
)
5111 ange-ftp-parse-list-func-alist
)))
5113 (defun ange-ftp-add-mts-host (host)
5114 "Mark HOST as the name of a machine running MTS."
5116 (list (read-string "Host: "
5117 (let ((name (or (buffer-file-name) default-directory
)))
5118 (and name
(car (ange-ftp-ftp-name name
)))))))
5119 (if (not (ange-ftp-mts-host host
))
5120 (setq ange-ftp-mts-host-regexp
5121 (concat "^" (regexp-quote host
) "$"
5122 (and ange-ftp-mts-host-regexp
"\\|")
5123 ange-ftp-mts-host-regexp
)
5124 ange-ftp-host-cache nil
)))
5126 ;;; Tree dired support:
5128 ;;;; There aren't too many systems left that use MTS. This dired support will
5129 ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems
5130 ;;;; implement ftp in the same way. If not, it might be necessary to make the
5131 ;;;; following more flexible.
5133 ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol)
5134 ;; "In dired, move to first char of filename on this line.
5135 ;;Returns position (point) or nil if no filename on this line."
5136 ;; ;; This is the MTS version.
5137 ;; (or eol (setq eol (progn (end-of-line) (point))))
5138 ;; (beginning-of-line)
5139 ;; (if (re-search-forward
5140 ;; ange-ftp-date-regexp eol t)
5142 ;; (skip-chars-forward " ") ; Eat blanks after date
5143 ;; (skip-chars-forward "0-9:" eol) ; Eat time or year
5144 ;; (skip-chars-forward " " eol) ; one space before filename
5145 ;; ;; When listing an account other than the users own account it appends
5146 ;; ;; ACCT: to the beginning of the filename. Skip over this.
5147 ;; (and (looking-at "[A-Z0-9_.]+:")
5148 ;; (goto-char (match-end 0)))
5151 ;; (error "No file on this line")
5154 ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist)
5155 ;; (setq ange-ftp-dired-move-to-filename-alist
5156 ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename)
5157 ;; ange-ftp-dired-move-to-filename-alist)))
5159 ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol)
5160 ;; ;; Assumes point is at beginning of filename.
5161 ;; ;; So, it should be called only after (dired-move-to-filename t).
5162 ;; ;; On failure, signals an error or returns nil.
5163 ;; ;; This is the MTS version.
5164 ;; (let (opoint hidden case-fold-search)
5165 ;; (setq opoint (point)
5166 ;; eol (save-excursion (end-of-line) (point))
5167 ;; hidden (and selective-display
5168 ;; (save-excursion (search-forward "\r" eol t))))
5171 ;; (skip-chars-forward "-A-Z0-9._!" eol))
5173 ;; (not (eq opoint (point)))
5176 ;; (substitute-command-keys
5177 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5178 ;; "No file on this line")))
5179 ;; (if (eq opoint (point))
5183 ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist)
5184 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5185 ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename)
5186 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5188 ;;;; ------------------------------------------------------------
5190 ;;;; ------------------------------------------------------------
5192 ;; Since CMS doesn't have any full file name syntax, we have to fudge
5193 ;; things with cd's. We actually send too many cd's, but it's dangerous
5194 ;; to try to remember the current minidisk, because if the connection
5195 ;; is closed and needs to be reopened, we will find ourselves back in
5196 ;; the default minidisk. This is fairly likely since CMS ftp servers
5197 ;; usually close the connection after 5 minutes of inactivity.
5199 ;; Have I got the filename character set right?
5201 (defun ange-ftp-fix-name-for-cms (name &optional reverse
)
5204 ;; Since we only convert output from a pwd in this direction,
5205 ;; we'll assume that it's a minidisk, and make it into a
5206 ;; directory file name. Note that the expand-dir-hashtable
5207 ;; stores directories without the trailing /. Is this
5210 (if (string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$"
5212 (let ((minidisk (substring name
1 (match-end 1))))
5213 (if (match-beginning 2)
5214 (let ((file (substring name
(match-beginning 2)
5216 (cmd (concat "cd " minidisk
))
5218 ;; Note that host and user are bound in the call
5219 ;; to ange-ftp-send-cmd
5220 (proc (ange-ftp-get-process ange-ftp-this-host
5221 ange-ftp-this-user
)))
5223 ;; Must use ange-ftp-raw-send-cmd here to avoid
5224 ;; an infinite loop.
5225 (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg
))
5227 ;; failed... try ONCE more.
5228 (setq proc
(ange-ftp-get-process ange-ftp-this-host
5229 ange-ftp-this-user
))
5230 (let ((result (ange-ftp-raw-send-cmd proc cmd
5231 ange-ftp-this-msg
)))
5235 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5236 (format "cd to minidisk %s failed: %s"
5237 minidisk
(cdr result
)))))))
5238 ;; return the minidisk
5240 (error "Invalid CMS filename")))))
5242 (or (assq 'cms ange-ftp-fix-name-func-alist
)
5243 (setq ange-ftp-fix-name-func-alist
5244 (cons '(cms . ange-ftp-fix-name-for-cms
)
5245 ange-ftp-fix-name-func-alist
)))
5247 (or (memq 'cms ange-ftp-dumb-host-types
)
5248 (setq ange-ftp-dumb-host-types
5249 (cons 'cms ange-ftp-dumb-host-types
)))
5251 ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing.
5252 (defun ange-ftp-fix-dir-name-for-cms (dir-name)
5254 ((string-equal "/" dir-name
)
5255 (error "Cannot get listing for fictitious \"/\" directory."))
5256 ((string-match "^/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?$" dir-name
)
5257 (let* ((minidisk (substring dir-name
(match-beginning 1) (match-end 1)))
5258 ;; host and user are bound in the call to ange-ftp-send-cmd
5259 (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user
))
5260 (cmd (concat "cd " minidisk
))
5261 (file (if (match-beginning 2)
5262 ;; it's a single file
5263 (substring dir-name
(match-beginning 2)
5265 ;; use the wild-card
5267 (if (car (ange-ftp-raw-send-cmd proc cmd
))
5270 (setq proc
(ange-ftp-get-process ange-ftp-this-host
5271 ange-ftp-this-user
))
5272 (let ((result (ange-ftp-raw-send-cmd proc cmd
)))
5276 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5277 (format "cd to minidisk %s failed: "
5278 minidisk
(cdr result
))))))))
5279 (t (error "Invalid CMS file name"))))
5281 (or (assq 'cms ange-ftp-fix-dir-name-func-alist
)
5282 (setq ange-ftp-fix-dir-name-func-alist
5283 (cons '(cms . ange-ftp-fix-dir-name-for-cms
)
5284 ange-ftp-fix-dir-name-func-alist
)))
5286 (defvar ange-ftp-cms-host-regexp nil
5287 "Regular expression to match hosts running the CMS operating system.")
5289 ;; Return non-nil if HOST is running CMS.
5290 (defun ange-ftp-cms-host (host)
5291 (and ange-ftp-cms-host-regexp
5293 (string-match ange-ftp-cms-host-regexp host
))))
5295 (defun ange-ftp-add-cms-host (host)
5296 "Mark HOST as the name of a CMS host."
5298 (list (read-string "Host: "
5299 (let ((name (or (buffer-file-name) default-directory
)))
5300 (and name
(car (ange-ftp-ftp-name name
)))))))
5301 (if (not (ange-ftp-cms-host host
))
5302 (setq ange-ftp-cms-host-regexp
5303 (concat "^" (regexp-quote host
) "$"
5304 (and ange-ftp-cms-host-regexp
"\\|")
5305 ange-ftp-cms-host-regexp
)
5306 ange-ftp-host-cache nil
)))
5308 (defun ange-ftp-parse-cms-listing ()
5309 ;; Parse the current buffer which is assumed to be a CMS directory listing.
5310 ;; If we succeed in getting a listing, then we will assume that the minidisk
5311 ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work
5312 ;; because ange-ftp doesn't know that the root hashtable has only part of
5313 ;; the info. It will assume that if a minidisk isn't in it, then it doesn't
5314 ;; exist. It would be nice if completion worked for minidisks, as we
5316 ; (let* ((dir-file (directory-file-name file))
5317 ; (root (file-name-directory dir-file))
5318 ; (minidisk (ange-ftp-get-file-part dir-file))
5319 ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable)))
5321 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5322 ; (setq root-tbl (ange-ftp-make-hashtable))
5323 ; (ange-ftp-put-hash-entry minidisk t root-tbl)
5324 ; (ange-ftp-put-hash-entry "." t root-tbl)
5325 ; (ange-ftp-set-files root root-tbl)))
5326 ;; Now do the usual parsing
5327 (let ((tbl (ange-ftp-make-hashtable)))
5328 (goto-char (point-min))
5332 "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t
)
5333 (ange-ftp-put-hash-entry
5334 (concat (buffer-substring (match-beginning 1)
5337 (buffer-substring (match-beginning 2)
5341 (ange-ftp-put-hash-entry "." t tbl
))
5344 (or (assq 'cms ange-ftp-parse-list-func-alist
)
5345 (setq ange-ftp-parse-list-func-alist
5346 (cons '(cms . ange-ftp-parse-cms-listing
)
5347 ange-ftp-parse-list-func-alist
)))
5349 ;;;;; Tree dired support:
5351 ;;(defconst ange-ftp-dired-cms-re-exe
5352 ;; "^. [-A-Z0-9$_]+ +EXEC "
5353 ;; "Regular expression to use to search for CMS executables.")
5355 ;;(or (assq 'cms ange-ftp-dired-re-exe-alist)
5356 ;; (setq ange-ftp-dired-re-exe-alist
5357 ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe)
5358 ;; ange-ftp-dired-re-exe-alist)))
5361 ;;(defun ange-ftp-dired-cms-insert-headerline (dir)
5362 ;; ;; CMS has no total line, so we insert a blank line for
5365 ;; (forward-char -1)
5366 ;; (ange-ftp-real-dired-insert-headerline dir))
5368 ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist)
5369 ;; (setq ange-ftp-dired-insert-headerline-alist
5370 ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline)
5371 ;; ange-ftp-dired-insert-headerline-alist)))
5373 ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol)
5374 ;; "In dired, move to the first char of filename on this line."
5375 ;; ;; This is the CMS version.
5376 ;; (or eol (setq eol (progn (end-of-line) (point))))
5377 ;; (let (case-fold-search)
5378 ;; (beginning-of-line)
5379 ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t)
5380 ;; (goto-char (1+ (match-beginning 0)))
5382 ;; (error "No file on this line")
5385 ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist)
5386 ;; (setq ange-ftp-dired-move-to-filename-alist
5387 ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename)
5388 ;; ange-ftp-dired-move-to-filename-alist)))
5390 ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol)
5391 ;; ;; Assumes point is at beginning of filename.
5392 ;; ;; So, it should be called only after (dired-move-to-filename t).
5393 ;; ;; case-fold-search must be nil, at least for VMS.
5394 ;; ;; On failure, signals an error or returns nil.
5395 ;; ;; This is the CMS version.
5396 ;; (let ((opoint (point))
5397 ;; case-fold-search hidden)
5398 ;; (or eol (setq eol (save-excursion (end-of-line) (point))))
5399 ;; (setq hidden (and selective-display
5401 ;; (search-forward "\r" eol t))))
5406 ;; (substitute-command-keys
5407 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
5408 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5409 ;; (skip-chars-forward " " eol)
5410 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5411 ;; (if (eq opoint (point))
5414 ;; (error "No file on this line"))
5417 ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist)
5418 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5419 ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename)
5420 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5422 (defun ange-ftp-cms-make-compressed-filename (name &optional reverse
)
5423 (if (string-match "-Z$" name
)
5424 (list nil
(substring name
0 -
2))
5425 (list t
(concat name
"-Z"))))
5427 (or (assq 'cms ange-ftp-make-compressed-filename-alist
)
5428 (setq ange-ftp-make-compressed-filename-alist
5429 (cons '(cms . ange-ftp-cms-make-compressed-filename
)
5430 ange-ftp-make-compressed-filename-alist
)))
5432 ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep)
5433 ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep)))
5435 ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name)
5436 ;; (concat (substring name 0 (match-end 1))
5438 ;; (substring name (match-beginning 2) (match-end 2)))
5441 ;;(or (assq 'cms ange-ftp-dired-get-filename-alist)
5442 ;; (setq ange-ftp-dired-get-filename-alist
5443 ;; (cons '(cms . ange-ftp-dired-cms-get-filename)
5444 ;; ange-ftp-dired-get-filename-alist)))
5446 ;;;; ------------------------------------------------------------
5447 ;;;; Finally provide package.
5448 ;;;; ------------------------------------------------------------
5452 ;;; ange-ftp.el ends here