1 ;;; ange-ftp.el --- transparent FTP support for GNU Emacs
3 ;; Copyright (C) 1989-1996, 1998, 2000-2013 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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; This package attempts to make accessing files and directories using FTP
27 ;; from within GNU Emacs as simple and transparent as possible. A subset of
28 ;; the common file-handling routines are extended to interact with FTP.
32 ;; Some of the common GNU Emacs file-handling operations have been made
33 ;; FTP-smart. If one of these routines is given a filename that matches
34 ;; '/user@host:name' then it will spawn an FTP process connecting to machine
35 ;; 'host' as account 'user' and perform its operation on the file 'name'.
37 ;; For example: if find-file is given a filename of:
39 ;; /ange@anorman:/tmp/notes
41 ;; then ange-ftp spawns an FTP process, connect to the host 'anorman' as
42 ;; user 'ange', get the file '/tmp/notes' and pop up a buffer containing the
43 ;; contents of that file as if it were on the local filesystem. If ange-ftp
44 ;; needs a password to connect then it reads one in the echo area.
46 ;; Extended filename syntax:
48 ;; The default extended filename syntax is '/user@host:name', where the
49 ;; 'user@' part may be omitted. This syntax can be customized to a certain
50 ;; extent by changing ange-ftp-name-format. There are limitations.
51 ;; The `host' part has an optional suffix `#port' which may be used to
52 ;; specify a non-default port number for the connection.
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 init 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 should be able to
279 ;; automatically recognize any VMS machine. However, if it fails to do
280 ;; this, you can use the command ange-ftp-add-vms-host. Also, you can
281 ;; set the variable ange-ftp-vms-host-regexp in your init 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 valid 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 init 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 init 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
387 ;; Ange-ftp has full support for BS2000 hosts. It should be able to
388 ;; automatically recognize any BS2000 machine. However, if it fails to
389 ;; do this, you can use the command ange-ftp-add-bs2000-host. As well,
390 ;; you can set the variable ange-ftp-bs2000-host-regexp in your .emacs
391 ;; file. We would be grateful if you would report any failures to auto-
392 ;; matically recognize a BS2000 host as a bug.
394 ;; If you want to access the POSIX subsystem on BS2000 you MUST use
395 ;; command ange-ftp-add-bs2000-posix-host for that particular
396 ;; hostname. ange-ftp can't decide if you want to access the native
397 ;; filesystem or the POSIX filesystem, so it accesses the native
398 ;; filesystem by default. And if you have an ASCII filesystem in
399 ;; your BS2000 POSIX subsystem you must use
400 ;; ange-ftp-binary-file-name-regexp to access its files.
404 ;; For ease of *implementation*, the user enters the BS2000 filename
405 ;; syntax in a UNIX-y way. For example:
406 ;; :PUB:$PUBLIC.ANONYMOUS.SDSCPUB.NEXT.README.TXT
407 ;; would be entered as:
408 ;; /:PUB:/$$PUBLIC/ANONYMOUS.SDSCPUB.NEXT.README.TXT
409 ;; You don't have to type pubset and account, if they have default values,
410 ;; i.e. to log in as anonymous on bs2000.anywhere.com and grab the file
411 ;; IMPORTANT.TEXT.ON.BS2000 on the default pubset X on userid PUBLIC
412 ;; (there are only 8 characters in a valid username), you could type:
413 ;; C-x C-f /public@bs2000.anywhere.com:/IMPORTANT.TEXT.ON.BS2000
415 ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/$$PUBLIC/IMPORTANT.TEXT.ON.BS2000
417 ;; If X is not your default pubset, you could add it as 'subdirectory' (BS2000
418 ;; has a flat architecture) with the command
419 ;; (setq ange-ftp-bs2000-additional-pubsets '(":X:"))
420 ;; and then you could type:
421 ;; C-x C-f /anonym@bs2000.anywhere.com:/:X:/IMPORTANT.TEXT.ON.BS2000
423 ;; Valid characters in an BS2000 filename are A-Z 0-9 $ # @ . -
424 ;; If the first character in a filename is # or @, this is replaced with
425 ;; ange-ftp-bs2000-special-prefix because names starting with # or @
426 ;; are reserved for temporary files.
427 ;; This is especially important for auto-save files.
428 ;; Valid file generations are ending with ([+|-|*]0-9...) .
429 ;; File generations are not supported yet!
430 ;; A filename must at least contain one character (A-Z) and cannot be longer
431 ;; than 41 characters.
434 ;; 1. Although BS2000 is not case sensitive, EMACS running under UNIX is.
435 ;; Therefore, to access a BS2000 file, you must enter the filename with
436 ;; upper case letters.
437 ;; 2. EMACS has a feature in which it does environment variable substitution
438 ;; in filenames. Therefore, to enter a $ in a filename, you must quote it
440 ;; 3. BS2000 machines, with the exception of anonymous accounts, nearly
441 ;; always need an account password. To have ange-ftp send an account
442 ;; password, you can either include it in your .netrc file, or use
443 ;; ange-ftp-set-account.
445 ;; ------------------------------------------------------------------
447 ;; ------------------------------------------------------------------
449 ;; 1. Umask problems:
450 ;; Be warned that files created by using ange-ftp will take account of the
451 ;; umask of the ftp daemon process rather than the umask of the creating
452 ;; user. This is particularly important when logging in as the root user.
453 ;; The way that I tighten up the ftp daemon's umask under HP-UX is to make
454 ;; sure that the umask is changed to 027 before I spawn /etc/inetd. I
455 ;; suspect that there is something similar on other systems.
457 ;; 2. Some combinations of FTP clients and servers break and get out of sync
458 ;; when asked to list a non-existent directory. Some of the ai.mit.edu
459 ;; machines cause this problem for some FTP clients. Using
460 ;; ange-ftp-kill-ftp-process can restart the ftp process, which
461 ;; should get things back in sync.
463 ;; 3. Ange-ftp does not check to make sure that when creating a new file,
464 ;; you provide a valid filename for the remote operating system.
465 ;; If you do not, then the remote FTP server will most likely
466 ;; translate your filename in some way. This may cause ange-ftp to
467 ;; get confused about what exactly is the name of the file. The
468 ;; most common causes of this are using lower case filenames on systems
469 ;; which support only upper case, and using filenames which are too
472 ;; 4. Null (blank) passwords confuse both ange-ftp and some FTP daemons.
474 ;; 5. Ange-ftp likes to use pty's to talk to its FTP processes. If GNU Emacs
475 ;; for some reason creates a FTP process that only talks via pipes then
476 ;; ange-ftp won't be getting the information it requires at the time that
477 ;; it wants it since pipes flush at different times to pty's. One
478 ;; disgusting way around this problem is to talk to the FTP process via
479 ;; rlogin which does the 'right' things with pty's.
481 ;; 6. For CMS support, we send too many cd's. Since cd's are cheap, I haven't
482 ;; worried about this too much. Eventually, we should have some caching
483 ;; of the current minidisk.
485 ;; 7. Some CMS machines do not assign a default minidisk when you ftp them as
486 ;; anonymous. It is then necessary to guess a valid minidisk name, and cd
487 ;; to it. This is (understandably) beyond ange-ftp.
489 ;; 8. Remote to remote copying of files on non-Unix machines can be risky.
490 ;; Depending on the variable ange-ftp-binary-file-name-regexp, ange-ftp
491 ;; will use binary mode for the copy. Between systems of different
492 ;; architecture, this still may not be enough to guarantee the integrity
493 ;; of binary files. Binary file transfers from VMS machines are
494 ;; particularly problematical. Should ange-ftp-binary-file-name-regexp be
495 ;; an alist of OS type, regexp pairs?
497 ;; 9. The code to do compression of files over ftp is not as careful as it
498 ;; should be. It deletes the old remote version of the file, before
499 ;; actually checking if the local to remote transfer of the compressed
500 ;; file succeeds. Of course to delete the original version of the file
501 ;; after transferring the compressed version back is also dangerous,
502 ;; because some OS's have severe restrictions on the length of filenames,
503 ;; and when the compressed version is copied back the "-Z" or ".Z" may be
504 ;; truncated. Then, ange-ftp would delete the only remaining version of
505 ;; the file. Maybe ange-ftp should make backups when it compresses files
506 ;; (of course, the backup "~" could also be truncated off, sigh...).
509 ;; 10. If a dir listing is attempted for an empty directory on (at least
510 ;; some) VMS hosts, an ftp error is given. This is really an ftp bug, and
511 ;; I don't know how to get ange-ftp work to around it.
513 ;; 11. Bombs on filenames that start with a space. Deals well with filenames
514 ;; containing spaces, but beware that the remote ftpd may not like them
517 ;; 12. The dired support for non-Unix-like systems does not currently work.
518 ;; It needs to be reimplemented by modifying the parse-...-listing
519 ;; functions to convert the directory listing to ls -l format.
521 ;; 13. The famous @ bug. As mentioned above in TIPS, ULTRIX marks symlinks
522 ;; with a trailing @ in a ls -alF listing. In order to account for this
523 ;; ange-ftp looks to chop trailing @'s off of symlink names when it is
524 ;; parsing a listing with the F switch. This will cause ange-ftp to
525 ;; incorrectly get the name of a symlink on a non-ULTRIX host if its name
526 ;; ends in an @. ange-ftp will correct itself if you take F out of the
527 ;; dired ls switches (C-u s will allow you to edit the switches). The
528 ;; dired buffer will be automatically reverted, which will allow ange-ftp
529 ;; to fix its files hashtable. A cookie to anyone who can think of a
530 ;; fast, sure-fire way to recognize ULTRIX over ftp.
532 ;; If you find any bugs or problems with this package, PLEASE either e-mail
533 ;; the above author, or send a message to the ange-ftp-lovers mailing list
534 ;; below. Ideas and constructive comments are especially welcome.
538 ;; ange-ftp has its own mailing list modestly called ange-ftp-lovers. All
539 ;; users of ange-ftp are welcome to subscribe (see below) and to discuss
540 ;; aspects of ange-ftp. New versions of ange-ftp are posted periodically to
543 ;; To [un]subscribe to ange-ftp-lovers, or to report mailer problems with the
544 ;; list, please mail one of the following addresses:
546 ;; ange-ftp-lovers-request@hplb.hpl.hp.com
548 ;; Please don't forget the -request part.
550 ;; For mail to be posted directly to ange-ftp-lovers, send to one of the
551 ;; following addresses:
553 ;; ange-ftp-lovers@hplb.hpl.hp.com
555 ;; Alternatively, there is a mailing list that only gets announcements of new
556 ;; ange-ftp releases. This is called ange-ftp-lovers-announce, and can be
557 ;; subscribed to by e-mailing to the -request address as above. Please make
558 ;; it clear in the request which mailing list you wish to join.
560 ;; -----------------------------------------------------------
561 ;; Technical information on this package:
562 ;; -----------------------------------------------------------
564 ;; ange-ftp works by putting a handler on file-name-handler-alist
565 ;; which is called by many primitives, and a few non-primitives,
566 ;; whenever they see a file name of the appropriate sort.
568 ;; Checklist for adding non-UNIX support for TYPE
570 ;; The following functions may need TYPE versions:
571 ;; (not all functions will be needed for every OS)
573 ;; ange-ftp-fix-name-for-TYPE
574 ;; ange-ftp-fix-dir-name-for-TYPE
575 ;; ange-ftp-TYPE-host
576 ;; ange-ftp-TYPE-add-host
577 ;; ange-ftp-parse-TYPE-listing
578 ;; ange-ftp-TYPE-delete-file-entry
579 ;; ange-ftp-TYPE-add-file-entry
580 ;; ange-ftp-TYPE-file-name-as-directory
581 ;; ange-ftp-TYPE-make-compressed-filename
582 ;; ange-ftp-TYPE-file-name-sans-versions
586 ;; ange-ftp-TYPE-host-regexp
587 ;; May need to add TYPE to ange-ftp-dumb-host-types
589 ;; Check the following functions for OS dependent coding:
591 ;; ange-ftp-host-type
592 ;; ange-ftp-guess-host-type
593 ;; ange-ftp-allow-child-lookup
595 ;; Host type conventions:
597 ;; The function ange-ftp-host-type and the variable ange-ftp-dired-host-type
598 ;; (mostly) follow the following conventions for remote host types. At
599 ;; least, I think that future code should try to follow these conventions,
600 ;; and the current code should eventually be made compliant.
602 ;; nil = local host type, whatever that is (probably unix).
603 ;; Think nil as in "not a remote host". This value is used by
604 ;; ange-ftp-dired-host-type for local buffers.
606 ;; t = a remote host of unknown type. Think t as in true, it's remote.
607 ;; Currently, `unix' is used as the default remote host type.
608 ;; Maybe we should use t.
610 ;; TYPE = a remote host of TYPE type.
612 ;; TYPE:LIST = a remote host of TYPE type, using a specialized ftp listing
613 ;; program called list. This is currently only used for Unix
614 ;; dl (descriptive listings), when ange-ftp-dired-host-type
615 ;; is set to `unix:dl'.
619 ;; Because of their naive faith in this code, there are certain situations
620 ;; which the writers of this program believe could never happen. However,
621 ;; being realists they have put calls to `error' in the program at these
622 ;; points. These errors provide a code, which is an integer, greater than 1.
623 ;; To aid debugging. the error codes, and the functions in which they reside
626 ;; 1: See ange-ftp-ls
629 ;; -----------------------------------------------------------
631 ;; -----------------------------------------------------------
633 ;; Thanks to Roland McGrath for improving the filename syntax handling,
634 ;; for suggesting many enhancements and for numerous cleanups to the code.
636 ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways.
638 ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and
639 ;; dired / shell auto-loading.
641 ;; Thanks to Sebastian Kremer for dired support and for many ideas and
644 ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support,
645 ;; VOS support, and hostname completion.
647 ;; Thanks to Nakagawa Takayuki for many good ideas, filename-completion, help
648 ;; with file-name expansion, efficiency worries, stylistic concerns and many
651 ;; Thanks to Sandy Rutherford who re-wrote most of ange-ftp to support VMS,
652 ;; MTS, CMS and UNIX-dls. Sandy also added dired-support for non-UNIX OS and
653 ;; auto-recognition of the host type.
655 ;; Thanks to Dave Smith who wrote the info file for ange-ftp.
657 ;; Finally, thanks to Keith Waclena, Mark D. Baushke, Terence Kelleher, Ping
658 ;; Zhou, Edward Vielmetti, Jack Repenning, Mike Balenger, Todd Kaufmann,
659 ;; Kjetil Svarstad, Tom Wurgler, Linus Tolke, Niko Makila, Carl Edman, Bill
660 ;; Trost, Dave Brennan, Dan Jacobson, Andy Scott, Steve Anderson, Sanjay
661 ;; Mathur, the folks on the ange-ftp-lovers mailing list and many others
662 ;; whose names I've forgotten who have helped to debug and fix problems with
669 ;;;; ------------------------------------------------------------
670 ;;;; User customization variables.
671 ;;;; ------------------------------------------------------------
673 (defgroup ange-ftp nil
674 "Accessing remote files and directories using FTP."
679 (defcustom ange-ftp-name-format
680 '("\\`/\\(\\([^/:]*\\)@\\)?\\([^@/:]*[^@/:.]\\):\\(.*\\)" . (3 2 4))
681 "Format of a fully expanded remote file name.
683 This is a list of the form \(REGEXP HOST USER NAME\),
684 where REGEXP is a regular expression matching
685 the full remote name, and HOST, USER, and NAME are the numbers of
686 parenthesized expressions in REGEXP for the components (in that order)."
688 :type '(list (regexp :tag "Name regexp")
689 (integer :tag "Host group")
690 (integer :tag "User group")
691 (integer :tag "Name group")))
693 ;; ange-ftp-multi-skip-msgs should only match ###-, where ### is one of
694 ;; the number codes corresponding to ange-ftp-good-msgs or ange-ftp-fatal-msgs.
695 ;; Otherwise, ange-ftp will go into multi-skip mode, and never come out.
697 (defvar ange-ftp-multi-msgs
698 "^150-\\|^220-\\|^230-\\|^226\\|^25.-\\|^221-\\|^200-\\|^331-\\|^4[25]1-\\|^530-"
699 "Regular expression matching the start of a multiline FTP reply.")
701 (defvar ange-ftp-good-msgs
702 "^220 \\|^230 \\|^226 \\|^25. \\|^221 \\|^200 \\|^[Hh]ash mark\\|^Remote directory:"
703 "Regular expression matching FTP \"success\" messages.")
705 ;; CMS and the odd VMS machine say 200 Port rather than 200 PORT.
706 ;; Also CMS machines use a multiline 550- reply to say that you
707 ;; don't have write permission. ange-ftp gets into multi-line skip
708 ;; mode and hangs. Have it ignore 550- instead. It will then barf
709 ;; when it gets the 550 line, as it should.
711 ;; RFC2228 "FTP Security Extensions" defines extensions to the FTP
712 ;; protocol which involve the client requesting particular
713 ;; authentication methods (typically) at connection establishment. Non
714 ;; security-aware FTP servers should respond to this with a 500 code,
716 (defcustom ange-ftp-skip-msgs
717 (concat "^200 \\(PORT\\|Port\\) \\|^331 \\|^150 \\|^350 \\|^[0-9]+ bytes \\|"
718 "^Connected \\|^$\\|^Remote system\\|^Using\\|^ \\|Password:\\|"
719 "^Data connection \\|"
720 "^local:\\|^Trying\\|^125 \\|^550-\\|^221 .*oodbye\\|"
721 "^500 .*AUTH\\|^KERBEROS\\|"
722 "^500 This security scheme is not implemented\\|"
723 "^504 Unknown security mechanism\\|"
724 "^530 Please login with USER and PASS\\|" ; non kerberized vsFTPd
725 "^534 Kerberos Authentication not enabled\\|"
726 "^22[789] .*[Pp]assive\\|^200 EPRT\\|^500 .*EPRT")
727 "Regular expression matching FTP messages that can be ignored."
731 (defcustom ange-ftp-fatal-msgs
732 (concat "^ftp: \\|^Not connected\\|^530 \\|^4[25]1 \\|rcmd: \\|"
733 "^No control connection\\|unknown host\\|^lost connection")
734 "Regular expression matching FTP messages that indicate serious errors.
736 These mean that the FTP process should be (or already has been) killed."
740 (defcustom ange-ftp-potential-error-msgs
741 ;; On Mac OS X we sometimes get things like:
743 ;; ftp> open ftp.nluug.nl
744 ;; Trying 2001:610:1:80aa:192:87:102:36...
745 ;; ftp: connect to address 2001:610:1:80aa:192:87:102:36: No route to host
746 ;; Trying 192.87.102.36...
747 ;; Connected to ftp.nluug.nl.
748 "^ftp: connect to address .*: No route to host"
749 "Regular expression matching FTP messages that can indicate serious errors.
750 These mean that something went wrong, but they may be followed by more
751 messages indicating that the error was somehow corrected."
755 (defcustom ange-ftp-gateway-fatal-msgs
756 "No route to host\\|Connection closed\\|No such host\\|Login incorrect"
757 "Regular expression matching login failure messages from rlogin/telnet."
761 (defcustom ange-ftp-xfer-size-msgs
762 "^150 .* connection for .* (\\([0-9]+\\) bytes)"
763 "Regular expression used to determine the number of bytes in a FTP transfer."
767 (defcustom ange-ftp-tmp-name-template
768 (expand-file-name "ange-ftp" temporary-file-directory)
769 "Template used to create temporary files."
773 (defcustom ange-ftp-gateway-tmp-name-template "/tmp/ange-ftp"
774 "Template used to create temporary files when FTP-ing through a gateway.
776 Files starting with this prefix need to be accessible from BOTH the local
777 machine and the gateway machine, and need to have the SAME name on both
778 machines, that is, /tmp is probably NOT what you want, since that is rarely
783 (defcustom ange-ftp-netrc-filename "~/.netrc"
784 "File in .netrc format to search for passwords."
788 (defcustom ange-ftp-disable-netrc-security-check (eq system-type 'windows-nt)
789 "If non-nil avoid checking permissions on the .netrc file."
793 (defcustom ange-ftp-default-user nil
794 "User name to use when none is specified in a file name.
796 If non-nil but not a string, you are prompted for the name.
797 If nil, the value of `ange-ftp-netrc-default-user' is used.
798 If that is nil too, then your login name is used.
800 Once a connection to a given host has been initiated, the user name
801 and password information for that host are cached and re-used by
802 ange-ftp. Use \\[ange-ftp-set-user] to change the cached values,
803 since setting `ange-ftp-default-user' directly does not affect
804 the cached information."
806 :type '(choice (const :tag "Default" nil)
808 (other :tag "Prompt" t)))
810 (defcustom ange-ftp-netrc-default-user nil
811 "Alternate default user name to use when none is specified.
813 This variable is set from the `default' command in your `.netrc' file,
816 :type '(choice (const :tag "Default" nil)
819 (defcustom ange-ftp-default-password nil
820 "Password to use when the user name equals `ange-ftp-default-user'."
822 :type '(choice (const :tag "Default" nil)
825 (defcustom ange-ftp-default-account nil
826 "Account to use when the user name equals `ange-ftp-default-user'."
828 :type '(choice (const :tag "Default" nil)
831 (defcustom ange-ftp-netrc-default-password nil
832 "Password to use when the user name equals `ange-ftp-netrc-default-user'."
834 :type '(choice (const :tag "Default" nil)
837 (defcustom ange-ftp-netrc-default-account nil
838 "Account to use when the user name equals `ange-ftp-netrc-default-user'."
840 :type '(choice (const :tag "Default" nil)
843 (defcustom ange-ftp-generate-anonymous-password t
844 "If t, use value of `user-mail-address' as password for anonymous FTP.
846 If a string, then use that string as the password.
847 If nil, prompt the user for a password."
849 :type '(choice (const :tag "Prompt" nil)
851 (other :tag "User address" t)))
853 (defcustom ange-ftp-dumb-unix-host-regexp nil
854 "If non-nil, regexp matching hosts on which `dir' command lists directory."
856 :type '(choice (const :tag "Default" nil)
859 (defcustom ange-ftp-binary-file-name-regexp ""
860 "If a file matches this regexp then it is transferred in binary mode."
865 (defcustom ange-ftp-gateway-host nil
866 "Name of host to use as gateway machine when local FTP isn't possible."
868 :type '(choice (const :tag "Default" nil)
871 (defcustom ange-ftp-local-host-regexp ".*"
872 "Regexp selecting hosts which can be reached directly with FTP.
874 For other hosts the FTP process is started on `ange-ftp-gateway-host'
875 instead, and/or reached via `ange-ftp-gateway-ftp-program-name'."
879 (defcustom ange-ftp-gateway-program-interactive nil
880 "If non-nil then the gateway program should give a shell prompt.
882 Both telnet and rlogin do something like this."
886 (defcustom ange-ftp-gateway-program remote-shell-program
887 "Name of program to spawn a shell on the gateway machine.
889 Valid candidates are rsh (remsh on some systems), telnet and rlogin.
890 See also the gateway variable above."
892 :type '(choice (const "rsh")
897 (defcustom ange-ftp-gateway-prompt-pattern "^[^#$%>;\n]*[#$%>;] *"
898 "Regexp matching prompt after complete login sequence on gateway machine.
900 A match for this means the shell is now awaiting input. Make this regexp as
901 strict as possible; it shouldn't match *anything* at all except the user's
902 initial prompt. The above string will fail under most SUN-3's since it
903 matches the login banner."
907 (defvar ange-ftp-gateway-setup-term-command
908 (if (eq system-type 'hpux)
909 "stty -onlcr -echo\n"
911 "Set up terminal after logging in to the gateway machine.
912 This command should stop the terminal from echoing each command, and
913 arrange to strip out trailing ^M characters.")
915 (defcustom ange-ftp-smart-gateway nil
916 "Non-nil says the FTP gateway (proxy) or gateway FTP program is smart.
918 Don't bother telnetting, etc., already connected to desired host transparently,
919 or just issue a user@host command in case `ange-ftp-gateway-host' is non-nil.
920 See also `ange-ftp-smart-gateway-port'."
924 (defcustom ange-ftp-smart-gateway-port "21"
925 "Port on gateway machine to use when smart gateway is in operation."
929 (defcustom ange-ftp-send-hash t
930 "If non-nil, send the HASH command to the FTP client."
934 (defcustom ange-ftp-binary-hash-mark-size nil
935 "Default size, in bytes, between hash-marks when transferring a binary file.
936 If nil, this variable will be locally overridden if the FTP client outputs a
937 suitable response to the HASH command. If non-nil, this value takes
938 precedence over the local value."
940 :type '(choice (const :tag "Overridden" nil)
943 (defcustom ange-ftp-ascii-hash-mark-size 1024
944 "Default size, in bytes, between hash-marks when transferring an ASCII file.
945 This variable is buffer-local and will be locally overridden if the FTP client
946 outputs a suitable response to the HASH command."
950 (defcustom ange-ftp-process-verbose t
951 "If non-nil then be chatty about interaction with the FTP process."
955 (defcustom ange-ftp-ftp-program-name "ftp"
956 "Name of FTP program to run."
960 (defcustom ange-ftp-gateway-ftp-program-name "ftp"
961 "Name of FTP program to run when accessing non-local hosts.
963 Some AT&T folks claim to use something called `pftp' here."
967 (defcustom ange-ftp-ftp-program-args '("-i" "-n" "-g" "-v")
968 "A list of arguments passed to the FTP program when started."
970 :type '(repeat string))
972 (defcustom ange-ftp-nslookup-program nil
973 "If non-nil, this is a string naming the nslookup program."
975 :type '(choice (const :tag "None" nil)
978 (defcustom ange-ftp-make-backup-files ()
979 "Non-nil means make backup files for \"magic\" remote files."
983 (defcustom ange-ftp-retry-time 5
984 "Number of seconds to wait before retry if file or listing doesn't arrive.
985 This might need to be increased for very slow connections."
989 (defcustom ange-ftp-auto-save 0
990 "If 1, allow ange-ftp files to be auto-saved.
991 If 0, inhibit auto-saving of ange-ftp files.
992 Don't use any other value."
994 :type '(choice (const :tag "Suppress" 0)
995 (const :tag "Allow" 1)))
997 (defcustom ange-ftp-try-passive-mode nil
998 "If t, try to use passive mode in FTP, if the client program supports it."
1003 (defcustom ange-ftp-passive-host-alist nil
1004 "Alist of FTP servers that need \"passive\" mode.
1005 Each element is of the form (HOSTNAME . SETTING).
1006 HOSTNAME is a regular expression to match the FTP server host name(s).
1007 SETTING is \"on\" to turn passive mode on, \"off\" to turn it off,
1008 or nil meaning don't change it."
1010 :type '(repeat (cons regexp (choice (const :tag "On" "on")
1011 (const :tag "Off" "off")
1012 (const :tag "Don't change" nil))))
1015 ;;;; ------------------------------------------------------------
1016 ;;;; Hash table support.
1017 ;;;; ------------------------------------------------------------
1019 (require 'backquote)
1021 (defun ange-ftp-hash-entry-exists-p (key tbl)
1022 "Return whether there is an association for KEY in table TBL."
1023 (and tbl (not (eq (gethash key tbl 'unknown) 'unknown))))
1025 (defun ange-ftp-hash-table-keys (tbl)
1026 "Return a sorted list of all the active keys in table TBL, as strings."
1027 ;; (let ((keys nil))
1028 ;; (maphash (lambda (k v) (push k keys)) tbl)
1029 ;; (sort keys 'string-lessp))
1030 (sort (all-completions "" tbl) 'string-lessp))
1032 ;;;; ------------------------------------------------------------
1033 ;;;; Internal variables.
1034 ;;;; ------------------------------------------------------------
1036 (defvar ange-ftp-data-buffer-name " *ftp data*"
1037 "Buffer name to hold directory listing data received from FTP process.")
1039 (defvar ange-ftp-netrc-modtime nil
1040 "Last modified time of the netrc file from file-attributes.")
1042 (defvar ange-ftp-user-hashtable (make-hash-table :test 'equal)
1043 "Hash table holding associations between HOST, USER pairs.")
1045 (defvar ange-ftp-passwd-hashtable (make-hash-table :test 'equal)
1046 "Mapping between a HOST, USER pair and a PASSWORD for them.
1047 All HOST values should be in lower case.")
1049 (defvar ange-ftp-account-hashtable (make-hash-table :test 'equal)
1050 "Mapping between a HOST, USER pair and an ACCOUNT password for them.")
1052 (defvar ange-ftp-files-hashtable (make-hash-table :test 'equal :size 97)
1053 "Hash table for storing directories and their respective files.")
1055 (defvar ange-ftp-inodes-hashtable (make-hash-table :test 'equal :size 97)
1056 "Hash table for storing file names and their \"inode numbers\".")
1058 (defvar ange-ftp-next-inode-number 1
1059 "Next \"inode number\" value. We give each file name a unique number.")
1061 (defvar ange-ftp-ls-cache-lsargs nil
1062 "Last set of args used by `ange-ftp-ls'.")
1064 (defvar ange-ftp-ls-cache-file nil
1065 "Last file passed to `ange-ftp-ls'.")
1067 (defvar ange-ftp-ls-cache-res nil
1068 "Last result returned from `ange-ftp-ls'.")
1070 (defconst ange-ftp-expand-dir-hashtable (make-hash-table :test 'equal))
1072 (defconst ange-ftp-expand-dir-regexp "^5.0 \\([^: ]+\\):")
1074 ;; These are local variables in each FTP process buffer.
1075 (defvar ange-ftp-hash-mark-unit nil)
1076 (defvar ange-ftp-hash-mark-count nil)
1077 (defvar ange-ftp-xfer-size nil)
1078 (defvar ange-ftp-process-string nil)
1079 (defvar ange-ftp-process-result-line nil)
1080 (defvar ange-ftp-pending-error-line nil)
1081 (defvar ange-ftp-process-busy nil)
1082 (defvar ange-ftp-process-result nil)
1083 (defvar ange-ftp-process-multi-skip nil)
1084 (defvar ange-ftp-process-msg nil)
1085 (defvar ange-ftp-process-continue nil)
1086 (defvar ange-ftp-last-percent nil)
1088 ;; These variables are bound by one function and examined by another.
1089 ;; Leave them void globally for error checking.
1090 (defvar ange-ftp-this-file)
1091 (defvar ange-ftp-this-dir)
1092 (defvar ange-ftp-this-user)
1093 (defvar ange-ftp-this-host)
1094 (defvar ange-ftp-this-msg)
1095 (defvar ange-ftp-completion-ignored-pattern)
1096 (defvar ange-ftp-trample-marker)
1098 ;; New error symbols.
1099 (define-error 'ftp-error nil 'file-error) ;"FTP error"
1101 ;;; ------------------------------------------------------------
1102 ;;; Enhanced message support.
1103 ;;; ------------------------------------------------------------
1105 (defun ange-ftp-message (fmt &rest args)
1106 "Display message in echo area, but indicate if truncated.
1107 Args are as in `message': a format string, plus arguments to be formatted."
1108 (let ((msg (apply 'format fmt args))
1109 (max (window-width (minibuffer-window))))
1112 (if (>= (length msg) max)
1113 ;; Take just the last MAX - 3 chars of the string.
1114 (setq msg (concat "> " (substring msg (- 3 max)))))
1115 (message "%s" msg))))
1117 (defun ange-ftp-abbreviate-filename (file &optional new)
1118 "Abbreviate the file name FILE relative to the `default-directory'.
1119 If the optional parameter NEW is given and the non-directory parts match,
1120 only return the directory part of FILE."
1122 (if (and default-directory
1123 (string-match (concat "\\`"
1124 (regexp-quote default-directory)
1126 (setq file (substring file (1- (match-end 0)))))
1128 (string-equal (file-name-nondirectory file)
1129 (file-name-nondirectory new)))
1130 (setq file (file-name-directory file)))
1133 ;;;; ------------------------------------------------------------
1134 ;;;; User / Host mapping support.
1135 ;;;; ------------------------------------------------------------
1137 (defun ange-ftp-set-user (host user)
1138 "For a given HOST, set or change the default USER."
1139 (interactive "sHost: \nsUser: ")
1140 (puthash host user ange-ftp-user-hashtable))
1142 (defun ange-ftp-get-user (host)
1143 "Given a HOST, return the default user."
1144 (ange-ftp-parse-netrc)
1145 (let ((user (gethash host ange-ftp-user-hashtable)))
1149 (cond ((stringp ange-ftp-default-user)
1150 ;; We have a default name. Use it.
1151 ange-ftp-default-user)
1152 (ange-ftp-default-user
1154 (let ((enable-recursive-minibuffers t))
1155 (read-string (format "User for %s: " host)
1156 (user-login-name))))
1157 (ange-ftp-netrc-default-user)
1158 ;; Default to the user's login name.
1160 (user-login-name))))
1161 (ange-ftp-set-user host user)))))
1163 ;;;; ------------------------------------------------------------
1164 ;;;; Password support.
1165 ;;;; ------------------------------------------------------------
1167 (defmacro ange-ftp-generate-passwd-key (host user)
1168 `(and (stringp ,host) (stringp ,user) (concat (downcase ,host) "/" ,user)))
1170 (defmacro ange-ftp-lookup-passwd (host user)
1171 `(gethash (ange-ftp-generate-passwd-key ,host ,user)
1172 ange-ftp-passwd-hashtable))
1174 (defun ange-ftp-set-passwd (host user password)
1175 "For a given HOST and USER, set or change the associated PASSWORD."
1176 (interactive (list (read-string "Host: ")
1177 (read-string "User: ")
1178 (read-passwd "Password: ")))
1179 (puthash (ange-ftp-generate-passwd-key host user)
1180 password ange-ftp-passwd-hashtable))
1182 (defun ange-ftp-get-host-with-passwd (user)
1183 "Given a USER, return a host we know the password for."
1184 (ange-ftp-parse-netrc)
1188 (if (ange-ftp-lookup-passwd host user) (throw 'found-one host)))
1189 ange-ftp-user-hashtable)
1193 (if (string-match "\\`[^/]*\\(/\\).*\\'" key)
1194 (let ((host (substring key 0 (match-beginning 1))))
1195 (if (and (string-equal user (substring key (match-end 1)))
1197 (throw 'found-one host)))))
1198 ange-ftp-passwd-hashtable))
1201 (defun ange-ftp-get-passwd (host user)
1202 "Return the password for specified HOST and USER, asking user if necessary."
1203 ;; If `non-essential' is non-nil, don't ask for a password. It will
1204 ;; be caught in Tramp.
1206 (throw 'non-essential 'non-essential))
1208 (ange-ftp-parse-netrc)
1210 ;; look up password in the hash table first; user might have overridden the
1212 (cond ((ange-ftp-lookup-passwd host user))
1214 ;; See if default user and password set.
1215 ((and (stringp ange-ftp-default-user)
1216 ange-ftp-default-password
1217 (string-equal user ange-ftp-default-user))
1218 ange-ftp-default-password)
1220 ;; See if default user and password set from .netrc file.
1221 ((and (stringp ange-ftp-netrc-default-user)
1222 ange-ftp-netrc-default-password
1223 (string-equal user ange-ftp-netrc-default-user))
1224 ange-ftp-netrc-default-password)
1226 ;; anonymous ftp password is handled specially since there is an
1227 ;; unwritten rule about how that is used on the Internet.
1228 ((and (or (string-equal user "anonymous")
1229 (string-equal user "ftp"))
1230 ange-ftp-generate-anonymous-password)
1231 (if (stringp ange-ftp-generate-anonymous-password)
1232 ange-ftp-generate-anonymous-password
1235 ;; see if same user has logged in to other hosts; if so then prompt
1236 ;; with the password that was used there.
1238 (let* ((enable-recursive-minibuffers t)
1239 (other (ange-ftp-get-host-with-passwd user))
1242 ;; found another machine with the same user.
1243 ;; Try that account.
1245 (format "passwd for %s@%s (default same as %s@%s): "
1246 user host user other)
1248 (ange-ftp-lookup-passwd other user))
1250 ;; I give up. Ask the user for the password.
1252 (format "Password for %s@%s: " user host)))))
1253 (ange-ftp-set-passwd host user passwd)
1256 ;;;; ------------------------------------------------------------
1257 ;;;; Account support
1258 ;;;; ------------------------------------------------------------
1260 ;; Account passwords must be either specified in the .netrc file, or set
1261 ;; manually by calling ange-ftp-set-account. For the moment, ange-ftp doesn't
1262 ;; check to see whether the FTP process is actually prompting for an account
1265 (defun ange-ftp-set-account (host user account)
1266 "For a given HOST and USER, set or change the associated ACCOUNT password."
1267 (interactive (list (read-string "Host: ")
1268 (read-string "User: ")
1269 (read-passwd "Account password: ")))
1270 (puthash (ange-ftp-generate-passwd-key host user)
1271 account ange-ftp-account-hashtable))
1273 (defun ange-ftp-get-account (host user)
1274 "Given a HOST and USER, return the FTP account."
1275 (ange-ftp-parse-netrc)
1276 (or (gethash (ange-ftp-generate-passwd-key host user)
1277 ange-ftp-account-hashtable)
1278 (and (stringp ange-ftp-default-user)
1279 (string-equal user ange-ftp-default-user)
1280 ange-ftp-default-account)
1281 (and (stringp ange-ftp-netrc-default-user)
1282 (string-equal user ange-ftp-netrc-default-user)
1283 ange-ftp-netrc-default-account)))
1285 ;;;; ------------------------------------------------------------
1286 ;;;; ~/.netrc support
1287 ;;;; ------------------------------------------------------------
1289 (defun ange-ftp-chase-symlinks (file)
1290 "Return the filename that FILE references, following all symbolic links."
1292 (while (setq temp (ange-ftp-real-file-symlink-p file))
1294 (if (file-name-absolute-p temp)
1296 ;; Wouldn't `expand-file-name' be better than `concat' ?
1297 ;; It would fail when `a/b/..' != `a', tho. --Stef
1298 (concat (file-name-directory file) temp)))))
1301 ;; Move along current line looking for the value of the TOKEN.
1302 ;; Valid separators between TOKEN and its value are commas and
1303 ;; whitespace. Second arg LIMIT is a limit for the search.
1305 (defun ange-ftp-parse-netrc-token (token limit)
1306 (if (search-forward token limit t)
1308 (skip-chars-forward ", \t\r\n" limit)
1309 (if (eq (following-char) ?\") ;quoted token value
1310 (progn (forward-char 1)
1312 (skip-chars-forward "^\"" limit)
1314 (buffer-substring beg (1- (point))))
1316 (skip-chars-forward "^, \t\r\n" limit)
1317 (buffer-substring beg (point))))))
1319 ;; Extract the values for the tokens `machine', `login',
1320 ;; `password' and `account' in the current buffer. If successful,
1321 ;; record the information found.
1323 (defun ange-ftp-parse-netrc-group ()
1324 (let ((start (point))
1325 (end (save-excursion
1326 (if (looking-at "machine\\>")
1327 ;; Skip `machine' and the machine name that follows.
1329 (skip-chars-forward "^ \t\r\n")
1330 (skip-chars-forward " \t\r\n")
1331 (skip-chars-forward "^ \t\r\n"))
1333 (skip-chars-forward "^ \t\r\n"))
1334 ;; Find start of the next `machine' or `default'
1335 ;; or the end of the buffer.
1336 (if (re-search-forward "machine\\>\\|default\\>" nil t)
1339 machine login password account)
1340 (setq machine (ange-ftp-parse-netrc-token "machine" end)
1341 login (ange-ftp-parse-netrc-token "login" end)
1342 password (ange-ftp-parse-netrc-token "password" end)
1343 account (ange-ftp-parse-netrc-token "account" end))
1344 (if (and machine login)
1345 ;; found a `machine` token.
1347 (ange-ftp-set-user machine login)
1348 (ange-ftp-set-passwd machine login password)
1350 (ange-ftp-set-account machine login account)))
1352 (if (search-forward "default" end t)
1353 ;; found a `default' token
1355 (setq login (ange-ftp-parse-netrc-token "login" end)
1356 password (ange-ftp-parse-netrc-token "password" end)
1357 account (ange-ftp-parse-netrc-token "account" end))
1359 (setq ange-ftp-netrc-default-user login))
1361 (setq ange-ftp-netrc-default-password password))
1363 (setq ange-ftp-netrc-default-account account)))))
1366 ;; Read in ~/.netrc, if one exists. If ~/.netrc file exists and has
1367 ;; the correct permissions then extract the \`machine\', \`login\',
1368 ;; \`password\' and \`account\' information from within.
1370 (defun ange-ftp-parse-netrc ()
1371 ;; We set this before actually doing it to avoid the possibility
1372 ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file.
1375 (let ((default-directory "/"))
1376 (setq file (ange-ftp-chase-symlinks
1377 (ange-ftp-real-expand-file-name ange-ftp-netrc-filename)))
1378 (setq attr (ange-ftp-real-file-attributes file)))
1379 (if (and attr ; file exists.
1380 (not (equal (nth 5 attr) ange-ftp-netrc-modtime))) ; file changed
1382 (if (or ange-ftp-disable-netrc-security-check
1383 (and (eq (nth 2 attr) (user-uid)) ; Same uids.
1384 (string-match ".r..------" (nth 8 attr))))
1385 (with-current-buffer
1386 ;; we are cheating a bit here. I'm trying to do the equivalent
1387 ;; of find-file on the .netrc file, but then nuke it afterwards.
1388 ;; with the bit of logic below we should be able to have
1389 ;; encrypted .netrc files.
1390 (generate-new-buffer "*ftp-.netrc*")
1391 (ange-ftp-real-insert-file-contents file)
1392 (setq buffer-file-name file)
1393 (setq default-directory (file-name-directory file))
1395 (run-hooks 'find-file-hook)
1396 (setq buffer-file-name nil)
1397 (goto-char (point-min))
1398 (while (search-forward-regexp "^[ \t]*#.*$" nil t)
1400 (goto-char (point-min))
1401 (skip-chars-forward " \t\r\n")
1403 (ange-ftp-parse-netrc-group))
1404 (kill-buffer (current-buffer)))
1405 (ange-ftp-message "%s either not owned by you or badly protected."
1406 ange-ftp-netrc-filename)
1408 (setq ange-ftp-netrc-modtime (nth 5 attr))))))
1410 ;; Return a list of prefixes of the form 'user@host:' to be used when
1411 ;; completion is done in the root directory.
1413 (defun ange-ftp-generate-root-prefixes ()
1414 (ange-ftp-parse-netrc)
1419 (if (string-match "\\`[^/]*\\(/\\).*\\'" key)
1420 (let ((host (substring key 0 (match-beginning 1)))
1421 (user (substring key (match-end 1))))
1422 (push (concat user "@" host ":") res))))
1423 ange-ftp-passwd-hashtable)
1425 (lambda (host user) (push (concat host ":") res))
1426 ange-ftp-user-hashtable)
1427 (or res (list nil)))))
1429 ;;;; ------------------------------------------------------------
1430 ;;;; Remote file name syntax support.
1431 ;;;; ------------------------------------------------------------
1433 (defmacro ange-ftp-ftp-name-component (n ns name)
1434 "Extract the Nth FTP file name component from NS."
1435 `(let ((elt (nth ,n ,ns)))
1436 (match-string elt ,name)))
1438 (defvar ange-ftp-ftp-name-arg "")
1439 (defvar ange-ftp-ftp-name-res nil)
1441 ;; Parse NAME according to `ange-ftp-name-format' (which see).
1442 ;; Returns a list (HOST USER NAME), or nil if NAME does not match the format.
1443 (defun ange-ftp-ftp-name (name)
1444 (if (string-equal name ange-ftp-ftp-name-arg)
1445 ange-ftp-ftp-name-res
1446 (setq ange-ftp-ftp-name-arg name
1447 ange-ftp-ftp-name-res
1449 (if (posix-string-match (car ange-ftp-name-format) name)
1450 (let* ((ns (cdr ange-ftp-name-format))
1451 (host (ange-ftp-ftp-name-component 0 ns name))
1452 (user (ange-ftp-ftp-name-component 1 ns name))
1453 (name (ange-ftp-ftp-name-component 2 ns name)))
1454 (if (zerop (length user))
1455 (setq user (ange-ftp-get-user host)))
1456 (list host user name))
1459 ;; Take a FULLNAME that matches according to ange-ftp-name-format and
1460 ;; replace the name component with NAME.
1461 (defun ange-ftp-replace-name-component (fullname name)
1463 (if (posix-string-match (car ange-ftp-name-format) fullname)
1464 (let* ((ns (cdr ange-ftp-name-format))
1466 (concat (substring fullname 0 (match-beginning elt))
1468 (substring fullname (match-end elt)))))))
1470 ;;;; ------------------------------------------------------------
1471 ;;;; Miscellaneous utils.
1472 ;;;; ------------------------------------------------------------
1474 ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap))
1475 ;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer)
1477 (defun ange-ftp-repaint-minibuffer ()
1478 "Clear any existing minibuffer message; let the minibuffer contents show."
1481 ;; Return the name of the buffer that collects output from the ftp process
1482 ;; connected to the given HOST and USER pair.
1483 (defun ange-ftp-ftp-process-buffer (host user)
1484 (concat "*ftp " user "@" host "*"))
1486 ;; Display the last chunk of output from the ftp process for the given HOST
1487 ;; USER pair, and signal an error including MSG in the text.
1488 (defun ange-ftp-error (host user msg)
1489 (save-excursion ;; Prevent pop-to-buffer from changing current buffer.
1490 (let ((cur (selected-window))
1494 (ange-ftp-ftp-process-buffer host user)))
1495 (goto-char (point-max))
1496 (select-window cur))
1497 (signal 'ftp-error (list (format "FTP Error: %s" msg)))))
1499 (defun ange-ftp-set-buffer-mode ()
1500 "Set correct modes for the current buffer if visiting a remote file."
1501 (if (and (stringp buffer-file-name)
1502 (ange-ftp-ftp-name buffer-file-name))
1503 (auto-save-mode ange-ftp-auto-save)))
1505 (defun ange-ftp-kill-ftp-process (&optional buffer)
1506 "Kill the FTP process associated with BUFFER (the current buffer, if nil).
1507 If the BUFFER's visited filename or `default-directory' is an FTP filename
1508 then kill the related FTP process."
1509 (interactive "bKill FTP process associated with buffer: ")
1511 (setq buffer (current-buffer))
1512 (setq buffer (get-buffer buffer)))
1513 (let ((file (or (buffer-file-name buffer)
1514 (with-current-buffer buffer default-directory))))
1516 (let ((parsed (ange-ftp-ftp-name (expand-file-name file))))
1518 (let ((host (nth 0 parsed))
1519 (user (nth 1 parsed)))
1520 (kill-buffer (get-buffer (ange-ftp-ftp-process-buffer host user)))))))))
1522 (defun ange-ftp-quote-string (string)
1523 "Quote any characters in STRING that may confuse the FTP process."
1524 ;; This is said to be wrong; ftp is said to need quoting only for ",
1525 ;; and that by doubling it. But experiment says UNIX-style kind of
1526 ;; quoting is correct when talking to ftp on GNU/Linux systems, and
1527 ;; W32-style kind of quoting on, yes, W32 systems.
1528 (if (stringp string)
1529 (shell-quote-argument string)
1532 (defun ange-ftp-barf-if-not-directory (directory)
1533 (or (file-directory-p directory)
1535 (list "Opening directory"
1536 (if (file-exists-p directory)
1538 "no such file or directory")
1541 ;;;; ------------------------------------------------------------
1542 ;;;; FTP process filter support.
1543 ;;;; ------------------------------------------------------------
1545 (defun ange-ftp-process-handle-line (line proc)
1546 "Look at the given LINE from the FTP process PROC.
1547 Try to categorize it into one of four categories:
1548 good, skip, fatal, or unknown."
1549 (cond ((string-match ange-ftp-xfer-size-msgs line)
1550 (setq ange-ftp-xfer-size
1551 (/ (string-to-number (match-string 1 line))
1553 ((string-match ange-ftp-skip-msgs line)
1555 ((string-match ange-ftp-good-msgs line)
1556 (setq ange-ftp-process-busy nil
1557 ange-ftp-process-result t
1558 ange-ftp-pending-error-line nil
1559 ange-ftp-process-result-line line))
1560 ;; Check this before checking for errors.
1561 ;; Otherwise the last line of these three seems to be an error:
1562 ;; 230-see a significant impact from the move. For those of you who can't
1563 ;; 230-use DNS to resolve hostnames and get an error message like
1564 ;; 230-"ftp.stsci.edu: unknown host", the new IP address will be...
1565 ((string-match ange-ftp-multi-msgs line)
1566 (setq ange-ftp-process-multi-skip t))
1567 ((string-match ange-ftp-potential-error-msgs line)
1568 ;; This looks like an error, but we have to keep reading the output
1569 ;; to see if it was fixed or not. E.g. it may indicate that IPv6
1570 ;; failed, but maybe a subsequent IPv4 fallback succeeded.
1571 (set (make-local-variable 'ange-ftp-pending-error-line) line)
1573 ((string-match ange-ftp-fatal-msgs line)
1574 (delete-process proc)
1575 (setq ange-ftp-process-busy nil
1576 ange-ftp-process-result-line line))
1577 (ange-ftp-process-multi-skip
1580 (setq ange-ftp-process-busy nil
1581 ange-ftp-process-result-line line))))
1583 (defun ange-ftp-set-xfer-size (host user bytes)
1584 "Set the size of the next FTP transfer in bytes."
1585 (let ((proc (ange-ftp-get-process host user)))
1587 (let ((buf (process-buffer proc)))
1589 (with-current-buffer buf
1590 (setq ange-ftp-xfer-size
1591 ;; For very large files, BYTES can be a float.
1592 (if (integerp bytes)
1594 (/ bytes 1024)))))))))
1596 (defun ange-ftp-process-handle-hash (string)
1597 "Remove hash marks from STRING and display count so far."
1598 (setq string (concat (substring string 0 (match-beginning 0))
1599 (substring string (match-end 0)))
1600 ange-ftp-hash-mark-count (+ (- (match-end 0)
1601 (match-beginning 0))
1602 ange-ftp-hash-mark-count))
1603 (and ange-ftp-hash-mark-unit
1604 ange-ftp-process-msg
1605 ange-ftp-process-verbose
1606 (not (eq (selected-window) (minibuffer-window)))
1607 (not (boundp 'search-message)) ;screws up isearch otherwise
1608 (not cursor-in-echo-area) ;screws up y-or-n-p otherwise
1609 (let ((kbytes (ash (* ange-ftp-hash-mark-unit
1610 ange-ftp-hash-mark-count)
1612 (if (zerop ange-ftp-xfer-size)
1613 (ange-ftp-message "%s...%dk" ange-ftp-process-msg kbytes)
1614 (let ((percent (/ (* 100 kbytes) ange-ftp-xfer-size)))
1615 ;; cut out the redisplay of identical %-age messages.
1616 (unless (eq percent ange-ftp-last-percent)
1617 (setq ange-ftp-last-percent percent)
1618 (ange-ftp-message "%s...%d%%" ange-ftp-process-msg percent))))))
1621 ;; Call the function specified by CONT. CONT can be either a function
1622 ;; or a list of a function and some args. The first two parameters
1623 ;; passed to the function will be RESULT and LINE. The remaining args
1624 ;; will be taken from CONT if a list was passed.
1626 (defun ange-ftp-call-cont (cont result line)
1628 (if (and (listp cont)
1629 (not (eq (car cont) 'lambda)))
1630 (apply (car cont) result line (cdr cont))
1631 (funcall cont result line))))
1633 ;; Build up a complete line of output from the ftp PROCESS and pass it
1634 ;; on to ange-ftp-process-handle-line to deal with.
1636 (defun ange-ftp-process-filter (proc str)
1638 (while (string-match "\000+" str)
1639 (setq str (replace-match "" nil nil str)))
1641 ;; see if the buffer is still around... it could have been deleted.
1642 (when (buffer-live-p (process-buffer proc))
1643 (with-current-buffer (process-buffer proc)
1645 ;; handle hash mark printing
1646 (and ange-ftp-process-busy
1647 (string-match "^#+$" str)
1648 (setq str (ange-ftp-process-handle-hash str)))
1649 (comint-output-filter proc str)
1650 ;; Replace STR by the result of the comint processing.
1651 (setq str (buffer-substring comint-last-output-start
1652 (process-mark proc)))
1653 (when ange-ftp-process-busy
1654 (setq ange-ftp-process-string (concat ange-ftp-process-string
1657 ;; if we gave an empty password to the USER command earlier
1658 ;; then we should send a null password now.
1659 (if (string-match "Password: *$" ange-ftp-process-string)
1660 (process-send-string proc "\n")))
1661 (while (and ange-ftp-process-busy
1662 (string-match "\n" ange-ftp-process-string))
1663 (let ((line (substring ange-ftp-process-string
1665 (match-beginning 0)))
1667 (setq ange-ftp-process-string (substring ange-ftp-process-string
1669 (while (string-match "\\`ftp> *" line)
1670 (setq seen-prompt t)
1671 (setq line (substring line (match-end 0))))
1672 (if (not (and seen-prompt ange-ftp-pending-error-line))
1673 (ange-ftp-process-handle-line line proc)
1674 ;; If we've seen a potential error message and it
1675 ;; hasn't been canceled by a good message before
1676 ;; seeing a prompt, then the error was real.
1677 (delete-process proc)
1678 (setq ange-ftp-process-busy nil
1679 ange-ftp-process-result-line ange-ftp-pending-error-line))))
1681 ;; has the ftp client finished? if so then do some clean-up
1683 (unless ange-ftp-process-busy
1684 ;; reset the xfer size
1685 (setq ange-ftp-xfer-size 0)
1687 ;; issue the "done" message since we've finished.
1688 (when (and ange-ftp-process-msg
1689 ange-ftp-process-verbose
1690 ange-ftp-process-result)
1691 (ange-ftp-message "%s...done" ange-ftp-process-msg)
1692 (ange-ftp-repaint-minibuffer)
1693 (setq ange-ftp-process-msg nil))
1695 ;; is there a continuation we should be calling? if so,
1696 ;; we'd better call it, making sure we only call it once.
1697 (when ange-ftp-process-continue
1698 (let ((cont ange-ftp-process-continue))
1699 (setq ange-ftp-process-continue nil)
1700 (ange-ftp-call-cont cont
1701 ange-ftp-process-result
1702 ange-ftp-process-result-line)))))))
1704 (defun ange-ftp-process-sentinel (proc str)
1705 "When FTP process changes state, nuke all file-entries in cache."
1706 (let ((name (process-name proc)))
1707 (when (string-match "\\*ftp \\([^@]+\\)@\\([^*]+\\)\\*" name)
1708 (let ((user (match-string 1 name))
1709 (host (match-string 2 name)))
1710 (ange-ftp-wipe-file-entries host user))))
1711 (setq ange-ftp-ls-cache-file nil))
1713 ;;;; ------------------------------------------------------------
1714 ;;;; Gateway support.
1715 ;;;; ------------------------------------------------------------
1717 (defun ange-ftp-use-gateway-p (host)
1718 "Return whether to access this HOST via a normal (non-smart) gateway."
1719 ;; yes, I know that I could simplify the following expression, but it is
1720 ;; clearer (to me at least) this way.
1721 (and (not ange-ftp-smart-gateway)
1722 (not (string-match-p ange-ftp-local-host-regexp host))))
1724 (defun ange-ftp-use-smart-gateway-p (host)
1725 "Returns whether to access this HOST via a smart gateway."
1726 (and ange-ftp-smart-gateway
1727 (not (string-match-p ange-ftp-local-host-regexp host))))
1730 ;;; ------------------------------------------------------------
1731 ;;; Temporary file location and deletion...
1732 ;;; ------------------------------------------------------------
1734 (defun ange-ftp-make-tmp-name (host &optional suffix)
1735 "This routine will return the name of a new file."
1736 (make-temp-file (if (ange-ftp-use-gateway-p host)
1737 ange-ftp-gateway-tmp-name-template
1738 ange-ftp-tmp-name-template)
1741 (defun ange-ftp-del-tmp-name (filename)
1742 "Force to delete temporary file."
1743 (delete-file filename))
1746 ;;;; ------------------------------------------------------------
1747 ;;;; Interactive gateway program support.
1748 ;;;; ------------------------------------------------------------
1750 (defvar ange-ftp-gwp-running t)
1751 (defvar ange-ftp-gwp-status nil)
1753 (defun ange-ftp-gwp-sentinel (proc str)
1754 (setq ange-ftp-gwp-running nil))
1756 (defun ange-ftp-gwp-filter (proc str)
1757 (comint-output-filter proc str)
1758 (with-current-buffer (process-buffer proc)
1759 ;; Replace STR by the result of the comint processing.
1760 (setq str (buffer-substring comint-last-output-start (process-mark proc))))
1761 (cond ((string-match "login: *$" str)
1762 (process-send-string proc
1764 (let ((ange-ftp-default-user t))
1765 (ange-ftp-get-user ange-ftp-gateway-host))
1767 ((string-match "Password: *$" str)
1768 (process-send-string proc
1770 (ange-ftp-get-passwd ange-ftp-gateway-host
1772 ange-ftp-gateway-host))
1774 ((string-match ange-ftp-gateway-fatal-msgs str)
1775 (delete-process proc)
1776 (setq ange-ftp-gwp-running nil))
1777 ((string-match ange-ftp-gateway-prompt-pattern str)
1778 (setq ange-ftp-gwp-running nil
1779 ange-ftp-gwp-status t))))
1781 (defun ange-ftp-gwp-start (host user name args)
1782 "Login to the gateway machine and fire up an FTP process."
1783 ;; If `non-essential' is non-nil, don't reopen a new connection. It
1784 ;; will be caught in Tramp.
1786 (throw 'non-essential 'non-essential))
1787 (let (;; It would be nice to make process-connection-type nil,
1788 ;; but that doesn't work: ftp never responds.
1789 ;; Can anyone find a fix for that?
1790 (proc (let ((process-connection-type t))
1791 (start-process name name
1792 ange-ftp-gateway-program
1793 ange-ftp-gateway-host)))
1794 (ftp (mapconcat 'identity args " ")))
1795 (set-process-query-on-exit-flag proc nil)
1796 (set-process-sentinel proc 'ange-ftp-gwp-sentinel)
1797 (set-process-filter proc 'ange-ftp-gwp-filter)
1798 (with-current-buffer (process-buffer proc)
1799 (goto-char (point-max))
1800 (set-marker (process-mark proc) (point)))
1801 (setq ange-ftp-gwp-running t
1802 ange-ftp-gwp-status nil)
1803 (ange-ftp-message "Connecting to gateway %s..." ange-ftp-gateway-host)
1804 (while ange-ftp-gwp-running ;perform login sequence
1805 (accept-process-output proc))
1806 (unless ange-ftp-gwp-status
1807 (ange-ftp-error host user "unable to login to gateway"))
1808 (ange-ftp-message "Connecting to gateway %s...done" ange-ftp-gateway-host)
1809 (setq ange-ftp-gwp-running t
1810 ange-ftp-gwp-status nil)
1811 (process-send-string proc ange-ftp-gateway-setup-term-command)
1812 (while ange-ftp-gwp-running ;zap ^M's and double echoing.
1813 (accept-process-output proc))
1814 (unless ange-ftp-gwp-status
1815 (ange-ftp-error host user "unable to set terminal modes on gateway"))
1816 (setq ange-ftp-gwp-running t
1817 ange-ftp-gwp-status nil)
1818 (process-send-string proc (concat "exec " ftp "\n")) ;spawn ftp process
1821 ;;;; ------------------------------------------------------------
1822 ;;;; Support for sending commands to the ftp process.
1823 ;;;; ------------------------------------------------------------
1825 (defun ange-ftp-raw-send-cmd (proc cmd &optional msg cont nowait)
1826 "Low-level routine to send the given FTP CMD to the FTP process PROC.
1827 MSG is an optional message to output before and after the command.
1828 If CONT is non-nil then it is either a function or a list of function
1829 and some arguments. The function will be called when the FTP command
1831 If CONT is nil then this routine will return (RESULT . LINE) where RESULT
1832 is whether the command was successful, and LINE is the line from the FTP
1833 process that caused the command to complete.
1834 If NOWAIT is given then the routine will return immediately the command has
1835 been queued with no result. CONT will still be called, however."
1836 (if (memq (process-status proc) '(run open))
1837 (with-current-buffer (process-buffer proc)
1838 (ange-ftp-wait-not-busy proc)
1839 (setq ange-ftp-process-string ""
1840 ange-ftp-process-result-line ""
1841 ange-ftp-process-busy t
1842 ange-ftp-process-result nil
1843 ange-ftp-process-multi-skip nil
1844 ange-ftp-process-msg msg
1845 ange-ftp-process-continue cont
1846 ange-ftp-hash-mark-count 0
1847 ange-ftp-last-percent -1
1848 cmd (concat cmd "\n"))
1849 (and msg ange-ftp-process-verbose (ange-ftp-message "%s..." msg))
1850 (goto-char (point-max))
1851 (move-marker comint-last-input-start (point))
1852 ;; don't insert the password into the buffer on the USER command.
1854 (if (string-match "\\`user \"[^\"]*\"" cmd)
1855 (insert (substring cmd 0 (match-end 0)) " Turtle Power!\n")
1857 (move-marker comint-last-input-end (point))
1858 (process-send-string proc cmd)
1859 (set-marker (process-mark proc) (point))
1862 (ange-ftp-wait-not-busy proc)
1864 nil ;cont has already been called
1865 (cons ange-ftp-process-result ange-ftp-process-result-line))))))
1867 ;; Wait for the ange-ftp process PROC not to be busy.
1868 (defun ange-ftp-wait-not-busy (proc)
1869 (with-current-buffer (process-buffer proc)
1871 ;; This is a kludge to let user quit in case ftp gets hung.
1872 ;; It matters because this function can be called from the filter.
1873 ;; It is bad to allow quitting in a filter, but getting hung
1874 ;; is worse. By binding quit-flag to nil, we might avoid
1875 ;; most of the probability of getting screwed because the user
1876 ;; wants to quit some command.
1877 (let ((quit-flag nil)
1879 (while ange-ftp-process-busy
1880 (accept-process-output proc)))
1882 ;; If the user does quit out of this,
1883 ;; kill the process. That stops any transfer in progress.
1884 ;; The next operation will open a new ftp connection.
1885 (delete-process proc)
1886 (signal 'quit nil)))))
1888 (defun ange-ftp-nslookup-host (hostname)
1889 "Attempt to resolve the given HOSTNAME using nslookup if possible."
1890 (interactive "sHost: ")
1891 (if ange-ftp-nslookup-program
1892 (let ((default-directory
1893 (if (file-accessible-directory-p default-directory)
1896 ;; It would be nice to make process-connection-type nil,
1897 ;; but that doesn't work: ftp never responds.
1898 ;; Can anyone find a fix for that?
1899 (proc (let ((process-connection-type t))
1900 (start-process " *nslookup*" " *nslookup*"
1901 ange-ftp-nslookup-program hostname)))
1903 (set-process-query-on-exit-flag proc nil)
1904 (with-current-buffer (process-buffer proc)
1905 (while (memq (process-status proc) '(run open))
1906 (accept-process-output proc))
1907 (goto-char (point-min))
1908 (if (re-search-forward "Name:.*\nAddress: *\\(.*\\)$" nil t)
1909 (setq res (match-string 1)))
1910 (kill-buffer (current-buffer)))
1914 (defun ange-ftp-start-process (host user name)
1915 "Spawn a new FTP process ready to connect to machine HOST and give it NAME.
1916 If HOST is only FTP-able through a gateway machine then spawn a shell
1917 on the gateway machine to do the FTP instead."
1918 ;; If `non-essential' is non-nil, don't reopen a new connection. It
1919 ;; will be caught in Tramp.
1921 (throw 'non-essential 'non-essential))
1922 (let* ((use-gateway (ange-ftp-use-gateway-p host))
1923 (use-smart-ftp (and (not ange-ftp-gateway-host)
1924 (ange-ftp-use-smart-gateway-p host)))
1925 (ftp-prog (if (or use-gateway
1927 ange-ftp-gateway-ftp-program-name
1928 ange-ftp-ftp-program-name))
1929 (args (append (list ftp-prog) ange-ftp-ftp-program-args))
1930 ;; Without the following binding, ange-ftp-start-process
1931 ;; recurses on file-accessible-directory-p, since it needs to
1932 ;; restart its process in order to determine anything about
1933 ;; default-directory.
1934 (file-name-handler-alist)
1936 (if (file-accessible-directory-p default-directory)
1940 ;; It would be nice to make process-connection-type nil,
1941 ;; but that doesn't work: ftp never responds.
1942 ;; Can anyone find a fix for that?
1943 (let ((process-connection-type t)
1944 ;; Copy this so we don't alter it permanently.
1945 (process-environment (copy-tree process-environment))
1946 (buffer (get-buffer-create name)))
1947 (with-current-buffer buffer
1948 (internal-ange-ftp-mode))
1949 ;; This tells GNU ftp not to output any fancy escape sequences.
1950 (setenv "TERM" "dumb")
1952 (if ange-ftp-gateway-program-interactive
1953 (setq proc (ange-ftp-gwp-start host user name args))
1954 (setq proc (apply 'start-process name name
1955 (append (list ange-ftp-gateway-program
1956 ange-ftp-gateway-host)
1958 (setq proc (apply 'start-process name name args))))
1959 (with-current-buffer (process-buffer proc)
1960 (goto-char (point-max))
1961 (set-marker (process-mark proc) (point)))
1962 (set-process-query-on-exit-flag proc nil)
1963 (set-process-sentinel proc 'ange-ftp-process-sentinel)
1964 (set-process-filter proc 'ange-ftp-process-filter)
1965 ;; On Windows, the standard ftp client buffers its output (because
1966 ;; stdout is a pipe handle) so the startup message may never appear:
1967 ;; `accept-process-output' at this point would hang indefinitely.
1968 ;; However, sending an innocuous command ("help foo") forces some
1969 ;; output that will be ignored, which is just as good. Once we
1970 ;; start sending normal commands, the output no longer appears to be
1971 ;; buffered, and everything works correctly. My guess is that the
1972 ;; output of interest is being sent to stderr which is not buffered.
1973 (when (eq system-type 'windows-nt)
1974 ;; force ftp output to be treated as DOS text, otherwise the
1975 ;; output of "help foo" confuses the EOL detection logic.
1976 (set-process-coding-system proc 'raw-text-dos)
1977 (process-send-string proc "help foo\n"))
1978 (accept-process-output proc) ;wait for ftp startup message
1981 (define-derived-mode internal-ange-ftp-mode comint-mode "Internal Ange-ftp"
1982 "Major mode for interacting with the FTP process.
1984 \\{comint-mode-map}"
1985 (make-local-variable 'ange-ftp-process-string)
1986 (setq ange-ftp-process-string "")
1987 (make-local-variable 'ange-ftp-process-busy)
1988 (make-local-variable 'ange-ftp-process-result)
1989 (make-local-variable 'ange-ftp-process-msg)
1990 (make-local-variable 'ange-ftp-process-multi-skip)
1991 (make-local-variable 'ange-ftp-process-result-line)
1992 (make-local-variable 'ange-ftp-process-continue)
1993 (make-local-variable 'ange-ftp-hash-mark-count)
1994 (make-local-variable 'ange-ftp-binary-hash-mark-size)
1995 (make-local-variable 'ange-ftp-ascii-hash-mark-size)
1996 (make-local-variable 'ange-ftp-hash-mark-unit)
1997 (make-local-variable 'ange-ftp-xfer-size)
1998 (make-local-variable 'ange-ftp-last-percent)
1999 (setq ange-ftp-hash-mark-count 0)
2000 (setq ange-ftp-xfer-size 0)
2001 (setq ange-ftp-process-result-line "")
2002 (setq comint-prompt-regexp "^ftp> ")
2003 (make-local-variable 'comint-password-prompt-regexp)
2004 ;; This is a regexp that can't match anything.
2005 ;; ange-ftp has its own ways of handling passwords.
2006 (setq comint-password-prompt-regexp "\\`a\\`")
2007 (make-local-variable 'paragraph-start)
2008 (setq paragraph-start comint-prompt-regexp))
2010 (defcustom ange-ftp-raw-login nil
2011 "Use raw FTP commands for login, if account password is not nil.
2012 Some FTP implementations need this, e.g. ftp in NT 4.0."
2017 (defun ange-ftp-smart-login (host user password account proc)
2018 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
2019 PROC is the FTP-client's process. This routine uses the smart-gateway
2020 host specified in `ange-ftp-gateway-host'."
2021 (let ((result (ange-ftp-raw-send-cmd
2023 (format "open %s %s"
2024 (ange-ftp-nslookup-host ange-ftp-gateway-host)
2025 ange-ftp-smart-gateway-port)
2026 (format "Opening FTP connection to %s via %s"
2028 ange-ftp-gateway-host))))
2030 (ange-ftp-error host user
2031 (concat "OPEN request failed: "
2033 (setq result (ange-ftp-raw-send-cmd
2034 proc (format "user \"%s\"@%s %s %s"
2036 (ange-ftp-nslookup-host host)
2039 (format "Logging in as user %s@%s"
2043 (ange-ftp-set-passwd host user nil) ; reset password
2044 (ange-ftp-set-account host user nil) ; reset account
2045 (ange-ftp-error host user
2046 (concat "USER request failed: "
2049 (defun ange-ftp-normal-login (host user password account proc)
2050 "Connect to the FTP-server on HOST as USER using PASSWORD and ACCOUNT.
2051 PROC is the process to the FTP-client. HOST may have an optional
2052 suffix of the form #PORT to specify a non-default port."
2054 (string-match "\\`\\([^#]+\\)\\(#\\([0-9]+\\)\\)?\\'" host)
2055 (let* ((nshost (ange-ftp-nslookup-host (match-string 1 host)))
2056 (port (match-string 3 host))
2057 (result (ange-ftp-raw-send-cmd
2060 (format "open %s %s" nshost port)
2061 (format "open %s" nshost))
2062 (format "Opening FTP connection to %s" host))))
2064 (ange-ftp-error host user
2065 (concat "OPEN request failed: "
2067 (if (not (and ange-ftp-raw-login (string< "" account)))
2068 (setq result (ange-ftp-raw-send-cmd
2070 (if (and (ange-ftp-use-smart-gateway-p host)
2071 ange-ftp-gateway-host)
2072 (format "user \"%s\"@%s %s %s"
2073 user nshost password account)
2074 (format "user \"%s\" %s %s" user password account))
2075 (format "Logging in as user %s@%s" user host)))
2076 (let ((good ange-ftp-good-msgs)
2077 (skip ange-ftp-skip-msgs))
2078 (setq ange-ftp-good-msgs (concat ange-ftp-good-msgs
2079 "\\|^331 \\|^332 "))
2080 (if (string-match (regexp-quote "\\|^331 ") ange-ftp-skip-msgs)
2081 (setq ange-ftp-skip-msgs
2082 (replace-match "" t t ange-ftp-skip-msgs)))
2083 (if (string-match (regexp-quote "\\|^332 ") ange-ftp-skip-msgs)
2084 (setq ange-ftp-skip-msgs
2085 (replace-match "" t t ange-ftp-skip-msgs)))
2086 (setq result (ange-ftp-raw-send-cmd
2088 (format "quote \"USER %s\"" user)
2089 (format "Logging in as user %s@%s" user host)))
2091 (setq result (ange-ftp-raw-send-cmd
2093 (format "quote \"PASS %s\"" password)
2094 (format "Logging in as user %s@%s" user host)))
2096 (setq result (ange-ftp-raw-send-cmd
2098 (format "quote \"ACCT %s\"" account)
2099 (format "Logging in as user %s@%s" user host)))
2101 (setq ange-ftp-good-msgs good
2102 ange-ftp-skip-msgs skip)))
2105 (ange-ftp-set-passwd host user nil) ;reset password.
2106 (ange-ftp-set-account host user nil) ;reset account.
2107 (ange-ftp-error host user
2108 (concat "USER request failed: "
2111 ;; ange@hplb.hpl.hp.com says this should not be changed.
2112 (defvar ange-ftp-hash-mark-msgs
2113 "[hH]ash mark [^0-9]*\\([0-9]+\\)"
2114 "Regexp matching the FTP client's output upon doing a HASH command.")
2116 (defun ange-ftp-guess-hash-mark-size (proc)
2117 (if ange-ftp-send-hash
2118 (with-current-buffer (process-buffer proc)
2119 (let* ((status (ange-ftp-raw-send-cmd proc "hash"))
2120 (line (cdr status)))
2122 (if (string-match ange-ftp-hash-mark-msgs line)
2123 (let ((size (string-to-number (match-string 1 line))))
2124 (setq ange-ftp-ascii-hash-mark-size size
2125 ange-ftp-hash-mark-unit (ash size -4))
2127 ;; if a default value for this is set, use that value.
2128 (or ange-ftp-binary-hash-mark-size
2129 (setq ange-ftp-binary-hash-mark-size size)))))))))
2131 (defvar ange-ftp-process-startup-hook nil)
2133 (defun ange-ftp-get-process (host user)
2134 "Return an FTP subprocess connected to HOST and logged in as USER.
2135 Create a new process if needed."
2136 (let* ((name (ange-ftp-ftp-process-buffer host user))
2137 (proc (get-process name)))
2138 (if (and proc (memq (process-status proc) '(run open)))
2140 ;; If `non-essential' is non-nil, don't reopen a new connection. It
2141 ;; will be caught in Tramp.
2143 (throw 'non-essential 'non-essential))
2145 ;; Must delete dead process so that new process can reuse the name.
2146 (if proc (delete-process proc))
2147 (let ((pass (ange-ftp-quote-string
2148 (ange-ftp-get-passwd host user)))
2149 (account (ange-ftp-quote-string
2150 (ange-ftp-get-account host user))))
2151 ;; grab a suitable process.
2152 (setq proc (ange-ftp-start-process host user name))
2154 ;; login to FTP server.
2155 (if (and (ange-ftp-use-smart-gateway-p host)
2156 ange-ftp-gateway-host)
2157 (ange-ftp-smart-login host user pass account proc)
2158 (ange-ftp-normal-login host user pass account proc))
2160 ;; Tell client to send back hash-marks as progress. It isn't usually
2161 ;; fatal if this command fails.
2162 (ange-ftp-guess-hash-mark-size proc)
2164 ;; Guess at the host type.
2165 (ange-ftp-guess-host-type host user)
2167 ;; Turn passive mode on or off as requested.
2168 (let* ((case-fold-search t)
2170 (or (assoc-default host ange-ftp-passive-host-alist
2172 (if ange-ftp-try-passive-mode "on"))))
2174 (ange-ftp-passive-mode proc passive)))
2176 ;; Run any user-specified hooks. Note that proc, host and user are
2177 ;; dynamically bound at this point.
2178 (let ((ange-ftp-this-user user)
2179 (ange-ftp-this-host host))
2180 (run-hooks 'ange-ftp-process-startup-hook)))
2183 (defun ange-ftp-passive-mode (proc on-or-off)
2184 (if (string-match (concat "Passive mode " on-or-off)
2185 (cdr (ange-ftp-raw-send-cmd
2186 proc (concat "passive " on-or-off)
2187 "Trying passive mode..." nil)))
2188 (ange-ftp-message (concat "Trying passive mode..." on-or-off))
2189 (error "Trying passive mode...failed")))
2191 ;; Variables for caching host and host-type
2192 (defvar ange-ftp-host-cache nil)
2193 (defvar ange-ftp-host-type-cache nil)
2195 ;; If ange-ftp-host-type is called with the optional user
2196 ;; argument, it will attempt to guess the host type by connecting
2197 ;; as user, if necessary. For efficiency, I have tried to give this
2198 ;; optional second argument only when necessary. Have I missed any calls
2199 ;; to ange-ftp-host-type where it should have been supplied?
2201 (defun ange-ftp-host-type (host &optional user)
2202 "Return a symbol which represents the type of the HOST given.
2203 If the optional argument USER is given, attempts to guess the
2204 host-type by logging in as USER."
2205 (cond ((null host) 'unix)
2206 ;; Return `unix' if HOST is nil, since that's the most vanilla
2207 ;; possible return value.
2208 ((eq host ange-ftp-host-cache)
2209 ange-ftp-host-type-cache)
2210 ;; Trigger an ftp connection, in case we need to guess at the host type.
2211 ((and user (ange-ftp-get-process host user) (eq host ange-ftp-host-cache))
2212 ange-ftp-host-type-cache)
2214 (setq ange-ftp-host-cache host
2215 ange-ftp-host-type-cache
2216 (cond ((ange-ftp-dumb-unix-host host)
2218 ;; ((and (fboundp 'ange-ftp-vos-host)
2219 ;; (ange-ftp-vos-host host))
2221 ((and (fboundp 'ange-ftp-vms-host)
2222 (ange-ftp-vms-host host))
2224 ((and (fboundp 'ange-ftp-mts-host)
2225 (ange-ftp-mts-host host))
2227 ((and (fboundp 'ange-ftp-cms-host)
2228 (ange-ftp-cms-host host))
2230 ((and (fboundp 'ange-ftp-bs2000-posix-host)
2231 (ange-ftp-bs2000-posix-host host))
2232 'text-unix) ; POSIX is a non-ASCII Unix
2233 ((and (fboundp 'ange-ftp-bs2000-host)
2234 (ange-ftp-bs2000-host host))
2239 ;; It would be nice to abstract the functions ange-ftp-TYPE-host and
2240 ;; ange-ftp-add-TYPE-host. The trick is to abstract these functions
2241 ;; without sacrificing speed. Also, having separate variables
2242 ;; ange-ftp-TYPE-regexp is more user friendly then requiring the user to
2243 ;; set an alist to indicate that a host is of a given type. Even with
2244 ;; automatic host type recognition, setting a regexp is still a good idea
2245 ;; (for efficiency) if you log into a particular non-UNIX host frequently.
2247 (defvar ange-ftp-fix-name-func-alist nil
2248 "Alist saying how to convert file name to the host's syntax.
2249 Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can
2250 change a UNIX file name into a name more suitable for a host of type TYPE.")
2252 (defvar ange-ftp-fix-dir-name-func-alist nil
2253 "Alist saying how to convert directory name to the host's syntax.
2254 Association list of (TYPE . FUNC) pairs, where FUNC is a routine which can
2255 change UNIX directory name into a directory name more suitable for a host
2258 ;; *** Perhaps the sense of this variable should be inverted, since there
2259 ;; *** is only 1 host type that can take ls-style listing options.
2260 (defvar ange-ftp-dumb-host-types '(dumb-unix)
2261 "List of host types that can't take UNIX ls-style listing options.")
2263 (defun ange-ftp-send-cmd (host user cmd &optional msg cont nowait)
2264 "Find an FTP process connected to HOST logged in as USER and send it CMD.
2265 MSG is an optional status message to be output before and after issuing the
2267 See the documentation for `ange-ftp-raw-send-cmd' for a description of CONT
2269 ;; Handle conversion to remote file name syntax and remote ls option
2271 (let ((cmd0 (car cmd))
2273 (ange-ftp-this-user user)
2274 (ange-ftp-this-host host)
2275 (ange-ftp-this-msg msg)
2276 cmd2 cmd3 host-type fix-name-func result)
2280 ;; pwd case (We don't care what host-type.)
2283 ;; cmd == 'dir "remote-name" "local-name" "ls-switches"
2285 (setq cmd2 (nth 2 cmd)
2286 host-type (ange-ftp-host-type host user))
2287 ;; This will trigger an FTP login, if one doesn't exist
2290 (or (cdr (assq host-type ange-ftp-fix-dir-name-func-alist))
2294 ;; Need to deal with the HP-UX ftp bug. This should also allow us to
2295 ;; resolve symlinks to directories on SysV machines. (Sebastian will
2297 (and (eq host-type 'unix)
2298 (string-match "/\\'" cmd1)
2299 (not (string-match "R" cmd3))
2300 (setq cmd1 (concat cmd1 ".")))
2302 ;; Using "ls -flags foo" has several problems:
2303 ;; - if foo is a symlink, we may get a single line showing the symlink
2304 ;; rather than the listing of the directory it points to.
2305 ;; - if "foo" has spaces, the parsing of the command may be done wrong.
2306 ;; - some version of netbsd's ftpd only accept a single argument after
2307 ;; `ls', which can either be the directory or the flags.
2308 ;; So to work around those problems, we use "cd foo; ls -flags".
2310 ;; If the dir name contains a space, some ftp servers will
2311 ;; refuse to list it. We instead change directory to the
2312 ;; directory in question and ls ".".
2313 (when (string-match " " cmd1)
2314 ;; Keep the result. In case of failure, we will (see below)
2315 ;; short-circuit CMD and return this result directly.
2316 (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror))
2319 ;; If the remote ls can take switches, put them in
2320 (unless (memq host-type ange-ftp-dumb-host-types)
2322 ;; We cd and then use `ls' with no directory argument.
2323 ;; This works around a misfeature of some versions of netbsd ftpd
2324 ;; where `ls' can only take one argument: either one set of flags
2325 ;; or a file/directory name.
2326 ;; If we're trying to `ls' a single file, this fails since we
2327 ;; can't cd to a file. We can't fix this problem here, tho, because
2328 ;; at this point we don't know whether the argument is a file or
2329 ;; a directory. Such an `ls' is only ever used (apparently) from
2330 ;; `insert-directory' when the `full-directory-p' argument is nil
2331 ;; (which seems to only be used by dired when updating its display
2332 ;; after operating on a set of files). So we've changed
2333 ;; `ange-ftp-insert-directory' such that in this case it gets
2334 ;; a full listing of the directory and extracting the line
2335 ;; corresponding to the requested file.
2336 (unless (equal cmd1 ".")
2337 (setq result (ange-ftp-cd host user (nth 1 cmd) 'noerror)))
2340 ;; First argument is the remote name
2342 (setq fix-name-func (or (cdr (assq host-type
2343 ange-ftp-fix-name-func-alist))
2345 (memq cmd0 '(get delete mkdir rmdir cd)))
2346 (setq cmd1 (funcall fix-name-func cmd1)))
2348 ;; Second argument is the remote name
2349 ((or (memq cmd0 '(append put chmod))
2350 (and (eq cmd0 'quote) (member cmd1 '("mdtm" "size"))))
2351 (setq cmd2 (funcall fix-name-func cmd2)))
2352 ;; Both arguments are remote names
2354 (setq cmd1 (funcall fix-name-func cmd1)
2355 cmd2 (funcall fix-name-func cmd2))))
2357 ;; Turn the command into one long string
2358 (setq cmd0 (symbol-name cmd0))
2359 (setq cmd (concat cmd0
2360 (and cmd1 (concat " " cmd1))
2361 (and cmd2 (concat " " cmd2))))
2363 ;; Actually send the resulting command.
2364 (if (and (consp result) (null (car result)))
2365 ;; `ange-ftp-cd' has failed, so there's no point sending `cmd'.
2369 (ange-ftp-raw-send-cmd
2370 (ange-ftp-get-process host user)
2373 (list (lambda (result line host user cmd msg cont nowait)
2374 (or cont (setq afsc-result result
2376 (if result (ange-ftp-call-cont cont result line)
2377 (ange-ftp-raw-send-cmd
2378 (ange-ftp-get-process host user)
2381 (list (lambda (result line cont)
2382 (or cont (setq afsc-result result
2384 (ange-ftp-call-cont cont result line))
2387 host user cmd msg cont nowait)
2394 (cons afsc-result afsc-line)))))))
2396 ;; It might be nice to message users about the host type identified,
2397 ;; but there is so much other messaging going on, it would not be
2398 ;; seen. No point in slowing things down just so users can read
2399 ;; a host type message.
2401 (defconst ange-ftp-cms-name-template
2403 "^[-A-Z0-9$*][-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?"
2404 "[-A-Z0-9$*]?[-A-Z0-9$*]?[-A-Z0-9$*]?\\.[0-9][0-9][0-9A-Z]$"))
2405 (defconst ange-ftp-vms-name-template
2406 "^[-A-Z0-9_$]+:\\[[-A-Z0-9_$]+\\(\\.[-A-Z0-9_$]+\\)*\\]$")
2407 (defconst ange-ftp-mts-name-template
2408 "^[A-Z0-9._][A-Z0-9._][A-Z0-9._][A-Z0-9._]:$")
2409 (defconst ange-ftp-bs2000-filename-pubset-regexp
2411 "Valid pubset for an BS2000 file name.")
2412 (defconst ange-ftp-bs2000-filename-username-regexp
2415 "Valid username for an BS2000 file name.")
2416 (defconst ange-ftp-bs2000-filename-prefix-regexp
2418 ange-ftp-bs2000-filename-pubset-regexp
2419 ange-ftp-bs2000-filename-username-regexp)
2420 "Valid prefix for an BS2000 file name (pubset and user).")
2421 (defconst ange-ftp-bs2000-name-template
2422 (concat "^" ange-ftp-bs2000-filename-prefix-regexp "$"))
2424 (defun ange-ftp-guess-host-type (host user)
2425 "Guess the host type of HOST.
2426 Works by doing a pwd and examining the directory syntax."
2427 (let ((host-type (ange-ftp-host-type host))
2428 (key (concat host "/" user "/~")))
2429 (if (eq host-type 'unix)
2430 ;; Note that ange-ftp-host-type returns unix as the default value.
2432 (let* ((result (ange-ftp-get-pwd host user))
2436 (message "Warning! Unable to get home directory")
2439 "^450 No current working directory defined$"
2442 ;; We'll assume that if pwd bombs with this
2443 ;; error message, then it's CMS.
2445 (ange-ftp-add-cms-host host)
2446 (setq ange-ftp-host-cache host
2447 ange-ftp-host-type-cache 'cms))))
2450 ((string-match ange-ftp-vms-name-template dir)
2451 (ange-ftp-add-vms-host host)
2452 ;; The add-host functions clear the host type cache.
2453 ;; Therefore, need to set the cache afterwards.
2454 (setq ange-ftp-host-cache host
2455 ange-ftp-host-type-cache 'vms))
2458 ((string-match ange-ftp-mts-name-template dir)
2459 (ange-ftp-add-mts-host host)
2460 (setq ange-ftp-host-cache host
2461 ange-ftp-host-type-cache 'mts))
2464 ((string-match ange-ftp-cms-name-template dir)
2465 (ange-ftp-add-cms-host host)
2466 (setq ange-ftp-host-cache host
2467 ange-ftp-host-type-cache 'cms))
2469 ;; try for BS2000-POSIX
2470 ((ange-ftp-bs2000-posix-host host)
2471 (ange-ftp-add-bs2000-host host)
2472 (setq ange-ftp-host-cache host
2473 ange-ftp-host-type-cache 'text-unix))
2475 ((and (string-match ange-ftp-bs2000-name-template dir)
2476 (not (ange-ftp-bs2000-posix-host host)))
2477 (ange-ftp-add-bs2000-host host)
2478 (setq ange-ftp-host-cache host
2479 ange-ftp-host-type-cache 'bs2000))
2482 (setq ange-ftp-host-cache host
2483 ange-ftp-host-type-cache 'unix)))
2485 ;; Now that we have done a pwd, might as well put it in
2486 ;; the expand-dir hashtable.
2487 (let ((ange-ftp-this-user user)
2488 (ange-ftp-this-host host))
2489 (setq fix-name-func (cdr (assq ange-ftp-host-type-cache
2490 ange-ftp-fix-name-func-alist)))
2492 (setq dir (funcall fix-name-func dir 'reverse))))
2493 (puthash key dir ange-ftp-expand-dir-hashtable))))
2495 ;; In the special case of CMS make sure that know the
2496 ;; expansion of the home minidisk now, because we will
2497 ;; be doing a lot of cd's.
2498 (if (and (eq host-type 'cms)
2499 (not (ange-ftp-hash-entry-exists-p
2500 key ange-ftp-expand-dir-hashtable)))
2501 (let ((dir (car (ange-ftp-get-pwd host user))))
2503 (puthash key (concat "/" dir) ange-ftp-expand-dir-hashtable)
2504 (message "Warning! Unable to get home directory")
2508 ;;;; ------------------------------------------------------------
2509 ;;;; Remote file and directory listing support.
2510 ;;;; ------------------------------------------------------------
2512 ;; Returns whether HOST's FTP server doesn't like \'ls\' or \'dir\' commands
2513 ;; to take switch arguments.
2514 (defun ange-ftp-dumb-unix-host (host)
2515 (and host ange-ftp-dumb-unix-host-regexp
2516 (string-match-p ange-ftp-dumb-unix-host-regexp host)))
2518 (defun ange-ftp-add-dumb-unix-host (host)
2519 "Interactively add a given HOST to `ange-ftp-dumb-unix-host-regexp'."
2521 (list (read-string "Host: "
2522 (let ((name (or (buffer-file-name) default-directory)))
2523 (and name (car (ange-ftp-ftp-name name)))))))
2524 (if (not (ange-ftp-dumb-unix-host host))
2525 (setq ange-ftp-dumb-unix-host-regexp
2526 (concat "^" (regexp-quote host) "$"
2527 (and ange-ftp-dumb-unix-host-regexp "\\|")
2528 ange-ftp-dumb-unix-host-regexp)
2529 ange-ftp-host-cache nil)))
2531 (defvar ange-ftp-parse-list-func-alist nil
2532 "Alist saying how to parse directory listings for certain OS types.
2533 Association list of (TYPE . FUNC) pairs. The FUNC is a routine which
2534 can parse the output from a DIR listing for a host of type TYPE.")
2536 ;; With no-error nil, this function returns:
2537 ;; an error if file is not an ange-ftp-name
2538 ;; (This should never happen.)
2539 ;; an error if either the listing is unreadable or there is an ftp error.
2540 ;; the listing (a string), if everything works.
2542 ;; With no-error t, it returns:
2543 ;; an error if not an ange-ftp-name
2544 ;; error if listing is unreadable (most likely caused by a slow connection)
2545 ;; nil if ftp error (this is because although asking to list a nonexistent
2546 ;; directory on a remote unix machine usually (except
2547 ;; maybe for dumb hosts) returns an ls error, but no
2548 ;; ftp error, if the same is done on a VMS machine,
2549 ;; an ftp error is returned. Need to trap the error
2550 ;; so we can go on and try to list the parent.)
2551 ;; the listing, if everything works.
2553 ;; If WILDCARD is non-nil, then this implements the guts of insert-directory
2554 ;; in the wildcard case. Then we make a relative directory listing
2555 ;; of FILE within the directory specified by `default-directory'.
2557 (defvar ange-ftp-before-parse-ls-hook nil
2558 "Normal hook run before parsing the text of an FTP directory listing.")
2560 (defvar ange-ftp-after-parse-ls-hook nil
2561 "Normal hook run after parsing the text of an FTP directory listing.")
2563 (defun ange-ftp-ls (file lsargs parse &optional no-error wildcard)
2564 "Return the output of a `DIR' or `ls' command done over FTP.
2565 FILE is the full name of the remote file, LSARGS is any args to pass to the
2566 `ls' command, and PARSE specifies that the output should be parsed and stored
2567 away in the internal cache."
2568 (when (string-match "^--dired\\s-+" lsargs)
2569 (setq lsargs (replace-match "" nil t lsargs)))
2570 ;; If parse is t, we assume that file is a directory. i.e. we only parse
2571 ;; full directory listings.
2572 (let* ((ange-ftp-this-file (ange-ftp-expand-file-name file))
2573 (parsed (ange-ftp-ftp-name ange-ftp-this-file)))
2575 (let* ((host (nth 0 parsed))
2576 (user (nth 1 parsed))
2577 (name (ange-ftp-quote-string (nth 2 parsed)))
2578 (key (directory-file-name ange-ftp-this-file))
2579 (host-type (ange-ftp-host-type host user))
2580 (dumb (memq host-type ange-ftp-dumb-host-types))
2584 (if (string-equal name "")
2586 (ange-ftp-real-file-name-as-directory
2587 (ange-ftp-expand-dir host user "~"))))
2588 (if (and ange-ftp-ls-cache-file
2589 (string-equal key ange-ftp-ls-cache-file)
2590 ;; Don't care about lsargs for dumb hosts.
2591 (or dumb (string-equal lsargs ange-ftp-ls-cache-lsargs)))
2592 ange-ftp-ls-cache-res
2593 (setq temp (ange-ftp-make-tmp-name host))
2596 (ange-ftp-cd host user (file-name-directory name))
2597 (setq lscmd (list 'ls file temp lsargs)))
2598 (setq lscmd (list 'dir name temp lsargs)))
2600 (if (car (setq result (ange-ftp-send-cmd
2604 (format "Listing %s"
2605 (ange-ftp-abbreviate-filename
2606 ange-ftp-this-file)))))
2607 (with-current-buffer (get-buffer-create
2608 ange-ftp-data-buffer-name)
2610 (if (ange-ftp-real-file-readable-p temp)
2611 (ange-ftp-real-insert-file-contents temp)
2612 (sleep-for ange-ftp-retry-time)
2613 ;wait for file to possibly appear
2614 (if (ange-ftp-real-file-readable-p temp)
2616 (ange-ftp-real-insert-file-contents temp)
2617 (ange-ftp-error host user
2619 "list data file %s not readable"
2621 ;; remove ^M inserted by the w32 ftp client
2622 (while (re-search-forward "\r$" nil t)
2625 (run-hooks 'ange-ftp-before-parse-ls-hook)
2631 (cdr (assq host-type
2632 ange-ftp-parse-list-func-alist)))
2633 (funcall parse-func)
2634 (ange-ftp-parse-dired-listing lsargs))))
2635 ;; Place this hook here to convert the contents of the
2636 ;; buffer to a ls compatible format if the host system
2637 ;; that is being queried is other than Unix i.e. VMS
2638 ;; returns an ls format that really sucks.
2639 (run-hooks 'ange-ftp-after-parse-ls-hook)
2640 (setq ange-ftp-ls-cache-file key
2641 ange-ftp-ls-cache-lsargs lsargs
2642 ; For dumb hosts-types this is
2643 ; meaningless but harmless.
2644 ange-ftp-ls-cache-res (buffer-string))
2645 ;; (kill-buffer (current-buffer))
2646 (if (equal ange-ftp-ls-cache-res "total 0\n")
2647 ;; wu-ftpd seems to return a successful result
2648 ;; with an empty file-listing when doing a
2649 ;; `DIR /some/file/.' which leads ange-ftp to
2650 ;; believe that /some/file is a directory ;-(
2652 ange-ftp-ls-cache-res))
2655 (ange-ftp-error host user
2656 (concat "DIR failed: " (cdr result)))))
2657 (ange-ftp-del-tmp-name temp))))
2658 (error "Should never happen. Please report. Bug ref. no.: 1"))))
2660 ;;;; ------------------------------------------------------------
2661 ;;;; Directory information caching support.
2662 ;;;; ------------------------------------------------------------
2664 (defvar ange-ftp-add-file-entry-alist nil
2665 "Alist saying how to add file entries on certain OS types.
2666 Association list of pairs (TYPE . FUNC), where FUNC is a function
2667 to be used to add a file entry for the OS TYPE.
2668 The main reason for this alist is to deal with file versions in VMS.")
2670 (defvar ange-ftp-delete-file-entry-alist nil
2671 "Alist saying how to delete files on certain OS types.
2672 Association list of pairs (TYPE . FUNC), where FUNC is a function
2673 to be used to delete a file entry for the OS TYPE.
2674 The main reason for this alist is to deal with file versions in VMS.")
2676 (defun ange-ftp-add-file-entry (name &optional dir-p)
2677 "Add a file entry for file NAME, if its directory info exists."
2678 (funcall (or (cdr (assq (ange-ftp-host-type
2679 (car (ange-ftp-ftp-name name)))
2680 ange-ftp-add-file-entry-alist))
2681 'ange-ftp-internal-add-file-entry)
2683 (setq ange-ftp-ls-cache-file nil))
2685 (defun ange-ftp-delete-file-entry (name &optional dir-p)
2686 "Delete the file entry for file NAME, if its directory info exists."
2687 (funcall (or (cdr (assq (ange-ftp-host-type
2688 (car (ange-ftp-ftp-name name)))
2689 ange-ftp-delete-file-entry-alist))
2690 'ange-ftp-internal-delete-file-entry)
2692 (setq ange-ftp-ls-cache-file nil))
2694 (defmacro ange-ftp-parse-filename ()
2695 ;;Extract the filename from the current line of a dired-like listing.
2697 (let ((eol (progn (end-of-line) (point))))
2699 (if (re-search-forward directory-listing-before-filename-regexp eol t)
2700 (buffer-substring (point) eol)))))
2702 ;; This deals with the F switch. Should also do something about
2703 ;; unquoting names obtained with the SysV b switch and the GNU Q
2704 ;; switch. See Sebastian's dired-get-filename.
2706 (defun ange-ftp-ls-parser (switches)
2707 ;; Meant to be called by ange-ftp-parse-dired-listing
2708 (let ((tbl (make-hash-table :test 'equal))
2709 (used-F (and (stringp switches)
2710 (string-match "F" switches)))
2711 file-type symlink directory file)
2712 (while (setq file (ange-ftp-parse-filename))
2714 (skip-chars-forward "\t 0-9")
2715 (setq file-type (following-char)
2716 directory (eq file-type ?d))
2717 (if (eq file-type ?l)
2718 (let ((end (string-match " -> " file)))
2720 ;; Sometimes `ls' appends a @ at the end of the target.
2721 (setq symlink (substring file (match-end 0)
2722 (string-match "@\\'" file))
2723 file (substring file 0 end))
2727 ;; Only do a costly regexp search if the F switch was used.
2729 (not (string-equal file ""))
2731 ".[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"))
2732 (let ((socket (eq file-type ?s))
2734 (and (not symlink) ; x bits don't mean a thing for symlinks
2737 (concat (match-string 1)
2739 (match-string 3))))))
2740 ;; Some ls's with the F switch mark symlinks with an @ (ULTRIX)
2741 ;; and others don't. (sigh...) Beware, that some Unix's don't
2742 ;; seem to believe in the F-switch
2743 (if (or (and symlink (string-match "@\\'" file))
2744 (and directory (string-match "/\\'" file))
2745 (and executable (string-match "*\\'" file))
2746 (and socket (string-match "=\\'" file)))
2747 (setq file (substring file 0 -1)))))
2748 (puthash file (or symlink directory) tbl)
2751 (puthash ".." t tbl)
2754 ;;; The dl stuff for descriptive listings
2756 (defvar ange-ftp-dl-dir-regexp nil
2757 "Regexp matching directories which are listed in dl format.
2758 This regexp should not be anchored with a trailing `$', because it should
2759 match subdirectories as well.")
2761 (defun ange-ftp-add-dl-dir (dir)
2762 "Interactively add a DIR to `ange-ftp-dl-dir-regexp'."
2764 (list (read-string "Directory: "
2765 (let ((name (or (buffer-file-name) default-directory)))
2766 (and name (ange-ftp-ftp-name name)
2767 (file-name-directory name))))))
2768 (if (not (and ange-ftp-dl-dir-regexp
2769 (string-match ange-ftp-dl-dir-regexp dir)))
2770 (setq ange-ftp-dl-dir-regexp
2771 (concat "^" (regexp-quote dir)
2772 (and ange-ftp-dl-dir-regexp "\\|")
2773 ange-ftp-dl-dir-regexp))))
2775 (defmacro ange-ftp-dl-parser ()
2776 ;; Parse the current buffer, which is assumed to be a descriptive
2777 ;; listing, and return a hashtable.
2778 `(let ((tbl (make-hash-table :test 'equal)))
2781 (buffer-substring (point)
2783 (skip-chars-forward "^ /\n")
2785 (eq (following-char) ?/)
2789 (puthash ".." t tbl)
2792 ;; Parse the current buffer which is assumed to be in a dired-like listing
2793 ;; format, and return a hashtable as the result. If the listing is not really
2794 ;; a listing, then return nil.
2796 (defun ange-ftp-parse-dired-listing (&optional switches)
2799 ((looking-at "^total [0-9]+$")
2801 ;; Some systems put in a blank line here.
2802 (if (eolp) (forward-line 1))
2803 (ange-ftp-ls-parser switches))
2804 ((looking-at "[^\n]+\\( not found\\|: Not a directory\\)\n\\'")
2805 ;; It's an ls error message.
2807 ((eobp) ; i.e. (zerop (buffer-size))
2808 ;; This could be one of:
2809 ;; (1) An Ultrix ls error message
2810 ;; (2) A listing with the A switch of an empty directory
2811 ;; on a machine which doesn't give a total line.
2812 ;; (3) The twilight zone.
2813 ;; We'll assume (1) for now.
2815 ((re-search-forward directory-listing-before-filename-regexp nil t)
2817 (ange-ftp-ls-parser switches))
2818 ((re-search-forward "^[^ \n\t]+ +\\([0-9]+\\|-\\|=\\) " nil t)
2819 ;; It's a dl listing (I hope).
2820 ;; file is bound by the call to ange-ftp-ls
2821 (ange-ftp-add-dl-dir ange-ftp-this-file)
2823 (ange-ftp-dl-parser))
2826 (defun ange-ftp-set-files (directory files)
2827 "For a given DIRECTORY, set or change the associated FILES hashtable."
2828 (and files (puthash (file-name-as-directory directory)
2829 files ange-ftp-files-hashtable)))
2831 (defun ange-ftp-switches-ok (switches)
2832 "Return SWITCHES (a string) if suitable for our use."
2833 (and (stringp switches)
2834 ;; We allow the A switch, which lists all files except "." and
2835 ;; "..". This is OK because we manually insert these entries
2836 ;; in the hash table.
2838 "--\\(almost-\\)?all\\>\\|\\(\\`\\| \\)-[[:alpha:]]*[aA]" switches)
2839 (string-match "\\(\\`\\| \\)-[[:alpha:]]*l" switches)
2841 "--recursive\\>\\|\\(\\`\\| \\)-[[:alpha:]]*R" switches))
2844 (defun ange-ftp-get-files (directory &optional no-error)
2845 "Given a DIRECTORY, return a hashtable of file entries.
2846 This will give an error or return nil, depending on the value of
2847 NO-ERROR, if a listing for DIRECTORY cannot be obtained."
2848 (setq directory (file-name-as-directory directory)) ;normalize
2849 (or (gethash directory ange-ftp-files-hashtable)
2851 (and (ange-ftp-ls directory
2852 ;; This is an efficiency hack. We try to
2853 ;; anticipate what sort of listing dired
2854 ;; might want, and cache just such a listing.
2855 (or (and (boundp 'dired-actual-switches)
2856 (ange-ftp-switches-ok dired-actual-switches))
2857 (and (boundp 'dired-listing-switches)
2858 (ange-ftp-switches-ok
2859 dired-listing-switches))
2862 (gethash directory ange-ftp-files-hashtable)))))
2864 ;; Given NAME, return the file part that can be used for looking up the
2865 ;; file's entry in a hashtable.
2866 (defmacro ange-ftp-get-file-part (name)
2867 `(let ((file (file-name-nondirectory ,name)))
2868 (if (string-equal file "")
2872 ;; Return whether ange-ftp-file-entry-p and ange-ftp-get-file-entry are
2873 ;; allowed to determine if NAME is a sub-directory by listing it directly,
2874 ;; rather than listing its parent directory. This is used for efficiency so
2875 ;; that a wasted listing is not done:
2876 ;; 1. When looking for a .dired file in dired-x.el.
2877 ;; 2. The syntax of FILE and DIR make it impossible that FILE could be a valid
2878 ;; subdirectory. This is of course an OS dependent judgment.
2880 (defvar dired-local-variables-file)
2881 (defmacro ange-ftp-allow-child-lookup (dir file)
2883 (let* ((efile ,file) ; expand once.
2885 (parsed (ange-ftp-ftp-name edir))
2886 (host-type (ange-ftp-host-type
2890 (and (boundp 'dired-local-variables-file) ; in the dired-x package
2891 (stringp dired-local-variables-file)
2892 (string-equal dired-local-variables-file efile))
2893 ;; No dots in dir names in vms.
2894 (and (eq host-type 'vms)
2895 (string-match "\\." efile))
2896 ;; No subdirs in mts of cms.
2897 (and (memq host-type '(mts cms))
2898 (not (string-equal "/" (nth 2 parsed))))
2899 ;; No dots in pseudo-dir names in bs2000.
2900 (and (eq host-type 'bs2000)
2901 (string-match "\\." efile))))))
2903 (defun ange-ftp-file-entry-p (name)
2904 "Given NAME, return whether there is a file entry for it."
2905 (let* ((name (directory-file-name name))
2906 (dir (file-name-directory name))
2907 (ent (gethash dir ange-ftp-files-hashtable))
2908 (file (ange-ftp-get-file-part name)))
2910 (ange-ftp-hash-entry-exists-p file ent)
2911 (or (and (ange-ftp-allow-child-lookup dir file)
2912 (setq ent (ange-ftp-get-files name t))
2913 ;; Try a child lookup. i.e. try to list file as a
2914 ;; subdirectory of dir. This is a good idea because
2915 ;; we may not have read permission for file's parent. Also,
2916 ;; people tend to work down directory trees anyway. We use
2917 ;; no-error ;; because if file does not exist as a subdir.,
2918 ;; then dumb hosts will give an ftp error. Smart unix hosts
2919 ;; will simply send back the ls
2922 ;; Child lookup failed, so try the parent.
2923 (ange-ftp-hash-entry-exists-p
2924 file (ange-ftp-get-files dir 'no-error))))))
2926 (defun ange-ftp-get-file-entry (name)
2927 "Given NAME, return the given file entry.
2928 The entry will be either t for a directory, nil for a normal file,
2929 or a string for a symlink. If the file isn't in the hashtable,
2930 this also returns nil."
2931 (let* ((name (directory-file-name name))
2932 (dir (file-name-directory name))
2933 (ent (gethash dir ange-ftp-files-hashtable))
2934 (file (ange-ftp-get-file-part name)))
2937 (or (and (ange-ftp-allow-child-lookup dir file)
2938 (setq ent (ange-ftp-get-files name t))
2940 ;; i.e. it's a directory by child lookup
2941 (and (setq ent (ange-ftp-get-files dir t))
2942 (gethash file ent))))))
2944 (defun ange-ftp-internal-delete-file-entry (name &optional dir-p)
2946 (setq name (file-name-as-directory name))
2947 (remhash name ange-ftp-files-hashtable)
2948 (setq name (directory-file-name name)))
2949 ;; Note that file-name-as-directory followed by directory-file-name
2950 ;; serves to canonicalize directory file names to their unix form.
2951 ;; i.e. in VMS, FOO.DIR -> FOO/ -> FOO
2952 (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable)))
2954 (remhash (ange-ftp-get-file-part name) files))))
2956 (defun ange-ftp-internal-add-file-entry (name &optional dir-p)
2958 (setq name (directory-file-name name)))
2959 (let ((files (gethash (file-name-directory name) ange-ftp-files-hashtable)))
2961 (puthash (ange-ftp-get-file-part name) dir-p files))))
2963 (defun ange-ftp-wipe-file-entries (host user)
2964 "Get rid of entry for HOST, USER pair from file entry information hashtable."
2965 (let ((new-tbl (make-hash-table :test 'equal
2966 :size (hash-table-size
2967 ange-ftp-files-hashtable))))
2970 (let ((parsed (ange-ftp-ftp-name key)))
2972 (let ((h (nth 0 parsed))
2974 (or (and (equal host h) (equal user u))
2975 (puthash key val new-tbl))))))
2976 ange-ftp-files-hashtable)
2977 (setq ange-ftp-files-hashtable new-tbl)))
2979 ;;;; ------------------------------------------------------------
2980 ;;;; File transfer mode support.
2981 ;;;; ------------------------------------------------------------
2983 (defun ange-ftp-set-binary-mode (host user)
2984 "Tell the FTP process for the given HOST & USER to switch to binary mode."
2985 ;; FIXME: We should keep track of the current mode, so as to avoid
2986 ;; unnecessary roundtrips.
2987 (let ((result (ange-ftp-send-cmd host user '(type "binary"))))
2988 (if (not (car result))
2989 (ange-ftp-error host user (concat "BINARY failed: " (cdr result)))
2990 (with-current-buffer (process-buffer (ange-ftp-get-process host user))
2991 (and ange-ftp-binary-hash-mark-size
2992 (setq ange-ftp-hash-mark-unit
2993 (ash ange-ftp-binary-hash-mark-size -4)))))))
2995 (defun ange-ftp-set-ascii-mode (host user)
2996 "Tell the FTP process for the given HOST & USER to switch to ASCII mode."
2997 ;; FIXME: We should keep track of the current mode, so as to avoid
2998 ;; unnecessary roundtrips.
2999 (let ((result (ange-ftp-send-cmd host user '(type "ascii"))))
3000 (if (not (car result))
3001 (ange-ftp-error host user (concat "ASCII failed: " (cdr result)))
3002 (with-current-buffer (process-buffer (ange-ftp-get-process host user))
3003 (and ange-ftp-ascii-hash-mark-size
3004 (setq ange-ftp-hash-mark-unit
3005 (ash ange-ftp-ascii-hash-mark-size -4)))))))
3007 (defun ange-ftp-cd (host user dir &optional noerror)
3008 (let ((result (ange-ftp-send-cmd host user (list 'cd dir) "Doing CD")))
3011 (ange-ftp-error host user (concat "CD failed: " (cdr result)))))))
3013 (defun ange-ftp-get-pwd (host user)
3014 "Attempt to get the current working directory for the given HOST/USER pair.
3015 Returns (DIR . LINE) where DIR is either the directory or nil if not found,
3016 and LINE is the relevant success or fail line from the FTP-client."
3017 (let* ((result (ange-ftp-send-cmd host user '(pwd) "Getting PWD"))
3022 (and (or (string-match "\"\\([^\"]*\\)\"" line)
3023 ;; Some clients cache the value and return it in
3024 ;; this way without asking the server. (Bug#15058)
3025 (string-match "^Remote directory: \\(.*\\)" line)
3026 (string-match " \\([^ ]+\\) " line)) ; stone-age VMS servers!
3027 (setq dir (match-string 1 line)))))
3030 ;;; ------------------------------------------------------------
3031 ;;; expand-file-name and friends...which currently don't work
3032 ;;; ------------------------------------------------------------
3034 (defun ange-ftp-expand-dir (host user dir)
3035 "Return the result of doing a PWD in the current FTP session.
3036 Use the connection to machine HOST
3037 logged in as user USER and cd'd to directory DIR."
3038 (let* ((host-type (ange-ftp-host-type host user))
3039 ;; It is more efficient to call ange-ftp-host-type
3040 ;; before binding res, because ange-ftp-host-type sometimes
3041 ;; adds to the info in the expand-dir-hashtable.
3043 (cdr (assq host-type ange-ftp-fix-name-func-alist)))
3044 (key (concat host "/" user "/" dir))
3045 (res (gethash key ange-ftp-expand-dir-hashtable)))
3049 (string-equal user "anonymous")
3050 (string-equal user "ftp")
3051 (not (eq host-type 'unix))
3052 (let* ((ange-ftp-good-msgs (concat ange-ftp-expand-dir-regexp
3054 ange-ftp-good-msgs))
3055 (result (ange-ftp-send-cmd host user
3056 (list 'get dir null-device)
3057 (format "expanding %s" dir)))
3058 (line (cdr result)))
3060 (if (string-match ange-ftp-expand-dir-regexp line)
3061 (match-string 1 line)))))
3063 (if (string-equal dir "~")
3064 (setq res (car (ange-ftp-get-pwd host user)))
3065 (let ((home (ange-ftp-expand-dir host user "~")))
3067 (and (ange-ftp-cd host user dir)
3068 (setq res (car (ange-ftp-get-pwd host user))))
3069 (ange-ftp-cd host user home)))))
3071 (let ((ange-ftp-this-user user)
3072 (ange-ftp-this-host host))
3074 (setq res (funcall fix-name-func res 'reverse)))
3075 (puthash key res ange-ftp-expand-dir-hashtable)))
3078 (defun ange-ftp-canonize-filename (n)
3079 "Take a string N and short-circuit //, /. and /.."
3080 (if (string-match "[^:]+//" n) ;don't upset Apollo users
3081 (setq n (substring n (1- (match-end 0)))))
3082 (let ((parsed (ange-ftp-ftp-name n)))
3084 (let ((host (car parsed))
3085 (user (nth 1 parsed))
3086 (name (nth 2 parsed)))
3088 ;; See if remote name is absolute. If so then just expand it and
3089 ;; replace the name component of the overall name.
3090 (cond ((string-match "\\`/" name)
3093 ;; Name starts with ~ or ~user. Resolve that part of the name
3094 ;; making it absolute then re-expand it.
3095 ((string-match "\\`~[^/]*" name)
3096 (let* ((tilda (match-string 0 name))
3097 (rest (substring name (match-end 0)))
3098 (dir (ange-ftp-expand-dir host user tilda)))
3100 ;; C-x d /ftp:anonymous@ftp.gnu.org:~/ RET
3101 ;; seems to cause `rest' to sometimes be empty.
3102 ;; Maybe it's an error for `rest' to be empty here,
3103 ;; but until we figure this out, this quick fix
3104 ;; seems to do the trick.
3105 (setq name (cond ((string-equal rest "") dir)
3106 ((string-equal dir "/") rest)
3107 (t (concat dir rest))))
3108 (error "User \"%s\" is not known"
3109 (substring tilda 1)))))
3111 ;; relative name. Tack on homedir and re-expand.
3113 (let ((dir (ange-ftp-expand-dir host user "~")))
3116 (ange-ftp-real-file-name-as-directory dir)
3118 (error "Unable to obtain CWD")))))
3120 ;; If name starts with //, preserve that, for apollo system.
3121 (unless (string-match "\\`//" name)
3122 (if (not (eq system-type 'windows-nt))
3123 (setq name (ange-ftp-real-expand-file-name name))
3124 ;; Windows UNC default dirs do not make sense for ftp.
3125 (setq name (if (and default-directory
3126 (string-match "\\`//" default-directory))
3127 (ange-ftp-real-expand-file-name name "c:/")
3128 (ange-ftp-real-expand-file-name name)))
3129 ;; Strip off possible drive specifier.
3130 (if (string-match "\\`[a-zA-Z]:" name)
3131 (setq name (substring name 2))))
3132 (if (string-match "\\`//" name)
3133 (setq name (substring name 1))))
3135 ;; Now substitute the expanded name back into the overall filename.
3136 (ange-ftp-replace-name-component n name))
3138 ;; non-ange-ftp name. Just expand normally.
3139 (if (eq (string-to-char n) ?/)
3140 (ange-ftp-real-expand-file-name n)
3141 (ange-ftp-real-expand-file-name
3142 (ange-ftp-real-file-name-nondirectory n)
3143 (ange-ftp-real-file-name-directory n))))))
3145 (defun ange-ftp-expand-file-name (name &optional default)
3146 "Documented as `expand-file-name'."
3148 (setq default (or default default-directory))
3150 ((ange-ftp-ftp-name name)
3151 ;; `default' is irrelevant.
3152 (ange-ftp-canonize-filename name))
3153 ((file-name-absolute-p name)
3154 ;; `name' is absolute but is not an ange-ftp name => not ange-ftp.
3155 (ange-ftp-real-expand-file-name name "/"))
3156 ((ange-ftp-canonize-filename
3157 (concat (file-name-as-directory default) name))))))
3159 ;;; These are problems--they are currently not enabled.
3161 (defvar ange-ftp-file-name-as-directory-alist nil
3162 "Association list of (TYPE . FUNC) pairs.
3163 FUNC converts a filename to a directory name for the operating
3166 (defun ange-ftp-file-name-as-directory (name)
3167 "Documented as `file-name-as-directory'."
3168 (let ((parsed (ange-ftp-ftp-name name)))
3170 (if (string-equal (nth 2 parsed) "")
3172 (funcall (or (cdr (assq
3173 (ange-ftp-host-type (car parsed))
3174 ange-ftp-file-name-as-directory-alist))
3175 'ange-ftp-real-file-name-as-directory)
3177 (ange-ftp-real-file-name-as-directory name))))
3179 (defun ange-ftp-file-name-directory (name)
3180 "Documented as `file-name-directory'."
3181 (let ((parsed (ange-ftp-ftp-name name)))
3183 (let ((filename (nth 2 parsed)))
3184 (if (string-match-p "\\`~[^/]*\\'" filename)
3186 (ange-ftp-replace-name-component
3188 (ange-ftp-real-file-name-directory filename))))
3189 (ange-ftp-real-file-name-directory name))))
3191 (defun ange-ftp-file-name-nondirectory (name)
3192 "Documented as `file-name-nondirectory'."
3193 (let ((parsed (ange-ftp-ftp-name name)))
3195 (let ((filename (nth 2 parsed)))
3196 (if (string-match-p "\\`~[^/]*\\'" filename)
3198 (ange-ftp-real-file-name-nondirectory filename)))
3199 (ange-ftp-real-file-name-nondirectory name))))
3201 (defun ange-ftp-directory-file-name (dir)
3202 "Documented as `directory-file-name'."
3203 (let ((parsed (ange-ftp-ftp-name dir)))
3205 (ange-ftp-replace-name-component
3207 (ange-ftp-real-directory-file-name (nth 2 parsed)))
3208 (ange-ftp-real-directory-file-name dir))))
3211 ;;; Hooks that handle Emacs primitives.
3213 ;; Returns non-nil if should transfer FILE in binary mode.
3214 (defun ange-ftp-binary-file (file)
3215 (string-match-p ange-ftp-binary-file-name-regexp file))
3217 (defun ange-ftp-write-region (start end filename &optional append visit)
3218 (setq filename (expand-file-name filename))
3219 (let ((parsed (ange-ftp-ftp-name filename)))
3221 (let* ((host (nth 0 parsed))
3222 (user (nth 1 parsed))
3223 (name (ange-ftp-quote-string (nth 2 parsed)))
3224 (temp (ange-ftp-make-tmp-name host))
3225 ;; What we REALLY need here is a way to determine if the mode
3226 ;; of the transfer is irrelevant, i.e. we can use binary mode
3227 ;; regardless. Maybe a system-type to host-type lookup?
3228 (binary (ange-ftp-binary-file filename))
3229 (cmd (if append 'append 'put))
3230 (abbr (ange-ftp-abbreviate-filename filename))
3231 ;; we need to reset `last-coding-system-used' to its
3232 ;; value immediately after calling the real write-region,
3233 ;; so that `basic-save-buffer' doesn't see whatever value
3234 ;; might be used when communicating with the ftp process.
3235 (coding-system-used last-coding-system-used))
3238 (let ((filename (buffer-file-name))
3239 (mod-p (buffer-modified-p)))
3242 (ange-ftp-real-write-region start end temp nil
3244 (setq coding-system-used last-coding-system-used))
3246 (setq coding-system-used last-coding-system-used)
3247 (setq buffer-file-name filename)
3248 (restore-buffer-modified-p mod-p)))
3250 (ange-ftp-set-binary-mode host user))
3252 ;; tell the process filter what size the transfer will be.
3253 (let ((attr (file-attributes temp)))
3255 (ange-ftp-set-xfer-size host user (nth 7 attr))))
3257 ;; put or append the file.
3258 (let ((result (ange-ftp-send-cmd host user
3259 (list cmd temp name)
3260 (format "Writing %s" abbr))))
3264 "Opening output file"
3265 (format "FTP Error: \"%s\"" (cdr result))
3267 (ange-ftp-del-tmp-name temp)
3269 (ange-ftp-set-ascii-mode host user)))
3272 (set-visited-file-modtime (ange-ftp-file-modtime filename))
3273 (ange-ftp-set-buffer-mode)
3274 (setq buffer-file-name filename)
3275 (set-buffer-modified-p nil)))
3276 ;; ensure `last-coding-system-used' has an appropriate value
3277 (setq last-coding-system-used coding-system-used)
3278 (ange-ftp-message "Wrote %s" abbr)
3279 (ange-ftp-add-file-entry filename))
3280 (ange-ftp-real-write-region start end filename append visit))))
3282 (defun ange-ftp-insert-file-contents (filename &optional visit beg end replace)
3283 (barf-if-buffer-read-only)
3284 (setq filename (expand-file-name filename))
3285 (let ((parsed (ange-ftp-ftp-name filename)))
3289 (setq buffer-file-name filename))
3290 (if (or (file-exists-p filename)
3292 (setq ange-ftp-ls-cache-file nil)
3293 (remhash (file-name-directory filename)
3294 ange-ftp-files-hashtable)
3295 (file-exists-p filename)))
3296 (let* ((host (nth 0 parsed))
3297 (user (nth 1 parsed))
3298 (name (ange-ftp-quote-string (nth 2 parsed)))
3299 (temp (ange-ftp-make-tmp-name host))
3300 (binary (ange-ftp-binary-file filename))
3301 (abbr (ange-ftp-abbreviate-filename filename))
3302 (coding-system-used last-coding-system-used)
3307 (ange-ftp-set-binary-mode host user))
3308 (let ((result (ange-ftp-send-cmd host user
3309 (list 'get name temp)
3310 (format "Retrieving %s" abbr))))
3314 "Opening input file"
3315 (format "FTP Error: \"%s\"" (cdr result))
3317 (if (or (ange-ftp-real-file-readable-p temp)
3318 (sleep-for ange-ftp-retry-time)
3319 ;; Wait for file to hopefully appear.
3320 (ange-ftp-real-file-readable-p temp))
3323 (nth 1 (ange-ftp-real-insert-file-contents
3324 temp visit beg end replace))
3325 coding-system-used last-coding-system-used)
3328 "Opening input file:"
3330 "FTP Error: %s not arrived or readable"
3333 ;; We must keep `last-coding-system-used'
3335 (let (last-coding-system-used)
3336 (ange-ftp-set-ascii-mode host user)))
3337 (ange-ftp-del-tmp-name temp))
3340 (set-visited-file-modtime
3341 (ange-ftp-file-modtime filename))
3342 (setq buffer-file-name filename)))
3343 (setq last-coding-system-used coding-system-used)
3344 (list filename size))
3347 "Opening input file"
3349 (ange-ftp-real-insert-file-contents filename visit beg end replace))))
3351 (defun ange-ftp-expand-symlink (file dir)
3352 (let ((res (if (file-name-absolute-p file)
3353 (ange-ftp-replace-name-component dir file)
3354 (expand-file-name file dir))))
3355 (if (file-symlink-p res)
3356 (ange-ftp-expand-symlink
3357 (ange-ftp-get-file-entry res)
3358 (file-name-directory (directory-file-name res)))
3361 (defun ange-ftp-file-symlink-p (file)
3362 ;; call ange-ftp-expand-file-name rather than the normal
3363 ;; expand-file-name to stop loops when using a package that
3364 ;; redefines both file-symlink-p and expand-file-name.
3365 (setq file (ange-ftp-expand-file-name file))
3366 (if (ange-ftp-ftp-name file)
3368 (let ((ent (ange-ftp-get-files (file-name-directory file))))
3371 (gethash (ange-ftp-get-file-part file) ent)))
3373 ;; If we can't read the parent directory, just assume
3374 ;; this file is not a symlink.
3375 ;; This makes it possible to access a directory that
3376 ;; whose parent is not readable.
3378 (ange-ftp-real-file-symlink-p file)))
3380 (defun ange-ftp-file-exists-p (name)
3381 (setq name (expand-file-name name))
3382 (if (ange-ftp-ftp-name name)
3383 (if (ange-ftp-file-entry-p name)
3384 (let ((file-ent (ange-ftp-get-file-entry name)))
3385 (if (stringp file-ent)
3386 (ange-ftp-file-exists-p
3387 (ange-ftp-expand-symlink file-ent
3388 (file-name-directory
3389 (directory-file-name name))))
3391 (ange-ftp-real-file-exists-p name)))
3393 (defun ange-ftp-file-directory-p (name)
3394 (setq name (expand-file-name name))
3395 (if (ange-ftp-ftp-name name)
3396 ;; We do a file-name-as-directory on name here because some
3397 ;; machines (VMS) use a .DIR to indicate the filename associated
3398 ;; with a directory. This needs to be canonicalized.
3399 (let ((file-ent (ange-ftp-get-file-entry
3400 (ange-ftp-file-name-as-directory name))))
3401 (if (stringp file-ent)
3402 ;; Calling file-directory-p doesn't work because ange-ftp
3403 ;; is temporarily disabled for this operation.
3404 (ange-ftp-file-directory-p
3405 (ange-ftp-expand-symlink file-ent
3406 (file-name-directory
3407 (directory-file-name name))))
3409 (ange-ftp-real-file-directory-p name)))
3411 (defun ange-ftp-directory-files (directory &optional full match
3413 (setq directory (expand-file-name directory))
3414 (if (ange-ftp-ftp-name directory)
3416 (ange-ftp-barf-if-not-directory directory)
3417 (let ((tail (ange-ftp-hash-table-keys
3418 (ange-ftp-get-files directory)))
3420 (setq directory (file-name-as-directory directory))
3424 (if (or (not match) (string-match-p match f))
3426 (cons (if full (concat directory f) f) files))))
3428 (apply 'ange-ftp-real-directory-files directory full match v19-args)))
3430 (defun ange-ftp-directory-files-and-attributes
3431 (directory &optional full match nosort id-format)
3432 (setq directory (expand-file-name directory))
3433 (if (ange-ftp-ftp-name directory)
3436 (cons file (file-attributes (expand-file-name file directory))))
3437 (ange-ftp-directory-files directory full match nosort))
3438 (ange-ftp-real-directory-files-and-attributes
3439 directory full match nosort id-format)))
3441 (defun ange-ftp-file-attributes (file &optional id-format)
3442 (setq file (expand-file-name file))
3443 (let ((parsed (ange-ftp-ftp-name file)))
3445 (let ((part (ange-ftp-get-file-part file))
3446 (files (ange-ftp-get-files (file-name-directory file))))
3447 (if (ange-ftp-hash-entry-exists-p part files)
3448 (let ((host (nth 0 parsed))
3449 (user (nth 1 parsed))
3450 (name (nth 2 parsed))
3451 (dirp (gethash part files))
3452 (inode (gethash file ange-ftp-inodes-hashtable)))
3454 (setq inode ange-ftp-next-inode-number
3455 ange-ftp-next-inode-number (1+ inode))
3456 (puthash file inode ange-ftp-inodes-hashtable))
3457 (list (if (and (stringp dirp) (file-name-absolute-p dirp))
3458 (ange-ftp-expand-symlink dirp
3459 (file-name-directory file))
3465 (ange-ftp-file-modtime file) ;5 mtime
3467 (ange-ftp-file-size file) ;7 size
3468 (concat (if (stringp dirp) "l" (if dirp "d" "-"))
3469 "?????????") ;8 mode
3471 inode ;10 "inode number".
3472 -1 ;11 device number [v19 only]
3475 (ange-ftp-real-file-attributes file id-format)
3476 (ange-ftp-real-file-attributes file)))))
3478 (defun ange-ftp-file-newer-than-file-p (f1 f2)
3479 (let ((f1-parsed (ange-ftp-ftp-name f1))
3480 (f2-parsed (ange-ftp-ftp-name f2)))
3481 (if (or f1-parsed f2-parsed)
3482 (let ((f1-mt (nth 5 (file-attributes f1)))
3483 (f2-mt (nth 5 (file-attributes f2))))
3484 (cond ((null f1-mt) nil)
3486 (t (> (float-time f1-mt) (float-time f2-mt)))))
3487 (ange-ftp-real-file-newer-than-file-p f1 f2))))
3489 (defun ange-ftp-file-writable-p (file)
3490 (let ((ange-ftp-process-verbose nil))
3491 (setq file (expand-file-name file))
3492 (if (ange-ftp-ftp-name file)
3493 (or (file-exists-p file) ;guess here for speed
3494 (file-directory-p (file-name-directory file)))
3495 (ange-ftp-real-file-writable-p file))))
3497 (defun ange-ftp-file-readable-p (file)
3498 (let ((ange-ftp-process-verbose nil))
3499 (setq file (expand-file-name file))
3500 (if (ange-ftp-ftp-name file)
3501 (file-exists-p file)
3502 (ange-ftp-real-file-readable-p file))))
3504 (defun ange-ftp-file-executable-p (file)
3505 (let ((ange-ftp-process-verbose nil))
3506 (setq file (expand-file-name file))
3507 (if (ange-ftp-ftp-name file)
3508 (file-exists-p file)
3509 (ange-ftp-real-file-executable-p file))))
3511 (defun ange-ftp-delete-file (file &optional trash)
3512 (interactive (list (read-file-name "Delete file: " nil default-directory)
3513 (null current-prefix-arg)))
3514 (setq file (expand-file-name file))
3515 (let ((parsed (ange-ftp-ftp-name file)))
3517 (let* ((host (nth 0 parsed))
3518 (user (nth 1 parsed))
3519 (name (ange-ftp-quote-string (nth 2 parsed)))
3520 (abbr (ange-ftp-abbreviate-filename file))
3521 (result (ange-ftp-send-cmd host user
3523 (format "Deleting %s" abbr))))
3528 (format "FTP Error: \"%s\"" (cdr result))
3530 (ange-ftp-delete-file-entry file))
3531 (ange-ftp-real-delete-file file trash))))
3533 (defun ange-ftp-file-modtime (file)
3534 "Return the modification time of remote file FILE.
3535 Value is (0 0) if the modification time cannot be determined."
3536 (let* ((parsed (ange-ftp-ftp-name file))
3537 ;; At least one FTP server (wu-ftpd) can return a "226
3538 ;; Transfer complete" before the "213 MODTIME". Let's skip
3540 (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226"))
3541 (res (ange-ftp-send-cmd (car parsed) (cadr parsed)
3542 (list 'quote "mdtm" (cadr (cdr parsed)))))
3545 ;; MDTM should return "213 YYYYMMDDhhmmss" GMT on success
3546 ;; following the Internet draft for FTP extensions.
3547 ;; Bob@rattlesnake.com reports that is returns something different
3548 ;; for at least one FTP server. So, let's use the response only
3549 ;; if it matches the Internet draft.
3550 (when (string-match-p "^213 [0-9]\\{14\\}$" line)
3553 (string-to-number (substring line 16 18))
3554 (string-to-number (substring line 14 16))
3555 (string-to-number (substring line 12 14))
3556 (string-to-number (substring line 10 12))
3557 (string-to-number (substring line 8 10))
3558 (string-to-number (substring line 4 8))
3562 (defun ange-ftp-verify-visited-file-modtime (buf)
3563 (let ((name (buffer-file-name buf)))
3564 (if (and (stringp name) (ange-ftp-ftp-name name))
3565 (let ((file-mdtm (ange-ftp-file-modtime name))
3566 (buf-mdtm (with-current-buffer buf (visited-file-modtime))))
3567 (or (zerop (car file-mdtm))
3568 (<= (float-time file-mdtm) (float-time buf-mdtm))))
3569 (ange-ftp-real-verify-visited-file-modtime buf))))
3571 (defun ange-ftp-file-size (file &optional ascii-mode)
3572 "Return the size of remote file FILE. Return -1 if can't get it.
3573 If ascii-mode is non-nil, return the size with the extra octets that
3574 need to be inserted, one at the end of each line, to provide correct
3575 end-of-line semantics for a transfer using TYPE=A. The default is nil,
3576 so return the size on the remote host exactly. See RFC 3659."
3577 (let* ((parsed (ange-ftp-ftp-name file))
3578 (host (nth 0 parsed))
3579 (user (nth 1 parsed))
3580 (name (ange-ftp-quote-string (nth 2 parsed)))
3581 ;; At least one FTP server (wu-ftpd) can return a "226
3582 ;; Transfer complete" before the "213 SIZE". Let's skip
3584 (ange-ftp-skip-msgs (concat ange-ftp-skip-msgs "\\|^226"))
3585 (res (unwind-protect
3588 (ange-ftp-set-binary-mode host user))
3589 (ange-ftp-send-cmd host user (list 'quote "size" name)))
3591 (ange-ftp-set-ascii-mode host user))))
3593 (if (string-match "^213 \\([0-9]+\\)$" line)
3594 (string-to-number (match-string 1 line))
3598 ;;;; ------------------------------------------------------------
3599 ;;;; File copying support... totally re-written 6/24/92.
3600 ;;;; ------------------------------------------------------------
3602 (defun ange-ftp-barf-or-query-if-file-exists (absname querystring interactive)
3603 (if (file-exists-p absname)
3604 (if (not interactive)
3605 (signal 'file-already-exists (list absname))
3606 (if (not (yes-or-no-p (format "File %s already exists; %s anyway? "
3607 absname querystring)))
3608 (signal 'file-already-exists (list absname))))))
3610 ;; async local copy commented out for now since I don't seem to get
3611 ;; the process sentinel called for some processes.
3613 ;; (defun ange-ftp-copy-file-locally (filename newname ok-if-already-exists
3615 ;; "Kludge to copy a local file and call a continuation when the copy
3617 ;; ;; check to see if we can overwrite
3618 ;; (if (or (not ok-if-already-exists)
3619 ;; (numberp ok-if-already-exists))
3620 ;; (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3621 ;; (numberp ok-if-already-exists)))
3622 ;; (let ((proc (start-process " *copy*"
3623 ;; (generate-new-buffer "*copy*")
3628 ;; (set-process-sentinel proc 'ange-ftp-copy-file-locally-sentinel)
3629 ;; (process-kill-without-query proc)
3630 ;; (with-current-buffer (process-buffer proc)
3631 ;; (set (make-local-variable 'copy-cont) cont))))
3633 ;; (defun ange-ftp-copy-file-locally-sentinel (proc status)
3634 ;; (with-current-buffer (process-buffer proc)
3635 ;; (let ((cont copy-cont)
3636 ;; (result (buffer-string)))
3638 ;; (if (and (string-equal status "finished\n")
3639 ;; (zerop (length result)))
3640 ;; (ange-ftp-call-cont cont t nil)
3641 ;; (ange-ftp-call-cont cont
3643 ;; (if (zerop (length result))
3644 ;; (substring status 0 -1)
3645 ;; (substring result 0 -1))))
3646 ;; (kill-buffer (current-buffer))))))
3648 ;; this is the extended version of ange-ftp-copy-file-internal that works
3649 ;; asynchronously if asked nicely.
3650 (defun ange-ftp-copy-file-internal (filename newname ok-if-already-exists
3651 keep-date &optional msg cont nowait)
3652 (setq filename (expand-file-name filename)
3653 newname (expand-file-name newname))
3655 (or (file-exists-p filename)
3657 (list "Copy file" "no such file or directory" filename)))
3659 ;; canonicalize newname if a directory.
3660 (if (file-directory-p newname)
3661 (setq newname (expand-file-name (file-name-nondirectory filename) newname)))
3663 (let ((f-parsed (ange-ftp-ftp-name filename))
3664 (t-parsed (ange-ftp-ftp-name newname)))
3666 ;; local file to local file copy?
3667 (if (and (not f-parsed) (not t-parsed))
3669 (ange-ftp-real-copy-file filename newname ok-if-already-exists
3672 (ange-ftp-call-cont cont t "Copied locally")))
3673 ;; one or both files are remote.
3674 (let* ((f-host (and f-parsed (nth 0 f-parsed)))
3675 (f-user (and f-parsed (nth 1 f-parsed)))
3676 (f-name (and f-parsed (ange-ftp-quote-string (nth 2 f-parsed))))
3677 (f-abbr (ange-ftp-abbreviate-filename filename))
3678 (t-host (and t-parsed (nth 0 t-parsed)))
3679 (t-user (and t-parsed (nth 1 t-parsed)))
3680 (t-name (and t-parsed (ange-ftp-quote-string (nth 2 t-parsed))))
3681 (t-abbr (ange-ftp-abbreviate-filename newname filename))
3682 (binary (or (ange-ftp-binary-file filename)
3683 (ange-ftp-binary-file newname)))
3687 ;; check to see if we can overwrite
3688 (if (or (not ok-if-already-exists)
3689 (numberp ok-if-already-exists))
3690 (ange-ftp-barf-or-query-if-file-exists newname "copy to it"
3691 (numberp ok-if-already-exists)))
3696 ;; filename was remote.
3698 (if (or (ange-ftp-use-gateway-p f-host)
3700 ;; have to use intermediate file if we are getting via
3701 ;; gateway machine or we are doing a remote to remote copy.
3702 (setq temp1 (ange-ftp-make-tmp-name f-host)))
3705 (ange-ftp-set-binary-mode f-host f-user))
3710 (list 'get f-name (or temp1 (ange-ftp-quote-string newname)))
3712 (if (and temp1 t-parsed)
3713 (format "Getting %s" f-abbr)
3714 (format "Copying %s to %s" f-abbr t-abbr)))
3716 filename newname binary msg
3717 f-parsed f-host f-user f-name f-abbr
3718 t-parsed t-host t-user t-name t-abbr
3719 temp1 temp2 cont nowait)
3722 ;; filename wasn't remote. newname must be remote. call the
3723 ;; function which does the remainder of the copying work.
3725 filename newname binary msg
3726 f-parsed f-host f-user f-name f-abbr
3727 t-parsed t-host t-user t-name t-abbr
3728 nil nil cont nowait))))))
3730 (defvar ange-ftp-waiting-flag nil)
3732 ;; next part of copying routine.
3733 (defun ange-ftp-cf1 (result line
3734 filename newname binary msg
3735 f-parsed f-host f-user f-name f-abbr
3736 t-parsed t-host t-user t-name t-abbr
3737 temp1 temp2 cont nowait)
3739 ;; filename must have been remote, and we must have just done a GET.
3742 ;; GET failed for some reason. Clean up and get out.
3744 (and temp1 (ange-ftp-del-tmp-name temp1))
3746 (if ange-ftp-waiting-flag
3747 (throw 'ftp-error t)
3749 (list "Opening input file"
3750 (format "FTP Error: \"%s\"" line)
3754 (ange-ftp-set-ascii-mode f-host f-user))))
3757 ;; We now have to copy either temp1 or filename to newname.
3760 ;; newname was remote.
3762 (if (ange-ftp-use-gateway-p t-host)
3763 (setq temp2 (ange-ftp-make-tmp-name t-host)))
3765 ;; make sure data is moved into the right place for the
3766 ;; outgoing transfer. gateway temporary files complicate
3770 (if (string-equal temp1 temp2)
3772 (ange-ftp-real-copy-file temp1 temp2 t))
3773 (setq temp2 temp1 temp1 nil))
3775 (ange-ftp-real-copy-file filename temp2 t)))
3778 (ange-ftp-set-binary-mode t-host t-user))
3780 ;; tell the process filter what size the file is.
3781 (let ((attr (file-attributes (or temp2 filename))))
3783 (ange-ftp-set-xfer-size t-host t-user (nth 7 attr))))
3788 (list 'put (or temp2 (ange-ftp-quote-string filename)) t-name)
3790 (if (and temp2 f-parsed)
3791 (format "Putting %s" newname)
3792 (format "Copying %s to %s" f-abbr t-abbr)))
3794 newname t-host t-user binary temp1 temp2 cont)
3796 (ange-ftp-add-file-entry newname))
3798 ;; newname wasn't remote.
3799 (ange-ftp-cf2 t nil newname t-host t-user binary temp1 temp2 cont))
3801 ;; first copy failed, tell caller
3802 (ange-ftp-call-cont cont result line)))
3804 ;; last part of copying routine.
3805 (defun ange-ftp-cf2 (result line newname t-host t-user binary temp1 temp2 cont)
3808 ;; result from doing a local to remote copy.
3813 (if ange-ftp-waiting-flag
3814 (throw 'ftp-error t)
3816 (list "Opening output file"
3817 (format "FTP Error: \"%s\"" line)
3820 (ange-ftp-add-file-entry newname))
3824 (ange-ftp-set-ascii-mode t-host t-user)))
3826 ;; newname was local.
3828 (ange-ftp-real-copy-file temp1 newname t)))
3831 (and temp1 (ange-ftp-del-tmp-name temp1))
3832 (and temp2 (ange-ftp-del-tmp-name temp2))
3833 (ange-ftp-call-cont cont result line)))
3835 (defun ange-ftp-copy-file (filename newname &optional ok-if-already-exists
3836 keep-date preserve-uid-gid
3837 preserve-selinux-context)
3838 (interactive "fCopy file: \nFCopy %s to file: \np")
3839 (ange-ftp-copy-file-internal filename
3841 ok-if-already-exists
3845 (called-interactively-p 'interactive)))
3847 (defun ange-ftp-copy-files-async (okay-p line verbose-p files)
3848 "Copy some files in the background.
3849 OKAY-P must be t, and LINE does not matter. They are here to make this
3850 function a valid CONT argument for `ange-ftp-raw-send-cmd'.
3851 If VERBOSE-P is non-nil, print progress report in the echo area.
3852 When all the files have been copied already, a message is shown anyway.
3853 FILES is a list of files to copy in the form
3854 (from-file to-file ok-if-already-exists keep-date)
3856 (ange-ftp-copy-files-async t nil t '((\"a\" \"b\" t t) (\"c\" \"d\" t t)))"
3857 (unless okay-p (error "%s: %s" 'ange-ftp-copy-files-async line))
3859 (let* ((ff (car files))
3860 (from-file (nth 0 ff))
3861 (to-file (nth 1 ff))
3862 (ok-if-exists (nth 2 ff))
3863 (keep-date (nth 3 ff)))
3864 (ange-ftp-copy-file-internal
3865 from-file to-file ok-if-exists keep-date
3866 (and verbose-p (format "%s --> %s" from-file to-file))
3867 (list 'ange-ftp-copy-files-async verbose-p (cdr files))
3869 (message "%s: done" 'ange-ftp-copy-files-async)))
3872 ;;;; ------------------------------------------------------------
3873 ;;;; File renaming support.
3874 ;;;; ------------------------------------------------------------
3876 (defun ange-ftp-rename-remote-to-remote (filename newname f-parsed t-parsed)
3877 "Rename remote file FILENAME to remote file NEWNAME."
3878 (let ((f-host (nth 0 f-parsed))
3879 (f-user (nth 1 f-parsed))
3880 (t-host (nth 0 t-parsed))
3881 (t-user (nth 1 t-parsed)))
3882 (if (and (string-equal f-host t-host)
3883 (string-equal f-user t-user))
3884 (let* ((f-name (ange-ftp-quote-string (nth 2 f-parsed)))
3885 (t-name (ange-ftp-quote-string (nth 2 t-parsed)))
3886 (cmd (list 'rename f-name t-name))
3887 (fabbr (ange-ftp-abbreviate-filename filename))
3888 (nabbr (ange-ftp-abbreviate-filename newname filename))
3889 (result (ange-ftp-send-cmd f-host f-user cmd
3890 (format "Renaming %s to %s"
3897 (format "FTP Error: \"%s\"" (cdr result))
3900 (ange-ftp-add-file-entry newname)
3901 (ange-ftp-delete-file-entry filename))
3902 (ange-ftp-copy-file-internal filename newname t nil)
3903 (delete-file filename))))
3905 (defun ange-ftp-rename-local-to-remote (filename newname)
3906 "Rename local file FILENAME to remote file NEWNAME."
3907 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3908 (nabbr (ange-ftp-abbreviate-filename newname filename))
3909 (msg (format "Renaming %s to %s" fabbr nabbr)))
3910 (ange-ftp-copy-file-internal filename newname t nil msg)
3911 (let (ange-ftp-process-verbose)
3912 (delete-file filename))))
3914 (defun ange-ftp-rename-remote-to-local (filename newname)
3915 "Rename remote file FILENAME to local file NEWNAME."
3916 (let* ((fabbr (ange-ftp-abbreviate-filename filename))
3917 (nabbr (ange-ftp-abbreviate-filename newname filename))
3918 (msg (format "Renaming %s to %s" fabbr nabbr)))
3919 (ange-ftp-copy-file-internal filename newname t nil msg)
3920 (let (ange-ftp-process-verbose)
3921 (delete-file filename))))
3923 (defun ange-ftp-rename-file (filename newname &optional ok-if-already-exists)
3924 (interactive "fRename file: \nFRename %s to file: \np")
3925 (setq filename (expand-file-name filename))
3926 (setq newname (expand-file-name newname))
3927 (let* ((f-parsed (ange-ftp-ftp-name filename))
3928 (t-parsed (ange-ftp-ftp-name newname)))
3929 (if (and (or f-parsed t-parsed)
3930 (or (not ok-if-already-exists)
3931 (numberp ok-if-already-exists)))
3932 (ange-ftp-barf-or-query-if-file-exists
3935 (numberp ok-if-already-exists)))
3938 (ange-ftp-rename-remote-to-remote filename newname f-parsed
3940 (ange-ftp-rename-remote-to-local filename newname))
3942 (ange-ftp-rename-local-to-remote filename newname)
3943 (ange-ftp-real-rename-file filename newname ok-if-already-exists)))))
3945 ;;;; ------------------------------------------------------------
3946 ;;;; File name completion support.
3947 ;;;; ------------------------------------------------------------
3949 ;; If the file entry is not a directory (nor a symlink pointing to a directory)
3950 ;; returns whether the file (or file pointed to by the symlink) is ignored
3951 ;; by completion-ignored-extensions.
3952 ;; Note that `ange-ftp-this-dir' and `ange-ftp-completion-ignored-pattern'
3953 ;; are used as free variables.
3954 (defun ange-ftp-file-entry-not-ignored-p (symname val)
3956 (let ((file (ange-ftp-expand-symlink val ange-ftp-this-dir)))
3957 (or (file-directory-p file)
3958 (and (file-exists-p file)
3959 (not (string-match ange-ftp-completion-ignored-pattern
3961 (or val ; is a directory name
3962 (not (string-match ange-ftp-completion-ignored-pattern symname)))))
3964 (defun ange-ftp-root-dir-p (dir)
3965 ;; Maybe we should use something more like
3966 ;; (equal dir (file-name-directory (directory-file-name dir))) -stef
3967 (or (and (eq system-type 'windows-nt)
3968 (string-match "\\`[a-zA-Z]:[/\\]\\'" dir))
3969 (string-equal "/" dir)))
3971 (defmacro ange-ftp-ignore-errors-if-non-essential (&rest body)
3973 (ignore-errors ,@body)
3976 (defun ange-ftp-file-name-all-completions (file dir)
3977 (let ((ange-ftp-this-dir (expand-file-name dir)))
3978 (if (ange-ftp-ftp-name ange-ftp-this-dir)
3979 (ange-ftp-ignore-errors-if-non-essential
3980 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
3981 (setq ange-ftp-this-dir
3982 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir))
3983 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
3984 (completions (all-completions file tbl)))
3986 ;; see whether each matching file is a directory or not...
3989 (let ((ent (gethash file tbl)))
3991 (or (not (stringp ent))
3993 (ange-ftp-expand-symlink ent
3994 ange-ftp-this-dir))))
3999 (if (ange-ftp-root-dir-p ange-ftp-this-dir)
4000 (nconc (all-completions file (ange-ftp-generate-root-prefixes))
4001 (ange-ftp-real-file-name-all-completions file
4003 (ange-ftp-real-file-name-all-completions file ange-ftp-this-dir)))))
4005 (defun ange-ftp-file-name-completion (file dir &optional predicate)
4006 (let ((ange-ftp-this-dir (expand-file-name dir)))
4007 (if (ange-ftp-ftp-name ange-ftp-this-dir)
4009 (ange-ftp-barf-if-not-directory ange-ftp-this-dir)
4012 (setq ange-ftp-this-dir
4013 (ange-ftp-real-file-name-as-directory ange-ftp-this-dir)) ;real?
4014 (let* ((tbl (ange-ftp-get-files ange-ftp-this-dir))
4015 (ange-ftp-completion-ignored-pattern
4016 (mapconcat (lambda (s) (if (stringp s)
4017 (concat (regexp-quote s) "$")
4018 "/")) ; / never in filename
4019 completion-ignored-extensions
4022 (or (ange-ftp-file-name-completion-1
4023 file tbl ange-ftp-this-dir
4024 'ange-ftp-file-entry-not-ignored-p)
4025 (ange-ftp-file-name-completion-1
4026 file tbl ange-ftp-this-dir))))))
4028 (if (ange-ftp-root-dir-p ange-ftp-this-dir)
4031 (nconc (ange-ftp-generate-root-prefixes)
4032 (ange-ftp-real-file-name-all-completions
4033 file ange-ftp-this-dir))
4036 (ange-ftp-real-file-name-completion
4037 file ange-ftp-this-dir predicate)
4038 (ange-ftp-real-file-name-completion
4039 file ange-ftp-this-dir))))))
4042 (defun ange-ftp-file-name-completion-1 (file tbl dir &optional predicate)
4043 (let ((bestmatch (try-completion file tbl predicate)))
4045 (if (eq bestmatch t)
4046 (if (file-directory-p (expand-file-name file dir))
4049 (if (and (eq (try-completion bestmatch tbl predicate) t)
4051 (expand-file-name bestmatch dir)))
4052 (concat bestmatch "/")
4055 ;; Put these lines uncommented in your .emacs if you want C-r to refresh
4056 ;; ange-ftp's cache whilst doing filename completion.
4058 ;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-re-read-dir)
4059 ;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-re-read-dir)
4062 (defalias 'ange-ftp-re-read-dir 'ange-ftp-reread-dir)
4065 (defun ange-ftp-reread-dir (&optional dir)
4066 "Reread remote directory DIR to update the directory cache.
4067 The implementation of remote FTP file names caches directory contents
4068 for speed. Therefore, when new remote files are created, Emacs
4069 may not know they exist. You can use this command to reread a specific
4070 directory, so that Emacs will know its current contents."
4073 (setq dir (expand-file-name dir))
4074 (setq dir (file-name-directory (expand-file-name (buffer-string)))))
4075 (if (ange-ftp-ftp-name dir)
4077 (setq ange-ftp-ls-cache-file nil)
4078 (remhash dir ange-ftp-files-hashtable)
4079 (ange-ftp-get-files dir t))))
4081 (defun ange-ftp-make-directory (dir &optional parents)
4082 (interactive (list (expand-file-name (read-directory-name "Make directory: "))))
4084 (let ((parent (file-name-directory (directory-file-name dir))))
4085 (or (file-exists-p parent)
4086 (ange-ftp-make-directory parent parents))))
4087 (if (file-exists-p dir)
4089 (error "Cannot make directory %s: file already exists" dir))
4090 (let ((parsed (ange-ftp-ftp-name dir)))
4092 (let* ((host (nth 0 parsed))
4093 (user (nth 1 parsed))
4094 ;; Some ftp's on unix machines (at least on Suns)
4095 ;; insist that mkdir take a filename, and not a
4096 ;; directory-name name as an arg. Argh!! This is a bug.
4097 ;; Non-unix machines will probably always insist
4098 ;; that mkdir takes a directory-name as an arg
4099 ;; (as the ftp man page says it should).
4100 (name (ange-ftp-quote-string
4101 (if (eq (ange-ftp-host-type host) 'unix)
4102 (ange-ftp-real-directory-file-name (nth 2 parsed))
4103 (ange-ftp-real-file-name-as-directory
4105 (abbr (ange-ftp-abbreviate-filename dir))
4106 (result (ange-ftp-send-cmd host user
4108 (format "Making directory %s"
4111 (ange-ftp-error host user
4112 (format "Could not make directory %s: %s"
4115 (ange-ftp-add-file-entry dir t))
4116 (ange-ftp-real-make-directory dir)))))
4118 (defun ange-ftp-delete-directory (dir &optional recursive)
4119 (if (file-directory-p dir)
4120 (let ((parsed (ange-ftp-ftp-name dir)))
4124 (if (file-directory-p file)
4125 (ange-ftp-delete-directory file recursive)
4126 (delete-file file)))
4127 ;; We do not want to delete "." and "..".
4129 dir 'full "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")))
4131 (let* ((host (nth 0 parsed))
4132 (user (nth 1 parsed))
4133 ;; Some ftp's on unix machines (at least on Suns)
4134 ;; insist that rmdir take a filename, and not a
4135 ;; directory-name name as an arg. Argh!! This is a bug.
4136 ;; Non-unix machines will probably always insist
4137 ;; that rmdir takes a directory-name as an arg
4138 ;; (as the ftp man page says it should).
4139 (name (ange-ftp-quote-string
4140 (if (eq (ange-ftp-host-type host) 'unix)
4141 (ange-ftp-real-directory-file-name
4143 (ange-ftp-real-file-name-as-directory
4145 (abbr (ange-ftp-abbreviate-filename dir))
4148 ;; CWD must not in this directory.
4149 (ange-ftp-cd host user "/" 'noerror)
4150 (ange-ftp-send-cmd host user
4152 (format "Removing directory %s"
4155 (ange-ftp-error host user
4156 (format "Could not remove directory %s: %s"
4159 (ange-ftp-delete-file-entry dir t))
4160 (ange-ftp-real-delete-directory dir recursive)))
4161 (error "Not a directory: %s" dir)))
4163 ;; Make a local copy of FILE and return its name.
4165 (defun ange-ftp-file-local-copy (file)
4166 (let* ((fn1 (expand-file-name file))
4167 (pa1 (ange-ftp-ftp-name fn1)))
4169 (let ((tmp1 (ange-ftp-make-tmp-name (car pa1)
4170 (file-name-extension file t))))
4171 (ange-ftp-copy-file-internal fn1 tmp1 t nil
4172 (format "Getting %s" fn1))
4175 (defun ange-ftp-file-remote-p (file &optional identification connected)
4176 (let* ((parsed (ange-ftp-ftp-name file))
4177 (host (nth 0 parsed))
4178 (user (nth 1 parsed))
4179 (localname (nth 2 parsed)))
4180 (and (or (not connected)
4181 (let ((proc (get-process (ange-ftp-ftp-process-buffer host user))))
4182 (and proc (processp proc)
4183 (memq (process-status proc) '(run open)))))
4185 ((eq identification 'method) (and parsed "ftp"))
4186 ((eq identification 'user) user)
4187 ((eq identification 'host) host)
4188 ((eq identification 'localname) localname)
4189 (t (ange-ftp-replace-name-component file ""))))))
4191 (defun ange-ftp-load (file &optional noerror nomessage nosuffix)
4192 (if (ange-ftp-ftp-name file)
4193 (let ((tryfiles (if nosuffix
4195 (list (concat file ".elc") (concat file ".el") file)))
4196 ;; make sure there are no references to temp files
4197 (load-force-doc-strings t)
4199 (while (and tryfiles (not copy))
4201 (let ((ange-ftp-waiting-flag t))
4202 (condition-case error
4203 (setq copy (ange-ftp-file-local-copy (car tryfiles)))
4205 (setq tryfiles (cdr tryfiles)))
4208 (funcall 'load copy noerror nomessage nosuffix)
4211 (signal 'file-error (list "Cannot open load file" file)))
4213 (ange-ftp-real-load file noerror nomessage nosuffix)))
4215 ;; Calculate default-unhandled-directory for a given ange-ftp buffer.
4216 (defun ange-ftp-unhandled-file-name-directory (filename)
4220 ;; Need the following functions for making filenames of compressed
4221 ;; files, because some OS's (unlike UNIX) do not allow a filename to
4222 ;; have two extensions.
4224 (defvar ange-ftp-make-compressed-filename-alist nil
4225 "Alist of host-type-specific functions to process file names for compression.
4226 Each element has the form (TYPE . FUNC).
4227 FUNC should take one argument, a file name, and return a list
4228 of the form (COMPRESSING NEWNAME).
4229 COMPRESSING should be t if the specified file should be compressed,
4230 and nil if it should be uncompressed (that is, if it is a compressed file).
4231 NEWNAME should be the name to give the new compressed or uncompressed file.")
4233 (declare-function dired-compress-file "dired-aux" (file))
4235 (defun ange-ftp-dired-compress-file (name)
4236 "Handler used by `dired-compress-file'."
4237 (let ((parsed (ange-ftp-ftp-name name))
4240 (setq conversion-func
4241 (cdr (assq (ange-ftp-host-type (car parsed))
4242 ange-ftp-make-compressed-filename-alist))))
4244 (save-match-data (funcall conversion-func name)))
4245 (compressing (car decision))
4246 (newfile (nth 1 decision)))
4248 (ange-ftp-compress name newfile)
4249 (ange-ftp-uncompress name newfile)))
4250 (let (file-name-handler-alist)
4251 (dired-compress-file name)))))
4253 ;; Copy FILE to this machine, compress it, and copy out to NFILE.
4254 (defun ange-ftp-compress (file nfile)
4255 (let* ((parsed (ange-ftp-ftp-name file))
4256 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
4257 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
4258 (abbr (ange-ftp-abbreviate-filename file))
4259 (nabbr (ange-ftp-abbreviate-filename nfile))
4260 (msg1 (format "Getting %s" abbr))
4261 (msg2 (format "Putting %s" nabbr)))
4264 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
4265 (and ange-ftp-process-verbose
4266 (ange-ftp-message "Compressing %s..." abbr))
4267 (call-process-region (point)
4274 (format "compress -f -c < %s > %s" tmp1 tmp2))
4275 (and ange-ftp-process-verbose
4276 (ange-ftp-message "Compressing %s...done" abbr))
4277 (if (zerop (buffer-size))
4279 (let (ange-ftp-process-verbose)
4281 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
4282 (ange-ftp-del-tmp-name tmp1)
4283 (ange-ftp-del-tmp-name tmp2))))
4285 ;; Copy FILE to this machine, uncompress it, and copy out to NFILE.
4286 (defun ange-ftp-uncompress (file nfile)
4287 (let* ((parsed (ange-ftp-ftp-name file))
4288 (tmp1 (ange-ftp-make-tmp-name (car parsed)))
4289 (tmp2 (ange-ftp-make-tmp-name (car parsed)))
4290 (abbr (ange-ftp-abbreviate-filename file))
4291 (nabbr (ange-ftp-abbreviate-filename nfile))
4292 (msg1 (format "Getting %s" abbr))
4293 (msg2 (format "Putting %s" nabbr))
4294 ;; ;; Cheap hack because of problems with binary file transfers from
4296 ;; (gbinary (not (eq 'vms (ange-ftp-host-type (car parsed)))))
4300 (ange-ftp-copy-file-internal file tmp1 t nil msg1)
4301 (and ange-ftp-process-verbose
4302 (ange-ftp-message "Uncompressing %s..." abbr))
4303 (call-process-region (point)
4310 (format "uncompress -c < %s > %s" tmp1 tmp2))
4311 (and ange-ftp-process-verbose
4312 (ange-ftp-message "Uncompressing %s...done" abbr))
4313 (if (zerop (buffer-size))
4315 (let (ange-ftp-process-verbose)
4317 (ange-ftp-copy-file-internal tmp2 nfile t nil msg2))))
4318 (ange-ftp-del-tmp-name tmp1)
4319 (ange-ftp-del-tmp-name tmp2))))
4321 (defun ange-ftp-find-backup-file-name (fn)
4322 ;; Either return the ordinary backup name, etc.,
4323 ;; or return nil meaning don't make a backup.
4324 (if ange-ftp-make-backup-files
4325 (ange-ftp-real-find-backup-file-name fn)))
4327 ;;; Define the handler for special file names
4328 ;;; that causes ange-ftp to be invoked.
4331 (defun ange-ftp-hook-function (operation &rest args)
4332 (let ((fn (get operation 'ange-ftp)))
4334 ;; Catch also errors in process-filter.
4336 (let ((debug-on-error t))
4337 (save-match-data (apply fn args)))
4338 (error (signal (car err) (cdr err))))
4339 (ange-ftp-run-real-handler operation args))))
4341 ;; The following code is commented out because Tramp now deals with
4342 ;; Ange-FTP filenames, too.
4344 ;;-;;; This regexp takes care of real ange-ftp file names (with a slash
4346 ;;-;;; Don't allow the host name to end in a period--some systems use /.:
4348 ;;-(or (assoc "^/[^/:]*[^/:.]:" file-name-handler-alist)
4349 ;;- (setq file-name-handler-alist
4350 ;;- (cons '("^/[^/:]*[^/:.]:" . ange-ftp-hook-function)
4351 ;;- file-name-handler-alist)))
4353 ;;-;;; This regexp recognizes absolute filenames with only one component,
4354 ;;-;;; for the sake of hostname completion.
4356 ;;-(or (assoc "^/[^/:]*\\'" file-name-handler-alist)
4357 ;;- (setq file-name-handler-alist
4358 ;;- (cons '("^/[^/:]*\\'" . ange-ftp-completion-hook-function)
4359 ;;- file-name-handler-alist)))
4361 ;;-;;; This regexp recognizes absolute filenames with only one component
4362 ;;-;;; on Windows, for the sake of hostname completion.
4363 ;;-;;; NB. Do not mark this as autoload, because it is very common to
4364 ;;-;;; do completions in the root directory of drives on Windows.
4365 ;;-(and (memq system-type '(ms-dos windows-nt))
4366 ;;- (or (assoc "^[a-zA-Z]:/[^/:]*\\'" file-name-handler-alist)
4367 ;;- (setq file-name-handler-alist
4368 ;;- (cons '("^[a-zA-Z]:/[^/:]*\\'" .
4369 ;;- ange-ftp-completion-hook-function)
4370 ;;- file-name-handler-alist))))
4372 ;;; The above two forms are sufficient to cause this file to be loaded
4373 ;;; if the user ever uses a file name with a colon in it.
4375 ;;; This sets the mode
4376 (add-hook 'find-file-hook 'ange-ftp-set-buffer-mode)
4378 ;;; Now say where to find the handlers for particular operations.
4380 (put 'file-name-directory 'ange-ftp 'ange-ftp-file-name-directory)
4381 (put 'file-name-nondirectory 'ange-ftp 'ange-ftp-file-name-nondirectory)
4382 (put 'file-name-as-directory 'ange-ftp 'ange-ftp-file-name-as-directory)
4383 (put 'directory-file-name 'ange-ftp 'ange-ftp-directory-file-name)
4384 (put 'expand-file-name 'ange-ftp 'ange-ftp-expand-file-name)
4385 (put 'make-directory 'ange-ftp 'ange-ftp-make-directory)
4386 (put 'delete-directory 'ange-ftp 'ange-ftp-delete-directory)
4387 (put 'insert-file-contents 'ange-ftp 'ange-ftp-insert-file-contents)
4388 (put 'directory-files 'ange-ftp 'ange-ftp-directory-files)
4389 (put 'directory-files-and-attributes 'ange-ftp
4390 'ange-ftp-directory-files-and-attributes)
4391 (put 'file-directory-p 'ange-ftp 'ange-ftp-file-directory-p)
4392 (put 'file-writable-p 'ange-ftp 'ange-ftp-file-writable-p)
4393 (put 'file-readable-p 'ange-ftp 'ange-ftp-file-readable-p)
4394 (put 'file-executable-p 'ange-ftp 'ange-ftp-file-executable-p)
4395 (put 'file-symlink-p 'ange-ftp 'ange-ftp-file-symlink-p)
4396 (put 'delete-file 'ange-ftp 'ange-ftp-delete-file)
4397 (put 'verify-visited-file-modtime 'ange-ftp
4398 'ange-ftp-verify-visited-file-modtime)
4399 (put 'file-exists-p 'ange-ftp 'ange-ftp-file-exists-p)
4400 (put 'write-region 'ange-ftp 'ange-ftp-write-region)
4401 (put 'copy-file 'ange-ftp 'ange-ftp-copy-file)
4402 (put 'rename-file 'ange-ftp 'ange-ftp-rename-file)
4403 (put 'file-attributes 'ange-ftp 'ange-ftp-file-attributes)
4404 (put 'file-newer-than-file-p 'ange-ftp 'ange-ftp-file-newer-than-file-p)
4405 (put 'file-name-all-completions 'ange-ftp 'ange-ftp-file-name-all-completions)
4406 (put 'file-name-completion 'ange-ftp 'ange-ftp-file-name-completion)
4407 (put 'insert-directory 'ange-ftp 'ange-ftp-insert-directory)
4408 (put 'file-local-copy 'ange-ftp 'ange-ftp-file-local-copy)
4409 (put 'file-remote-p 'ange-ftp 'ange-ftp-file-remote-p)
4410 (put 'unhandled-file-name-directory 'ange-ftp
4411 'ange-ftp-unhandled-file-name-directory)
4412 (put 'file-name-sans-versions 'ange-ftp 'ange-ftp-file-name-sans-versions)
4413 (put 'dired-uncache 'ange-ftp 'ange-ftp-dired-uncache)
4414 (put 'dired-compress-file 'ange-ftp 'ange-ftp-dired-compress-file)
4415 (put 'load 'ange-ftp 'ange-ftp-load)
4416 (put 'find-backup-file-name 'ange-ftp 'ange-ftp-find-backup-file-name)
4417 (put 'set-file-modes 'ange-ftp 'ange-ftp-set-file-modes)
4419 ;; Turn off truename processing to save time.
4420 ;; Treat each name as its own truename.
4421 (put 'file-truename 'ange-ftp 'identity)
4423 ;; We must return non-nil in order to mask our inability to do the job.
4424 ;; Otherwise there are errors when applied to the target file during
4425 ;; copying from a (localhost) Tramp file.
4426 (put 'set-file-times 'ange-ftp 'ignore)
4428 ;; Turn off RCS/SCCS processing to save time.
4429 ;; This returns nil for any file name as argument.
4430 (put 'vc-registered 'ange-ftp 'null)
4432 ;; We can handle process-file in a restricted way (just for chown).
4433 ;; Nothing possible for `start-file-process'.
4434 (put 'process-file 'ange-ftp 'ange-ftp-process-file)
4435 (put 'start-file-process 'ange-ftp 'ignore)
4436 (put 'shell-command 'ange-ftp 'ange-ftp-shell-command)
4438 ;;; Define ways of getting at unmodified Emacs primitives,
4439 ;;; turning off our handler.
4441 (defun ange-ftp-run-real-handler-orig (operation args)
4442 (let ((inhibit-file-name-handlers
4443 (cons 'ange-ftp-hook-function
4444 (cons 'ange-ftp-completion-hook-function
4445 (and (eq inhibit-file-name-operation operation)
4446 inhibit-file-name-handlers))))
4447 (inhibit-file-name-operation operation))
4448 (apply operation args)))
4450 (defalias 'ange-ftp-run-real-handler
4451 (if (fboundp 'tramp-run-real-handler)
4452 'tramp-run-real-handler 'ange-ftp-run-real-handler-orig))
4454 (defun ange-ftp-real-file-name-directory (&rest args)
4455 (ange-ftp-run-real-handler 'file-name-directory args))
4456 (defun ange-ftp-real-file-name-nondirectory (&rest args)
4457 (ange-ftp-run-real-handler 'file-name-nondirectory args))
4458 (defun ange-ftp-real-file-name-as-directory (&rest args)
4459 (ange-ftp-run-real-handler 'file-name-as-directory args))
4460 (defun ange-ftp-real-directory-file-name (&rest args)
4461 (ange-ftp-run-real-handler 'directory-file-name args))
4462 (defun ange-ftp-real-expand-file-name (&rest args)
4463 (ange-ftp-run-real-handler 'expand-file-name args))
4464 (defun ange-ftp-real-make-directory (&rest args)
4465 (ange-ftp-run-real-handler 'make-directory args))
4466 (defun ange-ftp-real-delete-directory (&rest args)
4467 (ange-ftp-run-real-handler 'delete-directory args))
4468 (defun ange-ftp-real-insert-file-contents (&rest args)
4469 (ange-ftp-run-real-handler 'insert-file-contents args))
4470 (defun ange-ftp-real-directory-files (&rest args)
4471 (ange-ftp-run-real-handler 'directory-files args))
4472 (defun ange-ftp-real-directory-files-and-attributes (&rest args)
4473 (ange-ftp-run-real-handler 'directory-files-and-attributes args))
4474 (defun ange-ftp-real-file-directory-p (&rest args)
4475 (ange-ftp-run-real-handler 'file-directory-p args))
4476 (defun ange-ftp-real-file-writable-p (&rest args)
4477 (ange-ftp-run-real-handler 'file-writable-p args))
4478 (defun ange-ftp-real-file-readable-p (&rest args)
4479 (ange-ftp-run-real-handler 'file-readable-p args))
4480 (defun ange-ftp-real-file-executable-p (&rest args)
4481 (ange-ftp-run-real-handler 'file-executable-p args))
4482 (defun ange-ftp-real-file-symlink-p (&rest args)
4483 (ange-ftp-run-real-handler 'file-symlink-p args))
4484 (defun ange-ftp-real-delete-file (&rest args)
4485 (ange-ftp-run-real-handler 'delete-file args))
4486 (defun ange-ftp-real-verify-visited-file-modtime (&rest args)
4487 (ange-ftp-run-real-handler 'verify-visited-file-modtime args))
4488 (defun ange-ftp-real-file-exists-p (&rest args)
4489 (ange-ftp-run-real-handler 'file-exists-p args))
4490 (defun ange-ftp-real-write-region (&rest args)
4491 (ange-ftp-run-real-handler 'write-region args))
4492 (defun ange-ftp-real-backup-buffer (&rest args)
4493 (ange-ftp-run-real-handler 'backup-buffer args))
4494 (defun ange-ftp-real-copy-file (&rest args)
4495 (ange-ftp-run-real-handler 'copy-file args))
4496 (defun ange-ftp-real-rename-file (&rest args)
4497 (ange-ftp-run-real-handler 'rename-file args))
4498 (defun ange-ftp-real-file-attributes (&rest args)
4499 (ange-ftp-run-real-handler 'file-attributes args))
4500 (defun ange-ftp-real-file-newer-than-file-p (&rest args)
4501 (ange-ftp-run-real-handler 'file-newer-than-file-p args))
4502 (defun ange-ftp-real-file-name-all-completions (&rest args)
4503 (ange-ftp-run-real-handler 'file-name-all-completions args))
4504 (defun ange-ftp-real-file-name-completion (&rest args)
4505 (ange-ftp-run-real-handler 'file-name-completion args))
4506 (defun ange-ftp-real-insert-directory (&rest args)
4507 (ange-ftp-run-real-handler 'insert-directory args))
4508 (defun ange-ftp-real-file-name-sans-versions (&rest args)
4509 (ange-ftp-run-real-handler 'file-name-sans-versions args))
4510 (defun ange-ftp-real-shell-command (&rest args)
4511 (ange-ftp-run-real-handler 'shell-command args))
4512 (defun ange-ftp-real-load (&rest args)
4513 (ange-ftp-run-real-handler 'load args))
4514 (defun ange-ftp-real-find-backup-file-name (&rest args)
4515 (ange-ftp-run-real-handler 'find-backup-file-name args))
4517 ;; Here we support using dired on remote hosts.
4518 ;; I have turned off the support for using dired on foreign directory formats.
4519 ;; That involves too many unclean hooks.
4520 ;; It would be cleaner to support such operations by
4521 ;; converting the foreign directory format to something dired can understand;
4522 ;; something close to ls -l output.
4523 ;; The logical place to do this is in the functions ange-ftp-parse-...-listing.
4525 ;; Some of the old dired hooks would still be needed even if this is done.
4526 ;; I have preserved (and modernized) those hooks.
4527 ;; So the format conversion should be all that is needed.
4529 ;; When called from dired, SWITCHES may start with "--dired".
4530 ;; `ange-ftp-ls' handles this.
4532 (defun ange-ftp-insert-directory (file switches &optional wildcard full)
4533 (if (not (ange-ftp-ftp-name (expand-file-name file)))
4534 (ange-ftp-real-insert-directory file switches wildcard full)
4535 ;; We used to follow symlinks on `file' here. Apparently it was done
4536 ;; because some FTP servers react to "ls foo" by listing the symlink foo
4537 ;; rather than the directory it points to. Now that ange-ftp-ls uses
4538 ;; "cd foo; ls" instead, this is not necessary any more.
4540 (end (point-marker)))
4541 (set-marker-insertion-type end t)
4545 (let ((default-directory (file-name-directory file)))
4546 (ange-ftp-ls (file-name-nondirectory file) switches nil nil t)))
4548 (ange-ftp-ls file switches 'parse))
4550 ;; If `full' is nil we're going to do `ls' for a single file.
4551 ;; Problem is that for various reasons, ange-ftp-ls needs to cd and
4552 ;; then do an ls of current dir, which obviously won't work if we
4553 ;; want to ls a file. So instead, we get a full listing of the
4554 ;; parent directory and extract the line corresponding to `file'.
4555 (when (string-match "-?d\\'" switches)
4556 ;; Remove "d" which dired added to `switches'.
4557 (setq switches (substring switches 0 (match-beginning 0))))
4558 (setq file (directory-file-name file))
4559 (let* ((dirlist (ange-ftp-ls (or (file-name-directory file) ".")
4561 (filename (file-name-nondirectory file))
4562 (case-fold-search nil))
4563 ;; FIXME: This presumes a particular output format, which is
4565 (if (string-match (concat "^.+[^ ] " (regexp-quote filename)
4566 "\\( -> .*\\)?[@/*=]?\n") dirlist)
4567 (match-string 0 dirlist)
4570 ;; Insert " " for dired's alignment sanity.
4572 (while (re-search-forward "^\\(\\S-\\)" end 'move)
4573 (replace-match " \\1"))
4575 ;; The inserted file could be from somewhere else.
4576 (when (and (not wildcard) (not full)
4578 (if (zerop (length (file-name-nondirectory
4579 (expand-file-name file))))
4581 (file-name-nondirectory file))
4583 (replace-match (file-relative-name (expand-file-name file)) t)
4586 (set-marker end nil))))
4588 (defun ange-ftp-dired-uncache (dir)
4589 (if (ange-ftp-ftp-name (expand-file-name dir))
4590 (setq ange-ftp-ls-cache-file nil)))
4592 (defvar ange-ftp-sans-version-alist nil
4593 "Alist of mapping host type into function to remove file version numbers.")
4595 (defun ange-ftp-file-name-sans-versions (file keep-backup-version)
4596 (let* ((short (ange-ftp-abbreviate-filename file))
4597 (parsed (ange-ftp-ftp-name short))
4598 (func (if parsed (cdr (assq (ange-ftp-host-type (car parsed))
4599 ange-ftp-sans-version-alist)))))
4600 (if func (funcall func file keep-backup-version)
4601 (ange-ftp-real-file-name-sans-versions file keep-backup-version))))
4603 ;; This is the handler for shell-command.
4604 (defun ange-ftp-shell-command (command &optional output-buffer error-buffer)
4605 (let* ((parsed (ange-ftp-ftp-name default-directory))
4606 (host (nth 0 parsed))
4607 (user (nth 1 parsed))
4608 (name (nth 2 parsed)))
4610 (ange-ftp-real-shell-command command output-buffer error-buffer)
4611 (if (> (length name) 0) ; else it's $HOME
4612 (setq command (concat "cd " name "; " command)))
4613 ;; Remove port from the hostname
4614 (when (string-match "\\(.*\\)#" host)
4615 (setq host (match-string 1 host)))
4617 (format "%s %s \"%s\"" ; remsh -l USER does not work well
4618 ; on a hp-ux machine I tried
4619 remote-shell-program host command))
4620 (ange-ftp-message "Remote command '%s' ..." command)
4621 ;; Cannot call ange-ftp-real-dired-run-shell-command here as it
4622 ;; would prepend "cd default-directory" --- which bombs because
4623 ;; default-directory is in ange-ftp syntax for remote file names.
4624 (ange-ftp-real-shell-command command output-buffer error-buffer))))
4626 ;;; This is the handler for process-file.
4627 (defun ange-ftp-process-file (program infile buffer display &rest arguments)
4628 ;; PROGRAM is always one of those below in the cond in dired.el.
4629 ;; The ARGUMENTS are (nearly) always files.
4630 (if (ange-ftp-ftp-name default-directory)
4631 ;; Can't use ange-ftp-dired-host-type here because the current
4632 ;; buffer is *dired-check-process output*
4633 (condition-case oops
4634 (cond ((equal (or (bound-and-true-p dired-chmod-program) "chmod")
4636 (ange-ftp-call-chmod arguments))
4637 ;; ((equal "chgrp" program))
4638 ;; ((equal dired-chown-program program))
4639 (t (error "Unknown remote command: %s" program)))
4640 (ftp-error (insert (format "%s: %s, %s\n"
4644 ;; Caller expects nonzero value to mean failure.
4646 (error (insert (format "%s\n" (nth 1 oops)))
4648 (apply 'call-process program infile buffer display arguments)))
4650 ;; Handle an attempt to run chmod on a remote file
4651 ;; by using the ftp chmod command.
4652 (defun ange-ftp-call-chmod (args)
4653 (if (< (length args) 2)
4654 (error "ange-ftp-call-chmod: missing mode and/or filename: %s" args))
4655 (let ((mode (car args))
4657 (if (equal "--" (car rest))
4658 (setq rest (cdr rest)))
4661 (setq file (expand-file-name file))
4662 (let ((parsed (ange-ftp-ftp-name file)))
4664 (let* ((host (nth 0 parsed))
4665 (user (nth 1 parsed))
4666 (name (ange-ftp-quote-string (nth 2 parsed)))
4667 (abbr (ange-ftp-abbreviate-filename file))
4668 (result (ange-ftp-send-cmd host user
4669 (list 'chmod mode name)
4670 (format "doing chmod %s"
4674 host user (concat "CHMOD failed: " (cdr result))))))))
4676 (setq ange-ftp-ls-cache-file nil) ;Stop confusing Dired.
4679 (defun ange-ftp-set-file-modes (filename mode)
4680 (ange-ftp-call-chmod (list (format "%o" mode) filename)))
4682 ;; This is turned off because it has nothing properly to do
4683 ;; with dired. It could be reasonable to adapt this to
4684 ;; replace ange-ftp-copy-file.
4686 ;;;;; ------------------------------------------------------------
4687 ;;;;; Noddy support for async copy-file within dired.
4688 ;;;;; ------------------------------------------------------------
4690 ;;(defun ange-ftp-dired-copy-file (from to ok-flag &optional cont nowait)
4691 ;; "Documented as original."
4692 ;; (dired-handle-overwrite to)
4693 ;; (ange-ftp-copy-file-internal from to ok-flag dired-copy-preserve-time nil
4696 ;;(defun ange-ftp-dired-do-create-files (op-symbol file-creator operation arg
4697 ;; &optional marker-char op1
4699 ;; "Documented as original."
4700 ;; ;; we need to let ange-ftp-dired-create-files know that we indirectly
4701 ;; ;; called it rather than somebody else.
4702 ;; (let ((ange-ftp-dired-do-create-files t)) ; tell who caller is
4703 ;; (ange-ftp-real-dired-do-create-files op-symbol file-creator operation
4704 ;; arg marker-char op1 how-to)))
4706 ;;(defun ange-ftp-dired-create-files (file-creator operation fn-list name-constructor
4707 ;; &optional marker-char)
4708 ;; "Documented as original."
4709 ;; (if (and (boundp 'ange-ftp-dired-do-create-files)
4710 ;; ;; called from ange-ftp-dired-do-create-files?
4711 ;; ange-ftp-dired-do-create-files
4712 ;; ;; any files worth copying?
4714 ;; ;; we only support async copy-file at the mo.
4715 ;; (eq file-creator 'dired-copy-file)
4716 ;; ;; it is only worth calling the alternative function for remote files
4717 ;; ;; as we tie ourself in recursive knots otherwise.
4718 ;; (or (ange-ftp-ftp-name (car fn-list))
4719 ;; ;; we can only call the name constructor for dired-do-create-files
4720 ;; ;; since the one for regexps starts prompting here, there and
4722 ;; (ange-ftp-ftp-name (funcall name-constructor (car fn-list)))))
4723 ;; ;; use the process-filter driven routine rather than the iterative one.
4724 ;; (ange-ftp-dcf-1 file-creator
4728 ;; (and (boundp 'target) target) ;dynamically bound
4731 ;; nil ;overwrite-query
4732 ;; nil ;overwrite-backup-query
4736 ;; (length fn-list) ;total
4738 ;; ;; normal case... use the interactive routine... much cheaper.
4739 ;; (ange-ftp-real-dired-create-files file-creator operation fn-list
4740 ;; name-constructor marker-char)))
4742 ;;(defun ange-ftp-dcf-1 (file-creator operation fn-list name-constructor
4743 ;; target marker-char buffer overwrite-query
4744 ;; overwrite-backup-query failures skipped
4745 ;; success-count total)
4746 ;; (with-current-buffer buffer
4747 ;; (if (null fn-list)
4748 ;; (ange-ftp-dcf-3 failures operation total skipped
4749 ;; success-count buffer)
4751 ;; (let* ((from (car fn-list))
4752 ;; (to (funcall name-constructor from)))
4753 ;; (if (equal to from)
4756 ;; (dired-log "Cannot %s to same file: %s\n"
4757 ;; (downcase operation) from)))
4759 ;; (ange-ftp-dcf-1 file-creator
4767 ;; overwrite-backup-query
4769 ;; (cons (dired-make-relative from) skipped)
4772 ;; (let* ((overwrite (file-exists-p to))
4773 ;; (overwrite-confirmed ; for dired-handle-overwrite
4775 ;; (let ((help-form '(format "\
4776 ;;Type SPC or `y' to overwrite file `%s',
4777 ;;DEL or `n' to skip to next,
4778 ;;ESC or `q' to not overwrite any of the remaining files,
4779 ;;`!' to overwrite all remaining files with no more questions." to)))
4780 ;; (dired-query 'overwrite-query
4781 ;; "Overwrite `%s'?" to))))
4782 ;; ;; must determine if FROM is marked before file-creator
4783 ;; ;; gets a chance to delete it (in case of a move).
4784 ;; (actual-marker-char
4785 ;; (cond ((integerp marker-char) marker-char)
4786 ;; (marker-char (dired-file-marker from)) ; slow
4788 ;; (condition-case err
4789 ;; (funcall file-creator from to overwrite-confirmed
4790 ;; (list 'ange-ftp-dcf-2
4792 ;; file-creator operation fn-list
4795 ;; marker-char actual-marker-char
4798 ;; overwrite-confirmed
4800 ;; overwrite-backup-query
4801 ;; failures skipped success-count
4804 ;; (file-error ; FILE-CREATOR aborted
4805 ;; (ange-ftp-dcf-2 nil ;result
4808 ;; file-creator operation fn-list
4811 ;; marker-char actual-marker-char
4814 ;; overwrite-confirmed
4816 ;; overwrite-backup-query
4817 ;; failures skipped success-count
4820 ;;(defun ange-ftp-dcf-2 (result line err
4821 ;; file-creator operation fn-list
4824 ;; marker-char actual-marker-char
4827 ;; overwrite-confirmed
4829 ;; overwrite-backup-query
4830 ;; failures skipped success-count
4832 ;; (with-current-buffer buffer
4833 ;; (if (or err (not result))
4835 ;; (setq failures (cons (dired-make-relative from) failures))
4836 ;; (dired-log "%s `%s' to `%s' failed:\n%s\n"
4837 ;; operation from to (or err line)))
4839 ;; ;; If we get here, file-creator hasn't been aborted
4840 ;; ;; and the old entry (if any) has to be deleted
4841 ;; ;; before adding the new entry.
4842 ;; (dired-remove-file to))
4843 ;; (setq success-count (1+ success-count))
4844 ;; (message "%s: %d of %d" operation success-count total)
4845 ;; (dired-add-file to actual-marker-char))
4847 ;; (ange-ftp-dcf-1 file-creator operation (cdr fn-list)
4853 ;; overwrite-backup-query
4854 ;; failures skipped success-count
4857 ;;(defun ange-ftp-dcf-3 (failures operation total skipped success-count
4859 ;; (with-current-buffer buffer
4862 ;; (dired-log-summary
4863 ;; (message "%s failed for %d of %d file%s %s"
4864 ;; operation (length failures) total
4865 ;; (dired-plural-s total) failures)))
4867 ;; (dired-log-summary
4868 ;; (message "%s: %d of %d file%s skipped %s"
4869 ;; operation (length skipped) total
4870 ;; (dired-plural-s total) skipped)))
4872 ;; (message "%s: %s file%s."
4873 ;; operation success-count (dired-plural-s success-count))))
4874 ;; (dired-move-to-filename)))
4876 ;;;; -----------------------------------------------
4877 ;;;; Unix Descriptive Listing (dl) Support
4878 ;;;; -----------------------------------------------
4880 ;; This is turned off because nothing uses it currently
4881 ;; and because I don't understand what it's supposed to be for. --rms.
4883 ;;(defconst ange-ftp-dired-dl-re-dir
4884 ;; "^. [^ /]+/[ \n]"
4885 ;; "Regular expression to use to search for dl directories.")
4887 ;;(or (assq 'unix:dl ange-ftp-dired-re-dir-alist)
4888 ;; (setq ange-ftp-dired-re-dir-alist
4889 ;; (cons (cons 'unix:dl ange-ftp-dired-dl-re-dir)
4890 ;; ange-ftp-dired-re-dir-alist)))
4892 ;;(defun ange-ftp-dired-dl-move-to-filename (&optional raise-error eol)
4893 ;; "In dired, move to the first character of the filename on this line."
4894 ;; ;; This is the Unix dl version.
4895 ;; (or eol (setq eol (progn (end-of-line) (point))))
4896 ;; (let (case-fold-search)
4897 ;; (beginning-of-line)
4898 ;; (if (looking-at ". [^ ]+ +\\([0-9]+\\|-\\|=\\) ")
4899 ;; (goto-char (+ (point) 2))
4901 ;; (error "No file on this line")
4904 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-filename-alist)
4905 ;; (setq ange-ftp-dired-move-to-filename-alist
4906 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-filename)
4907 ;; ange-ftp-dired-move-to-filename-alist)))
4909 ;;(defun ange-ftp-dired-dl-move-to-end-of-filename (&optional no-error eol)
4910 ;; ;; Assumes point is at beginning of filename.
4911 ;; ;; So, it should be called only after (dired-move-to-filename t).
4912 ;; ;; On failure, signals an error or returns nil.
4913 ;; ;; This is the Unix dl version.
4914 ;; (let ((opoint (point))
4915 ;; case-fold-search hidden)
4916 ;; (or eol (setq eol (line-end-position)))
4917 ;; (setq hidden (and selective-display
4919 ;; (search-forward "\r" eol t))))
4924 ;; (substitute-command-keys
4925 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
4926 ;; (skip-chars-forward "^ /" eol)
4927 ;; (if (eq opoint (point))
4930 ;; (error "No file on this line"))
4933 ;;(or (assq 'unix:dl ange-ftp-dired-move-to-end-of-filename-alist)
4934 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
4935 ;; (cons '(unix:dl . ange-ftp-dired-dl-move-to-end-of-filename)
4936 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
4938 ;;;; ------------------------------------------------------------
4939 ;;;; VOS support (VOS support is probably broken,
4940 ;;;; but I don't know anything about VOS.)
4941 ;;;; ------------------------------------------------------------
4943 ;(defun ange-ftp-fix-name-for-vos (name &optional reverse)
4944 ; (setq name (copy-sequence name))
4945 ; (let ((from (if reverse ?\> ?\/))
4946 ; (to (if reverse ?\/ ?\>))
4947 ; (i (1- (length name))))
4949 ; (if (= (aref name i) from)
4954 ;(or (assq 'vos ange-ftp-fix-name-func-alist)
4955 ; (setq ange-ftp-fix-name-func-alist
4956 ; (cons '(vos . ange-ftp-fix-name-for-vos)
4957 ; ange-ftp-fix-name-func-alist)))
4959 ;(or (memq 'vos ange-ftp-dumb-host-types)
4960 ; (setq ange-ftp-dumb-host-types
4961 ; (cons 'vos ange-ftp-dumb-host-types)))
4963 ;(defun ange-ftp-fix-dir-name-for-vos (dir-name)
4964 ; (ange-ftp-fix-name-for-vos
4966 ; (if (eq ?/ (aref dir-name (1- (length dir-name))))
4970 ;(or (assq 'vos ange-ftp-fix-dir-name-func-alist)
4971 ; (setq ange-ftp-fix-dir-name-func-alist
4972 ; (cons '(vos . ange-ftp-fix-dir-name-for-vos)
4973 ; ange-ftp-fix-dir-name-func-alist)))
4975 ;(defvar ange-ftp-vos-host-regexp nil
4976 ; "If a host matches this regexp then it is assumed to be running VOS.")
4978 ;(defun ange-ftp-vos-host (host)
4979 ; (and ange-ftp-vos-host-regexp
4981 ; (string-match ange-ftp-vos-host-regexp host))))
4983 ;(defun ange-ftp-parse-vos-listing ()
4984 ; "Parse the current buffer which is assumed to be in VOS list -all
4985 ;format, and return a hashtable as the result."
4986 ; (let ((tbl (ange-ftp-make-hashtable))
4988 ; '(("^Files: [0-9]+ +Blocks: [0-9]+\n+" nil 40)
4989 ; ("^Dirs: [0-9]+\n+" t 30)))
4990 ; type-regexp type-is-dir type-col file)
4991 ; (goto-char (point-min))
4994 ; (setq type-regexp (car (car type-list))
4995 ; type-is-dir (nth 1 (car type-list))
4996 ; type-col (nth 2 (car type-list))
4997 ; type-list (cdr type-list))
4998 ; (if (re-search-forward type-regexp nil t)
4999 ; (while (eq (char-after (point)) ? )
5000 ; (move-to-column type-col)
5001 ; (setq file (buffer-substring (point)
5005 ; (puthash file type-is-dir tbl)
5006 ; (forward-line 1))))
5007 ; (puthash "." 'vosdir tbl)
5008 ; (puthash ".." 'vosdir tbl))
5011 ;(or (assq 'vos ange-ftp-parse-list-func-alist)
5012 ; (setq ange-ftp-parse-list-func-alist
5013 ; (cons '(vos . ange-ftp-parse-vos-listing)
5014 ; ange-ftp-parse-list-func-alist)))
5016 ;;;; ------------------------------------------------------------
5018 ;;;; ------------------------------------------------------------
5020 ;; Convert NAME from UNIX-ish to VMS. If REVERSE given then convert from VMS
5022 (defun ange-ftp-fix-name-for-vms (name &optional reverse)
5025 (if (string-match "\\`\\([^:]+:\\)?\\(\\[.*\\]\\)?\\([^][]*\\)\\'" name)
5026 (let (drive dir file)
5027 (setq drive (match-string 1 name))
5028 (setq dir (match-string 2 name))
5029 (setq file (match-string 3 name))
5031 (setq dir (subst-char-in-string
5032 ?/ ?. (substring dir 1 -1) t)))
5034 (concat "/" drive "/"))
5037 (error "name %s didn't match" name))
5038 (let (drive dir file tmp quote)
5039 (if (string-match "\\`\".+\"\\'" name)
5040 (setq name (substring name 1 -1)
5043 (if (string-match "\\`/[^:]+:/" name)
5044 (setq drive (substring name 1
5046 name (substring name (match-end 0))))
5047 (setq tmp (file-name-directory name))
5049 (setq dir (subst-char-in-string ?/ ?. (substring tmp 0 -1) t)))
5050 (setq file (file-name-nondirectory name))
5052 (and dir (concat "[" (if drive nil ".") dir "]"))
5055 ;; (ange-ftp-fix-name-for-vms "/PUB$:/ANONYMOUS/SDSCPUB/NEXT/Readme.txt;1")
5056 ;; (ange-ftp-fix-name-for-vms "/PUB$:[ANONYMOUS.SDSCPUB.NEXT]Readme.txt;1" t)
5058 (or (assq 'vms ange-ftp-fix-name-func-alist)
5059 (setq ange-ftp-fix-name-func-alist
5060 (cons '(vms . ange-ftp-fix-name-for-vms)
5061 ange-ftp-fix-name-func-alist)))
5063 (or (memq 'vms ange-ftp-dumb-host-types)
5064 (setq ange-ftp-dumb-host-types
5065 (cons 'vms ange-ftp-dumb-host-types)))
5067 ;; It is important that this function barf for directories for which we know
5068 ;; that we cannot possibly get a directory listing, such as "/" and "/DEV:/".
5069 ;; This is because it saves an unnecessary FTP error, or possibly the listing
5070 ;; might succeed, but give erroneous info. This last case is particularly
5071 ;; likely for OS's (like MTS) for which we need to use a wildcard in order
5072 ;; to list a directory.
5074 ;; Convert name from UNIX-ish to VMS ready for a DIRectory listing.
5075 (defun ange-ftp-fix-dir-name-for-vms (dir-name)
5076 ;; Should there be entries for .. -> [-] and . -> [] below. Don't
5077 ;; think so, because expand-filename should have already short-circuited
5079 (cond ((string-equal dir-name "/")
5080 (error "Cannot get listing for fictitious \"/\" directory"))
5081 ((string-match "\\`/[-A-Z0-9_$]+:/\\'" dir-name)
5082 (error "Cannot get listing for device"))
5083 ((ange-ftp-fix-name-for-vms dir-name))))
5085 (or (assq 'vms ange-ftp-fix-dir-name-func-alist)
5086 (setq ange-ftp-fix-dir-name-func-alist
5087 (cons '(vms . ange-ftp-fix-dir-name-for-vms)
5088 ange-ftp-fix-dir-name-func-alist)))
5090 (defvar ange-ftp-vms-host-regexp nil)
5092 ;; Return non-nil if HOST is running VMS.
5093 (defun ange-ftp-vms-host (host)
5094 (and ange-ftp-vms-host-regexp
5095 (string-match-p ange-ftp-vms-host-regexp host)))
5097 ;; Because some VMS ftp servers convert filenames to lower case
5098 ;; we allow a-z in the filename regexp. I'm not too happy about this.
5100 (defconst ange-ftp-vms-filename-regexp
5102 "\\(\\([_A-Za-z0-9$]?\\|[_A-Za-z0-9$][-_A-Za-z0-9$]*\\)\\."
5103 "[-_A-Za-z0-9$]*;+[0-9]*\\)")
5104 "Regular expression to match for a valid VMS file name in Dired buffer.
5105 Stupid freaking bug! Position of _ and $ shouldn't matter but they do.
5106 Having [A-Z0-9$_] bombs on filename _$$CHANGE_LOG$.TXT$ and $CHANGE_LOG$.TX.
5107 Other orders of $ and _ seem to all work just fine.")
5109 ;; These parsing functions are as general as possible because the syntax
5110 ;; of ftp listings from VMS hosts is a bit erratic. What saves us is that
5111 ;; the VMS filename syntax is so rigid. If they bomb on a listing in the
5112 ;; standard VMS Multinet format, then this is a bug. If they bomb on a listing
5113 ;; from vms.weird.net, then too bad.
5115 ;; Extract the next filename from a VMS dired-like listing.
5116 (defun ange-ftp-parse-vms-filename ()
5117 (if (re-search-forward
5118 ange-ftp-vms-filename-regexp
5122 ;; Parse the current buffer which is assumed to be in MultiNet FTP dir
5123 ;; format, and return a hashtable as the result.
5124 (defun ange-ftp-parse-vms-listing ()
5125 (let ((tbl (make-hash-table :test 'equal))
5127 (goto-char (point-min))
5129 (while (setq file (ange-ftp-parse-vms-filename))
5130 (if (string-match "\\.\\(DIR\\|dir\\);[0-9]+" file)
5131 ;; deal with directories
5132 (puthash (substring file 0 (match-beginning 0)) t tbl)
5133 (puthash file nil tbl)
5134 (if (string-match ";[0-9]+\\'" file) ; deal with extension
5136 (puthash (substring file 0 (match-beginning 0)) nil tbl)))
5138 ;; Would like to look for a "Total" line, or a "Directory" line to
5139 ;; make sure that the listing isn't complete garbage before putting
5140 ;; in "." and "..", but we can't count on VMS giving us
5143 (puthash ".." t tbl))
5146 (add-to-list 'ange-ftp-parse-list-func-alist
5147 '(vms . ange-ftp-parse-vms-listing))
5149 ;; This version only deletes file entries which have
5150 ;; explicit version numbers, because that is all VMS allows.
5152 ;; Can the following two functions be speeded up using file
5153 ;; completion functions?
5155 (defun ange-ftp-vms-delete-file-entry (name &optional dir-p)
5157 (ange-ftp-internal-delete-file-entry name t)
5159 (let ((file (ange-ftp-get-file-part name)))
5160 (if (string-match ";[0-9]+\\'" file)
5161 ;; In VMS you can't delete a file without an explicit
5162 ;; version number, or wild-card (e.g. FOO;*)
5163 ;; For now, we give up on wildcards.
5164 (let ((files (gethash (file-name-directory name)
5165 ange-ftp-files-hashtable)))
5167 (let* ((root (substring file 0
5168 (match-beginning 0)))
5173 (remhash file files)
5174 ;; Now we need to check if there are any
5175 ;; versions left. If not, then delete the
5179 (and (string-match regexp key)
5183 (remhash root files))))))))))
5185 (or (assq 'vms ange-ftp-delete-file-entry-alist)
5186 (setq ange-ftp-delete-file-entry-alist
5187 (cons '(vms . ange-ftp-vms-delete-file-entry)
5188 ange-ftp-delete-file-entry-alist)))
5190 (defun ange-ftp-vms-add-file-entry (name &optional dir-p)
5192 (ange-ftp-internal-add-file-entry name t)
5193 (let ((files (gethash (file-name-directory name)
5194 ange-ftp-files-hashtable)))
5196 (let ((file (ange-ftp-get-file-part name)))
5198 (if (string-match ";[0-9]+\\'" file)
5199 (puthash (substring file 0 (match-beginning 0)) nil files)
5200 ;; Need to figure out what version of the file
5202 (let ((regexp (concat "^"
5208 (and (string-match regexp name)
5211 (string-to-number (match-string 1 name))))))
5213 (setq version (1+ version))
5215 (concat file ";" (int-to-string version))
5217 (puthash file nil files))))))
5219 (or (assq 'vms ange-ftp-add-file-entry-alist)
5220 (setq ange-ftp-add-file-entry-alist
5221 (cons '(vms . ange-ftp-vms-add-file-entry)
5222 ange-ftp-add-file-entry-alist)))
5225 (defun ange-ftp-add-vms-host (host)
5226 "Mark HOST as the name of a machine running VMS."
5228 (list (read-string "Host: "
5229 (let ((name (or (buffer-file-name) default-directory)))
5230 (and name (car (ange-ftp-ftp-name name)))))))
5231 (if (not (ange-ftp-vms-host host))
5232 (setq ange-ftp-vms-host-regexp
5233 (concat "^" (regexp-quote host) "$"
5234 (and ange-ftp-vms-host-regexp "\\|")
5235 ange-ftp-vms-host-regexp)
5236 ange-ftp-host-cache nil)))
5239 (defun ange-ftp-vms-file-name-as-directory (name)
5241 (if (string-match "\\.\\(DIR\\|dir\\)\\(;[0-9]+\\)?\\'" name)
5242 (setq name (substring name 0 (match-beginning 0))))
5243 (ange-ftp-real-file-name-as-directory name)))
5245 (or (assq 'vms ange-ftp-file-name-as-directory-alist)
5246 (setq ange-ftp-file-name-as-directory-alist
5247 (cons '(vms . ange-ftp-vms-file-name-as-directory)
5248 ange-ftp-file-name-as-directory-alist)))
5250 ;;; Tree dired support:
5252 ;; For this code I have borrowed liberally from Sebastian Kremer's
5256 ;;;; These regexps must be anchored to beginning of line.
5257 ;;;; Beware that the ftpd may put the device in front of the filename.
5259 ;;(defconst ange-ftp-dired-vms-re-exe "^. [^ \t.]+\\.\\(EXE\\|exe\\)[; ]"
5260 ;; "Regular expression to use to search for VMS executable files.")
5262 ;;(defconst ange-ftp-dired-vms-re-dir "^. [^ \t.]+\\.\\(DIR\\|dir\\)[; ]"
5263 ;; "Regular expression to use to search for VMS directories.")
5265 ;;(or (assq 'vms ange-ftp-dired-re-exe-alist)
5266 ;; (setq ange-ftp-dired-re-exe-alist
5267 ;; (cons (cons 'vms ange-ftp-dired-vms-re-exe)
5268 ;; ange-ftp-dired-re-exe-alist)))
5270 ;;(or (assq 'vms ange-ftp-dired-re-dir-alist)
5271 ;; (setq ange-ftp-dired-re-dir-alist
5272 ;; (cons (cons 'vms ange-ftp-dired-vms-re-dir)
5273 ;; ange-ftp-dired-re-dir-alist)))
5275 ;;(defun ange-ftp-dired-vms-insert-headerline (dir)
5276 ;; ;; VMS inserts a headerline. I would prefer the headerline
5277 ;; ;; to be in ange-ftp format. This version tries to
5278 ;; ;; be careful, because we can't count on a headerline
5279 ;; ;; over ftp, and we wouldn't want to delete anything
5282 ;; (if (looking-at "^ wildcard ")
5283 ;; (forward-line 1))
5284 ;; (if (looking-at "^[ \n\t]*[^\n]+\\][ \t]*\n")
5285 ;; (delete-region (point) (match-end 0))))
5286 ;; (ange-ftp-real-dired-insert-headerline dir))
5288 ;;(or (assq 'vms ange-ftp-dired-insert-headerline-alist)
5289 ;; (setq ange-ftp-dired-insert-headerline-alist
5290 ;; (cons '(vms . ange-ftp-dired-vms-insert-headerline)
5291 ;; ange-ftp-dired-insert-headerline-alist)))
5293 ;;(defun ange-ftp-dired-vms-move-to-filename (&optional raise-error eol)
5294 ;; "In dired, move to first char of filename on this line.
5295 ;;Returns position (point) or nil if no filename on this line."
5296 ;; ;; This is the VMS version.
5297 ;; (let (case-fold-search)
5298 ;; (or eol (setq eol (progn (end-of-line) (point))))
5299 ;; (beginning-of-line)
5300 ;; (if (re-search-forward ange-ftp-vms-filename-regexp eol t)
5301 ;; (goto-char (match-beginning 1))
5303 ;; (error "No file on this line")
5306 ;;(or (assq 'vms ange-ftp-dired-move-to-filename-alist)
5307 ;; (setq ange-ftp-dired-move-to-filename-alist
5308 ;; (cons '(vms . ange-ftp-dired-vms-move-to-filename)
5309 ;; ange-ftp-dired-move-to-filename-alist)))
5311 ;;(defun ange-ftp-dired-vms-move-to-end-of-filename (&optional no-error eol)
5312 ;; ;; Assumes point is at beginning of filename.
5313 ;; ;; So, it should be called only after (dired-move-to-filename t).
5314 ;; ;; case-fold-search must be nil, at least for VMS.
5315 ;; ;; On failure, signals an error or returns nil.
5316 ;; ;; This is the VMS version.
5317 ;; (let (opoint hidden case-fold-search)
5318 ;; (setq opoint (point))
5319 ;; (or eol (setq eol (line-end-position)))
5320 ;; (setq hidden (and selective-display
5321 ;; (save-excursion (search-forward "\r" eol t))))
5324 ;; (re-search-forward ange-ftp-vms-filename-regexp eol t))
5326 ;; (not (eq opoint (point)))
5329 ;; (substitute-command-keys
5330 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5331 ;; "No file on this line")))
5332 ;; (if (eq opoint (point))
5336 ;;(or (assq 'vms ange-ftp-dired-move-to-end-of-filename-alist)
5337 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5338 ;; (cons '(vms . ange-ftp-dired-vms-move-to-end-of-filename)
5339 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5341 ;;(defun ange-ftp-dired-vms-between-files ()
5343 ;; (beginning-of-line)
5344 ;; (or (equal (following-char) 10) ; newline
5345 ;; (equal (following-char) 9) ; tab
5346 ;; (progn (forward-char 2)
5347 ;; (or (looking-at "Total of")
5348 ;; (equal (following-char) 32))))))
5350 ;;(or (assq 'vms ange-ftp-dired-between-files-alist)
5351 ;; (setq ange-ftp-dired-between-files-alist
5352 ;; (cons '(vms . ange-ftp-dired-vms-between-files)
5353 ;; ange-ftp-dired-between-files-alist)))
5355 ;; Beware! In VMS filenames must be of the form "FILE.TYPE".
5356 ;; Therefore, we cannot just append a ".Z" to filenames for
5357 ;; compressed files. Instead, we turn "FILE.TYPE" into
5358 ;; "FILE.TYPE-Z". Hope that this is a reasonable thing to do.
5360 (defun ange-ftp-vms-make-compressed-filename (name &optional reverse)
5362 ((string-match "-Z;[0-9]+\\'" name)
5363 (list nil (substring name 0 (match-beginning 0))))
5364 ((string-match ";[0-9]+\\'" name)
5365 (list nil (substring name 0 (match-beginning 0))))
5366 ((string-match "-Z\\'" name)
5367 (list nil (substring name 0 -2)))
5370 (if (string-match ";[0-9]+\\'" name)
5371 (concat (substring name 0 (match-beginning 0))
5373 (concat name "-Z"))))))
5375 (or (assq 'vms ange-ftp-make-compressed-filename-alist)
5376 (setq ange-ftp-make-compressed-filename-alist
5377 (cons '(vms . ange-ftp-vms-make-compressed-filename)
5378 ange-ftp-make-compressed-filename-alist)))
5380 ;;;; When the filename is too long, VMS will use two lines to list a file
5381 ;;;; (damn them!) This will confuse dired. To solve this, need to convince
5382 ;;;; Sebastian to use a function dired-go-to-end-of-file-line, instead of
5383 ;;;; (forward-line 1). This would require a number of changes to dired.el.
5384 ;;;; If dired gets confused, revert-buffer will fix it.
5386 ;;(defun ange-ftp-dired-vms-ls-trim ()
5387 ;; (goto-char (point-min))
5388 ;; (let ((case-fold-search nil))
5389 ;; (re-search-forward ange-ftp-vms-filename-regexp))
5390 ;; (beginning-of-line)
5391 ;; (delete-region (point-min) (point))
5393 ;; (delete-region (point) (point-max)))
5396 ;;(or (assq 'vms ange-ftp-dired-ls-trim-alist)
5397 ;; (setq ange-ftp-dired-ls-trim-alist
5398 ;; (cons '(vms . ange-ftp-dired-vms-ls-trim)
5399 ;; ange-ftp-dired-ls-trim-alist)))
5401 (defun ange-ftp-vms-sans-version (name &rest args)
5403 (if (string-match ";[0-9]+\\'" name)
5404 (substring name 0 (match-beginning 0))
5407 (or (assq 'vms ange-ftp-sans-version-alist)
5408 (setq ange-ftp-sans-version-alist
5409 (cons '(vms . ange-ftp-vms-sans-version)
5410 ange-ftp-sans-version-alist)))
5412 ;;(defvar ange-ftp-file-version-alist)
5414 ;;;;; The vms version of clean-directory has 2 more optional args
5415 ;;;;; than the usual dired version. This is so that it can be used by
5416 ;;;;; ange-ftp-dired-vms-flag-backup-files.
5418 ;;(defun ange-ftp-dired-vms-clean-directory (keep &optional marker msg)
5419 ;; "Flag numerical backups for deletion.
5420 ;;Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
5421 ;;Positive prefix arg KEEP overrides `dired-kept-versions';
5422 ;;Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
5424 ;;To clear the flags on these files, you can use \\[dired-flag-backup-files]
5425 ;;with a prefix argument."
5426 ;;; (interactive "P") ; Never actually called interactively.
5427 ;; (setq keep (max 1 (if keep (prefix-numeric-value keep) dired-kept-versions)))
5428 ;; (let ((early-retention (if (< keep 0) (- keep) kept-old-versions))
5429 ;; ;; late-retention must NEVER be allowed to be less than 1 in VMS!
5430 ;; ;; This could wipe ALL copies of the file.
5431 ;; (late-retention (max 1 (if (<= keep 0) dired-kept-versions keep)))
5432 ;; (action (or msg "Cleaning"))
5433 ;; (ange-ftp-trample-marker (or marker dired-del-marker))
5434 ;; (ange-ftp-file-version-alist ()))
5435 ;; (message (concat action
5436 ;; " numerical backups (keeping %d late, %d old)...")
5437 ;; late-retention early-retention)
5438 ;; ;; Look at each file.
5439 ;; ;; If the file has numeric backup versions,
5440 ;; ;; put on ange-ftp-file-version-alist an element of the form
5441 ;; ;; (FILENAME . VERSION-NUMBER-LIST)
5442 ;; (dired-map-dired-file-lines 'ange-ftp-dired-vms-collect-file-versions)
5443 ;; ;; Sort each VERSION-NUMBER-LIST,
5444 ;; ;; and remove the versions not to be deleted.
5445 ;; (let ((fval ange-ftp-file-version-alist))
5447 ;; (let* ((sorted-v-list (cons 'q (sort (cdr (car fval)) '<)))
5448 ;; (v-count (length sorted-v-list)))
5449 ;; (if (> v-count (+ early-retention late-retention))
5450 ;; (rplacd (nthcdr early-retention sorted-v-list)
5451 ;; (nthcdr (- v-count late-retention)
5453 ;; (rplacd (car fval)
5454 ;; (cdr sorted-v-list)))
5455 ;; (setq fval (cdr fval))))
5456 ;; ;; Look at each file. If it is a numeric backup file,
5457 ;; ;; find it in a VERSION-NUMBER-LIST and maybe flag it for deletion.
5458 ;; (dired-map-dired-file-lines
5459 ;; 'ange-ftp-dired-vms-trample-file-versions mark)
5460 ;; (message (concat action " numerical backups...done"))))
5462 ;;(or (assq 'vms ange-ftp-dired-clean-directory-alist)
5463 ;; (setq ange-ftp-dired-clean-directory-alist
5464 ;; (cons '(vms . ange-ftp-dired-vms-clean-directory)
5465 ;; ange-ftp-dired-clean-directory-alist)))
5467 ;;(defun ange-ftp-dired-vms-collect-file-versions (fn)
5468 ;; ;; "If it looks like file FN has versions, return a list of the versions.
5469 ;; ;;That is a list of strings which are file names.
5470 ;; ;;The caller may want to flag some of these files for deletion."
5471 ;;(let ((name (nth 2 (ange-ftp-ftp-name fn))))
5472 ;; (if (string-match ";[0-9]+$" name)
5473 ;; (let* ((name (substring name 0 (match-beginning 0)))
5474 ;; (fn (ange-ftp-replace-name-component fn name)))
5475 ;; (if (not (assq fn ange-ftp-file-version-alist))
5476 ;; (let* ((base-versions
5477 ;; (concat (file-name-nondirectory name) ";"))
5478 ;; (bv-length (length base-versions))
5479 ;; (possibilities (file-name-all-completions
5481 ;; (file-name-directory fn)))
5482 ;; (versions (mapcar
5484 ;; (if (and (string-match
5485 ;; "[0-9]+$" arg bv-length)
5486 ;; (= (match-beginning 0) bv-length))
5487 ;; (string-to-int (substring arg bv-length))
5492 ;; ange-ftp-file-version-alist
5493 ;; (cons (cons fn versions)
5494 ;; ange-ftp-file-version-alist)))))))))
5496 ;;(defun ange-ftp-dired-vms-trample-file-versions (fn)
5497 ;; (let* ((start-vn (string-match ";[0-9]+$" fn))
5498 ;; base-version-list)
5500 ;; (setq base-version-list ; there was a base version to which
5501 ;; (assoc (substring fn 0 start-vn) ; this looks like a
5502 ;; ange-ftp-file-version-alist)) ; subversion
5503 ;; (not (memq (string-to-int (substring fn (1+ start-vn)))
5504 ;; base-version-list)) ; this one doesn't make the cut
5505 ;; (progn (beginning-of-line)
5507 ;; (insert ange-ftp-trample-marker)))))
5509 ;;(defun ange-ftp-dired-vms-flag-backup-files (&optional unflag-p)
5510 ;; (let ((dired-kept-versions 1)
5511 ;; (kept-old-versions 0)
5514 ;; (setq marker ?\040 msg "Unflagging")
5515 ;; (setq marker dired-del-marker msg "Cleaning"))
5516 ;; (ange-ftp-dired-vms-clean-directory nil marker msg)))
5518 ;;(or (assq 'vms ange-ftp-dired-flag-backup-files-alist)
5519 ;; (setq ange-ftp-dired-flag-backup-files-alist
5520 ;; (cons '(vms . ange-ftp-dired-vms-flag-backup-files)
5521 ;; ange-ftp-dired-flag-backup-files-alist)))
5523 ;;(defun ange-ftp-dired-vms-backup-diff (&optional switches)
5524 ;; (let ((file (dired-get-filename 'no-dir))
5526 ;; (if (and (string-match ";[0-9]+$" file)
5527 ;; ;; Find most recent previous version.
5528 ;; (let ((root (substring file 0 (match-beginning 0)))
5530 ;; (string-to-int (substring file (1+ (match-beginning 0)))))
5532 ;; (setq ver (1- ver))
5533 ;; (while (and (> ver 0) (not found))
5534 ;; (setq bak (concat root ";" (int-to-string ver)))
5535 ;; (and (file-exists-p bak) (setq found t))
5536 ;; (setq ver (1- ver)))
5539 ;; (diff (expand-file-name bak) (expand-file-name file) switches)
5540 ;; (diff (expand-file-name bak) (expand-file-name file)))
5541 ;; (error "No previous version found for %s" file))))
5543 ;;(or (assq 'vms ange-ftp-dired-backup-diff-alist)
5544 ;; (setq ange-ftp-dired-backup-diff-alist
5545 ;; (cons '(vms . ange-ftp-dired-vms-backup-diff)
5546 ;; ange-ftp-dired-backup-diff-alist)))
5549 ;;;; ------------------------------------------------------------
5551 ;;;; ------------------------------------------------------------
5554 ;; Convert NAME from UNIX-ish to MTS. If REVERSE given then convert from
5556 (defun ange-ftp-fix-name-for-mts (name &optional reverse)
5559 (if (string-match "\\`\\([^:]+:\\)?\\(.*\\)\\'" name)
5561 (setq acct (match-string 1 name))
5562 (setq file (match-string 2 name))
5563 (concat (and acct (concat "/" acct "/"))
5565 (error "name %s didn't match" name))
5566 (if (string-match "\\`/\\([^:]+:\\)/\\(.*\\)\\'" name)
5567 (concat (match-string 1 name) (match-string 2 name))
5568 ;; Let's hope that mts will recognize it anyway.
5571 (or (assq 'mts ange-ftp-fix-name-func-alist)
5572 (setq ange-ftp-fix-name-func-alist
5573 (cons '(mts . ange-ftp-fix-name-for-mts)
5574 ange-ftp-fix-name-func-alist)))
5576 ;; Convert name from UNIX-ish to MTS ready for a DIRectory listing.
5577 ;; Remember that there are no directories in MTS.
5578 (defun ange-ftp-fix-dir-name-for-mts (dir-name)
5579 (if (string-equal dir-name "/")
5580 (error "Cannot get listing for fictitious \"/\" directory")
5581 (let ((dir-name (ange-ftp-fix-name-for-mts dir-name)))
5583 ((string-equal dir-name "")
5585 ((string-match ":\\'" dir-name)
5586 (concat dir-name "?"))
5587 (dir-name))))) ; It's just a single file.
5589 (or (assq 'mts ange-ftp-fix-dir-name-func-alist)
5590 (setq ange-ftp-fix-dir-name-func-alist
5591 (cons '(mts . ange-ftp-fix-dir-name-for-mts)
5592 ange-ftp-fix-dir-name-func-alist)))
5594 (or (memq 'mts ange-ftp-dumb-host-types)
5595 (setq ange-ftp-dumb-host-types
5596 (cons 'mts ange-ftp-dumb-host-types)))
5598 (defvar ange-ftp-mts-host-regexp nil)
5600 ;; Return non-nil if HOST is running MTS.
5601 (defun ange-ftp-mts-host (host)
5602 (and ange-ftp-mts-host-regexp
5603 (string-match-p ange-ftp-mts-host-regexp host)))
5605 ;; Parse the current buffer which is assumed to be in mts ftp dir format.
5606 (defun ange-ftp-parse-mts-listing ()
5607 (let ((tbl (make-hash-table :test 'equal)))
5608 (goto-char (point-min))
5610 (while (re-search-forward directory-listing-before-filename-regexp nil t)
5612 (skip-chars-backward " ")
5613 (let ((end (point)))
5614 (skip-chars-backward "-A-Z0-9_.!")
5615 (puthash (buffer-substring (point) end) nil tbl))
5617 ;; Don't need to bother with ..
5621 (add-to-list 'ange-ftp-parse-list-func-alist
5622 '(mts . ange-ftp-parse-mts-listing))
5624 (defun ange-ftp-add-mts-host (host)
5625 "Mark HOST as the name of a machine running MTS."
5627 (list (read-string "Host: "
5628 (let ((name (or (buffer-file-name) default-directory)))
5629 (and name (car (ange-ftp-ftp-name name)))))))
5630 (if (not (ange-ftp-mts-host host))
5631 (setq ange-ftp-mts-host-regexp
5632 (concat "^" (regexp-quote host) "$"
5633 (and ange-ftp-mts-host-regexp "\\|")
5634 ange-ftp-mts-host-regexp)
5635 ange-ftp-host-cache nil)))
5637 ;;; Tree dired support:
5639 ;;;; There aren't too many systems left that use MTS. This dired support will
5640 ;;;; work for the implementation of ftp on mtsg.ubc.ca. I hope other mts systems
5641 ;;;; implement ftp in the same way. If not, it might be necessary to make the
5642 ;;;; following more flexible.
5644 ;;(defun ange-ftp-dired-mts-move-to-filename (&optional raise-error eol)
5645 ;; "In dired, move to first char of filename on this line.
5646 ;;Returns position (point) or nil if no filename on this line."
5647 ;; ;; This is the MTS version.
5648 ;; (or eol (setq eol (progn (end-of-line) (point))))
5649 ;; (beginning-of-line)
5650 ;; (if (re-search-forward
5651 ;; ange-ftp-date-regexp eol t)
5653 ;; (skip-chars-forward " ") ; Eat blanks after date
5654 ;; (skip-chars-forward "0-9:" eol) ; Eat time or year
5655 ;; (skip-chars-forward " " eol) ; one space before filename
5656 ;; ;; When listing an account other than the users own account it appends
5657 ;; ;; ACCT: to the beginning of the filename. Skip over this.
5658 ;; (and (looking-at "[A-Z0-9_.]+:")
5659 ;; (goto-char (match-end 0)))
5662 ;; (error "No file on this line")
5665 ;;(or (assq 'mts ange-ftp-dired-move-to-filename-alist)
5666 ;; (setq ange-ftp-dired-move-to-filename-alist
5667 ;; (cons '(mts . ange-ftp-dired-mts-move-to-filename)
5668 ;; ange-ftp-dired-move-to-filename-alist)))
5670 ;;(defun ange-ftp-dired-mts-move-to-end-of-filename (&optional no-error eol)
5671 ;; ;; Assumes point is at beginning of filename.
5672 ;; ;; So, it should be called only after (dired-move-to-filename t).
5673 ;; ;; On failure, signals an error or returns nil.
5674 ;; ;; This is the MTS version.
5675 ;; (let (opoint hidden case-fold-search)
5676 ;; (setq opoint (point)
5677 ;; eol (line-end-position)
5678 ;; hidden (and selective-display
5679 ;; (save-excursion (search-forward "\r" eol t))))
5682 ;; (skip-chars-forward "-A-Z0-9._!" eol))
5684 ;; (not (eq opoint (point)))
5687 ;; (substitute-command-keys
5688 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")
5689 ;; "No file on this line")))
5690 ;; (if (eq opoint (point))
5694 ;;(or (assq 'mts ange-ftp-dired-move-to-end-of-filename-alist)
5695 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5696 ;; (cons '(mts . ange-ftp-dired-mts-move-to-end-of-filename)
5697 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5699 ;;;; ------------------------------------------------------------
5701 ;;;; ------------------------------------------------------------
5703 ;; Since CMS doesn't have any full file name syntax, we have to fudge
5704 ;; things with cd's. We actually send too many cd's, but it's dangerous
5705 ;; to try to remember the current minidisk, because if the connection
5706 ;; is closed and needs to be reopened, we will find ourselves back in
5707 ;; the default minidisk. This is fairly likely since CMS ftp servers
5708 ;; usually close the connection after 5 minutes of inactivity.
5710 ;; Have I got the filename character set right?
5712 (defun ange-ftp-fix-name-for-cms (name &optional reverse)
5715 ;; Since we only convert output from a pwd in this direction,
5716 ;; we'll assume that it's a minidisk, and make it into a
5717 ;; directory file name. Note that the expand-dir-hashtable
5718 ;; stores directories without the trailing /. Is this
5721 (if (string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'"
5723 (let ((minidisk (match-string 1 name)))
5724 (if (match-beginning 2)
5725 (let ((file (match-string 2 name))
5726 (cmd (concat "cd " minidisk))
5728 ;; Note that host and user are bound in the call
5729 ;; to ange-ftp-send-cmd
5730 (proc (ange-ftp-get-process ange-ftp-this-host
5731 ange-ftp-this-user)))
5733 ;; Must use ange-ftp-raw-send-cmd here to avoid
5734 ;; an infinite loop.
5735 (if (car (ange-ftp-raw-send-cmd proc cmd ange-ftp-this-msg))
5737 ;; failed... try ONCE more.
5738 (setq proc (ange-ftp-get-process ange-ftp-this-host
5739 ange-ftp-this-user))
5740 (let ((result (ange-ftp-raw-send-cmd proc cmd
5741 ange-ftp-this-msg)))
5745 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5746 (format "cd to minidisk %s failed: %s"
5747 minidisk (cdr result)))))))
5748 ;; return the minidisk
5750 (error "Invalid CMS filename")))))
5752 (or (assq 'cms ange-ftp-fix-name-func-alist)
5753 (setq ange-ftp-fix-name-func-alist
5754 (cons '(cms . ange-ftp-fix-name-for-cms)
5755 ange-ftp-fix-name-func-alist)))
5757 (or (memq 'cms ange-ftp-dumb-host-types)
5758 (setq ange-ftp-dumb-host-types
5759 (cons 'cms ange-ftp-dumb-host-types)))
5761 ;; Convert name from UNIX-ish to CMS ready for a DIRectory listing.
5762 (defun ange-ftp-fix-dir-name-for-cms (dir-name)
5764 ((string-equal "/" dir-name)
5765 (error "Cannot get listing for fictitious \"/\" directory"))
5766 ((string-match "\\`/\\([-A-Z0-9$*._]+\\)/\\([-A-Z0-9$._]+\\)?\\'" dir-name)
5767 (let* ((minidisk (match-string 1 dir-name))
5768 ;; host and user are bound in the call to ange-ftp-send-cmd
5769 (proc (ange-ftp-get-process ange-ftp-this-host ange-ftp-this-user))
5770 (cmd (concat "cd " minidisk))
5771 (file (if (match-beginning 2)
5772 ;; it's a single file
5773 (match-string 2 dir-name)
5774 ;; use the wild-card
5776 (if (car (ange-ftp-raw-send-cmd proc cmd))
5779 (setq proc (ange-ftp-get-process ange-ftp-this-host
5780 ange-ftp-this-user))
5781 (let ((result (ange-ftp-raw-send-cmd proc cmd)))
5785 (ange-ftp-error ange-ftp-this-host ange-ftp-this-user
5786 (format "cd to minidisk %s failed: %s"
5787 minidisk (cdr result))))))))
5788 (t (error "Invalid CMS file name"))))
5790 (or (assq 'cms ange-ftp-fix-dir-name-func-alist)
5791 (setq ange-ftp-fix-dir-name-func-alist
5792 (cons '(cms . ange-ftp-fix-dir-name-for-cms)
5793 ange-ftp-fix-dir-name-func-alist)))
5795 (defvar ange-ftp-cms-host-regexp nil
5796 "Regular expression to match hosts running the CMS operating system.")
5798 ;; Return non-nil if HOST is running CMS.
5799 (defun ange-ftp-cms-host (host)
5800 (and ange-ftp-cms-host-regexp
5801 (string-match-p ange-ftp-cms-host-regexp host)))
5803 (defun ange-ftp-add-cms-host (host)
5804 "Mark HOST as the name of a CMS host."
5806 (list (read-string "Host: "
5807 (let ((name (or (buffer-file-name) default-directory)))
5808 (and name (car (ange-ftp-ftp-name name)))))))
5809 (if (not (ange-ftp-cms-host host))
5810 (setq ange-ftp-cms-host-regexp
5811 (concat "^" (regexp-quote host) "$"
5812 (and ange-ftp-cms-host-regexp "\\|")
5813 ange-ftp-cms-host-regexp)
5814 ange-ftp-host-cache nil)))
5816 (defun ange-ftp-parse-cms-listing ()
5817 ;; Parse the current buffer which is assumed to be a CMS directory listing.
5818 ;; If we succeed in getting a listing, then we will assume that the minidisk
5819 ;; exists. file is bound by the call to ange-ftp-ls. This doesn't work
5820 ;; because ange-ftp doesn't know that the root hashtable has only part of
5821 ;; the info. It will assume that if a minidisk isn't in it, then it doesn't
5822 ;; exist. It would be nice if completion worked for minidisks, as we
5824 ; (let* ((dir-file (directory-file-name file))
5825 ; (root (file-name-directory dir-file))
5826 ; (minidisk (ange-ftp-get-file-part dir-file))
5827 ; (root-tbl (ange-ftp-get-hash-entry root ange-ftp-files-hashtable)))
5829 ; (puthash minidisk t root-tbl)
5830 ; (setq root-tbl (ange-ftp-make-hashtable))
5831 ; (puthash minidisk t root-tbl)
5832 ; (puthash "." t root-tbl)
5833 ; (ange-ftp-set-files root root-tbl)))
5834 ;; Now do the usual parsing
5835 (let ((tbl (make-hash-table :test 'equal)))
5836 (goto-char (point-min))
5840 "^\\([-A-Z0-9$_]+\\) +\\([-A-Z0-9$_]+\\) +[VF] +[0-9]+ " nil t)
5841 (puthash (concat (match-string 1) "." (match-string 2)) nil tbl)
5843 (puthash "." t tbl))
5846 (add-to-list 'ange-ftp-parse-list-func-alist
5847 '(cms . ange-ftp-parse-cms-listing))
5849 ;;;;; Tree dired support:
5851 ;;(defconst ange-ftp-dired-cms-re-exe
5852 ;; "^. [-A-Z0-9$_]+ +EXEC "
5853 ;; "Regular expression to use to search for CMS executables.")
5855 ;;(or (assq 'cms ange-ftp-dired-re-exe-alist)
5856 ;; (setq ange-ftp-dired-re-exe-alist
5857 ;; (cons (cons 'cms ange-ftp-dired-cms-re-exe)
5858 ;; ange-ftp-dired-re-exe-alist)))
5861 ;;(defun ange-ftp-dired-cms-insert-headerline (dir)
5862 ;; ;; CMS has no total line, so we insert a blank line for
5865 ;; (forward-char -1)
5866 ;; (ange-ftp-real-dired-insert-headerline dir))
5868 ;;(or (assq 'cms ange-ftp-dired-insert-headerline-alist)
5869 ;; (setq ange-ftp-dired-insert-headerline-alist
5870 ;; (cons '(cms . ange-ftp-dired-cms-insert-headerline)
5871 ;; ange-ftp-dired-insert-headerline-alist)))
5873 ;;(defun ange-ftp-dired-cms-move-to-filename (&optional raise-error eol)
5874 ;; "In dired, move to the first char of filename on this line."
5875 ;; ;; This is the CMS version.
5876 ;; (or eol (setq eol (progn (end-of-line) (point))))
5877 ;; (let (case-fold-search)
5878 ;; (beginning-of-line)
5879 ;; (if (re-search-forward " [-A-Z0-9$_]+ +[-A-Z0-9$_]+ +[VF] +[0-9]+ " eol t)
5880 ;; (goto-char (1+ (match-beginning 0)))
5882 ;; (error "No file on this line")
5885 ;;(or (assq 'cms ange-ftp-dired-move-to-filename-alist)
5886 ;; (setq ange-ftp-dired-move-to-filename-alist
5887 ;; (cons '(cms . ange-ftp-dired-cms-move-to-filename)
5888 ;; ange-ftp-dired-move-to-filename-alist)))
5890 ;;(defun ange-ftp-dired-cms-move-to-end-of-filename (&optional no-error eol)
5891 ;; ;; Assumes point is at beginning of filename.
5892 ;; ;; So, it should be called only after (dired-move-to-filename t).
5893 ;; ;; case-fold-search must be nil, at least for VMS.
5894 ;; ;; On failure, signals an error or returns nil.
5895 ;; ;; This is the CMS version.
5896 ;; (let ((opoint (point))
5897 ;; case-fold-search hidden)
5898 ;; (or eol (setq eol (line-end-position)))
5899 ;; (setq hidden (and selective-display
5901 ;; (search-forward "\r" eol t))))
5906 ;; (substitute-command-keys
5907 ;; "File line is hidden, type \\[dired-hide-subdir] to unhide")))
5908 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5909 ;; (skip-chars-forward " " eol)
5910 ;; (skip-chars-forward "-A-Z0-9$_" eol)
5911 ;; (if (eq opoint (point))
5914 ;; (error "No file on this line"))
5917 ;;(or (assq 'cms ange-ftp-dired-move-to-end-of-filename-alist)
5918 ;; (setq ange-ftp-dired-move-to-end-of-filename-alist
5919 ;; (cons '(cms . ange-ftp-dired-cms-move-to-end-of-filename)
5920 ;; ange-ftp-dired-move-to-end-of-filename-alist)))
5922 (defun ange-ftp-cms-make-compressed-filename (name &optional reverse)
5923 (if (string-match "-Z\\'" name)
5924 (list nil (substring name 0 -2))
5925 (list t (concat name "-Z"))))
5927 (or (assq 'cms ange-ftp-make-compressed-filename-alist)
5928 (setq ange-ftp-make-compressed-filename-alist
5929 (cons '(cms . ange-ftp-cms-make-compressed-filename)
5930 ange-ftp-make-compressed-filename-alist)))
5932 ;;(defun ange-ftp-dired-cms-get-filename (&optional localp no-error-if-not-filep)
5933 ;; (let ((name (ange-ftp-real-dired-get-filename localp no-error-if-not-filep)))
5935 ;; (if (string-match "^\\([^ ]+\\) +\\([^ ]+\\)$" name)
5936 ;; (concat (substring name 0 (match-end 1))
5938 ;; (substring name (match-beginning 2) (match-end 2)))
5941 ;;(or (assq 'cms ange-ftp-dired-get-filename-alist)
5942 ;; (setq ange-ftp-dired-get-filename-alist
5943 ;; (cons '(cms . ange-ftp-dired-cms-get-filename)
5944 ;; ange-ftp-dired-get-filename-alist)))
5946 ;;;; ------------------------------------------------------------
5948 ;;;; ------------------------------------------------------------
5950 ;; There seems to be an error with regexps. '-' has to be the first
5951 ;; character inside of the square brackets.
5952 (defconst ange-ftp-bs2000-short-filename-regexp
5953 "[-A-Z0-9$#@.]*[A-Z][-A-Z0-9$#@.]*"
5954 "Regular expression to match for a valid short BS2000 file name.")
5956 (defconst ange-ftp-bs2000-fix-name-regexp-reverse
5958 "^\\(" ange-ftp-bs2000-filename-pubset-regexp "\\)?"
5959 "\\(" ange-ftp-bs2000-filename-username-regexp "\\)?"
5960 "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?")
5961 "Regular expression used in `ange-ftp-fix-name-for-bs2000'.")
5963 (defconst ange-ftp-bs2000-fix-name-regexp
5965 "/?\\(" ange-ftp-bs2000-filename-pubset-regexp "/\\)?"
5966 "\\(\\$[A-Z0-9]*/\\)?"
5967 "\\(" ange-ftp-bs2000-short-filename-regexp "\\)?")
5968 "Regular expression used in `ange-ftp-fix-name-for-bs2000'.")
5970 (defcustom ange-ftp-bs2000-special-prefix
5972 "Prefix used for filenames starting with '#' or '@'."
5976 ;; Convert NAME from UNIX-ish to BS2000. If REVERSE given then convert from
5977 ;; BS2000 to UNIX-ish.
5978 (defun ange-ftp-fix-name-for-bs2000 (name &optional reverse)
5982 ange-ftp-bs2000-fix-name-regexp-reverse
5984 (let ((pubset (if (match-beginning 1)
5985 (substring name 0 (match-end 1))))
5986 (userid (if (match-beginning 2)
5989 (1- (match-end 2)))))
5990 (filename (if (match-beginning 3)
5991 (substring name (match-beginning 3)))))
5994 ;; we have to insert "_/" here to prevent expand-file-name to
5995 ;; interpret BS2000 pubsets as the special escape prefix:
5996 (and pubset (concat "_/" pubset "/"))
5997 (and userid (concat userid "/"))
5999 (error "name %s didn't match" name))
6000 ;; and here we (maybe) have to remove the inserted "_/" 'cause
6001 ;; of our prevention of the special escape prefix above:
6002 (if (string-match (concat "^/_/") name)
6003 (setq name (substring name 2)))
6005 ange-ftp-bs2000-fix-name-regexp
6007 (let ((pubset (if (match-beginning 1)
6010 (1- (match-end 1)))))
6011 (userid (if (match-beginning 2)
6014 (1- (match-end 2)))))
6015 (filename (if (match-beginning 3)
6016 (substring name (match-beginning 3)))))
6017 (if (and (boundp 'filename)
6019 (string-match "[#@].+" filename))
6020 (setq filename (concat ange-ftp-bs2000-special-prefix
6021 (substring filename 1))))
6025 (and userid (concat userid "."))
6026 ;; change every '/' in filename to a '.', normally not necessary
6028 (subst-char-in-string ?/ ?. filename)))))
6029 ;; Let's hope that BS2000 recognize this anyway:
6032 (or (assq 'bs2000 ange-ftp-fix-name-func-alist)
6033 (setq ange-ftp-fix-name-func-alist
6034 (cons '(bs2000 . ange-ftp-fix-name-for-bs2000)
6035 ange-ftp-fix-name-func-alist)))
6037 ;; Convert name from UNIX-ish to BS2000 ready for a DIRectory listing.
6038 ;; Remember that there are no directories in BS2000.
6039 (defun ange-ftp-fix-dir-name-for-bs2000 (dir-name)
6040 (if (string-equal dir-name "/")
6041 "*" ;; Don't use an empty string here!
6042 (ange-ftp-fix-name-for-bs2000 dir-name)))
6044 (or (assq 'bs2000 ange-ftp-fix-dir-name-func-alist)
6045 (setq ange-ftp-fix-dir-name-func-alist
6046 (cons '(bs2000 . ange-ftp-fix-dir-name-for-bs2000)
6047 ange-ftp-fix-dir-name-func-alist)))
6049 (or (memq 'bs2000 ange-ftp-dumb-host-types)
6050 (setq ange-ftp-dumb-host-types
6051 (cons 'bs2000 ange-ftp-dumb-host-types)))
6053 (defvar ange-ftp-bs2000-host-regexp nil)
6054 (defvar ange-ftp-bs2000-posix-host-regexp nil)
6056 ;; Return non-nil if HOST is running BS2000.
6057 (defun ange-ftp-bs2000-host (host)
6058 (and ange-ftp-bs2000-host-regexp
6059 (string-match-p ange-ftp-bs2000-host-regexp host)))
6060 ;; Return non-nil if HOST is running BS2000 with POSIX subsystem.
6061 (defun ange-ftp-bs2000-posix-host (host)
6062 (and ange-ftp-bs2000-posix-host-regexp
6063 (string-match-p ange-ftp-bs2000-posix-host-regexp host)))
6065 (defun ange-ftp-add-bs2000-host (host)
6066 "Mark HOST as the name of a machine running BS2000."
6068 (list (read-string "Host: "
6069 (let ((name (or (buffer-file-name) default-directory)))
6070 (and name (car (ange-ftp-ftp-name name)))))))
6071 (if (not (ange-ftp-bs2000-host host))
6072 (setq ange-ftp-bs2000-host-regexp
6073 (concat "^" (regexp-quote host) "$"
6074 (and ange-ftp-bs2000-host-regexp "\\|")
6075 ange-ftp-bs2000-host-regexp)
6076 ange-ftp-host-cache nil)))
6078 (defun ange-ftp-add-bs2000-posix-host (host)
6079 "Mark HOST as the name of a machine running BS2000 with POSIX subsystem."
6081 (list (read-string "Host: "
6082 (let ((name (or (buffer-file-name) default-directory)))
6083 (and name (car (ange-ftp-ftp-name name)))))))
6084 (if (not (ange-ftp-bs2000-posix-host host))
6085 (setq ange-ftp-bs2000-posix-host-regexp
6086 (concat "^" (regexp-quote host) "$"
6087 (and ange-ftp-bs2000-posix-host-regexp "\\|")
6088 ange-ftp-bs2000-posix-host-regexp)
6089 ange-ftp-host-cache nil))
6090 ;; Install CD hook to cd to posix on connecting:
6091 (add-hook 'ange-ftp-process-startup-hook 'ange-ftp-bs2000-cd-to-posix)
6094 (defconst ange-ftp-bs2000-filename-regexp
6096 "\\(" ange-ftp-bs2000-filename-prefix-regexp "\\)?"
6097 "\\(" ange-ftp-bs2000-short-filename-regexp "\\)")
6098 "Regular expression to match for a valid BS2000 file name.")
6100 (defcustom ange-ftp-bs2000-additional-pubsets
6102 "List of additional pubsets available to all users."
6104 :type '(repeat string))
6106 ;; These parsing functions are as general as possible because the syntax
6107 ;; of ftp listings from BS2000 hosts is a bit erratic. What saves us is that
6108 ;; the BS2000 filename syntax is so rigid.
6110 ;; Extract the next filename from a BS2000 dired-like listing.
6111 (defun ange-ftp-parse-bs2000-filename ()
6112 (if (re-search-forward ange-ftp-bs2000-filename-regexp nil t)
6115 ;; Parse the current buffer which is assumed to be in (some) BS2000 FTP dir
6116 ;; format, and return a hashtable as the result.
6117 (defun ange-ftp-parse-bs2000-listing ()
6118 (let ((tbl (make-hash-table :test 'equal))
6121 ;; get current pubset
6122 (goto-char (point-min))
6123 (if (re-search-forward ange-ftp-bs2000-filename-pubset-regexp nil t)
6124 (setq pubset (match-string 0)))
6125 ;; add files to hashtable
6126 (goto-char (point-min))
6128 (while (setq file (ange-ftp-parse-bs2000-filename))
6129 (puthash file nil tbl)))
6132 (puthash ".." t tbl)
6133 ;; add all additional pubsets, if not listing one of them
6134 (if (not (member pubset ange-ftp-bs2000-additional-pubsets))
6135 (mapc (lambda (pubset) (puthash pubset t tbl))
6136 ange-ftp-bs2000-additional-pubsets))
6139 (add-to-list 'ange-ftp-parse-list-func-alist
6140 '(bs2000 . ange-ftp-parse-bs2000-listing))
6142 (defun ange-ftp-bs2000-cd-to-posix ()
6143 "cd to POSIX subsystem if the current host matches
6144 `ange-ftp-bs2000-posix-host-regexp'. All BS2000 hosts with POSIX subsystem
6145 MUST BE EXPLICITLY SET with `ange-ftp-add-bs2000-posix-host' for they cannot
6146 be recognized automatically (they are all valid BS2000 hosts too)."
6147 (if (and ange-ftp-this-host (ange-ftp-bs2000-posix-host ange-ftp-this-host))
6150 ; (ange-ftp-raw-send-cmd proc "cd %POSIX")
6151 (ange-ftp-cd ange-ftp-this-host ange-ftp-this-user "%POSIX")
6152 ;; put new home directory in the expand-dir hashtable.
6153 ;; `ange-ftp-this-host' and `ange-ftp-this-user' are bound in
6154 ;; ange-ftp-get-process.
6155 (puthash (concat ange-ftp-this-host "/" ange-ftp-this-user "/~")
6156 (car (ange-ftp-get-pwd ange-ftp-this-host ange-ftp-this-user))
6157 ange-ftp-expand-dir-hashtable))))
6159 ;; Not available yet:
6160 ;; ange-ftp-bs2000-delete-file-entry
6161 ;; ange-ftp-bs2000-add-file-entry
6162 ;; ange-ftp-bs2000-file-name-as-directory
6163 ;; ange-ftp-bs2000-make-compressed-filename
6164 ;; ange-ftp-bs2000-file-name-sans-versions
6166 ;;;; ------------------------------------------------------------
6167 ;;;; Finally provide package.
6168 ;;;; ------------------------------------------------------------
6172 ;;; ange-ftp.el ends here