Use mode-require-final-newline for idlwave.el and vera-mode.el.
[bpt/emacs.git] / lisp / tar-mode.el
CommitLineData
06b60517 1;;; tar-mode.el --- simple editing of tar files from GNU Emacs
aa73f29c 2
95df8112 3;; Copyright (C) 1990-1991, 1993-2011 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
f598e45e
SM
100(eval-when-compile (require 'cl))
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
145;; want to display may contain non-ascci chars, of course, so we'd like it
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
4062011e
SM
171 (assert (or (= (buffer-size tar-data-buffer) (buffer-size))
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
61bb55d0
SM
189(defstruct (tar-header
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"))
61bb55d0
SM
229 (assert (zerop (mod (- pos (point-min)) 512)))
230 (assert (not enable-multibyte-characters))
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))
328 (size (tar-header-size descriptor))
329 (fudge (cond
330 ;; Foo. There's an extra empty block after these.
331 ((memq link-type '(20 55)) 512)
332 (t 0))))
333 (+ data-start fudge
334 (if (and (null link-type) (> size 0))
335 (tar-roundup-512 size)
336 0))))
aa73f29c
RS
337
338(defun tar-parse-octal-integer (string &optional start end)
aa73f29c
RS
339 (if (null start) (setq start 0))
340 (if (null end) (setq end (length string)))
341 (if (= (aref string start) 0)
342 0
343 (let ((n 0))
344 (while (< start end)
345 (setq n (if (< (aref string start) ?0) n
30712209 346 (+ (* n 8) (- (aref string start) ?0)))
aa73f29c
RS
347 start (1+ start)))
348 n)))
349
30712209
RS
350(defun tar-parse-octal-long-integer (string &optional start end)
351 (if (null start) (setq start 0))
352 (if (null end) (setq end (length string)))
353 (if (= (aref string start) 0)
806cba9c 354 (list 0 0)
30712209
RS
355 (let ((lo 0)
356 (hi 0))
357 (while (< start end)
358 (if (>= (aref string start) ?0)
359 (setq lo (+ (* lo 8) (- (aref string start) ?0))
360 hi (+ (* hi 8) (ash lo -16))
361 lo (logand lo 65535)))
362 (setq start (1+ start)))
363 (list hi lo))))
364
aa73f29c 365(defun tar-parse-octal-integer-safe (string)
8560523d
SM
366 (if (zerop (length string)) (error "empty string"))
367 (mapc (lambda (c)
368 (if (or (< c ?0) (> c ?7))
369 (error "`%c' is not an octal digit" c)))
370 string)
aa73f29c
RS
371 (tar-parse-octal-integer string))
372
373
1bc28099 374(defun tar-header-block-checksum (string)
e865c5ce 375 "Compute and return a tar-acceptable checksum for this block."
61bb55d0 376 (assert (not (multibyte-string-p string)))
aa73f29c
RS
377 (let* ((chk-field-start tar-chk-offset)
378 (chk-field-end (+ chk-field-start 8))
379 (sum 0)
380 (i 0))
381 ;; Add up all of the characters except the ones in the checksum field.
382 ;; Add that field as if it were filled with spaces.
383 (while (< i chk-field-start)
384 (setq sum (+ sum (aref string i))
385 i (1+ i)))
386 (setq i chk-field-end)
387 (while (< i 512)
388 (setq sum (+ sum (aref string i))
389 i (1+ i)))
390 (+ sum (* 32 8))))
391
1bc28099 392(defun tar-header-block-check-checksum (hblock desired-checksum file-name)
aa73f29c 393 "Beep and print a warning if the checksum doesn't match."
1bc28099 394 (if (not (= desired-checksum (tar-header-block-checksum hblock)))
aa73f29c
RS
395 (progn (beep) (message "Invalid checksum for file %s!" file-name))))
396
30712209
RS
397(defun tar-clip-time-string (time)
398 (let ((str (current-time-string time)))
139f2b7c 399 (concat " " (substring str 4 16) (substring str 19 24))))
aa73f29c 400
139f2b7c
SM
401(defun tar-grind-file-mode (mode)
402 "Construct a `-rw--r--r--' string indicating MODE.
6a06ace6 403MODE should be an integer which is a file mode value."
139f2b7c
SM
404 (string
405 (if (zerop (logand 256 mode)) ?- ?r)
406 (if (zerop (logand 128 mode)) ?- ?w)
407 (if (zerop (logand 1024 mode)) (if (zerop (logand 64 mode)) ?- ?x) ?s)
408 (if (zerop (logand 32 mode)) ?- ?r)
409 (if (zerop (logand 16 mode)) ?- ?w)
410 (if (zerop (logand 2048 mode)) (if (zerop (logand 8 mode)) ?- ?x) ?s)
411 (if (zerop (logand 4 mode)) ?- ?r)
412 (if (zerop (logand 2 mode)) ?- ?w)
413 (if (zerop (logand 1 mode)) ?- ?x)))
aa73f29c 414
1bc28099 415(defun tar-header-block-summarize (tar-hblock &optional mod-p)
139f2b7c 416 "Return a line similar to the output of `tar -vtf'."
aa73f29c
RS
417 (let ((name (tar-header-name tar-hblock))
418 (mode (tar-header-mode tar-hblock))
419 (uid (tar-header-uid tar-hblock))
420 (gid (tar-header-gid tar-hblock))
421 (uname (tar-header-uname tar-hblock))
422 (gname (tar-header-gname tar-hblock))
423 (size (tar-header-size tar-hblock))
424 (time (tar-header-date tar-hblock))
8560523d 425 ;; (ck (tar-header-checksum tar-hblock))
139f2b7c
SM
426 (type (tar-header-link-type tar-hblock))
427 (link-name (tar-header-link-name tar-hblock)))
32d956a8 428 (format "%c%c%s %7s/%-7s %7s%s %s%s"
139f2b7c 429 (if mod-p ?* ? )
aa73f29c 430 (cond ((or (eq type nil) (eq type 0)) ?-)
6ee30a2a
RS
431 ((eq type 1) ?h) ; link
432 ((eq type 2) ?l) ; symlink
139f2b7c
SM
433 ((eq type 3) ?c) ; char special
434 ((eq type 4) ?b) ; block special
435 ((eq type 5) ?d) ; directory
436 ((eq type 6) ?p) ; FIFO/pipe
437 ((eq type 20) ?*) ; directory listing
f9580781 438 ((eq type 28) ?L) ; next has longname
139f2b7c
SM
439 ((eq type 29) ?M) ; multivolume continuation
440 ((eq type 35) ?S) ; sparse
441 ((eq type 38) ?V) ; volume header
133ecc54 442 ((eq type 55) ?H) ; extended pax header
e5d56b61 443 (t ?\s)
139f2b7c
SM
444 )
445 (tar-grind-file-mode mode)
446 (if (= 0 (length uname)) uid uname)
447 (if (= 0 (length gname)) gid gname)
448 size
449 (if tar-mode-show-date (tar-clip-time-string time) "")
a28eaf2c
EZ
450 (propertize name
451 'mouse-face 'highlight
452 'help-echo "mouse-2: extract this file into a buffer")
139f2b7c
SM
453 (if (or (eq type 1) (eq type 2))
454 (concat (if (= type 1) " ==> " " --> ") link-name)
455 ""))))
aa73f29c 456
27129192 457(defun tar-untar-buffer ()
643415c4 458 "Extract all archive members in the tar-file into the current directory."
27129192 459 (interactive)
f598e45e
SM
460 ;; FIXME: make it work even if we're not in tar-mode.
461 (let ((descriptors tar-parse-info)) ;Read the var in its buffer.
462 (with-current-buffer
463 (if (tar-data-swapped-p) tar-data-buffer (current-buffer))
464 (set-buffer-multibyte nil) ;Hopefully, a no-op.
465 (dolist (descriptor descriptors)
61bb55d0
SM
466 (let* ((name (tar-header-name descriptor))
467 (dir (if (eq (tar-header-link-type descriptor) 5)
f598e45e
SM
468 name
469 (file-name-directory name)))
61bb55d0
SM
470 (start (tar-header-data-start descriptor))
471 (end (+ start (tar-header-size descriptor))))
f598e45e
SM
472 (unless (file-directory-p name)
473 (message "Extracting %s" name)
474 (if (and dir (not (file-exists-p dir)))
475 (make-directory dir t))
476 (unless (file-directory-p name)
36c9fa27
J
477 (let ((coding-system-for-write 'no-conversion))
478 (write-region start end name)))
61bb55d0 479 (set-file-modes name (tar-header-mode descriptor))))))))
27129192 480
aa73f29c 481(defun tar-summarize-buffer ()
61bb55d0 482 "Parse the contents of the tar file in the current buffer."
f598e45e
SM
483 (assert (tar-data-swapped-p))
484 (let* ((modified (buffer-modified-p))
485 (result '())
486 (pos (point-min))
d3a36099 487 (coding tar-file-name-coding-system)
f598e45e 488 (progress-reporter
dd798c64
SM
489 (with-current-buffer tar-data-buffer
490 (make-progress-reporter "Parsing tar file..."
491 (point-min) (point-max))))
61bb55d0 492 descriptor)
f598e45e 493 (with-current-buffer tar-data-buffer
dc4e3ccc 494 (while (and (< pos (point-max))
d3a36099 495 (setq descriptor (tar-header-block-tokenize pos coding)))
61bb55d0 496 (let ((size (tar-header-size descriptor)))
c40d3365
MB
497 (if (< size 0)
498 (error "%s has size %s - corrupted"
58d6a142
SM
499 (tar-header-name descriptor) size)))
500 ;;
501 ;; This is just too slow. Don't really need it anyway....
502 ;;(tar-header-block-check-checksum
503 ;; hblock (tar-header-block-checksum hblock)
504 ;; (tar-header-name descriptor))
abef340a 505
58d6a142
SM
506 (push descriptor result)
507 (setq pos (tar-header-data-end descriptor))
508 (progress-reporter-update progress-reporter pos)))
509
61bb55d0 510 (set (make-local-variable 'tar-parse-info) (nreverse result))
f598e45e
SM
511 ;; A tar file should end with a block or two of nulls,
512 ;; but let's not get a fatal error if it doesn't.
61bb55d0 513 (if (null descriptor)
f598e45e
SM
514 (progress-reporter-done progress-reporter)
515 (message "Warning: premature EOF parsing tar file"))
aa73f29c 516 (goto-char (point-min))
c40d3365 517 (let ((inhibit-read-only t)
c40d3365 518 (total-summaries
61bb55d0 519 (mapconcat 'tar-header-block-summarize tar-parse-info "\n")))
c40d3365 520 (insert total-summaries "\n"))
c40d3365
MB
521 (goto-char (point-min))
522 (restore-buffer-modified-p modified)))
e865c5ce 523\f
b016851c
SM
524(defvar tar-mode-map
525 (let ((map (make-keymap)))
526 (suppress-keymap map)
527 (define-key map " " 'tar-next-line)
528 (define-key map "C" 'tar-copy)
529 (define-key map "d" 'tar-flag-deleted)
530 (define-key map "\^D" 'tar-flag-deleted)
531 (define-key map "e" 'tar-extract)
532 (define-key map "f" 'tar-extract)
533 (define-key map "\C-m" 'tar-extract)
534 (define-key map [mouse-2] 'tar-mouse-extract)
535 (define-key map "g" 'revert-buffer)
536 (define-key map "n" 'tar-next-line)
537 (define-key map "\^N" 'tar-next-line)
538 (define-key map [down] 'tar-next-line)
539 (define-key map "o" 'tar-extract-other-window)
540 (define-key map "p" 'tar-previous-line)
541 (define-key map "\^P" 'tar-previous-line)
542 (define-key map [up] 'tar-previous-line)
543 (define-key map "R" 'tar-rename-entry)
544 (define-key map "u" 'tar-unflag)
545 (define-key map "v" 'tar-view)
546 (define-key map "x" 'tar-expunge)
547 (define-key map "\177" 'tar-unflag-backwards)
548 (define-key map "E" 'tar-extract-other-window)
549 (define-key map "M" 'tar-chmod-entry)
550 (define-key map "G" 'tar-chgrp-entry)
551 (define-key map "O" 'tar-chown-entry)
552 ;; Let mouse-1 follow the link.
553 (define-key map [follow-link] 'mouse-face)
554
555 ;; Make menu bar items.
556
557 ;; Get rid of the Edit menu bar item to save space.
558 (define-key map [menu-bar edit] 'undefined)
559
560 (define-key map [menu-bar immediate]
561 (cons "Immediate" (make-sparse-keymap "Immediate")))
562
563 (define-key map [menu-bar immediate view]
564 '("View This File" . tar-view))
565 (define-key map [menu-bar immediate display]
566 '("Display in Other Window" . tar-display-other-window))
567 (define-key map [menu-bar immediate find-file-other-window]
568 '("Find in Other Window" . tar-extract-other-window))
569 (define-key map [menu-bar immediate find-file]
570 '("Find This File" . tar-extract))
571
572 (define-key map [menu-bar mark]
573 (cons "Mark" (make-sparse-keymap "Mark")))
574
575 (define-key map [menu-bar mark unmark-all]
576 '("Unmark All" . tar-clear-modification-flags))
577 (define-key map [menu-bar mark deletion]
578 '("Flag" . tar-flag-deleted))
579 (define-key map [menu-bar mark unmark]
580 '("Unflag" . tar-unflag))
581
582 (define-key map [menu-bar operate]
583 (cons "Operate" (make-sparse-keymap "Operate")))
584
585 (define-key map [menu-bar operate chown]
586 '("Change Owner..." . tar-chown-entry))
587 (define-key map [menu-bar operate chgrp]
588 '("Change Group..." . tar-chgrp-entry))
589 (define-key map [menu-bar operate chmod]
590 '("Change Mode..." . tar-chmod-entry))
591 (define-key map [menu-bar operate rename]
592 '("Rename to..." . tar-rename-entry))
593 (define-key map [menu-bar operate copy]
594 '("Copy to..." . tar-copy))
595 (define-key map [menu-bar operate expunge]
596 '("Expunge Marked Files" . tar-expunge))
597 \f
598 map)
599 "Local keymap for Tar mode listings.")
c40d3365 600
b016851c 601\f
aa73f29c
RS
602;; tar mode is suitable only for specially formatted data.
603(put 'tar-mode 'mode-class 'special)
604(put 'tar-subfile-mode 'mode-class 'special)
605
f598e45e
SM
606(defun tar-change-major-mode-hook ()
607 ;; Bring the actual Tar data back into the main buffer.
d3a36099 608 (when (tar-data-swapped-p) (tar-swap-data))
f598e45e
SM
609 ;; Throw away the summary.
610 (when (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
611
612(defun tar-mode-kill-buffer-hook ()
613 (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer)))
614
bdd53bbc 615;;;###autoload
abef340a 616(define-derived-mode tar-mode special-mode "Tar"
aa73f29c 617 "Major mode for viewing a tar file as a dired-like listing of its contents.
f1180544 618You can move around using the usual cursor motion commands.
aa73f29c 619Letters no longer insert themselves.
439fa06f
RS
620Type `e' to pull a file out of the tar file and into its own buffer;
621or click mouse-2 on the file's line in the Tar mode buffer.
e865c5ce 622Type `c' to copy an entry from the tar file into another file on disk.
aa73f29c 623
f1180544 624If you edit a sub-file of this archive (as with the `e' command) and
8560523d 625save it with \\[save-buffer], the contents of that buffer will be
f1180544 626saved back into the tar-file buffer; in this way you can edit a file
aa73f29c
RS
627inside of a tar archive without extracting it and re-archiving it.
628
e865c5ce 629See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
aa73f29c 630\\{tar-mode-map}"
aa73f29c 631 (make-local-variable 'tar-parse-info)
a91c76d6 632 (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
a91c76d6
SM
633 (set (make-local-variable 'local-enable-local-variables) nil)
634 (set (make-local-variable 'next-line-add-newlines) nil)
d26e6665
KH
635 (set (make-local-variable 'tar-file-name-coding-system)
636 (or file-name-coding-system
637 default-file-name-coding-system
638 locale-coding-system))
b9ca3cdb 639 ;; Prevent loss of data when saving the file.
a91c76d6 640 (set (make-local-variable 'file-precious-flag) t)
03b00795 641 (buffer-disable-undo)
aa73f29c 642 (widen)
f598e45e
SM
643 ;; Now move the Tar data into an auxiliary buffer, so we can use the main
644 ;; buffer for the summary.
645 (assert (not (tar-data-swapped-p)))
646 (set (make-local-variable 'revert-buffer-function) 'tar-mode-revert)
3006c8dc
SM
647 ;; We started using write-contents-functions, but this hook is not
648 ;; used during auto-save, so we now use
649 ;; write-region-annotate-functions which hooks at a lower-level.
650 (add-hook 'write-region-annotate-functions 'tar-write-region-annotate nil t)
f598e45e
SM
651 (add-hook 'kill-buffer-hook 'tar-mode-kill-buffer-hook nil t)
652 (add-hook 'change-major-mode-hook 'tar-change-major-mode-hook nil t)
653 ;; Tar data is made of bytes, not chars.
58d6a142 654 (set-buffer-multibyte nil) ;Hopefully a no-op.
f598e45e
SM
655 (set (make-local-variable 'tar-data-buffer)
656 (generate-new-buffer (format " *tar-data %s*"
657 (file-name-nondirectory
658 (or buffer-file-name (buffer-name))))))
dc4e3ccc
SM
659 (condition-case err
660 (progn
661 (tar-swap-data)
662 (tar-summarize-buffer)
663 (tar-next-line 0))
664 (error
665 ;; If summarizing caused an error, then maybe the buffer doesn't contain
666 ;; tar data. Rather than show a mysterious empty buffer, let's
667 ;; revert to fundamental-mode.
668 (fundamental-mode)
669 (signal (car err) (cdr err)))))
aa73f29c
RS
670
671
56eb0904 672(define-minor-mode tar-subfile-mode
aa73f29c 673 "Minor mode for editing an element of a tar-file.
76605277
RS
674This mode arranges for \"saving\" this buffer to write the data
675into the tar-file buffer that it came from. The changes will actually
676appear on disk when you save the tar-file's buffer."
56eb0904
SM
677 ;; Don't do this, because it is redundant and wastes mode line space.
678 ;; :lighter " TarFile"
679 nil nil nil
0f8becaa 680 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
e865c5ce 681 (error "This buffer is not an element of a tar file"))
aa73f29c 682 (cond (tar-subfile-mode
76bf6666 683 (add-hook 'write-file-functions 'tar-subfile-save-buffer nil t)
aa73f29c 684 ;; turn off auto-save.
75238436 685 (auto-save-mode -1)
56eb0904 686 (setq buffer-auto-save-file-name nil))
e865c5ce 687 (t
76bf6666 688 (remove-hook 'write-file-functions 'tar-subfile-save-buffer t))))
aa73f29c
RS
689
690
e865c5ce 691;; Revert the buffer and recompute the dired-like listing.
f6b0805a 692(defun tar-mode-revert (&optional no-auto-save no-confirm)
f598e45e
SM
693 (unwind-protect
694 (let ((revert-buffer-function nil))
d3a36099 695 (if (tar-data-swapped-p) (tar-swap-data))
f598e45e
SM
696 ;; FIXME: If we ask for confirmation, the user will be temporarily
697 ;; looking at the raw data.
698 (revert-buffer no-auto-save no-confirm 'preserve-modes)
f598e45e 699 ;; Recompute the summary.
d3a36099 700 (if (buffer-live-p tar-data-buffer) (kill-buffer tar-data-buffer))
f598e45e 701 (tar-mode))
d3a36099 702 (unless (tar-data-swapped-p) (tar-swap-data))))
aa73f29c
RS
703
704
210f943e
PJ
705(defun tar-next-line (arg)
706 "Move cursor vertically down ARG lines and to the start of the filename."
aa73f29c 707 (interactive "p")
210f943e 708 (forward-line arg)
58d6a142 709 (goto-char (or (next-single-property-change (point) 'mouse-face) (point))))
aa73f29c 710
210f943e
PJ
711(defun tar-previous-line (arg)
712 "Move cursor vertically up ARG lines and to the start of the filename."
aa73f29c 713 (interactive "p")
210f943e 714 (tar-next-line (- arg)))
aa73f29c
RS
715
716(defun tar-current-descriptor (&optional noerror)
e865c5ce 717 "Return the tar-descriptor of the current line, or signals an error."
aa73f29c 718 ;; I wish lines had plists, like in ZMACS...
f598e45e 719 (or (nth (count-lines (point-min) (line-beginning-position))
aa73f29c
RS
720 tar-parse-info)
721 (if noerror
722 nil
439fa06f 723 (error "This line does not describe a tar-file entry"))))
aa73f29c 724
439fa06f
RS
725(defun tar-get-descriptor ()
726 (let* ((descriptor (tar-current-descriptor))
61bb55d0
SM
727 (size (tar-header-size descriptor))
728 (link-p (tar-header-link-type descriptor)))
439fa06f 729 (if link-p
bf65c664
CY
730 (error "This is %s, not a real file"
731 (cond ((eq link-p 5) "a directory")
732 ((eq link-p 20) "a tar directory header")
733 ((eq link-p 28) "a next has longname")
734 ((eq link-p 29) "a multivolume-continuation")
735 ((eq link-p 35) "a sparse entry")
736 ((eq link-p 38) "a volume header")
737 ((eq link-p 55) "an extended pax header")
738 (t "a link"))))
f09bbd93 739 (if (zerop size) (message "This is a zero-length file"))
439fa06f
RS
740 descriptor))
741
742(defun tar-mouse-extract (event)
743 "Extract a file whose tar directory line you click on."
744 (interactive "e")
53ad7bee 745 (with-current-buffer (window-buffer (posn-window (event-end event)))
439fa06f
RS
746 (save-excursion
747 (goto-char (posn-point (event-end event)))
748 ;; Just make sure this doesn't get an error.
749 (tar-get-descriptor)))
750 (select-window (posn-window (event-end event)))
751 (goto-char (posn-point (event-end event)))
752 (tar-extract))
aa73f29c 753
07e7a05a
EZ
754(defun tar-file-name-handler (op &rest args)
755 "Helper function for `tar-extract'."
756 (or (eq op 'file-exists-p)
757 (let ((file-name-handler-alist nil))
758 (apply op args))))
759
aa73f29c 760(defun tar-extract (&optional other-window-p)
628d6cef 761 "In Tar mode, extract this entry of the tar file into its own buffer."
aa73f29c
RS
762 (interactive)
763 (let* ((view-p (eq other-window-p 'view))
439fa06f 764 (descriptor (tar-get-descriptor))
61bb55d0
SM
765 (name (tar-header-name descriptor))
766 (size (tar-header-size descriptor))
767 (start (tar-header-data-start descriptor))
aa73f29c 768 (end (+ start size)))
aa73f29c 769 (let* ((tar-buffer (current-buffer))
38c6e0c7 770 (tarname (buffer-name))
e8421604
GM
771 (bufname (concat (file-name-nondirectory name)
772 " ("
6da7ea56 773 tarname
e8421604 774 ")"))
aa73f29c 775 (read-only-p (or buffer-read-only view-p))
38c6e0c7
AS
776 (new-buffer-file-name (expand-file-name
777 ;; `:' is not allowed on Windows
dc4e3ccc
SM
778 (concat tarname "!"
779 (if (string-match "/" name)
780 name
781 ;; Make sure `name' contains a /
782 ;; so set-auto-mode doesn't try
783 ;; to look at `tarname' for hints.
784 (concat "./" name)))))
e8421604 785 (buffer (get-file-buffer new-buffer-file-name))
d26e6665 786 (just-created nil)
8e69f4d8 787 undo-list)
e8421604 788 (unless buffer
38c6e0c7 789 (setq buffer (generate-new-buffer bufname))
53ad7bee 790 (with-current-buffer buffer
8e69f4d8
KH
791 (setq undo-list buffer-undo-list
792 buffer-undo-list t))
38c6e0c7 793 (setq bufname (buffer-name buffer))
aa73f29c 794 (setq just-created t)
f598e45e
SM
795 (with-current-buffer tar-data-buffer
796 (let (coding)
797 (narrow-to-region start end)
798 (goto-char start)
799 (setq coding (or coding-system-for-read
800 (and set-auto-coding-function
801 (funcall set-auto-coding-function
802 name (- end start)))
803 ;; The following binding causes
804 ;; find-buffer-file-type-coding-system
805 ;; (defined on dos-w32.el) to act as if
806 ;; the file being extracted existed, so
807 ;; that the file's contents' encoding and
808 ;; EOL format are auto-detected.
809 (let ((file-name-handler-alist
810 '(("" . tar-file-name-handler))))
811 (car (find-operation-coding-system
812 'insert-file-contents
813 (cons name (current-buffer)) t)))))
814 (if (or (not coding)
815 (eq (coding-system-type coding) 'undecided))
816 (setq coding (detect-coding-region start end t)))
597e2240 817 (if (and (default-value 'enable-multibyte-characters)
f598e45e
SM
818 (coding-system-get coding :for-unibyte))
819 (with-current-buffer buffer
820 (set-buffer-multibyte nil)))
821 (widen)
822 (decode-coding-region start end coding buffer)))
823 (with-current-buffer buffer
824 (goto-char (point-min))
825 (setq buffer-file-name new-buffer-file-name)
826 (setq buffer-file-truename
827 (abbreviate-file-name buffer-file-name))
828 ;; Force buffer-file-coding-system to what
829 ;; decode-coding-region actually used.
830 (set-buffer-file-coding-system last-coding-system-used t)
831 ;; Set the default-directory to the dir of the
832 ;; superior buffer.
833 (setq default-directory
834 (with-current-buffer tar-buffer
835 default-directory))
f598e45e 836 (rename-buffer bufname)
f598e45e
SM
837 (set-buffer-modified-p nil)
838 (setq buffer-undo-list undo-list)
3ba41ce4
SM
839 (normal-mode) ; pick a mode.
840 (set (make-local-variable 'tar-superior-buffer) tar-buffer)
841 (set (make-local-variable 'tar-superior-descriptor) descriptor)
842 (setq buffer-read-only read-only-p)
f598e45e 843 (tar-subfile-mode 1)))
fd5c9dfa
JL
844 (cond
845 (view-p
846 (view-buffer buffer (and just-created 'kill-buffer-if-not-modified)))
847 ((eq other-window-p 'display) (display-buffer buffer))
848 (other-window-p (switch-to-buffer-other-window buffer))
849 (t (switch-to-buffer buffer))))))
aa73f29c
RS
850
851
852(defun tar-extract-other-window ()
8560523d 853 "In Tar mode, find this entry of the tar file in another window."
aa73f29c
RS
854 (interactive)
855 (tar-extract t))
856
e865c5ce 857(defun tar-display-other-window ()
8560523d 858 "In Tar mode, display this entry of the tar file in another window."
e865c5ce
RS
859 (interactive)
860 (tar-extract 'display))
861
aa73f29c 862(defun tar-view ()
8560523d 863 "In Tar mode, view the tar file entry on this line."
aa73f29c
RS
864 (interactive)
865 (tar-extract 'view))
866
867
868(defun tar-read-file-name (&optional prompt)
e865c5ce 869 "Read a file name with this line's entry as the default."
aa73f29c
RS
870 (or prompt (setq prompt "Copy to: "))
871 (let* ((default-file (expand-file-name
61bb55d0 872 (tar-header-name (tar-current-descriptor))))
aa73f29c
RS
873 (target (expand-file-name
874 (read-file-name prompt
875 (file-name-directory default-file)
876 default-file nil))))
877 (if (or (string= "" (file-name-nondirectory target))
878 (file-directory-p target))
879 (setq target (concat (if (string-match "/$" target)
880 (substring target 0 (1- (match-end 0)))
881 target)
882 "/"
883 (file-name-nondirectory default-file))))
884 target))
885
886
887(defun tar-copy (&optional to-file)
8560523d 888 "In Tar mode, extract this entry of the tar file into a file on disk.
aa73f29c
RS
889If TO-FILE is not supplied, it is prompted for, defaulting to the name of
890the current tar-entry."
891 (interactive (list (tar-read-file-name)))
439fa06f 892 (let* ((descriptor (tar-get-descriptor))
61bb55d0
SM
893 (name (tar-header-name descriptor))
894 (size (tar-header-size descriptor))
895 (start (tar-header-data-start descriptor))
d4ec0200
RS
896 (end (+ start size))
897 (inhibit-file-name-handlers inhibit-file-name-handlers)
898 (inhibit-file-name-operation inhibit-file-name-operation))
6960d7b9
CY
899 (with-current-buffer
900 (if (tar-data-swapped-p) tar-data-buffer (current-buffer))
d4ec0200
RS
901 ;; Inhibit compressing a subfile again if *both* name and
902 ;; to-file are handled by jka-compr
6960d7b9
CY
903 (if (and (eq (find-file-name-handler name 'write-region)
904 'jka-compr-handler)
905 (eq (find-file-name-handler to-file 'write-region)
906 'jka-compr-handler))
d4ec0200
RS
907 (setq inhibit-file-name-handlers
908 (cons 'jka-compr-handler
909 (and (eq inhibit-file-name-operation 'write-region)
910 inhibit-file-name-handlers))
911 inhibit-file-name-operation 'write-region))
d26e6665
KH
912 (let ((coding-system-for-write 'no-conversion))
913 (write-region start end to-file nil nil nil t)))
6a608e8e 914 (message "Copied tar entry %s to %s" name to-file)))
aa73f29c
RS
915
916(defun tar-flag-deleted (p &optional unflag)
8560523d 917 "In Tar mode, mark this sub-file to be deleted from the tar file.
aa73f29c
RS
918With a prefix argument, mark that many files."
919 (interactive "p")
920 (beginning-of-line)
8560523d 921 (dotimes (i (abs p))
aa73f29c
RS
922 (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
923 (progn
924 (delete-char 1)
925 (insert (if unflag " " "D"))))
926 (forward-line (if (< p 0) -1 1)))
927 (if (eobp) nil (forward-char 36)))
928
929(defun tar-unflag (p)
8560523d 930 "In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
931With a prefix argument, un-mark that many files forward."
932 (interactive "p")
933 (tar-flag-deleted p t))
934
935(defun tar-unflag-backwards (p)
8560523d 936 "In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
937With a prefix argument, un-mark that many files backward."
938 (interactive "p")
939 (tar-flag-deleted (- p) t))
940
941
942(defun tar-expunge-internal ()
943 "Expunge the tar-entry specified by the current line."
58d6a142 944 (let ((descriptor (tar-current-descriptor)))
aa73f29c
RS
945 ;;
946 ;; delete the current line...
f598e45e 947 (delete-region (line-beginning-position) (line-beginning-position 2))
aa73f29c
RS
948 ;;
949 ;; delete the data pointer...
950 (setq tar-parse-info (delq descriptor tar-parse-info))
951 ;;
952 ;; delete the data from inside the file...
58d6a142
SM
953 (with-current-buffer tar-data-buffer
954 (delete-region (or (tar-header-header-start descriptor)
955 (- (tar-header-data-start descriptor) 512))
956 (tar-header-data-end descriptor)))))
aa73f29c
RS
957
958
959(defun tar-expunge (&optional noconfirm)
8560523d 960 "In Tar mode, delete all the archived files flagged for deletion.
aa73f29c
RS
961This does not modify the disk image; you must save the tar file itself
962for this to be permanent."
963 (interactive)
964 (if (or noconfirm
67501c01 965 (y-or-n-p "Expunge files marked for deletion? "))
d26e6665 966 (let ((n 0))
aa73f29c 967 (save-excursion
cb33a0ce 968 (goto-char (point-min))
aa73f29c
RS
969 (while (not (eobp))
970 (if (looking-at "D")
971 (progn (tar-expunge-internal)
972 (setq n (1+ n)))
973 (forward-line 1)))
974 ;; after doing the deletions, add any padding that may be necessary.
f598e45e 975 (tar-pad-to-blocksize))
aa73f29c 976 (if (zerop n)
67501c01
RS
977 (message "Nothing to expunge.")
978 (message "%s files expunged. Be sure to save this buffer." n)))))
aa73f29c
RS
979
980
981(defun tar-clear-modification-flags ()
e865c5ce 982 "Remove the stars at the beginning of each line."
a7e5e8cb 983 (interactive)
aa73f29c 984 (save-excursion
cb33a0ce 985 (goto-char (point-min))
f598e45e 986 (while (not (eobp))
e5d56b61 987 (if (not (eq (following-char) ?\s))
aa73f29c
RS
988 (progn (delete-char 1) (insert " ")))
989 (forward-line 1))))
990
991
992(defun tar-chown-entry (new-uid)
8560523d 993 "Change the user-id associated with this entry in the tar file.
aa73f29c
RS
994If this tar file was written by GNU tar, then you will be able to edit
995the user id as a string; otherwise, you must edit it as a number.
996You can force editing as a number by calling this with a prefix arg.
997This does not modify the disk image; you must save the tar file itself
998for this to be permanent."
61bb55d0
SM
999 (interactive
1000 (list
1001 (let ((descriptor (tar-current-descriptor)))
1002 (if (or current-prefix-arg
1003 (not (tar-header-magic descriptor)))
1004 (read-number
1005 "New UID number: "
1006 (format "%s" (tar-header-uid descriptor)))
1007 (read-string "New UID string: " (tar-header-uname descriptor))))))
aa73f29c 1008 (cond ((stringp new-uid)
61bb55d0 1009 (setf (tar-header-uname (tar-current-descriptor)) new-uid)
4062011e
SM
1010 (tar-alter-one-field tar-uname-offset
1011 (concat (encode-coding-string
1012 new-uid tar-file-name-coding-system)
1013 "\000")))
aa73f29c 1014 (t
61bb55d0 1015 (setf (tar-header-uid (tar-current-descriptor)) new-uid)
aa73f29c
RS
1016 (tar-alter-one-field tar-uid-offset
1017 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
1018
1019
1020(defun tar-chgrp-entry (new-gid)
8560523d 1021 "Change the group-id associated with this entry in the tar file.
aa73f29c
RS
1022If this tar file was written by GNU tar, then you will be able to edit
1023the group id as a string; otherwise, you must edit it as a number.
1024You can force editing as a number by calling this with a prefix arg.
1025This does not modify the disk image; you must save the tar file itself
1026for this to be permanent."
61bb55d0
SM
1027 (interactive
1028 (list
1029 (let ((descriptor (tar-current-descriptor)))
1030 (if (or current-prefix-arg
1031 (not (tar-header-magic descriptor)))
1032 (read-number
1033 "New GID number: "
1034 (format "%s" (tar-header-gid descriptor)))
1035 (read-string "New GID string: " (tar-header-gname descriptor))))))
aa73f29c 1036 (cond ((stringp new-gid)
61bb55d0 1037 (setf (tar-header-gname (tar-current-descriptor)) new-gid)
aa73f29c 1038 (tar-alter-one-field tar-gname-offset
4062011e
SM
1039 (concat (encode-coding-string
1040 new-gid tar-file-name-coding-system)
1041 "\000")))
aa73f29c 1042 (t
61bb55d0 1043 (setf (tar-header-gid (tar-current-descriptor)) new-gid)
aa73f29c
RS
1044 (tar-alter-one-field tar-gid-offset
1045 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
1046
1047(defun tar-rename-entry (new-name)
8560523d 1048 "Change the name associated with this entry in the tar file.
aa73f29c
RS
1049This does not modify the disk image; you must save the tar file itself
1050for this to be permanent."
1051 (interactive
1052 (list (read-string "New name: "
61bb55d0 1053 (tar-header-name (tar-current-descriptor)))))
439fa06f 1054 (if (string= "" new-name) (error "zero length name"))
d26e6665 1055 (let ((encoded-new-name (encode-coding-string new-name
58d6a142
SM
1056 tar-file-name-coding-system))
1057 (descriptor (tar-current-descriptor))
1058 (prefix nil))
1059 (when (tar-header-header-start descriptor)
1060 ;; FIXME: Make it work for ././@LongLink.
1061 (error "Rename with @LongLink format is not implemented"))
1062
1063 (when (and (> (length encoded-new-name) 98)
1064 (string-match "/" encoded-new-name
1065 (- (length encoded-new-name) 99))
1066 (< (match-beginning 0) 155))
b6388cc9
SM
1067 (unless (equal (tar-header-magic descriptor) "ustar\0")
1068 (tar-alter-one-field tar-magic-offset (concat "ustar\0" "00")))
58d6a142
SM
1069 (setq prefix (substring encoded-new-name 0 (match-beginning 0)))
1070 (setq encoded-new-name (substring encoded-new-name (match-end 0))))
1071
d26e6665 1072 (if (> (length encoded-new-name) 98) (error "name too long"))
58d6a142 1073 (setf (tar-header-name descriptor) new-name)
d26e6665 1074 (tar-alter-one-field 0
58d6a142
SM
1075 (substring (concat encoded-new-name (make-string 99 0)) 0 99))
1076 (if prefix
1077 (tar-alter-one-field tar-prefix-offset
1078 (substring (concat prefix (make-string 155 0)) 0 155)))))
aa73f29c
RS
1079
1080
1081(defun tar-chmod-entry (new-mode)
c40d3365 1082 "Change the protection bits associated with this entry in the tar file.
aa73f29c
RS
1083This does not modify the disk image; you must save the tar file itself
1084for this to be permanent."
1085 (interactive (list (tar-parse-octal-integer-safe
1086 (read-string "New protection (octal): "))))
61bb55d0 1087 (setf (tar-header-mode (tar-current-descriptor)) new-mode)
aa73f29c
RS
1088 (tar-alter-one-field tar-mode-offset
1089 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1090
1091
58d6a142
SM
1092(defun tar-alter-one-field (data-position new-data-string &optional descriptor)
1093 (unless descriptor (setq descriptor (tar-current-descriptor)))
1094 ;;
1095 ;; update the header-line.
1096 (let ((col (current-column)))
1097 (delete-region (line-beginning-position)
1098 (prog2 (forward-line 1)
1099 (point)
1100 ;; Insert the new text after the old, before deleting,
1101 ;; to preserve markers such as the window start.
1102 (insert (tar-header-block-summarize descriptor) "\n")))
1103 (forward-line -1) (move-to-column col))
f598e45e 1104
58d6a142
SM
1105 (assert (tar-data-swapped-p))
1106 (with-current-buffer tar-data-buffer
1107 (let* ((start (- (tar-header-data-start descriptor) 512)))
f598e45e
SM
1108 ;;
1109 ;; delete the old field and insert a new one.
1110 (goto-char (+ start data-position))
1111 (delete-region (point) (+ (point) (length new-data-string))) ; <--
f598e45e
SM
1112 (assert (not (or enable-multibyte-characters
1113 (multibyte-string-p new-data-string))))
1114 (insert new-data-string)
1115 ;;
1116 ;; compute a new checksum and insert it.
1117 (let ((chk (tar-header-block-checksum
58d6a142
SM
1118 (buffer-substring start (+ start 512)))))
1119 (goto-char (+ start tar-chk-offset))
1120 (delete-region (point) (+ (point) 8))
1121 (insert (format "%6o\0 " chk))
1122 (setf (tar-header-checksum descriptor) chk)
1123 ;;
1124 ;; ok, make sure we didn't botch it.
1125 (tar-header-block-check-checksum
1126 (buffer-substring start (+ start 512))
1127 chk (tar-header-name descriptor))
1128 ))))
aa73f29c
RS
1129
1130
3d7fc2fb
ER
1131(defun tar-octal-time (timeval)
1132 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1133 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
516f7fca
EZ
1134 (format "%05o%01o%05o"
1135 (lsh hibits -2)
1136 (logior (lsh (logand 3 hibits) 1)
1137 (if (> (logand lobits 32768) 0) 1 0))
1138 (logand 32767 lobits)
1139 )))
3d7fc2fb 1140
aa73f29c 1141(defun tar-subfile-save-buffer ()
e865c5ce
RS
1142 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1143This doesn't write anything to disk; you must save the parent tar-file buffer
aa73f29c
RS
1144to make your changes permanent."
1145 (interactive)
0f8becaa 1146 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
f598e45e 1147 (error "This buffer has no superior tar file buffer"))
0f8becaa 1148 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
f598e45e 1149 (error "This buffer doesn't have an index into its superior tar file!"))
aa73f29c 1150 (let ((subfile (current-buffer))
f598e45e
SM
1151 (coding buffer-file-coding-system)
1152 (descriptor tar-superior-descriptor)
1153 subfile-size)
1154 (with-current-buffer tar-superior-buffer
61bb55d0 1155 (let* ((start (tar-header-data-start descriptor))
61bb55d0 1156 (size (tar-header-size descriptor))
dd798c64 1157 (head (memq descriptor tar-parse-info)))
f598e45e
SM
1158 (if (not head)
1159 (error "Can't find this tar file entry in its parent tar file!"))
1160 (with-current-buffer tar-data-buffer
1161 ;; delete the old data...
1162 (let* ((data-start start)
61bb55d0 1163 (data-end (+ data-start (tar-roundup-512 size))))
f598e45e
SM
1164 (narrow-to-region data-start data-end)
1165 (delete-region (point-min) (point-max))
1166 ;; insert the new data...
1167 (goto-char data-start)
1168 (let ((dest (current-buffer)))
1169 (with-current-buffer subfile
1170 (save-restriction
1171 (widen)
1172 (encode-coding-region (point-min) (point-max) coding dest))))
1173 (setq subfile-size (- (point-max) (point-min)))
1174 ;;
1175 ;; pad the new data out to a multiple of 512...
61bb55d0 1176 (let ((subfile-size-pad (tar-roundup-512 subfile-size)))
f598e45e
SM
1177 (goto-char (point-max))
1178 (insert (make-string (- subfile-size-pad subfile-size) 0))
1179 ;;
61bb55d0
SM
1180 ;; update the data of this files...
1181 (setf (tar-header-size descriptor) subfile-size)
f598e45e
SM
1182 ;;
1183 ;; Update the size field in the header block.
58d6a142 1184 (widen))))
f598e45e 1185 ;;
58d6a142 1186 ;; alter the descriptor-line and header
f598e45e
SM
1187 ;;
1188 (let ((position (- (length tar-parse-info) (length head))))
1189 (goto-char (point-min))
1190 (forward-line position)
58d6a142
SM
1191 (tar-alter-one-field tar-size-offset (format "%11o " subfile-size))
1192 ;;
1193 ;; Maybe update the datestamp.
1194 (when tar-update-datestamp
1195 (tar-alter-one-field tar-time-offset
1196 (concat (tar-octal-time (current-time)) " "))))
f598e45e
SM
1197 ;; After doing the insertion, add any necessary final padding.
1198 (tar-pad-to-blocksize))
1199 (set-buffer-modified-p t) ; mark the tar file as modified
1200 (tar-next-line 0))
1201 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
67501c01 1202 (message "Saved into tar-buffer `%s'. Be sure to save that buffer!"
f598e45e 1203 (buffer-name tar-superior-buffer))
47414bc1
RS
1204 ;; Prevent basic-save-buffer from changing our coding-system.
1205 (setq last-coding-system-used buffer-file-coding-system)
e865c5ce 1206 ;; Prevent ordinary saving from happening.
f598e45e 1207 t))
aa73f29c
RS
1208
1209
1b33e237 1210;; When this function is called, it is sure that the buffer is unibyte.
aa73f29c
RS
1211(defun tar-pad-to-blocksize ()
1212 "If we are being anal about tar file blocksizes, fix up the current buffer.
1213Leaves the region wide."
1214 (if (null tar-anal-blocksize)
1215 nil
aa73f29c 1216 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
61bb55d0
SM
1217 (start (tar-header-data-start last-desc))
1218 (link-p (tar-header-link-type last-desc))
1219 (size (if link-p 0 (tar-header-size last-desc)))
aa73f29c
RS
1220 (data-end (+ start size))
1221 (bbytes (ash tar-anal-blocksize 9))
f598e45e 1222 (pad-to (+ bbytes (* bbytes (/ (- data-end (point-min)) bbytes)))))
aa73f29c
RS
1223 ;; If the padding after the last data is too long, delete some;
1224 ;; else insert some until we are padded out to the right number of blocks.
1225 ;;
f598e45e
SM
1226 (with-current-buffer tar-data-buffer
1227 (let ((goal-end (+ (point-min) pad-to)))
1228 (if (> (point-max) goal-end)
1229 (delete-region goal-end (point-max))
1230 (goto-char (point-max))
1231 (insert (make-string (- goal-end (point-max)) ?\0))))))))
19eb68d0
SM
1232
1233
3006c8dc 1234;; Used in write-region-annotate-functions to write tar-files out correctly.
06b60517 1235(defun tar-write-region-annotate (start _end)
3006c8dc
SM
1236 ;; When called from write-file (and auto-save), `start' is nil.
1237 ;; When called from M-x write-region, we assume the user wants to save
1238 ;; (part of) the summary, not the tar data.
1239 (unless (or start (not (tar-data-swapped-p)))
d00da9d7 1240 (tar-clear-modification-flags)
3006c8dc
SM
1241 (set-buffer tar-data-buffer)
1242 nil))
19eb68d0 1243
aa73f29c
RS
1244(provide 'tar-mode)
1245
c88ab9ce 1246;;; tar-mode.el ends here