tar-mode.el 55.7 KB
Newer Older
1
;;; tar-mode.el --- simple editing of tar files from GNU Emacs  -*- lexical-binding:t -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1990-1991, 1993-2019 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: Jamie Zawinski <jwz@lucid.com>
6
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Created: 04 Apr 1990
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Keywords: unix
Richard M. Stallman's avatar
Richard M. Stallman committed
9

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

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

;; 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
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25 26
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40
;; This package attempts to make dealing with Unix 'tar' archives easier.
;; When this code is loaded, visiting a file whose name ends in '.tar' will
;; cause the contents of that archive file to be displayed in a Dired-like
;; listing.  It is then possible to use the customary Dired keybindings to
;; extract sub-files from that archive, either by reading them into their own
;; editor buffers, or by copying them directly to arbitrary files on disk.
;; It is also possible to delete sub-files from within the tar file and write
;; the modified archive back to disk, or to edit sub-files within the archive
;; and re-insert the modified files into the archive.  See the documentation
;; string of tar-mode for more info.

;; This code now understands the extra fields that GNU tar adds to tar files.

;; This interacts correctly with "uncompress.el" in the Emacs library,
41
;; which you get with
Erik Naggum's avatar
Erik Naggum committed
42 43 44 45 46 47 48
;;
;;  (autoload 'uncompress-while-visiting "uncompress")
;;  (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
;;			   auto-mode-alist))
;;
;; Do not attempt to use tar-mode.el with crypt.el, you will lose.

49
;;    ***************   TO DO   ***************
Erik Naggum's avatar
Erik Naggum committed
50 51 52 53 54 55 56 57 58 59 60
;;
;; o  chmod should understand "a+x,og-w".
;;
;; o  The code is less efficient that it could be - in a lot of places, I
;;    pull a 512-character string out of the buffer and parse it, when I could
;;    be parsing it in place, not garbaging a string.  Should redo that.
;;
;; o  I'd like a command that searches for a string/regexp in every subfile
;;    of an archive, where <esc> would leave you in a subfile-edit buffer.
;;    (Like the Meta-R command of the Zmacs mail reader.)
;;
61
;; o  Sometimes (but not always) reverting the tar-file buffer does not
Erik Naggum's avatar
Erik Naggum committed
62 63 64 65 66 67 68 69 70 71 72
;;    re-grind the listing, and you are staring at the binary tar data.
;;    Typing 'g' again immediately after that will always revert and re-grind
;;    it, though.  I have no idea why this happens.
;;
;; o  Tar-mode interacts poorly with crypt.el and zcat.el because the tar
;;    write-file-hook actually writes the file.  Instead it should remove the
;;    header (and conspire to put it back afterwards) so that other write-file
;;    hooks which frob the buffer have a chance to do their dirty work.  There
;;    might be a problem if the tar write-file-hook does not come *first* on
;;    the list.
;;
73
;; o  Block files, sparse files, continuation files, and the various header
Erik Naggum's avatar
Erik Naggum committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
;;    types aren't editable.  Actually I don't know that they work at all.

;; Rationale:

;; Why does tar-mode edit the file itself instead of using tar?

;; That means that you can edit tar files which you don't have room for
;; on your local disk.

;; I don't know about recent features in gnu tar, but old versions of tar
;; can't replace a file in the middle of a tar file with a new version.
;; Tar-mode can.  I don't think tar can do things like chmod the subfiles.
;; An implementation which involved unpacking and repacking the file into
;; some scratch directory would be very wasteful, and wouldn't be able to
;; preserve the file owners.
Richard M. Stallman's avatar
Richard M. Stallman committed
89

90 91
;;; Bugs:

92
;; - Rename on ././@LongLink files
93 94
;; - Revert confirmation displays the raw data temporarily.

Eric S. Raymond's avatar
Eric S. Raymond committed
95 96
;;; Code:

97
(eval-when-compile (require 'cl-lib))
98
(require 'arc-mode)
99

Stephen Eglen's avatar
Stephen Eglen committed
100 101 102 103 104 105
(defgroup tar nil
  "Simple editing of tar files."
  :prefix "tar-"
  :group 'data)

(defcustom tar-anal-blocksize 20
106
  "The blocksize of tar files written by Emacs, or nil, meaning don't care.
Richard M. Stallman's avatar
Richard M. Stallman committed
107
The blocksize of a tar file is not really the size of the blocks; rather, it is
108
the number of blocks written with one system call.  When tarring to a tape,
Richard M. Stallman's avatar
Richard M. Stallman committed
109 110 111
this is the size of the *tape* blocks, but when writing to a file, it doesn't
matter much.  The only noticeable difference is that if a tar file does not
have a blocksize of 20, tar will tell you that; all this really controls is
Stephen Eglen's avatar
Stephen Eglen committed
112
how many null padding bytes go on the end of the tar file."
113
  :type '(choice integer (const nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
114

Stephen Eglen's avatar
Stephen Eglen committed
115
(defcustom tar-update-datestamp nil
116
  "Non-nil means Tar mode should play fast and loose with sub-file datestamps.
117
If this is true, then editing and saving a tar file entry back into its
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119 120
tar file will update its datestamp.  If false, the datestamp is unchanged.
You may or may not want this - it is good in that you can tell when a file
in a tar archive has been changed, but it is bad for the same reason that
121
editing a file in the tar archive at all is bad - the changed version of
Stephen Eglen's avatar
Stephen Eglen committed
122
the file never exists on disk."
123
  :type 'boolean)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

Stephen Eglen's avatar
Stephen Eglen committed
125
(defcustom tar-mode-show-date nil
126
  "Non-nil means Tar mode should show the date/time of each subfile.
Stephen Eglen's avatar
Stephen Eglen committed
127
This information is useful, but it takes screen space away from file names."
128
  :type 'boolean)
129

130
(defvar tar-parse-info nil)
131 132 133 134
(defvar tar-superior-buffer nil
  "Buffer containing the tar archive from which a member was extracted.")
(defvar tar-superior-descriptor nil
  "Tar descriptor for a member extracted from an archive.")
135
(defvar tar-file-name-coding-system nil)
136 137 138

(put 'tar-superior-buffer 'permanent-local t)
(put 'tar-superior-descriptor 'permanent-local t)
139 140 141

;; The Tar data is made up of bytes and better manipulated as bytes
;; and can be very large, so insert/delete can be costly.  The summary we
Paul Eggert's avatar
Paul Eggert committed
142
;; want to display may contain non-ascii chars, of course, so we'd like it
143 144 145 146 147 148 149 150 151 152 153 154 155 156
;; to be multibyte.  We used to keep both in the same buffer and switch
;; from/to uni/multibyte.  But this had several downsides:
;; - set-buffer-multibyte has an O(N^2) worst case that tends to be triggered
;;   here, so it gets atrociously slow on large Tar files.
;; - need to widen/narrow the buffer to show/hide the raw data, and need to
;;   maintain a tar-header-offset that keeps track of the boundary between
;;   the two.
;; - can't use markers because they're not preserved by set-buffer-multibyte.
;; So instead, we now keep the two pieces of data in separate buffers, and
;; use the new buffer-swap-text primitive when we need to change which data
;; is associated with "the" buffer.
(defvar tar-data-buffer nil "Buffer that holds the actual raw tar bytes.")
(make-variable-buffer-local 'tar-data-buffer)

157 158 159 160
(defvar tar-data-swapped nil
  "If non-nil, `tar-data-buffer' indeed holds raw tar bytes.")
(make-variable-buffer-local 'tar-data-swapped)

161 162
(defun tar-data-swapped-p ()
  "Return non-nil if the tar-data is in `tar-data-buffer'."
163 164 165 166 167
  (and (buffer-live-p tar-data-buffer)
       ;; Sanity check to try and make sure tar-data-swapped tracks the swap
       ;; state correctly: the raw data is expected to be always larger than
       ;; the summary.
       (progn
168
	 (cl-assert (or (= (buffer-size tar-data-buffer) (buffer-size))
169 170
                     (eq tar-data-swapped
                         (> (buffer-size tar-data-buffer) (buffer-size)))))
171
	 tar-data-swapped)))
172 173 174 175 176 177 178

(defun tar-swap-data ()
  "Swap buffer contents between current buffer and `tar-data-buffer'.
Preserve the modified states of the buffers and set `buffer-swapped-with'."
  (let ((data-buffer-modified-p (buffer-modified-p tar-data-buffer))
	(current-buffer-modified-p (buffer-modified-p)))
    (buffer-swap-text tar-data-buffer)
179 180
    (setq tar-data-swapped (not tar-data-swapped))
    (restore-buffer-modified-p data-buffer-modified-p)
181
    (with-current-buffer tar-data-buffer
182
      (restore-buffer-modified-p current-buffer-modified-p))))
Richard M. Stallman's avatar
Richard M. Stallman committed
183 184 185

;;; down to business.

186
(cl-defstruct (tar-header
Stefan Monnier's avatar
Stefan Monnier committed
187 188 189 190 191 192 193
            (:constructor nil)
            (:type vector)
            :named
            (:constructor
             make-tar-header (data-start name mode uid gid size date checksum
                              link-type link-name magic uname gname dmaj dmin)))
  data-start name mode uid gid size date checksum link-type link-name
194 195 196 197
  magic uname gname dmaj dmin
  ;; Start of the header can be nil (meaning it's 512 bytes before data-start)
  ;; or a marker (in case the header uses LongLink thingies).
  header-start)
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213

(defconst tar-name-offset 0)
(defconst tar-mode-offset (+ tar-name-offset 100))
(defconst tar-uid-offset  (+ tar-mode-offset 8))
(defconst tar-gid-offset  (+ tar-uid-offset 8))
(defconst tar-size-offset (+ tar-gid-offset 8))
(defconst tar-time-offset (+ tar-size-offset 12))
(defconst tar-chk-offset  (+ tar-time-offset 12))
(defconst tar-linkp-offset (+ tar-chk-offset 8))
(defconst tar-link-offset (+ tar-linkp-offset 1))
;;; GNU-tar specific slots.
(defconst tar-magic-offset (+ tar-link-offset 100))
(defconst tar-uname-offset (+ tar-magic-offset 8))
(defconst tar-gname-offset (+ tar-uname-offset 32))
(defconst tar-dmaj-offset (+ tar-gname-offset 32))
(defconst tar-dmin-offset (+ tar-dmaj-offset 8))
214 215
(defconst tar-prefix-offset (+ tar-dmin-offset 8))
(defconst tar-end-offset (+ tar-prefix-offset 155))
Richard M. Stallman's avatar
Richard M. Stallman committed
216

Stefan Monnier's avatar
Stefan Monnier committed
217 218 219
(defun tar-roundup-512 (s)
  "Round S up to the next multiple of 512."
  (ash (ash (+ s 511) -9) 9))
220

221
(defun tar-header-block-tokenize (pos coding)
222
  "Return a `tar-header' structure.
223
This is a list of name, mode, uid, gid, size,
224
write-date, checksum, link-type, and link-name."
225
  (if (> (+ pos 512) (point-max)) (error "Malformed Tar header"))
226 227
  (cl-assert (zerop (mod (- pos (point-min)) 512)))
  (cl-assert (not enable-multibyte-characters))
Stefan Monnier's avatar
Stefan Monnier committed
228 229 230 231 232 233 234 235 236 237
  (let ((string (buffer-substring pos (setq pos (+ pos 512)))))
    (when      ;(some 'plusp string)		 ; <-- oops, massive cycle hog!
        (or (not (= 0 (aref string 0))) ; This will do.
            (not (= 0 (aref string 101))))
      (let* ((name-end tar-mode-offset)
             (link-end (1- tar-magic-offset))
             (uname-end (1- tar-gname-offset))
             (gname-end (1- tar-dmaj-offset))
             (link-p (aref string tar-linkp-offset))
             (magic-str (substring string tar-magic-offset
238 239 240 241 242 243 244
				   ;; The magic string is actually 6bytes
				   ;; of magic string plus 2bytes of version
				   ;; which we here ignore.
                                   (- tar-uname-offset 2)))
	     ;; The magic string is "ustar\0" for POSIX format, and
	     ;; "ustar " for GNU Tar's format.
             (uname-valid-p (car (member magic-str '("ustar " "ustar\0"))))
Stefan Monnier's avatar
Stefan Monnier committed
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
             name linkname
             (nulsexp   "[^\000]*\000"))
        (when (string-match nulsexp string tar-name-offset)
          (setq name-end (min name-end (1- (match-end 0)))))
        (when (string-match nulsexp string tar-link-offset)
          (setq link-end (min link-end (1- (match-end 0)))))
        (when (string-match nulsexp string tar-uname-offset)
          (setq uname-end (min uname-end (1- (match-end 0)))))
        (when (string-match nulsexp string tar-gname-offset)
          (setq gname-end (min gname-end (1- (match-end 0)))))
        (setq name (substring string tar-name-offset name-end)
              link-p (if (or (= link-p 0) (= link-p ?0))
                         nil
                       (- link-p ?0)))
        (setq linkname (substring string tar-link-offset link-end))
260
        (when (and (equal uname-valid-p "ustar\0")
Stefan Monnier's avatar
Stefan Monnier committed
261 262 263 264 265
                   (string-match nulsexp string tar-prefix-offset)
                   (> (match-end 0) (1+ tar-prefix-offset)))
          (setq name (concat (substring string tar-prefix-offset
                                        (1- (match-end 0)))
                             "/" name)))
266 267 268 269
        (setq name
              (decode-coding-string name coding)
              linkname
              (decode-coding-string linkname coding))
Stefan Monnier's avatar
Stefan Monnier committed
270 271 272 273
        (if (and (null link-p) (string-match "/\\'" name))
            (setq link-p 5))            ; directory

        (if (and (equal name "././@LongLink")
274 275 276 277
                 ;; Supposedly @LongLink is only used for GNUTAR
                 ;; format (i.e. "ustar ") but some POSIX Tar files
                 ;; (with "ustar\0") have been seen using it as well.
                 (member magic-str '("ustar " "ustar\0")))
Stefan Monnier's avatar
Stefan Monnier committed
278 279 280 281
            ;; This is a GNU Tar long-file-name header.
            (let* ((size (tar-parse-octal-integer
                          string tar-size-offset tar-time-offset))
                   ;; -1 so as to strip the terminating 0 byte.
282
		   (name (decode-coding-string
283
			  (buffer-substring pos (+ pos size -1)) coding))
Stefan Monnier's avatar
Stefan Monnier committed
284
                   (descriptor (tar-header-block-tokenize
285 286
                                (+ pos (tar-roundup-512 size))
				coding)))
Stefan Monnier's avatar
Stefan Monnier committed
287 288 289 290 291 292 293
              (cond
               ((eq link-p (- ?L ?0))      ;GNUTYPE_LONGNAME.
                (setf (tar-header-name descriptor) name))
               ((eq link-p (- ?K ?0))      ;GNUTYPE_LONGLINK.
                (setf (tar-header-link-name descriptor) name))
               (t
                (message "Unrecognized GNU Tar @LongLink format")))
294 295
              (setf (tar-header-header-start descriptor)
                    (copy-marker (- pos 512) t))
Stefan Monnier's avatar
Stefan Monnier committed
296
              descriptor)
297

Stefan Monnier's avatar
Stefan Monnier committed
298 299 300 301 302 303 304
          (make-tar-header
           (copy-marker pos nil)
           name
           (tar-parse-octal-integer string tar-mode-offset tar-uid-offset)
           (tar-parse-octal-integer string tar-uid-offset tar-gid-offset)
           (tar-parse-octal-integer string tar-gid-offset tar-size-offset)
           (tar-parse-octal-integer string tar-size-offset tar-time-offset)
305
           (tar-parse-octal-integer string tar-time-offset tar-chk-offset)
Stefan Monnier's avatar
Stefan Monnier committed
306 307 308 309
           (tar-parse-octal-integer string tar-chk-offset tar-linkp-offset)
           link-p
           linkname
           uname-valid-p
310 311 312 313 314 315
           (when uname-valid-p
             (decode-coding-string
              (substring string tar-uname-offset uname-end) coding))
           (when uname-valid-p
             (decode-coding-string
              (substring string tar-gname-offset gname-end) coding))
Stefan Monnier's avatar
Stefan Monnier committed
316 317 318
           (tar-parse-octal-integer string tar-dmaj-offset tar-dmin-offset)
           (tar-parse-octal-integer string tar-dmin-offset tar-prefix-offset)
           ))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
319

320 321 322 323
;; Pseudo-field.
(defun tar-header-data-end (descriptor)
  (let* ((data-start (tar-header-data-start descriptor))
         (link-type (tar-header-link-type descriptor))
324 325 326 327
         (size (tar-header-size descriptor)))
    (+ data-start
       ;; Ignore size for files of type 1-6
       (if (and (not (memq link-type '(1 2 3 4 5 6))) (> size 0))
328 329
           (tar-roundup-512 size)
         0))))
Richard M. Stallman's avatar
Richard M. Stallman committed
330 331 332 333 334 335 336 337 338

(defun tar-parse-octal-integer (string &optional start end)
  (if (null start) (setq start 0))
  (if (null end) (setq end (length string)))
  (if (= (aref string start) 0)
      0
    (let ((n 0))
      (while (< start end)
	(setq n (if (< (aref string start) ?0) n
339
		  (+ (* n 8) (- (aref string start) ?0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
340 341 342
	      start (1+ start)))
      n)))

343
(define-obsolete-function-alias 'tar-parse-octal-long-integer
344
  #'tar-parse-octal-integer "27.1")
345

Richard M. Stallman's avatar
Richard M. Stallman committed
346
(defun tar-parse-octal-integer-safe (string)
347 348 349 350 351
  (if (zerop (length string)) (error "empty string"))
  (mapc (lambda (c)
	  (if (or (< c ?0) (> c ?7))
	      (error "`%c' is not an octal digit" c)))
	string)
Richard M. Stallman's avatar
Richard M. Stallman committed
352 353
  (tar-parse-octal-integer string))

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 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 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
(defun tar-new-regular-file-header (filename &optional size time)
  "Return a Tar header for a regular file.
The header will lack a proper checksum; use `tar-header-block-checksum'
to compute one, or request `tar-header-serialize' to do that.

Other tar-mode facilities may also require the data-start header
field to be set to a valid value.

If SIZE is not given or nil, it defaults to 0.
If TIME is not given or nil, assume now."
  (make-tar-header
   nil
   filename
   #o644 0 0 (or size 0)
   (or time (current-time))
   nil				; checksum
   nil nil
   nil nil nil nil nil))

(defun tar--pad-to (pos)
  (make-string (+ pos (- (point)) (point-min)) 0))

(defun tar--put-at (pos val &optional fmt mask)
  (when val
    (insert (tar--pad-to pos)
	    (if fmt
		(format fmt (if mask (logand mask val) val))
	      val))))

(defun tar-header-serialize (header &optional update-checksum)
  "Return the serialization of a Tar HEADER as a string.
This function calls `tar-header-block-check-checksum' to ensure the
checksum is correct.

If UPDATE-CHECKSUM is non-nil, update HEADER with the newly-computed
checksum before doing the check."
  (with-temp-buffer
    (set-buffer-multibyte nil)
    (let ((encoded-name
	   (encode-coding-string (tar-header-name header)
				 tar-file-name-coding-system)))
      (unless (< (length encoded-name) 99)
	;; FIXME: Implement it.
	(error "Long file name support is not implemented"))
      (insert encoded-name))
    (tar--put-at tar-mode-offset (tar-header-mode header) "%6o\0 " #o777777)
    (tar--put-at tar-uid-offset  (tar-header-uid  header) "%6o\0 " #o777777)
    (tar--put-at tar-gid-offset  (tar-header-gid  header) "%6o\0 " #o777777)
    (tar--put-at tar-size-offset (tar-header-size header) "%11o ")
    (insert (tar--pad-to tar-time-offset)
	    (tar-octal-time (tar-header-date header))
	    " ")
    ;; Omit tar-header-checksum (tar-chk-offset) for now.
    (tar--put-at   tar-linkp-offset (tar-header-link-type header))
    (tar--put-at   tar-link-offset  (tar-header-link-name header))
    (when (tar-header-magic header)
      (tar--put-at tar-magic-offset (tar-header-magic header))
      (tar--put-at tar-uname-offset (tar-header-uname header))
      (tar--put-at tar-gname-offset (tar-header-gname header))
      (tar--put-at tar-dmaj-offset (tar-header-dmaj header) "%7o\0" #o7777777)
      (tar--put-at tar-dmin-offset (tar-header-dmin header) "%7o\0" #o7777777))
    (tar--put-at 512 "")
    (let ((ck (tar-header-block-checksum (buffer-string))))
      (goto-char (+ (point-min) tar-chk-offset))
      (delete-char 8)
      (insert (format "%6o\0 " ck))
      (when update-checksum
	(setf (tar-header-checksum header) ck))
      (tar-header-block-check-checksum (buffer-string)
				       (tar-header-checksum header)
				       (tar-header-name header)))
    ;; .
    (buffer-string)))

Richard M. Stallman's avatar
Richard M. Stallman committed
428

429
(defun tar-header-block-checksum (string)
430
  "Compute and return a tar-acceptable checksum for this block."
431
  (cl-assert (not (multibyte-string-p string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
  (let* ((chk-field-start tar-chk-offset)
	 (chk-field-end (+ chk-field-start 8))
	 (sum 0)
	 (i 0))
    ;; Add up all of the characters except the ones in the checksum field.
    ;; Add that field as if it were filled with spaces.
    (while (< i chk-field-start)
      (setq sum (+ sum (aref string i))
	    i (1+ i)))
    (setq i chk-field-end)
    (while (< i 512)
      (setq sum (+ sum (aref string i))
	    i (1+ i)))
    (+ sum (* 32 8))))

447
(defun tar-header-block-check-checksum (hblock desired-checksum file-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
448
  "Beep and print a warning if the checksum doesn't match."
449
  (if (not (= desired-checksum (tar-header-block-checksum hblock)))
Richard M. Stallman's avatar
Richard M. Stallman committed
450 451
      (progn (beep) (message "Invalid checksum for file %s!" file-name))))

452 453
(defun tar-clip-time-string (time)
  (let ((str (current-time-string time)))
Paul Eggert's avatar
Paul Eggert committed
454
    (concat " " (substring str 4 16) (format-time-string " %Y" time))))
Richard M. Stallman's avatar
Richard M. Stallman committed
455

456
(defun tar-grind-file-mode (mode)
457
  "Construct a `rw-r--r--' string indicating MODE.
458
MODE should be an integer which is a file mode value."
459 460 461
  (string
   (if (zerop (logand 256 mode)) ?- ?r)
   (if (zerop (logand 128 mode)) ?- ?w)
Ulrich Mueller's avatar
Ulrich Mueller committed
462 463 464
   (if (zerop (logand 2048 mode))
       (if (zerop (logand  64 mode)) ?- ?x)
     (if (zerop (logand  64 mode)) ?S ?s))
465 466
   (if (zerop (logand  32 mode)) ?- ?r)
   (if (zerop (logand  16 mode)) ?- ?w)
Ulrich Mueller's avatar
Ulrich Mueller committed
467 468 469
   (if (zerop (logand 1024 mode))
       (if (zerop (logand   8 mode)) ?- ?x)
     (if (zerop (logand   8 mode)) ?S ?s))
470 471
   (if (zerop (logand   4 mode)) ?- ?r)
   (if (zerop (logand   2 mode)) ?- ?w)
Ulrich Mueller's avatar
Ulrich Mueller committed
472 473 474
   (if (zerop (logand 512 mode))
       (if (zerop (logand   1 mode)) ?- ?x)
     (if (zerop (logand   1 mode)) ?T ?t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
475

476
(defun tar-header-block-summarize (tar-hblock &optional mod-p)
477
  "Return a line similar to the output of `tar -vtf'."
Richard M. Stallman's avatar
Richard M. Stallman committed
478 479 480 481 482 483 484 485
  (let ((name (tar-header-name tar-hblock))
	(mode (tar-header-mode tar-hblock))
	(uid (tar-header-uid tar-hblock))
	(gid (tar-header-gid tar-hblock))
	(uname (tar-header-uname tar-hblock))
	(gname (tar-header-gname tar-hblock))
	(size (tar-header-size tar-hblock))
	(time (tar-header-date tar-hblock))
486
	;; (ck (tar-header-checksum tar-hblock))
487 488
	(type (tar-header-link-type tar-hblock))
	(link-name (tar-header-link-name tar-hblock)))
489
    (format "%c%c%s %7s/%-7s %7s%s %s%s"
490
	    (if mod-p ?* ? )
Richard M. Stallman's avatar
Richard M. Stallman committed
491
	    (cond ((or (eq type nil) (eq type 0)) ?-)
492 493
		  ((eq type 1) ?h)	; link
		  ((eq type 2) ?l)	; symlink
494 495 496 497 498
		  ((eq type 3) ?c)	; char special
		  ((eq type 4) ?b)	; block special
		  ((eq type 5) ?d)	; directory
		  ((eq type 6) ?p)	; FIFO/pipe
		  ((eq type 20) ?*)	; directory listing
499
		  ((eq type 28) ?L)	; next has longname
500 501 502
		  ((eq type 29) ?M)	; multivolume continuation
		  ((eq type 35) ?S)	; sparse
		  ((eq type 38) ?V)	; volume header
503 504
		  ((eq type 55) ?H)	; pax global extended header
		  ((eq type 72) ?X)	; pax extended header
505
		  (t ?\s)
506 507 508 509 510 511
		  )
	    (tar-grind-file-mode mode)
	    (if (= 0 (length uname)) uid uname)
	    (if (= 0 (length gname)) gid gname)
	    size
	    (if tar-mode-show-date (tar-clip-time-string time) "")
512 513 514
	    (propertize name
			'mouse-face 'highlight
			'help-echo "mouse-2: extract this file into a buffer")
515 516 517
	    (if (or (eq type 1) (eq type 2))
		(concat (if (= type 1) " ==> " " --> ") link-name)
	      ""))))
Richard M. Stallman's avatar
Richard M. Stallman committed
518

519
(defun tar-untar-buffer ()
520
  "Extract all archive members in the tar-file into the current directory."
521
  (interactive)
522
  ;; FIXME: make it work even if we're not in tar-mode.
523 524
  (let ((data-buf (if (tar-data-swapped-p) tar-data-buffer
                    (current-buffer)))
525
        (reporter (make-progress-reporter "Extracting")))
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
    (with-current-buffer data-buf
      (cl-assert (not enable-multibyte-characters)))
    (dolist (descriptor tar-parse-info)
      (let* ((orig (tar-header-name descriptor))
	     ;; Note that default-directory may have different values
	     ;; in the tar-mode and data buffers, so we stick to the
	     ;; absolute file name from now on.
	     (name (expand-file-name orig))
             (dir (if (eq (tar-header-link-type descriptor) 5)
                      name
                    (file-name-directory name)))
             (link-desc (tar--describe-as-link descriptor))
             (start (tar-header-data-start descriptor))
             (end (+ start (tar-header-size descriptor))))
        (unless (file-directory-p name)
          (progress-reporter-update reporter name)
          (if (and dir (not (file-exists-p dir)))
              (make-directory dir t))
544
          (unless (file-directory-p name)
545
	    (with-current-buffer data-buf
546 547
              (let ((coding-system-for-write 'no-conversion)
                    (write-region-inhibit-fsync t))
548 549 550 551
                (when link-desc
                  (lwarn '(tar link) :warning
                         "Extracted `%s', %s, as a normal file"
                         name link-desc))
552
                (write-region start end name nil :nomessage)))
553 554
            (set-file-modes name (tar-header-mode descriptor))))))
    (progress-reporter-done reporter)))
555

Richard M. Stallman's avatar
Richard M. Stallman committed
556
(defun tar-summarize-buffer ()
Stefan Monnier's avatar
Stefan Monnier committed
557
  "Parse the contents of the tar file in the current buffer."
558
  (cl-assert (tar-data-swapped-p))
559 560 561
  (let* ((modified (buffer-modified-p))
         (result '())
         (pos (point-min))
562
	 (coding tar-file-name-coding-system)
563
         (progress-reporter
564 565 566
          (with-current-buffer tar-data-buffer
            (make-progress-reporter "Parsing tar file..."
                                    (point-min) (point-max))))
Stefan Monnier's avatar
Stefan Monnier committed
567
         descriptor)
568
    (with-current-buffer tar-data-buffer
569
      (while (and (< pos (point-max))
570
                  (setq descriptor (tar-header-block-tokenize pos coding)))
Stefan Monnier's avatar
Stefan Monnier committed
571
        (let ((size (tar-header-size descriptor)))
572 573
          (if (< size 0)
              (error "%s has size %s - corrupted"
574 575 576 577 578 579
                     (tar-header-name descriptor) size)))
        ;;
        ;; This is just too slow.  Don't really need it anyway....
        ;;(tar-header-block-check-checksum
        ;;  hblock (tar-header-block-checksum hblock)
        ;;  (tar-header-name descriptor))
580

581 582 583 584
        (push descriptor result)
        (setq pos (tar-header-data-end descriptor))
        (progress-reporter-update progress-reporter pos)))

Stefan Monnier's avatar
Stefan Monnier committed
585
    (set (make-local-variable 'tar-parse-info) (nreverse result))
586 587
    ;; A tar file should end with a block or two of nulls,
    ;; but let's not get a fatal error if it doesn't.
Stefan Monnier's avatar
Stefan Monnier committed
588
    (if (null descriptor)
589 590
        (progress-reporter-done progress-reporter)
      (message "Warning: premature EOF parsing tar file"))
Richard M. Stallman's avatar
Richard M. Stallman committed
591
    (goto-char (point-min))
592
    (let ((create-lockfiles nil) ; avoid changing dir mtime by lock_file
593
	  (inhibit-read-only t)
594
          (total-summaries
595
           (mapconcat #'tar-header-block-summarize tar-parse-info "\n")))
596 597 598
      (insert total-summaries "\n")
      (goto-char (point-min))
      (restore-buffer-modified-p modified))))
599

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
(defvar tar-mode-map
  (let ((map (make-keymap)))
    (suppress-keymap map)
    (define-key map " " 'tar-next-line)
    (define-key map "C" 'tar-copy)
    (define-key map "d" 'tar-flag-deleted)
    (define-key map "\^D" 'tar-flag-deleted)
    (define-key map "e" 'tar-extract)
    (define-key map "f" 'tar-extract)
    (define-key map "\C-m" 'tar-extract)
    (define-key map [mouse-2] 'tar-mouse-extract)
    (define-key map "g" 'revert-buffer)
    (define-key map "n" 'tar-next-line)
    (define-key map "\^N" 'tar-next-line)
    (define-key map [down] 'tar-next-line)
    (define-key map "o" 'tar-extract-other-window)
    (define-key map "p" 'tar-previous-line)
    (define-key map "\^P" 'tar-previous-line)
    (define-key map [up] 'tar-previous-line)
619
    (define-key map "I" 'tar-new-entry)
620 621 622
    (define-key map "R" 'tar-rename-entry)
    (define-key map "u" 'tar-unflag)
    (define-key map "v" 'tar-view)
623
    (define-key map "w" 'woman-tar-extract-file)
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    (define-key map "x" 'tar-expunge)
    (define-key map "\177" 'tar-unflag-backwards)
    (define-key map "E" 'tar-extract-other-window)
    (define-key map "M" 'tar-chmod-entry)
    (define-key map "G" 'tar-chgrp-entry)
    (define-key map "O" 'tar-chown-entry)
    ;; Let mouse-1 follow the link.
    (define-key map [follow-link] 'mouse-face)

    ;; Make menu bar items.

    ;; Get rid of the Edit menu bar item to save space.
    (define-key map [menu-bar edit] 'undefined)

    (define-key map [menu-bar immediate]
      (cons "Immediate" (make-sparse-keymap "Immediate")))

641 642
    (define-key map [menu-bar immediate woman]
      '("Read Man Page (WoMan)" . woman-tar-extract-file))
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
    (define-key map [menu-bar immediate view]
      '("View This File" . tar-view))
    (define-key map [menu-bar immediate display]
      '("Display in Other Window" . tar-display-other-window))
    (define-key map [menu-bar immediate find-file-other-window]
      '("Find in Other Window" . tar-extract-other-window))
    (define-key map [menu-bar immediate find-file]
      '("Find This File" . tar-extract))

    (define-key map [menu-bar mark]
      (cons "Mark" (make-sparse-keymap "Mark")))

    (define-key map [menu-bar mark unmark-all]
      '("Unmark All" . tar-clear-modification-flags))
    (define-key map [menu-bar mark deletion]
      '("Flag" . tar-flag-deleted))
    (define-key map [menu-bar mark unmark]
      '("Unflag" . tar-unflag))

    (define-key map [menu-bar operate]
      (cons "Operate" (make-sparse-keymap "Operate")))

    (define-key map [menu-bar operate chown]
      '("Change Owner..." . tar-chown-entry))
    (define-key map [menu-bar operate chgrp]
      '("Change Group..." . tar-chgrp-entry))
    (define-key map [menu-bar operate chmod]
      '("Change Mode..." . tar-chmod-entry))
    (define-key map [menu-bar operate rename]
      '("Rename to..." . tar-rename-entry))
    (define-key map [menu-bar operate copy]
      '("Copy to..." . tar-copy))
    (define-key map [menu-bar operate expunge]
      '("Expunge Marked Files" . tar-expunge))
    
    map)
  "Local keymap for Tar mode listings.")
680

681

Richard M. Stallman's avatar
Richard M. Stallman committed
682 683 684 685
;; tar mode is suitable only for specially formatted data.
(put 'tar-mode 'mode-class 'special)
(put 'tar-subfile-mode 'mode-class 'special)

686 687
(defun tar-change-major-mode-hook ()
  ;; Bring the actual Tar data back into the main buffer.
688
  (when (tar-data-swapped-p) (tar-swap-data))
689 690 691 692 693 694
  ;; Throw away the summary.
  (when (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))

(defun tar-mode-kill-buffer-hook ()
  (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))

695
;;;###autoload
696
(define-derived-mode tar-mode special-mode "Tar"
Richard M. Stallman's avatar
Richard M. Stallman committed
697
  "Major mode for viewing a tar file as a dired-like listing of its contents.
698
You can move around using the usual cursor motion commands.
Richard M. Stallman's avatar
Richard M. Stallman committed
699
Letters no longer insert themselves.
700 701
Type `e' to pull a file out of the tar file and into its own buffer;
or click mouse-2 on the file's line in the Tar mode buffer.
702
Type `c' to copy an entry from the tar file into another file on disk.
Richard M. Stallman's avatar
Richard M. Stallman committed
703

704
If you edit a sub-file of this archive (as with the `e' command) and
705
save it with \\[save-buffer], the contents of that buffer will be
706
saved back into the tar-file buffer; in this way you can edit a file
Richard M. Stallman's avatar
Richard M. Stallman committed
707 708
inside of a tar archive without extracting it and re-archiving it.

709
See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
Richard M. Stallman's avatar
Richard M. Stallman committed
710
\\{tar-mode-map}"
711 712 713
  (and buffer-file-name
       (file-writable-p buffer-file-name)
       (setq buffer-read-only nil))    ; undo what `special-mode' did
Richard M. Stallman's avatar
Richard M. Stallman committed
714
  (make-local-variable 'tar-parse-info)
715 716 717
  (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
  (set (make-local-variable 'local-enable-local-variables) nil)
  (set (make-local-variable 'next-line-add-newlines) nil)
718 719 720 721
  (set (make-local-variable 'tar-file-name-coding-system)
       (or file-name-coding-system
	   default-file-name-coding-system
	   locale-coding-system))
722
  ;; Prevent loss of data when saving the file.
723
  (set (make-local-variable 'file-precious-flag) t)
724
  (buffer-disable-undo)
Richard M. Stallman's avatar
Richard M. Stallman committed
725
  (widen)
726 727
  ;; Now move the Tar data into an auxiliary buffer, so we can use the main
  ;; buffer for the summary.
728
  (cl-assert (not (tar-data-swapped-p)))
729
  (set (make-local-variable 'revert-buffer-function) #'tar-mode-revert)
730 731 732
  ;; We started using write-contents-functions, but this hook is not
  ;; used during auto-save, so we now use
  ;; write-region-annotate-functions which hooks at a lower-level.
733 734 735
  (add-hook 'write-region-annotate-functions #'tar-write-region-annotate nil t)
  (add-hook 'kill-buffer-hook #'tar-mode-kill-buffer-hook nil t)
  (add-hook 'change-major-mode-hook #'tar-change-major-mode-hook nil t)
736
  ;; Tar data is made of bytes, not chars.
737
  (set-buffer-multibyte nil)            ;Hopefully a no-op.
738 739 740 741
  (set (make-local-variable 'tar-data-buffer)
       (generate-new-buffer (format " *tar-data %s*"
                                    (file-name-nondirectory
                                     (or buffer-file-name (buffer-name))))))
742 743 744 745 746 747 748 749 750 751 752
  (condition-case err
      (progn
        (tar-swap-data)
        (tar-summarize-buffer)
        (tar-next-line 0))
    (error
     ;; If summarizing caused an error, then maybe the buffer doesn't contain
     ;; tar data.  Rather than show a mysterious empty buffer, let's
     ;; revert to fundamental-mode.
     (fundamental-mode)
     (signal (car err) (cdr err)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
753

754 755
(autoload 'woman-tar-extract-file "woman"
  "In tar mode, run the WoMan man-page browser on this file." t)
Richard M. Stallman's avatar
Richard M. Stallman committed
756

757
(define-minor-mode tar-subfile-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
758
  "Minor mode for editing an element of a tar-file.
759 760 761 762

This mode arranges for \"saving\" this buffer to write the data
into the tar-file buffer that it came from.  The changes will
actually appear on disk when you save the tar-file's buffer."
763 764 765
  ;; Don't do this, because it is redundant and wastes mode line space.
  ;; :lighter " TarFile"
  nil nil nil
766
  (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
767
      (error "This buffer is not an element of a tar file"))
Richard M. Stallman's avatar
Richard M. Stallman committed
768
  (cond (tar-subfile-mode
769
	 (add-hook 'write-file-functions #'tar-subfile-save-buffer nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
770
	 ;; turn off auto-save.
771
	 (auto-save-mode -1)
772
	 (setq buffer-auto-save-file-name nil))
773
	(t
774
	 (remove-hook 'write-file-functions #'tar-subfile-save-buffer t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
775 776


777
;; Revert the buffer and recompute the dired-like listing.
778
(defun tar-mode-revert (&optional no-auto-save no-confirm)
779 780
  (unwind-protect
      (let ((revert-buffer-function nil))
781
        (if (tar-data-swapped-p) (tar-swap-data))
782 783 784 785
        ;; FIXME: If we ask for confirmation, the user will be temporarily
        ;; looking at the raw data.
        (revert-buffer no-auto-save no-confirm 'preserve-modes)
        ;; Recompute the summary.
786
        (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer))
787
        (tar-mode))
788
    (unless (tar-data-swapped-p) (tar-swap-data))))
Richard M. Stallman's avatar
Richard M. Stallman committed
789 790


791 792
(defun tar-next-line (arg)
  "Move cursor vertically down ARG lines and to the start of the filename."
Richard M. Stallman's avatar
Richard M. Stallman committed
793
  (interactive "p")
794
  (forward-line arg)
795
  (goto-char (or (next-single-property-change (point) 'mouse-face) (point))))
Richard M. Stallman's avatar
Richard M. Stallman committed
796

797 798
(defun tar-previous-line (arg)
  "Move cursor vertically up ARG lines and to the start of the filename."
Richard M. Stallman's avatar
Richard M. Stallman committed
799
  (interactive "p")
800
  (tar-next-line (- arg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
801

802 803 804 805
(defun tar-current-position ()
  "Return the `tar-parse-info' index for the current line."
  (count-lines (point-min) (line-beginning-position)))

Richard M. Stallman's avatar
Richard M. Stallman committed
806
(defun tar-current-descriptor (&optional noerror)
807
  "Return the tar-descriptor of the current line, or signals an error."
Richard M. Stallman's avatar
Richard M. Stallman committed
808
  ;; I wish lines had plists, like in ZMACS...
809
  (or (nth (tar-current-position)
Richard M. Stallman's avatar
Richard M. Stallman committed
810 811 812
	   tar-parse-info)
      (if noerror
	  nil
813
	  (error "This line does not describe a tar-file entry"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
814

815
(defun tar--describe-as-link (descriptor)
816
  (let ((link-p (tar-header-link-type descriptor)))
817
    (if link-p
818 819 820 821 822 823 824 825 826 827 828 829 830 831
	(cond ((eq link-p 5) "a directory")
              ((eq link-p 20) "a tar directory header")
              ((eq link-p 28) "a next has longname")
              ((eq link-p 29) "a multivolume-continuation")
              ((eq link-p 35) "a sparse entry")
              ((eq link-p 38) "a volume header")
              ((eq link-p 55) "a pax global extended header")
              ((eq link-p 72) "a pax extended header")
              (t "a link")))))

(defun tar--check-descriptor (descriptor)
  (let ((link-desc (tar--describe-as-link descriptor)))
    (when link-desc
      (error "This is %s, not a real file" link-desc))))
832 833 834 835 836

(defun tar-get-descriptor ()
  (let* ((descriptor (tar-current-descriptor))
	 (size (tar-header-size descriptor)))
    (tar--check-descriptor descriptor)
837
    (if (zerop size) (message "This is a zero-length file"))
838 839
    descriptor))

840 841 842 843 844 845 846 847 848
(defun tar-get-file-descriptor (file)
  ;; Used by package.el.
  (let ((desc ()))
    (dolist (hdr tar-parse-info)
      (when (equal file (tar-header-name hdr))
        (setq desc hdr)))
    (tar--check-descriptor desc)
    desc))

849 850 851
(defun tar-mouse-extract (event)
  "Extract a file whose tar directory line you click on."
  (interactive "e")
Stefan Monnier's avatar
Stefan Monnier committed
852
  (with-current-buffer (window-buffer (posn-window (event-end event)))
853 854 855 856 857 858 859
    (save-excursion
      (goto-char (posn-point (event-end event)))
      ;; Just make sure this doesn't get an error.
      (tar-get-descriptor)))
  (select-window (posn-window (event-end event)))
  (goto-char (posn-point (event-end event)))
  (tar-extract))
Richard M. Stallman's avatar
Richard M. Stallman committed
860

861 862 863 864 865 866
(defun tar-file-name-handler (op &rest args)
  "Helper function for `tar-extract'."
  (or (eq op 'file-exists-p)
      (let ((file-name-handler-alist nil))
	(apply op args))))

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
(defun tar--extract (descriptor)
  "Extract this entry of the tar file into its own buffer."
  (let* ((name (tar-header-name descriptor))
	 (size (tar-header-size descriptor))
	 (start (tar-header-data-start descriptor))
	 (end (+ start size))
         (tarname (buffer-name))
         (bufname (concat (file-name-nondirectory name)
                          " ("
                          tarname
                          ")"))
         (buffer (generate-new-buffer bufname)))
    (with-current-buffer tar-data-buffer
      (let (coding)
        (narrow-to-region start end)
        (goto-char start)
        (setq coding (or coding-system-for-read
                         (and set-auto-coding-function
                              (funcall set-auto-coding-function
                                       name (- end start)))
                         ;; The following binding causes
                         ;; find-buffer-file-type-coding-system
                         ;; (defined on dos-w32.el) to act as if
                         ;; the file being extracted existed, so
                         ;; that the file's contents' encoding and
                         ;; EOL format are auto-detected.
                         (let ((file-name-handler-alist
                                '(("" . tar-file-name-handler))))
                           (car (find-operation-coding-system
                                 'insert-file-contents
                                 (cons name (current-buffer)) t)))))
        (if (or (not coding)
                (eq (coding-system-type coding) 'undecided))
            (setq coding (detect-coding-region start end t)))
901
        (if (coding-system-get coding :for-unibyte)
902 903 904
            (with-current-buffer buffer
              (set-buffer-multibyte nil)))
        (widen)
905 906 907 908 909
        (with-current-buffer buffer
          (setq buffer-undo-list t))
        (decode-coding-region start end coding buffer)
        (with-current-buffer buffer
          (setq buffer-undo-list nil))))
910 911
    buffer))

Richard M. Stallman's avatar
Richard M. Stallman committed
912
(defun tar-extract (&optional other-window-p)
913
  "In Tar mode, extract this entry of the tar file into its own buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
914 915
  (interactive)
  (let* ((view-p (eq other-window-p 'view))
916
	 (descriptor (tar-get-descriptor))
Stefan Monnier's avatar
Stefan Monnier committed
917
	 (name (tar-header-name descriptor))
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
         (tar-buffer (current-buffer))
         (tarname (buffer-name))
         (read-only-p (or buffer-read-only view-p))
         (new-buffer-file-name (expand-file-name
                                ;; `:' is not allowed on Windows
                                (concat tarname "!"
                                        (if (string-match "/" name)
                                            name
                                          ;; Make sure `name' contains a /
                                          ;; so set-auto-mode doesn't try
                                          ;; to look at `tarname' for hints.
                                          (concat "./" name)))))
         (buffer (get-file-buffer new-buffer-file-name))
         (just-created nil))
    (unless buffer
      (setq buffer (tar--extract descriptor))
      (setq just-created t)
      (with-current-buffer buffer
        (goto-char (point-min))
        (setq buffer-file-name new-buffer-file-name)
        (setq buffer-file-truename
              (abbreviate-file-name buffer-file-name))
940
        (archive-try-jka-compr)       ;Pretty ugly hack :-(
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
        ;; Force buffer-file-coding-system to what
        ;; decode-coding-region actually used.
        (set-buffer-file-coding-system last-coding-system-used t)
        ;; Set the default-directory to the dir of the
        ;; superior buffer.
        (setq default-directory
              (with-current-buffer tar-buffer
                default-directory))
        (set-buffer-modified-p nil)
        (normal-mode)                   ; pick a mode.
        (set (make-local-variable 'tar-superior-buffer) tar-buffer)
        (set (make-local-variable 'tar-superior-descriptor) descriptor)
        (setq buffer-read-only read-only-p)
        (tar-subfile-mode 1)))
    (cond
     (view-p
      (view-buffer buffer (and just-created 'kill-buffer-if-not-modified)))
     ((eq other-window-p 'display) (display-buffer buffer))
     (other-window-p (switch-to-buffer-other-window buffer))
     (t (switch-to-buffer buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
961 962 963


(defun tar-extract-other-window ()
964
  "In Tar mode, find this entry of the tar file in another window."
Richard M. Stallman's avatar
Richard M. Stallman committed
965 966 967
  (interactive)
  (tar-extract t))

968
(defun tar-display-other-window ()
969
  "In Tar mode, display this entry of the tar file in another window."
970 971 972
  (interactive)
  (tar-extract 'display))

Richard M. Stallman's avatar
Richard M. Stallman committed
973
(defun tar-view ()
974
  "In Tar mode, view the tar file entry on this line."
Richard M. Stallman's avatar
Richard M. Stallman committed
975 976 977 978 979
  (interactive)
  (tar-extract 'view))


(defun tar-read-file-name (&optional prompt)
980
  "Read a file name with this line's entry as the default."
Richard M. Stallman's avatar
Richard M. Stallman committed
981 982
  (or prompt (setq prompt "Copy to: "))
  (let* ((default-file (expand-file-name
Stefan Monnier's avatar
Stefan Monnier committed
983
			(tar-header-name (tar-current-descriptor))))
Richard M. Stallman's avatar
Richard M. Stallman committed
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
	 (target (expand-file-name
		  (read-file-name prompt
				  (file-name-directory default-file)
				  default-file nil))))
    (if (or (string= "" (file-name-nondirectory target))
	    (file-directory-p target))
	(setq target (concat (if (string-match "/$" target)
				 (substring target 0 (1- (match-end 0)))
				 target)
			     "/"
			     (file-name-nondirectory default-file))))
    target))


(defun tar-copy (&optional to-file)
999
  "In Tar mode, extract this entry of the tar file into a file on disk.
Richard M. Stallman's avatar
Richard M. Stallman committed
1000 1001 1002
If TO-FILE is not supplied, it is prompted for, defaulting to the name of
the current tar-entry."
  (interactive (list (tar-read-file-name)))
1003
  (let* ((descriptor (tar-get-descriptor))
Stefan Monnier's avatar
Stefan Monnier committed
1004 1005 1006
	 (name (tar-header-name descriptor))
	 (size (tar-header-size descriptor))
	 (start (tar-header-data-start descriptor))
1007 1008 1009
	 (end (+ start size))
	 (inhibit-file-name-handlers inhibit-file-name-handlers)
	 (inhibit-file-name-operation inhibit-file-name-operation))
1010 1011
    (with-current-buffer
	(if (tar-data-swapped-p) tar-data-buffer (current-buffer))
1012 1013
      ;; Inhibit compressing a subfile again if *both* name and
      ;; to-file are handled by jka-compr
1014 1015 1016 1017
      (if (and (eq (find-file-name-handler name 'write-region)
		   'jka-compr-handler)
	       (eq (find-file-name-handler to-file 'write-region)
		   'jka-compr-handler))
1018 1019 1020 1021 1022
	  (setq inhibit-file-name-handlers
		(cons 'jka-compr-handler
		      (and (eq inhibit-file-name-operation 'write-region)
			   inhibit-file-name-handlers))
		inhibit-file-name-operation 'write-region))
1023 1024
      (let ((coding-system-for-write 'no-conversion))
	(write-region start end to-file nil nil nil t)))
1025
    (message "Copied tar entry %s to %s" name to-file)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1026

1027 1028 1029
(defun tar-new-entry (filename &optional index)
  "Insert a new empty regular file before point."
  (interactive "*sFile name: ")
1030
  (let* ((index   (or index (tar-current-position)))
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
	 (d-list  (and (not (zerop index))
		       (nthcdr (+ -1 index) tar-parse-info)))
	 (pos     (if d-list
		      (tar-header-data-end (car d-list))
		    (point-min)))
	 (new-descriptor
	  (tar-new-regular-file-header filename)))
    ;; Update the data buffer; fill the missing descriptor fields.
    (with-current-buffer tar-data-buffer
      (goto-char pos)
      (insert (tar-header-serialize new-descriptor t))
      (setf  (tar-header-data-start new-descriptor)
	     (copy-marker (point) nil)))
    ;; Update tar-parse-info.
    (if d-list
	(setcdr d-list     (cons new-descriptor (cdr d-list)))
      (setq tar-parse-info (cons new-descriptor tar-parse-info)))
    ;; Update the listing buffer.
    (save-excursion
      (goto-char (point-min))
      (forward-line index)
      (let ((inhibit-read-only t))
	(insert (tar-header-block-summarize new-descriptor) ?\n)))
    ;; .
    index))

Richard M. Stallman's avatar
Richard M. Stallman committed
1057
(defun tar-flag-deleted (p &optional unflag)
1058
  "In Tar mode, mark this sub-file to be deleted from the tar file.
Richard M. Stallman's avatar
Richard M. Stallman committed
1059 1060 1061
With a prefix argument, mark that many files."
  (interactive "p")
  (beginning-of-line)
1062
  (dotimes (_ (abs p))
Richard M. Stallman's avatar
Richard M. Stallman committed
1063 1064 1065 1066 1067 1068 1069 1070
    (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
	(progn
	  (delete-char 1)
	  (insert (if unflag " " "D"))))
    (forward-line (if (< p 0) -1 1)))
  (if (eobp) nil (forward-char 36)))

(defun tar-unflag (p)
1071
  "In Tar mode, un-mark this sub-file if it is marked to be deleted.
Richard M. Stallman's avatar
Richard M. Stallman committed
1072 1073 1074 1075 1076
With a prefix argument, un-mark that many files forward."
  (interactive "p")
  (tar-flag-deleted p t))

(defun tar-unflag-backwards (p)
1077
  "In Tar mode, un-mark this sub-file if it is marked to be deleted.
Richard M. Stallman's avatar
Richard M. Stallman committed
1078 1079 1080 1081 1082 1083 1084
With a prefix argument, un-mark that many files backward."
  (interactive "p")
  (tar-flag-deleted (- p) t))


(defun tar-expunge-internal ()
  "Expunge the tar-entry specified by the current line."
1085
  (let ((descriptor (tar-current-descriptor)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1086 1087
    ;;
    ;; delete the current line...
1088
    (delete-region (line-beginning-position) (line-beginning-position 2))
Richard M. Stallman's avatar
Richard M. Stallman committed
1089 1090 1091 1092 1093
    ;;
    ;; delete the data pointer...
    (setq tar-parse-info (delq descriptor tar-parse-info))
    ;;
    ;; delete the data from inside the file...
1094 1095 1096 1097
    (with-current-buffer tar-data-buffer
      (delete-region (or (tar-header-header-start descriptor)
                         (- (tar-header-data-start descriptor) 512))
                     (tar-header-data-end descriptor)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1098 1099 1100


(defun tar-expunge (&optional noconfirm)
1101
  "In Tar mode, delete all the archived files flagged for deletion.
Richard M. Stallman's avatar
Richard M. Stallman committed
1102 1103 1104 1105
This does not modify the disk image; you must save the tar file itself
for this to be permanent."
  (interactive)
  (if (or noconfirm
1106
	  (y-or-n-p "Expunge files marked for deletion? "))
1107
      (let ((n 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
1108
	(save-excursion
1109
	  (goto-char (point-min))
Richard M. Stallman's avatar
Richard M. Stallman committed
1110
	  (while (not (eobp))
1111
	    (if (= (following-char) ?D)
Richard M. Stallman's avatar
Richard M. Stallman committed
1112 1113 1114 1115
		(progn (tar-expunge-internal)
		       (setq n (1+ n)))
		(forward-line 1)))
	  ;; after doing the deletions, add any padding that may be necessary.
1116
	  (tar-pad-to-blocksize))
Richard M. Stallman's avatar
Richard M. Stallman committed
1117
	(if (zerop n)
1118 1119
	    (message "Nothing to expunge.")
	    (message "%s files expunged.  Be sure to save this buffer." n)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1120 1121 1122


(defun tar-clear-modification-flags ()
1123
  "Remove the stars at the beginning of each line."
1124
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
1125
  (save-excursion
1126
    (goto-char (point-min))
1127
    (while (not (eobp))
1128
      (if (not (eq (following-char) ?\s))
Richard M. Stallman's avatar
Richard M. Stallman committed
1129 1130 1131 1132 1133
	  (progn (delete-char 1) (insert " ")))
      (forward-line 1))))


(defun tar-chown-entry (new-uid)
1134
  "Change the user-id associated with this entry in the tar file.
Richard M. Stallman's avatar
Richard M. Stallman committed
1135 1136 1137 1138 1139
If this tar file was written by GNU tar, then you will be able to edit
the user id as a string; otherwise, you must edit it as a number.
You can force editing as a number by calling this with a prefix arg.
This does not modify the disk image; you must save the tar file itself
for this to be permanent."
Stefan Monnier's avatar
Stefan Monnier committed
1140 1141 1142 1143 1144 1145 1146 1147 1148
  (interactive
   (list
    (let ((descriptor (tar-current-descriptor)))
      (if (or current-prefix-arg
              (not (tar-header-magic descriptor)))
          (read-number
           "New UID number: "
           (format "%s" (tar-header-uid descriptor)))
        (read-string "New UID string: " (tar-header-uname descriptor))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1149
  (cond ((stringp new-uid)
Stefan Monnier's avatar
Stefan Monnier committed
1150
	 (setf (tar-header-uname (tar-current-descriptor)) new-uid)
1151 1152 1153 1154
	 (tar-alter-one-field tar-uname-offset
                              (concat (encode-coding-string
                                       new-uid tar-file-name-coding-system)
                                      "\000")))
Richard M. Stallman's avatar
Richard M. Stallman committed
1155
	(t
Stefan Monnier's avatar
Stefan Monnier committed
1156
	 (setf (tar-header-uid (tar-current-descriptor)) new-uid)
Richard M. Stallman's avatar
Richard M. Stallman committed
1157 1158 1159 1160 1161
	 (tar-alter-one-field tar-uid-offset
	   (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))


(defun tar-chgrp-entry (new-gid)
1162
  "Change the group-id associated with this entry in the tar file.
Richard M. Stallman's avatar
Richard M. Stallman committed
1163 1164 1165 1166 1167
If this tar file was written by GNU tar, then you will be able to edit
the group id as a string; otherwise, you must edit it as a number.
You can force editing as a number by calling this with a prefix arg.
This does not modify the disk image; you must save the tar file itself
for this to be permanent."
Stefan Monnier's avatar
Stefan Monnier committed
1168 1169 1170 1171 1172 1173 1174 1175 1176
  (interactive
   (list
    (let ((descriptor (tar-current-descriptor)))
      (if (or current-prefix-arg
              (not (tar-header-magic descriptor)))
          (read-number
           "New GID number: "
           (format "%s" (tar-header-gid descriptor)))
        (read-string "New GID string: " (tar-header-gname descriptor))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1177
  (cond ((stringp new-gid)
Stefan Monnier's avatar
Stefan Monnier committed
1178
	 (setf (tar-header-gname (tar-current-descriptor)) new-gid)
Richard M. Stallman's avatar
Richard M. Stallman committed
1179
	 (tar-alter-one-field tar-gname-offset
1180 1181 1182
                              (concat (encode-coding-string
                                       new-gid tar-file-name-coding-system)
                                      "\000")))
Richard M. Stallman's avatar
Richard M. Stallman committed
1183
	(t
Stefan Monnier's avatar
Stefan Monnier committed
1184
	 (setf (tar-header-gid (tar-current-descriptor)) new-gid)
Richard M. Stallman's avatar
Richard M. Stallman committed
1185 1186 1187 1188
	 (tar-alter-one-field tar-gid-offset
	   (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))

(defun tar-rename-entry (new-name)
1189
  "Change the name associated with this entry in the tar file.
Richard M. Stallman's avatar
Richard M. Stallman committed
1190 1191 1192 1193
This does not modify the disk image; you must save the tar file itself
for this to be permanent."
  (interactive
    (list (read-string "New name: "
Stefan Monnier's avatar
Stefan Monnier committed
1194
	    (tar-header-name (tar-current-descriptor)))))
1195
  (if (string= "" new-name) (error "zero length name"))
1196
  (let ((encoded-new-name (encode-coding-string new-name
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
						tar-file-name-coding-system))
        (descriptor (tar-current-descriptor))
        (prefix nil))
    (when (tar-header-header-start descriptor)
      ;; FIXME: Make it work for ././@LongLink.
      (error "Rename with @LongLink format is not implemented"))

    (when (and (> (length encoded-new-name) 98)
               (string-match "/" encoded-new-name
			     (- (length encoded-new-name) 99))
	       (< (match-beginning 0) 155))
1208 1209
      (unless (equal (tar-header-magic descriptor) "ustar\0")
        (tar-alter-one-field tar-magic-offset (concat "ustar\0" "00")))
1210 1211 1212
      (setq prefix (substring encoded-new-name 0 (match-beginning 0)))
      (setq encoded-new-name (substring encoded-new-name (match-end 0))))

1213
    (if (> (length encoded-new-name) 98) (error "name too long"))
1214
    (setf (tar-header-name descriptor) new-name)
1215
    (tar-alter-one-field 0
1216 1217 1218 1219
     (substring (concat encoded-new-name (make-string 99 0)) 0 99))
    (if prefix
        (tar-alter-one-field tar-prefix-offset
         (substring (concat prefix (make-string 155 0)) 0 155)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1220 1221 1222


(defun tar-chmod-entry (new-mode)
1223
  "Change the protection bits associated with this entry in the tar file.
Richard M. Stallman's avatar
Richard M. Stallman committed
1224 1225 1226 1227
This does not modify the disk image; you must save the tar file itself
for this to be permanent."
  (interactive (list (tar-parse-octal-integer-safe
		       (read-string "New protection (octal): "))))
Stefan Monnier's avatar
Stefan Monnier committed
1228
  (setf (tar-header-mode (tar-current-descriptor)) new-mode)
Richard M. Stallman's avatar