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)
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.
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
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
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.
101 ;; archive-foo-mode-hook
102 ;; archive-extract-hooks
106 ;; -------------------------------------------------------------------------
107 ;;; Section: Configuration.
109 (defgroup archive nil
110 "Simple editing of archives."
113 (defgroup archive-arc nil
114 "ARC-specific options to archive."
117 (defgroup archive-lzh nil
118 "LZH-specific options to archive."
121 (defgroup archive-zip nil
122 "ZIP-specific options to archive."
125 (defgroup archive-zoo nil
126 "ZOO-specific options to archive."
129 (defcustom archive-tmpdir
130 ;; make-temp-name is safe here because we use this name
131 ;; to create a directory.
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'."
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."
146 (defcustom archive-extract-hooks nil
147 "*Hooks to run when an archive member has been extracted."
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
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
160 :type
'(list (string :tag
"Program")
161 (repeat :tag
"Options"
163 (string :format
"%v")))
166 (defcustom archive-arc-expunge
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"
173 (string :format
"%v")))
176 (defcustom archive-arc-write-file-member
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"
183 (string :format
"%v")))
185 ;; ------------------------------
186 ;; Lzh archive configuration
188 (defcustom archive-lzh-extract
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
193 :type
'(list (string :tag
"Program")
194 (repeat :tag
"Options"
196 (string :format
"%v")))
199 (defcustom archive-lzh-expunge
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"
206 (string :format
"%v")))
209 (defcustom archive-lzh-write-file-member
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"
216 (string :format
"%v")))
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
229 :type
'(list (string :tag
"Program")
230 (repeat :tag
"Options"
232 (string :format
"%v")))
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
240 (defcustom archive-zip-expunge
241 (if (and (not (executable-find "zip"))
242 (executable-find "pkzip"))
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"
250 (string :format
"%v")))
253 (defcustom archive-zip-update
254 (if (and (not (executable-find "zip"))
255 (executable-find "pkzip"))
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"
264 (string :format
"%v")))
267 (defcustom archive-zip-update-case
268 (if (and (not (executable-find "zip"))
269 (executable-find "pkzip"))
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"
278 (string :format
"%v")))
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."
287 ;; ------------------------------
288 ;; Zoo archive configuration
290 (defcustom archive-zoo-extract
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
295 :type
'(list (string :tag
"Program")
296 (repeat :tag
"Options"
298 (string :format
"%v")))
301 (defcustom archive-zoo-expunge
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"
308 (string :format
"%v")))
311 (defcustom archive-zoo-write-file-member
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"
318 (string :format
"%v")))
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)
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))
370 (if (featurep 'xemacs) 'button2 [mouse-2]) 'archive-extract)
372 (if (featurep 'xemacs)
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"))
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.
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."
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)."
490 (setq len (length str))
491 (setq str (buffer-substring str (+ str len))))
492 (setq str (string-as-unibyte str))
497 result (+ (if float (* result 256.0) (ash result 8))
498 (aref str (- len i)))))
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.
505 (if (zerop (logand 8192 mode))
506 (if (zerop (logand 16384 mode)) ?- ?d)
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)
532 (len (length newmode))
535 (setq result (+ (lsh result 3) (aref newmode i) (- ?0))
537 (logior (logand oldmode 65024) result)))
538 ((string-match "^\\([agou]+\\)\\([---+=]\\)\\([rwxst]+\\)$" newmode)
541 (op (aref newmode (match-beginning 2)))
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)
552 (while (< who (match-end 1))
553 (let* ((whoc (aref newmode who))
554 (whomask (cond ((= whoc ?a) 4095)
559 (setq result (logand result (lognot whomask))))
561 (setq result (logand result (lognot (logand whomask bits))))
562 (setq result (logior result (logand whomask bits)))))
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))
578 (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
579 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
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))))
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)))
618 (error "Entry is not a regular member of the archive"))))
620 (error "Line does not describe a member of the archive")))))
621 ;; -------------------------------------------------------------------------
622 ;;; Section: the mode definition
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
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)
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.
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 ()
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))))
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 ((and (looking-at "MZ")
732 (re-search-forward "Rar!" (+ (point) 100000) t))
734 (t (error "Buffer format not recognized")))))
735 ;; -------------------------------------------------------------------------
737 (defun archive-desummarize ()
738 (let ((inhibit-read-only t)
739 (modified (buffer-modified-p)))
741 (delete-region (point-min) archive-proper-file-start)
742 (restore-buffer-modified-p modified)))
745 (defun archive-summarize (&optional shut-up)
746 "Parse the contents of the archive file in the current buffer.
747 Place a dired-like listing on the front;
748 then narrow to it, so that only that listing
749 is visible (and the real data of the buffer is hidden).
750 Optional argument SHUT-UP, if non-nil, means don't print messages
751 when parsing the archive."
753 (let ((inhibit-read-only t))
754 (setq archive-proper-file-start (copy-marker (point-min) t))
755 (set (make-local-variable 'change-major-mode-hook) 'archive-desummarize)
757 (message "Parsing archive file..."))
758 (buffer-disable-undo (current-buffer))
759 (setq archive-files (funcall (archive-name "summarize")))
761 (message "Parsing archive file...done."))
762 (setq archive-proper-file-start (point-marker))
763 (narrow-to-region (point-min) (point))
764 (set-buffer-modified-p nil)
765 (buffer-enable-undo))
766 (goto-char archive-file-list-start)
767 (archive-next-line 0))
769 (defun archive-resummarize ()
770 "Recreate the contents listing of an archive."
771 (let ((no (archive-get-lineno)))
772 (archive-desummarize)
773 (archive-summarize t)
774 (goto-char archive-file-list-start)
775 (archive-next-line no)))
777 (defun archive-summarize-files (files)
778 "Insert a description of a list of files annotated with proper mouse face."
779 (setq archive-file-list-start (point-marker))
780 (setq archive-file-name-indent (if files (aref (car files) 1) 0))
781 ;; We don't want to do an insert for each element since that takes too
782 ;; long when the archive -- which has to be moved in memory -- is large.
788 ;; Using `concat' here copies the text also, so we can add
789 ;; properties without problems.
790 (let ((text (concat (aref fil 0) "\n")))
791 (if (featurep 'xemacs)
794 (aref fil 1) (aref fil 2)
795 '(mouse-face highlight
796 help-echo "mouse-2: extract this file into a buffer")
800 (setq archive-file-list-end (point-marker)))
802 (defun archive-alternate-display ()
803 "Toggle alternative display.
804 To avoid very long lines archive mode does not show all information.
805 This function changes the set of information shown for each files."
807 (setq archive-alternate-display (not archive-alternate-display))
808 (archive-resummarize))
809 ;; -------------------------------------------------------------------------
810 ;;; Section: Local archive copy handling
812 (defun archive-unique-fname (fname dir)
813 "Make sure a file FNAME can be created uniquely in directory DIR.
815 If FNAME can be uniquely created in DIR, it is returned unaltered.
816 If FNAME is something our underlying filesystem can't grok, or if another
817 file by that name already exists in DIR, a unique new name is generated
818 using `make-temp-file', and the generated name is returned."
819 (let ((fullname (expand-file-name fname dir))
820 (alien (string-match file-name-invalid-regexp fname)))
821 (if (or alien (file-exists-p fullname))
824 (if (if (fboundp 'msdos-long-file-names)
825 (not (msdos-long-file-names)))
831 (defun archive-maybe-copy (archive)
832 (let ((coding-system-for-write 'no-conversion))
834 (let ((start (point-max))
835 ;; Sometimes ARCHIVE is invalid while its actual name, as
836 ;; recorded in its parent archive, is not. For example, an
837 ;; archive bar.zip inside another archive foo.zip gets a name
838 ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
839 ;; So use the actual name if available.
841 (or (and archive-subfile-mode (aref archive-subfile-mode 0))
843 (setq archive-local-name
844 (archive-unique-fname archive-name archive-tmpdir))
845 ;; Maked sure all the leading directories in
846 ;; archive-local-name exist under archive-tmpdir, so that
847 ;; the directory structure recorded in the archive is
848 ;; reconstructed in the temporary directory.
849 (make-directory (file-name-directory archive-local-name) t)
852 (write-region start (point-max) archive-local-name nil 'nomessage))
854 (if (buffer-modified-p) (save-buffer))
857 (defun archive-maybe-update (unchanged)
859 (let ((name archive-local-name)
860 (modified (buffer-modified-p))
861 (coding-system-for-read 'no-conversion)
862 (lno (archive-get-lineno))
863 (inhibit-read-only t))
865 (setq archive-files nil)
867 (insert-file-contents name)
869 (goto-char archive-file-list-start)
870 (archive-next-line lno))
871 (archive-delete-local name)
874 "Buffer `%s' must be saved for changes to take effect"
875 (buffer-name (current-buffer))))
876 (set-buffer-modified-p (or modified (not unchanged))))))
878 (defun archive-delete-local (name)
879 "Delete file NAME and its parents up to and including `archive-tmpdir'."
881 (top (directory-file-name (file-name-as-directory archive-tmpdir))))
886 (setq name (directory-file-name (file-name-directory name)))
888 (delete-directory name)
890 (if (string= name top) (setq again nil)))))
891 ;; -------------------------------------------------------------------------
892 ;;; Section: Member extraction
894 (defun archive-file-name-handler (op &rest args)
895 (or (eq op 'file-exists-p)
896 (let ((file-name-handler-alist nil))
899 (defun archive-set-buffer-as-visiting-file (filename)
900 "Set the current buffer as if it were visiting FILENAME."
902 (goto-char (point-min))
903 (let ((buffer-undo-list t)
905 (or coding-system-for-read
906 (and set-auto-coding-function
908 (funcall set-auto-coding-function
909 filename (- (point-max) (point-min)))))
910 ;; dos-w32.el defines the function
911 ;; find-buffer-file-type-coding-system for DOS/Windows
912 ;; systems which preserves the coding-system of existing files.
913 ;; (That function is called via file-coding-system-alist.)
914 ;; Here, we want it to act as if the extracted file existed.
915 ;; The following let-binding of file-name-handler-alist forces
916 ;; find-file-not-found-set-buffer-file-coding-system to ignore
917 ;; the file's name (see dos-w32.el).
918 (let ((file-name-handler-alist
919 '(("" . archive-file-name-handler))))
920 (car (find-operation-coding-system
921 'insert-file-contents
922 (cons filename (current-buffer)) t))))))
923 (if (and (not coding-system-for-read)
924 (not enable-multibyte-characters))
926 (coding-system-change-text-conversion coding 'raw-text)))
928 (not (eq coding 'no-conversion)))
929 (decode-coding-region (point-min) (point-max) coding)
930 (setq last-coding-system-used coding))
931 (set-buffer-modified-p nil)
932 (kill-local-variable 'buffer-file-coding-system)
933 (after-insert-file-set-coding (- (point-max) (point-min))))))
935 (define-obsolete-function-alias 'archive-mouse-extract 'archive-extract "22.1")
937 (defun archive-extract (&optional other-window-p event)
938 "In archive mode, extract this entry of the archive into its own buffer."
939 (interactive (list nil last-input-event))
940 (if event (posn-set-point (event-end event)))
941 (let* ((view-p (eq other-window-p 'view))
942 (descr (archive-get-descr))
943 (ename (aref descr 0))
944 (iname (aref descr 1))
945 (archive-buffer (current-buffer))
946 (arcdir default-directory)
947 (archive (buffer-file-name))
948 (arcname (file-name-nondirectory archive))
949 (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
950 (extractor (archive-name "extract"))
951 ;; Members with file names which aren't valid for the
952 ;; underlying filesystem, are treated as read-only.
953 (read-only-p (or archive-read-only
955 (string-match file-name-invalid-regexp ename)))
956 (arcfilename (expand-file-name (concat arcname ":" iname)))
957 (buffer (get-buffer bufname))
959 (file-name-coding archive-file-name-coding-system))
961 (string= (buffer-file-name buffer) arcfilename))
963 (setq archive (archive-maybe-copy archive))
964 (setq bufname (generate-new-buffer-name bufname))
965 (setq buffer (get-buffer-create bufname))
966 (setq just-created t)
967 (with-current-buffer buffer
968 (setq buffer-file-name arcfilename)
969 (setq buffer-file-truename
970 (abbreviate-file-name buffer-file-name))
971 ;; Set the default-directory to the dir of the superior buffer.
972 (setq default-directory arcdir)
973 (make-local-variable 'archive-superior-buffer)
974 (setq archive-superior-buffer archive-buffer)
975 (add-hook 'write-file-functions 'archive-write-file-member nil t)
976 (setq archive-subfile-mode descr)
977 (setq archive-file-name-coding-system file-name-coding)
980 (let (;; We may have to encode file name arguement for
981 ;; external programs.
982 (coding-system-for-write
983 (and enable-multibyte-characters
984 archive-file-name-coding-system))
985 ;; We read an archive member by no-conversion at
986 ;; first, then decode appropriately by calling
987 ;; archive-set-buffer-as-visiting-file later.
988 (coding-system-for-read 'no-conversion))
990 (if (fboundp extractor)
991 (funcall extractor archive ename)
992 (archive-*-extract archive ename
993 (symbol-value extractor)))
995 (ding (message "%s" (error-message-string err)))
999 (set-buffer-modified-p nil)
1000 (kill-buffer buffer))
1001 (archive-set-buffer-as-visiting-file ename)
1002 (goto-char (point-min))
1003 (rename-buffer bufname)
1004 (setq buffer-read-only read-only-p)
1005 (setq buffer-undo-list nil)
1006 (set-buffer-modified-p nil)
1007 (setq buffer-saved-size (buffer-size))
1009 ;; Just in case an archive occurs inside another archive.
1010 (when (derived-mode-p 'archive-mode)
1011 (setq archive-remote t)
1012 (if read-only-p (setq archive-read-only t))
1013 ;; We will write out the archive ourselves if it is
1014 ;; part of another archive.
1015 (remove-hook 'write-contents-functions 'archive-write-file t))
1016 (run-hooks 'archive-extract-hooks)
1017 (if archive-read-only
1018 (message "Note: altering this archive is not implemented."))))
1019 (archive-maybe-update t))
1020 (or (not (buffer-name buffer))
1022 (view-p (view-buffer
1023 buffer (and just-created 'kill-buffer-if-not-modified)))
1024 ((eq other-window-p 'display) (display-buffer buffer))
1025 (other-window-p (switch-to-buffer-other-window buffer))
1026 (t (switch-to-buffer buffer))))))
1028 (defun archive-*-extract (archive name command)
1029 (let* ((default-directory (file-name-as-directory archive-tmpdir))
1030 (tmpfile (expand-file-name (file-name-nondirectory name)
1032 exit-status success)
1033 (make-directory (directory-file-name default-directory) t)
1035 (apply 'call-process
1040 (append (cdr command) (list archive name))))
1041 (cond ((and (numberp exit-status) (= exit-status 0))
1042 (if (not (file-exists-p tmpfile))
1043 (ding (message "`%s': no such file or directory" tmpfile))
1044 (insert-file-contents tmpfile)
1046 ((numberp exit-status)
1048 (message "`%s' exited with status %d" (car command) exit-status)))
1049 ((stringp exit-status)
1050 (ding (message "`%s' aborted: %s" (car command) exit-status)))
1052 (ding (message "`%s' failed" (car command)))))
1053 (archive-delete-local tmpfile)
1056 (defun archive-extract-by-stdout (archive name command)
1057 (apply 'call-process
1062 (append (cdr command) (list archive name))))
1064 (defun archive-extract-other-window ()
1065 "In archive mode, find this member in another window."
1067 (archive-extract t))
1069 (defun archive-display-other-window ()
1070 "In archive mode, display this member in another window."
1072 (archive-extract 'display))
1074 (defun archive-view ()
1075 "In archive mode, view the member on this line."
1077 (archive-extract 'view))
1079 (defun archive-add-new-member (arcbuf name)
1080 "Add current buffer to the archive in ARCBUF naming it NAME."
1083 (read-buffer "Buffer containing archive: "
1084 ;; Find first archive buffer and suggest that
1085 (let ((bufs (buffer-list)))
1087 (not (with-current-buffer (car bufs)
1088 (derived-mode-p 'archive-mode))))
1089 (setq bufs (cdr bufs)))
1092 (error "There are no archive buffers")))
1094 (read-string "File name in archive: "
1095 (if buffer-file-name
1096 (file-name-nondirectory buffer-file-name)
1098 (with-current-buffer arcbuf
1099 (or (eq major-mode 'archive-mode)
1100 (error "Buffer is not an archive buffer"))
1101 (if archive-read-only
1102 (error "Archive is read-only")))
1103 (if (eq arcbuf (current-buffer))
1104 (error "An archive buffer cannot be added to itself"))
1105 (if (string= name "")
1106 (error "Archive members may not be given empty names"))
1107 (let ((func (with-current-buffer arcbuf
1108 (archive-name "add-new-member")))
1109 (membuf (current-buffer)))
1111 (with-current-buffer arcbuf
1112 (funcall func buffer-file-name membuf name))
1113 (error "Adding a new member is not supported for this archive type"))))
1114 ;; -------------------------------------------------------------------------
1115 ;;; Section: IO stuff
1117 (defun archive-write-file-member ()
1120 (message "Updating archive...")
1122 (let ((writer (with-current-buffer archive-superior-buffer
1123 (archive-name "write-file-member")))
1124 (archive (with-current-buffer archive-superior-buffer
1125 (archive-maybe-copy (buffer-file-name)))))
1126 (if (fboundp writer)
1127 (funcall writer archive archive-subfile-mode)
1128 (archive-*-write-file-member archive
1129 archive-subfile-mode
1130 (symbol-value writer)))
1131 (set-buffer-modified-p nil)
1132 (message "Updating archive...done"))
1133 (set-buffer archive-superior-buffer)
1134 (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
1135 ;; Restore the value of last-coding-system-used, so that basic-save-buffer
1136 ;; won't reset the coding-system of this archive member.
1137 (if (local-variable-p 'archive-member-coding-system)
1138 (setq last-coding-system-used archive-member-coding-system))
1141 (defun archive-*-write-file-member (archive descr command)
1142 (let* ((ename (aref descr 0))
1143 (tmpfile (expand-file-name ename archive-tmpdir))
1144 (top (directory-file-name (file-name-as-directory archive-tmpdir)))
1145 (default-directory (file-name-as-directory top)))
1148 (make-directory (file-name-directory tmpfile) t)
1149 ;; If the member is itself an archive, write it without
1150 ;; the dired-like listing we created.
1151 (if (eq major-mode 'archive-mode)
1152 (archive-write-file tmpfile)
1153 (write-region (point-min) (point-max) tmpfile nil 'nomessage))
1154 ;; basic-save-buffer needs last-coding-system-used to have
1155 ;; the value used to write the file, so save it before any
1156 ;; further processing clobbers it (we restore it in
1157 ;; archive-write-file-member, above).
1158 (setq archive-member-coding-system last-coding-system-used)
1160 ;; Set the file modes, but make sure we can read it.
1161 (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1163 (encode-coding-string ename archive-file-name-coding-system))
1164 (let* ((coding-system-for-write 'no-conversion)
1165 (exitcode (apply 'call-process
1170 (append (cdr command)
1171 (list archive ename)))))
1172 (if (equal exitcode 0)
1174 (error "Updating was unsuccessful (%S)" exitcode))))
1175 (archive-delete-local tmpfile))))
1177 (defun archive-write-file (&optional file)
1179 (let ((coding-system-for-write 'no-conversion))
1180 (write-region archive-proper-file-start (point-max)
1181 (or file buffer-file-name) nil t)
1182 (set-buffer-modified-p nil))
1184 ;; -------------------------------------------------------------------------
1185 ;;; Section: Marking and unmarking.
1187 (defun archive-flag-deleted (p &optional type)
1188 "In archive mode, mark this member to be deleted from the archive.
1189 With a prefix argument, mark that many files."
1191 (or type (setq type ?D))
1193 (let ((sign (if (>= p 0) +1 -1))
1194 (modified (buffer-modified-p))
1195 (inhibit-read-only t))
1196 (while (not (zerop p))
1197 (if (archive-get-descr t)
1202 (setq p (- p sign)))
1203 (restore-buffer-modified-p modified))
1204 (archive-next-line 0))
1206 (defun archive-unflag (p)
1207 "In archive mode, un-mark this member if it is marked to be deleted.
1208 With a prefix argument, un-mark that many files forward."
1210 (archive-flag-deleted p ?\s))
1212 (defun archive-unflag-backwards (p)
1213 "In archive mode, un-mark this member if it is marked to be deleted.
1214 With a prefix argument, un-mark that many members backward."
1216 (archive-flag-deleted (- p) ?\s))
1218 (defun archive-unmark-all-files ()
1221 (let ((modified (buffer-modified-p))
1222 (inhibit-read-only t))
1224 (goto-char archive-file-list-start)
1225 (while (< (point) archive-file-list-end)
1226 (or (= (following-char) ?\s)
1227 (progn (delete-char 1) (insert ?\s)))
1229 (restore-buffer-modified-p modified)))
1231 (defun archive-mark (p)
1232 "In archive mode, mark this member for group operations.
1233 With a prefix argument, mark that many members.
1234 Use \\[archive-unmark-all-files] to remove all marks."
1236 (archive-flag-deleted p ?*))
1238 (defun archive-get-marked (mark &optional default)
1241 (goto-char archive-file-list-start)
1242 (while (< (point) archive-file-list-end)
1243 (if (= (following-char) mark)
1244 (setq files (cons (archive-get-descr) files)))
1246 (or (nreverse files)
1248 (list (archive-get-descr))))))
1249 ;; -------------------------------------------------------------------------
1250 ;;; Section: Operate
1252 (defun archive-next-line (p)
1256 (forward-char archive-file-name-indent)))
1258 (defun archive-previous-line (p)
1260 (archive-next-line (- p)))
1262 (defun archive-chmod-entry (new-mode)
1263 "Change the protection bits associated with all marked or this member.
1264 The new protection bits can either be specified as an octal number or
1265 as a relative change like \"g+rw\" as for chmod(2)."
1266 (interactive "sNew mode (octal or relative): ")
1267 (if archive-read-only (error "Archive is read-only"))
1268 (let ((func (archive-name "chmod-entry")))
1271 (funcall func new-mode (archive-get-marked ?* t))
1272 (archive-resummarize))
1273 (error "Setting mode bits is not supported for this archive type"))))
1275 (defun archive-chown-entry (new-uid)
1276 "Change the owner of all marked or this member."
1277 (interactive "nNew uid: ")
1278 (if archive-read-only (error "Archive is read-only"))
1279 (let ((func (archive-name "chown-entry")))
1282 (funcall func new-uid (archive-get-marked ?* t))
1283 (archive-resummarize))
1284 (error "Setting owner is not supported for this archive type"))))
1286 (defun archive-chgrp-entry (new-gid)
1287 "Change the group of all marked or this member."
1288 (interactive "nNew gid: ")
1289 (if archive-read-only (error "Archive is read-only"))
1290 (let ((func (archive-name "chgrp-entry")))
1293 (funcall func new-gid (archive-get-marked ?* t))
1294 (archive-resummarize))
1295 (error "Setting group is not supported for this archive type"))))
1297 (defun archive-expunge ()
1298 "Do the flagged deletions."
1302 (goto-char archive-file-list-start)
1303 (while (< (point) archive-file-list-end)
1304 (if (= (following-char) ?D)
1305 (setq files (cons (aref (archive-get-descr) 0) files)))
1307 (setq files (nreverse files))
1309 (or (not archive-read-only)
1310 (error "Archive is read-only"))
1311 (or (yes-or-no-p (format "Really delete %d member%s? "
1313 (if (null (cdr files)) "" "s")))
1314 (error "Operation aborted"))
1315 (let ((archive (archive-maybe-copy (buffer-file-name)))
1316 (expunger (archive-name "expunge")))
1317 (if (fboundp expunger)
1318 (funcall expunger archive files)
1319 (archive-*-expunge archive files (symbol-value expunger)))
1320 (archive-maybe-update nil)
1322 (archive-resummarize)
1323 (revert-buffer))))))
1325 (defun archive-*-expunge (archive files command)
1326 (apply 'call-process
1331 (append (cdr command) (cons archive files))))
1333 (defun archive-rename-entry (newname)
1334 "Change the name associated with this entry in the archive file."
1335 (interactive "sNew name: ")
1336 (if archive-read-only (error "Archive is read-only"))
1337 (if (string= newname "")
1338 (error "Archive members may not be given empty names"))
1339 (let ((func (archive-name "rename-entry"))
1340 (descr (archive-get-descr)))
1344 (encode-coding-string newname
1345 archive-file-name-coding-system)
1347 (archive-resummarize))
1348 (error "Renaming is not supported for this archive type"))))
1350 ;; Revert the buffer and recompute the dired-like listing.
1351 (defun archive-mode-revert (&optional no-auto-save no-confirm)
1352 (let ((no (archive-get-lineno)))
1353 (setq archive-files nil)
1354 (let ((revert-buffer-function nil)
1355 (coding-system-for-read 'no-conversion))
1356 (revert-buffer t t))
1358 (goto-char archive-file-list-start)
1359 (archive-next-line no)))
1361 (defun archive-undo ()
1362 "Undo in an archive buffer.
1363 This doesn't recover lost files, it just undoes changes in the buffer itself."
1365 (let ((inhibit-read-only t))
1367 ;; -------------------------------------------------------------------------
1368 ;;; Section: Arc Archives
1370 (defun archive-arc-summarize ()
1376 (while (and (< (+ p 29) (point-max))
1377 (= (byte-after p) ?\C-z)
1378 (> (byte-after (1+ p)) 0))
1379 (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13)))
1380 (fnlen (or (string-match "\0" namefld) 13))
1381 (efnname (decode-coding-string (substring namefld 0 fnlen)
1382 archive-file-name-coding-system))
1383 ;; Convert to float to avoid overflow for very large files.
1384 (csize (archive-l-e (+ p 15) 4 'float))
1385 (moddate (archive-l-e (+ p 19) 2))
1386 (modtime (archive-l-e (+ p 21) 2))
1387 (ucsize (archive-l-e (+ p 25) 4 'float))
1388 (fiddle (string= efnname (upcase efnname)))
1389 (ifnname (if fiddle (downcase efnname) efnname))
1390 (text (format " %8.0f %-11s %-8s %s"
1392 (archive-dosdate moddate)
1393 (archive-dostime modtime)
1395 (setq maxlen (max maxlen fnlen)
1396 totalsize (+ totalsize ucsize)
1397 visual (cons (vector text
1398 (- (length text) (length ifnname))
1401 files (cons (vector efnname ifnname fiddle nil (1- p))
1403 ;; p needs to stay an integer, since we use it in char-after
1404 ;; above. Passing through `round' limits the compressed size
1405 ;; to most-positive-fixnum, but if the compressed size exceeds
1406 ;; that, we cannot visit the archive anyway.
1407 p (+ p 29 (round csize)))))
1408 (goto-char (point-min))
1409 (let ((dash (concat "- -------- ----------- -------- "
1410 (make-string maxlen ?-)
1412 (insert "M Length Date Time File\n"
1414 (archive-summarize-files (nreverse visual))
1416 (format " %8.0f %d file%s"
1419 (if (= 1 (length files)) "" "s"))
1421 (apply 'vector (nreverse files))))
1423 (defun archive-arc-rename-entry (newname descr)
1424 (if (string-match "[:\\\\/]" newname)
1425 (error "File names in arc files must not contain a directory component"))
1426 (if (> (length newname) 12)
1427 (error "File names in arc files are limited to 12 characters"))
1428 (let ((name (concat newname (substring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
1430 (inhibit-read-only t))
1434 (goto-char (+ archive-proper-file-start (aref descr 4) 2))
1436 (insert-unibyte name)))))
1437 ;; -------------------------------------------------------------------------
1438 ;;; Section: Lzh Archives
1440 (defun archive-lzh-summarize (&optional start)
1441 (let ((p (or start 1)) ;; 1 for .lzh, something further on for .exe
1446 (while (progn (goto-char p) ;beginning of a base header.
1447 (looking-at "\\(.\\|\n\\)\\(.\\|\n\\)-l[hz][0-9ds]-"))
1448 (let* ((hsize (byte-after p)) ;size of the base header (level 0 and 1)
1449 ;; Convert to float to avoid overflow for very large files.
1450 (csize (archive-l-e (+ p 7) 4 'float)) ;size of a compressed file to follow (level 0 and 2),
1451 ;size of extended headers + the compressed file to follow (level 1).
1452 (ucsize (archive-l-e (+ p 11) 4 'float)) ;size of an uncompressed file.
1453 (time1 (archive-l-e (+ p 15) 2)) ;date/time (MSDOS format in level 0, 1 headers
1454 (time2 (archive-l-e (+ p 17) 2)) ;and UNIX format in level 2 header.)
1455 (hdrlvl (byte-after (+ p 20))) ;header level
1456 thsize ;total header size (base + extensions)
1457 fnlen efnname osid fiddle ifnname width p2
1458 neh ;beginning of next extension header (level 1 and 2)
1459 mode modestr uid gid text dir prname
1460 gname uname modtime moddate)
1461 (if (= hdrlvl 3) (error "can't handle lzh level 3 header type"))
1462 (when (or (= hdrlvl 0) (= hdrlvl 1))
1463 (setq fnlen (byte-after (+ p 21))) ;filename length
1464 (setq efnname (let ((str (buffer-substring (+ p 22) (+ p 22 fnlen)))) ;filename from offset 22
1465 (decode-coding-string
1466 str archive-file-name-coding-system)))
1467 (setq p2 (+ p 22 fnlen))) ;
1469 (setq neh (+ p2 3)) ;specific to level 1 header
1471 (setq neh (+ p 24)))) ;specific to level 2 header
1472 (if neh ;if level 1 or 2 we expect extension headers to follow
1473 (let* ((ehsize (archive-l-e neh 2)) ;size of the extension header
1474 (etype (byte-after (+ neh 2)))) ;extension type
1475 (while (not (= ehsize 0))
1477 ((= etype 1) ;file name
1478 (let ((i (+ neh 3)))
1479 (while (< i (+ neh ehsize))
1480 (setq efnname (concat efnname (char-to-string (byte-after i))))
1482 ((= etype 2) ;directory name
1483 (let ((i (+ neh 3)))
1484 (while (< i (+ neh ehsize))
1485 (setq dir (concat dir
1486 (if (= (byte-after i)
1492 ((= etype 80) ;Unix file permission
1493 (setq mode (archive-l-e (+ neh 3) 2)))
1494 ((= etype 81) ;UNIX file group/user ID
1495 (progn (setq uid (archive-l-e (+ neh 3) 2))
1496 (setq gid (archive-l-e (+ neh 5) 2))))
1497 ((= etype 82) ;UNIX file group name
1498 (let ((i (+ neh 3)))
1499 (while (< i (+ neh ehsize))
1500 (setq gname (concat gname (char-to-string (char-after i))))
1502 ((= etype 83) ;UNIX file user name
1503 (let ((i (+ neh 3)))
1504 (while (< i (+ neh ehsize))
1505 (setq uname (concat uname (char-to-string (char-after i))))
1508 (setq neh (+ neh ehsize))
1509 (setq ehsize (archive-l-e neh 2))
1510 (setq etype (byte-after (+ neh 2))))
1511 ;;get total header size for level 1 and 2 headers
1512 (setq thsize (- neh p))))
1513 (if (= hdrlvl 0) ;total header size
1514 (setq thsize hsize))
1515 ;; OS ID field not present in level 0 header, use code 0 "generic"
1516 ;; in that case as per lha program header.c get_header()
1517 (setq osid (cond ((= hdrlvl 0) 0)
1518 ((= hdrlvl 1) (char-after (+ p 22 fnlen 2)))
1519 ((= hdrlvl 2) (char-after (+ p 23)))))
1520 ;; Filename fiddling must follow the lha program, otherwise the name
1521 ;; passed to "lha pq" etc won't match (which for an extract silently
1522 ;; results in no output). As of version 1.14i it goes from the OS ID,
1523 ;; - For 'M' MSDOS: msdos_to_unix_filename() downcases always, and
1524 ;; converts "\" to "/".
1525 ;; - For 0 generic: generic_to_unix_filename() downcases if there's
1526 ;; no lower case already present, and converts "\" to "/".
1527 ;; - For 'm' MacOS: macos_to_unix_filename() changes "/" to ":" and
1529 (setq fiddle (cond ((= ?M osid) t)
1530 ((= 0 osid) (string= efnname (upcase efnname)))))
1531 (setq ifnname (if fiddle (downcase efnname) efnname))
1532 (setq prname (if dir (concat dir ifnname) ifnname))
1533 (setq width (if prname (string-width prname) 0))
1534 (setq modestr (if mode (archive-int-to-mode mode) "??????????"))
1535 (setq moddate (if (= hdrlvl 2)
1536 (archive-unixdate time1 time2) ;level 2 header in UNIX format
1537 (archive-dosdate time2))) ;level 0 and 1 header in DOS format
1538 (setq modtime (if (= hdrlvl 2)
1539 (archive-unixtime time1 time2)
1540 (archive-dostime time1)))
1541 (setq text (if archive-alternate-display
1542 (format " %8.0f %5S %5S %s"
1547 (format " %10s %8.0f %-11s %-8s %s"
1553 (setq maxlen (max maxlen width)
1554 totalsize (+ totalsize ucsize)
1555 visual (cons (vector text
1556 (- (length text) (length prname))
1559 files (cons (vector prname ifnname fiddle mode (1- p))
1562 ;; p needs to stay an integer, since we use it in goto-char
1563 ;; above. Passing through `round' limits the compressed size
1564 ;; to most-positive-fixnum, but if the compressed size exceeds
1565 ;; that, we cannot visit the archive anyway.
1566 (setq p (+ p hsize 2 (round csize))))
1567 ((or (= hdrlvl 2) (= hdrlvl 0))
1568 (setq p (+ p thsize 2 (round csize)))))
1570 (goto-char (point-min))
1571 (let ((dash (concat (if archive-alternate-display
1572 "- -------- ----- ----- "
1573 "- ---------- -------- ----------- -------- ")
1574 (make-string maxlen ?-)
1576 (header (if archive-alternate-display
1577 "M Length Uid Gid File\n"
1578 "M Filemode Length Date Time File\n"))
1579 (sumline (if archive-alternate-display
1581 " %8.0f %d file%s")))
1582 (insert header dash)
1583 (archive-summarize-files (nreverse visual))
1588 (if (= 1 (length files)) "" "s"))
1590 (apply 'vector (nreverse files))))
1592 (defconst archive-lzh-alternate-display t)
1594 (defun archive-lzh-extract (archive name)
1595 (archive-extract-by-stdout archive name archive-lzh-extract))
1597 (defun archive-lzh-resum (p count)
1600 (setq count (1- count)
1601 sum (+ sum (byte-after p))
1605 (defun archive-lzh-rename-entry (newname descr)
1609 (let* ((p (+ archive-proper-file-start (aref descr 4)))
1610 (oldhsize (byte-after p))
1611 (oldfnlen (byte-after (+ p 21)))
1612 (newfnlen (length newname))
1613 (newhsize (+ oldhsize newfnlen (- oldfnlen)))
1614 (inhibit-read-only t))
1615 (if (> newhsize 255)
1616 (error "The file name is too long"))
1617 (goto-char (+ p 21))
1618 (delete-char (1+ oldfnlen))
1619 (insert-unibyte newfnlen newname)
1622 (insert-unibyte newhsize (archive-lzh-resum p newhsize))))))
1624 (defun archive-lzh-ogm (newval files errtxt ofs)
1629 (let* ((p (+ archive-proper-file-start (aref fil 4)))
1630 (hsize (byte-after p))
1631 (fnlen (byte-after (+ p 21)))
1633 (creator (if (>= (- hsize fnlen) 24) (byte-after (+ p2 2)) 0))
1634 (inhibit-read-only t))
1637 (or (numberp newval)
1638 (setq newval (funcall newval (archive-l-e (+ p2 ofs) 2))))
1639 (goto-char (+ p2 ofs))
1641 (insert-unibyte (logand newval 255) (lsh newval -8))
1644 (insert-unibyte (archive-lzh-resum (1+ p) hsize)))
1645 (message "Member %s does not have %s field"
1646 (aref fil 1) errtxt)))))))
1648 (defun archive-lzh-chown-entry (newuid files)
1649 (archive-lzh-ogm newuid files "an uid" 10))
1651 (defun archive-lzh-chgrp-entry (newgid files)
1652 (archive-lzh-ogm newgid files "a gid" 12))
1654 (defun archive-lzh-chmod-entry (newmode files)
1656 ;; This should work even though newmode will be dynamically accessed.
1657 (lambda (old) (archive-calc-mode old newmode t))
1658 files "a unix-style mode" 8))
1660 ;; -------------------------------------------------------------------------
1661 ;;; Section: Lzh Self-Extracting .exe Archives
1663 ;; No support for modifying these files. It looks like the lha for unix
1664 ;; program (as of version 1.14i) can't create or retain the DOS exe part.
1665 ;; If you do an "lha a" on a .exe for instance it renames and writes to a
1668 (defun archive-lzh-exe-summarize ()
1669 "Summarize the contents of an LZH self-extracting exe, for `archive-mode'."
1671 ;; Skip the initial executable code part and apply archive-lzh-summarize
1672 ;; to the archive part proper. The "-lh5-" etc regexp here for the start
1673 ;; is the same as in archive-find-type.
1675 ;; The lha program (version 1.14i) does this in skip_msdos_sfx1_code() by
1676 ;; a similar scan. It looks for "..-l..-" plus for level 0 or 1 a test of
1677 ;; the header checksum, or level 2 a test of the "attribute" and size.
1679 (re-search-forward "..-l[hz][0-9ds]-" nil)
1680 (archive-lzh-summarize (match-beginning 0)))
1682 ;; `archive-lzh-extract' runs "lha pq", and that works for .exe as well as
1684 (defalias 'archive-lzh-exe-extract 'archive-lzh-extract
1685 "Extract a member from an LZH self-extracting exe, for `archive-mode'.")
1687 ;; -------------------------------------------------------------------------
1688 ;;; Section: Zip Archives
1690 (defun archive-zip-summarize ()
1691 (goto-char (- (point-max) (- 22 18)))
1692 (search-backward-regexp "[P]K\005\006")
1693 (let ((p (+ (point-min) (archive-l-e (+ (point) 16) 4)))
1698 (while (string= "PK\001\002" (buffer-substring p (+ p 4)))
1699 (let* ((creator (byte-after (+ p 5)))
1700 ;; (method (archive-l-e (+ p 10) 2))
1701 (modtime (archive-l-e (+ p 12) 2))
1702 (moddate (archive-l-e (+ p 14) 2))
1703 ;; Convert to float to avoid overflow for very large files.
1704 (ucsize (archive-l-e (+ p 24) 4 'float))
1705 (fnlen (archive-l-e (+ p 28) 2))
1706 (exlen (archive-l-e (+ p 30) 2))
1707 (fclen (archive-l-e (+ p 32) 2))
1708 (lheader (archive-l-e (+ p 42) 4))
1709 (efnname (let ((str (buffer-substring (+ p 46) (+ p 46 fnlen))))
1710 (decode-coding-string
1711 str archive-file-name-coding-system)))
1712 (isdir (and (= ucsize 0)
1713 (string= (file-name-nondirectory efnname) "")))
1714 (mode (cond ((memq creator '(2 3)) ; Unix + VMS
1715 (archive-l-e (+ p 40) 2))
1716 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1718 (if isdir (logior 16384 ?\111) 0)
1720 (logand 1 (byte-after (+ p 38))))
1723 (modestr (if mode (archive-int-to-mode mode) "??????????"))
1724 (fiddle (and archive-zip-case-fiddle
1725 (not (not (memq creator '(0 2 4 5 9))))
1726 (string= (upcase efnname) efnname)))
1727 (ifnname (if fiddle (downcase efnname) efnname))
1728 (width (string-width ifnname))
1729 (text (format " %10s %8.0f %-11s %-8s %s"
1732 (archive-dosdate moddate)
1733 (archive-dostime modtime)
1735 (setq maxlen (max maxlen width)
1736 totalsize (+ totalsize ucsize)
1737 visual (cons (vector text
1738 (- (length text) (length ifnname))
1741 files (cons (if isdir
1743 (vector efnname ifnname fiddle mode
1744 (list (1- p) lheader)))
1746 p (+ p 46 fnlen exlen fclen))))
1747 (goto-char (point-min))
1748 (let ((dash (concat "- ---------- -------- ----------- -------- "
1749 (make-string maxlen ?-)
1751 (insert "M Filemode Length Date Time File\n"
1753 (archive-summarize-files (nreverse visual))
1755 (format " %8.0f %d file%s"
1758 (if (= 1 (length files)) "" "s"))
1760 (apply 'vector (nreverse files))))
1762 (defun archive-zip-extract (archive name)
1763 (if (equal (car archive-zip-extract) "pkzip")
1764 (archive-*-extract archive name archive-zip-extract)
1765 (archive-extract-by-stdout archive name archive-zip-extract)))
1767 (defun archive-zip-write-file-member (archive descr)
1768 (archive-*-write-file-member
1771 (if (aref descr 2) archive-zip-update-case archive-zip-update)))
1773 (defun archive-zip-chmod-entry (newmode files)
1778 (let* ((p (+ archive-proper-file-start (car (aref fil 4))))
1779 (creator (byte-after (+ p 5)))
1780 (oldmode (aref fil 3))
1781 (newval (archive-calc-mode oldmode newmode t))
1782 (inhibit-read-only t))
1783 (cond ((memq creator '(2 3)) ; Unix + VMS
1784 (goto-char (+ p 40))
1786 (insert-unibyte (logand newval 255) (lsh newval -8)))
1787 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1788 (goto-char (+ p 38))
1789 (insert-unibyte (logior (logand (byte-after (point)) 254)
1790 (logand (logxor 1 (lsh newval -7)) 1)))
1792 (t (message "Don't know how to change mode for this member"))))
1794 ;; -------------------------------------------------------------------------
1795 ;;; Section: Zoo Archives
1797 (defun archive-zoo-summarize ()
1798 (let ((p (1+ (archive-l-e 25 4)))
1803 (while (and (string= "\334\247\304\375" (buffer-substring p (+ p 4)))
1804 (> (archive-l-e (+ p 6) 4) 0))
1805 (let* ((next (1+ (archive-l-e (+ p 6) 4)))
1806 (moddate (archive-l-e (+ p 14) 2))
1807 (modtime (archive-l-e (+ p 16) 2))
1808 ;; Convert to float to avoid overflow for very large files.
1809 (ucsize (archive-l-e (+ p 20) 4 'float))
1810 (namefld (buffer-substring (+ p 38) (+ p 38 13)))
1811 (dirtype (byte-after (+ p 4)))
1812 (lfnlen (if (= dirtype 2) (byte-after (+ p 56)) 0))
1813 (ldirlen (if (= dirtype 2) (byte-after (+ p 57)) 0))
1814 (fnlen (or (string-match "\0" namefld) 13))
1818 (concat (buffer-substring
1820 (+ p 58 lfnlen ldirlen -1))
1824 (buffer-substring (+ p 58)
1826 (substring namefld 0 fnlen)))))
1827 (decode-coding-string
1828 str archive-file-name-coding-system)))
1829 (fiddle (and (= lfnlen 0) (string= efnname (upcase efnname))))
1830 (ifnname (if fiddle (downcase efnname) efnname))
1831 (width (string-width ifnname))
1832 (text (format " %8.0f %-11s %-8s %s"
1834 (archive-dosdate moddate)
1835 (archive-dostime modtime)
1837 (setq maxlen (max maxlen width)
1838 totalsize (+ totalsize ucsize)
1839 visual (cons (vector text
1840 (- (length text) (length ifnname))
1843 files (cons (vector efnname ifnname fiddle nil (1- p))
1846 (goto-char (point-min))
1847 (let ((dash (concat "- -------- ----------- -------- "
1848 (make-string maxlen ?-)
1850 (insert "M Length Date Time File\n"
1852 (archive-summarize-files (nreverse visual))
1854 (format " %8.0f %d file%s"
1857 (if (= 1 (length files)) "" "s"))
1859 (apply 'vector (nreverse files))))
1861 (defun archive-zoo-extract (archive name)
1862 (archive-extract-by-stdout archive name archive-zoo-extract))
1864 ;; -------------------------------------------------------------------------
1865 ;;; Section: Rar Archives
1867 (defun archive-rar-summarize (&optional file)
1868 ;; File is used internally for `archive-rar-exe-summarize'.
1869 (unless file (setq file buffer-file-name))
1870 (let* ((copy (file-local-copy file))
1875 (call-process "unrar-free" nil t nil "--list" (or file copy))
1876 (if copy (delete-file copy))
1877 (goto-char (point-min))
1878 (re-search-forward "^-+\n")
1879 (while (looking-at (concat " \\(.*\\)\n" ;Name.
1881 " +\\([0-9]+\\) +[0-9]+"
1883 " +\\([0-9%]+\\) +\\([-0-9]+\\)"
1885 " +\\([0-9:]+\\) +......"
1887 " +[0-9A-F]+ +[^ \n]+ +[0-9.]+\n"))
1888 (goto-char (match-end 0))
1889 (let ((name (match-string 1))
1890 (size (match-string 2)))
1891 (if (> (length name) maxname) (setq maxname (length name)))
1892 (if (> (length size) maxsize) (setq maxsize (length size)))
1893 (push (vector name name nil nil
1895 size (match-string 3)
1897 (match-string 4) (match-string 5))
1899 (setq files (nreverse files))
1900 (goto-char (point-min))
1901 (let* ((format (format " %%s %%s %%%ds %%5s %%s" maxsize))
1902 (sep (format format "--------" "-----" (make-string maxsize ?-)
1904 (column (length sep)))
1905 (insert (format format " Date " "Time " "Size " "Ratio" " Filename") "\n")
1906 (insert sep (make-string maxname ?-) "\n")
1907 (archive-summarize-files (mapcar (lambda (desc)
1919 (insert sep (make-string maxname ?-) "\n")
1920 (apply 'vector files))))
1922 (defun archive-rar-extract (archive name)
1923 ;; unrar-free seems to have no way to extract to stdout or even to a file.
1924 (if (file-name-absolute-p name)
1925 ;; The code below assumes the name is relative and may do undesirable
1926 ;; things otherwise.
1927 (error "Can't extract files with non-relative names")
1928 (let ((dest (make-temp-file "arc-rar" 'dir)))
1931 (call-process "unrar-free" nil nil nil
1932 "--extract" archive name dest)
1933 (insert-file-contents-literally (expand-file-name name dest)))
1934 (delete-file (expand-file-name name dest))
1935 (while (file-name-directory name)
1936 (setq name (directory-file-name (file-name-directory name)))
1937 (delete-directory (expand-file-name name dest)))
1938 (delete-directory dest)))))
1940 ;;; Section: Rar self-extracting .exe archives.
1942 (defun archive-rar-exe-summarize ()
1943 (let ((tmpfile (make-temp-file "rarexe")))
1946 (goto-char (point-min))
1947 (re-search-forward "Rar!")
1948 (write-region (match-beginning 0) (point-max) tmpfile)
1949 (archive-rar-summarize tmpfile))
1950 (delete-file tmpfile))))
1952 (defun archive-rar-exe-extract (archive name)
1953 (let* ((tmpfile (make-temp-file "rarexe"))
1954 (buf (find-buffer-visiting archive))
1955 (tmpbuf (unless buf (generate-new-buffer " *rar-exe*"))))
1958 (with-current-buffer (or buf tmpbuf)
1962 ;; point-max unwidened is assumed to be the end of the
1963 ;; summary text and the beginning of the actual file data.
1964 (progn (goto-char (point-max)) (widen))
1965 (insert-file-contents-literally archive)
1966 (goto-char (point-min)))
1967 (re-search-forward "Rar!")
1968 (write-region (match-beginning 0) (point-max) tmpfile))))
1969 (archive-rar-extract tmpfile name))
1970 (if tmpbuf (kill-buffer tmpbuf))
1971 (delete-file tmpfile))))
1974 ;; -------------------------------------------------------------------------
1975 ;; This line was a mistake; it is kept now for compatibility.
1978 (provide 'archive-mode)
1982 ;; arch-tag: e5966a01-35ec-4f27-8095-a043a79b457b
1983 ;;; arc-mode.el ends here