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