arc-mode.el 84.3 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1 2
;;; arc-mode.el --- simple editing of archives

3
;; Copyright (C) 1995, 1997-1998, 2001-2011  Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
4

Kenichi Handa's avatar
Kenichi Handa committed
5
;; Author: Morten Welinder <terra@gnu.org>
6
;; Keywords: files archives msdog editing major-mode
Karl Heuer's avatar
Karl Heuer committed
7 8
;; Favourite-brand-of-beer: None, I hate beer.

Erik Naggum's avatar
Erik Naggum committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Erik Naggum's avatar
Erik Naggum committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Erik Naggum's avatar
Erik Naggum committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Karl Heuer's avatar
Karl Heuer committed
23 24

;;; Commentary:
Erik Naggum's avatar
Erik Naggum committed
25

Karl Heuer's avatar
Karl Heuer committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
;; NAMING: "arc" is short for "archive" and does not refer specifically
;; to files whose name end in ".arc"
;;
;; This code does not decode any files internally, although it does
;; understand the directory level of the archives.  For this reason,
;; you should expect this code to need more fiddling than tar-mode.el
;; (although it at present has fewer bugs :-)  In particular, I have
;; not tested this under Ms-Dog myself.
;; -------------------------------------
;; INTERACTION: arc-mode.el should play together with
;;
;; * ange-ftp.el: Remote archives (i.e., ones that ange-ftp has brought
;;                to you) are handled by doing all updates on a local
;;                copy.  When you make changes to a remote file the
;;                changes will first take effect when the archive buffer
;;                is saved.  You will be warned about this.
;;
;; * dos-fns.el:  (Part of Emacs 19).  You get automatic ^M^J <--> ^J
;;                conversion.
;;
;; arc-mode.el does not work well with crypt++.el; for the archives as
;; such this could be fixed (but wouldn't be useful) by declaring such
;; archives to be "remote".  For the members this is a general Emacs
;; problem that 19.29's file formats may fix.
;; -------------------------------------
;; ARCHIVE TYPES: Currently only the archives below are handled, but the
;; structure for handling just about anything is in place.
;;
54 55 56 57 58 59 60 61 62 63 64
;;			Arc	Lzh	Zip	Zoo	Rar	7z
;;			--------------------------------------------
;; View listing		Intern	Intern	Intern	Intern	Y	Y
;; Extract member	Y	Y	Y	Y	Y	Y
;; Save changed member	Y	Y	Y	Y	N	N
;; Add new member	N	N	N	N	N	N
;; Delete member	Y	Y	Y	Y	N	N
;; Rename member	Y	Y	N	N	N	N
;; Chmod		-	Y	Y	-	N	N
;; Chown		-	Y	-	-	N	N
;; Chgrp		-	Y	-	-	N	N
Karl Heuer's avatar
Karl Heuer committed
65 66 67 68 69 70 71 72 73 74 75 76 77
;;
;; Special thanks to Bill Brodie <wbrodie@panix.com> for very useful tips
;; on the first released version of this package.
;;
;; This code is partly based on tar-mode.el from Emacs.
;; -------------------------------------
;; ARCHIVE STRUCTURES:
;; (This is mostly for myself.)
;;
;; ARC         A series of (header,file).  No interactions among members.
;;
;; LZH         A series of (header,file).  Headers are checksummed.  No
;;             interaction among members.
78 79 80 81 82 83
;;             Headers come in three flavours called level 0, 1 and 2 headers.
;;             Level 2 header is free of DOS specific restrictions and most
;;             prevalently used.  Also level 1 and 2 headers consist of base
;;             and extension headers.  For more details see
;;             http://homepage1.nifty.com/dangan/en/Content/Program/Java/jLHA/Notes/Notes.html
;;             http://www.osirusoft.com/joejared/lzhformat.html
Karl Heuer's avatar
Karl Heuer committed
84 85 86 87 88 89 90 91 92 93 94
;;
;; ZIP         A series of (lheader,fil) followed by a "central directory"
;;             which is a series of (cheader) followed by an end-of-
;;             central-dir record possibly followed by junk.  The e-o-c-d
;;             links to c-d.  cheaders link to lheaders which are basically
;;             cut-down versions of the cheaders.
;;
;; ZOO         An archive header followed by a series of (header,file).
;;             Each member header points to the next.  The archive is
;;             terminated by a bogus header with a zero next link.
;; -------------------------------------
Pavel Janík's avatar
Pavel Janík committed
95
;; HOOKS: `foo' means one of the supported archive types.
Karl Heuer's avatar
Karl Heuer committed
96 97 98 99 100 101 102 103
;;
;; archive-mode-hook
;; archive-foo-mode-hook
;; archive-extract-hooks

;;; Code:

;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
104
;;; Section: Configuration.
Karl Heuer's avatar
Karl Heuer committed
105

Richard M. Stallman's avatar
Richard M. Stallman committed
106 107 108
(defgroup archive nil
  "Simple editing of archives."
  :group 'data)
Karl Heuer's avatar
Karl Heuer committed
109

Richard M. Stallman's avatar
Richard M. Stallman committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
(defgroup archive-arc nil
  "ARC-specific options to archive."
  :group 'archive)

(defgroup archive-lzh nil
  "LZH-specific options to archive."
  :group 'archive)

(defgroup archive-zip nil
  "ZIP-specific options to archive."
  :group 'archive)

(defgroup archive-zoo nil
  "ZOO-specific options to archive."
  :group 'archive)

(defcustom archive-tmpdir
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128
  ;; make-temp-name is safe here because we use this name
  ;; to create a directory.
129 130
  (make-temp-name
   (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp")
131
		     temporary-file-directory))
132
  "Directory for temporary files made by `arc-mode.el'."
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134
  :type 'directory
  :group 'archive)
Karl Heuer's avatar
Karl Heuer committed
135

Richard M. Stallman's avatar
Richard M. Stallman committed
136
(defcustom archive-remote-regexp "^/[^/:]*[^/:.]:"
Lute Kamstra's avatar
Lute Kamstra committed
137
  "Regexp recognizing archive files names that are not local.
138
A non-local file is one whose file name is not proper outside Emacs.
Richard M. Stallman's avatar
Richard M. Stallman committed
139 140 141 142 143
A local copy of the archive will be used when updating."
  :type 'regexp
  :group 'archive)

(defcustom archive-extract-hooks nil
Lute Kamstra's avatar
Lute Kamstra committed
144
  "Hooks to run when an archive member has been extracted."
Richard M. Stallman's avatar
Richard M. Stallman committed
145 146
  :type 'hook
  :group 'archive)
Karl Heuer's avatar
Karl Heuer committed
147 148 149 150 151
;; ------------------------------
;; Arc archive configuration

;; We always go via a local file since there seems to be no reliable way
;; to extract to stdout without junk getting added.
Richard M. Stallman's avatar
Richard M. Stallman committed
152
(defcustom archive-arc-extract
Karl Heuer's avatar
Karl Heuer committed
153
  '("arc" "x")
Lute Kamstra's avatar
Lute Kamstra committed
154
  "Program and its options to run in order to extract an arc file member.
155
Extraction should happen to the current directory.  Archive and member
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157 158 159 160 161 162 163
name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-arc)

(defcustom archive-arc-expunge
Karl Heuer's avatar
Karl Heuer committed
164
  '("arc" "d")
Lute Kamstra's avatar
Lute Kamstra committed
165
  "Program and its options to run in order to delete arc file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168 169 170 171 172 173
Archive and member names will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-arc)

(defcustom archive-arc-write-file-member
Karl Heuer's avatar
Karl Heuer committed
174
  '("arc" "u")
Lute Kamstra's avatar
Lute Kamstra committed
175
  "Program and its options to run in order to update an arc file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
176 177 178 179 180 181
Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-arc)
Karl Heuer's avatar
Karl Heuer committed
182 183 184
;; ------------------------------
;; Lzh archive configuration

Richard M. Stallman's avatar
Richard M. Stallman committed
185
(defcustom archive-lzh-extract
Karl Heuer's avatar
Karl Heuer committed
186
  '("lha" "pq")
Lute Kamstra's avatar
Lute Kamstra committed
187
  "Program and its options to run in order to extract an lzh file member.
188
Extraction should happen to standard output.  Archive and member name will
Richard M. Stallman's avatar
Richard M. Stallman committed
189 190 191 192 193 194 195 196
be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-lzh)

(defcustom archive-lzh-expunge
Karl Heuer's avatar
Karl Heuer committed
197
  '("lha" "d")
Lute Kamstra's avatar
Lute Kamstra committed
198
  "Program and its options to run in order to delete lzh file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201 202 203 204 205 206
Archive and member names will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-lzh)

(defcustom archive-lzh-write-file-member
Karl Heuer's avatar
Karl Heuer committed
207
  '("lha" "a")
Lute Kamstra's avatar
Lute Kamstra committed
208
  "Program and its options to run in order to update an lzh file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
209 210 211 212 213 214
Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-lzh)
Karl Heuer's avatar
Karl Heuer committed
215 216 217
;; ------------------------------
;; Zip archive configuration

Richard M. Stallman's avatar
Richard M. Stallman committed
218
(defcustom archive-zip-extract
219 220 221 222
  (cond ((executable-find "unzip") '("unzip" "-qq" "-c"))
	((executable-find "7z") '("7z" "x" "-so"))
	((executable-find "pkunzip") '("pkunzip" "-e" "-o-"))
	(t '("unzip" "-qq" "-c")))
Lute Kamstra's avatar
Lute Kamstra committed
223
  "Program and its options to run in order to extract a zip file member.
224
Extraction should happen to standard output.  Archive and member name will
225
be added."
Richard M. Stallman's avatar
Richard M. Stallman committed
226
  :type '(list (string :tag "Program")
227 228 229
	       (repeat :tag "Options"
		       :inline t
		       (string :format "%v")))
Richard M. Stallman's avatar
Richard M. Stallman committed
230
  :group 'archive-zip)
Karl Heuer's avatar
Karl Heuer committed
231

232
;; For several reasons the latter behavior is not desirable in general.
Karl Heuer's avatar
Karl Heuer committed
233 234 235 236
;; (1) It uses more disk space.  (2) Error checking is worse or non-
;; existent.  (3) It tends to do funny things with other systems' file
;; names.

Richard M. Stallman's avatar
Richard M. Stallman committed
237
(defcustom archive-zip-expunge
238 239 240 241
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-d")
    '("zip" "-d" "-q"))
Lute Kamstra's avatar
Lute Kamstra committed
242
  "Program and its options to run in order to delete zip file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
243 244 245 246 247 248 249 250
Archive and member names will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zip)

(defcustom archive-zip-update
251 252 253 254
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-u" "-P")
    '("zip" "-q"))
Lute Kamstra's avatar
Lute Kamstra committed
255
  "Program and its options to run in order to update a zip file member.
Karl Heuer's avatar
Karl Heuer committed
256
Options should ensure that specified directory will be put into the zip
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258 259 260 261 262 263 264
file.  Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zip)

(defcustom archive-zip-update-case
265 266 267 268
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-u" "-P")
    '("zip" "-q" "-k"))
Lute Kamstra's avatar
Lute Kamstra committed
269
  "Program and its options to run in order to update a case fiddled zip member.
270
Options should ensure that specified directory will be put into the zip file.
Richard M. Stallman's avatar
Richard M. Stallman committed
271 272 273 274 275 276 277 278
Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zip)

(defcustom archive-zip-case-fiddle t
Lute Kamstra's avatar
Lute Kamstra committed
279
  "If non-nil then zip file members may be down-cased.
280 281
This case fiddling will only happen for members created by a system
that uses caseless file names."
Richard M. Stallman's avatar
Richard M. Stallman committed
282 283
  :type 'boolean
  :group 'archive-zip)
Karl Heuer's avatar
Karl Heuer committed
284 285 286
;; ------------------------------
;; Zoo archive configuration

Richard M. Stallman's avatar
Richard M. Stallman committed
287
(defcustom archive-zoo-extract
Karl Heuer's avatar
Karl Heuer committed
288
  '("zoo" "xpq")
Lute Kamstra's avatar
Lute Kamstra committed
289
  "Program and its options to run in order to extract a zoo file member.
290
Extraction should happen to standard output.  Archive and member name will
Richard M. Stallman's avatar
Richard M. Stallman committed
291 292 293 294 295 296 297 298
be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zoo)

(defcustom archive-zoo-expunge
Karl Heuer's avatar
Karl Heuer committed
299
  '("zoo" "DqPP")
Lute Kamstra's avatar
Lute Kamstra committed
300
  "Program and its options to run in order to delete zoo file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
301 302 303 304 305 306 307 308
Archive and member names will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zoo)

(defcustom archive-zoo-write-file-member
Karl Heuer's avatar
Karl Heuer committed
309
  '("zoo" "a")
Lute Kamstra's avatar
Lute Kamstra committed
310
  "Program and its options to run in order to update a zoo file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
311 312 313 314 315 316
Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zoo)
317 318 319 320 321 322 323 324 325 326 327 328 329 330
;; ------------------------------
;; 7z archive configuration

(defcustom archive-7z-extract
  '("7z" "x" "-so")
  "Program and its options to run in order to extract a 7z file member.
Extraction should happen to standard output.  Archive and member name will
be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-7z)

Karl Heuer's avatar
Karl Heuer committed
331
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
332
;;; Section: Variables
Karl Heuer's avatar
Karl Heuer committed
333

334 335 336 337 338 339
(defvar archive-subtype nil "Symbol describing archive type.")
(defvar archive-file-list-start nil "Position of first contents line.")
(defvar archive-file-list-end nil "Position just after last contents line.")
(defvar archive-proper-file-start nil "Position of real archive's start.")
(defvar archive-read-only nil "Non-nil if the archive is read-only on disk.")
(defvar archive-local-name nil "Name of local copy of remote archive.")
340 341
(defvar archive-mode-map
  (let ((map (make-keymap)))
342
    (set-keymap-parent map special-mode-map)
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
    (define-key map " " 'archive-next-line)
    (define-key map "a" 'archive-alternate-display)
    ;;(define-key map "c" 'archive-copy)
    (define-key map "d" 'archive-flag-deleted)
    (define-key map "\C-d" 'archive-flag-deleted)
    (define-key map "e" 'archive-extract)
    (define-key map "f" 'archive-extract)
    (define-key map "\C-m" 'archive-extract)
    (define-key map "m" 'archive-mark)
    (define-key map "n" 'archive-next-line)
    (define-key map "\C-n" 'archive-next-line)
    (define-key map [down] 'archive-next-line)
    (define-key map "o" 'archive-extract-other-window)
    (define-key map "p" 'archive-previous-line)
    (define-key map "\C-p" 'archive-previous-line)
    (define-key map [up] 'archive-previous-line)
    (define-key map "r" 'archive-rename-entry)
    (define-key map "u" 'archive-unflag)
    (define-key map "\M-\C-?" 'archive-unmark-all-files)
    (define-key map "v" 'archive-view)
    (define-key map "x" 'archive-expunge)
    (define-key map "\177" 'archive-unflag-backwards)
    (define-key map "E" 'archive-extract-other-window)
    (define-key map "M" 'archive-chmod-entry)
    (define-key map "G" 'archive-chgrp-entry)
    (define-key map "O" 'archive-chown-entry)
369 370
    ;; Let mouse-1 follow the link.
    (define-key map [follow-link] 'mouse-face)
371 372 373 374 375 376 377 378 379

    (if (fboundp 'command-remapping)
        (progn
          (define-key map [remap advertised-undo] 'archive-undo)
          (define-key map [remap undo] 'archive-undo))
      (substitute-key-definition 'advertised-undo 'archive-undo map global-map)
      (substitute-key-definition 'undo 'archive-undo map global-map))

    (define-key map
380
      (if (featurep 'xemacs) 'button2 [mouse-2]) 'archive-extract)
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443

    (if (featurep 'xemacs)
        ()				; out of luck

      (define-key map [menu-bar immediate]
        (cons "Immediate" (make-sparse-keymap "Immediate")))
      (define-key map [menu-bar immediate alternate]
        '(menu-item "Alternate Display" archive-alternate-display
          :enable (boundp (archive-name "alternate-display"))
          :help "Toggle alternate file info display"))
      (define-key map [menu-bar immediate view]
        '(menu-item "View This File" archive-view
          :help "Display file at cursor in View Mode"))
      (define-key map [menu-bar immediate display]
        '(menu-item "Display in Other Window" archive-display-other-window
          :help "Display file at cursor in another window"))
      (define-key map [menu-bar immediate find-file-other-window]
        '(menu-item "Find in Other Window" archive-extract-other-window
          :help "Edit file at cursor in another window"))
      (define-key map [menu-bar immediate find-file]
        '(menu-item "Find This File" archive-extract
          :help "Extract file at cursor and edit it"))

      (define-key map [menu-bar mark]
        (cons "Mark" (make-sparse-keymap "Mark")))
      (define-key map [menu-bar mark unmark-all]
        '(menu-item "Unmark All" archive-unmark-all-files
          :help "Unmark all marked files"))
      (define-key map [menu-bar mark deletion]
        '(menu-item "Flag" archive-flag-deleted
          :help "Flag file at cursor for deletion"))
      (define-key map [menu-bar mark unmark]
        '(menu-item "Unflag" archive-unflag
          :help "Unmark file at cursor"))
      (define-key map [menu-bar mark mark]
        '(menu-item "Mark" archive-mark
          :help "Mark file at cursor"))

      (define-key map [menu-bar operate]
        (cons "Operate" (make-sparse-keymap "Operate")))
      (define-key map [menu-bar operate chown]
        '(menu-item "Change Owner..." archive-chown-entry
          :enable (fboundp (archive-name "chown-entry"))
          :help "Change owner of marked files"))
      (define-key map [menu-bar operate chgrp]
        '(menu-item "Change Group..." archive-chgrp-entry
          :enable (fboundp (archive-name "chgrp-entry"))
          :help "Change group ownership of marked files"))
      (define-key map [menu-bar operate chmod]
        '(menu-item "Change Mode..." archive-chmod-entry
          :enable (fboundp (archive-name "chmod-entry"))
          :help "Change mode (permissions) of marked files"))
      (define-key map [menu-bar operate rename]
        '(menu-item "Rename to..." archive-rename-entry
          :enable (fboundp (archive-name "rename-entry"))
          :help "Rename marked files"))
      ;;(define-key map [menu-bar operate copy]
      ;;  '(menu-item "Copy to..." archive-copy))
      (define-key map [menu-bar operate expunge]
        '(menu-item "Expunge Marked Files" archive-expunge
          :help "Delete all flagged files from archive"))
      map))
  "Local keymap for archive mode listings.")
444 445 446
(defvar archive-file-name-indent nil "Column where file names start.")

(defvar archive-remote nil "Non-nil if the archive is outside file system.")
447 448 449 450 451 452
(make-variable-buffer-local 'archive-remote)
(put 'archive-remote 'permanent-local t)

(defvar archive-member-coding-system nil "Coding-system of archive member.")
(make-variable-buffer-local 'archive-member-coding-system)

Karl Heuer's avatar
Karl Heuer committed
453
(defvar archive-alternate-display nil
454
  "Non-nil when alternate information is shown.")
Karl Heuer's avatar
Karl Heuer committed
455 456 457
(make-variable-buffer-local 'archive-alternate-display)
(put 'archive-alternate-display 'permanent-local t)

458
(defvar archive-superior-buffer nil "In archive members, points to archive.")
Karl Heuer's avatar
Karl Heuer committed
459 460
(put 'archive-superior-buffer 'permanent-local t)

461
(defvar archive-subfile-mode nil "Non-nil in archive member buffers.")
Karl Heuer's avatar
Karl Heuer committed
462 463 464
(make-variable-buffer-local 'archive-subfile-mode)
(put 'archive-subfile-mode 'permanent-local t)

465 466 467 468
(defvar archive-file-name-coding-system nil)
(make-variable-buffer-local 'archive-file-name-coding-system)
(put 'archive-file-name-coding-system 'permanent-local t)

Richard M. Stallman's avatar
Richard M. Stallman committed
469 470 471 472
(defvar archive-files nil
  "Vector of file descriptors.
Each descriptor is a vector of the form
 [EXT-FILE-NAME INT-FILE-NAME CASE-FIDDLED MODE ...]")
Karl Heuer's avatar
Karl Heuer committed
473
(make-variable-buffer-local 'archive-files)
Karl Heuer's avatar
Karl Heuer committed
474

Karl Heuer's avatar
Karl Heuer committed
475
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
476
;;; Section: Support functions.
Karl Heuer's avatar
Karl Heuer committed
477

478 479 480 481 482 483 484 485 486 487 488 489
(eval-when-compile
  (defsubst byte-after (pos)
    "Like char-after but an eight-bit char is converted to unibyte."
    (multibyte-char-to-unibyte (char-after pos)))
  (defsubst insert-unibyte (&rest args)
    "Like insert but don't make unibyte string and eight-bit char multibyte."
    (dolist (elt args)
      (if (integerp elt)
	  (insert (if (< elt 128) elt (decode-char 'eight-bit elt)))
	(insert (string-to-multibyte elt)))))
  )

Karl Heuer's avatar
Karl Heuer committed
490 491 492
(defsubst archive-name (suffix)
  (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))

493
(defun archive-l-e (str &optional len float)
494 495
  "Convert little endian string/vector STR to integer.
Alternatively, STR may be a buffer position in the current buffer
496 497 498
in which case a second argument, length LEN, should be supplied.
FLOAT, if non-nil, means generate and return a float instead of an integer
\(use this for numbers that can overflow the Emacs integer)."
Karl Heuer's avatar
Karl Heuer committed
499 500 501
  (if (stringp str)
      (setq len (length str))
    (setq str (buffer-substring str (+ str len))))
Kenichi Handa's avatar
Kenichi Handa committed
502
  (setq str (string-as-unibyte str))
Karl Heuer's avatar
Karl Heuer committed
503 504 505 506
  (let ((result 0)
        (i 0))
    (while (< i len)
      (setq i (1+ i)
507 508
            result (+ (if float (* result 256.0) (ash result 8))
		      (aref str (- len i)))))
Karl Heuer's avatar
Karl Heuer committed
509 510 511
    result))

(defun archive-int-to-mode (mode)
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
  "Turn an integer like 0700 (i.e., 448) into a mode string like -rwx------."
  ;; FIXME: merge with tar-grind-file-mode.
  (string
    (if (zerop (logand  8192 mode))
	(if (zerop (logand 16384 mode)) ?- ?d)
      ?c) ; completeness
    (if (zerop (logand   256 mode)) ?- ?r)
    (if (zerop (logand   128 mode)) ?- ?w)
    (if (zerop (logand    64 mode))
	(if (zerop (logand  1024 mode)) ?- ?S)
      (if (zerop (logand  1024 mode)) ?x ?s))
    (if (zerop (logand    32 mode)) ?- ?r)
    (if (zerop (logand    16 mode)) ?- ?w)
    (if (zerop (logand     8 mode))
	(if (zerop (logand  2048 mode)) ?- ?S)
      (if (zerop (logand  2048 mode)) ?x ?s))
    (if (zerop (logand     4 mode)) ?- ?r)
    (if (zerop (logand     2 mode)) ?- ?w)
    (if (zerop (logand     1 mode)) ?- ?x)))
Karl Heuer's avatar
Karl Heuer committed
531 532

(defun archive-calc-mode (oldmode newmode &optional error)
533
  "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
Karl Heuer's avatar
Karl Heuer committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
NEWMODE may be an octal number including a leading zero in which case it
will become the new mode.\n
NEWMODE may also be a relative specification like \"og-rwx\" in which case
OLDMODE will be modified accordingly just like chmod(2) would have done.\n
If optional third argument ERROR is non-nil an error will be signaled if
the mode is invalid.  If ERROR is nil then nil will be returned."
  (cond ((string-match "^0[0-7]*$" newmode)
	 (let ((result 0)
	       (len (length newmode))
	       (i 1))
	   (while (< i len)
	     (setq result (+ (lsh result 3) (aref newmode i) (- ?0))
		   i (1+ i)))
	   (logior (logand oldmode 65024) result)))
	((string-match "^\\([agou]+\\)\\([---+=]\\)\\([rwxst]+\\)$" newmode)
	 (let ((who 0)
	       (result oldmode)
	       (op (aref newmode (match-beginning 2)))
	       (bits 0)
	       (i (match-beginning 3)))
	   (while (< i (match-end 3))
	     (let ((rwx (aref newmode i)))
	       (setq bits (logior bits (cond ((= rwx ?r)  292)
					     ((= rwx ?w)  146)
					     ((= rwx ?x)   73)
					     ((= rwx ?s) 3072)
					     ((= rwx ?t)  512)))
		     i (1+ i))))
	   (while (< who (match-end 1))
	     (let* ((whoc (aref newmode who))
		    (whomask (cond ((= whoc ?a) 4095)
				   ((= whoc ?u) 1472)
				   ((= whoc ?g) 2104)
				   ((= whoc ?o)    7))))
	       (if (= op ?=)
		   (setq result (logand result (lognot whomask))))
	       (if (= op ?-)
		   (setq result (logand result (lognot (logand whomask bits))))
		 (setq result (logior result (logand whomask bits)))))
	     (setq who (1+ who)))
	   result))
	(t
	 (if error
	     (error "Invalid mode specification: %s" newmode)))))

(defun archive-dosdate (date)
  "Stringify dos packed DATE record."
  (let ((year (+ 1980 (logand (ash date -9) 127)))
        (month (logand (ash date -5) 15))
        (day (logand date 31)))
    (if (or (> month 12) (< month 1))
        ""
      (format "%2d-%s-%d"
              day
              (aref ["Jan" "Feb" "Mar" "Apr" "May" "Jun"
                     "Jul" "Aug" "Sep" "Oct" "Nov" "Dec"] (1- month))
              year))))

(defun archive-dostime (time)
  "Stringify dos packed TIME record."
  (let ((hour (logand (ash time -11) 31))
595
        (minute (logand (ash time -5) 63))
Karl Heuer's avatar
Karl Heuer committed
596 597 598
        (second (* 2 (logand time 31)))) ; 2 seconds resolution
    (format "%02d:%02d:%02d" hour minute second)))

599
(defun archive-unixdate (low high)
600
  "Stringify Unix (LOW HIGH) date."
601 602 603 604 605
  (let ((str (current-time-string (cons high low))))
    (format "%s-%s-%s"
	    (substring str 8 10)
	    (substring str 4 7)
	    (substring str 20 24))))
Karl Heuer's avatar
Karl Heuer committed
606

607
(defun archive-unixtime (low high)
608
  "Stringify Unix (LOW HIGH) time."
609 610
  (let ((str (current-time-string (cons high low))))
    (substring str 11 19)))
Karl Heuer's avatar
Karl Heuer committed
611 612 613 614

(defun archive-get-lineno ()
  (if (>= (point) archive-file-list-start)
      (count-lines archive-file-list-start
615
		   (line-beginning-position))
Karl Heuer's avatar
Karl Heuer committed
616 617 618
    0))

(defun archive-get-descr (&optional noerror)
619
  "Return the descriptor vector for file at point.
620
Does not signal an error if optional argument NOERROR is non-nil."
Karl Heuer's avatar
Karl Heuer committed
621 622 623 624 625 626 627 628 629 630 631
  (let ((no (archive-get-lineno)))
    (if (and (>= (point) archive-file-list-start)
             (< no (length archive-files)))
	(let ((item (aref archive-files no)))
	  (if (vectorp item)
	      item
	    (if (not noerror)
		(error "Entry is not a regular member of the archive"))))
      (if (not noerror)
          (error "Line does not describe a member of the archive")))))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
632
;;; Section: the mode definition
Karl Heuer's avatar
Karl Heuer committed
633

634
;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
635
(defun archive-mode (&optional force)
636 637
  "Major mode for viewing an archive file in a dired-like way.
You can move around using the usual cursor motion commands.
Karl Heuer's avatar
Karl Heuer committed
638 639 640 641 642 643 644 645 646 647 648 649 650
Letters no longer insert themselves.
Type `e' to pull a file out of the archive and into its own buffer;
or click mouse-2 on the file's line in the archive mode buffer.

If you edit a sub-file of this archive (as with the `e' command) and
save it, the contents of that buffer will be saved back into the
archive.

\\{archive-mode-map}"
  ;; This is not interactive because you shouldn't be turning this
  ;; mode on and off.  You can corrupt things that way.
  (if (zerop (buffer-size))
      ;; At present we cannot create archives from scratch
651
      (funcall (or (default-value 'major-mode) 'fundamental-mode))
Karl Heuer's avatar
Karl Heuer committed
652 653
    (if (and (not force) archive-files) nil
      (let* ((type (archive-find-type))
654
	     (typename (capitalize (symbol-name type))))
Karl Heuer's avatar
Karl Heuer committed
655 656 657 658 659 660 661 662 663
	(kill-all-local-variables)
	(make-local-variable 'archive-subtype)
	(setq archive-subtype type)

	;; Buffer contains treated image of file before the file contents
	(make-local-variable 'revert-buffer-function)
	(setq revert-buffer-function 'archive-mode-revert)
	(auto-save-mode 0)

664 665
	;; Remote archives are not written by a hook.
	(if archive-remote nil
666
	  (add-hook 'write-contents-functions 'archive-write-file nil t))
667

Karl Heuer's avatar
Karl Heuer committed
668 669
	(make-local-variable 'require-final-newline)
	(setq require-final-newline nil)
670 671
	(make-local-variable 'local-enable-local-variables)
	(setq local-enable-local-variables nil)
Karl Heuer's avatar
Karl Heuer committed
672

673 674 675 676
	;; Prevent loss of data when saving the file.
	(make-local-variable 'file-precious-flag)
	(setq file-precious-flag t)

Karl Heuer's avatar
Karl Heuer committed
677
	(make-local-variable 'archive-read-only)
678 679 680 681 682
	;; Archives which are inside other archives and whose
	;; names are invalid for this OS, can't be written.
	(setq archive-read-only
	      (or (not (file-writable-p (buffer-file-name)))
		  (and archive-subfile-mode
683
		       (string-match file-name-invalid-regexp
684
				     (aref archive-subfile-mode 0)))))
Karl Heuer's avatar
Karl Heuer committed
685 686 687

	;; Should we use a local copy when accessing from outside Emacs?
	(make-local-variable 'archive-local-name)
688 689 690 691 692 693

	;; An archive can contain another archive whose name is invalid
	;; on local filesystem.  Treat such archives as remote.
	(or archive-remote
	    (setq archive-remote
		  (or (string-match archive-remote-regexp (buffer-file-name))
694
		      (string-match file-name-invalid-regexp
695
				    (buffer-file-name)))))
Karl Heuer's avatar
Karl Heuer committed
696 697 698 699

	(setq major-mode 'archive-mode)
	(setq mode-name (concat typename "-Archive"))
	;; Run archive-foo-mode-hook and archive-mode-hook
700
	(run-mode-hooks (archive-name "mode-hook") 'archive-mode-hook)
Karl Heuer's avatar
Karl Heuer committed
701 702 703 704 705 706
	(use-local-map archive-mode-map))

      (make-local-variable 'archive-proper-file-start)
      (make-local-variable 'archive-file-list-start)
      (make-local-variable 'archive-file-list-end)
      (make-local-variable 'archive-file-name-indent)
707 708 709 710
      (setq archive-file-name-coding-system
	    (or file-name-coding-system
		default-file-name-coding-system
		locale-coding-system))
711
      (if (default-value 'enable-multibyte-characters)
Kenichi Handa's avatar
Kenichi Handa committed
712
	  (set-buffer-multibyte 'to))
713
      (archive-summarize nil)
Karl Heuer's avatar
Karl Heuer committed
714 715 716 717 718
      (setq buffer-read-only t))))

;; Archive mode is suitable only for specially formatted data.
(put 'archive-mode 'mode-class 'special)

719
(let ((item1 '(archive-subfile-mode " Archive")))
Karl Heuer's avatar
Karl Heuer committed
720
  (or (member item1 minor-mode-alist)
721
      (setq minor-mode-alist (cons item1 minor-mode-alist))))
Karl Heuer's avatar
Karl Heuer committed
722 723 724 725 726 727 728
;; -------------------------------------------------------------------------
(defun archive-find-type ()
  (widen)
  (goto-char (point-min))
  ;; The funny [] here make it unlikely that the .elc file will be treated
  ;; as an archive by other software.
  (let (case-fold-search)
729
    (cond ((looking-at "\\(PK00\\)?[P]K\003\004") 'zip)
730
	  ((looking-at "..-l[hz][0-9ds]-") 'lzh)
Karl Heuer's avatar
Karl Heuer committed
731 732 733 734 735
	  ((looking-at "....................[\334]\247\304\375") 'zoo)
	  ((and (looking-at "\C-z")	; signature too simple, IMHO
		(string-match "\\.[aA][rR][cC]$"
			      (or buffer-file-name (buffer-name))))
	   'arc)
736
          ;; This pattern modeled on the BSD/GNU+Linux `file' command.
737 738 739
          ;; Have seen capital "LHA's", and file has lower case "LHa's" too.
          ;; Note this regexp is also in archive-exe-p.
          ((looking-at "MZ\\(.\\|\n\\)\\{34\\}LH[aA]'s SFX ") 'lzh-exe)
Stefan Monnier's avatar
Stefan Monnier committed
740
          ((looking-at "Rar!") 'rar)
741
          ((looking-at "!<arch>\n") 'ar)
742 743 744
          ((and (looking-at "MZ")
                (re-search-forward "Rar!" (+ (point) 100000) t))
           'rar-exe)
745
	  ((looking-at "7z\274\257\047\034") '7z)
746
	  (t (error "Buffer format not recognized")))))
Karl Heuer's avatar
Karl Heuer committed
747
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
748 749 750 751 752 753 754 755 756

(defun archive-desummarize ()
  (let ((inhibit-read-only t)
        (modified (buffer-modified-p)))
    (widen)
    (delete-region (point-min) archive-proper-file-start)
    (restore-buffer-modified-p modified)))


757
(defun archive-summarize (&optional shut-up)
Karl Heuer's avatar
Karl Heuer committed
758 759 760
  "Parse the contents of the archive file in the current buffer.
Place a dired-like listing on the front;
then narrow to it, so that only that listing
761 762 763
is visible (and the real data of the buffer is hidden).
Optional argument SHUT-UP, if non-nil, means don't print messages
when parsing the archive."
Karl Heuer's avatar
Karl Heuer committed
764
  (widen)
765
  (let ((inhibit-read-only t))
Stefan Monnier's avatar
Stefan Monnier committed
766 767
    (setq archive-proper-file-start (copy-marker (point-min) t))
    (set (make-local-variable 'change-major-mode-hook) 'archive-desummarize)
768 769
    (or shut-up
	(message "Parsing archive file..."))
Karl Heuer's avatar
Karl Heuer committed
770 771
    (buffer-disable-undo (current-buffer))
    (setq archive-files (funcall (archive-name "summarize")))
772 773
    (or shut-up
	(message "Parsing archive file...done."))
Karl Heuer's avatar
Karl Heuer committed
774 775 776 777 778 779 780 781 782
    (setq archive-proper-file-start (point-marker))
    (narrow-to-region (point-min) (point))
    (set-buffer-modified-p nil)
    (buffer-enable-undo))
  (goto-char archive-file-list-start)
  (archive-next-line 0))

(defun archive-resummarize ()
  "Recreate the contents listing of an archive."
Stefan Monnier's avatar
Stefan Monnier committed
783 784
  (let ((no (archive-get-lineno)))
    (archive-desummarize)
785
    (archive-summarize t)
Karl Heuer's avatar
Karl Heuer committed
786 787 788 789
    (goto-char archive-file-list-start)
    (archive-next-line no)))

(defun archive-summarize-files (files)
Richard M. Stallman's avatar
Richard M. Stallman committed
790
  "Insert a description of a list of files annotated with proper mouse face."
Karl Heuer's avatar
Karl Heuer committed
791 792 793 794 795 796 797 798
  (setq archive-file-list-start (point-marker))
  (setq archive-file-name-indent (if files (aref (car files) 1) 0))
  ;; We don't want to do an insert for each element since that takes too
  ;; long when the archive -- which has to be moved in memory -- is large.
  (insert
   (apply
    (function concat)
    (mapcar
799 800 801 802 803 804 805 806 807 808 809 810
     (lambda (fil)
       ;; Using `concat' here copies the text also, so we can add
       ;; properties without problems.
       (let ((text (concat (aref fil 0) "\n")))
         (if (featurep 'xemacs)
             ()                         ; out of luck
           (add-text-properties
            (aref fil 1) (aref fil 2)
            '(mouse-face highlight
              help-echo "mouse-2: extract this file into a buffer")
            text))
         text))
Karl Heuer's avatar
Karl Heuer committed
811 812 813 814
     files)))
  (setq archive-file-list-end (point-marker)))

(defun archive-alternate-display ()
815
  "Toggle alternative display.
816
To avoid very long lines archive mode does not show all information.
817
This function changes the set of information shown for each files."
Karl Heuer's avatar
Karl Heuer committed
818 819 820 821
  (interactive)
  (setq archive-alternate-display (not archive-alternate-display))
  (archive-resummarize))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
822
;;; Section: Local archive copy handling
Karl Heuer's avatar
Karl Heuer committed
823

824 825 826 827 828 829
(defun archive-unique-fname (fname dir)
  "Make sure a file FNAME can be created uniquely in directory DIR.

If FNAME can be uniquely created in DIR, it is returned unaltered.
If FNAME is something our underlying filesystem can't grok, or if another
file by that name already exists in DIR, a unique new name is generated
830
using `make-temp-file', and the generated name is returned."
831
  (let ((fullname (expand-file-name fname dir))
832 833
	(alien (string-match file-name-invalid-regexp fname))
	(tmpfile
834
	 (expand-file-name
835 836
	  (if (if (fboundp 'msdos-long-file-names)
		  (not (msdos-long-file-names)))
837 838
	      "am"
	    "arc-mode.")
839 840 841 842 843 844 845 846 847
	  dir)))
    (if (or alien (file-exists-p fullname))
	(progn
	  ;; Maked sure all the leading directories in
	  ;; archive-local-name exist under archive-tmpdir, so that
	  ;; the directory structure recorded in the archive is
	  ;; reconstructed in the temporary directory.
	  (make-directory (file-name-directory tmpfile) t)
	  (make-temp-file tmpfile))
848 849 850 851 852
      ;; Maked sure all the leading directories in `fullname' exist
      ;; under archive-tmpdir.  This is necessary for nested archives
      ;; (`archive-extract' sets `archive-remote' to t in case
      ;; an archive occurs inside another archive).
      (make-directory (file-name-directory fullname) t)
853 854
      fullname)))

Karl Heuer's avatar
Karl Heuer committed
855
(defun archive-maybe-copy (archive)
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  (let ((coding-system-for-write 'no-conversion))
    (if archive-remote
	(let ((start (point-max))
	      ;; Sometimes ARCHIVE is invalid while its actual name, as
	      ;; recorded in its parent archive, is not.  For example, an
	      ;; archive bar.zip inside another archive foo.zip gets a name
	      ;; "foo.zip:bar.zip", which is invalid on DOS/Windows.
	      ;; So use the actual name if available.
	      (archive-name
	       (or (and archive-subfile-mode (aref archive-subfile-mode 0))
		   archive)))
	  (setq archive-local-name
		(archive-unique-fname archive-name archive-tmpdir))
	  (save-restriction
	    (widen)
	    (write-region start (point-max) archive-local-name nil 'nomessage))
	  archive-local-name)
      (if (buffer-modified-p) (save-buffer))
      archive)))
Karl Heuer's avatar
Karl Heuer committed
875 876 877 878 879

(defun archive-maybe-update (unchanged)
  (if archive-remote
      (let ((name archive-local-name)
	    (modified (buffer-modified-p))
880 881
	    (coding-system-for-read 'no-conversion)
	    (lno (archive-get-lineno))
882
	    (inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
883
	(if unchanged nil
884
	  (setq archive-files nil)
Karl Heuer's avatar
Karl Heuer committed
885 886
	  (erase-buffer)
	  (insert-file-contents name)
887 888 889
	  (archive-mode t)
	  (goto-char archive-file-list-start)
	  (archive-next-line lno))
Karl Heuer's avatar
Karl Heuer committed
890 891
	(archive-delete-local name)
	(if (not unchanged)
892 893 894
	    (message
	     "Buffer `%s' must be saved for changes to take effect"
	     (buffer-name (current-buffer))))
Karl Heuer's avatar
Karl Heuer committed
895 896 897
	(set-buffer-modified-p (or modified (not unchanged))))))

(defun archive-delete-local (name)
898
  "Delete file NAME and its parents up to and including `archive-tmpdir'."
Karl Heuer's avatar
Karl Heuer committed
899 900 901 902 903 904 905 906 907 908 909 910
  (let ((again t)
	(top (directory-file-name (file-name-as-directory archive-tmpdir))))
    (condition-case nil
	(delete-file name)
      (error nil))
    (while again
      (setq name (directory-file-name (file-name-directory name)))
      (condition-case nil
	  (delete-directory name)
	(error nil))
      (if (string= name top) (setq again nil)))))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
911
;;; Section: Member extraction
Karl Heuer's avatar
Karl Heuer committed
912

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
(defun archive-try-jka-compr ()
  (when (and auto-compression-mode
             (jka-compr-get-compression-info buffer-file-name))
    (let* ((basename (file-name-nondirectory buffer-file-name))
           (tmpname (if (string-match ":\\([^:]+\\)\\'" basename)
                        (match-string 1 basename) basename))
           (tmpfile (make-temp-file (file-name-sans-extension tmpname)
                                    nil
                                    (file-name-extension tmpname 'period))))
      (unwind-protect
          (progn
            (let ((coding-system-for-write 'no-conversion)
                  ;; Don't re-compress this data just before decompressing it.
                  (jka-compr-inhibit t))
              (write-region (point-min) (point-max) tmpfile nil 'quiet))
            (erase-buffer)
            (let ((coding-system-for-read 'no-conversion))
              (insert-file-contents tmpfile)))
        (delete-file tmpfile)))))

933 934 935 936 937 938 939 940 941
(defun archive-file-name-handler (op &rest args)
  (or (eq op 'file-exists-p)
      (let ((file-name-handler-alist nil))
	(apply op args))))

(defun archive-set-buffer-as-visiting-file (filename)
  "Set the current buffer as if it were visiting FILENAME."
  (save-excursion
    (goto-char (point-min))
942 943
    (let ((buffer-undo-list t)
	  (coding
944 945
	   (or coding-system-for-read
	       (and set-auto-coding-function
946 947 948
		    (save-excursion
		      (funcall set-auto-coding-function
			       filename (- (point-max) (point-min)))))
949 950 951 952 953 954 955 956
	       ;; dos-w32.el defines the function
	       ;; find-buffer-file-type-coding-system for DOS/Windows
	       ;; systems which preserves the coding-system of existing files.
	       ;; (That function is called via file-coding-system-alist.)
	       ;; Here, we want it to act as if the extracted file existed.
	       ;; The following let-binding of file-name-handler-alist forces
	       ;; find-file-not-found-set-buffer-file-coding-system to ignore
	       ;; the file's name (see dos-w32.el).
957 958
	       (let ((file-name-handler-alist
		      '(("" . archive-file-name-handler))))
959 960 961
		 (car (find-operation-coding-system
		       'insert-file-contents
		       (cons filename (current-buffer)) t))))))
962 963 964 965 966 967
      (unless (or coding-system-for-read
                  enable-multibyte-characters)
        (setq coding
              (coding-system-change-text-conversion coding 'raw-text)))
      (unless (memq coding '(nil no-conversion))
        (decode-coding-region (point-min) (point-max) coding)
968 969 970
	(setq last-coding-system-used coding))
      (set-buffer-modified-p nil)
      (kill-local-variable 'buffer-file-coding-system)
971
      (after-insert-file-set-coding (- (point-max) (point-min))))))
972

973
(define-obsolete-function-alias 'archive-mouse-extract 'archive-extract "22.1")
Karl Heuer's avatar
Karl Heuer committed
974

975
(defun archive-extract (&optional other-window-p event)
Karl Heuer's avatar
Karl Heuer committed
976
  "In archive mode, extract this entry of the archive into its own buffer."
977
  (interactive (list nil last-input-event))
978
  (if event (posn-set-point (event-end event)))
Karl Heuer's avatar
Karl Heuer committed
979 980 981 982 983 984 985 986 987 988
  (let* ((view-p (eq other-window-p 'view))
	 (descr (archive-get-descr))
         (ename (aref descr 0))
         (iname (aref descr 1))
         (archive-buffer (current-buffer))
         (arcdir default-directory)
         (archive (buffer-file-name))
         (arcname (file-name-nondirectory archive))
         (bufname (concat (file-name-nondirectory iname) " (" arcname ")"))
         (extractor (archive-name "extract"))
989 990 991 992
	 ;; Members with file names which aren't valid for the
	 ;; underlying filesystem, are treated as read-only.
         (read-only-p (or archive-read-only
			  view-p
993
			  (string-match file-name-invalid-regexp ename)))
994
	 (arcfilename (expand-file-name (concat arcname ":" iname)))
Karl Heuer's avatar
Karl Heuer committed
995
         (buffer (get-buffer bufname))
996 997
         (just-created nil)
	 (file-name-coding archive-file-name-coding-system))
998 999
      (if (and buffer
	       (string= (buffer-file-name buffer) arcfilename))
Karl Heuer's avatar
Karl Heuer committed
1000 1001
          nil
	(setq archive (archive-maybe-copy archive))
1002
	(setq bufname (generate-new-buffer-name bufname))
Karl Heuer's avatar
Karl Heuer committed
1003 1004
        (setq buffer (get-buffer-create bufname))
        (setq just-created t)
1005
        (with-current-buffer buffer
1006
          (setq buffer-file-name arcfilename)
Karl Heuer's avatar
Karl Heuer committed
1007 1008 1009 1010 1011 1012
          (setq buffer-file-truename
                (abbreviate-file-name buffer-file-name))
          ;; Set the default-directory to the dir of the superior buffer.
          (setq default-directory arcdir)
          (make-local-variable 'archive-superior-buffer)
          (setq archive-superior-buffer archive-buffer)
1013
          (add-hook 'write-file-functions 'archive-write-file-member nil t)
Karl Heuer's avatar
Karl Heuer committed
1014
          (setq archive-subfile-mode descr)
1015
	  (setq archive-file-name-coding-system file-name-coding)
1016 1017
	  (if (and
	       (null
1018 1019
		(let (;; We may have to encode file name arguement for
		      ;; external programs.
1020 1021
		      (coding-system-for-write
		       (and enable-multibyte-characters
1022
			    archive-file-name-coding-system))
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
		      ;; We read an archive member by no-conversion at
		      ;; first, then decode appropriately by calling
		      ;; archive-set-buffer-as-visiting-file later.
		      (coding-system-for-read 'no-conversion))
		  (condition-case err
		      (if (fboundp extractor)
			  (funcall extractor archive ename)
			(archive-*-extract archive ename
					   (symbol-value extractor)))
		    (error
		     (ding (message "%s" (error-message-string err)))
		     nil))))
1035 1036 1037 1038
	       just-created)
	      (progn
		(set-buffer-modified-p nil)
		(kill-buffer buffer))
1039
            (archive-try-jka-compr)     ;Pretty ugly hack :-(
1040
	    (archive-set-buffer-as-visiting-file ename)
1041 1042 1043 1044 1045 1046 1047 1048
	    (goto-char (point-min))
	    (rename-buffer bufname)
	    (setq buffer-read-only read-only-p)
	    (setq buffer-undo-list nil)
	    (set-buffer-modified-p nil)
	    (setq buffer-saved-size (buffer-size))
	    (normal-mode)
	    ;; Just in case an archive occurs inside another archive.
1049 1050 1051 1052 1053 1054 1055
	    (when (derived-mode-p 'archive-mode)
              (setq archive-remote t)
              (if read-only-p (setq archive-read-only t))
              ;; We will write out the archive ourselves if it is
              ;; part of another archive.
              (remove-hook 'write-contents-functions 'archive-write-file t))
            (run-hooks 'archive-extract-hooks)
1056 1057 1058
	    (if archive-read-only
		(message "Note: altering this archive is not implemented."))))
	(archive-maybe-update t))
1059
      (or (not (buffer-name buffer))
1060
          (cond
1061 1062
           (view-p
	    (view-buffer buffer (and just-created 'kill-buffer-if-not-modified)))
1063 1064 1065
           ((eq other-window-p 'display) (display-buffer buffer))
           (other-window-p (switch-to-buffer-other-window buffer))
           (t (switch-to-buffer buffer))))))
Karl Heuer's avatar
Karl Heuer committed
1066 1067 1068 1069

(defun archive-*-extract (archive name command)
  (let* ((default-directory (file-name-as-directory archive-tmpdir))
	 (tmpfile (expand-file-name (file-name-nondirectory name)
1070 1071
				    default-directory))
	 exit-status success)
Karl Heuer's avatar
Karl Heuer committed
1072
    (make-directory (directory-file-name default-directory) t)
1073 1074 1075 1076 1077 1078 1079
    (setq exit-status
	  (apply 'call-process
		 (car command)
		 nil
		 nil
		 nil
		 (append (cdr command) (list archive name))))
1080
    (cond ((and (numberp exit-status) (zerop exit-status))
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
	   (if (not (file-exists-p tmpfile))
	       (ding (message "`%s': no such file or directory" tmpfile))
	     (insert-file-contents tmpfile)
	     (setq success t)))
	  ((numberp exit-status)
	   (ding
	    (message "`%s' exited with status %d" (car command) exit-status)))
	  ((stringp exit-status)
	   (ding (message "`%s' aborted: %s" (car command) exit-status)))
	  (t
	   (ding (message "`%s' failed" (car command)))))
    (archive-delete-local tmpfile)
    success))
Karl Heuer's avatar
Karl Heuer committed
1094

1095
(defun archive-extract-by-stdout (archive name command &optional stderr-file)
1096 1097 1098
  (apply 'call-process
	 (car command)
	 nil
1099
	 (if stderr-file (list t stderr-file) t)
1100 1101
	 nil
	 (append (cdr command) (list archive name))))
Karl Heuer's avatar
Karl Heuer committed
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

(defun archive-extract-other-window ()
  "In archive mode, find this member in another window."
  (interactive)
  (archive-extract t))

(defun archive-display-other-window ()
  "In archive mode, display this member in another window."
  (interactive)
  (archive-extract 'display))

(defun archive-view ()
  "In archive mode, view the member on this line."
  (interactive)
  (archive-extract 'view))

(defun archive-add-new-member (arcbuf name)
1119
  "Add current buffer to the archive in ARCBUF naming it NAME."
Karl Heuer's avatar
Karl Heuer committed
1120 1121 1122 1123 1124
  (interactive
   (list (get-buffer
	  (read-buffer "Buffer containing archive: "
		       ;; Find first archive buffer and suggest that
		       (let ((bufs (buffer-list)))
1125 1126 1127 1128
			 (while (and bufs
                                     (not (with-current-buffer (car bufs)
                                            (derived-mode-p 'archive-mode))))
                           (setq bufs (cdr bufs)))
Karl Heuer's avatar
Karl Heuer committed
1129 1130 1131 1132 1133 1134 1135 1136
			 (if bufs
			     (car bufs)
			   (error "There are no archive buffers")))
		       t))
	 (read-string "File name in archive: "
		      (if buffer-file-name
			  (file-name-nondirectory buffer-file-name)
			""))))
1137
  (with-current-buffer arcbuf
1138
    (or (derived-mode-p 'archive-mode)
Karl Heuer's avatar
Karl Heuer committed
1139 1140 1141 1142 1143 1144 1145
	(error "Buffer is not an archive buffer"))
    (if archive-read-only
	(error "Archive is read-only")))
  (if (eq arcbuf (current-buffer))
      (error "An archive buffer cannot be added to itself"))
  (if (string= name "")
      (error "Archive members may not be given empty names"))
1146 1147
  (let ((func (with-current-buffer arcbuf
                (archive-name "add-new-member")))
Karl Heuer's avatar
Karl Heuer committed
1148 1149
	(membuf (current-buffer)))
    (if (fboundp func)
1150
	(with-current-buffer arcbuf
Karl Heuer's avatar
Karl Heuer committed
1151 1152 1153
	  (funcall func buffer-file-name membuf name))
      (error "Adding a new member is not supported for this archive type"))))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
1154
;;; Section: IO stuff
Karl Heuer's avatar
Karl Heuer committed
1155 1156

(defun archive-write-file-member ()
1157 1158 1159 1160
  (save-excursion
    (save-restriction
      (message "Updating archive...")
      (widen)
1161 1162 1163 1164
      (let ((writer  (with-current-buffer archive-superior-buffer
                       (archive-name "write-file-member")))
	    (archive (with-current-buffer archive-superior-buffer
                       (archive-maybe-copy (buffer-file-name)))))
1165 1166 1167 1168
	(if (fboundp writer)
	    (funcall writer archive archive-subfile-mode)
	  (archive-*-write-file-member archive
				       archive-subfile-mode
1169 1170 1171
				       (symbol-value writer)))
	(set-buffer-modified-p nil)
	(message "Updating archive...done"))
1172
      (set-buffer archive-superior-buffer)
1173 1174 1175 1176 1177 1178
      (if (not archive-remote) (revert-buffer) (archive-maybe-update nil))))
  ;; Restore the value of last-coding-system-used, so that basic-save-buffer
  ;; won't reset the coding-system of this archive member.
  (if (local-variable-p 'archive-member-coding-system)
      (setq last-coding-system-used archive-member-coding-system))
  t)
Karl Heuer's avatar
Karl Heuer committed
1179 1180 1181 1182 1183 1184 1185 1186 1187

(defun archive-*-write-file-member (archive descr command)
  (let* ((ename (aref descr 0))
         (tmpfile (expand-file-name ename archive-tmpdir))
         (top (directory-file-name (file-name-as-directory archive-tmpdir)))
	 (default-directory (file-name-as-directory top)))
    (unwind-protect
        (progn
          (make-directory (file-name-directory tmpfile) t)
1188 1189 1190 1191
	  ;; If the member is itself an archive, write it without
	  ;; the dired-like listing we created.
	  (if (eq major-mode 'archive-mode)
	      (archive-write-file tmpfile)
1192
	    (write-region nil nil tmpfile nil 'nomessage))
1193 1194 1195 1196 1197
	  ;; basic-save-buffer needs last-coding-system-used to have
	  ;; the value used to write the file, so save it before any
	  ;; further processing clobbers it (we restore it in
	  ;; archive-write-file-member, above).
	  (setq archive-member-coding-system last-coding-system-used)
Karl Heuer's avatar
Karl Heuer committed
1198 1199 1200
	  (if (aref descr 3)
	      ;; Set the file modes, but make sure we can read it.
	      (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
	  (setq ename
		(encode-coding-string ename archive-file-name-coding-system))
          (let* ((coding-system-for-write 'no-conversion)
		 (exitcode (apply 'call-process
				  (car command)
				  nil
				  nil
				  nil
				  (append (cdr command)
					  (list archive ename)))))
1211 1212
            (or (zerop exitcode)
		(error "Updating was unsuccessful (%S)" exitcode))))
Karl Heuer's avatar
Karl Heuer committed
1213 1214
      (archive-delete-local tmpfile))))

1215
(defun archive-write-file (&optional file)
Karl Heuer's avatar
Karl Heuer committed
1216
  (save-excursion
1217 1218 1219 1220
    (let ((coding-system-for-write 'no-conversion))
      (write-region archive-proper-file-start (point-max)
		    (or file buffer-file-name) nil t)
      (set-buffer-modified-p nil))
Karl Heuer's avatar
Karl Heuer committed
1221 1222
    t))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
1223
;;; Section: Marking and unmarking.
Karl Heuer's avatar
Karl Heuer committed
1224 1225 1226 1227 1228 1229 1230 1231 1232

(defun archive-flag-deleted (p &optional type)
  "In archive mode, mark this member to be deleted from the archive.
With a prefix argument, mark that many files."
  (interactive "p")
  (or type (setq type ?D))
  (beginning-of-line)
  (let ((sign (if (>= p 0) +1 -1))
	(modified (buffer-modified-p))
1233
        (inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
1234 1235 1236 1237 1238 1239 1240
    (while (not (zerop p))
      (if (archive-get-descr t)
          (progn
            (delete-char 1)
            (insert type)))
      (forward-line sign)
      (setq p (- p sign)))
1241
    (restore-buffer-modified-p modified))
Karl Heuer's avatar
Karl Heuer committed
1242 1243 1244 1245 1246 1247
  (archive-next-line 0))

(defun archive-unflag (p)
  "In archive mode, un-mark this member if it is marked to be deleted.
With a prefix argument, un-mark that many files forward."
  (interactive "p")
1248
  (archive-flag-deleted p ?\s))
Karl Heuer's avatar
Karl Heuer committed
1249 1250 1251 1252 1253

(defun archive-unflag-backwards (p)
  "In archive mode, un-mark this member if it is marked to be deleted.
With a prefix argument, un-mark that many members backward."
  (interactive "p")
1254
  (archive-flag-deleted (- p) ?\s))
Karl Heuer's avatar
Karl Heuer committed
1255 1256 1257 1258 1259

(defun archive-unmark-all-files ()
  "Remove all marks."
  (interactive)
  (let ((modified (buffer-modified-p))
1260
	(inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
1261 1262 1263
    (save-excursion
      (goto-char archive-file-list-start)
      (while (< (point) archive-file-list-end)
1264 1265
        (or (= (following-char) ?\s)
            (progn (delete-char 1) (insert ?\s)))
Karl Heuer's avatar
Karl Heuer committed
1266
        (forward-line 1)))
1267
    (restore-buffer-modified-p modified)))
Karl Heuer's avatar
Karl Heuer committed
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287

(defun archive-mark (p)
  "In archive mode, mark this member for group operations.
With a prefix argument, mark that many members.
Use \\[archive-unmark-all-files] to remove all marks."
  (interactive "p")
  (archive-flag-deleted p ?*))

(defun archive-get-marked (mark &optional default)
  (let (files)
    (save-excursion
      (goto-char archive-file-list-start)
      (while (< (point) archive-file-list-end)
        (if (= (following-char) mark)
	    (setq files (cons (archive-get-descr) files)))
        (forward-line 1)))
    (or (nreverse files)
	(and default
	     (list (archive-get-descr))))))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
1288
;;; Section: Operate
Karl Heuer's avatar
Karl Heuer committed
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300

(defun archive-next-line (p)
  (interactive "p")
  (forward-line p)
  (or (eobp)
      (forward-char archive-file-name-indent)))

(defun archive-previous-line (p)
  (interactive "p")
  (archive-next-line (- p)))

(defun archive-chmod-entry (new-mode)
1301
  "Change the protection bits associated with all marked or this member.
Karl Heuer's avatar
Karl Heuer committed
1302
The new protection bits can either be specified as an octal number or
1303
as a relative change like \"g+rw\" as for chmod(2)."
Karl Heuer's avatar
Karl Heuer committed
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
  (interactive "sNew mode (octal or relative): ")
  (if archive-read-only (error "Archive is read-only"))
  (let ((func (archive-name "chmod-entry")))
    (if (fboundp func)
	(progn
	  (funcall func new-mode (archive-get-marked ?* t))
	  (archive-resummarize))
      (error "Setting mode bits is not supported for this archive type"))))

(defun archive-chown-entry (new-uid)
  "Change the owner of all marked or this member."
  (interactive "nNew uid: ")
  (if archive-read-only (error "Archive is read-only"))
  (let ((func (archive-name "chown-entry")))
    (if (fboundp func)
	(progn
	  (funcall func new-uid (archive-get-marked ?* t))
	  (archive-resummarize))
      (error "Setting owner is not supported for this archive type"))))

(defun archive-chgrp-entry (new-gid)
  "Change the group of all marked or this member."
  (interactive "nNew gid: ")
  (if archive-read-only (error "Archive is read-only"))
  (let ((func (archive-name "chgrp-entry")))
    (if (fboundp func)
	(progn
	  (funcall func new-gid (archive-get-marked ?* t))
	  (archive-resummarize))
      (error "Setting group is not supported for this archive type"))))

(defun archive-expunge ()
  "Do the flagged deletions."
  (interactive)
  (let (files)
    (save-excursion
      (goto-char archive-file-list-start)
      (while (< (point) archive-file-list-end)
        (if (= (following-char) ?D)
	    (setq files (cons (aref (archive-get-descr) 0) files)))
        (forward-line 1)))
    (setq files (nreverse files))
    (and files
	 (or (not archive-read-only)
	     (error "Archive is read-only"))
	 (or (yes-or-no-p (format "Really delete %d member%s? "
				  (length files)
				  (if (null (cdr files)) "" "s")))
	     (error "Operation aborted"))
	 (let ((archive (archive-maybe-copy (buffer-file-name)))
	       (expunger (archive-name "expunge")))
	   (if (fboundp expunger)
	       (funcall expunger archive files)
	     (archive-*-expunge archive files (symbol-value expunger)))
	   (archive-maybe-update nil)
	   (if archive-remote
	       (archive-resummarize)
	     (revert-buffer))))))

(defun archive-*-expunge (archive files command)
  (apply 'call-process
	 (car command)
	 nil
	 nil
	 nil
	 (append (cdr command) (cons archive files))))

(defun archive-rename-entry (newname)
1372
  "Change the name associated with this entry in the archive file."
Karl Heuer's avatar
Karl Heuer committed
1373 1374 1375 1376 1377 1378 1379 1380
  (interactive "sNew name: ")
  (if archive-read-only (error "Archive is read-only"))
  (if (string= newname "")
      (error "Archive members may not be given empty names"))
  (let ((func (archive-name "rename-entry"))
	(descr (archive-get-descr)))
    (if (fboundp func)
        (progn
1381
	  (funcall func
1382 1383
		   (encode-coding-string newname
					 archive-file-name-coding-system)
1384
		   descr)
Karl Heuer's avatar
Karl Heuer committed
1385 1386 1387 1388
	  (archive-resummarize))
      (error "Renaming is not supported for this archive type"))))

;; Revert the buffer and recompute the dired-like listing.
1389
(defun archive-mode-revert (&optional no-auto-save no-confirm)
Karl Heuer's avatar
Karl Heuer committed
1390 1391
  (let ((no (archive-get-lineno)))
    (setq archive-files nil)
1392 1393
    (let ((revert-buffer-function nil)
	  (coding-system-for-read 'no-conversion))
Karl Heuer's avatar
Karl Heuer committed
1394 1395 1396 1397 1398 1399 1400 1401 1402
      (revert-buffer t t))
    (archive-mode)
    (goto-char archive-file-list-start)
    (archive-next-line no)))

(defun archive-undo ()
  "Undo in an archive buffer.
This doesn't recover lost files, it just undoes changes in the buffer itself."
  (interactive)
1403
  (let ((inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
1404 1405
    (undo)))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
1406
;;; Section: Arc Archives
Karl Heuer's avatar
Karl Heuer committed
1407 1408 1409 1410 1411 1412 1413 1414

(defun archive-arc-summarize ()
  (let ((p 1)
	(totalsize 0)
	(maxlen 8)
        files
	visual)
    (while (and (< (+ p 29) (point-max))
1415 1416
		(= (byte-after p) ?\C-z)
		(> (byte-after (1+ p)) 0))
Karl Heuer's avatar
Karl Heuer committed
1417 1418
      (let* ((namefld (buffer-substring (+ p 2)