| blob | 404e4543e0b454e65e8ce823197b2807eb94164e |
1 ;;; arc-mode.el --- simple editing of archives
3 ;; Copyright (C) 1995, 1997, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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"
31 ;;
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
39 ;;
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.
45 ;;
46 ;; * dos-fns.el: (Part of Emacs 19). You get automatic ^M^J <--> ^J
47 ;; conversion.
48 ;;
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.
56 ;;
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
68 ;;
69 ;; Special thanks to Bill Brodie <wbrodie@panix.com> for very useful tips
70 ;; on the first released version of this package.
71 ;;
72 ;; This code is partly based on tar-mode.el from Emacs.
73 ;; -------------------------------------
74 ;; ARCHIVE STRUCTURES:
75 ;; (This is mostly for myself.)
76 ;;
77 ;; ARC A series of (header,file). No interactions among members.
78 ;;
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
87 ;;
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.
93 ;;
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.
99 ;;
100 ;; archive-mode-hook
101 ;; archive-foo-mode-hook
102 ;; archive-extract-hooks
104 ;;; Code:
106 ;; -------------------------------------------------------------------------
107 ;;; Section: Configuration.
110 "Simple editing of archives."
114 "ARC-specific options to archive."
118 "LZH-specific options to archive."
122 "ZIP-specific options to archive."
126 "ZOO-specific options to archive."
130 ;; make-temp-name is safe here because we use this name
131 ;; to create a directory.
134 temporary-file-directory))
135 "Directory for temporary files made by `arc-mode.el'."
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."
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.
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."
162 :inline t
168 "*Program and its options to run in order to delete arc file members.
169 Archive and member names will be added."
172 :inline t
178 "*Program and its options to run in order to update an arc file member.
179 Archive and member name will be added."
182 :inline t
185 ;; ------------------------------
186 ;; Lzh archive configuration
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."
195 :inline t
201 "*Program and its options to run in order to delete lzh file members.
202 Archive and member names will be added."
205 :inline t
211 "*Program and its options to run in order to update an lzh file member.
212 Archive and member name will be added."
215 :inline t
218 ;; ------------------------------
219 ;; Zip archive configuration
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."
231 :inline t
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.
245 "*Program and its options to run in order to delete zip file members.
246 Archive and member names will be added."
249 :inline t
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."
263 :inline t
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."
277 :inline 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
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."
297 :inline t
303 "*Program and its options to run in order to delete zoo file members.
304 Archive and member names will be added."
307 :inline t
313 "*Program and its options to run in order to update a zoo file member.
314 Archive and member name will be added."
317 :inline t
320 ;; -------------------------------------------------------------------------
321 ;;; Section: Variables
334 ;;(define-key map "c" 'archive-copy)
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)
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-files nil
456 "Vector of file descriptors.
457 Each descriptor is a vector of the form
458 [EXT-FILE-NAME INT-FILE-NAME CASE-FIDDLED MODE ...]")
459 (make-variable-buffer-local 'archive-files)
461 ;; -------------------------------------------------------------------------
462 ;;; Section: Support functions.
464 (defsubst archive-name (suffix)
465 (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))
467 (defun archive-l-e (str &optional len float)
468 "Convert little endian string/vector STR to integer.
469 Alternatively, STR may be a buffer position in the current buffer
470 in which case a second argument, length LEN, should be supplied.
471 FLOAT, if non-nil, means generate and return a float instead of an integer
472 \(use this for numbers that can overflow the Emacs integer)."
473 (if (stringp str)
474 (setq len (length str))
475 (setq str (buffer-substring str (+ str len))))
476 (let ((result 0)
477 (i 0))
478 (while (< i len)
479 (setq i (1+ i)
480 result (+ (if float (* result 256.0) (ash result 8))
481 (aref str (- len i)))))
482 result))
484 (defun archive-int-to-mode (mode)
485 "Turn an integer like 0700 (i.e., 448) into a mode string like -rwx------."
486 ;; FIXME: merge with tar-grind-file-mode.
487 (string
488 (if (zerop (logand 8192 mode))
489 (if (zerop (logand 16384 mode)) ?- ?d)
490 ?c) ; completeness
491 (if (zerop (logand 256 mode)) ?- ?r)
492 (if (zerop (logand 128 mode)) ?- ?w)
493 (if (zerop (logand 64 mode))
494 (if (zerop (logand 1024 mode)) ?- ?S)
495 (if (zerop (logand 1024 mode)) ?x ?s))
496 (if (zerop (logand 32 mode)) ?- ?r)
497 (if (zerop (logand 16 mode)) ?- ?w)
498 (if (zerop (logand 8 mode))
499 (if (zerop (logand 2048 mode)) ?- ?S)
500 (if (zerop (logand 2048 mode)) ?x ?s))
501 (if (zerop (logand 4 mode)) ?- ?r)
502 (if (zerop (logand 2 mode)) ?- ?w)
503 (if (zerop (logand 1 mode)) ?- ?x)))
505 (defun archive-calc-mode (oldmode newmode &optional error)
506 "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
507 NEWMODE may be an octal number including a leading zero in which case it
511 If optional third argument ERROR is non-nil an error will be signaled if
512 the mode is invalid. If ERROR is nil then nil will be returned."
513 (cond ((string-match "^0[0-7]*$" newmode)
514 (let ((result 0)
515 (len (length newmode))
516 (i 1))
517 (while (< i len)
518 (setq result (+ (lsh result 3) (aref newmode i) (- ?0))
519 i (1+ i)))
520 (logior (logand oldmode 65024) result)))
522 (let ((who 0)
523 (result oldmode)
524 (op (aref newmode (match-beginning 2)))
525 (bits 0)
526 (i (match-beginning 3)))
527 (while (< i (match-end 3))
528 (let ((rwx (aref newmode i)))
529 (setq bits (logior bits (cond ((= rwx ?r) 292)
530 ((= rwx ?w) 146)
531 ((= rwx ?x) 73)
532 ((= rwx ?s) 3072)
533 ((= rwx ?t) 512)))
534 i (1+ i))))
535 (while (< who (match-end 1))
536 (let* ((whoc (aref newmode who))
537 (whomask (cond ((= whoc ?a) 4095)
538 ((= whoc ?u) 1472)
539 ((= whoc ?g) 2104)
540 ((= whoc ?o) 7))))
541 (if (= op ?=)
542 (setq result (logand result (lognot whomask))))
543 (if (= op ?-)
544 (setq result (logand result (lognot (logand whomask bits))))
545 (setq result (logior result (logand whomask bits)))))
546 (setq who (1+ who)))
547 result))
548 (t
549 (if error
550 (error "Invalid mode specification: %s" newmode)))))
552 (defun archive-dosdate (date)
553 "Stringify dos packed DATE record."
554 (let ((year (+ 1980 (logand (ash date -9) 127)))
555 (month (logand (ash date -5) 15))
556 (day (logand date 31)))
557 (if (or (> month 12) (< month 1))
558 ""
559 (format "%2d-%s-%d"
560 day
561 (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
562 "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
563 year))))
565 (defun archive-dostime (time)
566 "Stringify dos packed TIME record."
567 (let ((hour (logand (ash time -11) 31))
568 (minute (logand (ash time -5) 63))
569 (second (* 2 (logand time 31)))) ; 2 seconds resolution
570 (format "%02d:%02d:%02d" hour minute second)))
572 (defun archive-unixdate (low high)
573 "Stringify Unix (LOW HIGH) date."
574 (let ((str (current-time-string (cons high low))))
575 (format "%s-%s-%s"
576 (substring str 8 10)
577 (substring str 4 7)
578 (substring str 20 24))))
580 (defun archive-unixtime (low high)
581 "Stringify Unix (LOW HIGH) time."
582 (let ((str (current-time-string (cons high low))))
583 (substring str 11 19)))
585 (defun archive-get-lineno ()
586 (if (>= (point) archive-file-list-start)
587 (count-lines archive-file-list-start
588 (save-excursion (beginning-of-line) (point)))
589 0))
591 (defun archive-get-descr (&optional noerror)
592 "Return the descriptor vector for file at point.
593 Does not signal an error if optional argument NOERROR is non-nil."
594 (let ((no (archive-get-lineno)))
595 (if (and (>= (point) archive-file-list-start)
596 (< no (length archive-files)))
597 (let ((item (aref archive-files no)))
598 (if (vectorp item)
599 item
600 (if (not noerror)
601 (error "Entry is not a regular member of the archive"))))
602 (if (not noerror)
603 (error "Line does not describe a member of the archive")))))
604 ;; -------------------------------------------------------------------------
605 ;;; Section: the mode definition
607 ;;;###autoload
608 (defun archive-mode (&optional force)
609 "Major mode for viewing an archive file in a dired-like way.
610 You can move around using the usual cursor motion commands.
611 Letters no longer insert themselves.
612 Type `e' to pull a file out of the archive and into its own buffer;
613 or click mouse-2 on the file's line in the archive mode buffer.
615 If you edit a sub-file of this archive (as with the `e' command) and
616 save it, the contents of that buffer will be saved back into the
617 archive.
620 ;; This is not interactive because you shouldn't be turning this
621 ;; mode on and off. You can corrupt things that way.
622 (if (zerop (buffer-size))
623 ;; At present we cannot create archives from scratch
624 (funcall default-major-mode)
625 (if (and (not force) archive-files) nil
626 (let* ((type (archive-find-type))
627 (typename (capitalize (symbol-name type))))
628 (kill-all-local-variables)
629 (make-local-variable 'archive-subtype)
630 (setq archive-subtype type)
632 ;; Buffer contains treated image of file before the file contents
633 (make-local-variable 'revert-buffer-function)
634 (setq revert-buffer-function 'archive-mode-revert)
635 (auto-save-mode 0)
637 ;; Remote archives are not written by a hook.
638 (if archive-remote nil
639 (add-hook 'write-contents-functions 'archive-write-file nil t))
641 (make-local-variable 'require-final-newline)
642 (setq require-final-newline nil)
643 (make-local-variable 'local-enable-local-variables)
644 (setq local-enable-local-variables nil)
646 ;; Prevent loss of data when saving the file.
647 (make-local-variable 'file-precious-flag)
648 (setq file-precious-flag t)
650 (make-local-variable 'archive-read-only)
651 ;; Archives which are inside other archives and whose
652 ;; names are invalid for this OS, can't be written.
653 (setq archive-read-only
654 (or (not (file-writable-p (buffer-file-name)))
655 (and archive-subfile-mode
656 (string-match file-name-invalid-regexp
657 (aref archive-subfile-mode 0)))))
659 ;; Should we use a local copy when accessing from outside Emacs?
660 (make-local-variable 'archive-local-name)
662 ;; An archive can contain another archive whose name is invalid
663 ;; on local filesystem. Treat such archives as remote.
664 (or archive-remote
665 (setq archive-remote
666 (or (string-match archive-remote-regexp (buffer-file-name))
667 (string-match file-name-invalid-regexp
668 (buffer-file-name)))))
670 (setq major-mode 'archive-mode)
671 (setq mode-name (concat typename "-Archive"))
672 ;; Run archive-foo-mode-hook and archive-mode-hook
673 (run-mode-hooks (archive-name "mode-hook") 'archive-mode-hook)
674 (use-local-map archive-mode-map))
676 (make-local-variable 'archive-proper-file-start)
677 (make-local-variable 'archive-file-list-start)
678 (make-local-variable 'archive-file-list-end)
679 (make-local-variable 'archive-file-name-indent)
680 (archive-summarize nil)
681 (setq buffer-read-only t))))
683 ;; Archive mode is suitable only for specially formatted data.
684 (put 'archive-mode 'mode-class 'special)
686 (let ((item1 '(archive-subfile-mode " Archive")))
687 (or (member item1 minor-mode-alist)
688 (setq minor-mode-alist (cons item1 minor-mode-alist))))
689 ;; -------------------------------------------------------------------------
690 (defun archive-find-type ()
691 (widen)
692 (goto-char (point-min))
693 ;; The funny [] here make it unlikely that the .elc file will be treated
694 ;; as an archive by other software.
695 (let (case-fold-search)
697 ((looking-at "..-l[hz][0-9ds]-") 'lzh)
699 ((and (looking-at "\C-z") ; signature too simple, IMHO
701 (or buffer-file-name (buffer-name))))
702 'arc)
703 ;; This pattern modelled on the BSD/GNU+Linux `file' command.
704 ;; Have seen capital "LHA's", and file has lower case "LHa's" too.
705 ;; Note this regexp is also in archive-exe-p.
707 ((looking-at "Rar!") 'rar)
708 (t (error "Buffer format not recognized")))))
709 ;; -------------------------------------------------------------------------
711 (defun archive-desummarize ()
712 (let ((inhibit-read-only t)
713 (modified (buffer-modified-p)))
714 (widen)
715 (delete-region (point-min) archive-proper-file-start)
716 (restore-buffer-modified-p modified)))
719 (defun archive-summarize (&optional shut-up)
720 "Parse the contents of the archive file in the current buffer.
721 Place a dired-like listing on the front;
722 then narrow to it, so that only that listing
723 is visible (and the real data of the buffer is hidden).
724 Optional argument SHUT-UP, if non-nil, means don't print messages
725 when parsing the archive."
726 (widen)
727 (set-buffer-multibyte nil)
728 (let ((inhibit-read-only t))
729 (setq archive-proper-file-start (copy-marker (point-min) t))
730 (set (make-local-variable 'change-major-mode-hook) 'archive-desummarize)
731 (or shut-up
732 (message "Parsing archive file..."))
733 (buffer-disable-undo (current-buffer))
734 (setq archive-files (funcall (archive-name "summarize")))
735 (or shut-up
736 (message "Parsing archive file...done."))
737 (setq archive-proper-file-start (point-marker))
738 (narrow-to-region (point-min) (point))
739 (set-buffer-modified-p nil)
740 (buffer-enable-undo))
741 (goto-char archive-file-list-start)
742 (archive-next-line 0))
744 (defun archive-resummarize ()
745 "Recreate the contents listing of an archive."
746 (let ((no (archive-get-lineno)))
747 (archive-desummarize)
748 (archive-summarize t)
749 (goto-char archive-file-list-start)
750 (archive-next-line no)))
752 (defun archive-summarize-files (files)
753 "Insert a description of a list of files annotated with proper mouse face."
754 (setq archive-file-list-start (point-marker))
755 (setq archive-file-name-indent (if files (aref (car files) 1) 0))
756 ;; We don't want to do an insert for each element since that takes too
757 ;; long when the archive -- which has to be moved in memory -- is large.
758 (insert
759 (apply
760 (function concat)
761 (mapcar
762 (lambda (fil)
763 ;; Using `concat' here copies the text also, so we can add
764 ;; properties without problems.
766 (if (featurep 'xemacs)
767 () ; out of luck
768 (add-text-properties
769 (aref fil 1) (aref fil 2)
770 '(mouse-face highlight
771 help-echo "mouse-2: extract this file into a buffer")
772 text))
773 text))
774 files)))
775 (setq archive-file-list-end (point-marker)))
777 (defun archive-alternate-display ()
778 "Toggle alternative display.
779 To avoid very long lines archive mode does not show all information.
780 This function changes the set of information shown for each files."
781 (interactive)
782 (setq archive-alternate-display (not archive-alternate-display))
783 (archive-resummarize))
784 ;; -------------------------------------------------------------------------
785 ;;; Section: Local archive copy handling
787 (defun archive-unique-fname (fname dir)
788 "Make sure a file FNAME can be created uniquely in directory DIR.
790 If FNAME can be uniquely created in DIR, it is returned unaltered.
791 If FNAME is something our underlying filesystem can't grok, or if another
792 file by that name already exists in DIR, a unique new name is generated
793 using `make-temp-file', and the generated name is returned."
794 (let ((fullname (expand-file-name fname dir))
795 (alien (string-match file-name-invalid-regexp fname)))
796 (if (or alien (file-exists-p fullname))
797 (make-temp-file
798 (expand-file-name
799 (if (if (fboundp 'msdos-long-file-names)
800 (not (msdos-long-file-names)))
801 "am"
802 "arc-mode.")
803 dir))
804 fullname)))
806 (defun archive-maybe-copy (archive)
807 (let ((coding-system-for-write 'no-conversion))
808 (if archive-remote
809 (let ((start (point-max))
810 ;; Sometimes ARCHIVE is invalid while its actual name, as
811 ;; recorded in its parent archive, is not. For example, an
812 ;; archive bar.zip inside another archive foo.zip gets a name
813 ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
814 ;; So use the actual name if available.
815 (archive-name
816 (or (and archive-subfile-mode (aref archive-subfile-mode 0))
817 archive)))
818 (setq archive-local-name
819 (archive-unique-fname archive-name archive-tmpdir))
820 ;; Maked sure all the leading directories in
821 ;; archive-local-name exist under archive-tmpdir, so that
822 ;; the directory structure recorded in the archive is
823 ;; reconstructed in the temporary directory.
824 (make-directory (file-name-directory archive-local-name) t)
825 (save-restriction
826 (widen)
827 (write-region start (point-max) archive-local-name nil 'nomessage))
828 archive-local-name)
829 (if (buffer-modified-p) (save-buffer))
830 archive)))
832 (defun archive-maybe-update (unchanged)
833 (if archive-remote
834 (let ((name archive-local-name)
835 (modified (buffer-modified-p))
836 (coding-system-for-read 'no-conversion)
837 (lno (archive-get-lineno))
838 (inhibit-read-only t))
839 (if unchanged nil
840 (setq archive-files nil)
841 (erase-buffer)
842 (insert-file-contents name)
843 (archive-mode t)
844 (goto-char archive-file-list-start)
845 (archive-next-line lno))
846 (archive-delete-local name)
847 (if (not unchanged)
848 (message
849 "Buffer `%s' must be saved for changes to take effect"
850 (buffer-name (current-buffer))))
851 (set-buffer-modified-p (or modified (not unchanged))))))
853 (defun archive-delete-local (name)
854 "Delete file NAME and its parents up to and including `archive-tmpdir'."
855 (let ((again t)
856 (top (directory-file-name (file-name-as-directory archive-tmpdir))))
857 (condition-case nil
858 (delete-file name)
859 (error nil))
860 (while again
861 (setq name (directory-file-name (file-name-directory name)))
862 (condition-case nil
863 (delete-directory name)
864 (error nil))
865 (if (string= name top) (setq again nil)))))
866 ;; -------------------------------------------------------------------------
867 ;;; Section: Member extraction
869 (defun archive-file-name-handler (op &rest args)
870 (or (eq op 'file-exists-p)
871 (let ((file-name-handler-alist nil))
872 (apply op args))))
874 (defun archive-set-buffer-as-visiting-file (filename)
875 "Set the current buffer as if it were visiting FILENAME."
876 (save-excursion
877 (goto-char (point-min))
878 (let ((buffer-undo-list t)
879 (coding
880 (or coding-system-for-read
881 (and set-auto-coding-function
882 (save-excursion
883 (funcall set-auto-coding-function
884 filename (- (point-max) (point-min)))))
885 ;; dos-w32.el defines the function
886 ;; find-buffer-file-type-coding-system for DOS/Windows
887 ;; systems which preserves the coding-system of existing files.
888 ;; (That function is called via file-coding-system-alist.)
889 ;; Here, we want it to act as if the extracted file existed.
890 ;; The following let-binding of file-name-handler-alist forces
891 ;; find-file-not-found-set-buffer-file-coding-system to ignore
892 ;; the file's name (see dos-w32.el).
893 (let ((file-name-handler-alist
894 '(("" . archive-file-name-handler))))
895 (car (find-operation-coding-system
896 'insert-file-contents
897 (cons filename (current-buffer)) t))))))
898 (if (and (not coding-system-for-read)
899 (not enable-multibyte-characters))
900 (setq coding
901 (coding-system-change-text-conversion coding 'raw-text)))
902 (if (and coding
903 (not (eq coding 'no-conversion)))
904 (decode-coding-region (point-min) (point-max) coding)
905 (setq last-coding-system-used coding))
906 (set-buffer-modified-p nil)
907 (kill-local-variable 'buffer-file-coding-system)
908 (after-insert-file-set-coding (- (point-max) (point-min))))))
910 (define-obsolete-function-alias 'archive-mouse-extract 'archive-extract "22.1")
912 (defun archive-extract (&optional other-window-p event)
913 "In archive mode, extract this entry of the archive into its own buffer."
914 (interactive (list nil last-input-event))
915 (if event (posn-set-point (event-end event)))
916 (let* ((view-p (eq other-window-p 'view))
917 (descr (archive-get-descr))
918 (ename (aref descr 0))
919 (iname (aref descr 1))
920 (archive-buffer (current-buffer))
921 (arcdir default-directory)
922 (archive (buffer-file-name))
923 (arcname (file-name-nondirectory archive))
924 (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
925 (extractor (archive-name "extract"))
926 ;; Members with file names which aren't valid for the
927 ;; underlying filesystem, are treated as read-only.
928 (read-only-p (or archive-read-only
929 view-p
930 (string-match file-name-invalid-regexp ename)))
931 (arcfilename (expand-file-name (concat arcname ":" iname)))
932 (buffer (get-buffer bufname))
933 (just-created nil))
934 (if (and buffer
935 (string= (buffer-file-name buffer) arcfilename))
936 nil
937 (setq archive (archive-maybe-copy archive))
938 (setq bufname (generate-new-buffer-name bufname))
939 (setq buffer (get-buffer-create bufname))
940 (setq just-created t)
941 (with-current-buffer buffer
942 (setq buffer-file-name arcfilename)
943 (setq buffer-file-truename
944 (abbreviate-file-name buffer-file-name))
945 ;; Set the default-directory to the dir of the superior buffer.
946 (setq default-directory arcdir)
947 (make-local-variable 'archive-superior-buffer)
948 (setq archive-superior-buffer archive-buffer)
949 (add-hook 'write-file-functions 'archive-write-file-member nil t)
950 (setq archive-subfile-mode descr)
951 (if (and
952 (null
953 (let (;; We may have to encode file name arguement for
954 ;; external programs.
955 (coding-system-for-write
956 (and enable-multibyte-characters
957 file-name-coding-system))
958 ;; We read an archive member by no-conversion at
959 ;; first, then decode appropriately by calling
960 ;; archive-set-buffer-as-visiting-file later.
961 (coding-system-for-read 'no-conversion))
962 (condition-case err
963 (if (fboundp extractor)
964 (funcall extractor archive ename)
965 (archive-*-extract archive ename
966 (symbol-value extractor)))
967 (error
968 (ding (message "%s" (error-message-string err)))
969 nil))))
970 just-created)
971 (progn
972 (set-buffer-modified-p nil)
973 (kill-buffer buffer))
974 (archive-set-buffer-as-visiting-file ename)
975 (goto-char (point-min))
976 (rename-buffer bufname)
977 (setq buffer-read-only read-only-p)
978 (setq buffer-undo-list nil)
979 (set-buffer-modified-p nil)
980 (setq buffer-saved-size (buffer-size))
981 (normal-mode)
982 ;; Just in case an archive occurs inside another archive.
983 (when (derived-mode-p 'archive-mode)
984 (setq archive-remote t)
985 (if read-only-p (setq archive-read-only t))
986 ;; We will write out the archive ourselves if it is
987 ;; part of another archive.
988 (remove-hook 'write-contents-functions 'archive-write-file t))
989 (run-hooks 'archive-extract-hooks)
990 (if archive-read-only
991 (message "Note: altering this archive is not implemented."))))
992 (archive-maybe-update t))
993 (or (not (buffer-name buffer))
994 (cond
995 (view-p (view-buffer buffer (and just-created 'kill-buffer)))
996 ((eq other-window-p 'display) (display-buffer buffer))
997 (other-window-p (switch-to-buffer-other-window buffer))
998 (t (switch-to-buffer buffer))))))
1000 (defun archive-*-extract (archive name command)
1001 (let* ((default-directory (file-name-as-directory archive-tmpdir))
1002 (tmpfile (expand-file-name (file-name-nondirectory name)
1003 default-directory))
1004 exit-status success)
1005 (make-directory (directory-file-name default-directory) t)
1006 (setq exit-status
1007 (apply 'call-process
1008 (car command)
1009 nil
1010 nil
1011 nil
1012 (append (cdr command) (list archive name))))
1013 (cond ((and (numberp exit-status) (= exit-status 0))
1014 (if (not (file-exists-p tmpfile))
1015 (ding (message "`%s': no such file or directory" tmpfile))
1016 (insert-file-contents tmpfile)
1017 (setq success t)))
1018 ((numberp exit-status)
1019 (ding
1020 (message "`%s' exited with status %d" (car command) exit-status)))
1021 ((stringp exit-status)
1022 (ding (message "`%s' aborted: %s" (car command) exit-status)))
1023 (t
1024 (ding (message "`%s' failed" (car command)))))
1025 (archive-delete-local tmpfile)
1026 success))
1028 (defun archive-extract-by-stdout (archive name command)
1029 (apply 'call-process
1030 (car command)
1031 nil
1032 t
1033 nil
1034 (append (cdr command) (list archive name))))
1036 (defun archive-extract-other-window ()
1037 "In archive mode, find this member in another window."
1038 (interactive)
1039 (archive-extract t))
1041 (defun archive-display-other-window ()
1042 "In archive mode, display this member in another window."
1043 (interactive)
1044 (archive-extract 'display))
1046 (defun archive-view ()
1047 "In archive mode, view the member on this line."
1048 (interactive)
1049 (archive-extract 'view))
1051 (defun archive-add-new-member (arcbuf name)
1052 "Add current buffer to the archive in ARCBUF naming it NAME."
1053 (interactive
1054 (list (get-buffer
1055 (read-buffer "Buffer containing archive: "
1056 ;; Find first archive buffer and suggest that
1057 (let ((bufs (buffer-list)))
1058 (while (and bufs
1059 (not (with-current-buffer (car bufs)
1060 (derived-mode-p 'archive-mode))))
1061 (setq bufs (cdr bufs)))
1062 (if bufs
1063 (car bufs)
1064 (error "There are no archive buffers")))
1065 t))
1066 (read-string "File name in archive: "
1067 (if buffer-file-name
1068 (file-name-nondirectory buffer-file-name)
1069 ""))))
1070 (with-current-buffer arcbuf
1071 (or (eq major-mode 'archive-mode)
1072 (error "Buffer is not an archive buffer"))
1073 (if archive-read-only
1074 (error "Archive is read-only")))
1075 (if (eq arcbuf (current-buffer))
1076 (error "An archive buffer cannot be added to itself"))
1077 (if (string= name "")
1078 (error "Archive members may not be given empty names"))
1079 (let ((func (with-current-buffer arcbuf
1080 (archive-name "add-new-member")))
1081 (membuf (current-buffer)))
1082 (if (fboundp func)
1083 (with-current-buffer arcbuf
1084 (funcall func buffer-file-name membuf name))
1085 (error "Adding a new member is not supported for this archive type"))))
1086 ;; -------------------------------------------------------------------------
1087 ;;; Section: IO stuff
1089 (defun archive-write-file-member ()
1090 (save-excursion
1091 (save-restriction
1092 (message "Updating archive...")
1093 (widen)
1094 (let ((writer (with-current-buffer archive-superior-buffer
1095 (archive-name "write-file-member")))
1096 (archive (with-current-buffer archive-superior-buffer
1097 (archive-maybe-copy (buffer-file-name)))))
1098 (if (fboundp writer)
1099 (funcall writer archive archive-subfile-mode)
1100 (archive-*-write-file-member archive
1101 archive-subfile-mode
1102 (symbol-value writer)))
1103 (set-buffer-modified-p nil)
1104 (message "Updating archive...done"))
1105 (set-buffer archive-superior-buffer)
1106 (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
1107 ;; Restore the value of last-coding-system-used, so that basic-save-buffer
1108 ;; won't reset the coding-system of this archive member.
1109 (if (local-variable-p 'archive-member-coding-system)
1110 (setq last-coding-system-used archive-member-coding-system))
1111 t)
1113 (defun archive-*-write-file-member (archive descr command)
1114 (let* ((ename (aref descr 0))
1115 (tmpfile (expand-file-name ename archive-tmpdir))
1116 (top (directory-file-name (file-name-as-directory archive-tmpdir)))
1117 (default-directory (file-name-as-directory top)))
1118 (unwind-protect
1119 (progn
1120 (make-directory (file-name-directory tmpfile) t)
1121 ;; If the member is itself an archive, write it without
1122 ;; the dired-like listing we created.
1123 (if (eq major-mode 'archive-mode)
1124 (archive-write-file tmpfile)
1125 (write-region (point-min) (point-max) tmpfile nil 'nomessage))
1126 ;; basic-save-buffer needs last-coding-system-used to have
1127 ;; the value used to write the file, so save it before any
1128 ;; further processing clobbers it (we restore it in
1129 ;; archive-write-file-member, above).
1130 (setq archive-member-coding-system last-coding-system-used)
1131 (if (aref descr 3)
1132 ;; Set the file modes, but make sure we can read it.
1134 (if enable-multibyte-characters
1135 (setq ename
1136 (encode-coding-string ename file-name-coding-system)))
1137 (let ((exitcode (apply 'call-process
1138 (car command)
1139 nil
1140 nil
1141 nil
1142 (append (cdr command) (list archive ename)))))
1143 (if (equal exitcode 0)
1144 nil
1145 (error "Updating was unsuccessful (%S)" exitcode))))
1146 (archive-delete-local tmpfile))))
1148 (defun archive-write-file (&optional file)
1149 (save-excursion
1150 (let ((coding-system-for-write 'no-conversion))
1151 (write-region archive-proper-file-start (point-max)
1152 (or file buffer-file-name) nil t)
1153 (set-buffer-modified-p nil))
1154 t))
1155 ;; -------------------------------------------------------------------------
1156 ;;; Section: Marking and unmarking.
1158 (defun archive-flag-deleted (p &optional type)
1159 "In archive mode, mark this member to be deleted from the archive.
1160 With a prefix argument, mark that many files."
1161 (interactive "p")
1162 (or type (setq type ?D))
1163 (beginning-of-line)
1164 (let ((sign (if (>= p 0) +1 -1))
1165 (modified (buffer-modified-p))
1166 (inhibit-read-only t))
1167 (while (not (zerop p))
1168 (if (archive-get-descr t)
1169 (progn
1170 (delete-char 1)
1171 (insert type)))
1172 (forward-line sign)
1173 (setq p (- p sign)))
1174 (restore-buffer-modified-p modified))
1175 (archive-next-line 0))
1177 (defun archive-unflag (p)
1178 "In archive mode, un-mark this member if it is marked to be deleted.
1179 With a prefix argument, un-mark that many files forward."
1180 (interactive "p")
1181 (archive-flag-deleted p ?\s))
1183 (defun archive-unflag-backwards (p)
1184 "In archive mode, un-mark this member if it is marked to be deleted.
1185 With a prefix argument, un-mark that many members backward."
1186 (interactive "p")
1187 (archive-flag-deleted (- p) ?\s))
1189 (defun archive-unmark-all-files ()
1190 "Remove all marks."
1191 (interactive)
1192 (let ((modified (buffer-modified-p))
1193 (inhibit-read-only t))
1194 (save-excursion
1195 (goto-char archive-file-list-start)
1196 (while (< (point) archive-file-list-end)
1197 (or (= (following-char) ?\s)
1198 (progn (delete-char 1) (insert ?\s)))
1199 (forward-line 1)))
1200 (restore-buffer-modified-p modified)))
1202 (defun archive-mark (p)
1203 "In archive mode, mark this member for group operations.
1204 With a prefix argument, mark that many members.
1206 (interactive "p")
1207 (archive-flag-deleted p ?*))
1209 (defun archive-get-marked (mark &optional default)
1210 (let (files)
1211 (save-excursion
1212 (goto-char archive-file-list-start)
1213 (while (< (point) archive-file-list-end)
1214 (if (= (following-char) mark)
1215 (setq files (cons (archive-get-descr) files)))
1216 (forward-line 1)))
1217 (or (nreverse files)
1218 (and default
1219 (list (archive-get-descr))))))
1220 ;; -------------------------------------------------------------------------
1221 ;;; Section: Operate
1223 (defun archive-next-line (p)
1224 (interactive "p")
1225 (forward-line p)
1226 (or (eobp)
1227 (forward-char archive-file-name-indent)))
1229 (defun archive-previous-line (p)
1230 (interactive "p")
1231 (archive-next-line (- p)))
1233 (defun archive-chmod-entry (new-mode)
1234 "Change the protection bits associated with all marked or this member.
1235 The new protection bits can either be specified as an octal number or
1237 (interactive "sNew mode (octal or relative): ")
1238 (if archive-read-only (error "Archive is read-only"))
1239 (let ((func (archive-name "chmod-entry")))
1240 (if (fboundp func)
1241 (progn
1242 (funcall func new-mode (archive-get-marked ?* t))
1243 (archive-resummarize))
1244 (error "Setting mode bits is not supported for this archive type"))))
1246 (defun archive-chown-entry (new-uid)
1247 "Change the owner of all marked or this member."
1248 (interactive "nNew uid: ")
1249 (if archive-read-only (error "Archive is read-only"))
1250 (let ((func (archive-name "chown-entry")))
1251 (if (fboundp func)
1252 (progn
1253 (funcall func new-uid (archive-get-marked ?* t))
1254 (archive-resummarize))
1255 (error "Setting owner is not supported for this archive type"))))
1257 (defun archive-chgrp-entry (new-gid)
1258 "Change the group of all marked or this member."
1259 (interactive "nNew gid: ")
1260 (if archive-read-only (error "Archive is read-only"))
1261 (let ((func (archive-name "chgrp-entry")))
1262 (if (fboundp func)
1263 (progn
1264 (funcall func new-gid (archive-get-marked ?* t))
1265 (archive-resummarize))
1266 (error "Setting group is not supported for this archive type"))))
1268 (defun archive-expunge ()
1269 "Do the flagged deletions."
1270 (interactive)
1271 (let (files)
1272 (save-excursion
1273 (goto-char archive-file-list-start)
1274 (while (< (point) archive-file-list-end)
1275 (if (= (following-char) ?D)
1276 (setq files (cons (aref (archive-get-descr) 0) files)))
1277 (forward-line 1)))
1278 (setq files (nreverse files))
1279 (and files
1280 (or (not archive-read-only)
1281 (error "Archive is read-only"))
1282 (or (yes-or-no-p (format "Really delete %d member%s? "
1283 (length files)
1284 (if (null (cdr files)) "" "s")))
1285 (error "Operation aborted"))
1286 (let ((archive (archive-maybe-copy (buffer-file-name)))
1287 (expunger (archive-name "expunge")))
1288 (if (fboundp expunger)
1289 (funcall expunger archive files)
1290 (archive-*-expunge archive files (symbol-value expunger)))
1291 (archive-maybe-update nil)
1292 (if archive-remote
1293 (archive-resummarize)
1294 (revert-buffer))))))
1296 (defun archive-*-expunge (archive files command)
1297 (apply 'call-process
1298 (car command)
1299 nil
1300 nil
1301 nil
1302 (append (cdr command) (cons archive files))))
1304 (defun archive-rename-entry (newname)
1305 "Change the name associated with this entry in the archive file."
1306 (interactive "sNew name: ")
1307 (if archive-read-only (error "Archive is read-only"))
1308 (if (string= newname "")
1309 (error "Archive members may not be given empty names"))
1310 (let ((func (archive-name "rename-entry"))
1311 (descr (archive-get-descr)))
1312 (if (fboundp func)
1313 (progn
1314 (funcall func
1315 (if enable-multibyte-characters
1316 (encode-coding-string newname file-name-coding-system)
1317 newname)
1318 descr)
1319 (archive-resummarize))
1320 (error "Renaming is not supported for this archive type"))))
1322 ;; Revert the buffer and recompute the dired-like listing.
1323 (defun archive-mode-revert (&optional no-auto-save no-confirm)
1324 (let ((no (archive-get-lineno)))
1325 (setq archive-files nil)
1326 (let ((revert-buffer-function nil)
1327 (coding-system-for-read 'no-conversion))
1328 (set-buffer-multibyte nil)
1329 (revert-buffer t t))
1330 (archive-mode)
1331 (goto-char archive-file-list-start)
1332 (archive-next-line no)))
1334 (defun archive-undo ()
1335 "Undo in an archive buffer.
1336 This doesn't recover lost files, it just undoes changes in the buffer itself."
1337 (interactive)
1338 (let ((inhibit-read-only t))
1339 (undo)))
1340 ;; -------------------------------------------------------------------------
1341 ;;; Section: Arc Archives
1343 (defun archive-arc-summarize ()
1344 (let ((p 1)
1345 (totalsize 0)
1346 (maxlen 8)
1347 files
1348 visual)
1349 (while (and (< (+ p 29) (point-max))
1350 (= (char-after p) ?\C-z)
1351 (> (char-after (1+ p)) 0))
1352 (let* ((namefld (buffer-substring (+ p 2) (+ p 2 13)))
1353 (fnlen (or (string-match "\0" namefld) 13))
1354 (efnname (substring namefld 0 fnlen))
1355 ;; Convert to float to avoid overflow for very large files.
1356 (csize (archive-l-e (+ p 15) 4 'float))
1357 (moddate (archive-l-e (+ p 19) 2))
1358 (modtime (archive-l-e (+ p 21) 2))
1359 (ucsize (archive-l-e (+ p 25) 4 'float))
1360 (fiddle (string= efnname (upcase efnname)))
1361 (ifnname (if fiddle (downcase efnname) efnname))
1362 (text (format " %8.0f %-11s %-8s %s"
1363 ucsize
1364 (archive-dosdate moddate)
1365 (archive-dostime modtime)
1366 ifnname)))
1367 (setq maxlen (max maxlen fnlen)
1368 totalsize (+ totalsize ucsize)
1369 visual (cons (vector text
1370 (- (length text) (length ifnname))
1371 (length text))
1372 visual)
1373 files (cons (vector efnname ifnname fiddle nil (1- p))
1374 files)
1375 ;; p needs to stay an integer, since we use it in char-after
1376 ;; above. Passing through `round' limits the compressed size
1377 ;; to most-positive-fixnum, but if the compressed size exceeds
1378 ;; that, we cannot visit the archive anyway.
1379 p (+ p 29 (round csize)))))
1380 (goto-char (point-min))
1381 (let ((dash (concat "- -------- ----------- -------- "
1382 (make-string maxlen ?-)
1385 dash)
1386 (archive-summarize-files (nreverse visual))
1387 (insert dash
1388 (format " %8.0f %d file%s"
1389 totalsize
1390 (length files)
1391 (if (= 1 (length files)) "" "s"))
1393 (apply 'vector (nreverse files))))
1395 (defun archive-arc-rename-entry (newname descr)
1397 (error "File names in arc files must not contain a directory component"))
1398 (if (> (length newname) 12)
1399 (error "File names in arc files are limited to 12 characters"))
1400 (let ((name (concat newname (substring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
1401 (length newname))))
1402 (inhibit-read-only t))
1403 (save-restriction
1404 (save-excursion
1405 (widen)
1406 (set-buffer-multibyte nil)
1407 (goto-char (+ archive-proper-file-start (aref descr 4) 2))
1408 (delete-char 13)
1409 (insert name)))))
1410 ;; -------------------------------------------------------------------------
1411 ;;; Section: Lzh Archives
1413 (defun archive-lzh-summarize (&optional start)
1414 (let ((p (or start 1)) ;; 1 for .lzh, something further on for .exe
1415 (totalsize 0)
1416 (maxlen 8)
1417 files
1418 visual)
1419 (while (progn (goto-char p) ;beginning of a base header.
1421 (let* ((hsize (char-after p)) ;size of the base header (level 0 and 1)
1422 ;; Convert to float to avoid overflow for very large files.
1423 (csize (archive-l-e (+ p 7) 4 'float)) ;size of a compressed file to follow (level 0 and 2),
1424 ;size of extended headers + the compressed file to follow (level 1).
1425 (ucsize (archive-l-e (+ p 11) 4 'float)) ;size of an uncompressed file.
1426 (time1 (archive-l-e (+ p 15) 2)) ;date/time (MSDOS format in level 0, 1 headers
1427 (time2 (archive-l-e (+ p 17) 2)) ;and UNIX format in level 2 header.)
1428 (hdrlvl (char-after (+ p 20))) ;header level
1429 thsize ;total header size (base + extensions)
1430 fnlen efnname osid fiddle ifnname width p2
1431 neh ;beginning of next extension header (level 1 and 2)
1432 mode modestr uid gid text dir prname
1433 gname uname modtime moddate)
1434 (if (= hdrlvl 3) (error "can't handle lzh level 3 header type"))
1435 (when (or (= hdrlvl 0) (= hdrlvl 1))
1436 (setq fnlen (char-after (+ p 21))) ;filename length
1437 (setq efnname (let ((str (buffer-substring (+ p 22) (+ p 22 fnlen)))) ;filename from offset 22
1438 (if file-name-coding-system
1439 (decode-coding-string str file-name-coding-system)
1440 (string-as-multibyte str))))
1441 (setq p2 (+ p 22 fnlen))) ;
1442 (if (= hdrlvl 1)
1443 (setq neh (+ p2 3)) ;specific to level 1 header
1444 (if (= hdrlvl 2)
1445 (setq neh (+ p 24)))) ;specific to level 2 header
1446 (if neh ;if level 1 or 2 we expect extension headers to follow
1447 (let* ((ehsize (archive-l-e neh 2)) ;size of the extension header
1448 (etype (char-after (+ neh 2)))) ;extension type
1449 (while (not (= ehsize 0))
1450 (cond
1451 ((= etype 1) ;file name
1452 (let ((i (+ neh 3)))
1453 (while (< i (+ neh ehsize))
1454 (setq efnname (concat efnname (char-to-string (char-after i))))
1455 (setq i (1+ i)))))
1456 ((= etype 2) ;directory name
1457 (let ((i (+ neh 3)))
1458 (while (< i (+ neh ehsize))
1459 (setq dir (concat dir
1460 (if (= (char-after i)
1461 255)
1462 "/"
1463 (char-to-string
1464 (char-after i)))))
1465 (setq i (1+ i)))))
1466 ((= etype 80) ;Unix file permission
1467 (setq mode (archive-l-e (+ neh 3) 2)))
1468 ((= etype 81) ;UNIX file group/user ID
1469 (progn (setq uid (archive-l-e (+ neh 3) 2))
1470 (setq gid (archive-l-e (+ neh 5) 2))))
1471 ((= etype 82) ;UNIX file group name
1472 (let ((i (+ neh 3)))
1473 (while (< i (+ neh ehsize))
1474 (setq gname (concat gname (char-to-string (char-after i))))
1475 (setq i (1+ i)))))
1476 ((= etype 83) ;UNIX file user name
1477 (let ((i (+ neh 3)))
1478 (while (< i (+ neh ehsize))
1479 (setq uname (concat uname (char-to-string (char-after i))))
1480 (setq i (1+ i)))))
1481 )
1482 (setq neh (+ neh ehsize))
1483 (setq ehsize (archive-l-e neh 2))
1484 (setq etype (char-after (+ neh 2))))
1485 ;;get total header size for level 1 and 2 headers
1486 (setq thsize (- neh p))))
1487 (if (= hdrlvl 0) ;total header size
1488 (setq thsize hsize))
1489 ;; OS ID field not present in level 0 header, use code 0 "generic"
1490 ;; in that case as per lha program header.c get_header()
1491 (setq osid (cond ((= hdrlvl 0) 0)
1492 ((= hdrlvl 1) (char-after (+ p 22 fnlen 2)))
1493 ((= hdrlvl 2) (char-after (+ p 23)))))
1494 ;; Filename fiddling must follow the lha program, otherwise the name
1495 ;; passed to "lha pq" etc won't match (which for an extract silently
1496 ;; results in no output). As of version 1.14i it goes from the OS ID,
1497 ;; - For 'M' MSDOS: msdos_to_unix_filename() downcases always, and
1499 ;; - For 0 generic: generic_to_unix_filename() downcases if there's
1501 ;; - For 'm' MacOS: macos_to_unix_filename() changes "/" to ":" and
1502 ;; ":" to "/"
1503 (setq fiddle (cond ((= ?M osid) t)
1504 ((= 0 osid) (string= efnname (upcase efnname)))))
1505 (setq ifnname (if fiddle (downcase efnname) efnname))
1506 (setq prname (if dir (concat dir ifnname) ifnname))
1507 (setq width (if prname (string-width prname) 0))
1508 (setq modestr (if mode (archive-int-to-mode mode) "??????????"))
1509 (setq moddate (if (= hdrlvl 2)
1510 (archive-unixdate time1 time2) ;level 2 header in UNIX format
1511 (archive-dosdate time2))) ;level 0 and 1 header in DOS format
1512 (setq modtime (if (= hdrlvl 2)
1513 (archive-unixtime time1 time2)
1514 (archive-dostime time1)))
1515 (setq text (if archive-alternate-display
1516 (format " %8.0f %5S %5S %s"
1517 ucsize
1518 (or uid "?")
1519 (or gid "?")
1520 ifnname)
1521 (format " %10s %8.0f %-11s %-8s %s"
1522 modestr
1523 ucsize
1524 moddate
1525 modtime
1526 prname)))
1527 (setq maxlen (max maxlen width)
1528 totalsize (+ totalsize ucsize)
1529 visual (cons (vector text
1530 (- (length text) (length prname))
1531 (length text))
1532 visual)
1533 files (cons (vector prname ifnname fiddle mode (1- p))
1534 files))
1535 (cond ((= hdrlvl 1)
1536 ;; p needs to stay an integer, since we use it in goto-char
1537 ;; above. Passing through `round' limits the compressed size
1538 ;; to most-positive-fixnum, but if the compressed size exceeds
1539 ;; that, we cannot visit the archive anyway.
1540 (setq p (+ p hsize 2 (round csize))))
1541 ((or (= hdrlvl 2) (= hdrlvl 0))
1542 (setq p (+ p thsize 2 (round csize)))))
1543 ))
1544 (goto-char (point-min))
1545 (set-buffer-multibyte default-enable-multibyte-characters)
1546 (let ((dash (concat (if archive-alternate-display
1547 "- -------- ----- ----- "
1548 "- ---------- -------- ----------- -------- ")
1549 (make-string maxlen ?-)
1551 (header (if archive-alternate-display
1554 (sumline (if archive-alternate-display
1555 " %8.0f %d file%s"
1556 " %8.0f %d file%s")))
1557 (insert header dash)
1558 (archive-summarize-files (nreverse visual))
1559 (insert dash
1560 (format sumline
1561 totalsize
1562 (length files)
1563 (if (= 1 (length files)) "" "s"))
1565 (apply 'vector (nreverse files))))
1567 (defconst archive-lzh-alternate-display t)
1569 (defun archive-lzh-extract (archive name)
1570 (archive-extract-by-stdout archive name archive-lzh-extract))
1572 (defun archive-lzh-resum (p count)
1573 (let ((sum 0))
1574 (while (> count 0)
1575 (setq count (1- count)
1576 sum (+ sum (char-after p))
1577 p (1+ p)))
1578 (logand sum 255)))
1580 (defun archive-lzh-rename-entry (newname descr)
1581 (save-restriction
1582 (save-excursion
1583 (widen)
1584 (set-buffer-multibyte nil)
1585 (let* ((p (+ archive-proper-file-start (aref descr 4)))
1586 (oldhsize (char-after p))
1587 (oldfnlen (char-after (+ p 21)))
1588 (newfnlen (length newname))
1589 (newhsize (+ oldhsize newfnlen (- oldfnlen)))
1590 (inhibit-read-only t))
1591 (if (> newhsize 255)
1592 (error "The file name is too long"))
1593 (goto-char (+ p 21))
1594 (delete-char (1+ oldfnlen))
1595 (insert newfnlen newname)
1596 (goto-char p)
1597 (delete-char 2)
1598 (insert newhsize (archive-lzh-resum p newhsize))))))
1600 (defun archive-lzh-ogm (newval files errtxt ofs)
1601 (save-excursion
1602 (save-restriction
1603 (widen)
1604 (set-buffer-multibyte nil)
1605 (dolist (fil files)
1606 (let* ((p (+ archive-proper-file-start (aref fil 4)))
1607 (hsize (char-after p))
1608 (fnlen (char-after (+ p 21)))
1609 (p2 (+ p 22 fnlen))
1610 (creator (if (>= (- hsize fnlen) 24) (char-after (+ p2 2)) 0))
1611 (inhibit-read-only t))
1612 (if (= creator ?U)
1613 (progn
1614 (or (numberp newval)
1615 (setq newval (funcall newval (archive-l-e (+ p2 ofs) 2))))
1616 (goto-char (+ p2 ofs))
1617 (delete-char 2)
1618 (insert (logand newval 255) (lsh newval -8))
1619 (goto-char (1+ p))
1620 (delete-char 1)
1621 (insert (archive-lzh-resum (1+ p) hsize)))
1622 (message "Member %s does not have %s field"
1623 (aref fil 1) errtxt)))))))
1625 (defun archive-lzh-chown-entry (newuid files)
1626 (archive-lzh-ogm newuid files "an uid" 10))
1628 (defun archive-lzh-chgrp-entry (newgid files)
1629 (archive-lzh-ogm newgid files "a gid" 12))
1631 (defun archive-lzh-chmod-entry (newmode files)
1632 (archive-lzh-ogm
1633 ;; This should work even though newmode will be dynamically accessed.
1634 (lambda (old) (archive-calc-mode old newmode t))
1635 files "a unix-style mode" 8))
1637 ;; -------------------------------------------------------------------------
1638 ;;; Section: Lzh Self-Extracting .exe Archives
1639 ;;
1640 ;; No support for modifying these files. It looks like the lha for unix
1641 ;; program (as of version 1.14i) can't create or retain the DOS exe part.
1642 ;; If you do an "lha a" on a .exe for instance it renames and writes to a
1643 ;; plain .lzh.
1645 (defun archive-lzh-exe-summarize ()
1646 "Summarize the contents of an LZH self-extracting exe, for `archive-mode'."
1648 ;; Skip the initial executable code part and apply archive-lzh-summarize
1649 ;; to the archive part proper. The "-lh5-" etc regexp here for the start
1650 ;; is the same as in archive-find-type.
1651 ;;
1652 ;; The lha program (version 1.14i) does this in skip_msdos_sfx1_code() by
1653 ;; a similar scan. It looks for "..-l..-" plus for level 0 or 1 a test of
1654 ;; the header checksum, or level 2 a test of the "attribute" and size.
1655 ;;
1656 (re-search-forward "..-l[hz][0-9ds]-" nil)
1657 (archive-lzh-summarize (match-beginning 0)))
1659 ;; `archive-lzh-extract' runs "lha pq", and that works for .exe as well as
1660 ;; .lzh files
1661 (defalias 'archive-lzh-exe-extract 'archive-lzh-extract
1662 "Extract a member from an LZH self-extracting exe, for `archive-mode'.")
1664 ;; -------------------------------------------------------------------------
1665 ;;; Section: Zip Archives
1667 (defun archive-zip-summarize ()
1668 (goto-char (- (point-max) (- 22 18)))
1670 (let ((p (+ (point-min) (archive-l-e (+ (point) 16) 4)))
1671 (maxlen 8)
1672 (totalsize 0)
1673 files
1674 visual)
1676 (let* ((creator (char-after (+ p 5)))
1677 ;; (method (archive-l-e (+ p 10) 2))
1678 (modtime (archive-l-e (+ p 12) 2))
1679 (moddate (archive-l-e (+ p 14) 2))
1680 ;; Convert to float to avoid overflow for very large files.
1681 (ucsize (archive-l-e (+ p 24) 4 'float))
1682 (fnlen (archive-l-e (+ p 28) 2))
1683 (exlen (archive-l-e (+ p 30) 2))
1684 (fclen (archive-l-e (+ p 32) 2))
1685 (lheader (archive-l-e (+ p 42) 4))
1686 (efnname (let ((str (buffer-substring (+ p 46) (+ p 46 fnlen))))
1687 (if file-name-coding-system
1688 (decode-coding-string str file-name-coding-system)
1689 (string-as-multibyte str))))
1690 (isdir (and (= ucsize 0)
1691 (string= (file-name-nondirectory efnname) "")))
1692 (mode (cond ((memq creator '(2 3)) ; Unix + VMS
1693 (archive-l-e (+ p 40) 2))
1694 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1697 (if (zerop
1698 (logand 1 (char-after (+ p 38))))
1700 (t nil)))
1701 (modestr (if mode (archive-int-to-mode mode) "??????????"))
1702 (fiddle (and archive-zip-case-fiddle
1703 (not (not (memq creator '(0 2 4 5 9))))
1704 (string= (upcase efnname) efnname)))
1705 (ifnname (if fiddle (downcase efnname) efnname))
1706 (width (string-width ifnname))
1707 (text (format " %10s %8.0f %-11s %-8s %s"
1708 modestr
1709 ucsize
1710 (archive-dosdate moddate)
1711 (archive-dostime modtime)
1712 ifnname)))
1713 (setq maxlen (max maxlen width)
1714 totalsize (+ totalsize ucsize)
1715 visual (cons (vector text
1716 (- (length text) (length ifnname))
1717 (length text))
1718 visual)
1719 files (cons (if isdir
1720 nil
1721 (vector efnname ifnname fiddle mode
1722 (list (1- p) lheader)))
1723 files)
1724 p (+ p 46 fnlen exlen fclen))))
1725 (goto-char (point-min))
1726 (let ((dash (concat "- ---------- -------- ----------- -------- "
1727 (make-string maxlen ?-)
1730 dash)
1731 (archive-summarize-files (nreverse visual))
1732 (insert dash
1733 (format " %8.0f %d file%s"
1734 totalsize
1735 (length files)
1736 (if (= 1 (length files)) "" "s"))
1738 (apply 'vector (nreverse files))))
1740 (defun archive-zip-extract (archive name)
1741 (if (equal (car archive-zip-extract) "pkzip")
1742 (archive-*-extract archive name archive-zip-extract)
1743 (archive-extract-by-stdout archive name archive-zip-extract)))
1745 (defun archive-zip-write-file-member (archive descr)
1746 (archive-*-write-file-member
1747 archive
1748 descr
1749 (if (aref descr 2) archive-zip-update-case archive-zip-update)))
1751 (defun archive-zip-chmod-entry (newmode files)
1752 (save-restriction
1753 (save-excursion
1754 (widen)
1755 (set-buffer-multibyte nil)
1756 (dolist (fil files)
1757 (let* ((p (+ archive-proper-file-start (car (aref fil 4))))
1758 (creator (char-after (+ p 5)))
1759 (oldmode (aref fil 3))
1760 (newval (archive-calc-mode oldmode newmode t))
1761 (inhibit-read-only t))
1762 (cond ((memq creator '(2 3)) ; Unix + VMS
1763 (goto-char (+ p 40))
1764 (delete-char 2)
1765 (insert (logand newval 255) (lsh newval -8)))
1766 ((memq creator '(0 5 6 7 10 11 15)) ; Dos etc.
1767 (goto-char (+ p 38))
1768 (insert (logior (logand (char-after (point)) 254)
1769 (logand (logxor 1 (lsh newval -7)) 1)))
1770 (delete-char 1))
1771 (t (message "Don't know how to change mode for this member"))))
1772 ))))
1773 ;; -------------------------------------------------------------------------
1774 ;;; Section: Zoo Archives
1776 (defun archive-zoo-summarize ()
1777 (let ((p (1+ (archive-l-e 25 4)))
1778 (maxlen 8)
1779 (totalsize 0)
1780 files
1781 visual)
1783 (> (archive-l-e (+ p 6) 4) 0))
1784 (let* ((next (1+ (archive-l-e (+ p 6) 4)))
1785 (moddate (archive-l-e (+ p 14) 2))
1786 (modtime (archive-l-e (+ p 16) 2))
1787 ;; Convert to float to avoid overflow for very large files.
1788 (ucsize (archive-l-e (+ p 20) 4 'float))
1789 (namefld (buffer-substring (+ p 38) (+ p 38 13)))
1790 (dirtype (char-after (+ p 4)))
1791 (lfnlen (if (= dirtype 2) (char-after (+ p 56)) 0))
1792 (ldirlen (if (= dirtype 2) (char-after (+ p 57)) 0))
1793 (fnlen (or (string-match "\0" namefld) 13))
1794 (efnname (let ((str
1795 (concat
1796 (if (> ldirlen 0)
1797 (concat (buffer-substring
1798 (+ p 58 lfnlen)
1799 (+ p 58 lfnlen ldirlen -1))
1800 "/")
1801 "")
1802 (if (> lfnlen 0)
1803 (buffer-substring (+ p 58)
1804 (+ p 58 lfnlen -1))
1805 (substring namefld 0 fnlen)))))
1806 (if file-name-coding-system
1807 (decode-coding-string str file-name-coding-system)
1808 (string-as-multibyte str))))
1809 (fiddle (and (= lfnlen 0) (string= efnname (upcase efnname))))
1810 (ifnname (if fiddle (downcase efnname) efnname))
1811 (width (string-width ifnname))
1812 (text (format " %8.0f %-11s %-8s %s"
1813 ucsize
1814 (archive-dosdate moddate)
1815 (archive-dostime modtime)
1816 ifnname)))
1817 (setq maxlen (max maxlen width)
1818 totalsize (+ totalsize ucsize)
1819 visual (cons (vector text
1820 (- (length text) (length ifnname))
1821 (length text))
1822 visual)
1823 files (cons (vector efnname ifnname fiddle nil (1- p))
1824 files)
1825 p next)))
1826 (goto-char (point-min))
1827 (let ((dash (concat "- -------- ----------- -------- "
1828 (make-string maxlen ?-)
1831 dash)
1832 (archive-summarize-files (nreverse visual))
1833 (insert dash
1834 (format " %8.0f %d file%s"
1835 totalsize
1836 (length files)
1837 (if (= 1 (length files)) "" "s"))
1839 (apply 'vector (nreverse files))))
1841 (defun archive-zoo-extract (archive name)
1842 (archive-extract-by-stdout archive name archive-zoo-extract))
1844 ;; -------------------------------------------------------------------------
1845 ;;; Section: Rar Archives
1847 (defun archive-rar-summarize ()
1848 (let* ((file buffer-file-name)
1849 (copy (file-local-copy file))
1850 header footer
1851 (maxname 10)
1852 (maxsize 5)
1853 (files ()))
1854 (with-temp-buffer
1855 (call-process "unrar-free" nil t nil "--list" (or file copy))
1856 (if copy (delete-file copy))
1857 (goto-char (point-min))
1859 (setq header
1860 (buffer-substring (save-excursion (re-search-backward "^[^ ]"))
1861 (point)))
1863 ;; Size ; Packed.
1865 ;; Ratio ; Date'
1867 ;; Time ; Attr.
1869 ;; CRC; Meth ; Var.
1871 (goto-char (match-end 0))
1872 (let ((name (match-string 1))
1873 (size (match-string 2)))
1874 (if (> (length name) maxname) (setq maxname (length name)))
1875 (if (> (length size) maxsize) (setq maxsize (length size)))
1876 (push (vector name name nil nil
1877 ;; Size, Ratio.
1878 size (match-string 3)
1879 ;; Date, Time.
1880 (match-string 4) (match-string 5))
1881 files)))
1882 (setq footer (buffer-substring (point) (point-max))))
1883 (setq files (nreverse files))
1884 (goto-char (point-min))
1885 (let* ((format (format " %%s %%s %%%ds %%5s %%s" maxsize))
1886 (sep (format format "--------" "-----" (make-string maxsize ?-)
1887 "-----" ""))
1888 (column (length sep)))
1891 (archive-summarize-files (mapcar (lambda (desc)
1892 (let ((text
1893 (format format
1894 (aref desc 6)
1895 (aref desc 7)
1896 (aref desc 4)
1897 (aref desc 5)
1898 (aref desc 1))))
1899 (vector text
1900 column
1901 (length text))))
1902 files))
1904 (apply 'vector files))))
1906 (defun archive-rar-extract (archive name)
1907 ;; unrar-free seems to have no way to extract to stdout or even to a file.
1908 (if (file-name-absolute-p name)
1909 ;; The code below assumes the name is relative and may do undesirable
1910 ;; things otherwise.
1911 (error "Can't extract files with non-relative names")
1912 (let ((dest (make-temp-file "arc-rar" 'dir)))
1913 (unwind-protect
1914 (progn
1915 (call-process "unrar-free" nil nil nil
1916 "--extract" archive name dest)
1917 (insert-file-contents-literally (expand-file-name name dest)))
1918 (delete-file (expand-file-name name dest))
1919 (while (file-name-directory name)
1920 (setq name (directory-file-name (file-name-directory name)))
1921 (delete-directory (expand-file-name name dest)))
1922 (delete-directory dest)))))
1924 ;; -------------------------------------------------------------------------
1925 ;; This line was a mistake; it is kept now for compatibility.
1926 ;; rms 15 Oct 98
1927 (provide 'archive-mode)
1929 (provide 'arc-mode)
1931 ;; arch-tag: e5966a01-35ec-4f27-8095-a043a79b457b
1932 ;;; arc-mode.el ends here