lisp/tar-mode.el

   1 ;;; tar-mode.el --- simple editing of tar files from GNU emacs
   2
   3 ;; Copyright (C) 1990, 1991, 1993, 1994, 1995 Free Software Foundation, Inc.
   4
   5 ;; Author: Jamie Zawinski <jwz@lucid.com>
   6 ;; Created: 04 Apr 1990
   7 ;; Keywords: unix
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This package attempts to make dealing with Unix 'tar' archives easier.
  29 ;; When this code is loaded, visiting a file whose name ends in '.tar' will
  30 ;; cause the contents of that archive file to be displayed in a Dired-like
  31 ;; listing.  It is then possible to use the customary Dired keybindings to
  32 ;; extract sub-files from that archive, either by reading them into their own
  33 ;; editor buffers, or by copying them directly to arbitrary files on disk.
  34 ;; It is also possible to delete sub-files from within the tar file and write
  35 ;; the modified archive back to disk, or to edit sub-files within the archive
  36 ;; and re-insert the modified files into the archive.  See the documentation
  37 ;; string of tar-mode for more info.
  38
  39 ;; This code now understands the extra fields that GNU tar adds to tar files.
  40
  41 ;; This interacts correctly with "uncompress.el" in the Emacs library,
  42 ;; which you get with
  43 ;;
  44 ;;  (autoload 'uncompress-while-visiting "uncompress")
  45 ;;  (setq auto-mode-alist (cons '("\\.Z$" . uncompress-while-visiting)
  46 ;;                         auto-mode-alist))
  47 ;;
  48 ;; Do not attempt to use tar-mode.el with crypt.el, you will lose.
  49
  50 ;;    ***************   TO DO   ***************
  51 ;;
  52 ;; o  chmod should understand "a+x,og-w".
  53 ;;
  54 ;; o  It's not possible to add a NEW file to a tar archive; not that
  55 ;;    important, but still...
  56 ;;
  57 ;; o  The code is less efficient that it could be - in a lot of places, I
  58 ;;    pull a 512-character string out of the buffer and parse it, when I could
  59 ;;    be parsing it in place, not garbaging a string.  Should redo that.
  60 ;;
  61 ;; o  I'd like a command that searches for a string/regexp in every subfile
  62 ;;    of an archive, where <esc> would leave you in a subfile-edit buffer.
  63 ;;    (Like the Meta-R command of the Zmacs mail reader.)
  64 ;;
  65 ;; o  Sometimes (but not always) reverting the tar-file buffer does not
  66 ;;    re-grind the listing, and you are staring at the binary tar data.
  67 ;;    Typing 'g' again immediately after that will always revert and re-grind
  68 ;;    it, though.  I have no idea why this happens.
  69 ;;
  70 ;; o  Tar-mode interacts poorly with crypt.el and zcat.el because the tar
  71 ;;    write-file-hook actually writes the file.  Instead it should remove the
  72 ;;    header (and conspire to put it back afterwards) so that other write-file
  73 ;;    hooks which frob the buffer have a chance to do their dirty work.  There
  74 ;;    might be a problem if the tar write-file-hook does not come *first* on
  75 ;;    the list.
  76 ;;
  77 ;; o  Block files, sparse files, continuation files, and the various header
  78 ;;    types aren't editable.  Actually I don't know that they work at all.
  79
  80 ;; Rationale:
  81
  82 ;; Why does tar-mode edit the file itself instead of using tar?
  83
  84 ;; That means that you can edit tar files which you don't have room for
  85 ;; on your local disk.
  86
  87 ;; I don't know about recent features in gnu tar, but old versions of tar
  88 ;; can't replace a file in the middle of a tar file with a new version.
  89 ;; Tar-mode can.  I don't think tar can do things like chmod the subfiles.
  90 ;; An implementation which involved unpacking and repacking the file into
  91 ;; some scratch directory would be very wasteful, and wouldn't be able to
  92 ;; preserve the file owners.
  93
  94 ;;; Code:
  95
  96 (defvar tar-anal-blocksize 20
  97   "*The blocksize of tar files written by Emacs, or nil, meaning don't care.
  98 The blocksize of a tar file is not really the size of the blocks; rather, it is
  99 the number of blocks written with one system call.  When tarring to a tape,
 100 this is the size of the *tape* blocks, but when writing to a file, it doesn't
 101 matter much.  The only noticeable difference is that if a tar file does not
 102 have a blocksize of 20, tar will tell you that; all this really controls is
 103 how many null padding bytes go on the end of the tar file.")
 104
 105 (defvar tar-update-datestamp nil
 106   "*Non-nil means tar-mode should play fast and loose with sub-file datestamps.
 107 If this is true, then editing and saving a tar file entry back into its
 108 tar file will update its datestamp.  If false, the datestamp is unchanged.
 109 You may or may not want this - it is good in that you can tell when a file
 110 in a tar archive has been changed, but it is bad for the same reason that
 111 editing a file in the tar archive at all is bad - the changed version of
 112 the file never exists on disk.")
 113
 114 (defvar tar-mode-show-date nil
 115   "*Non-nil means Tar mode should show the date/time of each subfile.
 116 This information is useful, but it takes screen space away from file names.")
 117
 118 (defvar tar-parse-info nil)
 119 (defvar tar-header-offset nil)
 120 (defvar tar-superior-buffer nil)
 121 (defvar tar-superior-descriptor nil)
 122 (defvar tar-subfile-mode nil)
 123
 124 (put 'tar-parse-info 'permanent-local t)
 125 (put 'tar-header-offset 'permanent-local t)
 126 (put 'tar-superior-buffer 'permanent-local t)
 127 (put 'tar-superior-descriptor 'permanent-local t)
 128 \f
 129 ;;; First, duplicate some Common Lisp functions; I used to just (require 'cl)
 130 ;;; but "cl.el" was messing some people up (also it's really big).
 131
 132 (defmacro tar-setf (form val)
 133   "A mind-numbingly simple implementation of setf."
 134   (let ((mform (macroexpand form (and (boundp 'byte-compile-macro-environment)
 135                                       byte-compile-macro-environment))))
 136     (cond ((symbolp mform) (list 'setq mform val))
 137           ((not (consp mform)) (error "can't setf %s" form))
 138           ((eq (car mform) 'aref)
 139            (list 'aset (nth 1 mform) (nth 2 mform) val))
 140           ((eq (car mform) 'car)
 141            (list 'setcar (nth 1 mform) val))
 142           ((eq (car mform) 'cdr)
 143            (list 'setcdr (nth 1 mform) val))
 144           (t (error "don't know how to setf %s" form)))))
 145
 146 (defmacro tar-dolist (control &rest body)
 147   "syntax: (dolist (var-name list-expr &optional return-value) &body body)"
 148   (let ((var (car control))
 149         (init (car (cdr control)))
 150         (val (car (cdr (cdr control)))))
 151     (list 'let (list (list '_dolist_iterator_ init))
 152           (list 'while '_dolist_iterator_
 153             (cons 'let
 154               (cons (list (list var '(car _dolist_iterator_)))
 155                     (append body
 156                             (list (list 'setq '_dolist_iterator_
 157                                         (list 'cdr '_dolist_iterator_)))))))
 158           val)))
 159
 160 (defmacro tar-dotimes (control &rest body)
 161   "syntax: (dolist (var-name count-expr &optional return-value) &body body)"
 162   (let ((var (car control))
 163         (n (car (cdr control)))
 164         (val (car (cdr (cdr control)))))
 165     (list 'let (list (list '_dotimes_end_ n)
 166                      (list var 0))
 167           (cons 'while
 168                 (cons (list '< var '_dotimes_end_)
 169                       (append body
 170                               (list (list 'setq var (list '1+ var))))))
 171           val)))
 172
 173 \f
 174 ;;; down to business.
 175
 176 (defmacro make-tar-header (name mode uid git size date ck lt ln
 177                            magic uname gname devmaj devmin)
 178   (list 'vector name mode uid git size date ck lt ln
 179         magic uname gname devmaj devmin))
 180
 181 (defmacro tar-header-name (x) (list 'aref x 0))
 182 (defmacro tar-header-mode (x) (list 'aref x 1))
 183 (defmacro tar-header-uid  (x) (list 'aref x 2))
 184 (defmacro tar-header-gid  (x) (list 'aref x 3))
 185 (defmacro tar-header-size (x) (list 'aref x 4))
 186 (defmacro tar-header-date (x) (list 'aref x 5))
 187 (defmacro tar-header-checksum  (x) (list 'aref x 6))
 188 (defmacro tar-header-link-type (x) (list 'aref x 7))
 189 (defmacro tar-header-link-name (x) (list 'aref x 8))
 190 (defmacro tar-header-magic (x) (list 'aref x 9))
 191 (defmacro tar-header-uname (x) (list 'aref x 10))
 192 (defmacro tar-header-gname (x) (list 'aref x 11))
 193 (defmacro tar-header-dmaj (x) (list 'aref x 12))
 194 (defmacro tar-header-dmin (x) (list 'aref x 13))
 195
 196 (defmacro make-tar-desc (data-start tokens)
 197   (list 'cons data-start tokens))
 198
 199 (defmacro tar-desc-data-start (x) (list 'car x))
 200 (defmacro tar-desc-tokens     (x) (list 'cdr x))
 201
 202 (defconst tar-name-offset 0)
 203 (defconst tar-mode-offset (+ tar-name-offset 100))
 204 (defconst tar-uid-offset  (+ tar-mode-offset 8))
 205 (defconst tar-gid-offset  (+ tar-uid-offset 8))
 206 (defconst tar-size-offset (+ tar-gid-offset 8))
 207 (defconst tar-time-offset (+ tar-size-offset 12))
 208 (defconst tar-chk-offset  (+ tar-time-offset 12))
 209 (defconst tar-linkp-offset (+ tar-chk-offset 8))
 210 (defconst tar-link-offset (+ tar-linkp-offset 1))
 211 ;;; GNU-tar specific slots.
 212 (defconst tar-magic-offset (+ tar-link-offset 100))
 213 (defconst tar-uname-offset (+ tar-magic-offset 8))
 214 (defconst tar-gname-offset (+ tar-uname-offset 32))
 215 (defconst tar-dmaj-offset (+ tar-gname-offset 32))
 216 (defconst tar-dmin-offset (+ tar-dmaj-offset 8))
 217 (defconst tar-end-offset (+ tar-dmin-offset 8))
 218
 219 (defun tar-header-block-tokenize (string)
 220   "Return a `tar-header' structure.
 221 This is a list of name, mode, uid, gid, size,
 222 write-date, checksum, link-type, and link-name."
 223   (cond ((< (length string) 512) nil)
 224         (;(some 'plusp string)           ; <-- oops, massive cycle hog!
 225          (or (not (= 0 (aref string 0))) ; This will do.
 226              (not (= 0 (aref string 101))))
 227          (let* ((name-end (1- tar-mode-offset))
 228                 (link-end (1- tar-magic-offset))
 229                 (uname-end (1- tar-gname-offset))
 230                 (gname-end (1- tar-dmaj-offset))
 231                 (link-p (aref string tar-linkp-offset))
 232                 (magic-str (substring string tar-magic-offset (1- tar-uname-offset)))
 233                 (uname-valid-p (or (string= "ustar  " magic-str) (string= "GNUtar " magic-str)))
 234                 name
 235                 (nulsexp   "[^\000]*\000"))
 236            (and (string-match nulsexp string tar-name-offset) (setq name-end (min name-end (1- (match-end 0)))))
 237            (and (string-match nulsexp string tar-link-offset) (setq link-end (min link-end (1- (match-end 0)))))
 238            (and (string-match nulsexp string tar-uname-offset) (setq uname-end (min uname-end (1- (match-end 0)))))
 239            (and (string-match nulsexp string tar-gname-offset) (setq gname-end (min gname-end (1- (match-end 0)))))
 240            (setq name (substring string tar-name-offset name-end)
 241                  link-p (if (or (= link-p 0) (= link-p ?0))
 242                             nil
 243                           (- link-p ?0)))
 244            (if (and (null link-p) (string-match "/$" name)) (setq link-p 5)) ; directory
 245            (make-tar-header
 246              name
 247              (tar-parse-octal-integer string tar-mode-offset (1- tar-uid-offset))
 248              (tar-parse-octal-integer string tar-uid-offset (1- tar-gid-offset))
 249              (tar-parse-octal-integer string tar-gid-offset (1- tar-size-offset))
 250              (tar-parse-octal-integer string tar-size-offset (1- tar-time-offset))
 251              (tar-parse-octal-long-integer string tar-time-offset (1- tar-chk-offset))
 252              (tar-parse-octal-integer string tar-chk-offset (1- tar-linkp-offset))
 253              link-p
 254              (substring string tar-link-offset link-end)
 255              uname-valid-p
 256              (and uname-valid-p (substring string tar-uname-offset uname-end))
 257              (and uname-valid-p (substring string tar-gname-offset gname-end))
 258              (tar-parse-octal-integer string tar-dmaj-offset (1- tar-dmin-offset))
 259              (tar-parse-octal-integer string tar-dmin-offset (1- tar-end-offset))
 260              )))
 261         (t 'empty-tar-block)))
 262
 263
 264 (defun tar-parse-octal-integer (string &optional start end)
 265   (if (null start) (setq start 0))
 266   (if (null end) (setq end (length string)))
 267   (if (= (aref string start) 0)
 268       0
 269     (let ((n 0))
 270       (while (< start end)
 271         (setq n (if (< (aref string start) ?0) n
 272                   (+ (* n 8) (- (aref string start) ?0)))
 273               start (1+ start)))
 274       n)))
 275
 276 (defun tar-parse-octal-long-integer (string &optional start end)
 277   (if (null start) (setq start 0))
 278   (if (null end) (setq end (length string)))
 279   (if (= (aref string start) 0)
 280       (list 0 0)
 281     (let ((lo 0)
 282           (hi 0))
 283       (while (< start end)
 284         (if (>= (aref string start) ?0)
 285             (setq lo (+ (* lo 8) (- (aref string start) ?0))
 286                   hi (+ (* hi 8) (ash lo -16))
 287                   lo (logand lo 65535)))
 288         (setq start (1+ start)))
 289       (list hi lo))))
 290
 291 (defun tar-parse-octal-integer-safe (string)
 292   (let ((L (length string)))
 293     (if (= L 0) (error "empty string"))
 294     (tar-dotimes (i L)
 295        (if (or (< (aref string i) ?0)
 296                (> (aref string i) ?7))
 297            (error "'%c' is not an octal digit"))))
 298   (tar-parse-octal-integer string))
 299
 300
 301 (defun tar-header-block-checksum (string)
 302   "Compute and return a tar-acceptable checksum for this block."
 303   (let* ((chk-field-start tar-chk-offset)
 304          (chk-field-end (+ chk-field-start 8))
 305          (sum 0)
 306          (i 0))
 307     ;; Add up all of the characters except the ones in the checksum field.
 308     ;; Add that field as if it were filled with spaces.
 309     (while (< i chk-field-start)
 310       (setq sum (+ sum (aref string i))
 311             i (1+ i)))
 312     (setq i chk-field-end)
 313     (while (< i 512)
 314       (setq sum (+ sum (aref string i))
 315             i (1+ i)))
 316     (+ sum (* 32 8))))
 317
 318 (defun tar-header-block-check-checksum (hblock desired-checksum file-name)
 319   "Beep and print a warning if the checksum doesn't match."
 320   (if (not (= desired-checksum (tar-header-block-checksum hblock)))
 321       (progn (beep) (message "Invalid checksum for file %s!" file-name))))
 322
 323 (defun tar-header-block-recompute-checksum (hblock)
 324   "Modifies the given string to have a valid checksum field."
 325   (let* ((chk (tar-header-block-checksum hblock))
 326          (chk-string (format "%6o" chk))
 327          (l (length chk-string)))
 328     (aset hblock 154 0)
 329     (aset hblock 155 32)
 330     (tar-dotimes (i l) (aset hblock (- 153 i) (aref chk-string (- l i 1)))))
 331   hblock)
 332
 333 (defun tar-clip-time-string (time)
 334   (let ((str (current-time-string time)))
 335     (concat (substring str 4 16) (substring str 19 24))))
 336
 337 (defun tar-grind-file-mode (mode string start)
 338   "Store `-rw--r--r--' indicating MODE into STRING beginning at START.
 339 MODE should be an integer which is a file mode value."
 340   (aset string start       (if (zerop (logand 256 mode)) ?- ?r))
 341   (aset string (+ start 1) (if (zerop (logand 128 mode)) ?- ?w))
 342   (aset string (+ start 2) (if (zerop (logand  64 mode)) ?- ?x))
 343   (aset string (+ start 3) (if (zerop (logand  32 mode)) ?- ?r))
 344   (aset string (+ start 4) (if (zerop (logand  16 mode)) ?- ?w))
 345   (aset string (+ start 5) (if (zerop (logand   8 mode)) ?- ?x))
 346   (aset string (+ start 6) (if (zerop (logand   4 mode)) ?- ?r))
 347   (aset string (+ start 7) (if (zerop (logand   2 mode)) ?- ?w))
 348   (aset string (+ start 8) (if (zerop (logand   1 mode)) ?- ?x))
 349   (if (zerop (logand 1024 mode)) nil (aset string (+ start 2) ?s))
 350   (if (zerop (logand 2048 mode)) nil (aset string (+ start 5) ?s))
 351   string)
 352
 353 (defun tar-header-block-summarize (tar-hblock &optional mod-p)
 354   "Returns a line similar to the output of `tar -vtf'."
 355   (let ((name (tar-header-name tar-hblock))
 356         (mode (tar-header-mode tar-hblock))
 357         (uid (tar-header-uid tar-hblock))
 358         (gid (tar-header-gid tar-hblock))
 359         (uname (tar-header-uname tar-hblock))
 360         (gname (tar-header-gname tar-hblock))
 361         (size (tar-header-size tar-hblock))
 362         (time (tar-header-date tar-hblock))
 363         (ck (tar-header-checksum tar-hblock))
 364         (link-p (tar-header-link-type tar-hblock))
 365         (link-name (tar-header-link-name tar-hblock))
 366         )
 367     (let* ((left 11)
 368            (namew 8)
 369            (groupw 8)
 370            (sizew 8)
 371            (datew (if tar-mode-show-date 18 0))
 372            (slash (1- (+ left namew)))
 373            (lastdigit (+ slash groupw sizew))
 374            (datestart (+ lastdigit 2))
 375            (namestart (+ datestart datew))
 376            (string (make-string (+ namestart (length name) (if link-p (+ 5 (length link-name)) 0)) 32))
 377            (type (tar-header-link-type tar-hblock)))
 378       (aset string 0 (if mod-p ?* ? ))
 379       (aset string 1
 380             (cond ((or (eq type nil) (eq type 0)) ?-)
 381                   ((eq type 1) ?l)  ; link
 382                   ((eq type 2) ?s)  ; symlink
 383                   ((eq type 3) ?c)  ; char special
 384                   ((eq type 4) ?b)  ; block special
 385                   ((eq type 5) ?d)  ; directory
 386                   ((eq type 6) ?p)  ; FIFO/pipe
 387                   ((eq type 20) ?*) ; directory listing
 388                   ((eq type 29) ?M) ; multivolume continuation
 389                   ((eq type 35) ?S) ; sparse
 390                   ((eq type 38) ?V) ; volume header
 391                   ))
 392       (tar-grind-file-mode mode string 2)
 393       (setq uid (if (= 0 (length uname)) (int-to-string uid) uname))
 394       (setq gid (if (= 0 (length gname)) (int-to-string gid) gname))
 395       (setq size (int-to-string size))
 396       (setq time (tar-clip-time-string time))
 397       (tar-dotimes (i (min (1- namew) (length uid))) (aset string (- slash i) (aref uid (- (length uid) i 1))))
 398       (aset string (1+ slash) ?/)
 399       (tar-dotimes (i (min (1- groupw) (length gid))) (aset string (+ (+ slash 2) i) (aref gid i)))
 400       (tar-dotimes (i (min sizew (length size))) (aset string (- lastdigit i) (aref size (- (length size) i 1))))
 401       (if tar-mode-show-date
 402           (tar-dotimes (i (length time)) (aset string (+ datestart i) (aref time i))))
 403       (tar-dotimes (i (length name)) (aset string (+ namestart i) (aref name i)))
 404       (if (or (eq link-p 1) (eq link-p 2))
 405           (progn
 406             (tar-dotimes (i 3) (aset string (+ namestart 1 (length name) i) (aref (if (= link-p 1) "==>" "-->") i)))
 407             (tar-dotimes (i (length link-name)) (aset string (+ namestart 5 (length name) i) (aref link-name i)))))
 408       (put-text-property namestart (length string)
 409                          'mouse-face 'highlight string)
 410       string)))
 411
 412
 413 (defun tar-summarize-buffer ()
 414   "Parse the contents of the tar file in the current buffer.
 415 Place a dired-like listing on the front;
 416 then narrow to it, so that only that listing
 417 is visible (and the real data of the buffer is hidden)."
 418   (message "Parsing tar file...")
 419   (let* ((result '())
 420          (pos 1)
 421          (bs (max 1 (- (buffer-size) 1024))) ; always 2+ empty blocks at end.
 422          (bs100 (max 1 (/ bs 100)))
 423          tokens)
 424     (while (and (<= (+ pos 512) (point-max))
 425                 (not (eq 'empty-tar-block
 426                          (setq tokens
 427                                (tar-header-block-tokenize
 428                                 (buffer-substring pos (+ pos 512)))))))
 429       (setq pos (+ pos 512))
 430       (message "Parsing tar file...%d%%"
 431                ;(/ (* pos 100) bs)   ; this gets round-off lossage
 432                (/ pos bs100)         ; this doesn't
 433                )
 434       (if (eq (tar-header-link-type tokens) 20)
 435           ;; Foo.  There's an extra empty block after these.
 436           (setq pos (+ pos 512)))
 437       (let ((size (tar-header-size tokens)))
 438         (if (< size 0)
 439             (error "%s has size %s - corrupted"
 440                    (tar-header-name tokens) size))
 441         ;
 442         ; This is just too slow.  Don't really need it anyway....
 443         ;(tar-header-block-check-checksum
 444         ;  hblock (tar-header-block-checksum hblock)
 445         ;  (tar-header-name tokens))
 446
 447         (setq result (cons (make-tar-desc pos tokens) result))
 448
 449         (and (null (tar-header-link-type tokens))
 450              (> size 0)
 451              (setq pos
 452                    (+ pos 512 (ash (ash (1- size) -9) 9))        ; this works
 453                    ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't
 454                    ))))
 455     (make-local-variable 'tar-parse-info)
 456     (setq tar-parse-info (nreverse result))
 457     ;; A tar file should end with a block or two of nulls,
 458     ;; but let's not get a fatal error if it doesn't.
 459     (if (eq tokens 'empty-tar-block)
 460         (message "Parsing tar file...done")
 461       (message "Warning: premature EOF parsing tar file")))
 462   (save-excursion
 463     (goto-char (point-min))
 464     (let ((buffer-read-only nil)
 465           (summaries nil))
 466       ;; Collect summary lines and insert them all at once since tar files
 467       ;; can be pretty big.
 468       (tar-dolist (tar-desc (reverse tar-parse-info))
 469         (setq summaries
 470               (cons (tar-header-block-summarize (tar-desc-tokens tar-desc))
 471                     (cons "\n"
 472                           summaries))))
 473       (insert (apply 'concat summaries))
 474       (make-local-variable 'tar-header-offset)
 475       (setq tar-header-offset (point))
 476       (narrow-to-region 1 tar-header-offset)
 477       (set-buffer-modified-p nil))))
 478 \f
 479 (defvar tar-mode-map nil "*Local keymap for Tar mode listings.")
 480
 481 (if tar-mode-map
 482     nil
 483   (setq tar-mode-map (make-keymap))
 484   (suppress-keymap tar-mode-map)
 485   (define-key tar-mode-map " " 'tar-next-line)
 486   (define-key tar-mode-map "c" 'tar-copy)
 487   (define-key tar-mode-map "d" 'tar-flag-deleted)
 488   (define-key tar-mode-map "\^D" 'tar-flag-deleted)
 489   (define-key tar-mode-map "e" 'tar-extract)
 490   (define-key tar-mode-map "f" 'tar-extract)
 491   (define-key tar-mode-map "\C-m" 'tar-extract)
 492   (define-key tar-mode-map [mouse-2] 'tar-mouse-extract)
 493   (define-key tar-mode-map "g" 'revert-buffer)
 494   (define-key tar-mode-map "h" 'describe-mode)
 495   (define-key tar-mode-map "n" 'tar-next-line)
 496   (define-key tar-mode-map "\^N" 'tar-next-line)
 497   (define-key tar-mode-map [down] 'tar-next-line)
 498   (define-key tar-mode-map "o" 'tar-extract-other-window)
 499   (define-key tar-mode-map "p" 'tar-previous-line)
 500   (define-key tar-mode-map "\^P" 'tar-previous-line)
 501   (define-key tar-mode-map [up] 'tar-previous-line)
 502   (define-key tar-mode-map "r" 'tar-rename-entry)
 503   (define-key tar-mode-map "u" 'tar-unflag)
 504   (define-key tar-mode-map "v" 'tar-view)
 505   (define-key tar-mode-map "x" 'tar-expunge)
 506   (define-key tar-mode-map "\177" 'tar-unflag-backwards)
 507   (define-key tar-mode-map "E" 'tar-extract-other-window)
 508   (define-key tar-mode-map "M" 'tar-chmod-entry)
 509   (define-key tar-mode-map "G" 'tar-chgrp-entry)
 510   (define-key tar-mode-map "O" 'tar-chown-entry)
 511   )
 512 \f
 513 ;; Make menu bar items.
 514
 515 ;; Get rid of the Edit menu bar item to save space.
 516 (define-key tar-mode-map [menu-bar edit] 'undefined)
 517
 518 (define-key tar-mode-map [menu-bar immediate]
 519   (cons "Immediate" (make-sparse-keymap "Immediate")))
 520
 521 (define-key tar-mode-map [menu-bar immediate view]
 522   '("View This File" . tar-view))
 523 (define-key tar-mode-map [menu-bar immediate display]
 524   '("Display in Other Window" . tar-display-other-file))
 525 (define-key tar-mode-map [menu-bar immediate find-file-other-window]
 526   '("Find in Other Window" . tar-extract-other-window))
 527 (define-key tar-mode-map [menu-bar immediate find-file]
 528   '("Find This File" . tar-extract))
 529
 530 (define-key tar-mode-map [menu-bar mark]
 531   (cons "Mark" (make-sparse-keymap "Mark")))
 532
 533 (define-key tar-mode-map [menu-bar mark unmark-all]
 534   '("Unmark All" . tar-clear-modification-flags))
 535 (define-key tar-mode-map [menu-bar mark deletion]
 536   '("Flag" . tar-flag-deleted))
 537 (define-key tar-mode-map [menu-bar mark unmark]
 538   '("Unflag" . tar-unflag))
 539
 540 (define-key tar-mode-map [menu-bar operate]
 541   (cons "Operate" (make-sparse-keymap "Operate")))
 542
 543 (define-key tar-mode-map [menu-bar operate chown]
 544   '("Change Owner..." . tar-chown-entry))
 545 (define-key tar-mode-map [menu-bar operate chgrp]
 546   '("Change Group..." . tar-chgrp-entry))
 547 (define-key tar-mode-map [menu-bar operate chmod]
 548   '("Change Mode..." . tar-chmod-entry))
 549 (define-key tar-mode-map [menu-bar operate rename]
 550   '("Rename to..." . tar-rename-entry))
 551 (define-key tar-mode-map [menu-bar operate copy]
 552   '("Copy to..." . tar-copy))
 553 (define-key tar-mode-map [menu-bar operate expunge]
 554   '("Expunge Marked Files" . tar-expunge))
 555 \f
 556 ;; tar mode is suitable only for specially formatted data.
 557 (put 'tar-mode 'mode-class 'special)
 558 (put 'tar-subfile-mode 'mode-class 'special)
 559
 560 ;;;###autoload
 561 (defun tar-mode ()
 562   "Major mode for viewing a tar file as a dired-like listing of its contents.
 563 You can move around using the usual cursor motion commands.
 564 Letters no longer insert themselves.
 565 Type `e' to pull a file out of the tar file and into its own buffer;
 566 or click mouse-2 on the file's line in the Tar mode buffer.
 567 Type `c' to copy an entry from the tar file into another file on disk.
 568
 569 If you edit a sub-file of this archive (as with the `e' command) and
 570 save it with Control-x Control-s, the contents of that buffer will be
 571 saved back into the tar-file buffer; in this way you can edit a file
 572 inside of a tar archive without extracting it and re-archiving it.
 573
 574 See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
 575 \\{tar-mode-map}"
 576   ;; this is not interactive because you shouldn't be turning this
 577   ;; mode on and off.  You can corrupt things that way.
 578   ;; rms: with permanent locals, it should now be possible to make this work
 579   ;; interactively in some reasonable fashion.
 580   (kill-all-local-variables)
 581   (make-local-variable 'tar-header-offset)
 582   (make-local-variable 'tar-parse-info)
 583   (make-local-variable 'require-final-newline)
 584   (setq require-final-newline nil) ; binary data, dude...
 585   (make-local-variable 'revert-buffer-function)
 586   (setq revert-buffer-function 'tar-mode-revert)
 587   (make-local-variable 'enable-local-variables)
 588   (setq enable-local-variables nil)
 589   (make-local-variable 'next-line-add-newlines)
 590   (setq next-line-add-newlines nil)
 591   (setq major-mode 'tar-mode)
 592   (setq mode-name "Tar")
 593   (use-local-map tar-mode-map)
 594   (auto-save-mode 0)
 595   (make-local-variable 'write-contents-hooks)
 596   (setq write-contents-hooks '(tar-mode-write-file))
 597   (widen)
 598   (if (and (boundp 'tar-header-offset) tar-header-offset)
 599       (narrow-to-region 1 tar-header-offset)
 600       (tar-summarize-buffer))
 601   (run-hooks 'tar-mode-hook)
 602   )
 603
 604
 605 (defun tar-subfile-mode (p)
 606   "Minor mode for editing an element of a tar-file.
 607 This mode arranges for \"saving\" this buffer to write the data
 608 into the tar-file buffer that it came from.  The changes will actually
 609 appear on disk when you save the tar-file's buffer."
 610   (interactive "P")
 611   (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
 612       (error "This buffer is not an element of a tar file"))
 613 ;;; Don't do this, because it is redundant and wastes mode line space.
 614 ;;;  (or (assq 'tar-subfile-mode minor-mode-alist)
 615 ;;;      (setq minor-mode-alist (append minor-mode-alist
 616 ;;;                                  (list '(tar-subfile-mode " TarFile")))))
 617   (make-local-variable 'tar-subfile-mode)
 618   (setq tar-subfile-mode
 619         (if (null p)
 620             (not tar-subfile-mode)
 621             (> (prefix-numeric-value p) 0)))
 622   (cond (tar-subfile-mode
 623          (make-local-variable 'local-write-file-hooks)
 624          (setq local-write-file-hooks '(tar-subfile-save-buffer))
 625          ;; turn off auto-save.
 626          (auto-save-mode nil)
 627          (setq buffer-auto-save-file-name nil)
 628          (run-hooks 'tar-subfile-mode-hook))
 629         (t
 630          (kill-local-variable 'local-write-file-hooks))))
 631
 632
 633 ;; Revert the buffer and recompute the dired-like listing.
 634 (defun tar-mode-revert (&optional no-autosave no-confirm)
 635   (let ((revert-buffer-function nil)
 636         (old-offset tar-header-offset)
 637         success)
 638     (setq tar-header-offset nil)
 639     (unwind-protect
 640         (and (revert-buffer t no-confirm)
 641              (progn (widen)
 642                     (setq success t)
 643                     (tar-mode)))
 644       ;; If the revert was canceled,
 645       ;; put back the old value of tar-header-offset.
 646       (or success
 647           (setq tar-header-offset old-offset)))))
 648
 649
 650 (defun tar-next-line (p)
 651   (interactive "p")
 652   (forward-line p)
 653   (if (eobp) nil (forward-char (if tar-mode-show-date 54 36))))
 654
 655 (defun tar-previous-line (p)
 656   (interactive "p")
 657   (tar-next-line (- p)))
 658
 659 (defun tar-current-descriptor (&optional noerror)
 660   "Return the tar-descriptor of the current line, or signals an error."
 661   ;; I wish lines had plists, like in ZMACS...
 662   (or (nth (count-lines (point-min)
 663                         (save-excursion (beginning-of-line) (point)))
 664            tar-parse-info)
 665       (if noerror
 666           nil
 667           (error "This line does not describe a tar-file entry"))))
 668
 669 (defun tar-get-descriptor ()
 670   (let* ((descriptor (tar-current-descriptor))
 671          (tokens (tar-desc-tokens descriptor))
 672          (size (tar-header-size tokens))
 673          (link-p (tar-header-link-type tokens)))
 674     (if link-p
 675         (error "This is a %s, not a real file"
 676                (cond ((eq link-p 5) "directory")
 677                      ((eq link-p 20) "tar directory header")
 678                      ((eq link-p 29) "multivolume-continuation")
 679                      ((eq link-p 35) "sparse entry")
 680                      ((eq link-p 38) "volume header")
 681                      (t "link"))))
 682     (if (zerop size) (error "This is a zero-length file"))
 683     descriptor))
 684
 685 (defun tar-mouse-extract (event)
 686   "Extract a file whose tar directory line you click on."
 687   (interactive "e")
 688   (save-excursion
 689     (set-buffer (window-buffer (posn-window (event-end event))))
 690     (save-excursion
 691       (goto-char (posn-point (event-end event)))
 692       ;; Just make sure this doesn't get an error.
 693       (tar-get-descriptor)))
 694   (select-window (posn-window (event-end event)))
 695   (goto-char (posn-point (event-end event)))
 696   (tar-extract))
 697
 698 (defun tar-extract (&optional other-window-p)
 699   "In Tar mode, extract this entry of the tar file into its own buffer."
 700   (interactive)
 701   (let* ((view-p (eq other-window-p 'view))
 702          (descriptor (tar-get-descriptor))
 703          (tokens (tar-desc-tokens descriptor))
 704          (name (tar-header-name tokens))
 705          (size (tar-header-size tokens))
 706          (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
 707          (end (+ start size)))
 708     (let* ((tar-buffer (current-buffer))
 709            (tarname (file-name-nondirectory (buffer-file-name)))
 710            (bufname (concat (file-name-nondirectory name)
 711                             " ("
 712                             tarname
 713                             ")"))
 714            (read-only-p (or buffer-read-only view-p))
 715            (buffer (get-buffer bufname))
 716            (just-created nil))
 717       (if buffer
 718           nil
 719         (setq buffer (get-buffer-create bufname))
 720         (setq just-created t)
 721         (unwind-protect
 722             (progn
 723               (widen)
 724               (save-excursion
 725                 (set-buffer buffer)
 726                 (insert-buffer-substring tar-buffer start end)
 727                 (goto-char 0)
 728                 (setq buffer-file-name
 729                       (expand-file-name (concat tarname ":" name)))
 730                 (setq buffer-file-truename
 731                       (abbreviate-file-name buffer-file-name))
 732                 ;; Set the default-directory to the dir of the
 733                 ;; superior buffer.
 734                 (setq default-directory
 735                       (save-excursion
 736                         (set-buffer tar-buffer)
 737                         default-directory))
 738                 (normal-mode)  ; pick a mode.
 739                 (rename-buffer bufname)
 740                 (make-local-variable 'tar-superior-buffer)
 741                 (make-local-variable 'tar-superior-descriptor)
 742                 (setq tar-superior-buffer tar-buffer)
 743                 (setq tar-superior-descriptor descriptor)
 744                 (setq buffer-read-only read-only-p)
 745                 (set-buffer-modified-p nil)
 746                 (tar-subfile-mode 1))
 747               (set-buffer tar-buffer))
 748           (narrow-to-region 1 tar-header-offset)))
 749       (if view-p
 750           (view-buffer buffer (and just-created 'kill-buffer))
 751         (if (eq other-window-p 'display)
 752             (display-buffer buffer)
 753           (if other-window-p
 754               (switch-to-buffer-other-window buffer)
 755             (switch-to-buffer buffer)))))))
 756
 757
 758 (defun tar-extract-other-window ()
 759   "*In Tar mode, find this entry of the tar file in another window."
 760   (interactive)
 761   (tar-extract t))
 762
 763 (defun tar-display-other-window ()
 764   "*In Tar mode, display this entry of the tar file in another window."
 765   (interactive)
 766   (tar-extract 'display))
 767
 768 (defun tar-view ()
 769   "*In Tar mode, view the tar file entry on this line."
 770   (interactive)
 771   (tar-extract 'view))
 772
 773
 774 (defun tar-read-file-name (&optional prompt)
 775   "Read a file name with this line's entry as the default."
 776   (or prompt (setq prompt "Copy to: "))
 777   (let* ((default-file (expand-file-name
 778                         (tar-header-name (tar-desc-tokens
 779                                           (tar-current-descriptor)))))
 780          (target (expand-file-name
 781                   (read-file-name prompt
 782                                   (file-name-directory default-file)
 783                                   default-file nil))))
 784     (if (or (string= "" (file-name-nondirectory target))
 785             (file-directory-p target))
 786         (setq target (concat (if (string-match "/$" target)
 787                                  (substring target 0 (1- (match-end 0)))
 788                                  target)
 789                              "/"
 790                              (file-name-nondirectory default-file))))
 791     target))
 792
 793
 794 (defun tar-copy (&optional to-file)
 795   "*In Tar mode, extract this entry of the tar file into a file on disk.
 796 If TO-FILE is not supplied, it is prompted for, defaulting to the name of
 797 the current tar-entry."
 798   (interactive (list (tar-read-file-name)))
 799   (let* ((descriptor (tar-get-descriptor))
 800          (tokens (tar-desc-tokens descriptor))
 801          (name (tar-header-name tokens))
 802          (size (tar-header-size tokens))
 803          (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
 804          (end (+ start size))
 805          (inhibit-file-name-handlers inhibit-file-name-handlers)
 806          (inhibit-file-name-operation inhibit-file-name-operation))
 807     (save-restriction
 808       (widen)
 809       ;; Inhibit compressing a subfile again if *both* name and
 810       ;; to-file are handled by jka-compr
 811       (if (and (eq (find-file-name-handler name 'write-region) 'jka-compr-handler)
 812                (eq (find-file-name-handler to-file 'write-region) 'jka-compr-handler))
 813           (setq inhibit-file-name-handlers
 814                 (cons 'jka-compr-handler
 815                       (and (eq inhibit-file-name-operation 'write-region)
 816                            inhibit-file-name-handlers))
 817                 inhibit-file-name-operation 'write-region))
 818       (write-region start end to-file))
 819     (message "Copied tar entry %s to %s" name to-file)))
 820
 821 (defun tar-flag-deleted (p &optional unflag)
 822   "*In Tar mode, mark this sub-file to be deleted from the tar file.
 823 With a prefix argument, mark that many files."
 824   (interactive "p")
 825   (beginning-of-line)
 826   (tar-dotimes (i (if (< p 0) (- p) p))
 827     (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
 828         (progn
 829           (delete-char 1)
 830           (insert (if unflag " " "D"))))
 831     (forward-line (if (< p 0) -1 1)))
 832   (if (eobp) nil (forward-char 36)))
 833
 834 (defun tar-unflag (p)
 835   "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
 836 With a prefix argument, un-mark that many files forward."
 837   (interactive "p")
 838   (tar-flag-deleted p t))
 839
 840 (defun tar-unflag-backwards (p)
 841   "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
 842 With a prefix argument, un-mark that many files backward."
 843   (interactive "p")
 844   (tar-flag-deleted (- p) t))
 845
 846
 847 (defun tar-expunge-internal ()
 848   "Expunge the tar-entry specified by the current line."
 849   (let* ((descriptor (tar-current-descriptor))
 850          (tokens (tar-desc-tokens descriptor))
 851          (line (tar-desc-data-start descriptor))
 852          (name (tar-header-name tokens))
 853          (size (tar-header-size tokens))
 854          (link-p (tar-header-link-type tokens))
 855          (start (tar-desc-data-start descriptor))
 856          (following-descs (cdr (memq descriptor tar-parse-info))))
 857     (if link-p (setq size 0)) ; size lies for hard-links.
 858     ;;
 859     ;; delete the current line...
 860     (beginning-of-line)
 861     (let ((line-start (point)))
 862       (end-of-line) (forward-char)
 863       (let ((line-len (- (point) line-start)))
 864         (delete-region line-start (point))
 865         ;;
 866         ;; decrement the header-pointer to be in sync...
 867         (setq tar-header-offset (- tar-header-offset line-len))))
 868     ;;
 869     ;; delete the data pointer...
 870     (setq tar-parse-info (delq descriptor tar-parse-info))
 871     ;;
 872     ;; delete the data from inside the file...
 873     (widen)
 874     (let* ((data-start (+ start tar-header-offset -513))
 875            (data-end (+ data-start 512 (ash (ash (+ size 511) -9) 9))))
 876       (delete-region data-start data-end)
 877       ;;
 878       ;; and finally, decrement the start-pointers of all following
 879       ;; entries in the archive.  This is a pig when deleting a bunch
 880       ;; of files at once - we could optimize this to only do the
 881       ;; iteration over the files that remain, or only iterate up to
 882       ;; the next file to be deleted.
 883       (let ((data-length (- data-end data-start)))
 884         (tar-dolist (desc following-descs)
 885           (tar-setf (tar-desc-data-start desc)
 886                     (- (tar-desc-data-start desc) data-length))))
 887       ))
 888   (narrow-to-region 1 tar-header-offset))
 889
 890
 891 (defun tar-expunge (&optional noconfirm)
 892   "*In Tar mode, delete all the archived files flagged for deletion.
 893 This does not modify the disk image; you must save the tar file itself
 894 for this to be permanent."
 895   (interactive)
 896   (if (or noconfirm
 897           (y-or-n-p "Expunge files marked for deletion? "))
 898       (let ((n 0))
 899         (save-excursion
 900           (goto-char 0)
 901           (while (not (eobp))
 902             (if (looking-at "D")
 903                 (progn (tar-expunge-internal)
 904                        (setq n (1+ n)))
 905                 (forward-line 1)))
 906           ;; after doing the deletions, add any padding that may be necessary.
 907           (tar-pad-to-blocksize)
 908           (narrow-to-region 1 tar-header-offset)
 909           )
 910         (if (zerop n)
 911             (message "Nothing to expunge.")
 912             (message "%s files expunged.  Be sure to save this buffer." n)))))
 913
 914
 915 (defun tar-clear-modification-flags ()
 916   "Remove the stars at the beginning of each line."
 917   (interactive)
 918   (save-excursion
 919     (goto-char 1)
 920     (while (< (point) tar-header-offset)
 921       (if (not (eq (following-char) ?\ ))
 922           (progn (delete-char 1) (insert " ")))
 923       (forward-line 1))))
 924
 925
 926 (defun tar-chown-entry (new-uid)
 927   "*Change the user-id associated with this entry in the tar file.
 928 If this tar file was written by GNU tar, then you will be able to edit
 929 the user id as a string; otherwise, you must edit it as a number.
 930 You can force editing as a number by calling this with a prefix arg.
 931 This does not modify the disk image; you must save the tar file itself
 932 for this to be permanent."
 933   (interactive (list
 934                  (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
 935                    (if (or current-prefix-arg
 936                            (not (tar-header-magic tokens)))
 937                        (let (n)
 938                          (while (not (numberp (setq n (read-minibuffer
 939                                                         "New UID number: "
 940                                                         (format "%s" (tar-header-uid tokens)))))))
 941                          n)
 942                        (read-string "New UID string: " (tar-header-uname tokens))))))
 943   (cond ((stringp new-uid)
 944          (tar-setf (tar-header-uname (tar-desc-tokens (tar-current-descriptor)))
 945                    new-uid)
 946          (tar-alter-one-field tar-uname-offset (concat new-uid "\000")))
 947         (t
 948          (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor)))
 949                    new-uid)
 950          (tar-alter-one-field tar-uid-offset
 951            (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
 952
 953
 954 (defun tar-chgrp-entry (new-gid)
 955   "*Change the group-id associated with this entry in the tar file.
 956 If this tar file was written by GNU tar, then you will be able to edit
 957 the group id as a string; otherwise, you must edit it as a number.
 958 You can force editing as a number by calling this with a prefix arg.
 959 This does not modify the disk image; you must save the tar file itself
 960 for this to be permanent."
 961   (interactive (list
 962                  (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
 963                    (if (or current-prefix-arg
 964                            (not (tar-header-magic tokens)))
 965                        (let (n)
 966                          (while (not (numberp (setq n (read-minibuffer
 967                                                         "New GID number: "
 968                                                         (format "%s" (tar-header-gid tokens)))))))
 969                          n)
 970                        (read-string "New GID string: " (tar-header-gname tokens))))))
 971   (cond ((stringp new-gid)
 972          (tar-setf (tar-header-gname (tar-desc-tokens (tar-current-descriptor)))
 973                    new-gid)
 974          (tar-alter-one-field tar-gname-offset
 975            (concat new-gid "\000")))
 976         (t
 977          (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor)))
 978                    new-gid)
 979          (tar-alter-one-field tar-gid-offset
 980            (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
 981
 982 (defun tar-rename-entry (new-name)
 983   "*Change the name associated with this entry in the tar file.
 984 This does not modify the disk image; you must save the tar file itself
 985 for this to be permanent."
 986   (interactive
 987     (list (read-string "New name: "
 988             (tar-header-name (tar-desc-tokens (tar-current-descriptor))))))
 989   (if (string= "" new-name) (error "zero length name"))
 990   (if (> (length new-name) 98) (error "name too long"))
 991   (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor)))
 992             new-name)
 993   (tar-alter-one-field 0
 994     (substring (concat new-name (make-string 99 0)) 0 99)))
 995
 996
 997 (defun tar-chmod-entry (new-mode)
 998   "*Change the protection bits associated with this entry in the tar file.
 999 This does not modify the disk image; you must save the tar file itself
1000 for this to be permanent."
1001   (interactive (list (tar-parse-octal-integer-safe
1002                        (read-string "New protection (octal): "))))
1003   (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor)))
1004             new-mode)
1005   (tar-alter-one-field tar-mode-offset
1006     (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1007
1008
1009 (defun tar-alter-one-field (data-position new-data-string)
1010   (let* ((descriptor (tar-current-descriptor))
1011          (tokens (tar-desc-tokens descriptor)))
1012     (unwind-protect
1013         (save-excursion
1014           ;;
1015           ;; update the header-line.
1016           (beginning-of-line)
1017           (let ((p (point)))
1018             (forward-line 1)
1019             (delete-region p (point))
1020             (insert (tar-header-block-summarize tokens) "\n")
1021             (setq tar-header-offset (point-max)))
1022
1023           (widen)
1024           (let* ((start (+ (tar-desc-data-start descriptor) tar-header-offset -513)))
1025             ;;
1026             ;; delete the old field and insert a new one.
1027             (goto-char (+ start data-position))
1028             (delete-region (point) (+ (point) (length new-data-string))) ; <--
1029             (insert new-data-string) ; <--
1030             ;;
1031             ;; compute a new checksum and insert it.
1032             (let ((chk (tar-header-block-checksum
1033                         (buffer-substring start (+ start 512)))))
1034               (goto-char (+ start tar-chk-offset))
1035               (delete-region (point) (+ (point) 8))
1036               (insert (format "%6o" chk))
1037               (insert 0)
1038               (insert ? )
1039               (tar-setf (tar-header-checksum tokens) chk)
1040               ;;
1041               ;; ok, make sure we didn't botch it.
1042               (tar-header-block-check-checksum
1043                 (buffer-substring start (+ start 512))
1044                 chk (tar-header-name tokens))
1045               )))
1046       (narrow-to-region 1 tar-header-offset))))
1047
1048
1049 (defun tar-octal-time (timeval)
1050   ;; Format a timestamp as 11 octal digits.  Ghod, I hope this works...
1051   (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
1052     (insert (format "%05o%01o%05o"
1053                     (lsh hibits -2)
1054                     (logior (lsh (logand 3 hibits) 1) (> (logand lobits 32768) 0))
1055                     (logand 32767 lobits)
1056                     ))))
1057
1058 (defun tar-subfile-save-buffer ()
1059   "In tar subfile mode, save this buffer into its parent tar-file buffer.
1060 This doesn't write anything to disk; you must save the parent tar-file buffer
1061 to make your changes permanent."
1062   (interactive)
1063   (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
1064     (error "This buffer has no superior tar file buffer"))
1065   (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
1066     (error "This buffer doesn't have an index into its superior tar file!"))
1067   (save-excursion
1068   (let ((subfile (current-buffer))
1069         (subfile-size (buffer-size))
1070         (descriptor tar-superior-descriptor))
1071     (set-buffer tar-superior-buffer)
1072     (let* ((tokens (tar-desc-tokens descriptor))
1073            (start (tar-desc-data-start descriptor))
1074            (name (tar-header-name tokens))
1075            (size (tar-header-size tokens))
1076            (size-pad (ash (ash (+ size 511) -9) 9))
1077            (head (memq descriptor tar-parse-info))
1078            (following-descs (cdr head)))
1079       (if (not head)
1080         (error "Can't find this tar file entry in its parent tar file!"))
1081       (unwind-protect
1082        (save-excursion
1083         (widen)
1084         ;; delete the old data...
1085         (let* ((data-start (+ start tar-header-offset -1))
1086                (data-end (+ data-start (ash (ash (+ size 511) -9) 9))))
1087           (delete-region data-start data-end)
1088           ;; insert the new data...
1089           (goto-char data-start)
1090           (insert-buffer subfile)
1091           ;;
1092           ;; pad the new data out to a multiple of 512...
1093           (let ((subfile-size-pad (ash (ash (+ subfile-size 511) -9) 9)))
1094             (goto-char (+ data-start subfile-size))
1095             (insert (make-string (- subfile-size-pad subfile-size) 0))
1096             ;;
1097             ;; update the data pointer of this and all following files...
1098             (tar-setf (tar-header-size tokens) subfile-size)
1099             (let ((difference (- subfile-size-pad size-pad)))
1100               (tar-dolist (desc following-descs)
1101                 (tar-setf (tar-desc-data-start desc)
1102                           (+ (tar-desc-data-start desc) difference))))
1103             ;;
1104             ;; Update the size field in the header block.
1105             (let ((header-start (- data-start 512)))
1106               (goto-char (+ header-start tar-size-offset))
1107               (delete-region (point) (+ (point) 12))
1108               (insert (format "%11o" subfile-size))
1109               (insert ? )
1110               ;;
1111               ;; Maybe update the datestamp.
1112               (if (not tar-update-datestamp)
1113                   nil
1114                 (goto-char (+ header-start tar-time-offset))
1115                 (delete-region (point) (+ (point) 12))
1116                 (insert (tar-octal-time (current-time)))
1117                 (insert ? ))
1118               ;;
1119               ;; compute a new checksum and insert it.
1120               (let ((chk (tar-header-block-checksum
1121                           (buffer-substring header-start data-start))))
1122                 (goto-char (+ header-start tar-chk-offset))
1123                 (delete-region (point) (+ (point) 8))
1124                 (insert (format "%6o" chk))
1125                 (insert 0)
1126                 (insert ? )
1127                 (tar-setf (tar-header-checksum tokens) chk)))
1128             ;;
1129             ;; alter the descriptor-line...
1130             ;;
1131             (let ((position (- (length tar-parse-info) (length head))))
1132               (goto-char 1)
1133               (next-line position)
1134               (beginning-of-line)
1135               (let ((p (point))
1136                     after
1137                     (m (set-marker (make-marker) tar-header-offset)))
1138                 (forward-line 1)
1139                 (setq after (point))
1140                 ;; Insert the new text after the old, before deleting,
1141                 ;; to preserve the window start.
1142                 (insert-before-markers (tar-header-block-summarize tokens t) "\n")
1143                 (delete-region p after)
1144                 (setq tar-header-offset (marker-position m)))
1145               )))
1146         ;; after doing the insertion, add any final padding that may be necessary.
1147         (tar-pad-to-blocksize))
1148        (narrow-to-region 1 tar-header-offset)))
1149     (set-buffer-modified-p t)   ; mark the tar file as modified
1150     (set-buffer subfile)
1151     (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
1152     (message "Saved into tar-buffer `%s'.  Be sure to save that buffer!"
1153              (buffer-name tar-superior-buffer))
1154     ;; Prevent ordinary saving from happening.
1155     t)))
1156
1157
1158 (defun tar-pad-to-blocksize ()
1159   "If we are being anal about tar file blocksizes, fix up the current buffer.
1160 Leaves the region wide."
1161   (if (null tar-anal-blocksize)
1162       nil
1163     (widen)
1164     (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
1165            (start (tar-desc-data-start last-desc))
1166            (tokens (tar-desc-tokens last-desc))
1167            (link-p (tar-header-link-type tokens))
1168            (size (if link-p 0 (tar-header-size tokens)))
1169            (data-end (+ start size))
1170            (bbytes (ash tar-anal-blocksize 9))
1171            (pad-to (+ bbytes (* bbytes (/ (1- data-end) bbytes))))
1172            (inhibit-read-only t) ; ##
1173            )
1174       ;; If the padding after the last data is too long, delete some;
1175       ;; else insert some until we are padded out to the right number of blocks.
1176       ;;
1177       (goto-char (+ (or tar-header-offset 0) data-end))
1178       (if (> (1+ (buffer-size)) (+ (or tar-header-offset 0) pad-to))
1179           (delete-region (+ (or tar-header-offset 0) pad-to) (1+ (buffer-size)))
1180           (insert (make-string (- (+ (or tar-header-offset 0) pad-to)
1181                                   (1+ (buffer-size)))
1182                                0)))
1183       )))
1184
1185
1186 ;; Used in write-file-hook to write tar-files out correctly.
1187 (defun tar-mode-write-file ()
1188   (unwind-protect
1189       (save-excursion
1190         (widen)
1191         ;; Doing this here confuses things - the region gets left too wide!
1192         ;; I suppose this is run in a context where changing the buffer is bad.
1193         ;; (tar-pad-to-blocksize)
1194         (write-region tar-header-offset (point-max) buffer-file-name nil t)
1195         (tar-clear-modification-flags)
1196         (set-buffer-modified-p nil))
1197     (narrow-to-region 1 tar-header-offset))
1198   ;; return T because we've written the file.
1199   t)
1200 \f
1201 (provide 'tar-mode)
1202
1203 ;;; tar-mode.el ends here