Update years in copyright notice; nfc.
[bpt/emacs.git] / lisp / arc-mode.el
1 ;;; arc-mode.el --- simple editing of archives
2
3 ;; Copyright (C) 1995, 1997, 1998, 2002, 2003, 2004,
4 ;; 2005, 2006 Free Software Foundation, Inc.
5
6 ;; Author: Morten Welinder <terra@gnu.org>
7 ;; Keywords: archives msdog editing major-mode
8 ;; Favourite-brand-of-beer: None, I hate beer.
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26
27 ;;; Commentary:
28
29 ;; NAMING: "arc" is short for "archive" and does not refer specifically
30 ;; to files whose name end in ".arc"
31 ;;
32 ;; This code does not decode any files internally, although it does
33 ;; understand the directory level of the archives. For this reason,
34 ;; you should expect this code to need more fiddling than tar-mode.el
35 ;; (although it at present has fewer bugs :-) In particular, I have
36 ;; not tested this under Ms-Dog myself.
37 ;; -------------------------------------
38 ;; INTERACTION: arc-mode.el should play together with
39 ;;
40 ;; * ange-ftp.el: Remote archives (i.e., ones that ange-ftp has brought
41 ;; to you) are handled by doing all updates on a local
42 ;; copy. When you make changes to a remote file the
43 ;; changes will first take effect when the archive buffer
44 ;; is saved. You will be warned about this.
45 ;;
46 ;; * dos-fns.el: (Part of Emacs 19). You get automatic ^M^J <--> ^J
47 ;; conversion.
48 ;;
49 ;; arc-mode.el does not work well with crypt++.el; for the archives as
50 ;; such this could be fixed (but wouldn't be useful) by declaring such
51 ;; archives to be "remote". For the members this is a general Emacs
52 ;; problem that 19.29's file formats may fix.
53 ;; -------------------------------------
54 ;; ARCHIVE TYPES: Currently only the archives below are handled, but the
55 ;; structure for handling just about anything is in place.
56 ;;
57 ;; Arc Lzh Zip Zoo
58 ;; --------------------------------
59 ;; View listing Intern Intern Intern Intern
60 ;; Extract member Y Y Y Y
61 ;; Save changed member Y Y Y Y
62 ;; Add new member N N N N
63 ;; Delete member Y Y Y Y
64 ;; Rename member Y Y N N
65 ;; Chmod - Y Y -
66 ;; Chown - Y - -
67 ;; Chgrp - Y - -
68 ;;
69 ;; Special thanks to Bill Brodie <wbrodie@panix.com> for very useful tips
70 ;; on the first released version of this package.
71 ;;
72 ;; This code is partly based on tar-mode.el from Emacs.
73 ;; -------------------------------------
74 ;; ARCHIVE STRUCTURES:
75 ;; (This is mostly for myself.)
76 ;;
77 ;; ARC A series of (header,file). No interactions among members.
78 ;;
79 ;; LZH A series of (header,file). Headers are checksummed. No
80 ;; interaction among members.
81 ;; Headers come in three flavours called level 0, 1 and 2 headers.
82 ;; Level 2 header is free of DOS specific restrictions and most
83 ;; prevalently used. Also level 1 and 2 headers consist of base
84 ;; and extension headers. For more details see
85 ;; http://homepage1.nifty.com/dangan/en/Content/Program/Java/jLHA/Notes/Notes.html
86 ;; http://www.osirusoft.com/joejared/lzhformat.html
87 ;;
88 ;; ZIP A series of (lheader,fil) followed by a "central directory"
89 ;; which is a series of (cheader) followed by an end-of-
90 ;; central-dir record possibly followed by junk. The e-o-c-d
91 ;; links to c-d. cheaders link to lheaders which are basically
92 ;; cut-down versions of the cheaders.
93 ;;
94 ;; ZOO An archive header followed by a series of (header,file).
95 ;; Each member header points to the next. The archive is
96 ;; terminated by a bogus header with a zero next link.
97 ;; -------------------------------------
98 ;; HOOKS: `foo' means one of the supported archive types.
99 ;;
100 ;; archive-mode-hook
101 ;; archive-foo-mode-hook
102 ;; archive-extract-hooks
103
104 ;;; Code:
105
106 ;; -------------------------------------------------------------------------
107 ;; Section: Configuration.
108
109 (defgroup archive nil
110 "Simple editing of archives."
111 :group 'data)
112
113 (defgroup archive-arc nil
114 "ARC-specific options to archive."
115 :group 'archive)
116
117 (defgroup archive-lzh nil
118 "LZH-specific options to archive."
119 :group 'archive)
120
121 (defgroup archive-zip nil
122 "ZIP-specific options to archive."
123 :group 'archive)
124
125 (defgroup archive-zoo nil
126 "ZOO-specific options to archive."
127 :group 'archive)
128
129 (defcustom archive-tmpdir
130 ;; make-temp-name is safe here because we use this name
131 ;; to create a directory.
132 (make-temp-name
133 (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp")
134 temporary-file-directory))
135 "Directory for temporary files made by `arc-mode.el'."
136 :type 'directory
137 :group 'archive)
138
139 (defcustom archive-remote-regexp "^/[^/:]*[^/:.]:"
140 "*Regexp recognizing archive files names that are not local.
141 A non-local file is one whose file name is not proper outside Emacs.
142 A local copy of the archive will be used when updating."
143 :type 'regexp
144 :group 'archive)
145
146 (defcustom archive-extract-hooks nil
147 "*Hooks to run when an archive member has been extracted."
148 :type 'hook
149 :group 'archive)
150 ;; ------------------------------
151 ;; Arc archive configuration
152
153 ;; We always go via a local file since there seems to be no reliable way
154 ;; to extract to stdout without junk getting added.
155 (defcustom archive-arc-extract
156 '("arc" "x")
157 "*Program and its options to run in order to extract an arc file member.
158 Extraction should happen to the current directory. Archive and member
159 name will be added."
160 :type '(list (string :tag "Program")
161 (repeat :tag "Options"
162 :inline t
163 (string :format "%v")))
164 :group 'archive-arc)
165
166 (defcustom archive-arc-expunge
167 '("arc" "d")
168 "*Program and its options to run in order to delete arc file members.
169 Archive and member names will be added."
170 :type '(list (string :tag "Program")
171 (repeat :tag "Options"
172 :inline t
173 (string :format "%v")))
174 :group 'archive-arc)
175
176 (defcustom archive-arc-write-file-member
177 '("arc" "u")
178 "*Program and its options to run in order to update an arc file member.
179 Archive and member name will be added."
180 :type '(list (string :tag "Program")
181 (repeat :tag "Options"
182 :inline t
183 (string :format "%v")))
184 :group 'archive-arc)
185 ;; ------------------------------
186 ;; Lzh archive configuration
187
188 (defcustom archive-lzh-extract
189 '("lha" "pq")
190 "*Program and its options to run in order to extract an lzh file member.
191 Extraction should happen to standard output. Archive and member name will
192 be added."
193 :type '(list (string :tag "Program")
194 (repeat :tag "Options"
195 :inline t
196 (string :format "%v")))
197 :group 'archive-lzh)
198
199 (defcustom archive-lzh-expunge
200 '("lha" "d")
201 "*Program and its options to run in order to delete lzh file members.
202 Archive and member names will be added."
203 :type '(list (string :tag "Program")
204 (repeat :tag "Options"
205 :inline t
206 (string :format "%v")))
207 :group 'archive-lzh)
208
209 (defcustom archive-lzh-write-file-member
210 '("lha" "a")
211 "*Program and its options to run in order to update an lzh file member.
212 Archive and member name will be added."
213 :type '(list (string :tag "Program")
214 (repeat :tag "Options"
215 :inline t
216 (string :format "%v")))
217 :group 'archive-lzh)
218 ;; ------------------------------
219 ;; Zip archive configuration
220
221 (defcustom archive-zip-extract
222 (if (and (not (executable-find "unzip"))
223 (executable-find "pkunzip"))
224 '("pkunzip" "-e" "-o-")
225 '("unzip" "-qq" "-c"))
226 "*Program and its options to run in order to extract a zip file member.
227 Extraction should happen to standard output. Archive and member name will
228 be added."
229 :type '(list (string :tag "Program")
230 (repeat :tag "Options"
231 :inline t
232 (string :format "%v")))
233 :group 'archive-zip)
234
235 ;; For several reasons the latter behaviour is not desirable in general.
236 ;; (1) It uses more disk space. (2) Error checking is worse or non-
237 ;; existent. (3) It tends to do funny things with other systems' file
238 ;; names.
239
240 (defcustom archive-zip-expunge
241 (if (and (not (executable-find "zip"))
242 (executable-find "pkzip"))
243 '("pkzip" "-d")
244 '("zip" "-d" "-q"))
245 "*Program and its options to run in order to delete zip file members.
246 Archive and member names will be added."
247 :type '(list (string :tag "Program")
248 (repeat :tag "Options"
249 :inline t
250 (string :format "%v")))
251 :group 'archive-zip)
252
253 (defcustom archive-zip-update
254 (if (and (not (executable-find "zip"))
255 (executable-find "pkzip"))
256 '("pkzip" "-u" "-P")
257 '("zip" "-q"))
258 "*Program and its options to run in order to update a zip file member.
259 Options should ensure that specified directory will be put into the zip
260 file. Archive and member name will be added."
261 :type '(list (string :tag "Program")
262 (repeat :tag "Options"
263 :inline t
264 (string :format "%v")))
265 :group 'archive-zip)
266
267 (defcustom archive-zip-update-case
268 (if (and (not (executable-find "zip"))
269 (executable-find "pkzip"))
270 '("pkzip" "-u" "-P")
271 '("zip" "-q" "-k"))
272 "*Program and its options to run in order to update a case fiddled zip member.
273 Options should ensure that specified directory will be put into the zip file.
274 Archive and member name will be added."
275 :type '(list (string :tag "Program")
276 (repeat :tag "Options"
277 :inline t
278 (string :format "%v")))
279 :group 'archive-zip)
280
281 (defcustom archive-zip-case-fiddle t
282 "*If non-nil then zip file members may be down-cased.
283 This case fiddling will only happen for members created by a system
284 that uses caseless file names."
285 :type 'boolean
286 :group 'archive-zip)
287 ;; ------------------------------
288 ;; Zoo archive configuration
289
290 (defcustom archive-zoo-extract
291 '("zoo" "xpq")
292 "*Program and its options to run in order to extract a zoo file member.
293 Extraction should happen to standard output. Archive and member name will
294 be added."
295 :type '(list (string :tag "Program")
296 (repeat :tag "Options"
297 :inline t
298 (string :format "%v")))
299 :group 'archive-zoo)
300
301 (defcustom archive-zoo-expunge
302 '("zoo" "DqPP")
303 "*Program and its options to run in order to delete zoo file members.
304 Archive and member names will be added."
305 :type '(list (string :tag "Program")
306 (repeat :tag "Options"
307 :inline t
308 (string :format "%v")))
309 :group 'archive-zoo)
310
311 (defcustom archive-zoo-write-file-member
312 '("zoo" "a")
313 "*Program and its options to run in order to update a zoo file member.
314 Archive and member name will be added."
315 :type '(list (string :tag "Program")
316 (repeat :tag "Options"
317 :inline t
318 (string :format "%v")))
319 :group 'archive-zoo)
320 ;; -------------------------------------------------------------------------
321 ;; Section: Variables
322
323 (defvar archive-subtype nil "Symbol describing archive type.")
324 (defvar archive-file-list-start nil "Position of first contents line.")
325 (defvar archive-file-list-end nil "Position just after last contents line.")
326 (defvar archive-proper-file-start nil "Position of real archive's start.")
327 (defvar archive-read-only nil "Non-nil if the archive is read-only on disk.")
328 (defvar archive-local-name nil "Name of local copy of remote archive.")
329 (defvar archive-mode-map
330 (let ((map (make-keymap)))
331 (suppress-keymap map)
332 (define-key map " " 'archive-next-line)
333 (define-key map "a" 'archive-alternate-display)
334 ;;(define-key map "c" 'archive-copy)
335 (define-key map "d" 'archive-flag-deleted)
336 (define-key map "\C-d" 'archive-flag-deleted)
337 (define-key map "e" 'archive-extract)
338 (define-key map "f" 'archive-extract)
339 (define-key map "\C-m" 'archive-extract)
340 (define-key map "g" 'revert-buffer)
341 (define-key map "h" 'describe-mode)
342 (define-key map "m" 'archive-mark)
343 (define-key map "n" 'archive-next-line)
344 (define-key map "\C-n" 'archive-next-line)
345 (define-key map [down] 'archive-next-line)
346 (define-key map "o" 'archive-extract-other-window)
347 (define-key map "p" 'archive-previous-line)
348 (define-key map "q" 'quit-window)
349 (define-key map "\C-p" 'archive-previous-line)
350 (define-key map [up] 'archive-previous-line)
351 (define-key map "r" 'archive-rename-entry)
352 (define-key map "u" 'archive-unflag)
353 (define-key map "\M-\C-?" 'archive-unmark-all-files)
354 (define-key map "v" 'archive-view)
355 (define-key map "x" 'archive-expunge)
356 (define-key map "\177" 'archive-unflag-backwards)
357 (define-key map "E" 'archive-extract-other-window)
358 (define-key map "M" 'archive-chmod-entry)
359 (define-key map "G" 'archive-chgrp-entry)
360 (define-key map "O" 'archive-chown-entry)
361
362 (if (fboundp 'command-remapping)
363 (progn
364 (define-key map [remap advertised-undo] 'archive-undo)
365 (define-key map [remap undo] 'archive-undo))
366 (substitute-key-definition 'advertised-undo 'archive-undo map global-map)
367 (substitute-key-definition 'undo 'archive-undo map global-map))
368
369 (define-key map
370 (if (featurep 'xemacs) 'button2 [mouse-2]) 'archive-extract)
371
372 (if (featurep 'xemacs)
373 () ; out of luck
374
375 (define-key map [menu-bar immediate]
376 (cons "Immediate" (make-sparse-keymap "Immediate")))
377 (define-key map [menu-bar immediate alternate]
378 '(menu-item "Alternate Display" archive-alternate-display
379 :enable (boundp (archive-name "alternate-display"))
380 :help "Toggle alternate file info display"))
381 (define-key map [menu-bar immediate view]
382 '(menu-item "View This File" archive-view
383 :help "Display file at cursor in View Mode"))
384 (define-key map [menu-bar immediate display]
385 '(menu-item "Display in Other Window" archive-display-other-window
386 :help "Display file at cursor in another window"))
387 (define-key map [menu-bar immediate find-file-other-window]
388 '(menu-item "Find in Other Window" archive-extract-other-window
389 :help "Edit file at cursor in another window"))
390 (define-key map [menu-bar immediate find-file]
391 '(menu-item "Find This File" archive-extract
392 :help "Extract file at cursor and edit it"))
393
394 (define-key map [menu-bar mark]
395 (cons "Mark" (make-sparse-keymap "Mark")))
396 (define-key map [menu-bar mark unmark-all]
397 '(menu-item "Unmark All" archive-unmark-all-files
398 :help "Unmark all marked files"))
399 (define-key map [menu-bar mark deletion]
400 '(menu-item "Flag" archive-flag-deleted
401 :help "Flag file at cursor for deletion"))
402 (define-key map [menu-bar mark unmark]
403 '(menu-item "Unflag" archive-unflag
404 :help "Unmark file at cursor"))
405 (define-key map [menu-bar mark mark]
406 '(menu-item "Mark" archive-mark
407 :help "Mark file at cursor"))
408
409 (define-key map [menu-bar operate]
410 (cons "Operate" (make-sparse-keymap "Operate")))
411 (define-key map [menu-bar operate chown]
412 '(menu-item "Change Owner..." archive-chown-entry
413 :enable (fboundp (archive-name "chown-entry"))
414 :help "Change owner of marked files"))
415 (define-key map [menu-bar operate chgrp]
416 '(menu-item "Change Group..." archive-chgrp-entry
417 :enable (fboundp (archive-name "chgrp-entry"))
418 :help "Change group ownership of marked files"))
419 (define-key map [menu-bar operate chmod]
420 '(menu-item "Change Mode..." archive-chmod-entry
421 :enable (fboundp (archive-name "chmod-entry"))
422 :help "Change mode (permissions) of marked files"))
423 (define-key map [menu-bar operate rename]
424 '(menu-item "Rename to..." archive-rename-entry
425 :enable (fboundp (archive-name "rename-entry"))
426 :help "Rename marked files"))
427 ;;(define-key map [menu-bar operate copy]
428 ;; '(menu-item "Copy to..." archive-copy))
429 (define-key map [menu-bar operate expunge]
430 '(menu-item "Expunge Marked Files" archive-expunge
431 :help "Delete all flagged files from archive"))
432 map))
433 "Local keymap for archive mode listings.")
434 (defvar archive-file-name-indent nil "Column where file names start.")
435
436 (defvar archive-remote nil "Non-nil if the archive is outside file system.")
437 (make-variable-buffer-local 'archive-remote)
438 (put 'archive-remote 'permanent-local t)
439
440 (defvar archive-member-coding-system nil "Coding-system of archive member.")
441 (make-variable-buffer-local 'archive-member-coding-system)
442
443 (defvar archive-alternate-display nil
444 "Non-nil when alternate information is shown.")
445 (make-variable-buffer-local 'archive-alternate-display)
446 (put 'archive-alternate-display 'permanent-local t)
447
448 (defvar archive-superior-buffer nil "In archive members, points to archive.")
449 (put 'archive-superior-buffer 'permanent-local t)
450
451 (defvar archive-subfile-mode nil "Non-nil in archive member buffers.")
452 (make-variable-buffer-local 'archive-subfile-mode)
453 (put 'archive-subfile-mode 'permanent-local t)
454
455 (defvar archive-files nil
456 "Vector of file descriptors.
457 Each descriptor is a vector of the form
458 [EXT-FILE-NAME INT-FILE-NAME CASE-FIDDLED MODE ...]")
459 (make-variable-buffer-local 'archive-files)
460
461 ;; -------------------------------------------------------------------------
462 ;; Section: Support functions.
463
464 (defsubst archive-name (suffix)
465 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))
466
467 (defun archive-l-e (str &optional len)
468 "Convert little endian string/vector STR to integer.
469 Alternatively, STR may be a buffer position in the current buffer
470 in which case a second argument, length LEN, should be supplied."
471 (if (stringp str)
472 (setq len (length str))
473 (setq str (buffer-substring str (+ str len))))
474 (let ((result 0)
475 (i 0))
476 (while (< i len)
477 (setq i (1+ i)
478 result (+ (ash result 8) (aref str (- len i)))))
479 result))
480
481 (defun archive-int-to-mode (mode)
482 "Turn an integer like 0700 (i.e., 448) into a mode string like -rwx------."
483 ;; FIXME: merge with tar-grind-file-mode.
484 (string
485 (if (zerop (logand 8192 mode))
486 (if (zerop (logand 16384 mode)) ?- ?d)
487 ?c) ; completeness
488 (if (zerop (logand 256 mode)) ?- ?r)
489 (if (zerop (logand 128 mode)) ?- ?w)
490 (if (zerop (logand 64 mode))
491 (if (zerop (logand 1024 mode)) ?- ?S)
492 (if (zerop (logand 1024 mode)) ?x ?s))
493 (if (zerop (logand 32 mode)) ?- ?r)
494 (if (zerop (logand 16 mode)) ?- ?w)
495 (if (zerop (logand 8 mode))
496 (if (zerop (logand 2048 mode)) ?- ?S)
497 (if (zerop (logand 2048 mode)) ?x ?s))
498 (if (zerop (logand 4 mode)) ?- ?r)
499 (if (zerop (logand 2 mode)) ?- ?w)
500 (if (zerop (logand 1 mode)) ?- ?x)))
501
502 (defun archive-calc-mode (oldmode newmode &optional error)
503 "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
504 NEWMODE may be an octal number including a leading zero in which case it
505 will become the new mode.\n
506 NEWMODE may also be a relative specification like \"og-rwx\" in which case
507 OLDMODE will be modified accordingly just like chmod(2) would have done.\n
508 If optional third argument ERROR is non-nil an error will be signaled if
509 the mode is invalid. If ERROR is nil then nil will be returned."
510 (cond ((string-match "^0[0-7]*$" newmode)
511 (let ((result 0)
512 (len (length newmode))
513 (i 1))
514 (while (< i len)
515 (setq result (+ (lsh result 3) (aref newmode i) (- ?0))
516 i (1+ i)))
517 (logior (logand oldmode 65024) result)))
518 ((string-match "^\\([agou]+\\)\\([---+=]\\)\\([rwxst]+\\)$" newmode)
519 (let ((who 0)
520 (result oldmode)
521 (op (aref newmode (match-beginning 2)))
522 (bits 0)
523 (i (match-beginning 3)))
524 (while (< i (match-end 3))
525 (let ((rwx (aref newmode i)))
526 (setq bits (logior bits (cond ((= rwx ?r) 292)
527 ((= rwx ?w) 146)
528 ((= rwx ?x) 73)
529 ((= rwx ?s) 3072)
530 ((= rwx ?t) 512)))
531 i (1+ i))))
532 (while (< who (match-end 1))
533 (let* ((whoc (aref newmode who))
534 (whomask (cond ((= whoc ?a) 4095)
535 ((= whoc ?u) 1472)
536 ((= whoc ?g) 2104)
537 ((= whoc ?o) 7))))
538 (if (= op ?=)
539 (setq result (logand result (lognot whomask))))
540 (if (= op ?-)
541 (setq result (logand result (lognot (logand whomask bits))))
542 (setq result (logior result (logand whomask bits)))))
543 (setq who (1+ who)))
544 result))
545 (t
546 (if error
547 (error "Invalid mode specification: %s" newmode)))))
548
549 (defun archive-dosdate (date)
550 "Stringify dos packed DATE record."
551 (let ((year (+ 1980 (logand (ash date -9) 127)))
552 (month (logand (ash date -5) 15))
553 (day (logand date 31)))
554 (if (or (> month 12) (< month 1))
555 ""
556 (format "%2d-%s-%d"
557 day
558 (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
559 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
560 year))))
561
562 (defun archive-dostime (time)
563 "Stringify dos packed TIME record."
564 (let ((hour (logand (ash time -11) 31))
565 (minute (logand (ash time -5) 63))
566 (second (* 2 (logand time 31)))) ; 2 seconds resolution
567 (format "%02d:%02d:%02d" hour minute second)))
568
569 (defun archive-unixdate (low high)
570 "Stringify Unix (LOW HIGH) date."
571 (let ((str (current-time-string (cons high low))))
572 (format "%s-%s-%s"
573 (substring str 8 10)
574 (substring str 4 7)
575 (substring str 20 24))))
576
577 (defun archive-unixtime (low high)
578 "Stringify Unix (LOW HIGH) time."
579 (let ((str (current-time-string (cons high low))))
580 (substring str 11 19)))
581
582 (defun archive-get-lineno ()
583 (if (>= (point) archive-file-list-start)
584 (count-lines archive-file-list-start
585 (save-excursion (beginning-of-line) (point)))
586 0))
587
588 (defun archive-get-descr (&optional noerror)
589 "Return the descriptor vector for file at point.
590 Does not signal an error if optional argument NOERROR is non-nil."
591 (let ((no (archive-get-lineno)))
592 (if (and (>= (point) archive-file-list-start)
593 (< no (length archive-files)))
594 (let ((item (aref archive-files no)))
595 (if (vectorp item)
596 item
597 (if (not noerror)
598 (error "Entry is not a regular member of the archive"))))
599 (if (not noerror)
600 (error "Line does not describe a member of the archive")))))
601 ;; -------------------------------------------------------------------------
602 ;; Section: the mode definition
603
604 ;;;###autoload
605 (defun archive-mode (&optional force)
606 "Major mode for viewing an archive file in a dired-like way.
607 You can move around using the usual cursor motion commands.
608 Letters no longer insert themselves.
609 Type `e' to pull a file out of the archive and into its own buffer;
610 or click mouse-2 on the file's line in the archive mode buffer.
611
612 If you edit a sub-file of this archive (as with the `e' command) and
613 save it, the contents of that buffer will be saved back into the
614 archive.
615
616 \\{archive-mode-map}"
617 ;; This is not interactive because you shouldn't be turning this
618 ;; mode on and off. You can corrupt things that way.
619 (if (zerop (buffer-size))
620 ;; At present we cannot create archives from scratch
621 (funcall default-major-mode)
622 (if (and (not force) archive-files) nil
623 (let* ((type (archive-find-type))
624 (typename (capitalize (symbol-name type))))
625 (kill-all-local-variables)
626 (make-local-variable 'archive-subtype)
627 (setq archive-subtype type)
628
629 ;; Buffer contains treated image of file before the file contents
630 (make-local-variable 'revert-buffer-function)
631 (setq revert-buffer-function 'archive-mode-revert)
632 (auto-save-mode 0)
633
634 ;; Remote archives are not written by a hook.
635 (if archive-remote nil
636 (add-hook 'write-contents-functions 'archive-write-file nil t))
637
638 (make-local-variable 'require-final-newline)
639 (setq require-final-newline nil)
640 (make-local-variable 'local-enable-local-variables)
641 (setq local-enable-local-variables nil)
642
643 ;; Prevent loss of data when saving the file.
644 (make-local-variable 'file-precious-flag)
645 (setq file-precious-flag t)
646
647 (make-local-variable 'archive-read-only)
648 ;; Archives which are inside other archives and whose
649 ;; names are invalid for this OS, can't be written.
650 (setq archive-read-only
651 (or (not (file-writable-p (buffer-file-name)))
652 (and archive-subfile-mode
653 (string-match file-name-invalid-regexp
654 (aref archive-subfile-mode 0)))))
655
656 ;; Should we use a local copy when accessing from outside Emacs?
657 (make-local-variable 'archive-local-name)
658
659 ;; An archive can contain another archive whose name is invalid
660 ;; on local filesystem. Treat such archives as remote.
661 (or archive-remote
662 (setq archive-remote
663 (or (string-match archive-remote-regexp (buffer-file-name))
664 (string-match file-name-invalid-regexp
665 (buffer-file-name)))))
666
667 (setq major-mode 'archive-mode)
668 (setq mode-name (concat typename "-Archive"))
669 ;; Run archive-foo-mode-hook and archive-mode-hook
670 (run-mode-hooks (archive-name "mode-hook") 'archive-mode-hook)
671 (use-local-map archive-mode-map))
672
673 (make-local-variable 'archive-proper-file-start)
674 (make-local-variable 'archive-file-list-start)
675 (make-local-variable 'archive-file-list-end)
676 (make-local-variable 'archive-file-name-indent)
677 (archive-summarize nil)
678 (setq buffer-read-only t))))
679
680 ;; Archive mode is suitable only for specially formatted data.
681 (put 'archive-mode 'mode-class 'special)
682
683 (let ((item1 '(archive-subfile-mode " Archive")))
684 (or (member item1 minor-mode-alist)
685 (setq minor-mode-alist (cons item1 minor-mode-alist))))
686 ;; -------------------------------------------------------------------------
687 (defun archive-find-type ()
688 (widen)
689 (goto-char (point-min))
690 ;; The funny [] here make it unlikely that the .elc file will be treated
691 ;; as an archive by other software.
692 (let (case-fold-search)
693 (cond ((looking-at "[P]K\003\004") 'zip)
694 ((looking-at "..-l[hz][0-9ds]-") 'lzh)
695 ((looking-at "....................[\334]\247\304\375") 'zoo)
696 ((and (looking-at "\C-z") ; signature too simple, IMHO
697 (string-match "\\.[aA][rR][cC]$"
698 (or buffer-file-name (buffer-name))))
699 'arc)
700 (t (error "Buffer format not recognized")))))
701 ;; -------------------------------------------------------------------------
702 (defun archive-summarize (&optional shut-up)
703 "Parse the contents of the archive file in the current buffer.
704 Place a dired-like listing on the front;
705 then narrow to it, so that only that listing
706 is visible (and the real data of the buffer is hidden).
707 Optional argument SHUT-UP, if non-nil, means don't print messages
708 when parsing the archive."
709 (widen)
710 (set-buffer-multibyte nil)
711 (let ((inhibit-read-only t))
712 (or shut-up
713 (message "Parsing archive file..."))
714 (buffer-disable-undo (current-buffer))
715 (setq archive-files (funcall (archive-name "summarize")))
716 (or shut-up
717 (message "Parsing archive file...done."))
718 (setq archive-proper-file-start (point-marker))
719 (narrow-to-region (point-min) (point))
720 (set-buffer-modified-p nil)
721 (buffer-enable-undo))
722 (goto-char archive-file-list-start)
723 (archive-next-line 0))
724
725 (defun archive-resummarize ()
726 "Recreate the contents listing of an archive."
727 (let ((modified (buffer-modified-p))
728 (no (archive-get-lineno))
729 (inhibit-read-only t))
730 (widen)
731 (delete-region (point-min) archive-proper-file-start)
732 (archive-summarize t)
733 (restore-buffer-modified-p modified)
734 (goto-char archive-file-list-start)
735 (archive-next-line no)))
736
737 (defun archive-summarize-files (files)
738 "Insert a description of a list of files annotated with proper mouse face."
739 (setq archive-file-list-start (point-marker))
740 (setq archive-file-name-indent (if files (aref (car files) 1) 0))
741 ;; We don't want to do an insert for each element since that takes too
742 ;; long when the archive -- which has to be moved in memory -- is large.
743 (insert
744 (apply
745 (function concat)
746 (mapcar
747 (lambda (fil)
748 ;; Using `concat' here copies the text also, so we can add
749 ;; properties without problems.
750 (let ((text (concat (aref fil 0) "\n")))
751 (if (featurep 'xemacs)
752 () ; out of luck
753 (add-text-properties
754 (aref fil 1) (aref fil 2)
755 '(mouse-face highlight
756 help-echo "mouse-2: extract this file into a buffer")
757 text))
758 text))
759 files)))
760 (setq archive-file-list-end (point-marker)))
761
762 (defun archive-alternate-display ()
763 "Toggle alternative display.
764 To avoid very long lines archive mode does not show all information.
765 This function changes the set of information shown for each files."
766 (interactive)
767 (setq archive-alternate-display (not archive-alternate-display))
768 (archive-resummarize))
769 ;; -------------------------------------------------------------------------
770 ;; Section: Local archive copy handling
771
772 (defun archive-unique-fname (fname dir)
773 "Make sure a file FNAME can be created uniquely in directory DIR.
774
775 If FNAME can be uniquely created in DIR, it is returned unaltered.
776 If FNAME is something our underlying filesystem can't grok, or if another
777 file by that name already exists in DIR, a unique new name is generated
778 using `make-temp-file', and the generated name is returned."
779 (let ((fullname (expand-file-name fname dir))
780 (alien (string-match file-name-invalid-regexp fname)))
781 (if (or alien (file-exists-p fullname))
782 (make-temp-file
783 (expand-file-name
784 (if (if (fboundp 'msdos-long-file-names)
785 (not (msdos-long-file-names)))
786 "am"
787 "arc-mode.")
788 dir))
789 fullname)))
790
791 (defun archive-maybe-copy (archive)
792 (let ((coding-system-for-write 'no-conversion))
793 (if archive-remote
794 (let ((start (point-max))
795 ;; Sometimes ARCHIVE is invalid while its actual name, as
796 ;; recorded in its parent archive, is not. For example, an
797 ;; archive bar.zip inside another archive foo.zip gets a name
798 ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
799 ;; So use the actual name if available.
800 (archive-name
801 (or (and archive-subfile-mode (aref archive-subfile-mode 0))
802 archive)))
803 (setq archive-local-name
804 (archive-unique-fname archive-name archive-tmpdir))
805 ;; Maked sure all the leading directories in
806 ;; archive-local-name exist under archive-tmpdir, so that
807 ;; the directory structure recorded in the archive is
808 ;; reconstructed in the temporary directory.
809 (make-directory (file-name-directory archive-local-name) t)
810 (save-restriction
811 (widen)
812 (write-region start (point-max) archive-local-name nil 'nomessage))
813 archive-local-name)
814 (if (buffer-modified-p) (save-buffer))
815 archive)))
816
817 (defun archive-maybe-update (unchanged)
818 (if archive-remote
819 (let ((name archive-local-name)
820 (modified (buffer-modified-p))
821 (coding-system-for-read 'no-conversion)
822 (lno (archive-get-lineno))
823 (inhibit-read-only t))
824 (if unchanged nil
825 (setq archive-files nil)
826 (erase-buffer)
827 (insert-file-contents name)
828 (archive-mode t)
829 (goto-char archive-file-list-start)
830 (archive-next-line lno))
831 (archive-delete-local name)
832 (if (not unchanged)
833 (message
834 "Buffer `%s' must be saved for changes to take effect"
835 (buffer-name (current-buffer))))
836 (set-buffer-modified-p (or modified (not unchanged))))))
837
838 (defun archive-delete-local (name)
839 "Delete file NAME and its parents up to and including `archive-tmpdir'."
840 (let ((again t)
841 (top (directory-file-name (file-name-as-directory archive-tmpdir))))
842 (condition-case nil
843 (delete-file name)
844 (error nil))
845 (while again
846 (setq name (directory-file-name (file-name-directory name)))
847 (condition-case nil
848 (delete-directory name)
849 (error nil))
850 (if (string= name top) (setq again nil)))))
851 ;; -------------------------------------------------------------------------
852 ;; Section: Member extraction
853
854 (defun archive-file-name-handler (op &rest args)
855 (or (eq op 'file-exists-p)
856 (let ((file-name-handler-alist nil))
857 (apply op args))))
858
859 (defun archive-set-buffer-as-visiting-file (filename)
860 "Set the current buffer as if it were visiting FILENAME."
861 (save-excursion
862 (goto-char (point-min))
863 (let ((coding
864 (or coding-system-for-read
865 (and set-auto-coding-function
866 (save-excursion
867 (funcall set-auto-coding-function
868 filename (- (point-max) (point-min)))))
869 ;; dos-w32.el defines find-operation-coding-system for
870 ;; DOS/Windows systems which preserves the coding-system
871 ;; of existing files. We want it to act here as if the
872 ;; extracted file existed.
873 (let ((file-name-handler-alist
874 '(("" . archive-file-name-handler))))
875 (car (find-operation-coding-system 'insert-file-contents
876 filename t))))))
877 (if (and (not coding-system-for-read)
878 (not enable-multibyte-characters))
879 (setq coding
880 (coding-system-change-text-conversion coding 'raw-text)))
881 (if (and coding
882 (not (eq coding 'no-conversion)))
883 (decode-coding-region (point-min) (point-max) coding)
884 (setq last-coding-system-used coding))
885 (set-buffer-modified-p nil)
886 (kill-local-variable 'buffer-file-coding-system)
887 (after-insert-file-set-coding (- (point-max) (point-min))))))
888
889 (define-obsolete-function-alias 'archive-mouse-extract 'archive-extract "22.1")
890
891 (defun archive-extract (&optional other-window-p event)
892 "In archive mode, extract this entry of the archive into its own buffer."
893 (interactive (list nil last-input-event))
894 (if event (posn-set-point (event-end event)))
895 (let* ((view-p (eq other-window-p 'view))
896 (descr (archive-get-descr))
897 (ename (aref descr 0))
898 (iname (aref descr 1))
899 (archive-buffer (current-buffer))
900 (arcdir default-directory)
901 (archive (buffer-file-name))
902 (arcname (file-name-nondirectory archive))
903 (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
904 (extractor (archive-name "extract"))
905 ;; Members with file names which aren't valid for the
906 ;; underlying filesystem, are treated as read-only.
907 (read-only-p (or archive-read-only
908 view-p
909 (string-match file-name-invalid-regexp ename)))
910 (buffer (get-buffer bufname))
911 (just-created nil))
912 (if buffer
913 nil
914 (setq archive (archive-maybe-copy archive))
915 (setq buffer (get-buffer-create bufname))
916 (setq just-created t)
917 (with-current-buffer buffer
918 (setq buffer-file-name
919 (expand-file-name (concat arcname ":" iname)))
920 (setq buffer-file-truename
921 (abbreviate-file-name buffer-file-name))
922 ;; Set the default-directory to the dir of the superior buffer.
923 (setq default-directory arcdir)
924 (make-local-variable 'archive-superior-buffer)
925 (setq archive-superior-buffer archive-buffer)
926 (add-hook 'write-file-functions 'archive-write-file-member nil t)
927 (setq archive-subfile-mode descr)
928 (if (and
929 (null
930 (let (;; We may have to encode file name arguement for
931 ;; external programs.
932 (coding-system-for-write
933 (and enable-multibyte-characters
934 file-name-coding-system))
935 ;; We read an archive member by no-conversion at
936 ;; first, then decode appropriately by calling
937 ;; archive-set-buffer-as-visiting-file later.
938 (coding-system-for-read 'no-conversion))
939 (condition-case err
940 (if (fboundp extractor)
941 (funcall extractor archive ename)
942 (archive-*-extract archive ename
943 (symbol-value extractor)))
944 (error
945 (ding (message "%s" (error-message-string err)))
946 nil))))
947 just-created)
948 (progn
949 (set-buffer-modified-p nil)
950 (kill-buffer buffer))
951 (archive-set-buffer-as-visiting-file ename)
952 (goto-char (point-min))
953 (rename-buffer bufname)
954 (setq buffer-read-only read-only-p)
955 (setq buffer-undo-list nil)
956 (set-buffer-modified-p nil)
957 (setq buffer-saved-size (buffer-size))
958 (normal-mode)
959 ;; Just in case an archive occurs inside another archive.
960 (when (derived-mode-p 'archive-mode)
961 (setq archive-remote t)
962 (if read-only-p (setq archive-read-only t))
963 ;; We will write out the archive ourselves if it is
964 ;; part of another archive.
965 (remove-hook 'write-contents-functions 'archive-write-file t))
966 (run-hooks 'archive-extract-hooks)
967 (if archive-read-only
968 (message "Note: altering this archive is not implemented."))))
969 (archive-maybe-update t))
970 (or (not (buffer-name buffer))
971 (cond
972 (view-p (view-buffer buffer (and just-created 'kill-buffer)))
973 ((eq other-window-p 'display) (display-buffer buffer))
974 (other-window-p (switch-to-buffer-other-window buffer))
975 (t (switch-to-buffer buffer))))))
976
977 (defun archive-*-extract (archive name command)
978 (let* ((default-directory (file-name-as-directory archive-tmpdir))
979 (tmpfile (expand-file-name (file-name-nondirectory name)
980 default-directory))
981 exit-status success)
982 (make-directory (directory-file-name default-directory) t)
983 (setq exit-status
984 (apply 'call-process
985 (car command)
986 nil
987 nil
988 nil
989 (append (cdr command) (list archive name))))
990 (cond ((and (numberp exit-status) (= exit-status 0))
991 (if (not (file-exists-p tmpfile))
992 (ding (message "`%s': no such file or directory" tmpfile))
993 (insert-file-contents tmpfile)
994 (setq success t)))
995 ((numberp exit-status)
996 (ding
997 (message "`%s' exited with status %d" (car command) exit-status)))
998 ((stringp exit-status)
999 (ding (message "`%s' aborted: %s" (car command) exit-status)))
1000 (t
1001 (ding (message "`%s' failed" (car command)))))
1002 (archive-delete-local tmpfile)
1003 success))
1004
1005 (defun archive-extract-by-stdout (archive name command)
1006 (apply 'call-process
1007 (car command)
1008 nil
1009 t
1010 nil
1011 (append (cdr command) (list archive name))))
1012
1013 (defun archive-extract-other-window ()
1014 "In archive mode, find this member in another window."
1015 (interactive)
1016 (archive-extract t))
1017
1018 (defun archive-display-other-window ()
1019 "In archive mode, display this member in another window."
1020 (interactive)
1021 (archive-extract 'display))
1022
1023 (defun archive-view ()
1024 "In archive mode, view the member on this line."
1025 (interactive)
1026 (archive-extract 'view))
1027
1028 (defun archive-add-new-member (arcbuf name)
1029 "Add current buffer to the archive in ARCBUF naming it NAME."
1030 (interactive
1031 (list (get-buffer
1032 (read-buffer "Buffer containing archive: "
1033 ;; Find first archive buffer and suggest that
1034 (let ((bufs (buffer-list)))
1035 (while (and bufs
1036 (not (with-current-buffer (car bufs)
1037 (derived-mode-p 'archive-mode))))
1038 (setq bufs (cdr bufs)))
1039 (if bufs
1040 (car bufs)
1041 (error "There are no archive buffers")))
1042 t))
1043 (read-string "File name in archive: "
1044 (if buffer-file-name
1045 (file-name-nondirectory buffer-file-name)
1046 ""))))
1047 (with-current-buffer arcbuf
1048 (or (eq major-mode 'archive-mode)
1049 (error "Buffer is not an archive buffer"))
1050 (if archive-read-only
1051 (error "Archive is read-only")))
1052 (if (eq arcbuf (current-buffer))
1053 (error "An archive buffer cannot be added to itself"))
1054 (if (string= name "")
1055 (error "Archive members may not be given empty names"))
1056 (let ((func (with-current-buffer arcbuf
1057 (archive-name "add-new-member")))
1058 (membuf (current-buffer)))
1059 (if (fboundp func)
1060 (with-current-buffer arcbuf
1061 (funcall func buffer-file-name membuf name))
1062 (error "Adding a new member is not supported for this archive type"))))
1063 ;; -------------------------------------------------------------------------
1064 ;; Section: IO stuff
1065
1066 (defun archive-write-file-member ()
1067 (save-excursion
1068 (save-restriction
1069 (message "Updating archive...")
1070 (widen)
1071 (let ((writer (with-current-buffer archive-superior-buffer
1072 (archive-name "write-file-member")))
1073 (archive (with-current-buffer archive-superior-buffer
1074 (archive-maybe-copy (buffer-file-name)))))
1075 (if (fboundp writer)
1076 (funcall writer archive archive-subfile-mode)
1077 (archive-*-write-file-member archive
1078 archive-subfile-mode
1079 (symbol-value writer)))
1080 (set-buffer-modified-p nil)
1081 (message "Updating archive...done"))
1082 (set-buffer archive-superior-buffer)
1083 (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
1084 ;; Restore the value of last-coding-system-used, so that basic-save-buffer
1085 ;; won't reset the coding-system of this archive member.
1086 (if (local-variable-p 'archive-member-coding-system)
1087 (setq last-coding-system-used archive-member-coding-system))
1088 t)
1089
1090 (defun archive-*-write-file-member (archive descr command)
1091 (let* ((ename (aref descr 0))
1092 (tmpfile (expand-file-name ename archive-tmpdir))
1093 (top (directory-file-name (file-name-as-directory archive-tmpdir)))
1094 (default-directory (file-name-as-directory top)))
1095 (unwind-protect
1096 (progn
1097 (make-directory (file-name-directory tmpfile) t)
1098 ;; If the member is itself an archive, write it without
1099 ;; the dired-like listing we created.
1100 (if (eq major-mode 'archive-mode)
1101 (archive-write-file tmpfile)
1102 (write-region (point-min) (point-max) tmpfile nil 'nomessage))
1103 ;; basic-save-buffer needs last-coding-system-used to have
1104 ;; the value used to write the file, so save it before any
1105 ;; further processing clobbers it (we restore it in
1106 ;; archive-write-file-member, above).
1107 (setq archive-member-coding-system last-coding-system-used)
1108 (if (aref descr 3)
1109 ;; Set the file modes, but make sure we can read it.
1110 (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1111 (if enable-multibyte-characters
1112 (setq ename
1113 (encode-coding-string ename file-name-coding-system)))
1114 (let ((exitcode (apply 'call-process
1115 (car command)
1116 nil
1117 nil
1118 nil
1119 (append (cdr command) (list archive ename)))))
1120 (if (equal exitcode 0)
1121 nil
1122 (error "Updating was unsuccessful (%S)" exitcode))))
1123 (archive-delete-local tmpfile))))
1124
1125 (defun archive-write-file (&optional file)
1126 (save-excursion
1127 (let ((coding-system-for-write 'no-conversion))
1128 (write-region archive-proper-file-start (point-max)
1129 (or file buffer-file-name) nil t)
1130 (set-buffer-modified-p nil))
1131 t))
1132 ;; -------------------------------------------------------------------------
1133 ;; Section: Marking and unmarking.
1134
1135 (defun archive-flag-deleted (p &optional type)
1136 "In archive mode, mark this member to be deleted from the archive.
1137 With a prefix argument, mark that many files."
1138 (interactive "p")
1139 (or type (setq type ?D))
1140 (beginning-of-line)
1141 (let ((sign (if (>= p 0) +1 -1))
1142 (modified (buffer-modified-p))
1143 (inhibit-read-only t))
1144 (while (not (zerop p))
1145 (if (archive-get-descr t)
1146 (progn
1147 (delete-char 1)
1148 (insert type)))
1149 (forward-line sign)
1150 (setq p (- p sign)))
1151 (restore-buffer-modified-p modified))
1152 (archive-next-line 0))
1153
1154 (defun archive-unflag (p)
1155 "In archive mode, un-mark this member if it is marked to be deleted.
1156 With a prefix argument, un-mark that many files forward."
1157 (interactive "p")
1158 (archive-flag-deleted p ?\s))
1159
1160 (defun archive-unflag-backwards (p)
1161 "In archive mode, un-mark this member if it is marked to be deleted.
1162 With a prefix argument, un-mark that many members backward."
1163 (interactive "p")
1164 (archive-flag-deleted (- p) ?\s))
1165
1166 (defun archive-unmark-all-files ()
1167 "Remove all marks."
1168 (interactive)
1169 (let ((modified (buffer-modified-p))
1170 (inhibit-read-only t))
1171 (save-excursion
1172 (goto-char archive-file-list-start)
1173 (while (< (point) archive-file-list-end)
1174 (or (= (following-char) ?\s)
1175 (progn (delete-char 1) (insert ?\s)))
1176 (forward-line 1)))
1177 (restore-buffer-modified-p modified)))
1178
1179 (defun archive-mark (p)
1180 "In archive mode, mark this member for group operations.
1181 With a prefix argument, mark that many members.
1182 Use \\[archive-unmark-all-files] to remove all marks."
1183 (interactive "p")
1184 (archive-flag-deleted p ?*))
1185
1186 (defun archive-get-marked (mark &optional default)
1187 (let (files)
1188 (save-excursion
1189 (goto-char archive-file-list-start)
1190 (while (< (point) archive-file-list-end)
1191 (if (= (following-char) mark)
1192 (setq files (cons (archive-get-descr) files)))
1193 (forward-line 1)))
1194 (or (nreverse files)
1195 (and default
1196 (list (archive-get-descr))))))
1197 ;; -------------------------------------------------------------------------
1198 ;; Section: Operate
1199
1200 (defun archive-next-line (p)
1201 (interactive "p")
1202 (forward-line p)
1203 (or (eobp)
1204 (forward-char archive-file-name-indent)))
1205
1206 (defun archive-previous-line (p)
1207 (interactive "p")
1208 (archive-next-line (- p)))
1209
1210 (defun archive-chmod-entry (new-mode)
1211 "Change the protection bits associated with all marked or this member.
1212 The new protection bits can either be specified as an octal number or
1213 as a relative change like \"g+rw\" as for chmod(2)."
1214 (interactive "sNew mode (octal or relative): ")
1215 (if archive-read-only (error "Archive is read-only"))
1216 (let ((func (archive-name "chmod-entry")))
1217 (if (fboundp func)
1218 (progn
1219 (funcall func new-mode (archive-get-marked ?* t))
1220 (archive-resummarize))
1221 (error "Setting mode bits is not supported for this archive type"))))
1222
1223 (defun archive-chown-entry (new-uid)
1224 "Change the owner of all marked or this member."
1225 (interactive "nNew uid: ")
1226 (if archive-read-only (error "Archive is read-only"))
1227 (let ((func (archive-name "chown-entry")))
1228 (if (fboundp func)
1229 (progn
1230 (funcall func new-uid (archive-get-marked ?* t))
1231 (archive-resummarize))
1232 (error "Setting owner is not supported for this archive type"))))
1233
1234 (defun archive-chgrp-entry (new-gid)
1235 "Change the group of all marked or this member."
1236 (interactive "nNew gid: ")
1237 (if archive-read-only (error "Archive is read-only"))
1238 (let ((func (archive-name "chgrp-entry")))
1239 (if (fboundp func)
1240 (progn
1241 (funcall func new-gid (archive-get-marked ?* t))
1242 (archive-resummarize))
1243 (error "Setting group is not supported for this archive type"))))
1244
1245 (defun archive-expunge ()
1246 "Do the flagged deletions."
1247 (interactive)
1248 (let (files)
1249 (save-excursion
1250 (goto-char archive-file-list-start)
1251 (while (< (point) archive-file-list-end)
1252 (if (= (following-char) ?D)
1253 (setq files (cons (aref (archive-get-descr) 0) files)))
1254 (forward-line 1)))
1255 (setq files (nreverse files))
1256 (and files
1257 (or (not archive-read-only)
1258 (error "Archive is read-only"))
1259 (or (yes-or-no-p (format "Really delete %d member%s? "
1260 (length files)
1261 (if (null (cdr files)) "" "s")))
1262 (error "Operation aborted"))
1263 (let ((archive (archive-maybe-copy (buffer-file-name)))
1264 (expunger (archive-name "expunge")))
1265 (if (fboundp expunger)
1266 (funcall expunger archive files)
1267 (archive-*-expunge archive files (symbol-value expunger)))
1268 (archive-maybe-update nil)
1269 (if archive-remote
1270 (archive-resummarize)
1271 (revert-buffer))))))
1272
1273 (defun archive-*-expunge (archive files command)
1274 (apply 'call-process
1275 (car command)
1276 nil
1277 nil
1278 nil
1279 (append (cdr command) (cons archive files))))
1280
1281 (defun archive-rename-entry (newname)
1282 "Change the name associated with this entry in the archive file."
1283 (interactive "sNew name: ")
1284 (if archive-read-only (error "Archive is read-only"))
1285 (if (string= newname "")
1286 (error "Archive members may not be given empty names"))
1287 (let ((func (archive-name "rename-entry"))
1288 (descr (archive-get-descr)))
1289 (if (fboundp func)
1290 (progn
1291 (funcall func
1292 (if enable-multibyte-characters
1293 (encode-coding-string newname file-name-coding-system)
1294 newname)
1295 descr)
1296 (archive-resummarize))
1297 (error "Renaming is not supported for this archive type"))))
1298
1299 ;; Revert the buffer and recompute the dired-like listing.
1300 (defun archive-mode-revert (&optional no-auto-save no-confirm)
1301 (let ((no (archive-get-lineno)))
1302 (setq archive-files nil)
1303 (let ((revert-buffer-function nil)
1304 (coding-system-for-read 'no-conversion))
1305 (set-buffer-multibyte nil)
1306 (revert-buffer t t))
1307 (archive-mode)
1308 (goto-char archive-file-list-start)
1309 (archive-next-line no)))
1310
1311 (defun archive-undo ()
1312 "Undo in an archive buffer.
1313 This doesn't recover lost files, it just undoes changes in the buffer itself."
1314 (interactive)
1315 (let ((inhibit-read-only t))
1316 (undo)))
1317 ;; -------------------------------------------------------------------------
1318 ;; Section: Arc Archives
1319
1320 (defun archive-arc-summarize ()
1321 (let ((p 1)
1322 (totalsize 0)
1323 (maxlen 8)
1324 files
1325 visual)
1326 (while (and (< (+ p 29) (point-max))
1327 (= (char-after p) ?\C-z)
1328 (> (char-after (1+ p)) 0))
1329 (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13)))
1330 (fnlen (or (string-match "\0" namefld) 13))
1331 (efnname (substring namefld 0 fnlen))
1332 (csize (archive-l-e (+ p 15) 4))
1333 (moddate (archive-l-e (+ p 19) 2))
1334 (modtime (archive-l-e (+ p 21) 2))
1335 (ucsize (archive-l-e (+ p 25) 4))
1336 (fiddle (string= efnname (upcase efnname)))
1337 (ifnname (if fiddle (downcase efnname) efnname))
1338 (text (format " %8d %-11s %-8s %s"
1339 ucsize
1340 (archive-dosdate moddate)
1341 (archive-dostime modtime)
1342 ifnname)))
1343 (setq maxlen (max maxlen fnlen)
1344 totalsize (+ totalsize ucsize)
1345 visual (cons (vector text
1346 (- (length text) (length ifnname))
1347 (length text))
1348 visual)
1349 files (cons (vector efnname ifnname fiddle nil (1- p))
1350 files)
1351 p (+ p 29 csize))))
1352 (goto-char (point-min))
1353 (let ((dash (concat "- -------- ----------- -------- "
1354 (make-string maxlen ?-)
1355 "\n")))
1356 (insert "M Length Date Time File\n"
1357 dash)
1358 (archive-summarize-files (nreverse visual))
1359 (insert dash
1360 (format " %8d %d file%s"
1361 totalsize
1362 (length files)
1363 (if (= 1 (length files)) "" "s"))
1364 "\n"))
1365 (apply 'vector (nreverse files))))
1366
1367 (defun archive-arc-rename-entry (newname descr)
1368 (if (string-match "[:\\\\/]" newname)
1369 (error "File names in arc files must not contain a directory component"))
1370 (if (> (length newname) 12)
1371 (error "File names in arc files are limited to 12 characters"))
1372 (let ((name (concat newname (substring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
1373 (length newname))))
1374 (inhibit-read-only t))
1375 (save-restriction
1376 (save-excursion
1377 (widen)
1378 (set-buffer-multibyte nil)
1379 (goto-char (+ archive-proper-file-start (aref descr 4) 2))
1380 (delete-char 13)
1381 (insert name)))))
1382 ;; -------------------------------------------------------------------------
1383 ;; Section: Lzh Archives
1384
1385 (defun archive-lzh-summarize ()
1386 (let ((p 1)
1387 (totalsize 0)
1388 (maxlen 8)
1389 files
1390 visual)
1391 (while (progn (goto-char p) ;beginning of a base header.
1392 (looking-at "\\(.\\|\n\\)\\(.\\|\n\\)-l[hz][0-9ds]-"))
1393 (let* ((hsize (char-after p)) ;size of the base header (level 0 and 1)
1394 (csize (archive-l-e (+ p 7) 4)) ;size of a compressed file to follow (level 0 and 2),
1395 ;size of extended headers + the compressed file to follow (level 1).
1396 (ucsize (archive-l-e (+ p 11) 4)) ;size of an uncompressed file.
1397 (time1 (archive-l-e (+ p 15) 2)) ;date/time (MSDOS format in level 0, 1 headers
1398 (time2 (archive-l-e (+ p 17) 2)) ;and UNIX format in level 2 header.)
1399 (hdrlvl (char-after (+ p 20))) ;header level
1400 thsize ;total header size (base + extensions)
1401 fnlen efnname fiddle ifnname width p2
1402 neh ;beginning of next extension header (level 1 and 2)
1403 mode modestr uid gid text dir prname
1404 gname uname modtime moddate)
1405 (if (= hdrlvl 3) (error "can't handle lzh level 3 header type"))
1406 (when (or (= hdrlvl 0) (= hdrlvl 1))
1407 (setq fnlen (char-after (+ p 21))) ;filename length
1408 (setq efnname (let ((str (buffer-substring (+ p 22) (+ p 22 fnlen)))) ;filename from offset 22
1409 (if file-name-coding-system
1410 (decode-coding-string str file-name-coding-system)
1411 (string-as-multibyte str))))
1412 (setq p2 (+ p 22 fnlen))) ;
1413 (if (= hdrlvl 1)
1414 (setq neh (+ p2 3)) ;specific to level 1 header
1415 (if (= hdrlvl 2)
1416 (setq neh (+ p 24)))) ;specific to level 2 header
1417 (if neh ;if level 1 or 2 we expect extension headers to follow
1418 (let* ((ehsize (archive-l-e neh 2)) ;size of the extension header
1419 (etype (char-after (+ neh 2)))) ;extension type
1420 (while (not (= ehsize 0))
1421 (cond
1422 ((= etype 1) ;file name
1423 (let ((i (+ neh 3)))
1424 (while (< i (+ neh ehsize))
1425 (setq efnname (concat efnname (char-to-string (char-after i))))
1426 (setq i (1+ i)))))
1427 ((= etype 2) ;directory name
1428 (let ((i (+ neh 3)))
1429 (while (< i (+ neh ehsize))
1430 (setq dir (concat dir
1431 (if (= (char-after i)
1432 255)
1433 "/"
1434 (char-to-string
1435 (char-after i)))))
1436 (setq i (1+ i)))))
1437 ((= etype 80) ;Unix file permission
1438 (setq mode (archive-l-e (+ neh 3) 2)))
1439 ((= etype 81) ;UNIX file group/user ID
1440 (progn (setq uid (archive-l-e (+ neh 3) 2))
1441 (setq gid (archive-l-e (+ neh 5) 2))))
1442 ((= etype 82) ;UNIX file group name
1443 (let ((i (+ neh 3)))
1444 (while (< i (+ neh ehsize))
1445 (setq gname (concat gname (char-to-string (char-after i))))
1446 (setq i (1+ i)))))
1447 ((= etype 83) ;UNIX file user name
1448 (let ((i (+ neh 3)))
1449 (while (< i (+ neh ehsize))
1450 (setq uname (concat uname (char-to-string (char-after i))))
1451 (setq i (1+ i)))))
1452 )
1453 (setq neh (+ neh ehsize))
1454 (setq ehsize (archive-l-e neh 2))
1455 (setq etype (char-after (+ neh 2))))
1456 ;;get total header size for level 1 and 2 headers
1457 (setq thsize (- neh p))))
1458 (if (= hdrlvl 0) ;total header size
1459 (setq thsize hsize))
1460 (setq fiddle (if efnname (string= efnname (upcase efnname))))
1461 (setq ifnname (if fiddle (downcase efnname) efnname))
1462 (setq prname (if dir (concat dir ifnname) ifnname))
1463 (setq width (if prname (string-width prname) 0))
1464 (setq modestr (if mode (archive-int-to-mode mode) "??????????"))
1465 (setq moddate (if (= hdrlvl 2)
1466 (archive-unixdate time1 time2) ;level 2 header in UNIX format
1467 (archive-dosdate time2))) ;level 0 and 1 header in DOS format
1468 (setq modtime (if (= hdrlvl 2)
1469 (archive-unixtime time1 time2)
1470 (archive-dostime time1)))
1471 (setq text (if archive-alternate-display
1472 (format " %8d %5S %5S %s"
1473 ucsize
1474 (or uid "?")
1475 (or gid "?")
1476 ifnname)
1477 (format " %10s %8d %-11s %-8s %s"
1478 modestr
1479 ucsize
1480 moddate
1481 modtime
1482 prname)))
1483 (setq maxlen (max maxlen width)
1484 totalsize (+ totalsize ucsize)
1485 visual (cons (vector text
1486 (- (length text) (length prname))
1487 (length text))
1488 visual)
1489 files (cons (vector prname ifnname fiddle mode (1- p))
1490 files))
1491 (cond ((= hdrlvl 1)
1492 (setq p (+ p hsize 2 csize)))
1493 ((or (= hdrlvl 2) (= hdrlvl 0))
1494 (setq p (+ p thsize 2 csize))))
1495 ))
1496 (goto-char (point-min))
1497 (set-buffer-multibyte default-enable-multibyte-characters)
1498 (let ((dash (concat (if archive-alternate-display
1499 "- -------- ----- ----- "
1500 "- ---------- -------- ----------- -------- ")
1501 (make-string maxlen ?-)
1502 "\n"))
1503 (header (if archive-alternate-display
1504 "M Length Uid Gid File\n"
1505 "M Filemode Length Date Time File\n"))
1506 (sumline (if archive-alternate-display
1507 " %8d %d file%s"
1508 " %8d %d file%s")))
1509 (insert header dash)
1510 (archive-summarize-files (nreverse visual))
1511 (insert dash
1512 (format sumline
1513 totalsize
1514 (length files)
1515 (if (= 1 (length files)) "" "s"))
1516 "\n"))
1517 (apply 'vector (nreverse files))))
1518
1519 (defconst archive-lzh-alternate-display t)
1520
1521 (defun archive-lzh-extract (archive name)
1522 (archive-extract-by-stdout archive name archive-lzh-extract))
1523
1524 (defun archive-lzh-resum (p count)
1525 (let ((sum 0))
1526 (while (> count 0)
1527 (setq count (1- count)
1528 sum (+ sum (char-after p))
1529 p (1+ p)))
1530 (logand sum 255)))
1531
1532 (defun archive-lzh-rename-entry (newname descr)
1533 (save-restriction
1534 (save-excursion
1535 (widen)
1536 (set-buffer-multibyte nil)
1537 (let* ((p (+ archive-proper-file-start (aref descr 4)))
1538 (oldhsize (char-after p))
1539 (oldfnlen (char-after (+ p 21)))
1540 (newfnlen (length newname))
1541 (newhsize (+ oldhsize newfnlen (- oldfnlen)))
1542 (inhibit-read-only t))
1543 (if (> newhsize 255)
1544 (error "The file name is too long"))
1545 (goto-char (+ p 21))
1546 (delete-char (1+ oldfnlen))
1547 (insert newfnlen newname)
1548 (goto-char p)
1549 (delete-char 2)
1550 (insert newhsize (archive-lzh-resum p newhsize))))))
1551
1552 (defun archive-lzh-ogm (newval files errtxt ofs)
1553 (save-excursion
1554 (save-restriction
1555 (widen)
1556 (set-buffer-multibyte nil)
1557 (dolist (fil files)
1558 (let* ((p (+ archive-proper-file-start (aref fil 4)))
1559 (hsize (char-after p))
1560 (fnlen (char-after (+ p 21)))
1561 (p2 (+ p 22 fnlen))
1562 (creator (if (>= (- hsize fnlen) 24) (char-after (+ p2 2)) 0))
1563 (inhibit-read-only t))
1564 (if (= creator ?U)
1565 (progn
1566 (or (numberp newval)
1567 (setq newval (funcall newval (archive-l-e (+ p2 ofs) 2))))
1568 (goto-char (+ p2 ofs))
1569 (delete-char 2)
1570 (insert (logand newval 255) (lsh newval -8))
1571 (goto-char (1+ p))
1572 (delete-char 1)
1573 (insert (archive-lzh-resum (1+ p) hsize)))
1574 (message "Member %s does not have %s field"
1575 (aref fil 1) errtxt)))))))
1576
1577 (defun archive-lzh-chown-entry (newuid files)
1578 (archive-lzh-ogm newuid files "an uid" 10))
1579
1580 (defun archive-lzh-chgrp-entry (newgid files)
1581 (archive-lzh-ogm newgid files "a gid" 12))
1582
1583 (defun archive-lzh-chmod-entry (newmode files)
1584 (archive-lzh-ogm
1585 ;; This should work even though newmode will be dynamically accessed.
1586 (lambda (old) (archive-calc-mode old newmode t))
1587 files "a unix-style mode" 8))
1588 ;; -------------------------------------------------------------------------
1589 ;; Section: Zip Archives
1590
1591 (defun archive-zip-summarize ()
1592 (goto-char (- (point-max) (- 22 18)))
1593 (search-backward-regexp "[P]K\005\006")
1594 (let ((p (+ (point-min) (archive-l-e (+ (point) 16) 4)))
1595 (maxlen 8)
1596 (totalsize 0)
1597 files
1598 visual)
1599 (while (string= "PK\001\002" (buffer-substring p (+ p 4)))
1600 (let* ((creator (char-after (+ p 5)))
1601 ;; (method (archive-l-e (+ p 10) 2))
1602 (modtime (archive-l-e (+ p 12) 2))
1603 (moddate (archive-l-e (+ p 14) 2))
1604 (ucsize (archive-l-e (+ p 24) 4))
1605 (fnlen (archive-l-e (+ p 28) 2))
1606 (exlen (archive-l-e (+ p 30) 2))
1607 (fclen (archive-l-e (+ p 32) 2))
1608 (lheader (archive-l-e (+ p 42) 4))
1609 (efnname (let ((str (buffer-substring (+ p 46) (+ p 46 fnlen))))
1610 (if file-name-coding-system
1611 (decode-coding-string str file-name-coding-system)
1612 (string-as-multibyte str))))
1613 (isdir (and (= ucsize 0)
1614 (string= (file-name-nondirectory efnname) "")))
1615 (mode (cond ((memq creator '(2 3)) ; Unix + VMS
1616 (archive-l-e (+ p 40) 2))
1617 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1618 (logior ?\444
1619 (if isdir (logior 16384 ?\111) 0)
1620 (if (zerop
1621 (logand 1 (char-after (+ p 38))))
1622 ?\222 0)))
1623 (t nil)))
1624 (modestr (if mode (archive-int-to-mode mode) "??????????"))
1625 (fiddle (and archive-zip-case-fiddle
1626 (not (not (memq creator '(0 2 4 5 9))))
1627 (string= (upcase efnname) efnname)))
1628 (ifnname (if fiddle (downcase efnname) efnname))
1629 (width (string-width ifnname))
1630 (text (format " %10s %8d %-11s %-8s %s"
1631 modestr
1632 ucsize
1633 (archive-dosdate moddate)
1634 (archive-dostime modtime)
1635 ifnname)))
1636 (setq maxlen (max maxlen width)
1637 totalsize (+ totalsize ucsize)
1638 visual (cons (vector text
1639 (- (length text) (length ifnname))
1640 (length text))
1641 visual)
1642 files (cons (if isdir
1643 nil
1644 (vector efnname ifnname fiddle mode
1645 (list (1- p) lheader)))
1646 files)
1647 p (+ p 46 fnlen exlen fclen))))
1648 (goto-char (point-min))
1649 (let ((dash (concat "- ---------- -------- ----------- -------- "
1650 (make-string maxlen ?-)
1651 "\n")))
1652 (insert "M Filemode Length Date Time File\n"
1653 dash)
1654 (archive-summarize-files (nreverse visual))
1655 (insert dash
1656 (format " %8d %d file%s"
1657 totalsize
1658 (length files)
1659 (if (= 1 (length files)) "" "s"))
1660 "\n"))
1661 (apply 'vector (nreverse files))))
1662
1663 (defun archive-zip-extract (archive name)
1664 (if (equal (car archive-zip-extract) "pkzip")
1665 (archive-*-extract archive name archive-zip-extract)
1666 (archive-extract-by-stdout archive name archive-zip-extract)))
1667
1668 (defun archive-zip-write-file-member (archive descr)
1669 (archive-*-write-file-member
1670 archive
1671 descr
1672 (if (aref descr 2) archive-zip-update-case archive-zip-update)))
1673
1674 (defun archive-zip-chmod-entry (newmode files)
1675 (save-restriction
1676 (save-excursion
1677 (widen)
1678 (set-buffer-multibyte nil)
1679 (dolist (fil files)
1680 (let* ((p (+ archive-proper-file-start (car (aref fil 4))))
1681 (creator (char-after (+ p 5)))
1682 (oldmode (aref fil 3))
1683 (newval (archive-calc-mode oldmode newmode t))
1684 (inhibit-read-only t))
1685 (cond ((memq creator '(2 3)) ; Unix + VMS
1686 (goto-char (+ p 40))
1687 (delete-char 2)
1688 (insert (logand newval 255) (lsh newval -8)))
1689 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1690 (goto-char (+ p 38))
1691 (insert (logior (logand (char-after (point)) 254)
1692 (logand (logxor 1 (lsh newval -7)) 1)))
1693 (delete-char 1))
1694 (t (message "Don't know how to change mode for this member"))))
1695 ))))
1696 ;; -------------------------------------------------------------------------
1697 ;; Section: Zoo Archives
1698
1699 (defun archive-zoo-summarize ()
1700 (let ((p (1+ (archive-l-e 25 4)))
1701 (maxlen 8)
1702 (totalsize 0)
1703 files
1704 visual)
1705 (while (and (string= "\334\247\304\375" (buffer-substring p (+ p 4)))
1706 (> (archive-l-e (+ p 6) 4) 0))
1707 (let* ((next (1+ (archive-l-e (+ p 6) 4)))
1708 (moddate (archive-l-e (+ p 14) 2))
1709 (modtime (archive-l-e (+ p 16) 2))
1710 (ucsize (archive-l-e (+ p 20) 4))
1711 (namefld (buffer-substring (+ p 38) (+ p 38 13)))
1712 (dirtype (char-after (+ p 4)))
1713 (lfnlen (if (= dirtype 2) (char-after (+ p 56)) 0))
1714 (ldirlen (if (= dirtype 2) (char-after (+ p 57)) 0))
1715 (fnlen (or (string-match "\0" namefld) 13))
1716 (efnname (let ((str
1717 (concat
1718 (if (> ldirlen 0)
1719 (concat (buffer-substring
1720 (+ p 58 lfnlen)
1721 (+ p 58 lfnlen ldirlen -1))
1722 "/")
1723 "")
1724 (if (> lfnlen 0)
1725 (buffer-substring (+ p 58)
1726 (+ p 58 lfnlen -1))
1727 (substring namefld 0 fnlen)))))
1728 (if file-name-coding-system
1729 (decode-coding-string str file-name-coding-system)
1730 (string-as-multibyte str))))
1731 (fiddle (and (= lfnlen 0) (string= efnname (upcase efnname))))
1732 (ifnname (if fiddle (downcase efnname) efnname))
1733 (width (string-width ifnname))
1734 (text (format " %8d %-11s %-8s %s"
1735 ucsize
1736 (archive-dosdate moddate)
1737 (archive-dostime modtime)
1738 ifnname)))
1739 (setq maxlen (max maxlen width)
1740 totalsize (+ totalsize ucsize)
1741 visual (cons (vector text
1742 (- (length text) (length ifnname))
1743 (length text))
1744 visual)
1745 files (cons (vector efnname ifnname fiddle nil (1- p))
1746 files)
1747 p next)))
1748 (goto-char (point-min))
1749 (let ((dash (concat "- -------- ----------- -------- "
1750 (make-string maxlen ?-)
1751 "\n")))
1752 (insert "M Length Date Time File\n"
1753 dash)
1754 (archive-summarize-files (nreverse visual))
1755 (insert dash
1756 (format " %8d %d file%s"
1757 totalsize
1758 (length files)
1759 (if (= 1 (length files)) "" "s"))
1760 "\n"))
1761 (apply 'vector (nreverse files))))
1762
1763 (defun archive-zoo-extract (archive name)
1764 (archive-extract-by-stdout archive name archive-zoo-extract))
1765 ;; -------------------------------------------------------------------------
1766 ;; This line was a mistake; it is kept now for compatibility.
1767 ;; rms 15 Oct 98
1768 (provide 'archive-mode)
1769
1770 (provide 'arc-mode)
1771
1772 ;; arch-tag: e5966a01-35ec-4f27-8095-a043a79b457b
1773 ;;; arc-mode.el ends here