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