arc-mode.el 64.8 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, 2003, 2005 Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
4

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

Erik Naggum's avatar
Erik Naggum committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Karl Heuer's avatar
Karl Heuer committed
25 26

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

Karl Heuer's avatar
Karl Heuer committed
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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
;; 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.
;;
;;                        Arc     Lzh     Zip     Zoo
;;                        --------------------------------
;; View listing           Intern  Intern  Intern  Intern
;; Extract member         Y       Y       Y       Y
;; Save changed member    Y       Y       Y       Y
;; Add new member         N       N       N       N
;; Delete member          Y       Y       Y       Y
;; Rename member          Y       Y       N       N
;; Chmod                  -       Y       Y       -
;; Chown                  -       Y       -       -
;; Chgrp                  -       Y       -       -
;;
;; 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.
80 81 82 83 84 85
;;             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
86 87 88 89 90 91 92 93 94 95 96
;;
;; 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
97
;; HOOKS: `foo' means one of the supported archive types.
Karl Heuer's avatar
Karl Heuer committed
98 99 100 101 102 103 104 105 106 107
;;
;; archive-mode-hook
;; archive-foo-mode-hook
;; archive-extract-hooks

;;; Code:

;; -------------------------------------------------------------------------
;; Section: Configuration.

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

Richard M. Stallman's avatar
Richard M. Stallman committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
(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
129 130
  ;; make-temp-name is safe here because we use this name
  ;; to create a directory.
131 132
  (make-temp-name
   (expand-file-name (if (eq system-type 'ms-dos) "ar" "archive.tmp")
133
		     temporary-file-directory))
134
  "Directory for temporary files made by arc-mode.el."
Richard M. Stallman's avatar
Richard M. Stallman committed
135 136
  :type 'directory
  :group 'archive)
Karl Heuer's avatar
Karl Heuer committed
137

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

(defcustom archive-extract-hooks nil
  "*Hooks to run when an archive member has been extracted."
  :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")
156 157
  "*Program and its options to run in order to extract an arc file member.
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 167
  '("arc" "d")
  "*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 177
  '("arc" "u")
  "*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")
189 190
  "*Program and its options to run in order to extract an lzh file member.
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 200
  '("lha" "d")
  "*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 210
  '("lha" "a")
  "*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 223 224
  (if (and (not (executable-find "unzip"))
           (executable-find "pkunzip"))
      '("pkunzip" "-e" "-o-")
    '("unzip" "-qq" "-c"))
225 226 227
  "*Program and its options to run in order to extract a zip file member.
Extraction should happen to standard output.  Archive and member name will
be added.  If `archive-zip-use-pkzip' is non-nil then this program is
Richard M. Stallman's avatar
Richard M. Stallman committed
228 229 230 231 232 233
expected to extract to a file junking the directory part of the name."
  :type '(list (string :tag "Program")
		(repeat :tag "Options"
			:inline t
			(string :format "%v")))
  :group 'archive-zip)
Karl Heuer's avatar
Karl Heuer committed
234

235
;; For several reasons the latter behaviour is not desirable in general.
Karl Heuer's avatar
Karl Heuer committed
236 237 238 239
;; (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
240
(defcustom archive-zip-expunge
241 242 243 244
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-d")
    '("zip" "-d" "-q"))
Karl Heuer's avatar
Karl Heuer committed
245
  "*Program and its options to run in order to delete zip file members.
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249 250 251 252 253
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
254 255 256 257
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-u" "-P")
    '("zip" "-q"))
Karl Heuer's avatar
Karl Heuer committed
258 259
  "*Program and its options to run in order to update a zip file member.
Options should ensure that specified directory will be put into the zip
Richard M. Stallman's avatar
Richard M. Stallman committed
260 261 262 263 264 265 266 267
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
268 269 270 271
  (if (and (not (executable-find "zip"))
           (executable-find "pkzip"))
      '("pkzip" "-u" "-P")
    '("zip" "-q" "-k"))
272 273
  "*Program and its options to run in order to update a case fiddled zip member.
Options should ensure that specified directory will be put into the zip file.
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275 276 277 278 279 280 281
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
282 283 284
  "*If non-nil then zip file members may be down-cased.
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
285 286
  :type 'boolean
  :group 'archive-zip)
Karl Heuer's avatar
Karl Heuer committed
287 288 289
;; ------------------------------
;; Zoo archive configuration

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

323 324 325 326 327 328
(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.")
329 330 331 332 333 334 335 336 337 338 339 340 341 342 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 369
(defvar archive-mode-map
  (let ((map (make-keymap)))
    (suppress-keymap map)
    (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 "g" 'revert-buffer)
    (define-key map "h" 'describe-mode)
    (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 "q" 'quit-window)
    (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)

    (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
370
      (if (featurep 'xemacs) 'button2 [mouse-2]) 'archive-extract)
371 372 373 374 375 376 377 378 379 380 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

    (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.")
434 435 436
(defvar archive-file-name-indent nil "Column where file names start.")

(defvar archive-remote nil "Non-nil if the archive is outside file system.")
437 438 439 440 441 442
(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
443
(defvar archive-alternate-display nil
444
  "Non-nil when alternate information is shown.")
Karl Heuer's avatar
Karl Heuer committed
445 446 447
(make-variable-buffer-local 'archive-alternate-display)
(put 'archive-alternate-display 'permanent-local t)

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

451
(defvar archive-subfile-mode nil "Non-nil in archive member buffers.")
Karl Heuer's avatar
Karl Heuer committed
452 453 454
(make-variable-buffer-local 'archive-subfile-mode)
(put 'archive-subfile-mode 'permanent-local t)

Richard M. Stallman's avatar
Richard M. Stallman committed
455 456 457 458
(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
459
(make-variable-buffer-local 'archive-files)
Karl Heuer's avatar
Karl Heuer committed
460

Karl Heuer's avatar
Karl Heuer committed
461 462 463 464 465 466 467
;; -------------------------------------------------------------------------
;; Section: Support functions.

(defsubst archive-name (suffix)
  (intern (concat "archive-" (symbol-name archive-subtype) "-" suffix)))

(defun archive-l-e (str &optional len)
468 469 470
  "Convert little endian string/vector to integer.
Alternatively, first argument may be a buffer position in the current buffer
in which case a second argument, length, should be supplied."
Karl Heuer's avatar
Karl Heuer committed
471 472 473 474 475 476 477 478 479 480 481
  (if (stringp str)
      (setq len (length str))
    (setq str (buffer-substring str (+ str len))))
  (let ((result 0)
        (i 0))
    (while (< i len)
      (setq i (1+ i)
            result (+ (ash result 8) (aref str (- len i)))))
    result))

(defun archive-int-to-mode (mode)
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
  "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
501 502

(defun archive-calc-mode (oldmode newmode &optional error)
503
  "From the integer OLDMODE and the string NEWMODE calculate a new file mode.
Karl Heuer's avatar
Karl Heuer committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 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
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))
565
        (minute (logand (ash time -5) 63))
Karl Heuer's avatar
Karl Heuer committed
566 567 568
        (second (* 2 (logand time 31)))) ; 2 seconds resolution
    (format "%02d:%02d:%02d" hour minute second)))

569 570 571 572 573 574 575
(defun archive-unixdate (low high)
  "Stringify unix (LOW HIGH) date."
  (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
576

577 578 579 580
(defun archive-unixtime (low high)
  "Stringify unix (LOW HIGH) time."
  (let ((str (current-time-string (cons high low))))
    (substring str 11 19)))
Karl Heuer's avatar
Karl Heuer committed
581 582 583 584 585 586 587 588

(defun archive-get-lineno ()
  (if (>= (point) archive-file-list-start)
      (count-lines archive-file-list-start
		   (save-excursion (beginning-of-line) (point)))
    0))

(defun archive-get-descr (&optional noerror)
589 590
  "Return the descriptor vector for file at point.
Does not signal an error if optional second argument NOERROR is non-nil."
Karl Heuer's avatar
Karl Heuer committed
591 592 593 594 595 596 597 598 599 600 601 602 603
  (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")))))
;; -------------------------------------------------------------------------
;; Section: the mode definition

604
;;;###autoload
Karl Heuer's avatar
Karl Heuer committed
605
(defun archive-mode (&optional force)
606 607
  "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
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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
      (funcall default-major-mode)
    (if (and (not force) archive-files) nil
      (let* ((type (archive-find-type))
624
	     (typename (capitalize (symbol-name type))))
Karl Heuer's avatar
Karl Heuer committed
625 626 627 628 629 630 631 632 633
	(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)

634 635
	;; Remote archives are not written by a hook.
	(if archive-remote nil
636
	  (add-hook 'write-contents-functions 'archive-write-file nil t))
637

Karl Heuer's avatar
Karl Heuer committed
638 639
	(make-local-variable 'require-final-newline)
	(setq require-final-newline nil)
640 641
	(make-local-variable 'local-enable-local-variables)
	(setq local-enable-local-variables nil)
Karl Heuer's avatar
Karl Heuer committed
642

643 644 645 646
	;; 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
647
	(make-local-variable 'archive-read-only)
648 649 650 651 652
	;; 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
653
		       (string-match file-name-invalid-regexp
654
				     (aref archive-subfile-mode 0)))))
Karl Heuer's avatar
Karl Heuer committed
655 656 657

	;; Should we use a local copy when accessing from outside Emacs?
	(make-local-variable 'archive-local-name)
658 659 660 661 662 663

	;; 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))
664
		      (string-match file-name-invalid-regexp
665
				    (buffer-file-name)))))
Karl Heuer's avatar
Karl Heuer committed
666 667 668 669

	(setq major-mode 'archive-mode)
	(setq mode-name (concat typename "-Archive"))
	;; Run archive-foo-mode-hook and archive-mode-hook
670
	(run-mode-hooks (archive-name "mode-hook") 'archive-mode-hook)
Karl Heuer's avatar
Karl Heuer committed
671 672 673 674 675 676
	(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)
677
      (archive-summarize nil)
Karl Heuer's avatar
Karl Heuer committed
678 679 680 681 682
      (setq buffer-read-only t))))

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

683
(let ((item1 '(archive-subfile-mode " Archive")))
Karl Heuer's avatar
Karl Heuer committed
684
  (or (member item1 minor-mode-alist)
685
      (setq minor-mode-alist (cons item1 minor-mode-alist))))
Karl Heuer's avatar
Karl Heuer committed
686 687 688 689 690 691 692 693
;; -------------------------------------------------------------------------
(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)
    (cond ((looking-at "[P]K\003\004") 'zip)
694
	  ((looking-at "..-l[hz][0-9ds]-") 'lzh)
Karl Heuer's avatar
Karl Heuer committed
695 696 697 698 699
	  ((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)
700
	  (t (error "Buffer format not recognized")))))
Karl Heuer's avatar
Karl Heuer committed
701
;; -------------------------------------------------------------------------
702
(defun archive-summarize (&optional shut-up)
Karl Heuer's avatar
Karl Heuer committed
703 704 705
  "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
706 707 708
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
709
  (widen)
710
  (set-buffer-multibyte nil)
711
  (let ((inhibit-read-only t))
712 713
    (or shut-up
	(message "Parsing archive file..."))
Karl Heuer's avatar
Karl Heuer committed
714 715
    (buffer-disable-undo (current-buffer))
    (setq archive-files (funcall (archive-name "summarize")))
716 717
    (or shut-up
	(message "Parsing archive file...done."))
Karl Heuer's avatar
Karl Heuer committed
718 719 720 721 722 723 724 725 726 727 728
    (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."
  (let ((modified (buffer-modified-p))
	(no (archive-get-lineno))
729
	(inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
730 731
    (widen)
    (delete-region (point-min) archive-proper-file-start)
732
    (archive-summarize t)
733
    (restore-buffer-modified-p modified)
Karl Heuer's avatar
Karl Heuer committed
734 735 736 737
    (goto-char archive-file-list-start)
    (archive-next-line no)))

(defun archive-summarize-files (files)
Richard M. Stallman's avatar
Richard M. Stallman committed
738
  "Insert a description of a list of files annotated with proper mouse face."
Karl Heuer's avatar
Karl Heuer committed
739 740 741 742 743 744 745 746
  (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
747 748 749 750 751 752 753 754 755 756 757 758
     (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
759 760 761 762
     files)))
  (setq archive-file-list-end (point-marker)))

(defun archive-alternate-display ()
763 764 765
  "Toggle alternative display.
To avoid very long lines some archive mode don't show all information.
This function changes the set of information shown for each files."
Karl Heuer's avatar
Karl Heuer committed
766 767 768 769 770 771
  (interactive)
  (setq archive-alternate-display (not archive-alternate-display))
  (archive-resummarize))
;; -------------------------------------------------------------------------
;; Section: Local archive copy handling

772 773 774 775 776 777
(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
778
using `make-temp-file', and the generated name is returned."
779
  (let ((fullname (expand-file-name fname dir))
780
	(alien (string-match file-name-invalid-regexp fname)))
781
    (if (or alien (file-exists-p fullname))
782
	(make-temp-file
783
	 (expand-file-name
784 785
	  (if (if (fboundp 'msdos-long-file-names)
		  (not (msdos-long-file-names)))
786 787 788 789 790
	      "am"
	    "arc-mode.")
	  dir))
      fullname)))

Karl Heuer's avatar
Karl Heuer committed
791
(defun archive-maybe-copy (archive)
792 793 794 795 796 797 798 799 800 801 802 803
  (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)))
	  (make-directory archive-tmpdir t)
804 805 806 807 808 809 810 811
	  ;; If ARCHIVE includes leading directories, make sure they
	  ;; exist under archive-tmpdir.
	  (let ((arch-dir (file-name-directory archive)))
	    (if arch-dir
		(make-directory (concat
				 (file-name-as-directory archive-tmpdir)
				 arch-dir)
				t)))
812 813 814 815 816 817 818 819
	  (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
820 821 822 823 824

(defun archive-maybe-update (unchanged)
  (if archive-remote
      (let ((name archive-local-name)
	    (modified (buffer-modified-p))
825 826
	    (coding-system-for-read 'no-conversion)
	    (lno (archive-get-lineno))
827
	    (inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
828
	(if unchanged nil
829
	  (setq archive-files nil)
Karl Heuer's avatar
Karl Heuer committed
830 831
	  (erase-buffer)
	  (insert-file-contents name)
832 833 834
	  (archive-mode t)
	  (goto-char archive-file-list-start)
	  (archive-next-line lno))
Karl Heuer's avatar
Karl Heuer committed
835 836
	(archive-delete-local name)
	(if (not unchanged)
837 838 839
	    (message
	     "Buffer `%s' must be saved for changes to take effect"
	     (buffer-name (current-buffer))))
Karl Heuer's avatar
Karl Heuer committed
840 841 842
	(set-buffer-modified-p (or modified (not unchanged))))))

(defun archive-delete-local (name)
843
  "Delete file NAME and its parents up to and including `archive-tmpdir'."
Karl Heuer's avatar
Karl Heuer committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857
  (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)))))
;; -------------------------------------------------------------------------
;; Section: Member extraction

858 859 860 861 862 863 864 865 866 867 868 869
(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))
    (let ((coding
	   (or coding-system-for-read
	       (and set-auto-coding-function
870 871 872
		    (save-excursion
		      (funcall set-auto-coding-function
			       filename (- (point-max) (point-min)))))
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
	       ;; dos-w32.el defines find-operation-coding-system for
	       ;; DOS/Windows systems which preserves the coding-system
	       ;; of existing files.  We want it to act here as if the
	       ;; extracted file existed.
	       (let ((file-name-handler-alist
		      '(("" . archive-file-name-handler))))
		 (car (find-operation-coding-system 'insert-file-contents
						    filename t))))))
      (if (and (not coding-system-for-read)
	       (not enable-multibyte-characters))
	  (setq coding
		(coding-system-change-text-conversion coding 'raw-text)))
      (if (and coding
	       (not (eq coding 'no-conversion)))
	  (decode-coding-region (point-min) (point-max) coding)
	(setq last-coding-system-used coding))
      (set-buffer-modified-p nil)
      (kill-local-variable 'buffer-file-coding-system)
891
      (after-insert-file-set-coding (- (point-max) (point-min))))))
892

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

895
(defun archive-extract (&optional other-window-p event)
Karl Heuer's avatar
Karl Heuer committed
896
  "In archive mode, extract this entry of the archive into its own buffer."
897 898
  (interactive (list nil last-input-event))
  (if event (mouse-set-point event))
Karl Heuer's avatar
Karl Heuer committed
899 900 901 902 903 904 905 906 907 908
  (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"))
909 910 911 912
	 ;; 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
913
			  (string-match file-name-invalid-regexp ename)))
Karl Heuer's avatar
Karl Heuer committed
914 915 916 917 918 919 920
         (buffer (get-buffer bufname))
         (just-created nil))
      (if buffer
          nil
	(setq archive (archive-maybe-copy archive))
        (setq buffer (get-buffer-create bufname))
        (setq just-created t)
921
        (with-current-buffer buffer
Karl Heuer's avatar
Karl Heuer committed
922 923 924 925 926 927 928 929
          (setq buffer-file-name
                (expand-file-name (concat arcname ":" iname)))
          (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)
930
          (add-hook 'write-file-functions 'archive-write-file-member nil t)
Karl Heuer's avatar
Karl Heuer committed
931
          (setq archive-subfile-mode descr)
932 933
	  (if (and
	       (null
934 935
		(let (;; We may have to encode file name arguement for
		      ;; external programs.
936 937 938
		      (coding-system-for-write
		       (and enable-multibyte-characters
			    file-name-coding-system))
939 940 941 942 943 944 945 946 947 948 949 950
		      ;; 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))))
951 952 953 954
	       just-created)
	      (progn
		(set-buffer-modified-p nil)
		(kill-buffer buffer))
955
	    (archive-set-buffer-as-visiting-file ename)
956 957 958 959 960 961 962 963
	    (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.
964 965 966 967 968 969 970
	    (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)
971 972 973
	    (if archive-read-only
		(message "Note: altering this archive is not implemented."))))
	(archive-maybe-update t))
974
      (or (not (buffer-name buffer))
975 976 977 978 979
          (cond
           (view-p (view-buffer buffer (and just-created 'kill-buffer)))
           ((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
980 981 982 983

(defun archive-*-extract (archive name command)
  (let* ((default-directory (file-name-as-directory archive-tmpdir))
	 (tmpfile (expand-file-name (file-name-nondirectory name)
984 985
				    default-directory))
	 exit-status success)
Karl Heuer's avatar
Karl Heuer committed
986
    (make-directory (directory-file-name default-directory) t)
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    (setq exit-status
	  (apply 'call-process
		 (car command)
		 nil
		 nil
		 nil
		 (append (cdr command) (list archive name))))
    (cond ((and (numberp exit-status) (= exit-status 0))
	   (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
1008 1009

(defun archive-extract-by-stdout (archive name command)
1010 1011 1012 1013 1014 1015
  (apply 'call-process
	 (car command)
	 nil
	 t
	 nil
	 (append (cdr command) (list archive name))))
Karl Heuer's avatar
Karl Heuer committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032

(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)
1033
  "Add current buffer to the archive in ARCBUF naming it NAME."
Karl Heuer's avatar
Karl Heuer committed
1034 1035 1036 1037 1038
  (interactive
   (list (get-buffer
	  (read-buffer "Buffer containing archive: "
		       ;; Find first archive buffer and suggest that
		       (let ((bufs (buffer-list)))
1039 1040 1041 1042
			 (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
1043 1044 1045 1046 1047 1048 1049 1050
			 (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)
			""))))
1051
  (with-current-buffer arcbuf
Karl Heuer's avatar
Karl Heuer committed
1052 1053 1054 1055 1056 1057 1058 1059
    (or (eq major-mode 'archive-mode)
	(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"))
1060 1061
  (let ((func (with-current-buffer arcbuf
                (archive-name "add-new-member")))
Karl Heuer's avatar
Karl Heuer committed
1062 1063
	(membuf (current-buffer)))
    (if (fboundp func)
1064
	(with-current-buffer arcbuf
Karl Heuer's avatar
Karl Heuer committed
1065 1066 1067 1068 1069 1070
	  (funcall func buffer-file-name membuf name))
      (error "Adding a new member is not supported for this archive type"))))
;; -------------------------------------------------------------------------
;; Section: IO stuff

(defun archive-write-file-member ()
1071 1072 1073 1074
  (save-excursion
    (save-restriction
      (message "Updating archive...")
      (widen)
1075 1076 1077 1078
      (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)))))
1079 1080 1081 1082
	(if (fboundp writer)
	    (funcall writer archive archive-subfile-mode)
	  (archive-*-write-file-member archive
				       archive-subfile-mode
1083 1084 1085
				       (symbol-value writer)))
	(set-buffer-modified-p nil)
	(message "Updating archive...done"))
1086
      (set-buffer archive-superior-buffer)
1087 1088 1089 1090 1091 1092
      (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
1093 1094 1095 1096 1097 1098 1099 1100 1101

(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)
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
	  ;; 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)
	    (write-region (point-min) (point-max) tmpfile nil 'nomessage))
	  ;; 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
1112 1113 1114
	  (if (aref descr 3)
	      ;; Set the file modes, but make sure we can read it.
	      (set-file-modes tmpfile (logior ?\400 (aref descr 3))))
1115 1116 1117
	  (if enable-multibyte-characters
	      (setq ename
		    (encode-coding-string ename file-name-coding-system)))
Karl Heuer's avatar
Karl Heuer committed
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
          (let ((exitcode (apply 'call-process
                                 (car command)
                                 nil
                                 nil
                                 nil
                                 (append (cdr command) (list archive ename)))))
            (if (equal exitcode 0)
                nil
              (error "Updating was unsuccessful (%S)" exitcode))))
      (archive-delete-local tmpfile))))

1129
(defun archive-write-file (&optional file)
Karl Heuer's avatar
Karl Heuer committed
1130
  (save-excursion
1131 1132 1133 1134
    (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
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
    t))
;; -------------------------------------------------------------------------
;; Section: Marking and unmarking.

(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))
1147
        (inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
1148 1149 1150 1151 1152 1153 1154
    (while (not (zerop p))
      (if (archive-get-descr t)
          (progn
            (delete-char 1)
            (insert type)))
      (forward-line sign)
      (setq p (- p sign)))
1155
    (restore-buffer-modified-p modified))
Karl Heuer's avatar
Karl Heuer committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  (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")
  (archive-flag-deleted p ? ))

(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")
  (archive-flag-deleted (- p) ? ))

(defun archive-unmark-all-files ()
  "Remove all marks."
  (interactive)
  (let ((modified (buffer-modified-p))
1174
	(inhibit-read-only t))
Karl Heuer's avatar
Karl Heuer committed
1175 1176 1177 1178 1179 1180
    (save-excursion
      (goto-char archive-file-list-start)
      (while (< (point) archive-file-list-end)
        (or (= (following-char) ? )
            (progn (delete-char 1) (insert ? )))
        (forward-line 1)))
1181
    (restore-buffer-modified-p modified)))
Karl Heuer's avatar
Karl Heuer committed
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214

(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))))))
;; -------------------------------------------------------------------------
;; Section: Operate

(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)
1215
  "Change the protection bits associated with all marked or this member.
Karl Heuer's avatar
Karl Heuer committed
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
The new protection bits can either be specified as an octal number or
as a relative change like \"g+rw\" as for chmod(2)"
  (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)
1286
  "Change the name associated with this entry in the archive file."
Karl Heuer's avatar
Karl Heuer committed
1287 1288 1289 1290 1291 1292 1293 1294
  (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