(info-other-window): New function.
[bpt/emacs.git] / lisp / arc-mode.el
CommitLineData
665211a3
KH
1;;; arc-mode.el --- simple editing of archives
2
380683ed 3;; Copyright (C) 1995, 1997, 1998 Free Software Foundation, Inc.
665211a3 4
0acdb863 5;; Author: Morten Welinder <terra@diku.dk>
665211a3
KH
6;; Keywords: archives msdog editing major-mode
7;; Favourite-brand-of-beer: None, I hate beer.
8
b578f267
EN
9;; This file is part of GNU Emacs.
10
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.
15
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.
20
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.
665211a3
KH
25
26;;; Commentary:
b578f267 27
665211a3
KH
28;; NAMING: "arc" is short for "archive" and does not refer specifically
29;; to files whose name end in ".arc"
30;;
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
38;;
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.
44;;
45;; * dos-fns.el: (Part of Emacs 19). You get automatic ^M^J <--> ^J
46;; conversion.
47;;
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.
55;;
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 - -
67;;
68;; Special thanks to Bill Brodie <wbrodie@panix.com> for very useful tips
69;; on the first released version of this package.
70;;
71;; This code is partly based on tar-mode.el from Emacs.
72;; -------------------------------------
73;; ARCHIVE STRUCTURES:
74;; (This is mostly for myself.)
75;;
76;; ARC A series of (header,file). No interactions among members.
77;;
78;; LZH A series of (header,file). Headers are checksummed. No
79;; interaction among members.
80;;
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.
86;;
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;; -------------------------------------
665211a3
KH
91;; HOOKS: `foo' means one the the supported archive types.
92;;
93;; archive-mode-hook
94;; archive-foo-mode-hook
95;; archive-extract-hooks
96
97;;; Code:
98
99;; -------------------------------------------------------------------------
100;; Section: Configuration.
101
c38eb0a8
RS
102(defgroup archive nil
103 "Simple editing of archives."
104 :group 'data)
665211a3 105
c38eb0a8
RS
106(defgroup archive-arc nil
107 "ARC-specific options to archive."
108 :group 'archive)
109
110(defgroup archive-lzh nil
111 "LZH-specific options to archive."
112 :group 'archive)
113
114(defgroup archive-zip nil
115 "ZIP-specific options to archive."
116 :group 'archive)
117
118(defgroup archive-zoo nil
119 "ZOO-specific options to archive."
120 :group 'archive)
121
c38eb0a8 122(defcustom archive-tmpdir
380683ed
EZ
123 (make-temp-name
124 (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp")
0adf5079 125 temporary-file-directory))
c38eb0a8
RS
126 "*Directory for temporary files made by arc-mode.el"
127 :type 'directory
128 :group 'archive)
665211a3 129
c38eb0a8 130(defcustom archive-remote-regexp "^/[^/:]*[^/:.]:"
eeba65ed
RS
131 "*Regexp recognizing archive files names that are not local.
132A non-local file is one whose file name is not proper outside Emacs.
c38eb0a8
RS
133A local copy of the archive will be used when updating."
134 :type 'regexp
135 :group 'archive)
136
137(defcustom archive-extract-hooks nil
138 "*Hooks to run when an archive member has been extracted."
139 :type 'hook
140 :group 'archive)
665211a3
KH
141;; ------------------------------
142;; Arc archive configuration
143
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.
c38eb0a8 146(defcustom archive-arc-extract
665211a3 147 '("arc" "x")
eeba65ed
RS
148 "*Program and its options to run in order to extract an arc file member.
149Extraction should happen to the current directory. Archive and member
c38eb0a8
RS
150name will be added."
151 :type '(list (string :tag "Program")
152 (repeat :tag "Options"
153 :inline t
154 (string :format "%v")))
155 :group 'archive-arc)
156
157(defcustom archive-arc-expunge
665211a3
KH
158 '("arc" "d")
159 "*Program and its options to run in order to delete arc file members.
c38eb0a8
RS
160Archive 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)
166
167(defcustom archive-arc-write-file-member
665211a3
KH
168 '("arc" "u")
169 "*Program and its options to run in order to update an arc file member.
c38eb0a8
RS
170Archive 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)
665211a3
KH
176;; ------------------------------
177;; Lzh archive configuration
178
c38eb0a8 179(defcustom archive-lzh-extract
665211a3 180 '("lha" "pq")
eeba65ed
RS
181 "*Program and its options to run in order to extract an lzh file member.
182Extraction should happen to standard output. Archive and member name will
c38eb0a8
RS
183be added."
184 :type '(list (string :tag "Program")
185 (repeat :tag "Options"
186 :inline t
187 (string :format "%v")))
188 :group 'archive-lzh)
189
190(defcustom archive-lzh-expunge
665211a3
KH
191 '("lha" "d")
192 "*Program and its options to run in order to delete lzh file members.
c38eb0a8
RS
193Archive 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)
199
200(defcustom archive-lzh-write-file-member
665211a3
KH
201 '("lha" "a")
202 "*Program and its options to run in order to update an lzh file member.
c38eb0a8
RS
203Archive 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)
665211a3
KH
209;; ------------------------------
210;; Zip archive configuration
211
c38eb0a8 212(defcustom archive-zip-use-pkzip (memq system-type '(ms-dos windows-nt))
eeba65ed 213 "*If non-nil then pkzip option are used instead of zip options.
c38eb0a8
RS
214Only set to true for msdog systems!"
215 :type 'boolean
216 :group 'archive-zip)
665211a3 217
c38eb0a8 218(defcustom archive-zip-extract
b48fa570 219 (if archive-zip-use-pkzip '("pkunzip" "-e" "-o-") '("unzip" "-qq" "-c"))
eeba65ed
RS
220 "*Program and its options to run in order to extract a zip file member.
221Extraction should happen to standard output. Archive and member name will
222be added. If `archive-zip-use-pkzip' is non-nil then this program is
c38eb0a8
RS
223expected 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)
665211a3 229
e946e18c 230;; For several reasons the latter behaviour is not desirable in general.
665211a3
KH
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.
234
c38eb0a8 235(defcustom archive-zip-expunge
665211a3
KH
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.
c38eb0a8
RS
238Archive 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)
244
245(defcustom archive-zip-update
665211a3
KH
246 (if archive-zip-use-pkzip '("pkzip" "-u") '("zip" "-q"))
247 "*Program and its options to run in order to update a zip file member.
248Options should ensure that specified directory will be put into the zip
c38eb0a8
RS
249file. 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)
255
256(defcustom archive-zip-update-case
665211a3 257 (if archive-zip-use-pkzip archive-zip-update '("zip" "-q" "-k"))
eeba65ed
RS
258 "*Program and its options to run in order to update a case fiddled zip member.
259Options should ensure that specified directory will be put into the zip file.
c38eb0a8
RS
260Archive 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-case-fiddle t
380683ed
EZ
268 "*If non-nil then zip file members may be down-cased.
269This case fiddling will only happen for members created by a system
270that uses caseless file names."
c38eb0a8
RS
271 :type 'boolean
272 :group 'archive-zip)
665211a3
KH
273;; ------------------------------
274;; Zoo archive configuration
275
c38eb0a8 276(defcustom archive-zoo-extract
665211a3 277 '("zoo" "xpq")
eeba65ed
RS
278 "*Program and its options to run in order to extract a zoo file member.
279Extraction should happen to standard output. Archive and member name will
c38eb0a8
RS
280be added."
281 :type '(list (string :tag "Program")
282 (repeat :tag "Options"
283 :inline t
284 (string :format "%v")))
285 :group 'archive-zoo)
286
287(defcustom archive-zoo-expunge
665211a3
KH
288 '("zoo" "DqPP")
289 "*Program and its options to run in order to delete zoo file members.
c38eb0a8
RS
290Archive 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)
296
297(defcustom archive-zoo-write-file-member
665211a3
KH
298 '("zoo" "a")
299 "*Program and its options to run in order to update a zoo file member.
c38eb0a8
RS
300Archive 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)
665211a3
KH
306;; -------------------------------------------------------------------------
307;; Section: Variables
308
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.")
665211a3
KH
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.")
317
380683ed
EZ
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)
321
322(defvar archive-member-coding-system nil "Coding-system of archive member.")
323(make-variable-buffer-local 'archive-member-coding-system)
324
665211a3
KH
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)
329
330(defvar archive-superior-buffer nil "*In archive members, points to archive.")
331(put 'archive-superior-buffer 'permanent-local t)
332
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)
336
c4de97b4
RS
337(defvar archive-files nil
338 "Vector of file descriptors.
339Each descriptor is a vector of the form
340 [EXT-FILE-NAME INT-FILE-NAME CASE-FIDDLED MODE ...]")
665211a3 341(make-variable-buffer-local 'archive-files)
43f657ea
KH
342
343(defvar archive-lemacs
344 (string-match "\\(Lucid\\|Xemacs\\)" emacs-version)
345 "*Non-nil when running under under Lucid Emacs or Xemacs.")
665211a3
KH
346;; -------------------------------------------------------------------------
347;; Section: Support functions.
348
349(defsubst archive-name (suffix)
350 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))
351
352(defun archive-l-e (str &optional len)
eeba65ed
RS
353 "Convert little endian string/vector to integer.
354Alternatively, first argument may be a buffer position in the current buffer
355in which case a second argument, length, should be supplied."
665211a3
KH
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))
365
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))
385
386(defun archive-calc-mode (oldmode newmode &optional error)
eeba65ed 387 "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
665211a3
KH
388NEWMODE may be an octal number including a leading zero in which case it
389will become the new mode.\n
390NEWMODE may also be a relative specification like \"og-rwx\" in which case
391OLDMODE will be modified accordingly just like chmod(2) would have done.\n
392If optional third argument ERROR is non-nil an error will be signaled if
393the 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))
429 (t
430 (if error
431 (error "Invalid mode specification: %s" newmode)))))
432
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))
439 ""
440 (format "%2d-%s-%d"
441 day
442 (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
443 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
444 year))))
445
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)))
452
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))))
460
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)))
465
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)))
470 0))
471
472(defun archive-get-descr (&optional noerror)
eeba65ed
RS
473 "Return the descriptor vector for file at point.
474Does not signal an error if optional second argument NOERROR is non-nil."
665211a3
KH
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
487
9199a670 488;;;###autoload
665211a3 489(defun archive-mode (&optional force)
eeba65ed
RS
490 "Major mode for viewing an archive file in a dired-like way.
491You can move around using the usual cursor motion commands.
665211a3
KH
492Letters no longer insert themselves.
493Type `e' to pull a file out of the archive and into its own buffer;
494or click mouse-2 on the file's line in the archive mode buffer.
495
496If you edit a sub-file of this archive (as with the `e' command) and
497save it, the contents of that buffer will be saved back into the
498archive.
499
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)
513
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)
665211a3 518
380683ed
EZ
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))
523
665211a3
KH
524 (make-local-variable 'require-final-newline)
525 (setq require-final-newline nil)
526 (make-local-variable 'enable-local-variables)
527 (setq enable-local-variables nil)
665211a3
KH
528
529 (make-local-variable 'archive-read-only)
380683ed
EZ
530 ;; Archives which are inside other archives and whose
531 ;; names are invalid for this OS, can't be written.
532 (setq archive-read-only
533 (or (not (file-writable-p (buffer-file-name)))
534 (and archive-subfile-mode
4dbbd6a1 535 (string-match file-name-invalid-regexp
380683ed 536 (aref archive-subfile-mode 0)))))
665211a3
KH
537
538 ;; Should we use a local copy when accessing from outside Emacs?
539 (make-local-variable 'archive-local-name)
380683ed
EZ
540
541 ;; An archive can contain another archive whose name is invalid
542 ;; on local filesystem. Treat such archives as remote.
543 (or archive-remote
544 (setq archive-remote
545 (or (string-match archive-remote-regexp (buffer-file-name))
4dbbd6a1 546 (string-match file-name-invalid-regexp
380683ed 547 (buffer-file-name)))))
665211a3
KH
548
549 (setq major-mode 'archive-mode)
550 (setq mode-name (concat typename "-Archive"))
551 ;; Run archive-foo-mode-hook and archive-mode-hook
552 (run-hooks (archive-name "mode-hook") 'archive-mode-hook)
553 (use-local-map archive-mode-map))
554
555 (make-local-variable 'archive-proper-file-start)
556 (make-local-variable 'archive-file-list-start)
557 (make-local-variable 'archive-file-list-end)
558 (make-local-variable 'archive-file-name-indent)
380683ed 559 (archive-summarize nil)
665211a3
KH
560 (setq buffer-read-only t))))
561
562;; Archive mode is suitable only for specially formatted data.
563(put 'archive-mode 'mode-class 'special)
564;; -------------------------------------------------------------------------
565;; Section: Key maps
566
567(if archive-mode-map nil
568 (setq archive-mode-map (make-keymap))
569 (suppress-keymap archive-mode-map)
570 (define-key archive-mode-map " " 'archive-next-line)
571 (define-key archive-mode-map "a" 'archive-alternate-display)
572 ;;(define-key archive-mode-map "c" 'archive-copy)
573 (define-key archive-mode-map "d" 'archive-flag-deleted)
574 (define-key archive-mode-map "\C-d" 'archive-flag-deleted)
575 (define-key archive-mode-map "e" 'archive-extract)
576 (define-key archive-mode-map "f" 'archive-extract)
577 (define-key archive-mode-map "\C-m" 'archive-extract)
665211a3
KH
578 (define-key archive-mode-map "g" 'revert-buffer)
579 (define-key archive-mode-map "h" 'describe-mode)
580 (define-key archive-mode-map "m" 'archive-mark)
581 (define-key archive-mode-map "n" 'archive-next-line)
582 (define-key archive-mode-map "\C-n" 'archive-next-line)
583 (define-key archive-mode-map [down] 'archive-next-line)
584 (define-key archive-mode-map "o" 'archive-extract-other-window)
585 (define-key archive-mode-map "p" 'archive-previous-line)
586 (define-key archive-mode-map "\C-p" 'archive-previous-line)
587 (define-key archive-mode-map [up] 'archive-previous-line)
588 (define-key archive-mode-map "r" 'archive-rename-entry)
589 (define-key archive-mode-map "u" 'archive-unflag)
590 (define-key archive-mode-map "\M-\C-?" 'archive-unmark-all-files)
591 (define-key archive-mode-map "v" 'archive-view)
592 (define-key archive-mode-map "x" 'archive-expunge)
593 (define-key archive-mode-map "\177" 'archive-unflag-backwards)
594 (define-key archive-mode-map "E" 'archive-extract-other-window)
595 (define-key archive-mode-map "M" 'archive-chmod-entry)
596 (define-key archive-mode-map "G" 'archive-chgrp-entry)
597 (define-key archive-mode-map "O" 'archive-chown-entry)
43f657ea
KH
598
599 (if archive-lemacs
600 (progn
601 ;; Not a nice "solution" but it'll have to do
602 (define-key archive-mode-map "\C-xu" 'archive-undo)
603 (define-key archive-mode-map "\C-_" 'archive-undo))
604 (substitute-key-definition 'undo 'archive-undo
605 archive-mode-map global-map))
606
607 (define-key archive-mode-map
608 (if archive-lemacs 'button2 [mouse-2]) 'archive-mouse-extract)
609
610 (if archive-lemacs
611 () ; out of luck
612 ;; Get rid of the Edit menu bar item to save space.
613 (define-key archive-mode-map [menu-bar edit] 'undefined)
614
615 (define-key archive-mode-map [menu-bar immediate]
616 (cons "Immediate" (make-sparse-keymap "Immediate")))
617 (define-key archive-mode-map [menu-bar immediate alternate]
618 '("Alternate Display" . archive-alternate-display))
619 (put 'archive-alternate-display 'menu-enable
620 '(boundp (archive-name "alternate-display")))
621 (define-key archive-mode-map [menu-bar immediate view]
622 '("View This File" . archive-view))
623 (define-key archive-mode-map [menu-bar immediate display]
624 '("Display in Other Window" . archive-display-other-window))
625 (define-key archive-mode-map [menu-bar immediate find-file-other-window]
626 '("Find in Other Window" . archive-extract-other-window))
627 (define-key archive-mode-map [menu-bar immediate find-file]
628 '("Find This File" . archive-extract))
629
630 (define-key archive-mode-map [menu-bar mark]
631 (cons "Mark" (make-sparse-keymap "Mark")))
632 (define-key archive-mode-map [menu-bar mark unmark-all]
633 '("Unmark All" . archive-unmark-all-files))
634 (define-key archive-mode-map [menu-bar mark deletion]
635 '("Flag" . archive-flag-deleted))
636 (define-key archive-mode-map [menu-bar mark unmark]
637 '("Unflag" . archive-unflag))
638 (define-key archive-mode-map [menu-bar mark mark]
639 '("Mark" . archive-mark))
640
641 (define-key archive-mode-map [menu-bar operate]
642 (cons "Operate" (make-sparse-keymap "Operate")))
643 (define-key archive-mode-map [menu-bar operate chown]
644 '("Change Owner..." . archive-chown-entry))
645 (put 'archive-chown-entry 'menu-enable
646 '(fboundp (archive-name "chown-entry")))
647 (define-key archive-mode-map [menu-bar operate chgrp]
648 '("Change Group..." . archive-chgrp-entry))
649 (put 'archive-chgrp-entry 'menu-enable
650 '(fboundp (archive-name "chgrp-entry")))
651 (define-key archive-mode-map [menu-bar operate chmod]
652 '("Change Mode..." . archive-chmod-entry))
653 (put 'archive-chmod-entry 'menu-enable
654 '(fboundp (archive-name "chmod-entry")))
655 (define-key archive-mode-map [menu-bar operate rename]
656 '("Rename to..." . archive-rename-entry))
657 (put 'archive-rename-entry 'menu-enable
658 '(fboundp (archive-name "rename-entry")))
659 ;;(define-key archive-mode-map [menu-bar operate copy]
660 ;; '("Copy to..." . archive-copy))
661 (define-key archive-mode-map [menu-bar operate expunge]
662 '("Expunge Marked Files" . archive-expunge))
663 ))
665211a3
KH
664
665(let* ((item1 '(archive-subfile-mode " Archive"))
b48fa570 666 (items (list item1)))
665211a3
KH
667 (or (member item1 minor-mode-alist)
668 (setq minor-mode-alist (append items minor-mode-alist))))
669;; -------------------------------------------------------------------------
670(defun archive-find-type ()
671 (widen)
672 (goto-char (point-min))
673 ;; The funny [] here make it unlikely that the .elc file will be treated
674 ;; as an archive by other software.
675 (let (case-fold-search)
676 (cond ((looking-at "[P]K\003\004") 'zip)
a56636ae 677 ((looking-at "..-l[hz][0-9ds]-") 'lzh)
665211a3
KH
678 ((looking-at "....................[\334]\247\304\375") 'zoo)
679 ((and (looking-at "\C-z") ; signature too simple, IMHO
680 (string-match "\\.[aA][rR][cC]$"
681 (or buffer-file-name (buffer-name))))
682 'arc)
683 (t (error "Buffer format not recognized.")))))
684;; -------------------------------------------------------------------------
380683ed 685(defun archive-summarize (&optional shut-up)
665211a3
KH
686 "Parse the contents of the archive file in the current buffer.
687Place a dired-like listing on the front;
688then narrow to it, so that only that listing
380683ed
EZ
689is visible (and the real data of the buffer is hidden).
690Optional argument SHUT-UP, if non-nil, means don't print messages
691when parsing the archive."
665211a3
KH
692 (widen)
693 (let (buffer-read-only)
380683ed
EZ
694 (or shut-up
695 (message "Parsing archive file..."))
665211a3
KH
696 (buffer-disable-undo (current-buffer))
697 (setq archive-files (funcall (archive-name "summarize")))
380683ed
EZ
698 (or shut-up
699 (message "Parsing archive file...done."))
665211a3
KH
700 (setq archive-proper-file-start (point-marker))
701 (narrow-to-region (point-min) (point))
702 (set-buffer-modified-p nil)
703 (buffer-enable-undo))
704 (goto-char archive-file-list-start)
705 (archive-next-line 0))
706
707(defun archive-resummarize ()
708 "Recreate the contents listing of an archive."
709 (let ((modified (buffer-modified-p))
710 (no (archive-get-lineno))
711 buffer-read-only)
712 (widen)
713 (delete-region (point-min) archive-proper-file-start)
380683ed 714 (archive-summarize t)
665211a3
KH
715 (set-buffer-modified-p modified)
716 (goto-char archive-file-list-start)
717 (archive-next-line no)))
718
719(defun archive-summarize-files (files)
c4de97b4 720 "Insert a description of a list of files annotated with proper mouse face."
665211a3
KH
721 (setq archive-file-list-start (point-marker))
722 (setq archive-file-name-indent (if files (aref (car files) 1) 0))
723 ;; We don't want to do an insert for each element since that takes too
724 ;; long when the archive -- which has to be moved in memory -- is large.
725 (insert
726 (apply
727 (function concat)
728 (mapcar
43f657ea
KH
729 (function
730 (lambda (fil)
731 ;; Using `concat' here copies the text also, so we can add
732 ;; properties without problems.
733 (let ((text (concat (aref fil 0) "\n")))
734 (if archive-lemacs
735 () ; out of luck
736 (put-text-property (aref fil 1) (aref fil 2)
737 'mouse-face 'highlight
738 text))
739 text)))
665211a3
KH
740 files)))
741 (setq archive-file-list-end (point-marker)))
742
743(defun archive-alternate-display ()
eeba65ed
RS
744 "Toggle alternative display.
745To avoid very long lines some archive mode don't show all information.
746This function changes the set of information shown for each files."
665211a3
KH
747 (interactive)
748 (setq archive-alternate-display (not archive-alternate-display))
749 (archive-resummarize))
750;; -------------------------------------------------------------------------
751;; Section: Local archive copy handling
752
380683ed
EZ
753(defun archive-unique-fname (fname dir)
754 "Make sure a file FNAME can be created uniquely in directory DIR.
755
756If FNAME can be uniquely created in DIR, it is returned unaltered.
757If FNAME is something our underlying filesystem can't grok, or if another
758file by that name already exists in DIR, a unique new name is generated
759using `make-temp-name', and the generated name is returned."
760 (let ((fullname (expand-file-name fname dir))
4dbbd6a1 761 (alien (string-match file-name-invalid-regexp fname)))
380683ed
EZ
762 (if (or alien (file-exists-p fullname))
763 (make-temp-name
764 (expand-file-name
765 (if (and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
766 "am"
767 "arc-mode.")
768 dir))
769 fullname)))
770
665211a3 771(defun archive-maybe-copy (archive)
380683ed
EZ
772 (let ((coding-system-for-write 'no-conversion))
773 (if archive-remote
774 (let ((start (point-max))
775 ;; Sometimes ARCHIVE is invalid while its actual name, as
776 ;; recorded in its parent archive, is not. For example, an
777 ;; archive bar.zip inside another archive foo.zip gets a name
778 ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
779 ;; So use the actual name if available.
780 (archive-name
781 (or (and archive-subfile-mode (aref archive-subfile-mode 0))
782 archive)))
783 (make-directory archive-tmpdir t)
784 (setq archive-local-name
785 (archive-unique-fname archive-name archive-tmpdir))
786 (save-restriction
787 (widen)
788 (write-region start (point-max) archive-local-name nil 'nomessage))
789 archive-local-name)
790 (if (buffer-modified-p) (save-buffer))
791 archive)))
665211a3
KH
792
793(defun archive-maybe-update (unchanged)
794 (if archive-remote
795 (let ((name archive-local-name)
796 (modified (buffer-modified-p))
380683ed
EZ
797 (coding-system-for-read 'no-conversion)
798 (lno (archive-get-lineno))
665211a3
KH
799 buffer-read-only)
800 (if unchanged nil
380683ed 801 (setq archive-files nil)
665211a3
KH
802 (erase-buffer)
803 (insert-file-contents name)
380683ed
EZ
804 (archive-mode t)
805 (goto-char archive-file-list-start)
806 (archive-next-line lno))
665211a3
KH
807 (archive-delete-local name)
808 (if (not unchanged)
380683ed
EZ
809 (message
810 "Buffer `%s' must be saved for changes to take effect"
811 (buffer-name (current-buffer))))
665211a3
KH
812 (set-buffer-modified-p (or modified (not unchanged))))))
813
814(defun archive-delete-local (name)
eeba65ed 815 "Delete file NAME and its parents up to and including `archive-tmpdir'."
665211a3
KH
816 (let ((again t)
817 (top (directory-file-name (file-name-as-directory archive-tmpdir))))
818 (condition-case nil
819 (delete-file name)
820 (error nil))
821 (while again
822 (setq name (directory-file-name (file-name-directory name)))
823 (condition-case nil
824 (delete-directory name)
825 (error nil))
826 (if (string= name top) (setq again nil)))))
827;; -------------------------------------------------------------------------
828;; Section: Member extraction
829
830(defun archive-mouse-extract (event)
831 "Extract a file whose name you click on."
832 (interactive "e")
43f657ea
KH
833 (mouse-set-point event)
834 (switch-to-buffer
835 (save-excursion
836 (archive-extract)
837 (current-buffer))))
665211a3
KH
838
839(defun archive-extract (&optional other-window-p)
840 "In archive mode, extract this entry of the archive into its own buffer."
841 (interactive)
842 (let* ((view-p (eq other-window-p 'view))
843 (descr (archive-get-descr))
844 (ename (aref descr 0))
845 (iname (aref descr 1))
846 (archive-buffer (current-buffer))
847 (arcdir default-directory)
848 (archive (buffer-file-name))
849 (arcname (file-name-nondirectory archive))
850 (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
851 (extractor (archive-name "extract"))
380683ed
EZ
852 ;; Members with file names which aren't valid for the
853 ;; underlying filesystem, are treated as read-only.
854 (read-only-p (or archive-read-only
855 view-p
4dbbd6a1 856 (string-match file-name-invalid-regexp ename)))
665211a3
KH
857 (buffer (get-buffer bufname))
858 (just-created nil))
859 (if buffer
860 nil
861 (setq archive (archive-maybe-copy archive))
862 (setq buffer (get-buffer-create bufname))
863 (setq just-created t)
864 (save-excursion
865 (set-buffer buffer)
866 (setq buffer-file-name
867 (expand-file-name (concat arcname ":" iname)))
868 (setq buffer-file-truename
869 (abbreviate-file-name buffer-file-name))
870 ;; Set the default-directory to the dir of the superior buffer.
871 (setq default-directory arcdir)
872 (make-local-variable 'archive-superior-buffer)
873 (setq archive-superior-buffer archive-buffer)
874 (make-local-variable 'local-write-file-hooks)
875 (add-hook 'local-write-file-hooks 'archive-write-file-member)
876 (setq archive-subfile-mode descr)
b48fa570
EZ
877 (if (and
878 (null
879 (if (fboundp extractor)
880 (funcall extractor archive ename)
881 (archive-*-extract archive ename (symbol-value extractor))))
882 just-created)
883 (progn
884 (set-buffer-modified-p nil)
885 (kill-buffer buffer))
886 (goto-char (point-min))
887 (rename-buffer bufname)
888 (setq buffer-read-only read-only-p)
889 (setq buffer-undo-list nil)
890 (set-buffer-modified-p nil)
891 (setq buffer-saved-size (buffer-size))
892 (normal-mode)
893 ;; Just in case an archive occurs inside another archive.
894 (if (eq major-mode 'archive-mode)
380683ed
EZ
895 (progn
896 (setq archive-remote t)
897 (if read-only-p (setq archive-read-only t))
898 ;; We will write out the archive ourselves if it is
899 ;; part of another archive.
900 (remove-hook 'write-contents-hooks 'archive-write-file t)))
901 (run-hooks 'archive-extract-hooks)
902 (if archive-read-only
903 (message "Note: altering this archive is not implemented."))))
904 (archive-maybe-update t))
b48fa570
EZ
905 (or (not (buffer-name buffer))
906 (progn
907 (if view-p
5f7493ac
KH
908 (view-buffer buffer (and just-created 'kill-buffer))
909 (if (eq other-window-p 'display)
910 (display-buffer buffer)
911 (if other-window-p
912 (switch-to-buffer-other-window buffer)
913 (switch-to-buffer buffer))))))))
665211a3
KH
914
915(defun archive-*-extract (archive name command)
916 (let* ((default-directory (file-name-as-directory archive-tmpdir))
917 (tmpfile (expand-file-name (file-name-nondirectory name)
b48fa570
EZ
918 default-directory))
919 exit-status success)
665211a3 920 (make-directory (directory-file-name default-directory) t)
b48fa570
EZ
921 (setq exit-status
922 (apply 'call-process
923 (car command)
924 nil
925 nil
926 nil
927 (append (cdr command) (list archive name))))
928 (cond ((and (numberp exit-status) (= exit-status 0))
929 (if (not (file-exists-p tmpfile))
930 (ding (message "`%s': no such file or directory" tmpfile))
931 (insert-file-contents tmpfile)
932 (setq success t)))
933 ((numberp exit-status)
934 (ding
935 (message "`%s' exited with status %d" (car command) exit-status)))
936 ((stringp exit-status)
937 (ding (message "`%s' aborted: %s" (car command) exit-status)))
938 (t
939 (ding (message "`%s' failed" (car command)))))
940 (archive-delete-local tmpfile)
941 success))
665211a3
KH
942
943(defun archive-extract-by-stdout (archive name command)
b48fa570
EZ
944 ;; We need the coding system of the output of the extract program,
945 ;; including the EOL encoding, be decoded dynamically, since what
946 ;; the extract program outputs is the contents of some file.
947 (let ((coding-system-for-read (or coding-system-for-read 'undecided))
948 (inherit-process-coding-system t))
665211a3
KH
949 (apply 'call-process
950 (car command)
951 nil
952 t
953 nil
954 (append (cdr command) (list archive name)))))
955
956(defun archive-extract-other-window ()
957 "In archive mode, find this member in another window."
958 (interactive)
959 (archive-extract t))
960
961(defun archive-display-other-window ()
962 "In archive mode, display this member in another window."
963 (interactive)
964 (archive-extract 'display))
965
966(defun archive-view ()
967 "In archive mode, view the member on this line."
968 (interactive)
969 (archive-extract 'view))
970
971(defun archive-add-new-member (arcbuf name)
eeba65ed 972 "Add current buffer to the archive in ARCBUF naming it NAME."
665211a3
KH
973 (interactive
974 (list (get-buffer
975 (read-buffer "Buffer containing archive: "
976 ;; Find first archive buffer and suggest that
977 (let ((bufs (buffer-list)))
978 (while (and bufs (not (eq (save-excursion
979 (set-buffer (car bufs))
980 major-mode)
981 'archive-mode)))
982 (setq bufs (cdr bufs)))
983 (if bufs
984 (car bufs)
985 (error "There are no archive buffers")))
986 t))
987 (read-string "File name in archive: "
988 (if buffer-file-name
989 (file-name-nondirectory buffer-file-name)
990 ""))))
991 (save-excursion
992 (set-buffer arcbuf)
993 (or (eq major-mode 'archive-mode)
994 (error "Buffer is not an archive buffer"))
995 (if archive-read-only
996 (error "Archive is read-only")))
997 (if (eq arcbuf (current-buffer))
998 (error "An archive buffer cannot be added to itself"))
999 (if (string= name "")
1000 (error "Archive members may not be given empty names"))
1001 (let ((func (save-excursion (set-buffer arcbuf)
1002 (archive-name "add-new-member")))
1003 (membuf (current-buffer)))
1004 (if (fboundp func)
1005 (save-excursion
1006 (set-buffer arcbuf)
1007 (funcall func buffer-file-name membuf name))
1008 (error "Adding a new member is not supported for this archive type"))))
1009;; -------------------------------------------------------------------------
1010;; Section: IO stuff
1011
665211a3 1012(defun archive-write-file-member ()
b48fa570
EZ
1013 (save-excursion
1014 (save-restriction
1015 (message "Updating archive...")
1016 (widen)
1017 (let ((writer (save-excursion (set-buffer archive-superior-buffer)
1018 (archive-name "write-file-member")))
1019 (archive (save-excursion (set-buffer archive-superior-buffer)
380683ed 1020 (archive-maybe-copy (buffer-file-name)))))
b48fa570
EZ
1021 (if (fboundp writer)
1022 (funcall writer archive archive-subfile-mode)
1023 (archive-*-write-file-member archive
1024 archive-subfile-mode
380683ed
EZ
1025 (symbol-value writer)))
1026 (set-buffer-modified-p nil)
1027 (message "Updating archive...done"))
b48fa570 1028 (set-buffer archive-superior-buffer)
380683ed
EZ
1029 (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
1030 ;; Restore the value of last-coding-system-used, so that basic-save-buffer
1031 ;; won't reset the coding-system of this archive member.
1032 (if (local-variable-p 'archive-member-coding-system)
1033 (setq last-coding-system-used archive-member-coding-system))
1034 t)
665211a3
KH
1035
1036(defun archive-*-write-file-member (archive descr command)
1037 (let* ((ename (aref descr 0))
1038 (tmpfile (expand-file-name ename archive-tmpdir))
1039 (top (directory-file-name (file-name-as-directory archive-tmpdir)))
1040 (default-directory (file-name-as-directory top)))
1041 (unwind-protect
1042 (progn
1043 (make-directory (file-name-directory tmpfile) t)
380683ed
EZ
1044 ;; If the member is itself an archive, write it without
1045 ;; the dired-like listing we created.
1046 (if (eq major-mode 'archive-mode)
1047 (archive-write-file tmpfile)
1048 (write-region (point-min) (point-max) tmpfile nil 'nomessage))
1049 ;; basic-save-buffer needs last-coding-system-used to have
1050 ;; the value used to write the file, so save it before any
1051 ;; further processing clobbers it (we restore it in
1052 ;; archive-write-file-member, above).
1053 (setq archive-member-coding-system last-coding-system-used)
665211a3
KH
1054 (if (aref descr 3)
1055 ;; Set the file modes, but make sure we can read it.
1056 (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1057 (let ((exitcode (apply 'call-process
1058 (car command)
1059 nil
1060 nil
1061 nil
1062 (append (cdr command) (list archive ename)))))
1063 (if (equal exitcode 0)
1064 nil
1065 (error "Updating was unsuccessful (%S)" exitcode))))
1066 (archive-delete-local tmpfile))))
1067
380683ed 1068(defun archive-write-file (&optional file)
665211a3 1069 (save-excursion
380683ed
EZ
1070 (let ((coding-system-for-write 'no-conversion))
1071 (write-region archive-proper-file-start (point-max)
1072 (or file buffer-file-name) nil t)
1073 (set-buffer-modified-p nil))
665211a3
KH
1074 t))
1075;; -------------------------------------------------------------------------
1076;; Section: Marking and unmarking.
1077
1078(defun archive-flag-deleted (p &optional type)
1079 "In archive mode, mark this member to be deleted from the archive.
1080With a prefix argument, mark that many files."
1081 (interactive "p")
1082 (or type (setq type ?D))
1083 (beginning-of-line)
1084 (let ((sign (if (>= p 0) +1 -1))
1085 (modified (buffer-modified-p))
1086 buffer-read-only)
1087 (while (not (zerop p))
1088 (if (archive-get-descr t)
1089 (progn
1090 (delete-char 1)
1091 (insert type)))
1092 (forward-line sign)
1093 (setq p (- p sign)))
1094 (set-buffer-modified-p modified))
1095 (archive-next-line 0))
1096
1097(defun archive-unflag (p)
1098 "In archive mode, un-mark this member if it is marked to be deleted.
1099With a prefix argument, un-mark that many files forward."
1100 (interactive "p")
1101 (archive-flag-deleted p ? ))
1102
1103(defun archive-unflag-backwards (p)
1104 "In archive mode, un-mark this member if it is marked to be deleted.
1105With a prefix argument, un-mark that many members backward."
1106 (interactive "p")
1107 (archive-flag-deleted (- p) ? ))
1108
1109(defun archive-unmark-all-files ()
1110 "Remove all marks."
1111 (interactive)
1112 (let ((modified (buffer-modified-p))
1113 buffer-read-only)
1114 (save-excursion
1115 (goto-char archive-file-list-start)
1116 (while (< (point) archive-file-list-end)
1117 (or (= (following-char) ? )
1118 (progn (delete-char 1) (insert ? )))
1119 (forward-line 1)))
1120 (set-buffer-modified-p modified)))
1121
1122(defun archive-mark (p)
1123 "In archive mode, mark this member for group operations.
1124With a prefix argument, mark that many members.
1125Use \\[archive-unmark-all-files] to remove all marks."
1126 (interactive "p")
1127 (archive-flag-deleted p ?*))
1128
1129(defun archive-get-marked (mark &optional default)
1130 (let (files)
1131 (save-excursion
1132 (goto-char archive-file-list-start)
1133 (while (< (point) archive-file-list-end)
1134 (if (= (following-char) mark)
1135 (setq files (cons (archive-get-descr) files)))
1136 (forward-line 1)))
1137 (or (nreverse files)
1138 (and default
1139 (list (archive-get-descr))))))
1140;; -------------------------------------------------------------------------
1141;; Section: Operate
1142
1143(defun archive-next-line (p)
1144 (interactive "p")
1145 (forward-line p)
1146 (or (eobp)
1147 (forward-char archive-file-name-indent)))
1148
1149(defun archive-previous-line (p)
1150 (interactive "p")
1151 (archive-next-line (- p)))
1152
1153(defun archive-chmod-entry (new-mode)
eeba65ed 1154 "Change the protection bits associated with all marked or this member.
665211a3
KH
1155The new protection bits can either be specified as an octal number or
1156as a relative change like \"g+rw\" as for chmod(2)"
1157 (interactive "sNew mode (octal or relative): ")
1158 (if archive-read-only (error "Archive is read-only"))
1159 (let ((func (archive-name "chmod-entry")))
1160 (if (fboundp func)
1161 (progn
1162 (funcall func new-mode (archive-get-marked ?* t))
1163 (archive-resummarize))
1164 (error "Setting mode bits is not supported for this archive type"))))
1165
1166(defun archive-chown-entry (new-uid)
1167 "Change the owner of all marked or this member."
1168 (interactive "nNew uid: ")
1169 (if archive-read-only (error "Archive is read-only"))
1170 (let ((func (archive-name "chown-entry")))
1171 (if (fboundp func)
1172 (progn
1173 (funcall func new-uid (archive-get-marked ?* t))
1174 (archive-resummarize))
1175 (error "Setting owner is not supported for this archive type"))))
1176
1177(defun archive-chgrp-entry (new-gid)
1178 "Change the group of all marked or this member."
1179 (interactive "nNew gid: ")
1180 (if archive-read-only (error "Archive is read-only"))
1181 (let ((func (archive-name "chgrp-entry")))
1182 (if (fboundp func)
1183 (progn
1184 (funcall func new-gid (archive-get-marked ?* t))
1185 (archive-resummarize))
1186 (error "Setting group is not supported for this archive type"))))
1187
1188(defun archive-expunge ()
1189 "Do the flagged deletions."
1190 (interactive)
1191 (let (files)
1192 (save-excursion
1193 (goto-char archive-file-list-start)
1194 (while (< (point) archive-file-list-end)
1195 (if (= (following-char) ?D)
1196 (setq files (cons (aref (archive-get-descr) 0) files)))
1197 (forward-line 1)))
1198 (setq files (nreverse files))
1199 (and files
1200 (or (not archive-read-only)
1201 (error "Archive is read-only"))
1202 (or (yes-or-no-p (format "Really delete %d member%s? "
1203 (length files)
1204 (if (null (cdr files)) "" "s")))
1205 (error "Operation aborted"))
1206 (let ((archive (archive-maybe-copy (buffer-file-name)))
1207 (expunger (archive-name "expunge")))
1208 (if (fboundp expunger)
1209 (funcall expunger archive files)
1210 (archive-*-expunge archive files (symbol-value expunger)))
1211 (archive-maybe-update nil)
1212 (if archive-remote
1213 (archive-resummarize)
1214 (revert-buffer))))))
1215
1216(defun archive-*-expunge (archive files command)
1217 (apply 'call-process
1218 (car command)
1219 nil
1220 nil
1221 nil
1222 (append (cdr command) (cons archive files))))
1223
1224(defun archive-rename-entry (newname)
1225 "Change the name associated with this entry in the tar file."
1226 (interactive "sNew name: ")
1227 (if archive-read-only (error "Archive is read-only"))
1228 (if (string= newname "")
1229 (error "Archive members may not be given empty names"))
1230 (let ((func (archive-name "rename-entry"))
1231 (descr (archive-get-descr)))
1232 (if (fboundp func)
1233 (progn
1234 (funcall func (buffer-file-name) newname descr)
1235 (archive-resummarize))
1236 (error "Renaming is not supported for this archive type"))))
1237
1238;; Revert the buffer and recompute the dired-like listing.
1239(defun archive-mode-revert (&optional no-autosave no-confirm)
1240 (let ((no (archive-get-lineno)))
1241 (setq archive-files nil)
380683ed
EZ
1242 (let ((revert-buffer-function nil)
1243 (coding-system-for-read 'no-conversion))
665211a3
KH
1244 (revert-buffer t t))
1245 (archive-mode)
1246 (goto-char archive-file-list-start)
1247 (archive-next-line no)))
1248
1249(defun archive-undo ()
1250 "Undo in an archive buffer.
1251This doesn't recover lost files, it just undoes changes in the buffer itself."
1252 (interactive)
1253 (let (buffer-read-only)
1254 (undo)))
1255;; -------------------------------------------------------------------------
1256;; Section: Arc Archives
1257
1258(defun archive-arc-summarize ()
1259 (let ((p 1)
1260 (totalsize 0)
1261 (maxlen 8)
1262 files
1263 visual)
1264 (while (and (< (+ p 29) (point-max))
1265 (= (char-after p) ?\C-z)
1266 (> (char-after (1+ p)) 0))
1267 (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13)))
1268 (fnlen (or (string-match "\0" namefld) 13))
1269 (efnname (substring namefld 0 fnlen))
1270 (csize (archive-l-e (+ p 15) 4))
1271 (moddate (archive-l-e (+ p 19) 2))
1272 (modtime (archive-l-e (+ p 21) 2))
1273 (ucsize (archive-l-e (+ p 25) 4))
1274 (fiddle (string= efnname (upcase efnname)))
1275 (ifnname (if fiddle (downcase efnname) efnname))
1276 (text (format " %8d %-11s %-8s %s"
1277 ucsize
1278 (archive-dosdate moddate)
1279 (archive-dostime modtime)
1280 ifnname)))
1281 (setq maxlen (max maxlen fnlen)
1282 totalsize (+ totalsize ucsize)
1283 visual (cons (vector text
1284 (- (length text) (length ifnname))
1285 (length text))
1286 visual)
1287 files (cons (vector efnname ifnname fiddle nil (1- p))
1288 files)
1289 p (+ p 29 csize))))
1290 (goto-char (point-min))
1291 (let ((dash (concat "- -------- ----------- -------- "
1292 (make-string maxlen ?-)
1293 "\n")))
1294 (insert "M Length Date Time File\n"
1295 dash)
1296 (archive-summarize-files (nreverse visual))
1297 (insert dash
1298 (format " %8d %d file%s"
1299 totalsize
1300 (length files)
1301 (if (= 1 (length files)) "" "s"))
1302 "\n"))
1303 (apply 'vector (nreverse files))))
1304
1305(defun archive-arc-rename-entry (archive newname descr)
1306 (if (string-match "[:\\\\/]" newname)
1307 (error "File names in arc files may not contain a path"))
1308 (if (> (length newname) 12)
1309 (error "File names in arc files are limited to 12 characters"))
1310 (let ((name (concat newname (substring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
1311 (length newname))))
1312 buffer-read-only)
1313 (save-restriction
1314 (save-excursion
1315 (widen)
1316 (goto-char (+ archive-proper-file-start (aref descr 4) 2))
1317 (delete-char 13)
1318 (insert name)))))
1319;; -------------------------------------------------------------------------
1320;; Section: Lzh Archives
1321
1322(defun archive-lzh-summarize ()
1323 (let ((p 1)
1324 (totalsize 0)
1325 (maxlen 8)
1326 files
1327 visual)
a56636ae
RS
1328 (while (progn (goto-char p)
1329 (looking-at "\\(.\\|\n\\)\\(.\\|\n\\)-l[hz][0-9ds]-"))
665211a3
KH
1330 (let* ((hsize (char-after p))
1331 (csize (archive-l-e (+ p 7) 4))
1332 (ucsize (archive-l-e (+ p 11) 4))
1333 (modtime (archive-l-e (+ p 15) 2))
1334 (moddate (archive-l-e (+ p 17) 2))
a56636ae 1335 (hdrlvl (char-after (+ p 20)))
665211a3
KH
1336 (fnlen (char-after (+ p 21)))
1337 (efnname (buffer-substring (+ p 22) (+ p 22 fnlen)))
1338 (fiddle (string= efnname (upcase efnname)))
1339 (ifnname (if fiddle (downcase efnname) efnname))
1340 (p2 (+ p 22 fnlen))
1341 (creator (if (>= (- hsize fnlen) 24) (char-after (+ p2 2)) 0))
a56636ae
RS
1342 mode modestr uid gid text path prname
1343 )
1344 (if (= hdrlvl 0)
1345 (setq mode (if (= creator ?U) (archive-l-e (+ p2 8) 2) ?\666)
1346 uid (if (= creator ?U) (archive-l-e (+ p2 10) 2))
1347 gid (if (= creator ?U) (archive-l-e (+ p2 12) 2)))
1348 (if (= creator ?U)
1349 (let* ((p3 (+ p2 3))
1350 (hsize (archive-l-e p3 2))
1351 (etype (char-after (+ p3 2))))
1352 (while (not (= hsize 0))
1353 (cond
1354 ((= etype 2) (let ((i (+ p3 3)))
1355 (while (< i (+ p3 hsize))
1356 (setq path (concat path
1357 (if (= (char-after i)
1358 255)
1359 "/"
1360 (char-to-string
1361 (char-after i)))))
1362 (setq i (1+ i)))))
1363 ((= etype 80) (setq mode (archive-l-e (+ p3 3) 2)))
1364 ((= etype 81) (progn (setq uid (archive-l-e (+ p3 3) 2))
1365 (setq gid (archive-l-e (+ p3 5) 2))))
1366 )
1367 (setq p3 (+ p3 hsize))
1368 (setq hsize (archive-l-e p3 2))
1369 (setq etype (char-after (+ p3 2)))))))
1370 (setq prname (if path (concat path ifnname) ifnname))
1371 (setq modestr (if mode (archive-int-to-mode mode) "??????????"))
1372 (setq text (if archive-alternate-display
665211a3
KH
1373 (format " %8d %5S %5S %s"
1374 ucsize
1375 (or uid "?")
1376 (or gid "?")
1377 ifnname)
1378 (format " %10s %8d %-11s %-8s %s"
1379 modestr
1380 ucsize
1381 (archive-dosdate moddate)
1382 (archive-dostime modtime)
a56636ae 1383 ifnname)))
665211a3
KH
1384 (setq maxlen (max maxlen fnlen)
1385 totalsize (+ totalsize ucsize)
1386 visual (cons (vector text
1387 (- (length text) (length ifnname))
1388 (length text))
1389 visual)
a56636ae 1390 files (cons (vector prname ifnname fiddle mode (1- p))
665211a3
KH
1391 files)
1392 p (+ p hsize 2 csize))))
1393 (goto-char (point-min))
1394 (let ((dash (concat (if archive-alternate-display
1395 "- -------- ----- ----- "
1396 "- ---------- -------- ----------- -------- ")
1397 (make-string maxlen ?-)
1398 "\n"))
1399 (header (if archive-alternate-display
1400 "M Length Uid Gid File\n"
1401 "M Filemode Length Date Time File\n"))
1402 (sumline (if archive-alternate-display
1403 " %8d %d file%s"
1404 " %8d %d file%s")))
1405 (insert header dash)
1406 (archive-summarize-files (nreverse visual))
1407 (insert dash
1408 (format sumline
1409 totalsize
1410 (length files)
1411 (if (= 1 (length files)) "" "s"))
1412 "\n"))
1413 (apply 'vector (nreverse files))))
1414
1415(defconst archive-lzh-alternate-display t)
1416
1417(defun archive-lzh-extract (archive name)
1418 (archive-extract-by-stdout archive name archive-lzh-extract))
1419
1420(defun archive-lzh-resum (p count)
1421 (let ((sum 0))
1422 (while (> count 0)
1423 (setq count (1- count)
1424 sum (+ sum (char-after p))
1425 p (1+ p)))
1426 (logand sum 255)))
1427
1428(defun archive-lzh-rename-entry (archive newname descr)
1429 (save-restriction
1430 (save-excursion
1431 (widen)
1432 (let* ((p (+ archive-proper-file-start (aref descr 4)))
1433 (oldhsize (char-after p))
1434 (oldfnlen (char-after (+ p 21)))
1435 (newfnlen (length newname))
1436 (newhsize (+ oldhsize newfnlen (- oldfnlen)))
1437 buffer-read-only)
1438 (if (> newhsize 255)
1439 (error "The file name is too long"))
1440 (goto-char (+ p 21))
1441 (delete-char (1+ oldfnlen))
1442 (insert newfnlen newname)
1443 (goto-char p)
1444 (delete-char 2)
1445 (insert newhsize (archive-lzh-resum p newhsize))))))
1446
1447(defun archive-lzh-ogm (newval files errtxt ofs)
1448 (save-restriction
1449 (save-excursion
1450 (widen)
1451 (while files
1452 (let* ((fil (car files))
1453 (p (+ archive-proper-file-start (aref fil 4)))
1454 (hsize (char-after p))
1455 (fnlen (char-after (+ p 21)))
1456 (p2 (+ p 22 fnlen))
1457 (creator (if (>= (- hsize fnlen) 24) (char-after (+ p2 2)) 0))
1458 buffer-read-only)
1459 (if (= creator ?U)
1460 (progn
1461 (or (numberp newval)
1462 (setq newval (funcall newval (archive-l-e (+ p2 ofs) 2))))
1463 (goto-char (+ p2 ofs))
1464 (delete-char 2)
1465 (insert (logand newval 255) (lsh newval -8))
1466 (goto-char (1+ p))
1467 (delete-char 1)
1468 (insert (archive-lzh-resum (1+ p) hsize)))
1469 (message "Member %s does not have %s field"
1470 (aref fil 1) errtxt)))
1471 (setq files (cdr files))))))
1472
1473(defun archive-lzh-chown-entry (newuid files)
1474 (archive-lzh-ogm newuid files "an uid" 10))
1475
1476(defun archive-lzh-chgrp-entry (newgid files)
1477 (archive-lzh-ogm newgid files "a gid" 12))
1478
1479(defun archive-lzh-chmod-entry (newmode files)
1480 (archive-lzh-ogm
1481 ;; This should work even though newmode will be dynamically accessed.
43f657ea 1482 (function (lambda (old) (archive-calc-mode old newmode t)))
665211a3
KH
1483 files "a unix-style mode" 8))
1484;; -------------------------------------------------------------------------
1485;; Section: Zip Archives
1486
1487(defun archive-zip-summarize ()
1488 (goto-char (- (point-max) (- 22 18)))
1489 (search-backward-regexp "[P]K\005\006")
1490 (let ((p (1+ (archive-l-e (+ (point) 16) 4)))
1491 (maxlen 8)
1492 (totalsize 0)
1493 files
1494 visual)
1495 (while (string= "PK\001\002" (buffer-substring p (+ p 4)))
1496 (let* ((creator (char-after (+ p 5)))
1497 (method (archive-l-e (+ p 10) 2))
1498 (modtime (archive-l-e (+ p 12) 2))
1499 (moddate (archive-l-e (+ p 14) 2))
1500 (ucsize (archive-l-e (+ p 24) 4))
1501 (fnlen (archive-l-e (+ p 28) 2))
1502 (exlen (archive-l-e (+ p 30) 2))
845720b9 1503 (fclen (archive-l-e (+ p 32) 2))
665211a3
KH
1504 (lheader (archive-l-e (+ p 42) 4))
1505 (efnname (buffer-substring (+ p 46) (+ p 46 fnlen)))
1506 (isdir (and (= ucsize 0)
1507 (string= (file-name-nondirectory efnname) "")))
1508 (mode (cond ((memq creator '(2 3)) ; Unix + VMS
1509 (archive-l-e (+ p 40) 2))
380683ed 1510 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
665211a3
KH
1511 (logior ?\444
1512 (if isdir (logior 16384 ?\111) 0)
1513 (if (zerop
1514 (logand 1 (char-after (+ p 38))))
1515 ?\222 0)))
1516 (t nil)))
1517 (modestr (if mode (archive-int-to-mode mode) "??????????"))
1518 (fiddle (and archive-zip-case-fiddle
380683ed
EZ
1519 (not (not (memq creator '(0 2 4 5 9))))
1520 (string= (upcase efnname) efnname)))
665211a3
KH
1521 (ifnname (if fiddle (downcase efnname) efnname))
1522 (text (format " %10s %8d %-11s %-8s %s"
1523 modestr
1524 ucsize
1525 (archive-dosdate moddate)
1526 (archive-dostime modtime)
1527 ifnname)))
1528 (setq maxlen (max maxlen fnlen)
1529 totalsize (+ totalsize ucsize)
1530 visual (cons (vector text
1531 (- (length text) (length ifnname))
1532 (length text))
1533 visual)
1534 files (cons (if isdir
1535 nil
1536 (vector efnname ifnname fiddle mode
1537 (list (1- p) lheader)))
1538 files)
845720b9 1539 p (+ p 46 fnlen exlen fclen))))
665211a3
KH
1540 (goto-char (point-min))
1541 (let ((dash (concat "- ---------- -------- ----------- -------- "
1542 (make-string maxlen ?-)
1543 "\n")))
1544 (insert "M Filemode Length Date Time File\n"
1545 dash)
1546 (archive-summarize-files (nreverse visual))
1547 (insert dash
1548 (format " %8d %d file%s"
1549 totalsize
1550 (length files)
1551 (if (= 1 (length files)) "" "s"))
1552 "\n"))
1553 (apply 'vector (nreverse files))))
1554
1555(defun archive-zip-extract (archive name)
1556 (if archive-zip-use-pkzip
1557 (archive-*-extract archive name archive-zip-extract)
1558 (archive-extract-by-stdout archive name archive-zip-extract)))
1559
1560(defun archive-zip-write-file-member (archive descr)
1561 (archive-*-write-file-member
1562 archive
1563 descr
1564 (if (aref descr 2) archive-zip-update-case archive-zip-update)))
1565
1566(defun archive-zip-chmod-entry (newmode files)
1567 (save-restriction
1568 (save-excursion
1569 (widen)
1570 (while files
1571 (let* ((fil (car files))
1572 (p (+ archive-proper-file-start (car (aref fil 4))))
1573 (creator (char-after (+ p 5)))
1574 (oldmode (aref fil 3))
1575 (newval (archive-calc-mode oldmode newmode t))
1576 buffer-read-only)
1577 (cond ((memq creator '(2 3)) ; Unix + VMS
1578 (goto-char (+ p 40))
1579 (delete-char 2)
1580 (insert (logand newval 255) (lsh newval -8)))
380683ed 1581 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
665211a3
KH
1582 (goto-char (+ p 38))
1583 (insert (logior (logand (char-after (point)) 254)
1584 (logand (logxor 1 (lsh newval -7)) 1)))
1585 (delete-char 1))
1586 (t (message "Don't know how to change mode for this member"))))
1587 (setq files (cdr files))))))
1588;; -------------------------------------------------------------------------
1589;; Section: Zoo Archives
1590
1591(defun archive-zoo-summarize ()
1592 (let ((p (1+ (archive-l-e 25 4)))
1593 (maxlen 8)
1594 (totalsize 0)
1595 files
1596 visual)
1597 (while (and (string= "\334\247\304\375" (buffer-substring p (+ p 4)))
1598 (> (archive-l-e (+ p 6) 4) 0))
1599 (let* ((next (1+ (archive-l-e (+ p 6) 4)))
1600 (moddate (archive-l-e (+ p 14) 2))
1601 (modtime (archive-l-e (+ p 16) 2))
1602 (ucsize (archive-l-e (+ p 20) 4))
1603 (namefld (buffer-substring (+ p 38) (+ p 38 13)))
83c4abcb
RS
1604 (dirtype (char-after (+ p 4)))
1605 (lfnlen (if (= dirtype 2) (char-after (+ p 56)) 0))
1606 (ldirlen (if (= dirtype 2) (char-after (+ p 57)) 0))
9913653a 1607 (fnlen (or (string-match "\0" namefld) 13))
83c4abcb
RS
1608 (efnname (concat
1609 (if (> ldirlen 0)
1610 (concat (buffer-substring
1611 (+ p 58 lfnlen) (+ p 58 lfnlen ldirlen -1))
1612 "/")
1613 "")
1614 (if (> lfnlen 0)
1615 (buffer-substring (+ p 58) (+ p 58 lfnlen -1))
1616 (substring namefld 0 fnlen))))
1617 (fiddle (and (= lfnlen 0) (string= efnname (upcase efnname))))
665211a3
KH
1618 (ifnname (if fiddle (downcase efnname) efnname))
1619 (text (format " %8d %-11s %-8s %s"
1620 ucsize
1621 (archive-dosdate moddate)
1622 (archive-dostime modtime)
1623 ifnname)))
9913653a 1624 (setq maxlen (max maxlen (length ifnname))
665211a3
KH
1625 totalsize (+ totalsize ucsize)
1626 visual (cons (vector text
1627 (- (length text) (length ifnname))
1628 (length text))
1629 visual)
1630 files (cons (vector efnname ifnname fiddle nil (1- p))
1631 files)
1632 p next)))
1633 (goto-char (point-min))
1634 (let ((dash (concat "- -------- ----------- -------- "
1635 (make-string maxlen ?-)
1636 "\n")))
1637 (insert "M Length Date Time File\n"
1638 dash)
1639 (archive-summarize-files (nreverse visual))
1640 (insert dash
1641 (format " %8d %d file%s"
1642 totalsize
1643 (length files)
1644 (if (= 1 (length files)) "" "s"))
1645 "\n"))
1646 (apply 'vector (nreverse files))))
1647
1648(defun archive-zoo-extract (archive name)
1649 (archive-extract-by-stdout archive name archive-zoo-extract))
1650;; -------------------------------------------------------------------------
1651(provide 'archive-mode)
1652
1653;; arc-mode.el ends here.