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