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