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