arc-mode.el 86.6 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-2012  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
Paul Eggert's avatar
Paul Eggert committed
7
;; Favorite-brand-of-beer: None, I hate beer.
Karl Heuer's avatar
Karl Heuer committed
8

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
;;			Arc	Lzh	Zip	Zoo	Rar	7z
;;			--------------------------------------------
;; View listing		Intern	Intern	Intern	Intern	Y	Y
;; Extract member	Y	Y	Y	Y	Y	Y
58
;; Save changed member	Y	Y	Y	Y	N	Y
59
;; Add new member	N	N	N	N	N	N
60
;; Delete member	Y	Y	Y	Y	N	Y
61 62 63 64
;; 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.
Paul Eggert's avatar
Paul Eggert committed
78
;;             Headers come in three flavors called level 0, 1 and 2 headers.
79 80 81 82 83
;;             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
;;
;; archive-mode-hook
;; archive-foo-mode-hook
99
;; archive-extract-hook
Karl Heuer's avatar
Karl Heuer committed
100 101 102 103

;;; 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
A local copy of the archive will be used when updating."
  :type 'regexp
  :group 'archive)

Stefan Monnier's avatar
Stefan Monnier committed
143 144 145 146
(define-obsolete-variable-alias 'archive-extract-hooks
  'archive-extract-hook "24.3")
(defcustom archive-extract-hook nil
  "Hook run when an archive member has been extracted."
Richard M. Stallman's avatar
Richard M. Stallman committed
147 148
  :type 'hook
  :group 'archive)
Karl Heuer's avatar
Karl Heuer committed
149 150 151 152 153
;; ------------------------------
;; 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
154
(defcustom archive-arc-extract
Karl Heuer's avatar
Karl Heuer committed
155
  '("arc" "x")
Lute Kamstra's avatar
Lute Kamstra committed
156
  "Program and its options to run in order to extract an arc file member.
157
Extraction should happen to the current directory.  Archive and member
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159 160 161 162 163 164 165
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
166
  '("arc" "d")
Lute Kamstra's avatar
Lute Kamstra committed
167
  "Program and its options to run in order to delete arc file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
168 169 170 171 172 173 174 175
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
176
  '("arc" "u")
Lute Kamstra's avatar
Lute Kamstra committed
177
  "Program and its options to run in order to update an arc file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179 180 181 182 183
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
184 185 186
;; ------------------------------
;; Lzh archive configuration

Richard M. Stallman's avatar
Richard M. Stallman committed
187
(defcustom archive-lzh-extract
Karl Heuer's avatar
Karl Heuer committed
188
  '("lha" "pq")
Lute Kamstra's avatar
Lute Kamstra committed
189
  "Program and its options to run in order to extract an lzh file member.
190
Extraction should happen to standard output.  Archive and member name will
Richard M. Stallman's avatar
Richard M. Stallman committed
191 192 193 194 195 196 197 198
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
199
  '("lha" "d")
Lute Kamstra's avatar
Lute Kamstra committed
200
  "Program and its options to run in order to delete lzh file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202 203 204 205 206 207 208
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
209
  '("lha" "a")
Lute Kamstra's avatar
Lute Kamstra committed
210
  "Program and its options to run in order to update an lzh file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
211 212 213 214 215 216
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
217 218 219
;; ------------------------------
;; Zip archive configuration

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

Glenn Morris's avatar
Glenn Morris committed
234
;; For several reasons the latter behavior is not desirable in general.
Karl Heuer's avatar
Karl Heuer committed
235 236 237 238
;; (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
239
(defcustom archive-zip-expunge
240 241 242 243
  (cond ((executable-find "zip")     '("zip" "-d" "-q"))
	((executable-find "7z")      '("7z" "d"))
	((executable-find "pkzip")   '("pkzip" "-d"))
	(t                           '("zip" "-d" "-q")))
Lute Kamstra's avatar
Lute Kamstra committed
244
  "Program and its options to run in order to delete zip file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
245 246
Archive and member names will be added."
  :type '(list (string :tag "Program")
247 248 249
	       (repeat :tag "Options"
		       :inline t
		       (string :format "%v")))
Richard M. Stallman's avatar
Richard M. Stallman committed
250 251 252
  :group 'archive-zip)

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

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

(defcustom archive-zip-case-fiddle t
Lute Kamstra's avatar
Lute Kamstra committed
281
  "If non-nil then zip file members may be down-cased.
282 283
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
284 285
  :type 'boolean
  :group 'archive-zip)
Karl Heuer's avatar
Karl Heuer committed
286 287 288
;; ------------------------------
;; Zoo archive configuration

Richard M. Stallman's avatar
Richard M. Stallman committed
289
(defcustom archive-zoo-extract
Karl Heuer's avatar
Karl Heuer committed
290
  '("zoo" "xpq")
Lute Kamstra's avatar
Lute Kamstra committed
291
  "Program and its options to run in order to extract a zoo file member.
292
Extraction should happen to standard output.  Archive and member name will
Richard M. Stallman's avatar
Richard M. Stallman committed
293 294 295 296 297 298 299 300
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
301
  '("zoo" "DqPP")
Lute Kamstra's avatar
Lute Kamstra committed
302
  "Program and its options to run in order to delete zoo file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
303 304 305 306 307 308 309 310
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
311
  '("zoo" "a")
Lute Kamstra's avatar
Lute Kamstra committed
312
  "Program and its options to run in order to update a zoo file member.
Richard M. Stallman's avatar
Richard M. Stallman committed
313 314 315 316 317 318
Archive and member name will be added."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zoo)
319 320 321 322 323 324 325 326
;; ------------------------------
;; 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."
327
  :version "24.1"
328
  :type '(list (string :tag "Program")
329 330 331 332 333 334 335 336 337
	       (repeat :tag "Options"
		       :inline t
		       (string :format "%v")))
  :group 'archive-7z)

(defcustom archive-7z-expunge
  '("7z" "d")
  "Program and its options to run in order to delete 7z file members.
Archive and member names will be added."
338
  :version "24.1"
339 340 341 342 343 344 345 346 347 348 349
  :type '(list (string :tag "Program")
	       (repeat :tag "Options"
		       :inline t
		       (string :format "%v")))
  :group 'archive-7z)

(defcustom archive-7z-update
  '("7z" "u")
  "Program and its options to run in order to update a 7z file member.
Options should ensure that specified directory will be put into the 7z
file.  Archive and member name will be added."
350
  :version "24.1"
351 352 353 354
  :type '(list (string :tag "Program")
	       (repeat :tag "Options"
		       :inline t
		       (string :format "%v")))
355 356
  :group 'archive-7z)

Karl Heuer's avatar
Karl Heuer committed
357
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
358
;;; Section: Variables
Karl Heuer's avatar
Karl Heuer committed
359

360 361 362 363 364 365
(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.")
366 367
(defvar archive-mode-map
  (let ((map (make-keymap)))
368
    (set-keymap-parent map special-mode-map)
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
    (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)
395 396
    ;; Let mouse-1 follow the link.
    (define-key map [follow-link] 'mouse-face)
397 398 399 400 401 402 403 404 405

    (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
406
      (if (featurep 'xemacs) 'button2 [mouse-2]) 'archive-extract)
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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469

    (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.")
470 471 472
(defvar archive-file-name-indent nil "Column where file names start.")

(defvar archive-remote nil "Non-nil if the archive is outside file system.")
473 474 475 476 477 478
(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
479
(defvar archive-alternate-display nil
480
  "Non-nil when alternate information is shown.")
Karl Heuer's avatar
Karl Heuer committed
481 482 483
(make-variable-buffer-local 'archive-alternate-display)
(put 'archive-alternate-display 'permanent-local t)

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

487
(defvar archive-subfile-mode nil "Non-nil in archive member buffers.")
Karl Heuer's avatar
Karl Heuer committed
488 489 490
(make-variable-buffer-local 'archive-subfile-mode)
(put 'archive-subfile-mode 'permanent-local t)

491 492 493 494
(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
495 496 497 498
(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
499
(make-variable-buffer-local 'archive-files)
Karl Heuer's avatar
Karl Heuer committed
500

Karl Heuer's avatar
Karl Heuer committed
501
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
502
;;; Section: Support functions.
Karl Heuer's avatar
Karl Heuer committed
503

504 505 506 507 508 509 510 511 512 513 514 515
(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
516 517 518
(defsubst archive-name (suffix)
  (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))

519
(defun archive-l-e (str &optional len float)
520 521
  "Convert little endian string/vector STR to integer.
Alternatively, STR may be a buffer position in the current buffer
522 523 524
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
525 526 527
  (if (stringp str)
      (setq len (length str))
    (setq str (buffer-substring str (+ str len))))
Kenichi Handa's avatar
Kenichi Handa committed
528
  (setq str (string-as-unibyte str))
Karl Heuer's avatar
Karl Heuer committed
529 530 531 532
  (let ((result 0)
        (i 0))
    (while (< i len)
      (setq i (1+ i)
533 534
            result (+ (if float (* result 256.0) (ash result 8))
		      (aref str (- len i)))))
Karl Heuer's avatar
Karl Heuer committed
535 536 537
    result))

(defun archive-int-to-mode (mode)
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
  "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
557 558

(defun archive-calc-mode (oldmode newmode &optional error)
559
  "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
Karl Heuer's avatar
Karl Heuer committed
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 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
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))
621
        (minute (logand (ash time -5) 63))
Karl Heuer's avatar
Karl Heuer committed
622 623 624
        (second (* 2 (logand time 31)))) ; 2 seconds resolution
    (format "%02d:%02d:%02d" hour minute second)))

625
(defun archive-unixdate (low high)
626
  "Stringify Unix (LOW HIGH) date."
Paul Eggert's avatar
Paul Eggert committed
627 628
  (let* ((time (cons high low))
	 (str (current-time-string time)))
629 630 631
    (format "%s-%s-%s"
	    (substring str 8 10)
	    (substring str 4 7)
Paul Eggert's avatar
Paul Eggert committed
632
	    (format-time-string "%Y" time))))
Karl Heuer's avatar
Karl Heuer committed
633

634
(defun archive-unixtime (low high)
635
  "Stringify Unix (LOW HIGH) time."
636 637
  (let ((str (current-time-string (cons high low))))
    (substring str 11 19)))
Karl Heuer's avatar
Karl Heuer committed
638 639 640 641

(defun archive-get-lineno ()
  (if (>= (point) archive-file-list-start)
      (count-lines archive-file-list-start
642
		   (line-beginning-position))
Karl Heuer's avatar
Karl Heuer committed
643 644 645
    0))

(defun archive-get-descr (&optional noerror)
646
  "Return the descriptor vector for file at point.
647
Does not signal an error if optional argument NOERROR is non-nil."
Karl Heuer's avatar
Karl Heuer committed
648 649 650 651 652 653 654 655 656 657 658
  (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
659
;;; Section: the mode definition
Karl Heuer's avatar
Karl Heuer committed
660

661
;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
662
(defun archive-mode (&optional force)
663 664
  "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
665 666 667 668 669 670 671 672 673 674 675 676 677
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
678
      (funcall (or (default-value 'major-mode) 'fundamental-mode))
Karl Heuer's avatar
Karl Heuer committed
679 680
    (if (and (not force) archive-files) nil
      (let* ((type (archive-find-type))
681
	     (typename (capitalize (symbol-name type))))
Karl Heuer's avatar
Karl Heuer committed
682 683 684 685 686 687 688 689 690
	(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)

691 692
	;; Remote archives are not written by a hook.
	(if archive-remote nil
693
	  (add-hook 'write-contents-functions 'archive-write-file nil t))
694

Karl Heuer's avatar
Karl Heuer committed
695 696
	(make-local-variable 'require-final-newline)
	(setq require-final-newline nil)
697 698
	(make-local-variable 'local-enable-local-variables)
	(setq local-enable-local-variables nil)
Karl Heuer's avatar
Karl Heuer committed
699

700 701 702 703
	;; 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
704
	(make-local-variable 'archive-read-only)
705 706 707 708 709
	;; 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
710
		       (string-match file-name-invalid-regexp
711
				     (aref archive-subfile-mode 0)))))
Karl Heuer's avatar
Karl Heuer committed
712 713 714

	;; Should we use a local copy when accessing from outside Emacs?
	(make-local-variable 'archive-local-name)
715 716 717 718 719 720

	;; 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))
721
		      (string-match file-name-invalid-regexp
722
				    (buffer-file-name)))))
Karl Heuer's avatar
Karl Heuer committed
723 724 725 726

	(setq major-mode 'archive-mode)
	(setq mode-name (concat typename "-Archive"))
	;; Run archive-foo-mode-hook and archive-mode-hook
727
	(run-mode-hooks (archive-name "mode-hook") 'archive-mode-hook)
Karl Heuer's avatar
Karl Heuer committed
728 729 730 731 732 733
	(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)
734 735 736 737
      (setq archive-file-name-coding-system
	    (or file-name-coding-system
		default-file-name-coding-system
		locale-coding-system))
738
      (if (default-value 'enable-multibyte-characters)
Kenichi Handa's avatar
Kenichi Handa committed
739
	  (set-buffer-multibyte 'to))
740
      (archive-summarize nil)
Karl Heuer's avatar
Karl Heuer committed
741 742 743 744 745
      (setq buffer-read-only t))))

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

746
(let ((item1 '(archive-subfile-mode " Archive")))
Karl Heuer's avatar
Karl Heuer committed
747
  (or (member item1 minor-mode-alist)
748
      (setq minor-mode-alist (cons item1 minor-mode-alist))))
Karl Heuer's avatar
Karl Heuer committed
749 750 751 752 753 754 755
;; -------------------------------------------------------------------------
(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)
756
    (cond ((looking-at "\\(PK00\\)?[P]K\003\004") 'zip)
757
	  ((looking-at "..-l[hz][0-9ds]-") 'lzh)
Karl Heuer's avatar
Karl Heuer committed
758 759 760 761 762
	  ((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)
Glenn Morris's avatar
Glenn Morris committed
763
          ;; This pattern modeled on the BSD/GNU+Linux `file' command.
764 765 766
          ;; 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
767
          ((looking-at "Rar!") 'rar)
768
          ((looking-at "!<arch>\n") 'ar)
769 770 771
          ((and (looking-at "MZ")
                (re-search-forward "Rar!" (+ (point) 100000) t))
           'rar-exe)
772
	  ((looking-at "7z\274\257\047\034") '7z)
773
	  (t (error "Buffer format not recognized")))))
Karl Heuer's avatar
Karl Heuer committed
774
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
775 776 777 778 779 780 781 782 783

(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)))


784
(defun archive-summarize (&optional shut-up)
Karl Heuer's avatar
Karl Heuer committed
785 786 787
  "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
788 789 790
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
791
  (widen)
792 793
  (let ((buffer-file-truename nil) ; avoid changing dir mtime by lock_file
	(inhibit-read-only t))
Stefan Monnier's avatar
Stefan Monnier committed
794 795
    (setq archive-proper-file-start (copy-marker (point-min) t))
    (set (make-local-variable 'change-major-mode-hook) 'archive-desummarize)
796 797
    (or shut-up
	(message "Parsing archive file..."))
Karl Heuer's avatar
Karl Heuer committed
798 799
    (buffer-disable-undo (current-buffer))
    (setq archive-files (funcall (archive-name "summarize")))
800 801
    (or shut-up
	(message "Parsing archive file...done."))
Karl Heuer's avatar
Karl Heuer committed
802 803 804 805 806 807 808 809 810
    (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
811 812
  (let ((no (archive-get-lineno)))
    (archive-desummarize)
813
    (archive-summarize t)
Karl Heuer's avatar
Karl Heuer committed
814 815 816 817
    (goto-char archive-file-list-start)
    (archive-next-line no)))

(defun archive-summarize-files (files)
Richard M. Stallman's avatar
Richard M. Stallman committed
818
  "Insert a description of a list of files annotated with proper mouse face."
Karl Heuer's avatar
Karl Heuer committed
819 820 821 822 823 824 825 826
  (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
827 828 829 830 831 832 833 834 835 836 837 838
     (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
839 840 841 842
     files)))
  (setq archive-file-list-end (point-marker)))

(defun archive-alternate-display ()
843
  "Toggle alternative display.
844
To avoid very long lines archive mode does not show all information.
845
This function changes the set of information shown for each files."
Karl Heuer's avatar
Karl Heuer committed
846 847 848 849
  (interactive)
  (setq archive-alternate-display (not archive-alternate-display))
  (archive-resummarize))
;; -------------------------------------------------------------------------
Stefan Monnier's avatar
Stefan Monnier committed
850
;;; Section: Local archive copy handling
Karl Heuer's avatar
Karl Heuer committed
851

852 853 854 855 856 857
(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
858
using `make-temp-file', and the generated name is returned."
859
  (let ((fullname (expand-file-name fname dir))
860 861
	(alien (string-match file-name-invalid-regexp fname))
	(tmpfile
862
	 (expand-file-name
863 864
	  (if (if (fboundp 'msdos-long-file-names)
		  (not (msdos-long-file-names)))
865 866
	      "am"
	    "arc-mode.")
867 868 869
	  dir)))
    (if (or alien (file-exists-p fullname))
	(progn
Paul Eggert's avatar
Paul Eggert committed
870
	  ;; Make sure all the leading directories in
871 872 873 874 875
	  ;; 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))
Paul Eggert's avatar
Paul Eggert committed
876
      ;; Make sure all the leading directories in `fullname' exist
877 878 879 880
      ;; 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)
881 882
      fullname)))

Karl Heuer's avatar
Karl Heuer committed
883
(defun archive-maybe-copy (archive)
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
  (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
903 904 905 906 907

(defun archive-maybe-update (unchanged)
  (if archive-remote
      (let ((name archive-local-name)
	    (modified (buffer-modified-p))
908 909
	    (coding-system-for-read 'no-conversion)
	    (lno (archive-get-lineno))
910
	    (inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
911
	(if unchanged nil
912
	  (setq archive-files nil)
Karl Heuer's avatar
Karl Heuer committed
913 914
	  (erase-buffer)
	  (insert-file-contents name)
915 916 917
	  (archive-mode t)
	  (goto-char archive-file-list-start)
	  (archive-next-line lno))
Karl Heuer's avatar
Karl Heuer committed
918 919
	(archive-delete-local name)
	(if (not unchanged)
920 921 922
	    (message
	     "Buffer `%s' must be saved for changes to take effect"
	     (buffer-name (current-buffer))))
Karl Heuer's avatar
Karl Heuer committed
923 924 925
	(set-buffer-modified-p (or modified (not unchanged))))))

(defun archive-delete-local (name)
926
  "Delete file NAME and its parents up to and including `archive-tmpdir'."
Karl Heuer's avatar
Karl Heuer committed
927 928 929 930 931 932 933 934 935 936 937 938
  (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
939
;;; Section: Member extraction
Karl Heuer's avatar
Karl Heuer committed
940

941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
(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)))))

961 962 963 964 965 966 967 968 969
(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))
970 971
    (let ((buffer-undo-list t)
	  (coding
972 973
	   (or coding-system-for-read
	       (and set-auto-coding-function
974 975 976
		    (save-excursion
		      (funcall set-auto-coding-function
			       filename (- (point-max) (point-min)))))
977 978 979 980 981 982 983 984
	       ;; 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).
985 986
	       (let ((file-name-handler-alist
		      '(("" . archive-file-name-handler))))
987 988 989
		 (car (find-operation-coding-system
		       'insert-file-contents
		       (cons filename (current-buffer)) t))))))
990 991 992 993 994 995
      (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)
996 997 998
	(setq last-coding-system-used coding))
      (set-buffer-modified-p nil)
      (kill-local-variable 'buffer-file-coding-system)
999
      (after-insert-file-set-coding (- (point-max) (point-min))))))
1000

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

1003
(defun archive-extract (&optional other-window-p event)
Karl Heuer's avatar
Karl Heuer committed
1004
  "In archive mode, extract this entry of the archive into its own buffer."
1005
  (interactive (list nil last-input-event))
1006
  (if event (posn-set-point (event-end event)))
Karl Heuer's avatar
Karl Heuer committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  (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"))
1017 1018 1019 1020
	 ;; 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
1021
			  (string-match file-name-invalid-regexp ename)))
1022
	 (arcfilename (expand-file-name (concat arcname ":" iname)))
Karl Heuer's avatar
Karl Heuer committed
1023
         (buffer (get-buffer bufname))
1024 1025
         (just-created nil)
	 (file-name-coding archive-file-name-coding-system))
1026 1027
      (if (and buffer
	       (string= (buffer-file-name buffer) arcfilename))
Karl Heuer's avatar
Karl Heuer committed
1028 1029
          nil
	(setq archive (archive-maybe-copy archive))
1030
	(setq bufname (generate-new-buffer-name bufname))
Karl Heuer's avatar
Karl Heuer committed
1031 1032
        (setq buffer (get-buffer-create bufname))
        (setq just-created t)
1033
        (with-current-buffer buffer
1034
          (setq buffer-file-name arcfilename)
Karl Heuer's avatar
Karl Heuer committed
1035 1036 1037 1038 1039 1040
          (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)
1041
          (add-hook 'write-file-functions 'archive-write-file-member nil t)
Karl Heuer's avatar
Karl Heuer committed
1042
          (setq archive-subfile-mode descr)
1043
	  (setq archive-file-name-coding-system file-name-coding)
1044 1045
	  (if (and
	       (null
Paul Eggert's avatar
Paul Eggert committed
1046
		(let (;; We may have to encode the file name argument for
1047
		      ;; external programs.
1048 1049
		      (coding-system-for-write
		       (and enable-multibyte-characters
1050
			    archive-file-name-coding-system))
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
		      ;; 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))))
1063 1064 1065 1066
	       just-created)
	      (progn
		(set-buffer-modified-p nil)
		(kill-buffer buffer))
1067
            (archive-try-jka-compr)     ;Pretty ugly hack :-(
1068
	    (archive-set-buffer-as-visiting-file ename)
1069 1070 1071 1072 1073 1074 1075 1076
	    (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.