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