(buffer-swapped-with): New var, moved from files.el. Add advice to
[bpt/emacs.git] / lisp / tar-mode.el
CommitLineData
c88ab9ce 1;;; tar-mode.el --- simple editing of tar files from GNU emacs
aa73f29c 2
0d30b337 3;; Copyright (C) 1990, 1991, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
409cc4a3 4;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
eea8d4ef 5
22a89ee8 6;; Author: Jamie Zawinski <jwz@lucid.com>
54138c9d 7;; Maintainer: FSF
e5167999 8;; Created: 04 Apr 1990
d7b4d18f 9;; Keywords: unix
aa73f29c 10
b578f267
EN
11;; This file is part of GNU Emacs.
12
eb3fa2cf 13;; GNU Emacs is free software: you can redistribute it and/or modify
b578f267 14;; it under the terms of the GNU General Public License as published by
eb3fa2cf
GM
15;; the Free Software Foundation, either version 3 of the License, or
16;; (at your option) any later version.
b578f267
EN
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
eb3fa2cf 24;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
aa73f29c 25
22a89ee8
ER
26;;; Commentary:
27
b578f267
EN
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,
f1180544 42;; which you get with
b578f267
EN
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
f1180544 50;; *************** TO DO ***************
b578f267
EN
51;;
52;; o chmod should understand "a+x,og-w".
53;;
f1180544 54;; o It's not possible to add a NEW file to a tar archive; not that
b578f267
EN
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;;
f1180544 65;; o Sometimes (but not always) reverting the tar-file buffer does not
b578f267
EN
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;;
f1180544 77;; o Block files, sparse files, continuation files, and the various header
b578f267
EN
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.
ce210066 93
f598e45e
SM
94;;; Bugs:
95
58d6a142 96;; - Rename on ././@LongLink files
f598e45e 97;; - Revert confirmation displays the raw data temporarily.
f598e45e 98
22a89ee8
ER
99;;; Code:
100
f598e45e
SM
101(eval-when-compile (require 'cl))
102
b4dd2e66
SE
103(defgroup tar nil
104 "Simple editing of tar files."
105 :prefix "tar-"
106 :group 'data)
107
108(defcustom tar-anal-blocksize 20
8560523d 109 "The blocksize of tar files written by Emacs, or nil, meaning don't care.
aa73f29c 110The blocksize of a tar file is not really the size of the blocks; rather, it is
f1180544 111the number of blocks written with one system call. When tarring to a tape,
aa73f29c
RS
112this is the size of the *tape* blocks, but when writing to a file, it doesn't
113matter much. The only noticeable difference is that if a tar file does not
114have a blocksize of 20, tar will tell you that; all this really controls is
b4dd2e66
SE
115how many null padding bytes go on the end of the tar file."
116 :type '(choice integer (const nil))
117 :group 'tar)
aa73f29c 118
b4dd2e66 119(defcustom tar-update-datestamp nil
8560523d 120 "Non-nil means Tar mode should play fast and loose with sub-file datestamps.
30712209 121If this is true, then editing and saving a tar file entry back into its
aa73f29c
RS
122tar file will update its datestamp. If false, the datestamp is unchanged.
123You may or may not want this - it is good in that you can tell when a file
124in a tar archive has been changed, but it is bad for the same reason that
f1180544 125editing a file in the tar archive at all is bad - the changed version of
b4dd2e66
SE
126the file never exists on disk."
127 :type 'boolean
128 :group 'tar)
aa73f29c 129
b4dd2e66 130(defcustom tar-mode-show-date nil
8560523d 131 "Non-nil means Tar mode should show the date/time of each subfile.
b4dd2e66
SE
132This information is useful, but it takes screen space away from file names."
133 :type 'boolean
134 :group 'tar)
30712209 135
0f8becaa 136(defvar tar-parse-info nil)
0f8becaa
ER
137(defvar tar-superior-buffer nil)
138(defvar tar-superior-descriptor nil)
139(defvar tar-subfile-mode nil)
d26e6665 140(defvar tar-file-name-coding-system nil)
1c0b3743 141
1c0b3743
RS
142(put 'tar-superior-buffer 'permanent-local t)
143(put 'tar-superior-descriptor 'permanent-local t)
f598e45e
SM
144
145;; The Tar data is made up of bytes and better manipulated as bytes
146;; and can be very large, so insert/delete can be costly. The summary we
147;; want to display may contain non-ascci chars, of course, so we'd like it
148;; to be multibyte. We used to keep both in the same buffer and switch
149;; from/to uni/multibyte. But this had several downsides:
150;; - set-buffer-multibyte has an O(N^2) worst case that tends to be triggered
151;; here, so it gets atrociously slow on large Tar files.
152;; - need to widen/narrow the buffer to show/hide the raw data, and need to
153;; maintain a tar-header-offset that keeps track of the boundary between
154;; the two.
155;; - can't use markers because they're not preserved by set-buffer-multibyte.
156;; So instead, we now keep the two pieces of data in separate buffers, and
157;; use the new buffer-swap-text primitive when we need to change which data
158;; is associated with "the" buffer.
159(defvar tar-data-buffer nil "Buffer that holds the actual raw tar bytes.")
160(make-variable-buffer-local 'tar-data-buffer)
161
19eb68d0
SM
162(defvar tar-data-swapped nil
163 "If non-nil, `tar-data-buffer' indeed holds raw tar bytes.")
164(make-variable-buffer-local 'tar-data-swapped)
165
f598e45e
SM
166(defun tar-data-swapped-p ()
167 "Return non-nil if the tar-data is in `tar-data-buffer'."
19eb68d0
SM
168 (and (buffer-live-p tar-data-buffer)
169 ;; Sanity check to try and make sure tar-data-swapped tracks the swap
170 ;; state correctly: the raw data is expected to be always larger than
171 ;; the summary.
172 (progn
173 (assert (eq tar-data-swapped
174 (> (buffer-size tar-data-buffer) (buffer-size))))
175 tar-data-swapped)))
d3a36099
AS
176
177(defun tar-swap-data ()
178 "Swap buffer contents between current buffer and `tar-data-buffer'.
179Preserve the modified states of the buffers and set `buffer-swapped-with'."
180 (let ((data-buffer-modified-p (buffer-modified-p tar-data-buffer))
181 (current-buffer-modified-p (buffer-modified-p)))
182 (buffer-swap-text tar-data-buffer)
19eb68d0
SM
183 (setq tar-data-swapped (not tar-data-swapped))
184 (restore-buffer-modified-p data-buffer-modified-p)
d3a36099 185 (with-current-buffer tar-data-buffer
19eb68d0 186 (restore-buffer-modified-p current-buffer-modified-p))))
aa73f29c 187\f
aa73f29c
RS
188;;; down to business.
189
61bb55d0
SM
190(defstruct (tar-header
191 (:constructor nil)
192 (:type vector)
193 :named
194 (:constructor
195 make-tar-header (data-start name mode uid gid size date checksum
196 link-type link-name magic uname gname dmaj dmin)))
197 data-start name mode uid gid size date checksum link-type link-name
58d6a142
SM
198 magic uname gname dmaj dmin
199 ;; Start of the header can be nil (meaning it's 512 bytes before data-start)
200 ;; or a marker (in case the header uses LongLink thingies).
201 header-start)
aa73f29c
RS
202
203(defconst tar-name-offset 0)
204(defconst tar-mode-offset (+ tar-name-offset 100))
205(defconst tar-uid-offset (+ tar-mode-offset 8))
206(defconst tar-gid-offset (+ tar-uid-offset 8))
207(defconst tar-size-offset (+ tar-gid-offset 8))
208(defconst tar-time-offset (+ tar-size-offset 12))
209(defconst tar-chk-offset (+ tar-time-offset 12))
210(defconst tar-linkp-offset (+ tar-chk-offset 8))
211(defconst tar-link-offset (+ tar-linkp-offset 1))
212;;; GNU-tar specific slots.
213(defconst tar-magic-offset (+ tar-link-offset 100))
214(defconst tar-uname-offset (+ tar-magic-offset 8))
215(defconst tar-gname-offset (+ tar-uname-offset 32))
216(defconst tar-dmaj-offset (+ tar-gname-offset 32))
217(defconst tar-dmin-offset (+ tar-dmaj-offset 8))
034e32b0
JL
218(defconst tar-prefix-offset (+ tar-dmin-offset 8))
219(defconst tar-end-offset (+ tar-prefix-offset 155))
aa73f29c 220
61bb55d0
SM
221(defun tar-roundup-512 (s)
222 "Round S up to the next multiple of 512."
223 (ash (ash (+ s 511) -9) 9))
224
d3a36099 225(defun tar-header-block-tokenize (pos coding)
e865c5ce 226 "Return a `tar-header' structure.
f1180544 227This is a list of name, mode, uid, gid, size,
e865c5ce 228write-date, checksum, link-type, and link-name."
61bb55d0
SM
229 (assert (<= (+ pos 512) (point-max)))
230 (assert (zerop (mod (- pos (point-min)) 512)))
231 (assert (not enable-multibyte-characters))
232 (let ((string (buffer-substring pos (setq pos (+ pos 512)))))
233 (when ;(some 'plusp string) ; <-- oops, massive cycle hog!
234 (or (not (= 0 (aref string 0))) ; This will do.
235 (not (= 0 (aref string 101))))
236 (let* ((name-end tar-mode-offset)
237 (link-end (1- tar-magic-offset))
238 (uname-end (1- tar-gname-offset))
239 (gname-end (1- tar-dmaj-offset))
240 (link-p (aref string tar-linkp-offset))
241 (magic-str (substring string tar-magic-offset
242 (1- tar-uname-offset)))
58d6a142 243 (uname-valid-p (car (member magic-str '("ustar " "ustar\0\0"))))
61bb55d0
SM
244 name linkname
245 (nulsexp "[^\000]*\000"))
246 (when (string-match nulsexp string tar-name-offset)
247 (setq name-end (min name-end (1- (match-end 0)))))
248 (when (string-match nulsexp string tar-link-offset)
249 (setq link-end (min link-end (1- (match-end 0)))))
250 (when (string-match nulsexp string tar-uname-offset)
251 (setq uname-end (min uname-end (1- (match-end 0)))))
252 (when (string-match nulsexp string tar-gname-offset)
253 (setq gname-end (min gname-end (1- (match-end 0)))))
254 (setq name (substring string tar-name-offset name-end)
255 link-p (if (or (= link-p 0) (= link-p ?0))
256 nil
257 (- link-p ?0)))
258 (setq linkname (substring string tar-link-offset link-end))
58d6a142 259 (when (and (equal uname-valid-p "ustar\0\0")
61bb55d0
SM
260 (string-match nulsexp string tar-prefix-offset)
261 (> (match-end 0) (1+ tar-prefix-offset)))
262 (setq name (concat (substring string tar-prefix-offset
263 (1- (match-end 0)))
264 "/" name)))
265 (if default-enable-multibyte-characters
266 (setq name
d3a36099 267 (decode-coding-string name coding)
61bb55d0 268 linkname
d3a36099 269 (decode-coding-string linkname coding)))
61bb55d0
SM
270 (if (and (null link-p) (string-match "/\\'" name))
271 (setq link-p 5)) ; directory
272
273 (if (and (equal name "././@LongLink")
274 (equal magic-str "ustar ")) ;OLDGNU_MAGIC.
275 ;; This is a GNU Tar long-file-name header.
276 (let* ((size (tar-parse-octal-integer
277 string tar-size-offset tar-time-offset))
278 ;; -1 so as to strip the terminating 0 byte.
279 (name (buffer-substring pos (+ pos size -1)))
280 (descriptor (tar-header-block-tokenize
19eb68d0
SM
281 (+ pos (tar-roundup-512 size))
282 coding)))
61bb55d0
SM
283 (cond
284 ((eq link-p (- ?L ?0)) ;GNUTYPE_LONGNAME.
285 (setf (tar-header-name descriptor) name))
286 ((eq link-p (- ?K ?0)) ;GNUTYPE_LONGLINK.
287 (setf (tar-header-link-name descriptor) name))
288 (t
289 (message "Unrecognized GNU Tar @LongLink format")))
58d6a142
SM
290 (setf (tar-header-header-start descriptor)
291 (copy-marker (- pos 512) t))
61bb55d0
SM
292 descriptor)
293
294 (make-tar-header
295 (copy-marker pos nil)
296 name
297 (tar-parse-octal-integer string tar-mode-offset tar-uid-offset)
298 (tar-parse-octal-integer string tar-uid-offset tar-gid-offset)
299 (tar-parse-octal-integer string tar-gid-offset tar-size-offset)
300 (tar-parse-octal-integer string tar-size-offset tar-time-offset)
301 (tar-parse-octal-long-integer string tar-time-offset tar-chk-offset)
302 (tar-parse-octal-integer string tar-chk-offset tar-linkp-offset)
303 link-p
304 linkname
305 uname-valid-p
306 (and uname-valid-p (substring string tar-uname-offset uname-end))
307 (and uname-valid-p (substring string tar-gname-offset gname-end))
308 (tar-parse-octal-integer string tar-dmaj-offset tar-dmin-offset)
309 (tar-parse-octal-integer string tar-dmin-offset tar-prefix-offset)
310 ))))))
aa73f29c 311
58d6a142
SM
312;; Pseudo-field.
313(defun tar-header-data-end (descriptor)
314 (let* ((data-start (tar-header-data-start descriptor))
315 (link-type (tar-header-link-type descriptor))
316 (size (tar-header-size descriptor))
317 (fudge (cond
318 ;; Foo. There's an extra empty block after these.
319 ((memq link-type '(20 55)) 512)
320 (t 0))))
321 (+ data-start fudge
322 (if (and (null link-type) (> size 0))
323 (tar-roundup-512 size)
324 0))))
aa73f29c
RS
325
326(defun tar-parse-octal-integer (string &optional start end)
aa73f29c
RS
327 (if (null start) (setq start 0))
328 (if (null end) (setq end (length string)))
329 (if (= (aref string start) 0)
330 0
331 (let ((n 0))
332 (while (< start end)
333 (setq n (if (< (aref string start) ?0) n
30712209 334 (+ (* n 8) (- (aref string start) ?0)))
aa73f29c
RS
335 start (1+ start)))
336 n)))
337
30712209
RS
338(defun tar-parse-octal-long-integer (string &optional start end)
339 (if (null start) (setq start 0))
340 (if (null end) (setq end (length string)))
341 (if (= (aref string start) 0)
806cba9c 342 (list 0 0)
30712209
RS
343 (let ((lo 0)
344 (hi 0))
345 (while (< start end)
346 (if (>= (aref string start) ?0)
347 (setq lo (+ (* lo 8) (- (aref string start) ?0))
348 hi (+ (* hi 8) (ash lo -16))
349 lo (logand lo 65535)))
350 (setq start (1+ start)))
351 (list hi lo))))
352
aa73f29c 353(defun tar-parse-octal-integer-safe (string)
8560523d
SM
354 (if (zerop (length string)) (error "empty string"))
355 (mapc (lambda (c)
356 (if (or (< c ?0) (> c ?7))
357 (error "`%c' is not an octal digit" c)))
358 string)
aa73f29c
RS
359 (tar-parse-octal-integer string))
360
361
1bc28099 362(defun tar-header-block-checksum (string)
e865c5ce 363 "Compute and return a tar-acceptable checksum for this block."
61bb55d0 364 (assert (not (multibyte-string-p string)))
aa73f29c
RS
365 (let* ((chk-field-start tar-chk-offset)
366 (chk-field-end (+ chk-field-start 8))
367 (sum 0)
368 (i 0))
369 ;; Add up all of the characters except the ones in the checksum field.
370 ;; Add that field as if it were filled with spaces.
371 (while (< i chk-field-start)
372 (setq sum (+ sum (aref string i))
373 i (1+ i)))
374 (setq i chk-field-end)
375 (while (< i 512)
376 (setq sum (+ sum (aref string i))
377 i (1+ i)))
378 (+ sum (* 32 8))))
379
1bc28099 380(defun tar-header-block-check-checksum (hblock desired-checksum file-name)
aa73f29c 381 "Beep and print a warning if the checksum doesn't match."
1bc28099 382 (if (not (= desired-checksum (tar-header-block-checksum hblock)))
aa73f29c
RS
383 (progn (beep) (message "Invalid checksum for file %s!" file-name))))
384
30712209
RS
385(defun tar-clip-time-string (time)
386 (let ((str (current-time-string time)))
139f2b7c 387 (concat " " (substring str 4 16) (substring str 19 24))))
aa73f29c 388
139f2b7c
SM
389(defun tar-grind-file-mode (mode)
390 "Construct a `-rw--r--r--' string indicating MODE.
6a06ace6 391MODE should be an integer which is a file mode value."
139f2b7c
SM
392 (string
393 (if (zerop (logand 256 mode)) ?- ?r)
394 (if (zerop (logand 128 mode)) ?- ?w)
395 (if (zerop (logand 1024 mode)) (if (zerop (logand 64 mode)) ?- ?x) ?s)
396 (if (zerop (logand 32 mode)) ?- ?r)
397 (if (zerop (logand 16 mode)) ?- ?w)
398 (if (zerop (logand 2048 mode)) (if (zerop (logand 8 mode)) ?- ?x) ?s)
399 (if (zerop (logand 4 mode)) ?- ?r)
400 (if (zerop (logand 2 mode)) ?- ?w)
401 (if (zerop (logand 1 mode)) ?- ?x)))
aa73f29c 402
1bc28099 403(defun tar-header-block-summarize (tar-hblock &optional mod-p)
139f2b7c 404 "Return a line similar to the output of `tar -vtf'."
aa73f29c
RS
405 (let ((name (tar-header-name tar-hblock))
406 (mode (tar-header-mode tar-hblock))
407 (uid (tar-header-uid tar-hblock))
408 (gid (tar-header-gid tar-hblock))
409 (uname (tar-header-uname tar-hblock))
410 (gname (tar-header-gname tar-hblock))
411 (size (tar-header-size tar-hblock))
412 (time (tar-header-date tar-hblock))
8560523d 413 ;; (ck (tar-header-checksum tar-hblock))
139f2b7c
SM
414 (type (tar-header-link-type tar-hblock))
415 (link-name (tar-header-link-name tar-hblock)))
32d956a8 416 (format "%c%c%s %7s/%-7s %7s%s %s%s"
139f2b7c 417 (if mod-p ?* ? )
aa73f29c 418 (cond ((or (eq type nil) (eq type 0)) ?-)
6ee30a2a
RS
419 ((eq type 1) ?h) ; link
420 ((eq type 2) ?l) ; symlink
139f2b7c
SM
421 ((eq type 3) ?c) ; char special
422 ((eq type 4) ?b) ; block special
423 ((eq type 5) ?d) ; directory
424 ((eq type 6) ?p) ; FIFO/pipe
425 ((eq type 20) ?*) ; directory listing
f9580781 426 ((eq type 28) ?L) ; next has longname
139f2b7c
SM
427 ((eq type 29) ?M) ; multivolume continuation
428 ((eq type 35) ?S) ; sparse
429 ((eq type 38) ?V) ; volume header
133ecc54 430 ((eq type 55) ?H) ; extended pax header
e5d56b61 431 (t ?\s)
139f2b7c
SM
432 )
433 (tar-grind-file-mode mode)
434 (if (= 0 (length uname)) uid uname)
435 (if (= 0 (length gname)) gid gname)
436 size
437 (if tar-mode-show-date (tar-clip-time-string time) "")
a28eaf2c
EZ
438 (propertize name
439 'mouse-face 'highlight
440 'help-echo "mouse-2: extract this file into a buffer")
139f2b7c
SM
441 (if (or (eq type 1) (eq type 2))
442 (concat (if (= type 1) " ==> " " --> ") link-name)
443 ""))))
aa73f29c 444
27129192 445(defun tar-untar-buffer ()
643415c4 446 "Extract all archive members in the tar-file into the current directory."
27129192 447 (interactive)
f598e45e
SM
448 ;; FIXME: make it work even if we're not in tar-mode.
449 (let ((descriptors tar-parse-info)) ;Read the var in its buffer.
450 (with-current-buffer
451 (if (tar-data-swapped-p) tar-data-buffer (current-buffer))
452 (set-buffer-multibyte nil) ;Hopefully, a no-op.
453 (dolist (descriptor descriptors)
61bb55d0
SM
454 (let* ((name (tar-header-name descriptor))
455 (dir (if (eq (tar-header-link-type descriptor) 5)
f598e45e
SM
456 name
457 (file-name-directory name)))
61bb55d0
SM
458 (start (tar-header-data-start descriptor))
459 (end (+ start (tar-header-size descriptor))))
f598e45e
SM
460 (unless (file-directory-p name)
461 (message "Extracting %s" name)
462 (if (and dir (not (file-exists-p dir)))
463 (make-directory dir t))
464 (unless (file-directory-p name)
465 (write-region start end name))
61bb55d0 466 (set-file-modes name (tar-header-mode descriptor))))))))
27129192 467
aa73f29c 468(defun tar-summarize-buffer ()
61bb55d0 469 "Parse the contents of the tar file in the current buffer."
f598e45e
SM
470 (assert (tar-data-swapped-p))
471 (let* ((modified (buffer-modified-p))
472 (result '())
473 (pos (point-min))
d3a36099 474 (coding tar-file-name-coding-system)
f598e45e 475 (progress-reporter
dd798c64
SM
476 (with-current-buffer tar-data-buffer
477 (make-progress-reporter "Parsing tar file..."
478 (point-min) (point-max))))
61bb55d0 479 descriptor)
f598e45e 480 (with-current-buffer tar-data-buffer
c40d3365 481 (while (and (<= (+ pos 512) (point-max))
d3a36099 482 (setq descriptor (tar-header-block-tokenize pos coding)))
61bb55d0 483 (let ((size (tar-header-size descriptor)))
c40d3365
MB
484 (if (< size 0)
485 (error "%s has size %s - corrupted"
58d6a142
SM
486 (tar-header-name descriptor) size)))
487 ;;
488 ;; This is just too slow. Don't really need it anyway....
489 ;;(tar-header-block-check-checksum
490 ;; hblock (tar-header-block-checksum hblock)
491 ;; (tar-header-name descriptor))
492
493 (push descriptor result)
494 (setq pos (tar-header-data-end descriptor))
495 (progress-reporter-update progress-reporter pos)))
496
61bb55d0 497 (set (make-local-variable 'tar-parse-info) (nreverse result))
f598e45e
SM
498 ;; A tar file should end with a block or two of nulls,
499 ;; but let's not get a fatal error if it doesn't.
61bb55d0 500 (if (null descriptor)
f598e45e
SM
501 (progress-reporter-done progress-reporter)
502 (message "Warning: premature EOF parsing tar file"))
aa73f29c 503 (goto-char (point-min))
c40d3365 504 (let ((inhibit-read-only t)
c40d3365 505 (total-summaries
61bb55d0 506 (mapconcat 'tar-header-block-summarize tar-parse-info "\n")))
c40d3365 507 (insert total-summaries "\n"))
c40d3365
MB
508 (goto-char (point-min))
509 (restore-buffer-modified-p modified)))
e865c5ce 510\f
c40d3365
MB
511(defvar tar-mode-map
512 (let ((map (make-keymap)))
513 (suppress-keymap map)
514 (define-key map " " 'tar-next-line)
515 (define-key map "C" 'tar-copy)
516 (define-key map "d" 'tar-flag-deleted)
517 (define-key map "\^D" 'tar-flag-deleted)
518 (define-key map "e" 'tar-extract)
519 (define-key map "f" 'tar-extract)
520 (define-key map "\C-m" 'tar-extract)
521 (define-key map [mouse-2] 'tar-mouse-extract)
522 (define-key map "g" 'revert-buffer)
523 (define-key map "h" 'describe-mode)
524 (define-key map "n" 'tar-next-line)
525 (define-key map "\^N" 'tar-next-line)
526 (define-key map [down] 'tar-next-line)
527 (define-key map "o" 'tar-extract-other-window)
528 (define-key map "p" 'tar-previous-line)
529 (define-key map "q" 'quit-window)
530 (define-key map "\^P" 'tar-previous-line)
531 (define-key map [up] 'tar-previous-line)
532 (define-key map "R" 'tar-rename-entry)
533 (define-key map "u" 'tar-unflag)
534 (define-key map "v" 'tar-view)
535 (define-key map "x" 'tar-expunge)
536 (define-key map "\177" 'tar-unflag-backwards)
537 (define-key map "E" 'tar-extract-other-window)
538 (define-key map "M" 'tar-chmod-entry)
539 (define-key map "G" 'tar-chgrp-entry)
540 (define-key map "O" 'tar-chown-entry)
7fe7479d
SM
541 ;; Let mouse-1 follow the link.
542 (define-key map [follow-link] 'mouse-face)
53ad7bee 543
c40d3365 544 ;; Make menu bar items.
e865c5ce 545
c40d3365
MB
546 ;; Get rid of the Edit menu bar item to save space.
547 (define-key map [menu-bar edit] 'undefined)
e865c5ce 548
c40d3365 549 (define-key map [menu-bar immediate]
53ad7bee 550 (cons "Immediate" (make-sparse-keymap "Immediate")))
e865c5ce 551
c40d3365 552 (define-key map [menu-bar immediate view]
53ad7bee 553 '("View This File" . tar-view))
c40d3365 554 (define-key map [menu-bar immediate display]
53ad7bee 555 '("Display in Other Window" . tar-display-other-window))
c40d3365 556 (define-key map [menu-bar immediate find-file-other-window]
53ad7bee 557 '("Find in Other Window" . tar-extract-other-window))
c40d3365 558 (define-key map [menu-bar immediate find-file]
53ad7bee 559 '("Find This File" . tar-extract))
e865c5ce 560
c40d3365 561 (define-key map [menu-bar mark]
53ad7bee 562 (cons "Mark" (make-sparse-keymap "Mark")))
e865c5ce 563
c40d3365 564 (define-key map [menu-bar mark unmark-all]
53ad7bee 565 '("Unmark All" . tar-clear-modification-flags))
c40d3365 566 (define-key map [menu-bar mark deletion]
53ad7bee 567 '("Flag" . tar-flag-deleted))
c40d3365 568 (define-key map [menu-bar mark unmark]
53ad7bee 569 '("Unflag" . tar-unflag))
e865c5ce 570
c40d3365 571 (define-key map [menu-bar operate]
53ad7bee 572 (cons "Operate" (make-sparse-keymap "Operate")))
e865c5ce 573
c40d3365 574 (define-key map [menu-bar operate chown]
53ad7bee 575 '("Change Owner..." . tar-chown-entry))
c40d3365 576 (define-key map [menu-bar operate chgrp]
53ad7bee 577 '("Change Group..." . tar-chgrp-entry))
c40d3365 578 (define-key map [menu-bar operate chmod]
53ad7bee 579 '("Change Mode..." . tar-chmod-entry))
c40d3365 580 (define-key map [menu-bar operate rename]
53ad7bee 581 '("Rename to..." . tar-rename-entry))
c40d3365 582 (define-key map [menu-bar operate copy]
53ad7bee 583 '("Copy to..." . tar-copy))
c40d3365 584 (define-key map [menu-bar operate expunge]
53ad7bee
SM
585 '("Expunge Marked Files" . tar-expunge))
586 \f
c40d3365
MB
587 map)
588 "Local keymap for Tar mode listings.")
589
590\f
aa73f29c
RS
591;; tar mode is suitable only for specially formatted data.
592(put 'tar-mode 'mode-class 'special)
593(put 'tar-subfile-mode 'mode-class 'special)
594
f598e45e
SM
595(defun tar-change-major-mode-hook ()
596 ;; Bring the actual Tar data back into the main buffer.
d3a36099 597 (when (tar-data-swapped-p) (tar-swap-data))
f598e45e
SM
598 ;; Throw away the summary.
599 (when (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
600
601(defun tar-mode-kill-buffer-hook ()
602 (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
603
bdd53bbc 604;;;###autoload
a91c76d6 605(define-derived-mode tar-mode nil "Tar"
aa73f29c 606 "Major mode for viewing a tar file as a dired-like listing of its contents.
f1180544 607You can move around using the usual cursor motion commands.
aa73f29c 608Letters no longer insert themselves.
439fa06f
RS
609Type `e' to pull a file out of the tar file and into its own buffer;
610or click mouse-2 on the file's line in the Tar mode buffer.
e865c5ce 611Type `c' to copy an entry from the tar file into another file on disk.
aa73f29c 612
f1180544 613If you edit a sub-file of this archive (as with the `e' command) and
8560523d 614save it with \\[save-buffer], the contents of that buffer will be
f1180544 615saved back into the tar-file buffer; in this way you can edit a file
aa73f29c
RS
616inside of a tar archive without extracting it and re-archiving it.
617
e865c5ce 618See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
aa73f29c
RS
619\\{tar-mode-map}"
620 ;; this is not interactive because you shouldn't be turning this
621 ;; mode on and off. You can corrupt things that way.
1c0b3743
RS
622 ;; rms: with permanent locals, it should now be possible to make this work
623 ;; interactively in some reasonable fashion.
aa73f29c 624 (make-local-variable 'tar-parse-info)
a91c76d6 625 (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
a91c76d6
SM
626 (set (make-local-variable 'local-enable-local-variables) nil)
627 (set (make-local-variable 'next-line-add-newlines) nil)
d26e6665
KH
628 (set (make-local-variable 'tar-file-name-coding-system)
629 (or file-name-coding-system
630 default-file-name-coding-system
631 locale-coding-system))
b9ca3cdb 632 ;; Prevent loss of data when saving the file.
a91c76d6 633 (set (make-local-variable 'file-precious-flag) t)
03b00795 634 (buffer-disable-undo)
aa73f29c 635 (widen)
f598e45e
SM
636 ;; Now move the Tar data into an auxiliary buffer, so we can use the main
637 ;; buffer for the summary.
638 (assert (not (tar-data-swapped-p)))
639 (set (make-local-variable 'revert-buffer-function) 'tar-mode-revert)
19eb68d0 640 (add-hook 'write-region-annotate-functions 'tar-write-region-annotate nil t)
f598e45e
SM
641 (add-hook 'kill-buffer-hook 'tar-mode-kill-buffer-hook nil t)
642 (add-hook 'change-major-mode-hook 'tar-change-major-mode-hook nil t)
643 ;; Tar data is made of bytes, not chars.
58d6a142 644 (set-buffer-multibyte nil) ;Hopefully a no-op.
f598e45e
SM
645 (set (make-local-variable 'tar-data-buffer)
646 (generate-new-buffer (format " *tar-data %s*"
647 (file-name-nondirectory
648 (or buffer-file-name (buffer-name))))))
d3a36099 649 (tar-swap-data)
f598e45e
SM
650 (tar-summarize-buffer)
651 (tar-next-line 0))
aa73f29c
RS
652
653
654(defun tar-subfile-mode (p)
655 "Minor mode for editing an element of a tar-file.
76605277
RS
656This mode arranges for \"saving\" this buffer to write the data
657into the tar-file buffer that it came from. The changes will actually
658appear on disk when you save the tar-file's buffer."
aa73f29c 659 (interactive "P")
0f8becaa 660 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
e865c5ce 661 (error "This buffer is not an element of a tar file"))
643415c4
SM
662 ;; Don't do this, because it is redundant and wastes mode line space.
663 ;; (or (assq 'tar-subfile-mode minor-mode-alist)
664 ;; (setq minor-mode-alist (append minor-mode-alist
665 ;; (list '(tar-subfile-mode " TarFile")))))
aa73f29c
RS
666 (make-local-variable 'tar-subfile-mode)
667 (setq tar-subfile-mode
668 (if (null p)
669 (not tar-subfile-mode)
670 (> (prefix-numeric-value p) 0)))
671 (cond (tar-subfile-mode
76bf6666 672 (add-hook 'write-file-functions 'tar-subfile-save-buffer nil t)
aa73f29c 673 ;; turn off auto-save.
75238436 674 (auto-save-mode -1)
aa73f29c
RS
675 (setq buffer-auto-save-file-name nil)
676 (run-hooks 'tar-subfile-mode-hook))
e865c5ce 677 (t
76bf6666 678 (remove-hook 'write-file-functions 'tar-subfile-save-buffer t))))
aa73f29c
RS
679
680
e865c5ce 681;; Revert the buffer and recompute the dired-like listing.
f6b0805a 682(defun tar-mode-revert (&optional no-auto-save no-confirm)
f598e45e
SM
683 (unwind-protect
684 (let ((revert-buffer-function nil))
d3a36099 685 (if (tar-data-swapped-p) (tar-swap-data))
f598e45e
SM
686 ;; FIXME: If we ask for confirmation, the user will be temporarily
687 ;; looking at the raw data.
688 (revert-buffer no-auto-save no-confirm 'preserve-modes)
f598e45e 689 ;; Recompute the summary.
d3a36099 690 (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer))
f598e45e 691 (tar-mode))
d3a36099 692 (unless (tar-data-swapped-p) (tar-swap-data))))
aa73f29c
RS
693
694
210f943e
PJ
695(defun tar-next-line (arg)
696 "Move cursor vertically down ARG lines and to the start of the filename."
aa73f29c 697 (interactive "p")
210f943e 698 (forward-line arg)
58d6a142 699 (goto-char (or (next-single-property-change (point) 'mouse-face) (point))))
aa73f29c 700
210f943e
PJ
701(defun tar-previous-line (arg)
702 "Move cursor vertically up ARG lines and to the start of the filename."
aa73f29c 703 (interactive "p")
210f943e 704 (tar-next-line (- arg)))
aa73f29c
RS
705
706(defun tar-current-descriptor (&optional noerror)
e865c5ce 707 "Return the tar-descriptor of the current line, or signals an error."
aa73f29c 708 ;; I wish lines had plists, like in ZMACS...
f598e45e 709 (or (nth (count-lines (point-min) (line-beginning-position))
aa73f29c
RS
710 tar-parse-info)
711 (if noerror
712 nil
439fa06f 713 (error "This line does not describe a tar-file entry"))))
aa73f29c 714
439fa06f
RS
715(defun tar-get-descriptor ()
716 (let* ((descriptor (tar-current-descriptor))
61bb55d0
SM
717 (size (tar-header-size descriptor))
718 (link-p (tar-header-link-type descriptor)))
439fa06f 719 (if link-p
bf65c664
CY
720 (error "This is %s, not a real file"
721 (cond ((eq link-p 5) "a directory")
722 ((eq link-p 20) "a tar directory header")
723 ((eq link-p 28) "a next has longname")
724 ((eq link-p 29) "a multivolume-continuation")
725 ((eq link-p 35) "a sparse entry")
726 ((eq link-p 38) "a volume header")
727 ((eq link-p 55) "an extended pax header")
728 (t "a link"))))
f09bbd93 729 (if (zerop size) (message "This is a zero-length file"))
439fa06f
RS
730 descriptor))
731
732(defun tar-mouse-extract (event)
733 "Extract a file whose tar directory line you click on."
734 (interactive "e")
53ad7bee 735 (with-current-buffer (window-buffer (posn-window (event-end event)))
439fa06f
RS
736 (save-excursion
737 (goto-char (posn-point (event-end event)))
738 ;; Just make sure this doesn't get an error.
739 (tar-get-descriptor)))
740 (select-window (posn-window (event-end event)))
741 (goto-char (posn-point (event-end event)))
742 (tar-extract))
aa73f29c 743
07e7a05a
EZ
744(defun tar-file-name-handler (op &rest args)
745 "Helper function for `tar-extract'."
746 (or (eq op 'file-exists-p)
747 (let ((file-name-handler-alist nil))
748 (apply op args))))
749
aa73f29c 750(defun tar-extract (&optional other-window-p)
628d6cef 751 "In Tar mode, extract this entry of the tar file into its own buffer."
aa73f29c
RS
752 (interactive)
753 (let* ((view-p (eq other-window-p 'view))
439fa06f 754 (descriptor (tar-get-descriptor))
61bb55d0
SM
755 (name (tar-header-name descriptor))
756 (size (tar-header-size descriptor))
757 (start (tar-header-data-start descriptor))
aa73f29c 758 (end (+ start size)))
aa73f29c 759 (let* ((tar-buffer (current-buffer))
38c6e0c7 760 (tarname (buffer-name))
e8421604
GM
761 (bufname (concat (file-name-nondirectory name)
762 " ("
6da7ea56 763 tarname
e8421604 764 ")"))
aa73f29c 765 (read-only-p (or buffer-read-only view-p))
38c6e0c7
AS
766 (new-buffer-file-name (expand-file-name
767 ;; `:' is not allowed on Windows
e8421604
GM
768 (concat tarname "!" name)))
769 (buffer (get-file-buffer new-buffer-file-name))
d26e6665 770 (just-created nil)
8e69f4d8 771 undo-list)
e8421604 772 (unless buffer
38c6e0c7 773 (setq buffer (generate-new-buffer bufname))
53ad7bee 774 (with-current-buffer buffer
8e69f4d8
KH
775 (setq undo-list buffer-undo-list
776 buffer-undo-list t))
38c6e0c7 777 (setq bufname (buffer-name buffer))
aa73f29c 778 (setq just-created t)
f598e45e
SM
779 (with-current-buffer tar-data-buffer
780 (let (coding)
781 (narrow-to-region start end)
782 (goto-char start)
783 (setq coding (or coding-system-for-read
784 (and set-auto-coding-function
785 (funcall set-auto-coding-function
786 name (- end start)))
787 ;; The following binding causes
788 ;; find-buffer-file-type-coding-system
789 ;; (defined on dos-w32.el) to act as if
790 ;; the file being extracted existed, so
791 ;; that the file's contents' encoding and
792 ;; EOL format are auto-detected.
793 (let ((file-name-handler-alist
794 '(("" . tar-file-name-handler))))
795 (car (find-operation-coding-system
796 'insert-file-contents
797 (cons name (current-buffer)) t)))))
798 (if (or (not coding)
799 (eq (coding-system-type coding) 'undecided))
800 (setq coding (detect-coding-region start end t)))
801 (if (and default-enable-multibyte-characters
802 (coding-system-get coding :for-unibyte))
803 (with-current-buffer buffer
804 (set-buffer-multibyte nil)))
805 (widen)
806 (decode-coding-region start end coding buffer)))
807 (with-current-buffer buffer
808 (goto-char (point-min))
809 (setq buffer-file-name new-buffer-file-name)
810 (setq buffer-file-truename
811 (abbreviate-file-name buffer-file-name))
812 ;; Force buffer-file-coding-system to what
813 ;; decode-coding-region actually used.
814 (set-buffer-file-coding-system last-coding-system-used t)
815 ;; Set the default-directory to the dir of the
816 ;; superior buffer.
817 (setq default-directory
818 (with-current-buffer tar-buffer
819 default-directory))
820 (normal-mode) ; pick a mode.
821 (rename-buffer bufname)
822 (make-local-variable 'tar-superior-buffer)
823 (make-local-variable 'tar-superior-descriptor)
824 (setq tar-superior-buffer tar-buffer)
825 (setq tar-superior-descriptor descriptor)
826 (setq buffer-read-only read-only-p)
827 (set-buffer-modified-p nil)
828 (setq buffer-undo-list undo-list)
829 (tar-subfile-mode 1)))
aa73f29c 830 (if view-p
a51b80e7
MR
831 (view-buffer
832 buffer (and just-created 'kill-buffer-if-not-modified))
e865c5ce
RS
833 (if (eq other-window-p 'display)
834 (display-buffer buffer)
835 (if other-window-p
836 (switch-to-buffer-other-window buffer)
837 (switch-to-buffer buffer)))))))
aa73f29c
RS
838
839
840(defun tar-extract-other-window ()
8560523d 841 "In Tar mode, find this entry of the tar file in another window."
aa73f29c
RS
842 (interactive)
843 (tar-extract t))
844
e865c5ce 845(defun tar-display-other-window ()
8560523d 846 "In Tar mode, display this entry of the tar file in another window."
e865c5ce
RS
847 (interactive)
848 (tar-extract 'display))
849
aa73f29c 850(defun tar-view ()
8560523d 851 "In Tar mode, view the tar file entry on this line."
aa73f29c
RS
852 (interactive)
853 (tar-extract 'view))
854
855
856(defun tar-read-file-name (&optional prompt)
e865c5ce 857 "Read a file name with this line's entry as the default."
aa73f29c
RS
858 (or prompt (setq prompt "Copy to: "))
859 (let* ((default-file (expand-file-name
61bb55d0 860 (tar-header-name (tar-current-descriptor))))
aa73f29c
RS
861 (target (expand-file-name
862 (read-file-name prompt
863 (file-name-directory default-file)
864 default-file nil))))
865 (if (or (string= "" (file-name-nondirectory target))
866 (file-directory-p target))
867 (setq target (concat (if (string-match "/$" target)
868 (substring target 0 (1- (match-end 0)))
869 target)
870 "/"
871 (file-name-nondirectory default-file))))
872 target))
873
874
875(defun tar-copy (&optional to-file)
8560523d 876 "In Tar mode, extract this entry of the tar file into a file on disk.
aa73f29c
RS
877If TO-FILE is not supplied, it is prompted for, defaulting to the name of
878the current tar-entry."
879 (interactive (list (tar-read-file-name)))
439fa06f 880 (let* ((descriptor (tar-get-descriptor))
61bb55d0
SM
881 (name (tar-header-name descriptor))
882 (size (tar-header-size descriptor))
883 (start (tar-header-data-start descriptor))
d4ec0200
RS
884 (end (+ start size))
885 (inhibit-file-name-handlers inhibit-file-name-handlers)
886 (inhibit-file-name-operation inhibit-file-name-operation))
6a608e8e
KH
887 (save-restriction
888 (widen)
d4ec0200
RS
889 ;; Inhibit compressing a subfile again if *both* name and
890 ;; to-file are handled by jka-compr
891 (if (and (eq (find-file-name-handler name 'write-region) 'jka-compr-handler)
892 (eq (find-file-name-handler to-file 'write-region) 'jka-compr-handler))
893 (setq inhibit-file-name-handlers
894 (cons 'jka-compr-handler
895 (and (eq inhibit-file-name-operation 'write-region)
896 inhibit-file-name-handlers))
897 inhibit-file-name-operation 'write-region))
d26e6665
KH
898 (let ((coding-system-for-write 'no-conversion))
899 (write-region start end to-file nil nil nil t)))
6a608e8e 900 (message "Copied tar entry %s to %s" name to-file)))
aa73f29c
RS
901
902(defun tar-flag-deleted (p &optional unflag)
8560523d 903 "In Tar mode, mark this sub-file to be deleted from the tar file.
aa73f29c
RS
904With a prefix argument, mark that many files."
905 (interactive "p")
906 (beginning-of-line)
8560523d 907 (dotimes (i (abs p))
aa73f29c
RS
908 (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
909 (progn
910 (delete-char 1)
911 (insert (if unflag " " "D"))))
912 (forward-line (if (< p 0) -1 1)))
913 (if (eobp) nil (forward-char 36)))
914
915(defun tar-unflag (p)
8560523d 916 "In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
917With a prefix argument, un-mark that many files forward."
918 (interactive "p")
919 (tar-flag-deleted p t))
920
921(defun tar-unflag-backwards (p)
8560523d 922 "In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
923With a prefix argument, un-mark that many files backward."
924 (interactive "p")
925 (tar-flag-deleted (- p) t))
926
927
928(defun tar-expunge-internal ()
929 "Expunge the tar-entry specified by the current line."
58d6a142 930 (let ((descriptor (tar-current-descriptor)))
aa73f29c
RS
931 ;;
932 ;; delete the current line...
f598e45e 933 (delete-region (line-beginning-position) (line-beginning-position 2))
aa73f29c
RS
934 ;;
935 ;; delete the data pointer...
936 (setq tar-parse-info (delq descriptor tar-parse-info))
937 ;;
938 ;; delete the data from inside the file...
58d6a142
SM
939 (with-current-buffer tar-data-buffer
940 (delete-region (or (tar-header-header-start descriptor)
941 (- (tar-header-data-start descriptor) 512))
942 (tar-header-data-end descriptor)))))
aa73f29c
RS
943
944
945(defun tar-expunge (&optional noconfirm)
8560523d 946 "In Tar mode, delete all the archived files flagged for deletion.
aa73f29c
RS
947This does not modify the disk image; you must save the tar file itself
948for this to be permanent."
949 (interactive)
950 (if (or noconfirm
67501c01 951 (y-or-n-p "Expunge files marked for deletion? "))
d26e6665 952 (let ((n 0))
aa73f29c 953 (save-excursion
cb33a0ce 954 (goto-char (point-min))
aa73f29c
RS
955 (while (not (eobp))
956 (if (looking-at "D")
957 (progn (tar-expunge-internal)
958 (setq n (1+ n)))
959 (forward-line 1)))
960 ;; after doing the deletions, add any padding that may be necessary.
f598e45e 961 (tar-pad-to-blocksize))
aa73f29c 962 (if (zerop n)
67501c01
RS
963 (message "Nothing to expunge.")
964 (message "%s files expunged. Be sure to save this buffer." n)))))
aa73f29c
RS
965
966
967(defun tar-clear-modification-flags ()
e865c5ce 968 "Remove the stars at the beginning of each line."
a7e5e8cb 969 (interactive)
aa73f29c 970 (save-excursion
cb33a0ce 971 (goto-char (point-min))
f598e45e 972 (while (not (eobp))
e5d56b61 973 (if (not (eq (following-char) ?\s))
aa73f29c
RS
974 (progn (delete-char 1) (insert " ")))
975 (forward-line 1))))
976
977
978(defun tar-chown-entry (new-uid)
8560523d 979 "Change the user-id associated with this entry in the tar file.
aa73f29c
RS
980If this tar file was written by GNU tar, then you will be able to edit
981the user id as a string; otherwise, you must edit it as a number.
982You can force editing as a number by calling this with a prefix arg.
983This does not modify the disk image; you must save the tar file itself
984for this to be permanent."
61bb55d0
SM
985 (interactive
986 (list
987 (let ((descriptor (tar-current-descriptor)))
988 (if (or current-prefix-arg
989 (not (tar-header-magic descriptor)))
990 (read-number
991 "New UID number: "
992 (format "%s" (tar-header-uid descriptor)))
993 (read-string "New UID string: " (tar-header-uname descriptor))))))
aa73f29c 994 (cond ((stringp new-uid)
61bb55d0 995 (setf (tar-header-uname (tar-current-descriptor)) new-uid)
aa73f29c
RS
996 (tar-alter-one-field tar-uname-offset (concat new-uid "\000")))
997 (t
61bb55d0 998 (setf (tar-header-uid (tar-current-descriptor)) new-uid)
aa73f29c
RS
999 (tar-alter-one-field tar-uid-offset
1000 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
1001
1002
1003(defun tar-chgrp-entry (new-gid)
8560523d 1004 "Change the group-id associated with this entry in the tar file.
aa73f29c
RS
1005If this tar file was written by GNU tar, then you will be able to edit
1006the group id as a string; otherwise, you must edit it as a number.
1007You can force editing as a number by calling this with a prefix arg.
1008This does not modify the disk image; you must save the tar file itself
1009for this to be permanent."
61bb55d0
SM
1010 (interactive
1011 (list
1012 (let ((descriptor (tar-current-descriptor)))
1013 (if (or current-prefix-arg
1014 (not (tar-header-magic descriptor)))
1015 (read-number
1016 "New GID number: "
1017 (format "%s" (tar-header-gid descriptor)))
1018 (read-string "New GID string: " (tar-header-gname descriptor))))))
aa73f29c 1019 (cond ((stringp new-gid)
61bb55d0 1020 (setf (tar-header-gname (tar-current-descriptor)) new-gid)
aa73f29c
RS
1021 (tar-alter-one-field tar-gname-offset
1022 (concat new-gid "\000")))
1023 (t
61bb55d0 1024 (setf (tar-header-gid (tar-current-descriptor)) new-gid)
aa73f29c
RS
1025 (tar-alter-one-field tar-gid-offset
1026 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
1027
1028(defun tar-rename-entry (new-name)
8560523d 1029 "Change the name associated with this entry in the tar file.
aa73f29c
RS
1030This does not modify the disk image; you must save the tar file itself
1031for this to be permanent."
1032 (interactive
1033 (list (read-string "New name: "
61bb55d0 1034 (tar-header-name (tar-current-descriptor)))))
439fa06f 1035 (if (string= "" new-name) (error "zero length name"))
d26e6665 1036 (let ((encoded-new-name (encode-coding-string new-name
58d6a142
SM
1037 tar-file-name-coding-system))
1038 (descriptor (tar-current-descriptor))
1039 (prefix nil))
1040 (when (tar-header-header-start descriptor)
1041 ;; FIXME: Make it work for ././@LongLink.
1042 (error "Rename with @LongLink format is not implemented"))
1043
1044 (when (and (> (length encoded-new-name) 98)
1045 (string-match "/" encoded-new-name
1046 (- (length encoded-new-name) 99))
1047 (< (match-beginning 0) 155))
1048 (unless (equal (tar-header-magic descriptor) "ustar\0\0")
1049 (tar-alter-one-field tar-magic-offset "ustar\0\0"))
1050 (setq prefix (substring encoded-new-name 0 (match-beginning 0)))
1051 (setq encoded-new-name (substring encoded-new-name (match-end 0))))
1052
d26e6665 1053 (if (> (length encoded-new-name) 98) (error "name too long"))
58d6a142 1054 (setf (tar-header-name descriptor) new-name)
d26e6665 1055 (tar-alter-one-field 0
58d6a142
SM
1056 (substring (concat encoded-new-name (make-string 99 0)) 0 99))
1057 (if prefix
1058 (tar-alter-one-field tar-prefix-offset
1059 (substring (concat prefix (make-string 155 0)) 0 155)))))
aa73f29c
RS
1060
1061
1062(defun tar-chmod-entry (new-mode)
c40d3365 1063 "Change the protection bits associated with this entry in the tar file.
aa73f29c
RS
1064This does not modify the disk image; you must save the tar file itself
1065for this to be permanent."
1066 (interactive (list (tar-parse-octal-integer-safe
1067 (read-string "New protection (octal): "))))
61bb55d0 1068 (setf (tar-header-mode (tar-current-descriptor)) new-mode)
aa73f29c
RS
1069 (tar-alter-one-field tar-mode-offset
1070 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1071
1072
58d6a142
SM
1073(defun tar-alter-one-field (data-position new-data-string &optional descriptor)
1074 (unless descriptor (setq descriptor (tar-current-descriptor)))
1075 ;;
1076 ;; update the header-line.
1077 (let ((col (current-column)))
1078 (delete-region (line-beginning-position)
1079 (prog2 (forward-line 1)
1080 (point)
1081 ;; Insert the new text after the old, before deleting,
1082 ;; to preserve markers such as the window start.
1083 (insert (tar-header-block-summarize descriptor) "\n")))
1084 (forward-line -1) (move-to-column col))
f598e45e 1085
58d6a142
SM
1086 (assert (tar-data-swapped-p))
1087 (with-current-buffer tar-data-buffer
1088 (let* ((start (- (tar-header-data-start descriptor) 512)))
f598e45e
SM
1089 ;;
1090 ;; delete the old field and insert a new one.
1091 (goto-char (+ start data-position))
1092 (delete-region (point) (+ (point) (length new-data-string))) ; <--
f598e45e
SM
1093 (assert (not (or enable-multibyte-characters
1094 (multibyte-string-p new-data-string))))
1095 (insert new-data-string)
1096 ;;
1097 ;; compute a new checksum and insert it.
1098 (let ((chk (tar-header-block-checksum
58d6a142
SM
1099 (buffer-substring start (+ start 512)))))
1100 (goto-char (+ start tar-chk-offset))
1101 (delete-region (point) (+ (point) 8))
1102 (insert (format "%6o\0 " chk))
1103 (setf (tar-header-checksum descriptor) chk)
1104 ;;
1105 ;; ok, make sure we didn't botch it.
1106 (tar-header-block-check-checksum
1107 (buffer-substring start (+ start 512))
1108 chk (tar-header-name descriptor))
1109 ))))
aa73f29c
RS
1110
1111
3d7fc2fb
ER
1112(defun tar-octal-time (timeval)
1113 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1114 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
516f7fca
EZ
1115 (format "%05o%01o%05o"
1116 (lsh hibits -2)
1117 (logior (lsh (logand 3 hibits) 1)
1118 (if (> (logand lobits 32768) 0) 1 0))
1119 (logand 32767 lobits)
1120 )))
3d7fc2fb 1121
aa73f29c 1122(defun tar-subfile-save-buffer ()
e865c5ce
RS
1123 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1124This doesn't write anything to disk; you must save the parent tar-file buffer
aa73f29c
RS
1125to make your changes permanent."
1126 (interactive)
0f8becaa 1127 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
f598e45e 1128 (error "This buffer has no superior tar file buffer"))
0f8becaa 1129 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
f598e45e 1130 (error "This buffer doesn't have an index into its superior tar file!"))
aa73f29c 1131 (let ((subfile (current-buffer))
f598e45e
SM
1132 (coding buffer-file-coding-system)
1133 (descriptor tar-superior-descriptor)
1134 subfile-size)
1135 (with-current-buffer tar-superior-buffer
61bb55d0
SM
1136 (let* ((start (tar-header-data-start descriptor))
1137 (name (tar-header-name descriptor))
1138 (size (tar-header-size descriptor))
dd798c64 1139 (head (memq descriptor tar-parse-info)))
f598e45e
SM
1140 (if (not head)
1141 (error "Can't find this tar file entry in its parent tar file!"))
1142 (with-current-buffer tar-data-buffer
1143 ;; delete the old data...
1144 (let* ((data-start start)
61bb55d0 1145 (data-end (+ data-start (tar-roundup-512 size))))
f598e45e
SM
1146 (narrow-to-region data-start data-end)
1147 (delete-region (point-min) (point-max))
1148 ;; insert the new data...
1149 (goto-char data-start)
1150 (let ((dest (current-buffer)))
1151 (with-current-buffer subfile
1152 (save-restriction
1153 (widen)
1154 (encode-coding-region (point-min) (point-max) coding dest))))
1155 (setq subfile-size (- (point-max) (point-min)))
1156 ;;
1157 ;; pad the new data out to a multiple of 512...
61bb55d0 1158 (let ((subfile-size-pad (tar-roundup-512 subfile-size)))
f598e45e
SM
1159 (goto-char (point-max))
1160 (insert (make-string (- subfile-size-pad subfile-size) 0))
1161 ;;
61bb55d0
SM
1162 ;; update the data of this files...
1163 (setf (tar-header-size descriptor) subfile-size)
f598e45e
SM
1164 ;;
1165 ;; Update the size field in the header block.
58d6a142 1166 (widen))))
f598e45e 1167 ;;
58d6a142 1168 ;; alter the descriptor-line and header
f598e45e
SM
1169 ;;
1170 (let ((position (- (length tar-parse-info) (length head))))
1171 (goto-char (point-min))
1172 (forward-line position)
58d6a142
SM
1173 (tar-alter-one-field tar-size-offset (format "%11o " subfile-size))
1174 ;;
1175 ;; Maybe update the datestamp.
1176 (when tar-update-datestamp
1177 (tar-alter-one-field tar-time-offset
1178 (concat (tar-octal-time (current-time)) " "))))
f598e45e
SM
1179 ;; After doing the insertion, add any necessary final padding.
1180 (tar-pad-to-blocksize))
1181 (set-buffer-modified-p t) ; mark the tar file as modified
1182 (tar-next-line 0))
1183 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
67501c01 1184 (message "Saved into tar-buffer `%s'. Be sure to save that buffer!"
f598e45e 1185 (buffer-name tar-superior-buffer))
47414bc1
RS
1186 ;; Prevent basic-save-buffer from changing our coding-system.
1187 (setq last-coding-system-used buffer-file-coding-system)
e865c5ce 1188 ;; Prevent ordinary saving from happening.
f598e45e 1189 t))
aa73f29c
RS
1190
1191
1b33e237 1192;; When this function is called, it is sure that the buffer is unibyte.
aa73f29c
RS
1193(defun tar-pad-to-blocksize ()
1194 "If we are being anal about tar file blocksizes, fix up the current buffer.
1195Leaves the region wide."
1196 (if (null tar-anal-blocksize)
1197 nil
aa73f29c 1198 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
61bb55d0
SM
1199 (start (tar-header-data-start last-desc))
1200 (link-p (tar-header-link-type last-desc))
1201 (size (if link-p 0 (tar-header-size last-desc)))
aa73f29c
RS
1202 (data-end (+ start size))
1203 (bbytes (ash tar-anal-blocksize 9))
f598e45e 1204 (pad-to (+ bbytes (* bbytes (/ (- data-end (point-min)) bbytes)))))
aa73f29c
RS
1205 ;; If the padding after the last data is too long, delete some;
1206 ;; else insert some until we are padded out to the right number of blocks.
1207 ;;
f598e45e
SM
1208 (with-current-buffer tar-data-buffer
1209 (let ((goal-end (+ (point-min) pad-to)))
1210 (if (> (point-max) goal-end)
1211 (delete-region goal-end (point-max))
1212 (goto-char (point-max))
1213 (insert (make-string (- goal-end (point-max)) ?\0))))))))
19eb68d0
SM
1214
1215
1216;; Used in write-region-annotate-functions to write tar-files out correctly.
1217(defun tar-write-region-annotate (start end)
1218 ;; When called from write-file (and auto-save), `start' is nil.
1219 ;; When called from M-x write-region, we assume the user wants to save
1220 ;; (part of) the summary, not the tar data.
1221 (unless (or start (not (tar-data-swapped-p)))
1222 (tar-clear-modification-flags)
1223 (set-buffer tar-data-buffer)
1224 nil))
1225
aa73f29c
RS
1226(provide 'tar-mode)
1227
8560523d 1228;; arch-tag: 8a585a4a-340e-42c2-89e7-d3b1013a4b78
c88ab9ce 1229;;; tar-mode.el ends here