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