(Fbyte_code): Convert a unibyte character to multibyte if necessary.
[emacs.git] / lisp / arc-mode.el
blob69b00ec575bfcfa7cc05509983f13bd8ad59ea8d
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 of 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-file-name-coding-system nil)
338 (make-variable-buffer-local 'archive-file-name-coding-system)
339 (put 'archive-file-name-coding-system 'permanent-local t)
341 (defvar archive-files nil
342 "Vector of file descriptors.
343 Each descriptor is a vector of the form
344 [EXT-FILE-NAME INT-FILE-NAME CASE-FIDDLED MODE ...]")
345 (make-variable-buffer-local 'archive-files)
347 (defvar archive-lemacs
348 (string-match "\\(Lucid\\|Xemacs\\)" emacs-version)
349 "*Non-nil when running under under Lucid Emacs or Xemacs.")
350 ;; -------------------------------------------------------------------------
351 ;; Section: Support functions.
353 (eval-when-compile
354 (defsubst byte-after (pos)
355 "Like char-after but an eight-bit char is converted to unibyte."
356 (multibyte-char-to-unibyte (char-after pos)))
357 (defsubst bref (string idx)
358 "Like aref but an eight-bit char is converted to unibyte."
359 (multibyte-char-to-unibyte (aref string idx)))
360 (defsubst insert-unibyte (&rest args)
361 "Like insert but don't make unibyte string and eight-bit char multibyte."
362 (dolist (elt args)
363 (if (integerp elt)
364 (insert (if (< elt 128) elt (decode-char 'eight-bit elt)))
365 (insert (string-to-multibyte elt)))))
368 (defsubst archive-name (suffix)
369 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))
371 (defun archive-l-e (str &optional len)
372 "Convert little endian string/vector to integer.
373 Alternatively, first argument may be a buffer position in the current buffer
374 in which case a second argument, length, should be supplied."
375 (if (stringp str)
376 (setq len (length str))
377 (setq str (buffer-substring str (+ str len))))
378 (let ((result 0)
379 (i 0))
380 (while (< i len)
381 (setq i (1+ i)
382 result (+ (ash result 8)
383 (bref str (- len i)))))
384 result))
386 (defun archive-int-to-mode (mode)
387 "Turn an integer like 0700 (i.e., 448) into a mode string like -rwx------."
388 ;; FIXME: merge with tar-grind-file-mode.
389 (string
390 (if (zerop (logand 8192 mode))
391 (if (zerop (logand 16384 mode)) ?- ?d)
392 ?c) ; completeness
393 (if (zerop (logand 256 mode)) ?- ?r)
394 (if (zerop (logand 128 mode)) ?- ?w)
395 (if (zerop (logand 64 mode))
396 (if (zerop (logand 1024 mode)) ?- ?S)
397 (if (zerop (logand 1024 mode)) ?x ?s))
398 (if (zerop (logand 32 mode)) ?- ?r)
399 (if (zerop (logand 16 mode)) ?- ?w)
400 (if (zerop (logand 8 mode))
401 (if (zerop (logand 2048 mode)) ?- ?S)
402 (if (zerop (logand 2048 mode)) ?x ?s))
403 (if (zerop (logand 4 mode)) ?- ?r)
404 (if (zerop (logand 2 mode)) ?- ?w)
405 (if (zerop (logand 1 mode)) ?- ?x)))
407 (defun archive-calc-mode (oldmode newmode &optional error)
408 "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
409 NEWMODE may be an octal number including a leading zero in which case it
410 will become the new mode.\n
411 NEWMODE may also be a relative specification like \"og-rwx\" in which case
412 OLDMODE will be modified accordingly just like chmod(2) would have done.\n
413 If optional third argument ERROR is non-nil an error will be signaled if
414 the mode is invalid. If ERROR is nil then nil will be returned."
415 (cond ((string-match "^0[0-7]*$" newmode)
416 (let ((result 0)
417 (len (length newmode))
418 (i 1))
419 (while (< i len)
420 (setq result (+ (lsh result 3) (aref newmode i) (- ?0))
421 i (1+ i)))
422 (logior (logand oldmode 65024) result)))
423 ((string-match "^\\([agou]+\\)\\([---+=]\\)\\([rwxst]+\\)$" newmode)
424 (let ((who 0)
425 (result oldmode)
426 (op (aref newmode (match-beginning 2)))
427 (bits 0)
428 (i (match-beginning 3)))
429 (while (< i (match-end 3))
430 (let ((rwx (aref newmode i)))
431 (setq bits (logior bits (cond ((= rwx ?r) 292)
432 ((= rwx ?w) 146)
433 ((= rwx ?x) 73)
434 ((= rwx ?s) 3072)
435 ((= rwx ?t) 512)))
436 i (1+ i))))
437 (while (< who (match-end 1))
438 (let* ((whoc (aref newmode who))
439 (whomask (cond ((= whoc ?a) 4095)
440 ((= whoc ?u) 1472)
441 ((= whoc ?g) 2104)
442 ((= whoc ?o) 7))))
443 (if (= op ?=)
444 (setq result (logand result (lognot whomask))))
445 (if (= op ?-)
446 (setq result (logand result (lognot (logand whomask bits))))
447 (setq result (logior result (logand whomask bits)))))
448 (setq who (1+ who)))
449 result))
451 (if error
452 (error "Invalid mode specification: %s" newmode)))))
454 (defun archive-dosdate (date)
455 "Stringify dos packed DATE record."
456 (let ((year (+ 1980 (logand (ash date -9) 127)))
457 (month (logand (ash date -5) 15))
458 (day (logand date 31)))
459 (if (or (> month 12) (< month 1))
461 (format "%2d-%s-%d"
463 (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
464 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
465 year))))
467 (defun archive-dostime (time)
468 "Stringify dos packed TIME record."
469 (let ((hour (logand (ash time -11) 31))
470 (minute (logand (ash time -5) 63))
471 (second (* 2 (logand time 31)))) ; 2 seconds resolution
472 (format "%02d:%02d:%02d" hour minute second)))
474 ;;(defun archive-unixdate (low high)
475 ;; "Stringify unix (LOW HIGH) date."
476 ;; (let ((str (current-time-string (cons high low))))
477 ;; (format "%s-%s-%s"
478 ;; (substring str 8 9)
479 ;; (substring str 4 7)
480 ;; (substring str 20 24))))
482 ;;(defun archive-unixtime (low high)
483 ;; "Stringify unix (LOW HIGH) time."
484 ;; (let ((str (current-time-string (cons high low))))
485 ;; (substring str 11 19)))
487 (defun archive-get-lineno ()
488 (if (>= (point) archive-file-list-start)
489 (count-lines archive-file-list-start
490 (save-excursion (beginning-of-line) (point)))
493 (defun archive-get-descr (&optional noerror)
494 "Return the descriptor vector for file at point.
495 Does not signal an error if optional second argument NOERROR is non-nil."
496 (let ((no (archive-get-lineno)))
497 (if (and (>= (point) archive-file-list-start)
498 (< no (length archive-files)))
499 (let ((item (aref archive-files no)))
500 (if (vectorp item)
501 item
502 (if (not noerror)
503 (error "Entry is not a regular member of the archive"))))
504 (if (not noerror)
505 (error "Line does not describe a member of the archive")))))
506 ;; -------------------------------------------------------------------------
507 ;; Section: the mode definition
509 ;;;###autoload
510 (defun archive-mode (&optional force)
511 "Major mode for viewing an archive file in a dired-like way.
512 You can move around using the usual cursor motion commands.
513 Letters no longer insert themselves.
514 Type `e' to pull a file out of the archive and into its own buffer;
515 or click mouse-2 on the file's line in the archive mode buffer.
517 If you edit a sub-file of this archive (as with the `e' command) and
518 save it, the contents of that buffer will be saved back into the
519 archive.
521 \\{archive-mode-map}"
522 ;; This is not interactive because you shouldn't be turning this
523 ;; mode on and off. You can corrupt things that way.
524 (if (zerop (buffer-size))
525 ;; At present we cannot create archives from scratch
526 (funcall default-major-mode)
527 (if (and (not force) archive-files) nil
528 (let* ((type (archive-find-type))
529 (typename (capitalize (symbol-name type))))
530 (kill-all-local-variables)
531 (make-local-variable 'archive-subtype)
532 (setq archive-subtype type)
534 ;; Buffer contains treated image of file before the file contents
535 (make-local-variable 'revert-buffer-function)
536 (setq revert-buffer-function 'archive-mode-revert)
537 (auto-save-mode 0)
539 ;; Remote archives are not written by a hook.
540 (if archive-remote nil
541 (make-local-variable 'write-contents-hooks)
542 (add-hook 'write-contents-hooks 'archive-write-file))
544 (make-local-variable 'require-final-newline)
545 (setq require-final-newline nil)
546 (make-local-variable 'local-enable-local-variables)
547 (setq local-enable-local-variables nil)
549 ;; Prevent loss of data when saving the file.
550 (make-local-variable 'file-precious-flag)
551 (setq file-precious-flag t)
553 (make-local-variable 'archive-read-only)
554 ;; Archives which are inside other archives and whose
555 ;; names are invalid for this OS, can't be written.
556 (setq archive-read-only
557 (or (not (file-writable-p (buffer-file-name)))
558 (and archive-subfile-mode
559 (string-match file-name-invalid-regexp
560 (aref archive-subfile-mode 0)))))
562 ;; Should we use a local copy when accessing from outside Emacs?
563 (make-local-variable 'archive-local-name)
565 ;; An archive can contain another archive whose name is invalid
566 ;; on local filesystem. Treat such archives as remote.
567 (or archive-remote
568 (setq archive-remote
569 (or (string-match archive-remote-regexp (buffer-file-name))
570 (string-match file-name-invalid-regexp
571 (buffer-file-name)))))
573 (setq major-mode 'archive-mode)
574 (setq mode-name (concat typename "-Archive"))
575 ;; Run archive-foo-mode-hook and archive-mode-hook
576 (run-hooks (archive-name "mode-hook") 'archive-mode-hook)
577 (use-local-map archive-mode-map))
579 (make-local-variable 'archive-proper-file-start)
580 (make-local-variable 'archive-file-list-start)
581 (make-local-variable 'archive-file-list-end)
582 (make-local-variable 'archive-file-name-indent)
583 (setq archive-file-name-coding-system
584 (or file-name-coding-system
585 default-file-name-coding-system
586 locale-coding-system))
587 (if default-enable-multibyte-characters
588 (set-buffer-multibyte t 'to))
589 (archive-summarize nil)
590 (setq buffer-read-only t))))
592 ;; Archive mode is suitable only for specially formatted data.
593 (put 'archive-mode 'mode-class 'special)
594 ;; -------------------------------------------------------------------------
595 ;; Section: Key maps
597 (if archive-mode-map nil
598 (setq archive-mode-map (make-keymap))
599 (suppress-keymap archive-mode-map)
600 (define-key archive-mode-map " " 'archive-next-line)
601 (define-key archive-mode-map "a" 'archive-alternate-display)
602 ;;(define-key archive-mode-map "c" 'archive-copy)
603 (define-key archive-mode-map "d" 'archive-flag-deleted)
604 (define-key archive-mode-map "\C-d" 'archive-flag-deleted)
605 (define-key archive-mode-map "e" 'archive-extract)
606 (define-key archive-mode-map "f" 'archive-extract)
607 (define-key archive-mode-map "\C-m" 'archive-extract)
608 (define-key archive-mode-map "g" 'revert-buffer)
609 (define-key archive-mode-map "h" 'describe-mode)
610 (define-key archive-mode-map "m" 'archive-mark)
611 (define-key archive-mode-map "n" 'archive-next-line)
612 (define-key archive-mode-map "\C-n" 'archive-next-line)
613 (define-key archive-mode-map [down] 'archive-next-line)
614 (define-key archive-mode-map "o" 'archive-extract-other-window)
615 (define-key archive-mode-map "p" 'archive-previous-line)
616 (define-key archive-mode-map "q" 'quit-window)
617 (define-key archive-mode-map "\C-p" 'archive-previous-line)
618 (define-key archive-mode-map [up] 'archive-previous-line)
619 (define-key archive-mode-map "r" 'archive-rename-entry)
620 (define-key archive-mode-map "u" 'archive-unflag)
621 (define-key archive-mode-map "\M-\C-?" 'archive-unmark-all-files)
622 (define-key archive-mode-map "v" 'archive-view)
623 (define-key archive-mode-map "x" 'archive-expunge)
624 (define-key archive-mode-map "\177" 'archive-unflag-backwards)
625 (define-key archive-mode-map "E" 'archive-extract-other-window)
626 (define-key archive-mode-map "M" 'archive-chmod-entry)
627 (define-key archive-mode-map "G" 'archive-chgrp-entry)
628 (define-key archive-mode-map "O" 'archive-chown-entry)
630 (if archive-lemacs
631 (progn
632 ;; Not a nice "solution" but it'll have to do
633 (define-key archive-mode-map "\C-xu" 'archive-undo)
634 (define-key archive-mode-map "\C-_" 'archive-undo))
635 (substitute-key-definition 'undo 'archive-undo
636 archive-mode-map global-map))
638 (define-key archive-mode-map
639 (if archive-lemacs 'button2 [mouse-2]) 'archive-mouse-extract)
641 (if archive-lemacs
642 () ; out of luck
644 (define-key archive-mode-map [menu-bar immediate]
645 (cons "Immediate" (make-sparse-keymap "Immediate")))
646 (define-key archive-mode-map [menu-bar immediate alternate]
647 '(menu-item "Alternate Display" archive-alternate-display
648 :enable (boundp (archive-name "alternate-display"))
649 :help "Toggle alternate file info display"))
650 (define-key archive-mode-map [menu-bar immediate view]
651 '(menu-item "View This File" archive-view
652 :help "Display file at cursor in View Mode"))
653 (define-key archive-mode-map [menu-bar immediate display]
654 '(menu-item "Display in Other Window" archive-display-other-window
655 :help "Display file at cursor in another window"))
656 (define-key archive-mode-map [menu-bar immediate find-file-other-window]
657 '(menu-item "Find in Other Window" archive-extract-other-window
658 :help "Edit file at cursor in another window"))
659 (define-key archive-mode-map [menu-bar immediate find-file]
660 '(menu-item "Find This File" archive-extract
661 :help "Extract file at cursor and edit it"))
663 (define-key archive-mode-map [menu-bar mark]
664 (cons "Mark" (make-sparse-keymap "Mark")))
665 (define-key archive-mode-map [menu-bar mark unmark-all]
666 '(menu-item "Unmark All" archive-unmark-all-files
667 :help "Unmark all marked files"))
668 (define-key archive-mode-map [menu-bar mark deletion]
669 '(menu-item "Flag" archive-flag-deleted
670 :help "Flag file at cursor for deletion"))
671 (define-key archive-mode-map [menu-bar mark unmark]
672 '(menu-item "Unflag" archive-unflag
673 :help "Unmark file at cursor"))
674 (define-key archive-mode-map [menu-bar mark mark]
675 '(menu-item "Mark" archive-mark
676 :help "Mark file at cursor"))
678 (define-key archive-mode-map [menu-bar operate]
679 (cons "Operate" (make-sparse-keymap "Operate")))
680 (define-key archive-mode-map [menu-bar operate chown]
681 '(menu-item "Change Owner..." archive-chown-entry
682 :enable (fboundp (archive-name "chown-entry"))
683 :help "Change owner of marked files"))
684 (define-key archive-mode-map [menu-bar operate chgrp]
685 '(menu-item "Change Group..." archive-chgrp-entry
686 :enable (fboundp (archive-name "chgrp-entry"))
687 :help "Change group ownership of marked files"))
688 (define-key archive-mode-map [menu-bar operate chmod]
689 '(menu-item "Change Mode..." archive-chmod-entry
690 :enable (fboundp (archive-name "chmod-entry"))
691 :help "Change mode (permissions) of marked files"))
692 (define-key archive-mode-map [menu-bar operate rename]
693 '(menu-item "Rename to..." archive-rename-entry
694 :enable (fboundp (archive-name "rename-entry"))
695 :help "Rename marked files"))
696 ;;(define-key archive-mode-map [menu-bar operate copy]
697 ;; '(menu-item "Copy to..." archive-copy))
698 (define-key archive-mode-map [menu-bar operate expunge]
699 '(menu-item "Expunge Marked Files" archive-expunge
700 :help "Delete all flagged files from archive"))
703 (let* ((item1 '(archive-subfile-mode " Archive"))
704 (items (list item1)))
705 (or (member item1 minor-mode-alist)
706 (setq minor-mode-alist (append items minor-mode-alist))))
707 ;; -------------------------------------------------------------------------
708 (defun archive-find-type ()
709 (widen)
710 (goto-char (point-min))
711 ;; The funny [] here make it unlikely that the .elc file will be treated
712 ;; as an archive by other software.
713 (let (case-fold-search)
714 (cond ((looking-at "[P]K\003\004") 'zip)
715 ((looking-at "..-l[hz][0-9ds]-") 'lzh)
716 ((looking-at "....................[\334]\247\304\375") 'zoo)
717 ((and (looking-at "\C-z") ; signature too simple, IMHO
718 (string-match "\\.[aA][rR][cC]$"
719 (or buffer-file-name (buffer-name))))
720 'arc)
721 (t (error "Buffer format not recognized")))))
722 ;; -------------------------------------------------------------------------
723 (defun archive-summarize (&optional shut-up)
724 "Parse the contents of the archive file in the current buffer.
725 Place a dired-like listing on the front;
726 then narrow to it, so that only that listing
727 is visible (and the real data of the buffer is hidden).
728 Optional argument SHUT-UP, if non-nil, means don't print messages
729 when parsing the archive."
730 (widen)
731 (let (buffer-read-only)
732 (or shut-up
733 (message "Parsing archive file..."))
734 (buffer-disable-undo (current-buffer))
735 (setq archive-files (funcall (archive-name "summarize")))
736 (or shut-up
737 (message "Parsing archive file...done."))
738 (setq archive-proper-file-start (point-marker))
739 (narrow-to-region (point-min) (point))
740 (set-buffer-modified-p nil)
741 (buffer-enable-undo))
742 (goto-char archive-file-list-start)
743 (archive-next-line 0))
745 (defun archive-resummarize ()
746 "Recreate the contents listing of an archive."
747 (let ((modified (buffer-modified-p))
748 (no (archive-get-lineno))
749 buffer-read-only)
750 (widen)
751 (delete-region (point-min) archive-proper-file-start)
752 (archive-summarize t)
753 (set-buffer-modified-p modified)
754 (goto-char archive-file-list-start)
755 (archive-next-line no)))
757 (defun archive-summarize-files (files)
758 "Insert a description of a list of files annotated with proper mouse face."
759 (setq archive-file-list-start (point-marker))
760 (setq archive-file-name-indent (if files (aref (car files) 1) 0))
761 ;; We don't want to do an insert for each element since that takes too
762 ;; long when the archive -- which has to be moved in memory -- is large.
763 (insert
764 (apply
765 (function concat)
766 (mapcar
767 (function
768 (lambda (fil)
769 ;; Using `concat' here copies the text also, so we can add
770 ;; properties without problems.
771 (let ((text (concat (aref fil 0) "\n")))
772 (if archive-lemacs
773 () ; out of luck
774 (add-text-properties
775 (aref fil 1) (aref fil 2)
776 '(mouse-face highlight
777 help-echo "mouse-2: extract this file into a buffer")
778 text))
779 text)))
780 files)))
781 (setq archive-file-list-end (point-marker)))
783 (defun archive-alternate-display ()
784 "Toggle alternative display.
785 To avoid very long lines some archive mode don't show all information.
786 This function changes the set of information shown for each files."
787 (interactive)
788 (setq archive-alternate-display (not archive-alternate-display))
789 (archive-resummarize))
790 ;; -------------------------------------------------------------------------
791 ;; Section: Local archive copy handling
793 (defun archive-unique-fname (fname dir)
794 "Make sure a file FNAME can be created uniquely in directory DIR.
796 If FNAME can be uniquely created in DIR, it is returned unaltered.
797 If FNAME is something our underlying filesystem can't grok, or if another
798 file by that name already exists in DIR, a unique new name is generated
799 using `make-temp-file', and the generated name is returned."
800 (let ((fullname (expand-file-name fname dir))
801 (alien (string-match file-name-invalid-regexp fname)))
802 (if (or alien (file-exists-p fullname))
803 (make-temp-file
804 (expand-file-name
805 (if (and (fboundp 'msdos-long-file-names)
806 (not (msdos-long-file-names)))
807 "am"
808 "arc-mode.")
809 dir))
810 fullname)))
812 (defun archive-maybe-copy (archive)
813 (let ((coding-system-for-write 'no-conversion))
814 (if archive-remote
815 (let ((start (point-max))
816 ;; Sometimes ARCHIVE is invalid while its actual name, as
817 ;; recorded in its parent archive, is not. For example, an
818 ;; archive bar.zip inside another archive foo.zip gets a name
819 ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
820 ;; So use the actual name if available.
821 (archive-name
822 (or (and archive-subfile-mode (aref archive-subfile-mode 0))
823 archive)))
824 (make-directory archive-tmpdir t)
825 (setq archive-local-name
826 (archive-unique-fname archive-name archive-tmpdir))
827 (save-restriction
828 (widen)
829 (write-region start (point-max) archive-local-name nil 'nomessage))
830 archive-local-name)
831 (if (buffer-modified-p) (save-buffer))
832 archive)))
834 (defun archive-maybe-update (unchanged)
835 (if archive-remote
836 (let ((name archive-local-name)
837 (modified (buffer-modified-p))
838 (coding-system-for-read 'no-conversion)
839 (lno (archive-get-lineno))
840 buffer-read-only)
841 (if unchanged nil
842 (setq archive-files nil)
843 (erase-buffer)
844 (insert-file-contents name)
845 (archive-mode t)
846 (goto-char archive-file-list-start)
847 (archive-next-line lno))
848 (archive-delete-local name)
849 (if (not unchanged)
850 (message
851 "Buffer `%s' must be saved for changes to take effect"
852 (buffer-name (current-buffer))))
853 (set-buffer-modified-p (or modified (not unchanged))))))
855 (defun archive-delete-local (name)
856 "Delete file NAME and its parents up to and including `archive-tmpdir'."
857 (let ((again t)
858 (top (directory-file-name (file-name-as-directory archive-tmpdir))))
859 (condition-case nil
860 (delete-file name)
861 (error nil))
862 (while again
863 (setq name (directory-file-name (file-name-directory name)))
864 (condition-case nil
865 (delete-directory name)
866 (error nil))
867 (if (string= name top) (setq again nil)))))
868 ;; -------------------------------------------------------------------------
869 ;; Section: Member extraction
871 (defun archive-file-name-handler (op &rest args)
872 (or (eq op 'file-exists-p)
873 (let ((file-name-handler-alist nil))
874 (apply op args))))
876 (defun archive-set-buffer-as-visiting-file (filename)
877 "Set the current buffer as if it were visiting FILENAME."
878 (save-excursion
879 (goto-char (point-min))
880 (let ((coding
881 (or coding-system-for-read
882 (and set-auto-coding-function
883 (save-excursion
884 (funcall set-auto-coding-function
885 filename (- (point-max) (point-min)))))
886 ;; dos-w32.el defines find-operation-coding-system for
887 ;; DOS/Windows systems which preserves the coding-system
888 ;; of existing files. We want it to act here as if the
889 ;; extracted file existed.
890 (let ((file-name-handler-alist
891 '(("" . archive-file-name-handler))))
892 (car (find-operation-coding-system 'insert-file-contents
893 filename t))))))
894 (if (and (not coding-system-for-read)
895 (not enable-multibyte-characters))
896 (setq coding
897 (coding-system-change-text-conversion coding 'raw-text)))
898 (if (and coding
899 (not (eq coding 'no-conversion)))
900 (decode-coding-region (point-min) (point-max) coding)
901 (setq last-coding-system-used coding))
902 (set-buffer-modified-p nil)
903 (kill-local-variable 'buffer-file-coding-system)
904 (after-insert-file-set-buffer-file-coding-system (- (point-max)
905 (point-min))))))
907 (defun archive-mouse-extract (event)
908 "Extract a file whose name you click on."
909 (interactive "e")
910 (mouse-set-point event)
911 (switch-to-buffer
912 (save-excursion
913 (archive-extract)
914 (current-buffer))))
916 (defun archive-extract (&optional other-window-p)
917 "In archive mode, extract this entry of the archive into its own buffer."
918 (interactive)
919 (let* ((view-p (eq other-window-p 'view))
920 (descr (archive-get-descr))
921 (ename (aref descr 0))
922 (iname (aref descr 1))
923 (archive-buffer (current-buffer))
924 (arcdir default-directory)
925 (archive (buffer-file-name))
926 (arcname (file-name-nondirectory archive))
927 (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
928 (extractor (archive-name "extract"))
929 ;; Members with file names which aren't valid for the
930 ;; underlying filesystem, are treated as read-only.
931 (read-only-p (or archive-read-only
932 view-p
933 (string-match file-name-invalid-regexp ename)))
934 (buffer (get-buffer bufname))
935 (just-created nil)
936 (file-name-coding archive-file-name-coding-system))
937 (if buffer
939 (setq archive (archive-maybe-copy archive))
940 (setq buffer (get-buffer-create bufname))
941 (setq just-created t)
942 (save-excursion
943 (set-buffer buffer)
944 (setq buffer-file-name
945 (expand-file-name (concat arcname ":" iname)))
946 (setq buffer-file-truename
947 (abbreviate-file-name buffer-file-name))
948 ;; Set the default-directory to the dir of the superior buffer.
949 (setq default-directory arcdir)
950 (make-local-variable 'archive-superior-buffer)
951 (setq archive-superior-buffer archive-buffer)
952 (make-local-variable 'local-write-file-hooks)
953 (add-hook 'local-write-file-hooks 'archive-write-file-member)
954 (setq archive-subfile-mode descr)
955 (setq archive-file-name-coding-system file-name-coding)
956 (if (and
957 (null
958 (let (;; We may have to encode file name arguement for
959 ;; external programs.
960 (coding-system-for-write
961 (and enable-multibyte-characters
962 archive-file-name-coding-system))
963 ;; We read an archive member by no-conversion at
964 ;; first, then decode appropriately by calling
965 ;; archive-set-buffer-as-visiting-file later.
966 (coding-system-for-read 'no-conversion))
967 (condition-case err
968 (if (fboundp extractor)
969 (funcall extractor archive ename)
970 (archive-*-extract archive ename
971 (symbol-value extractor)))
972 (error
973 (ding (message "%s" (error-message-string err)))
974 nil))))
975 just-created)
976 (progn
977 (set-buffer-modified-p nil)
978 (kill-buffer buffer))
979 (archive-set-buffer-as-visiting-file ename)
980 (goto-char (point-min))
981 (rename-buffer bufname)
982 (setq buffer-read-only read-only-p)
983 (setq buffer-undo-list nil)
984 (set-buffer-modified-p nil)
985 (setq buffer-saved-size (buffer-size))
986 (normal-mode)
987 ;; Just in case an archive occurs inside another archive.
988 (if (eq major-mode 'archive-mode)
989 (progn
990 (setq archive-remote t)
991 (if read-only-p (setq archive-read-only t))
992 ;; We will write out the archive ourselves if it is
993 ;; part of another archive.
994 (remove-hook 'write-contents-hooks 'archive-write-file t)))
995 (run-hooks 'archive-extract-hooks)
996 (if archive-read-only
997 (message "Note: altering this archive is not implemented."))))
998 (archive-maybe-update t))
999 (or (not (buffer-name buffer))
1000 (progn
1001 (if view-p
1002 (view-buffer buffer (and just-created 'kill-buffer))
1003 (if (eq other-window-p 'display)
1004 (display-buffer buffer)
1005 (if other-window-p
1006 (switch-to-buffer-other-window buffer)
1007 (switch-to-buffer buffer))))))))
1009 (defun archive-*-extract (archive name command)
1010 (let* ((default-directory (file-name-as-directory archive-tmpdir))
1011 (tmpfile (expand-file-name (file-name-nondirectory name)
1012 default-directory))
1013 exit-status success)
1014 (make-directory (directory-file-name default-directory) t)
1015 (setq exit-status
1016 (apply 'call-process
1017 (car command)
1021 (append (cdr command) (list archive name))))
1022 (cond ((and (numberp exit-status) (= exit-status 0))
1023 (if (not (file-exists-p tmpfile))
1024 (ding (message "`%s': no such file or directory" tmpfile))
1025 (insert-file-contents tmpfile)
1026 (setq success t)))
1027 ((numberp exit-status)
1028 (ding
1029 (message "`%s' exited with status %d" (car command) exit-status)))
1030 ((stringp exit-status)
1031 (ding (message "`%s' aborted: %s" (car command) exit-status)))
1033 (ding (message "`%s' failed" (car command)))))
1034 (archive-delete-local tmpfile)
1035 success))
1037 (defun archive-extract-by-stdout (archive name command)
1038 (apply 'call-process
1039 (car command)
1043 (append (cdr command) (list archive name))))
1045 (defun archive-extract-other-window ()
1046 "In archive mode, find this member in another window."
1047 (interactive)
1048 (archive-extract t))
1050 (defun archive-display-other-window ()
1051 "In archive mode, display this member in another window."
1052 (interactive)
1053 (archive-extract 'display))
1055 (defun archive-view ()
1056 "In archive mode, view the member on this line."
1057 (interactive)
1058 (archive-extract 'view))
1060 (defun archive-add-new-member (arcbuf name)
1061 "Add current buffer to the archive in ARCBUF naming it NAME."
1062 (interactive
1063 (list (get-buffer
1064 (read-buffer "Buffer containing archive: "
1065 ;; Find first archive buffer and suggest that
1066 (let ((bufs (buffer-list)))
1067 (while (and bufs (not (eq (save-excursion
1068 (set-buffer (car bufs))
1069 major-mode)
1070 'archive-mode)))
1071 (setq bufs (cdr bufs)))
1072 (if bufs
1073 (car bufs)
1074 (error "There are no archive buffers")))
1076 (read-string "File name in archive: "
1077 (if buffer-file-name
1078 (file-name-nondirectory buffer-file-name)
1079 ""))))
1080 (save-excursion
1081 (set-buffer arcbuf)
1082 (or (eq major-mode 'archive-mode)
1083 (error "Buffer is not an archive buffer"))
1084 (if archive-read-only
1085 (error "Archive is read-only")))
1086 (if (eq arcbuf (current-buffer))
1087 (error "An archive buffer cannot be added to itself"))
1088 (if (string= name "")
1089 (error "Archive members may not be given empty names"))
1090 (let ((func (save-excursion (set-buffer arcbuf)
1091 (archive-name "add-new-member")))
1092 (membuf (current-buffer)))
1093 (if (fboundp func)
1094 (save-excursion
1095 (set-buffer arcbuf)
1096 (funcall func buffer-file-name membuf name))
1097 (error "Adding a new member is not supported for this archive type"))))
1098 ;; -------------------------------------------------------------------------
1099 ;; Section: IO stuff
1101 (defun archive-write-file-member ()
1102 (save-excursion
1103 (save-restriction
1104 (message "Updating archive...")
1105 (widen)
1106 (let ((writer (save-excursion (set-buffer archive-superior-buffer)
1107 (archive-name "write-file-member")))
1108 (archive (save-excursion (set-buffer archive-superior-buffer)
1109 (archive-maybe-copy (buffer-file-name)))))
1110 (if (fboundp writer)
1111 (funcall writer archive archive-subfile-mode)
1112 (archive-*-write-file-member archive
1113 archive-subfile-mode
1114 (symbol-value writer)))
1115 (set-buffer-modified-p nil)
1116 (message "Updating archive...done"))
1117 (set-buffer archive-superior-buffer)
1118 (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
1119 ;; Restore the value of last-coding-system-used, so that basic-save-buffer
1120 ;; won't reset the coding-system of this archive member.
1121 (if (local-variable-p 'archive-member-coding-system)
1122 (setq last-coding-system-used archive-member-coding-system))
1125 (defun archive-*-write-file-member (archive descr command)
1126 (let* ((ename (aref descr 0))
1127 (tmpfile (expand-file-name ename archive-tmpdir))
1128 (top (directory-file-name (file-name-as-directory archive-tmpdir)))
1129 (default-directory (file-name-as-directory top)))
1130 (unwind-protect
1131 (progn
1132 (make-directory (file-name-directory tmpfile) t)
1133 ;; If the member is itself an archive, write it without
1134 ;; the dired-like listing we created.
1135 (if (eq major-mode 'archive-mode)
1136 (archive-write-file tmpfile)
1137 (write-region (point-min) (point-max) tmpfile nil 'nomessage))
1138 ;; basic-save-buffer needs last-coding-system-used to have
1139 ;; the value used to write the file, so save it before any
1140 ;; further processing clobbers it (we restore it in
1141 ;; archive-write-file-member, above).
1142 (setq archive-member-coding-system last-coding-system-used)
1143 (if (aref descr 3)
1144 ;; Set the file modes, but make sure we can read it.
1145 (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1146 (setq ename
1147 (encode-coding-string ename archive-file-name-coding-system))
1148 (let* ((coding-system-for-write 'no-conversion)
1149 (exitcode (apply 'call-process
1150 (car command)
1154 (append (cdr command)
1155 (list archive ename)))))
1156 (if (equal exitcode 0)
1158 (error "Updating was unsuccessful (%S)" exitcode))))
1159 (archive-delete-local tmpfile))))
1161 (defun archive-write-file (&optional file)
1162 (save-excursion
1163 (let ((coding-system-for-write 'no-conversion))
1164 (write-region archive-proper-file-start (point-max)
1165 (or file buffer-file-name) nil t)
1166 (set-buffer-modified-p nil))
1168 ;; -------------------------------------------------------------------------
1169 ;; Section: Marking and unmarking.
1171 (defun archive-flag-deleted (p &optional type)
1172 "In archive mode, mark this member to be deleted from the archive.
1173 With a prefix argument, mark that many files."
1174 (interactive "p")
1175 (or type (setq type ?D))
1176 (beginning-of-line)
1177 (let ((sign (if (>= p 0) +1 -1))
1178 (modified (buffer-modified-p))
1179 buffer-read-only)
1180 (while (not (zerop p))
1181 (if (archive-get-descr t)
1182 (progn
1183 (delete-char 1)
1184 (insert type)))
1185 (forward-line sign)
1186 (setq p (- p sign)))
1187 (set-buffer-modified-p modified))
1188 (archive-next-line 0))
1190 (defun archive-unflag (p)
1191 "In archive mode, un-mark this member if it is marked to be deleted.
1192 With a prefix argument, un-mark that many files forward."
1193 (interactive "p")
1194 (archive-flag-deleted p ? ))
1196 (defun archive-unflag-backwards (p)
1197 "In archive mode, un-mark this member if it is marked to be deleted.
1198 With a prefix argument, un-mark that many members backward."
1199 (interactive "p")
1200 (archive-flag-deleted (- p) ? ))
1202 (defun archive-unmark-all-files ()
1203 "Remove all marks."
1204 (interactive)
1205 (let ((modified (buffer-modified-p))
1206 buffer-read-only)
1207 (save-excursion
1208 (goto-char archive-file-list-start)
1209 (while (< (point) archive-file-list-end)
1210 (or (= (following-char) ? )
1211 (progn (delete-char 1) (insert ? )))
1212 (forward-line 1)))
1213 (set-buffer-modified-p modified)))
1215 (defun archive-mark (p)
1216 "In archive mode, mark this member for group operations.
1217 With a prefix argument, mark that many members.
1218 Use \\[archive-unmark-all-files] to remove all marks."
1219 (interactive "p")
1220 (archive-flag-deleted p ?*))
1222 (defun archive-get-marked (mark &optional default)
1223 (let (files)
1224 (save-excursion
1225 (goto-char archive-file-list-start)
1226 (while (< (point) archive-file-list-end)
1227 (if (= (following-char) mark)
1228 (setq files (cons (archive-get-descr) files)))
1229 (forward-line 1)))
1230 (or (nreverse files)
1231 (and default
1232 (list (archive-get-descr))))))
1233 ;; -------------------------------------------------------------------------
1234 ;; Section: Operate
1236 (defun archive-next-line (p)
1237 (interactive "p")
1238 (forward-line p)
1239 (or (eobp)
1240 (forward-char archive-file-name-indent)))
1242 (defun archive-previous-line (p)
1243 (interactive "p")
1244 (archive-next-line (- p)))
1246 (defun archive-chmod-entry (new-mode)
1247 "Change the protection bits associated with all marked or this member.
1248 The new protection bits can either be specified as an octal number or
1249 as a relative change like \"g+rw\" as for chmod(2)"
1250 (interactive "sNew mode (octal or relative): ")
1251 (if archive-read-only (error "Archive is read-only"))
1252 (let ((func (archive-name "chmod-entry")))
1253 (if (fboundp func)
1254 (progn
1255 (funcall func new-mode (archive-get-marked ?* t))
1256 (archive-resummarize))
1257 (error "Setting mode bits is not supported for this archive type"))))
1259 (defun archive-chown-entry (new-uid)
1260 "Change the owner of all marked or this member."
1261 (interactive "nNew uid: ")
1262 (if archive-read-only (error "Archive is read-only"))
1263 (let ((func (archive-name "chown-entry")))
1264 (if (fboundp func)
1265 (progn
1266 (funcall func new-uid (archive-get-marked ?* t))
1267 (archive-resummarize))
1268 (error "Setting owner is not supported for this archive type"))))
1270 (defun archive-chgrp-entry (new-gid)
1271 "Change the group of all marked or this member."
1272 (interactive "nNew gid: ")
1273 (if archive-read-only (error "Archive is read-only"))
1274 (let ((func (archive-name "chgrp-entry")))
1275 (if (fboundp func)
1276 (progn
1277 (funcall func new-gid (archive-get-marked ?* t))
1278 (archive-resummarize))
1279 (error "Setting group is not supported for this archive type"))))
1281 (defun archive-expunge ()
1282 "Do the flagged deletions."
1283 (interactive)
1284 (let (files)
1285 (save-excursion
1286 (goto-char archive-file-list-start)
1287 (while (< (point) archive-file-list-end)
1288 (if (= (following-char) ?D)
1289 (setq files (cons (aref (archive-get-descr) 0) files)))
1290 (forward-line 1)))
1291 (setq files (nreverse files))
1292 (and files
1293 (or (not archive-read-only)
1294 (error "Archive is read-only"))
1295 (or (yes-or-no-p (format "Really delete %d member%s? "
1296 (length files)
1297 (if (null (cdr files)) "" "s")))
1298 (error "Operation aborted"))
1299 (let ((archive (archive-maybe-copy (buffer-file-name)))
1300 (expunger (archive-name "expunge")))
1301 (if (fboundp expunger)
1302 (funcall expunger archive files)
1303 (archive-*-expunge archive files (symbol-value expunger)))
1304 (archive-maybe-update nil)
1305 (if archive-remote
1306 (archive-resummarize)
1307 (revert-buffer))))))
1309 (defun archive-*-expunge (archive files command)
1310 (apply 'call-process
1311 (car command)
1315 (append (cdr command) (cons archive files))))
1317 (defun archive-rename-entry (newname)
1318 "Change the name associated with this entry in the tar file."
1319 (interactive "sNew name: ")
1320 (if archive-read-only (error "Archive is read-only"))
1321 (if (string= newname "")
1322 (error "Archive members may not be given empty names"))
1323 (let ((func (archive-name "rename-entry"))
1324 (descr (archive-get-descr)))
1325 (if (fboundp func)
1326 (progn
1327 (funcall func (buffer-file-name)
1328 (encode-coding-string newname
1329 archive-file-name-coding-system)
1330 descr)
1331 (archive-resummarize))
1332 (error "Renaming is not supported for this archive type"))))
1334 ;; Revert the buffer and recompute the dired-like listing.
1335 (defun archive-mode-revert (&optional no-auto-save no-confirm)
1336 (let ((no (archive-get-lineno)))
1337 (setq archive-files nil)
1338 (let ((revert-buffer-function nil)
1339 (coding-system-for-read 'no-conversion))
1340 (revert-buffer t t))
1341 (archive-mode)
1342 (goto-char archive-file-list-start)
1343 (archive-next-line no)))
1345 (defun archive-undo ()
1346 "Undo in an archive buffer.
1347 This doesn't recover lost files, it just undoes changes in the buffer itself."
1348 (interactive)
1349 (let (buffer-read-only)
1350 (undo)))
1351 ;; -------------------------------------------------------------------------
1352 ;; Section: Arc Archives
1354 (defun archive-arc-summarize ()
1355 (let ((p 1)
1356 (totalsize 0)
1357 (maxlen 8)
1358 files
1359 visual)
1360 (while (and (< (+ p 29) (point-max))
1361 (= (byte-after p) ?\C-z)
1362 (> (byte-after (1+ p)) 0))
1363 (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13)))
1364 (fnlen (or (string-match "\0" namefld) 13))
1365 (efnname (decode-coding-string (substring namefld 0 fnlen)
1366 archive-file-name-coding-system))
1367 (csize (archive-l-e (+ p 15) 4))
1368 (moddate (archive-l-e (+ p 19) 2))
1369 (modtime (archive-l-e (+ p 21) 2))
1370 (ucsize (archive-l-e (+ p 25) 4))
1371 (fiddle (string= efnname (upcase efnname)))
1372 (ifnname (if fiddle (downcase efnname) efnname))
1373 (text (format " %8d %-11s %-8s %s"
1374 ucsize
1375 (archive-dosdate moddate)
1376 (archive-dostime modtime)
1377 ifnname)))
1378 (setq maxlen (max maxlen fnlen)
1379 totalsize (+ totalsize ucsize)
1380 visual (cons (vector text
1381 (- (length text) (length ifnname))
1382 (length text))
1383 visual)
1384 files (cons (vector efnname ifnname fiddle nil (1- p))
1385 files)
1386 p (+ p 29 csize))))
1387 (goto-char (point-min))
1388 (let ((dash (concat "- -------- ----------- -------- "
1389 (make-string maxlen ?-)
1390 "\n")))
1391 (insert "M Length Date Time File\n"
1392 dash)
1393 (archive-summarize-files (nreverse visual))
1394 (insert dash
1395 (format " %8d %d file%s"
1396 totalsize
1397 (length files)
1398 (if (= 1 (length files)) "" "s"))
1399 "\n"))
1400 (apply 'vector (nreverse files))))
1402 (defun archive-arc-rename-entry (archive newname descr)
1403 (if (string-match "[:\\\\/]" newname)
1404 (error "File names in arc files may not contain a path"))
1405 (if (> (length newname) 12)
1406 (error "File names in arc files are limited to 12 characters"))
1407 (let ((name (concat newname (substring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
1408 (length newname))))
1409 buffer-read-only)
1410 (save-restriction
1411 (save-excursion
1412 (widen)
1413 (goto-char (+ archive-proper-file-start (aref descr 4) 2))
1414 (delete-char 13)
1415 (insert-unibyte name)))))
1416 ;; -------------------------------------------------------------------------
1417 ;; Section: Lzh Archives
1419 (defun archive-lzh-summarize ()
1420 (let ((p 1)
1421 (totalsize 0)
1422 (maxlen 8)
1423 files
1424 visual)
1425 (while (progn (goto-char p)
1426 (looking-at "\\(.\\|\n\\)\\(.\\|\n\\)-l[hz][0-9ds]-"))
1427 (let* ((hsize (byte-after p))
1428 (csize (archive-l-e (+ p 7) 4))
1429 (ucsize (archive-l-e (+ p 11) 4))
1430 (modtime (archive-l-e (+ p 15) 2))
1431 (moddate (archive-l-e (+ p 17) 2))
1432 (hdrlvl (byte-after (+ p 20)))
1433 (fnlen (byte-after (+ p 21)))
1434 (efnname (let ((str (buffer-substring (+ p 22) (+ p 22 fnlen))))
1435 (decode-coding-string
1436 str archive-file-name-coding-system)))
1437 (fiddle (string= efnname (upcase efnname)))
1438 (ifnname (if fiddle (downcase efnname) efnname))
1439 (width (string-width ifnname))
1440 (p2 (+ p 22 fnlen))
1441 (creator (if (>= (- hsize fnlen) 24) (byte-after (+ p2 2)) 0))
1442 mode modestr uid gid text path prname
1444 (if (= hdrlvl 0)
1445 (setq mode (if (= creator ?U) (archive-l-e (+ p2 8) 2) ?\666)
1446 uid (if (= creator ?U) (archive-l-e (+ p2 10) 2))
1447 gid (if (= creator ?U) (archive-l-e (+ p2 12) 2)))
1448 (if (= creator ?U)
1449 (let* ((p3 (+ p2 3))
1450 (hsize (archive-l-e p3 2))
1451 (etype (byte-after (+ p3 2))))
1452 (while (not (= hsize 0))
1453 (cond
1454 ((= etype 2) (let ((i (+ p3 3)))
1455 (while (< i (+ p3 hsize))
1456 (setq path (concat path
1457 (if (= (byte-after i)
1458 255)
1460 (char-to-string
1461 (byte-after i)))))
1462 (setq i (1+ i)))))
1463 ((= etype 80) (setq mode (archive-l-e (+ p3 3) 2)))
1464 ((= etype 81) (progn (setq uid (archive-l-e (+ p3 3) 2))
1465 (setq gid (archive-l-e (+ p3 5) 2))))
1467 (setq p3 (+ p3 hsize))
1468 (setq hsize (archive-l-e p3 2))
1469 (setq etype (byte-after (+ p3 2)))))))
1470 (setq prname (if path (concat path ifnname) ifnname))
1471 (setq modestr (if mode (archive-int-to-mode mode) "??????????"))
1472 (setq text (if archive-alternate-display
1473 (format " %8d %5S %5S %s"
1474 ucsize
1475 (or uid "?")
1476 (or gid "?")
1477 ifnname)
1478 (format " %10s %8d %-11s %-8s %s"
1479 modestr
1480 ucsize
1481 (archive-dosdate moddate)
1482 (archive-dostime modtime)
1483 ifnname)))
1484 (setq maxlen (max maxlen width)
1485 totalsize (+ totalsize ucsize)
1486 visual (cons (vector text
1487 (- (length text) (length ifnname))
1488 (length text))
1489 visual)
1490 files (cons (vector prname ifnname fiddle mode (1- p))
1491 files)
1492 p (+ p hsize 2 csize))))
1493 (goto-char (point-min))
1494 (let ((dash (concat (if archive-alternate-display
1495 "- -------- ----- ----- "
1496 "- ---------- -------- ----------- -------- ")
1497 (make-string maxlen ?-)
1498 "\n"))
1499 (header (if archive-alternate-display
1500 "M Length Uid Gid File\n"
1501 "M Filemode Length Date Time File\n"))
1502 (sumline (if archive-alternate-display
1503 " %8d %d file%s"
1504 " %8d %d file%s")))
1505 (insert header dash)
1506 (archive-summarize-files (nreverse visual))
1507 (insert dash
1508 (format sumline
1509 totalsize
1510 (length files)
1511 (if (= 1 (length files)) "" "s"))
1512 "\n"))
1513 (apply 'vector (nreverse files))))
1515 (defconst archive-lzh-alternate-display t)
1517 (defun archive-lzh-extract (archive name)
1518 (archive-extract-by-stdout archive name archive-lzh-extract))
1520 (defun archive-lzh-resum (p count)
1521 (let ((sum 0))
1522 (while (> count 0)
1523 (setq count (1- count)
1524 sum (+ sum (byte-after p))
1525 p (1+ p)))
1526 (logand sum 255)))
1528 (defun archive-lzh-rename-entry (archive newname descr)
1529 (save-restriction
1530 (save-excursion
1531 (widen)
1532 (let* ((p (+ archive-proper-file-start (aref descr 4)))
1533 (oldhsize (byte-after p))
1534 (oldfnlen (byte-after (+ p 21)))
1535 (newfnlen (length newname))
1536 (newhsize (+ oldhsize newfnlen (- oldfnlen)))
1537 buffer-read-only)
1538 (if (> newhsize 255)
1539 (error "The file name is too long"))
1540 (goto-char (+ p 21))
1541 (delete-char (1+ oldfnlen))
1542 (insert-unibyte newfnlen newname)
1543 (goto-char p)
1544 (delete-char 2)
1545 (insert-unibyte newhsize (archive-lzh-resum p newhsize))))))
1547 (defun archive-lzh-ogm (newval files errtxt ofs)
1548 (save-restriction
1549 (save-excursion
1550 (widen)
1551 (while files
1552 (let* ((fil (car files))
1553 (p (+ archive-proper-file-start (aref fil 4)))
1554 (hsize (byte-after p))
1555 (fnlen (byte-after (+ p 21)))
1556 (p2 (+ p 22 fnlen))
1557 (creator (if (>= (- hsize fnlen) 24) (byte-after (+ p2 2)) 0))
1558 buffer-read-only)
1559 (if (= creator ?U)
1560 (progn
1561 (or (numberp newval)
1562 (setq newval (funcall newval (archive-l-e (+ p2 ofs) 2))))
1563 (goto-char (+ p2 ofs))
1564 (delete-char 2)
1565 (insert-unibyte (logand newval 255) (lsh newval -8))
1566 (goto-char (1+ p))
1567 (delete-char 1)
1568 (insert-unibyte (archive-lzh-resum (1+ p) hsize)))
1569 (message "Member %s does not have %s field"
1570 (aref fil 1) errtxt)))
1571 (setq files (cdr files))))))
1573 (defun archive-lzh-chown-entry (newuid files)
1574 (archive-lzh-ogm newuid files "an uid" 10))
1576 (defun archive-lzh-chgrp-entry (newgid files)
1577 (archive-lzh-ogm newgid files "a gid" 12))
1579 (defun archive-lzh-chmod-entry (newmode files)
1580 (archive-lzh-ogm
1581 ;; This should work even though newmode will be dynamically accessed.
1582 (function (lambda (old) (archive-calc-mode old newmode t)))
1583 files "a unix-style mode" 8))
1584 ;; -------------------------------------------------------------------------
1585 ;; Section: Zip Archives
1587 (defun archive-zip-summarize ()
1588 (goto-char (- (point-max) (- 22 18)))
1589 (search-backward-regexp "[P]K\005\006")
1590 (let ((p (1+ (archive-l-e (+ (point) 16) 4)))
1591 (maxlen 8)
1592 (totalsize 0)
1593 files
1594 visual)
1595 (while (string= "PK\001\002" (buffer-substring p (+ p 4)))
1596 (let* ((creator (byte-after (+ p 5)))
1597 (method (archive-l-e (+ p 10) 2))
1598 (modtime (archive-l-e (+ p 12) 2))
1599 (moddate (archive-l-e (+ p 14) 2))
1600 (ucsize (archive-l-e (+ p 24) 4))
1601 (fnlen (archive-l-e (+ p 28) 2))
1602 (exlen (archive-l-e (+ p 30) 2))
1603 (fclen (archive-l-e (+ p 32) 2))
1604 (lheader (archive-l-e (+ p 42) 4))
1605 (efnname (let ((str (buffer-substring (+ p 46) (+ p 46 fnlen))))
1606 (decode-coding-string
1607 str archive-file-name-coding-system)))
1608 (isdir (and (= ucsize 0)
1609 (string= (file-name-nondirectory efnname) "")))
1610 (mode (cond ((memq creator '(2 3)) ; Unix + VMS
1611 (archive-l-e (+ p 40) 2))
1612 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1613 (logior ?\444
1614 (if isdir (logior 16384 ?\111) 0)
1615 (if (zerop
1616 (logand 1 (byte-after (+ p 38))))
1617 ?\222 0)))
1618 (t nil)))
1619 (modestr (if mode (archive-int-to-mode mode) "??????????"))
1620 (fiddle (and archive-zip-case-fiddle
1621 (not (not (memq creator '(0 2 4 5 9))))
1622 (string= (upcase efnname) efnname)))
1623 (ifnname (if fiddle (downcase efnname) efnname))
1624 (width (string-width ifnname))
1625 (text (format " %10s %8d %-11s %-8s %s"
1626 modestr
1627 ucsize
1628 (archive-dosdate moddate)
1629 (archive-dostime modtime)
1630 ifnname)))
1631 (setq maxlen (max maxlen width)
1632 totalsize (+ totalsize ucsize)
1633 visual (cons (vector text
1634 (- (length text) (length ifnname))
1635 (length text))
1636 visual)
1637 files (cons (if isdir
1639 (vector efnname ifnname fiddle mode
1640 (list (1- p) lheader)))
1641 files)
1642 p (+ p 46 fnlen exlen fclen))))
1643 (goto-char (point-min))
1644 (let ((dash (concat "- ---------- -------- ----------- -------- "
1645 (make-string maxlen ?-)
1646 "\n")))
1647 (insert "M Filemode Length Date Time File\n"
1648 dash)
1649 (archive-summarize-files (nreverse visual))
1650 (insert dash
1651 (format " %8d %d file%s"
1652 totalsize
1653 (length files)
1654 (if (= 1 (length files)) "" "s"))
1655 "\n"))
1656 (apply 'vector (nreverse files))))
1658 (defun archive-zip-extract (archive name)
1659 (if archive-zip-use-pkzip
1660 (archive-*-extract archive name archive-zip-extract)
1661 (archive-extract-by-stdout archive name archive-zip-extract)))
1663 (defun archive-zip-write-file-member (archive descr)
1664 (archive-*-write-file-member
1665 archive
1666 descr
1667 (if (aref descr 2) archive-zip-update-case archive-zip-update)))
1669 (defun archive-zip-chmod-entry (newmode files)
1670 (save-restriction
1671 (save-excursion
1672 (widen)
1673 (while files
1674 (let* ((fil (car files))
1675 (p (+ archive-proper-file-start (car (aref fil 4))))
1676 (creator (byte-after (+ p 5)))
1677 (oldmode (aref fil 3))
1678 (newval (archive-calc-mode oldmode newmode t))
1679 buffer-read-only)
1680 (cond ((memq creator '(2 3)) ; Unix + VMS
1681 (goto-char (+ p 40))
1682 (delete-char 2)
1683 (insert-unibyte (logand newval 255) (lsh newval -8)))
1684 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1685 (goto-char (+ p 38))
1686 (insert-unibyte (logior (logand (byte-after (point)) 254)
1687 (logand (logxor 1 (lsh newval -7)) 1)))
1688 (delete-char 1))
1689 (t (message "Don't know how to change mode for this member"))))
1690 (setq files (cdr files))))))
1691 ;; -------------------------------------------------------------------------
1692 ;; Section: Zoo Archives
1694 (defun archive-zoo-summarize ()
1695 (let ((p (1+ (archive-l-e 25 4)))
1696 (maxlen 8)
1697 (totalsize 0)
1698 files
1699 visual)
1700 (while (and (string= "\334\247\304\375" (buffer-substring p (+ p 4)))
1701 (> (archive-l-e (+ p 6) 4) 0))
1702 (let* ((next (1+ (archive-l-e (+ p 6) 4)))
1703 (moddate (archive-l-e (+ p 14) 2))
1704 (modtime (archive-l-e (+ p 16) 2))
1705 (ucsize (archive-l-e (+ p 20) 4))
1706 (namefld (buffer-substring (+ p 38) (+ p 38 13)))
1707 (dirtype (byte-after (+ p 4)))
1708 (lfnlen (if (= dirtype 2) (byte-after (+ p 56)) 0))
1709 (ldirlen (if (= dirtype 2) (byte-after (+ p 57)) 0))
1710 (fnlen (or (string-match "\0" namefld) 13))
1711 (efnname (let ((str
1712 (concat
1713 (if (> ldirlen 0)
1714 (concat (buffer-substring
1715 (+ p 58 lfnlen)
1716 (+ p 58 lfnlen ldirlen -1))
1717 "/")
1719 (if (> lfnlen 0)
1720 (buffer-substring (+ p 58)
1721 (+ p 58 lfnlen -1))
1722 (substring namefld 0 fnlen)))))
1723 (decode-coding-string
1724 str archive-file-name-coding-system)))
1725 (fiddle (and (= lfnlen 0) (string= efnname (upcase efnname))))
1726 (ifnname (if fiddle (downcase efnname) efnname))
1727 (width (string-width ifnname))
1728 (text (format " %8d %-11s %-8s %s"
1729 ucsize
1730 (archive-dosdate moddate)
1731 (archive-dostime modtime)
1732 ifnname)))
1733 (setq maxlen (max maxlen width)
1734 totalsize (+ totalsize ucsize)
1735 visual (cons (vector text
1736 (- (length text) (length ifnname))
1737 (length text))
1738 visual)
1739 files (cons (vector efnname ifnname fiddle nil (1- p))
1740 files)
1741 p next)))
1742 (goto-char (point-min))
1743 (let ((dash (concat "- -------- ----------- -------- "
1744 (make-string maxlen ?-)
1745 "\n")))
1746 (insert "M Length Date Time File\n"
1747 dash)
1748 (archive-summarize-files (nreverse visual))
1749 (insert dash
1750 (format " %8d %d file%s"
1751 totalsize
1752 (length files)
1753 (if (= 1 (length files)) "" "s"))
1754 "\n"))
1755 (apply 'vector (nreverse files))))
1757 (defun archive-zoo-extract (archive name)
1758 (archive-extract-by-stdout archive name archive-zoo-extract))
1759 ;; -------------------------------------------------------------------------
1760 ;; This line was a mistake; it is kept now for compatibility.
1761 ;; rms 15 Oct 98
1762 (provide 'archive-mode)
1764 (provide 'arc-mode)
1766 ;;; arc-mode.el ends here