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