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