(cp855, ibm855): New coding systems.
[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) "")
a28eaf2c
EZ
369 (propertize name
370 'mouse-face 'highlight
371 'help-echo "mouse-2: extract this file into a buffer")
139f2b7c
SM
372 (if (or (eq type 1) (eq type 2))
373 (concat (if (= type 1) " ==> " " --> ") link-name)
374 ""))))
aa73f29c
RS
375
376(defun tar-summarize-buffer ()
e865c5ce
RS
377 "Parse the contents of the tar file in the current buffer.
378Place a dired-like listing on the front;
379then narrow to it, so that only that listing
aa73f29c 380is visible (and the real data of the buffer is hidden)."
1b33e237 381 (set-buffer-multibyte nil)
67501c01 382 (message "Parsing tar file...")
aa73f29c
RS
383 (let* ((result '())
384 (pos 1)
385 (bs (max 1 (- (buffer-size) 1024))) ; always 2+ empty blocks at end.
386 (bs100 (max 1 (/ bs 100)))
7bfcceab
KH
387 tokens)
388 (while (and (<= (+ pos 512) (point-max))
389 (not (eq 'empty-tar-block
390 (setq tokens
391 (tar-header-block-tokenize
392 (buffer-substring pos (+ pos 512)))))))
1b15043e 393 (setq pos (+ pos 512))
7bfcceab 394 (message "Parsing tar file...%d%%"
1b15043e
KH
395 ;(/ (* pos 100) bs) ; this gets round-off lossage
396 (/ pos bs100) ; this doesn't
397 )
7bfcceab
KH
398 (if (eq (tar-header-link-type tokens) 20)
399 ;; Foo. There's an extra empty block after these.
400 (setq pos (+ pos 512)))
401 (let ((size (tar-header-size tokens)))
402 (if (< size 0)
403 (error "%s has size %s - corrupted"
404 (tar-header-name tokens) size))
405 ;
406 ; This is just too slow. Don't really need it anyway....
407 ;(tar-header-block-check-checksum
408 ; hblock (tar-header-block-checksum hblock)
409 ; (tar-header-name tokens))
410
411 (setq result (cons (make-tar-desc pos tokens) result))
412
413 (and (null (tar-header-link-type tokens))
414 (> size 0)
415 (setq pos
416 (+ pos 512 (ash (ash (1- size) -9) 9)) ; this works
417 ;(+ pos (+ size (- 512 (rem (1- size) 512)))) ; this doesn't
418 ))))
aa73f29c 419 (make-local-variable 'tar-parse-info)
7bfcceab
KH
420 (setq tar-parse-info (nreverse result))
421 ;; A tar file should end with a block or two of nulls,
422 ;; but let's not get a fatal error if it doesn't.
423 (if (eq tokens 'empty-tar-block)
624204f0 424 (message "Parsing tar file...done")
7bfcceab 425 (message "Warning: premature EOF parsing tar file")))
aa73f29c
RS
426 (save-excursion
427 (goto-char (point-min))
a728aa90
RS
428 (let ((buffer-read-only nil)
429 (summaries nil))
430 ;; Collect summary lines and insert them all at once since tar files
431 ;; can be pretty big.
048d06bd 432 (dolist (tar-desc (reverse tar-parse-info))
a728aa90
RS
433 (setq summaries
434 (cons (tar-header-block-summarize (tar-desc-tokens tar-desc))
435 (cons "\n"
436 summaries))))
1b33e237
KH
437 (let ((total-summaries (apply 'concat summaries)))
438 (if (multibyte-string-p total-summaries)
439 (set-buffer-multibyte t))
440 (insert total-summaries))
aa73f29c
RS
441 (make-local-variable 'tar-header-offset)
442 (setq tar-header-offset (point))
443 (narrow-to-region 1 tar-header-offset)
1b33e237
KH
444 (if enable-multibyte-characters
445 (setq tar-header-offset (position-bytes tar-header-offset)))
7bfcceab 446 (set-buffer-modified-p nil))))
e865c5ce 447\f
439fa06f 448(defvar tar-mode-map nil "*Local keymap for Tar mode listings.")
aa73f29c
RS
449
450(if tar-mode-map
451 nil
452 (setq tar-mode-map (make-keymap))
453 (suppress-keymap tar-mode-map)
454 (define-key tar-mode-map " " 'tar-next-line)
92062a09 455 (define-key tar-mode-map "C" 'tar-copy)
aa73f29c
RS
456 (define-key tar-mode-map "d" 'tar-flag-deleted)
457 (define-key tar-mode-map "\^D" 'tar-flag-deleted)
458 (define-key tar-mode-map "e" 'tar-extract)
459 (define-key tar-mode-map "f" 'tar-extract)
42269da5 460 (define-key tar-mode-map "\C-m" 'tar-extract)
439fa06f 461 (define-key tar-mode-map [mouse-2] 'tar-mouse-extract)
aa73f29c
RS
462 (define-key tar-mode-map "g" 'revert-buffer)
463 (define-key tar-mode-map "h" 'describe-mode)
464 (define-key tar-mode-map "n" 'tar-next-line)
465 (define-key tar-mode-map "\^N" 'tar-next-line)
b6445135 466 (define-key tar-mode-map [down] 'tar-next-line)
aa73f29c 467 (define-key tar-mode-map "o" 'tar-extract-other-window)
aa73f29c 468 (define-key tar-mode-map "p" 'tar-previous-line)
23bdfc9a 469 (define-key tar-mode-map "q" 'quit-window)
aa73f29c 470 (define-key tar-mode-map "\^P" 'tar-previous-line)
b6445135 471 (define-key tar-mode-map [up] 'tar-previous-line)
92062a09 472 (define-key tar-mode-map "R" 'tar-rename-entry)
aa73f29c
RS
473 (define-key tar-mode-map "u" 'tar-unflag)
474 (define-key tar-mode-map "v" 'tar-view)
475 (define-key tar-mode-map "x" 'tar-expunge)
476 (define-key tar-mode-map "\177" 'tar-unflag-backwards)
477 (define-key tar-mode-map "E" 'tar-extract-other-window)
478 (define-key tar-mode-map "M" 'tar-chmod-entry)
479 (define-key tar-mode-map "G" 'tar-chgrp-entry)
480 (define-key tar-mode-map "O" 'tar-chown-entry)
481 )
e865c5ce
RS
482\f
483;; Make menu bar items.
484
485;; Get rid of the Edit menu bar item to save space.
486(define-key tar-mode-map [menu-bar edit] 'undefined)
487
488(define-key tar-mode-map [menu-bar immediate]
489 (cons "Immediate" (make-sparse-keymap "Immediate")))
490
491(define-key tar-mode-map [menu-bar immediate view]
492 '("View This File" . tar-view))
493(define-key tar-mode-map [menu-bar immediate display]
ddcb4671 494 '("Display in Other Window" . tar-display-other-window))
e865c5ce
RS
495(define-key tar-mode-map [menu-bar immediate find-file-other-window]
496 '("Find in Other Window" . tar-extract-other-window))
497(define-key tar-mode-map [menu-bar immediate find-file]
498 '("Find This File" . tar-extract))
499
500(define-key tar-mode-map [menu-bar mark]
501 (cons "Mark" (make-sparse-keymap "Mark")))
502
503(define-key tar-mode-map [menu-bar mark unmark-all]
504 '("Unmark All" . tar-clear-modification-flags))
505(define-key tar-mode-map [menu-bar mark deletion]
506 '("Flag" . tar-flag-deleted))
507(define-key tar-mode-map [menu-bar mark unmark]
508 '("Unflag" . tar-unflag))
509
510(define-key tar-mode-map [menu-bar operate]
511 (cons "Operate" (make-sparse-keymap "Operate")))
512
513(define-key tar-mode-map [menu-bar operate chown]
514 '("Change Owner..." . tar-chown-entry))
515(define-key tar-mode-map [menu-bar operate chgrp]
516 '("Change Group..." . tar-chgrp-entry))
517(define-key tar-mode-map [menu-bar operate chmod]
518 '("Change Mode..." . tar-chmod-entry))
519(define-key tar-mode-map [menu-bar operate rename]
520 '("Rename to..." . tar-rename-entry))
521(define-key tar-mode-map [menu-bar operate copy]
522 '("Copy to..." . tar-copy))
523(define-key tar-mode-map [menu-bar operate expunge]
9f1250c5 524 '("Expunge Marked Files" . tar-expunge))
e865c5ce 525\f
aa73f29c
RS
526;; tar mode is suitable only for specially formatted data.
527(put 'tar-mode 'mode-class 'special)
528(put 'tar-subfile-mode 'mode-class 'special)
529
bdd53bbc 530;;;###autoload
a91c76d6 531(define-derived-mode tar-mode nil "Tar"
aa73f29c
RS
532 "Major mode for viewing a tar file as a dired-like listing of its contents.
533You can move around using the usual cursor motion commands.
534Letters no longer insert themselves.
439fa06f
RS
535Type `e' to pull a file out of the tar file and into its own buffer;
536or click mouse-2 on the file's line in the Tar mode buffer.
e865c5ce 537Type `c' to copy an entry from the tar file into another file on disk.
aa73f29c 538
e865c5ce
RS
539If you edit a sub-file of this archive (as with the `e' command) and
540save it with Control-x Control-s, the contents of that buffer will be
aa73f29c
RS
541saved back into the tar-file buffer; in this way you can edit a file
542inside of a tar archive without extracting it and re-archiving it.
543
e865c5ce 544See also: variables `tar-update-datestamp' and `tar-anal-blocksize'.
aa73f29c
RS
545\\{tar-mode-map}"
546 ;; this is not interactive because you shouldn't be turning this
547 ;; mode on and off. You can corrupt things that way.
1c0b3743
RS
548 ;; rms: with permanent locals, it should now be possible to make this work
549 ;; interactively in some reasonable fashion.
aa73f29c
RS
550 (make-local-variable 'tar-header-offset)
551 (make-local-variable 'tar-parse-info)
a91c76d6
SM
552 (set (make-local-variable 'require-final-newline) nil) ; binary data, dude...
553 (set (make-local-variable 'revert-buffer-function) 'tar-mode-revert)
554 (set (make-local-variable 'local-enable-local-variables) nil)
555 (set (make-local-variable 'next-line-add-newlines) nil)
b9ca3cdb 556 ;; Prevent loss of data when saving the file.
a91c76d6 557 (set (make-local-variable 'file-precious-flag) t)
aa73f29c 558 (auto-save-mode 0)
a91c76d6 559 (set (make-local-variable 'write-contents-hooks) '(tar-mode-write-file))
aa73f29c
RS
560 (widen)
561 (if (and (boundp 'tar-header-offset) tar-header-offset)
1b33e237 562 (narrow-to-region 1 (byte-to-position tar-header-offset))
a91c76d6
SM
563 (tar-summarize-buffer)
564 (tar-next-line 0)))
aa73f29c
RS
565
566
567(defun tar-subfile-mode (p)
568 "Minor mode for editing an element of a tar-file.
76605277
RS
569This mode arranges for \"saving\" this buffer to write the data
570into the tar-file buffer that it came from. The changes will actually
571appear on disk when you save the tar-file's buffer."
aa73f29c 572 (interactive "P")
0f8becaa 573 (or (and (boundp 'tar-superior-buffer) tar-superior-buffer)
e865c5ce 574 (error "This buffer is not an element of a tar file"))
c09655bc
RS
575;;; Don't do this, because it is redundant and wastes mode line space.
576;;; (or (assq 'tar-subfile-mode minor-mode-alist)
577;;; (setq minor-mode-alist (append minor-mode-alist
578;;; (list '(tar-subfile-mode " TarFile")))))
aa73f29c
RS
579 (make-local-variable 'tar-subfile-mode)
580 (setq tar-subfile-mode
581 (if (null p)
582 (not tar-subfile-mode)
583 (> (prefix-numeric-value p) 0)))
584 (cond (tar-subfile-mode
e865c5ce
RS
585 (make-local-variable 'local-write-file-hooks)
586 (setq local-write-file-hooks '(tar-subfile-save-buffer))
aa73f29c 587 ;; turn off auto-save.
75238436 588 (auto-save-mode -1)
aa73f29c
RS
589 (setq buffer-auto-save-file-name nil)
590 (run-hooks 'tar-subfile-mode-hook))
e865c5ce
RS
591 (t
592 (kill-local-variable 'local-write-file-hooks))))
aa73f29c
RS
593
594
e865c5ce 595;; Revert the buffer and recompute the dired-like listing.
f6b0805a 596(defun tar-mode-revert (&optional no-auto-save no-confirm)
3742f39f
RS
597 (let ((revert-buffer-function nil)
598 (old-offset tar-header-offset)
599 success)
600 (setq tar-header-offset nil)
601 (unwind-protect
602 (and (revert-buffer t no-confirm)
603 (progn (widen)
604 (setq success t)
605 (tar-mode)))
606 ;; If the revert was canceled,
607 ;; put back the old value of tar-header-offset.
608 (or success
609 (setq tar-header-offset old-offset)))))
aa73f29c
RS
610
611
210f943e
PJ
612(defun tar-next-line (arg)
613 "Move cursor vertically down ARG lines and to the start of the filename."
aa73f29c 614 (interactive "p")
210f943e 615 (forward-line arg)
30712209 616 (if (eobp) nil (forward-char (if tar-mode-show-date 54 36))))
aa73f29c 617
210f943e
PJ
618(defun tar-previous-line (arg)
619 "Move cursor vertically up ARG lines and to the start of the filename."
aa73f29c 620 (interactive "p")
210f943e 621 (tar-next-line (- arg)))
aa73f29c
RS
622
623(defun tar-current-descriptor (&optional noerror)
e865c5ce 624 "Return the tar-descriptor of the current line, or signals an error."
aa73f29c
RS
625 ;; I wish lines had plists, like in ZMACS...
626 (or (nth (count-lines (point-min)
627 (save-excursion (beginning-of-line) (point)))
628 tar-parse-info)
629 (if noerror
630 nil
439fa06f 631 (error "This line does not describe a tar-file entry"))))
aa73f29c 632
439fa06f
RS
633(defun tar-get-descriptor ()
634 (let* ((descriptor (tar-current-descriptor))
635 (tokens (tar-desc-tokens descriptor))
636 (size (tar-header-size tokens))
637 (link-p (tar-header-link-type tokens)))
638 (if link-p
639 (error "This is a %s, not a real file"
640 (cond ((eq link-p 5) "directory")
641 ((eq link-p 20) "tar directory header")
642 ((eq link-p 29) "multivolume-continuation")
643 ((eq link-p 35) "sparse entry")
644 ((eq link-p 38) "volume header")
645 (t "link"))))
646 (if (zerop size) (error "This is a zero-length file"))
647 descriptor))
648
649(defun tar-mouse-extract (event)
650 "Extract a file whose tar directory line you click on."
651 (interactive "e")
652 (save-excursion
653 (set-buffer (window-buffer (posn-window (event-end event))))
654 (save-excursion
655 (goto-char (posn-point (event-end event)))
656 ;; Just make sure this doesn't get an error.
657 (tar-get-descriptor)))
658 (select-window (posn-window (event-end event)))
659 (goto-char (posn-point (event-end event)))
660 (tar-extract))
aa73f29c
RS
661
662(defun tar-extract (&optional other-window-p)
628d6cef 663 "In Tar mode, extract this entry of the tar file into its own buffer."
aa73f29c
RS
664 (interactive)
665 (let* ((view-p (eq other-window-p 'view))
439fa06f 666 (descriptor (tar-get-descriptor))
aa73f29c
RS
667 (tokens (tar-desc-tokens descriptor))
668 (name (tar-header-name tokens))
669 (size (tar-header-size tokens))
aa73f29c
RS
670 (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
671 (end (+ start size)))
aa73f29c 672 (let* ((tar-buffer (current-buffer))
1b33e237 673 (tar-buffer-multibyte enable-multibyte-characters)
38c6e0c7 674 (tarname (buffer-name))
e8421604
GM
675 (bufname (concat (file-name-nondirectory name)
676 " ("
6da7ea56 677 tarname
e8421604 678 ")"))
aa73f29c 679 (read-only-p (or buffer-read-only view-p))
38c6e0c7
AS
680 (new-buffer-file-name (expand-file-name
681 ;; `:' is not allowed on Windows
e8421604
GM
682 (concat tarname "!" name)))
683 (buffer (get-file-buffer new-buffer-file-name))
684 (just-created nil))
685 (unless buffer
38c6e0c7
AS
686 (setq buffer (generate-new-buffer bufname))
687 (setq bufname (buffer-name buffer))
aa73f29c
RS
688 (setq just-created t)
689 (unwind-protect
690 (progn
691 (widen)
1b33e237 692 (set-buffer-multibyte nil)
aa73f29c
RS
693 (save-excursion
694 (set-buffer buffer)
1b33e237
KH
695 (if enable-multibyte-characters
696 (progn
697 ;; We must avoid unibyte->multibyte conversion.
698 (set-buffer-multibyte nil)
699 (insert-buffer-substring tar-buffer start end)
700 (set-buffer-multibyte t))
701 (insert-buffer-substring tar-buffer start end))
cb33a0ce 702 (goto-char (point-min))
38c6e0c7 703 (setq buffer-file-name new-buffer-file-name)
fef5a0be
RS
704 (setq buffer-file-truename
705 (abbreviate-file-name buffer-file-name))
47414bc1
RS
706 ;; We need to mimic the parts of insert-file-contents
707 ;; which determine the coding-system and decode the text.
708 (let ((coding
c533a7e2
EZ
709 (or coding-system-for-read
710 (and set-auto-coding-function
711 (save-excursion
712 (funcall set-auto-coding-function
713 name (- (point-max) (point)))))))
47414bc1
RS
714 (multibyte enable-multibyte-characters)
715 (detected (detect-coding-region
9e169221 716 1 (min 16384 (point-max)) t)))
47414bc1
RS
717 (if coding
718 (or (numberp (coding-system-eol-type coding))
719 (setq coding (coding-system-change-eol-conversion
720 coding
721 (coding-system-eol-type detected))))
722 (setq coding
723 (or (find-new-buffer-file-coding-system detected)
724 (let ((file-coding
725 (find-operation-coding-system
726 'insert-file-contents buffer-file-name)))
727 (if (consp file-coding)
728 (setq file-coding (car file-coding))
729 file-coding)))))
730 (if (or (eq coding 'no-conversion)
731 (eq (coding-system-type coding) 5))
732 (setq multibyte (set-buffer-multibyte nil)))
733 (or multibyte
734 (setq coding
735 (coding-system-change-text-conversion
736 coding 'raw-text)))
737 (decode-coding-region 1 (point-max) coding)
738 (set-buffer-file-coding-system coding))
fef5a0be
RS
739 ;; Set the default-directory to the dir of the
740 ;; superior buffer.
741 (setq default-directory
742 (save-excursion
743 (set-buffer tar-buffer)
744 default-directory))
aa73f29c 745 (normal-mode) ; pick a mode.
aa73f29c 746 (rename-buffer bufname)
0f8becaa
ER
747 (make-local-variable 'tar-superior-buffer)
748 (make-local-variable 'tar-superior-descriptor)
749 (setq tar-superior-buffer tar-buffer)
750 (setq tar-superior-descriptor descriptor)
76605277
RS
751 (setq buffer-read-only read-only-p)
752 (set-buffer-modified-p nil)
753 (tar-subfile-mode 1))
aa73f29c 754 (set-buffer tar-buffer))
1b33e237
KH
755 (narrow-to-region 1 tar-header-offset)
756 (set-buffer-multibyte tar-buffer-multibyte)))
aa73f29c 757 (if view-p
3eb37b08 758 (view-buffer buffer (and just-created 'kill-buffer))
e865c5ce
RS
759 (if (eq other-window-p 'display)
760 (display-buffer buffer)
761 (if other-window-p
762 (switch-to-buffer-other-window buffer)
763 (switch-to-buffer buffer)))))))
aa73f29c
RS
764
765
766(defun tar-extract-other-window ()
e865c5ce 767 "*In Tar mode, find this entry of the tar file in another window."
aa73f29c
RS
768 (interactive)
769 (tar-extract t))
770
e865c5ce
RS
771(defun tar-display-other-window ()
772 "*In Tar mode, display this entry of the tar file in another window."
773 (interactive)
774 (tar-extract 'display))
775
aa73f29c 776(defun tar-view ()
e865c5ce 777 "*In Tar mode, view the tar file entry on this line."
aa73f29c
RS
778 (interactive)
779 (tar-extract 'view))
780
781
782(defun tar-read-file-name (&optional prompt)
e865c5ce 783 "Read a file name with this line's entry as the default."
aa73f29c
RS
784 (or prompt (setq prompt "Copy to: "))
785 (let* ((default-file (expand-file-name
786 (tar-header-name (tar-desc-tokens
787 (tar-current-descriptor)))))
788 (target (expand-file-name
789 (read-file-name prompt
790 (file-name-directory default-file)
791 default-file nil))))
792 (if (or (string= "" (file-name-nondirectory target))
793 (file-directory-p target))
794 (setq target (concat (if (string-match "/$" target)
795 (substring target 0 (1- (match-end 0)))
796 target)
797 "/"
798 (file-name-nondirectory default-file))))
799 target))
800
801
802(defun tar-copy (&optional to-file)
e865c5ce 803 "*In Tar mode, extract this entry of the tar file into a file on disk.
aa73f29c
RS
804If TO-FILE is not supplied, it is prompted for, defaulting to the name of
805the current tar-entry."
806 (interactive (list (tar-read-file-name)))
439fa06f 807 (let* ((descriptor (tar-get-descriptor))
aa73f29c
RS
808 (tokens (tar-desc-tokens descriptor))
809 (name (tar-header-name tokens))
810 (size (tar-header-size tokens))
aa73f29c 811 (start (+ (tar-desc-data-start descriptor) tar-header-offset -1))
d4ec0200 812 (end (+ start size))
1b33e237 813 (multibyte enable-multibyte-characters)
d4ec0200
RS
814 (inhibit-file-name-handlers inhibit-file-name-handlers)
815 (inhibit-file-name-operation inhibit-file-name-operation))
6a608e8e
KH
816 (save-restriction
817 (widen)
d4ec0200
RS
818 ;; Inhibit compressing a subfile again if *both* name and
819 ;; to-file are handled by jka-compr
820 (if (and (eq (find-file-name-handler name 'write-region) 'jka-compr-handler)
821 (eq (find-file-name-handler to-file 'write-region) 'jka-compr-handler))
822 (setq inhibit-file-name-handlers
823 (cons 'jka-compr-handler
824 (and (eq inhibit-file-name-operation 'write-region)
825 inhibit-file-name-handlers))
826 inhibit-file-name-operation 'write-region))
1b33e237
KH
827 (unwind-protect
828 (let ((coding-system-for-write 'no-conversion))
829 (set-buffer-multibyte nil)
5ee42746 830 (write-region start end to-file nil nil nil t))
1b33e237 831 (set-buffer-multibyte multibyte)))
6a608e8e 832 (message "Copied tar entry %s to %s" name to-file)))
aa73f29c
RS
833
834(defun tar-flag-deleted (p &optional unflag)
e865c5ce 835 "*In Tar mode, mark this sub-file to be deleted from the tar file.
aa73f29c
RS
836With a prefix argument, mark that many files."
837 (interactive "p")
838 (beginning-of-line)
048d06bd 839 (dotimes (i (if (< p 0) (- p) p))
aa73f29c
RS
840 (if (tar-current-descriptor unflag) ; barf if we're not on an entry-line.
841 (progn
842 (delete-char 1)
843 (insert (if unflag " " "D"))))
844 (forward-line (if (< p 0) -1 1)))
845 (if (eobp) nil (forward-char 36)))
846
847(defun tar-unflag (p)
e865c5ce 848 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
849With a prefix argument, un-mark that many files forward."
850 (interactive "p")
851 (tar-flag-deleted p t))
852
853(defun tar-unflag-backwards (p)
e865c5ce 854 "*In Tar mode, un-mark this sub-file if it is marked to be deleted.
aa73f29c
RS
855With a prefix argument, un-mark that many files backward."
856 (interactive "p")
857 (tar-flag-deleted (- p) t))
858
859
1b33e237 860;; When this function is called, it is sure that the buffer is unibyte.
aa73f29c
RS
861(defun tar-expunge-internal ()
862 "Expunge the tar-entry specified by the current line."
863 (let* ((descriptor (tar-current-descriptor))
864 (tokens (tar-desc-tokens descriptor))
865 (line (tar-desc-data-start descriptor))
866 (name (tar-header-name tokens))
867 (size (tar-header-size tokens))
868 (link-p (tar-header-link-type tokens))
869 (start (tar-desc-data-start descriptor))
870 (following-descs (cdr (memq descriptor tar-parse-info))))
871 (if link-p (setq size 0)) ; size lies for hard-links.
872 ;;
873 ;; delete the current line...
874 (beginning-of-line)
875 (let ((line-start (point)))
876 (end-of-line) (forward-char)
877 (let ((line-len (- (point) line-start)))
878 (delete-region line-start (point))
879 ;;
a7acbbe4 880 ;; decrement the header-pointer to be in sync...
aa73f29c
RS
881 (setq tar-header-offset (- tar-header-offset line-len))))
882 ;;
883 ;; delete the data pointer...
884 (setq tar-parse-info (delq descriptor tar-parse-info))
885 ;;
886 ;; delete the data from inside the file...
887 (widen)
888 (let* ((data-start (+ start tar-header-offset -513))
889 (data-end (+ data-start 512 (ash (ash (+ size 511) -9) 9))))
890 (delete-region data-start data-end)
891 ;;
892 ;; and finally, decrement the start-pointers of all following
893 ;; entries in the archive. This is a pig when deleting a bunch
894 ;; of files at once - we could optimize this to only do the
895 ;; iteration over the files that remain, or only iterate up to
896 ;; the next file to be deleted.
897 (let ((data-length (- data-end data-start)))
048d06bd 898 (dolist (desc following-descs)
aa73f29c
RS
899 (tar-setf (tar-desc-data-start desc)
900 (- (tar-desc-data-start desc) data-length))))
901 ))
902 (narrow-to-region 1 tar-header-offset))
903
904
905(defun tar-expunge (&optional noconfirm)
e865c5ce 906 "*In Tar mode, delete all the archived files flagged for deletion.
aa73f29c
RS
907This does not modify the disk image; you must save the tar file itself
908for this to be permanent."
909 (interactive)
910 (if (or noconfirm
67501c01 911 (y-or-n-p "Expunge files marked for deletion? "))
1b33e237
KH
912 (let ((n 0)
913 (multibyte enable-multibyte-characters))
914 (set-buffer-multibyte nil)
aa73f29c 915 (save-excursion
cb33a0ce 916 (goto-char (point-min))
aa73f29c
RS
917 (while (not (eobp))
918 (if (looking-at "D")
919 (progn (tar-expunge-internal)
920 (setq n (1+ n)))
921 (forward-line 1)))
922 ;; after doing the deletions, add any padding that may be necessary.
923 (tar-pad-to-blocksize)
1b33e237
KH
924 (narrow-to-region 1 tar-header-offset))
925 (set-buffer-multibyte multibyte)
aa73f29c 926 (if (zerop n)
67501c01
RS
927 (message "Nothing to expunge.")
928 (message "%s files expunged. Be sure to save this buffer." n)))))
aa73f29c
RS
929
930
931(defun tar-clear-modification-flags ()
e865c5ce 932 "Remove the stars at the beginning of each line."
a7e5e8cb 933 (interactive)
aa73f29c 934 (save-excursion
cb33a0ce 935 (goto-char (point-min))
1b33e237 936 (while (< (position-bytes (point)) tar-header-offset)
a7e5e8cb 937 (if (not (eq (following-char) ?\ ))
aa73f29c
RS
938 (progn (delete-char 1) (insert " ")))
939 (forward-line 1))))
940
941
942(defun tar-chown-entry (new-uid)
943 "*Change the user-id associated with this entry in the tar file.
944If this tar file was written by GNU tar, then you will be able to edit
945the user id as a string; otherwise, you must edit it as a number.
946You can force editing as a number by calling this with a prefix arg.
947This does not modify the disk image; you must save the tar file itself
948for this to be permanent."
949 (interactive (list
950 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
951 (if (or current-prefix-arg
952 (not (tar-header-magic tokens)))
953 (let (n)
954 (while (not (numberp (setq n (read-minibuffer
955 "New UID number: "
956 (format "%s" (tar-header-uid tokens)))))))
957 n)
958 (read-string "New UID string: " (tar-header-uname tokens))))))
959 (cond ((stringp new-uid)
960 (tar-setf (tar-header-uname (tar-desc-tokens (tar-current-descriptor)))
961 new-uid)
962 (tar-alter-one-field tar-uname-offset (concat new-uid "\000")))
963 (t
964 (tar-setf (tar-header-uid (tar-desc-tokens (tar-current-descriptor)))
965 new-uid)
966 (tar-alter-one-field tar-uid-offset
967 (concat (substring (format "%6o" new-uid) 0 6) "\000 ")))))
968
969
970(defun tar-chgrp-entry (new-gid)
971 "*Change the group-id associated with this entry in the tar file.
972If this tar file was written by GNU tar, then you will be able to edit
973the group id as a string; otherwise, you must edit it as a number.
974You can force editing as a number by calling this with a prefix arg.
975This does not modify the disk image; you must save the tar file itself
976for this to be permanent."
977 (interactive (list
978 (let ((tokens (tar-desc-tokens (tar-current-descriptor))))
979 (if (or current-prefix-arg
980 (not (tar-header-magic tokens)))
981 (let (n)
982 (while (not (numberp (setq n (read-minibuffer
983 "New GID number: "
984 (format "%s" (tar-header-gid tokens)))))))
985 n)
986 (read-string "New GID string: " (tar-header-gname tokens))))))
987 (cond ((stringp new-gid)
988 (tar-setf (tar-header-gname (tar-desc-tokens (tar-current-descriptor)))
989 new-gid)
990 (tar-alter-one-field tar-gname-offset
991 (concat new-gid "\000")))
992 (t
993 (tar-setf (tar-header-gid (tar-desc-tokens (tar-current-descriptor)))
994 new-gid)
995 (tar-alter-one-field tar-gid-offset
996 (concat (substring (format "%6o" new-gid) 0 6) "\000 ")))))
997
998(defun tar-rename-entry (new-name)
999 "*Change the name associated with this entry in the tar file.
1000This does not modify the disk image; you must save the tar file itself
1001for this to be permanent."
1002 (interactive
1003 (list (read-string "New name: "
1004 (tar-header-name (tar-desc-tokens (tar-current-descriptor))))))
439fa06f
RS
1005 (if (string= "" new-name) (error "zero length name"))
1006 (if (> (length new-name) 98) (error "name too long"))
aa73f29c
RS
1007 (tar-setf (tar-header-name (tar-desc-tokens (tar-current-descriptor)))
1008 new-name)
1009 (tar-alter-one-field 0
1010 (substring (concat new-name (make-string 99 0)) 0 99)))
1011
1012
1013(defun tar-chmod-entry (new-mode)
1014 "*Change the protection bits associated with this entry in the tar file.
1015This does not modify the disk image; you must save the tar file itself
1016for this to be permanent."
1017 (interactive (list (tar-parse-octal-integer-safe
1018 (read-string "New protection (octal): "))))
1019 (tar-setf (tar-header-mode (tar-desc-tokens (tar-current-descriptor)))
1020 new-mode)
1021 (tar-alter-one-field tar-mode-offset
1022 (concat (substring (format "%6o" new-mode) 0 6) "\000 ")))
1023
1024
1025(defun tar-alter-one-field (data-position new-data-string)
1026 (let* ((descriptor (tar-current-descriptor))
1b33e237
KH
1027 (tokens (tar-desc-tokens descriptor))
1028 (multibyte enable-multibyte-characters))
aa73f29c
RS
1029 (unwind-protect
1030 (save-excursion
1031 ;;
1032 ;; update the header-line.
1033 (beginning-of-line)
1034 (let ((p (point)))
1035 (forward-line 1)
1036 (delete-region p (point))
1bc28099 1037 (insert (tar-header-block-summarize tokens) "\n")
1b33e237 1038 (setq tar-header-offset (position-bytes (point-max))))
aa73f29c
RS
1039
1040 (widen)
1b33e237 1041 (set-buffer-multibyte nil)
aa73f29c
RS
1042 (let* ((start (+ (tar-desc-data-start descriptor) tar-header-offset -513)))
1043 ;;
1044 ;; delete the old field and insert a new one.
1045 (goto-char (+ start data-position))
1046 (delete-region (point) (+ (point) (length new-data-string))) ; <--
1047 (insert new-data-string) ; <--
1048 ;;
1049 ;; compute a new checksum and insert it.
1bc28099 1050 (let ((chk (tar-header-block-checksum
aa73f29c
RS
1051 (buffer-substring start (+ start 512)))))
1052 (goto-char (+ start tar-chk-offset))
1053 (delete-region (point) (+ (point) 8))
1054 (insert (format "%6o" chk))
1055 (insert 0)
1056 (insert ? )
1057 (tar-setf (tar-header-checksum tokens) chk)
1058 ;;
1059 ;; ok, make sure we didn't botch it.
d246db94 1060 (tar-header-block-check-checksum
aa73f29c
RS
1061 (buffer-substring start (+ start 512))
1062 chk (tar-header-name tokens))
1063 )))
47414bc1 1064 (narrow-to-region 1 tar-header-offset)
1b33e237 1065 (set-buffer-multibyte multibyte)
47414bc1 1066 (tar-next-line 0))))
aa73f29c
RS
1067
1068
3d7fc2fb
ER
1069(defun tar-octal-time (timeval)
1070 ;; Format a timestamp as 11 octal digits. Ghod, I hope this works...
1071 (let ((hibits (car timeval)) (lobits (car (cdr timeval))))
1072 (insert (format "%05o%01o%05o"
1073 (lsh hibits -2)
1074 (logior (lsh (logand 3 hibits) 1) (> (logand lobits 32768) 0))
1075 (logand 32767 lobits)
1076 ))))
1077
aa73f29c 1078(defun tar-subfile-save-buffer ()
e865c5ce
RS
1079 "In tar subfile mode, save this buffer into its parent tar-file buffer.
1080This doesn't write anything to disk; you must save the parent tar-file buffer
aa73f29c
RS
1081to make your changes permanent."
1082 (interactive)
0f8becaa 1083 (if (not (and (boundp 'tar-superior-buffer) tar-superior-buffer))
439fa06f 1084 (error "This buffer has no superior tar file buffer"))
0f8becaa 1085 (if (not (and (boundp 'tar-superior-descriptor) tar-superior-descriptor))
439fa06f 1086 (error "This buffer doesn't have an index into its superior tar file!"))
aa73f29c
RS
1087 (save-excursion
1088 (let ((subfile (current-buffer))
1b33e237 1089 (subfile-multibyte enable-multibyte-characters)
47414bc1 1090 (coding buffer-file-coding-system)
1b33e237
KH
1091 (descriptor tar-superior-descriptor)
1092 subfile-size)
1093 ;; We must make the current buffer unibyte temporarily to avoid
1094 ;; multibyte->unibyte conversion in `insert-buffer'.
1095 (set-buffer-multibyte nil)
1096 (setq subfile-size (buffer-size))
0f8becaa 1097 (set-buffer tar-superior-buffer)
aa73f29c
RS
1098 (let* ((tokens (tar-desc-tokens descriptor))
1099 (start (tar-desc-data-start descriptor))
1100 (name (tar-header-name tokens))
1101 (size (tar-header-size tokens))
1102 (size-pad (ash (ash (+ size 511) -9) 9))
1103 (head (memq descriptor tar-parse-info))
1b33e237
KH
1104 (following-descs (cdr head))
1105 (tar-buffer-multibyte enable-multibyte-characters))
aa73f29c
RS
1106 (if (not head)
1107 (error "Can't find this tar file entry in its parent tar file!"))
1108 (unwind-protect
1109 (save-excursion
1110 (widen)
1b33e237 1111 (set-buffer-multibyte nil)
aa73f29c
RS
1112 ;; delete the old data...
1113 (let* ((data-start (+ start tar-header-offset -1))
1114 (data-end (+ data-start (ash (ash (+ size 511) -9) 9))))
1115 (delete-region data-start data-end)
1116 ;; insert the new data...
1117 (goto-char data-start)
1118 (insert-buffer subfile)
47414bc1
RS
1119 (setq subfile-size
1120 (encode-coding-region
1121 data-start (+ data-start subfile-size) coding))
aa73f29c
RS
1122 ;;
1123 ;; pad the new data out to a multiple of 512...
1124 (let ((subfile-size-pad (ash (ash (+ subfile-size 511) -9) 9)))
1125 (goto-char (+ data-start subfile-size))
1126 (insert (make-string (- subfile-size-pad subfile-size) 0))
1127 ;;
1128 ;; update the data pointer of this and all following files...
1129 (tar-setf (tar-header-size tokens) subfile-size)
1130 (let ((difference (- subfile-size-pad size-pad)))
048d06bd 1131 (dolist (desc following-descs)
aa73f29c
RS
1132 (tar-setf (tar-desc-data-start desc)
1133 (+ (tar-desc-data-start desc) difference))))
1134 ;;
1135 ;; Update the size field in the header block.
1136 (let ((header-start (- data-start 512)))
1137 (goto-char (+ header-start tar-size-offset))
1138 (delete-region (point) (+ (point) 12))
1139 (insert (format "%11o" subfile-size))
1140 (insert ? )
1141 ;;
1142 ;; Maybe update the datestamp.
1143 (if (not tar-update-datestamp)
1144 nil
1145 (goto-char (+ header-start tar-time-offset))
1146 (delete-region (point) (+ (point) 12))
3d7fc2fb 1147 (insert (tar-octal-time (current-time)))
aa73f29c
RS
1148 (insert ? ))
1149 ;;
1150 ;; compute a new checksum and insert it.
1bc28099 1151 (let ((chk (tar-header-block-checksum
aa73f29c
RS
1152 (buffer-substring header-start data-start))))
1153 (goto-char (+ header-start tar-chk-offset))
1154 (delete-region (point) (+ (point) 8))
1155 (insert (format "%6o" chk))
1156 (insert 0)
1157 (insert ? )
1158 (tar-setf (tar-header-checksum tokens) chk)))
1159 ;;
1160 ;; alter the descriptor-line...
1161 ;;
1162 (let ((position (- (length tar-parse-info) (length head))))
cb33a0ce 1163 (goto-char (point-min))
aa73f29c
RS
1164 (next-line position)
1165 (beginning-of-line)
1166 (let ((p (point))
97590737 1167 after
aa73f29c
RS
1168 (m (set-marker (make-marker) tar-header-offset)))
1169 (forward-line 1)
97590737
RS
1170 (setq after (point))
1171 ;; Insert the new text after the old, before deleting,
1172 ;; to preserve the window start.
1b33e237
KH
1173 (let ((line (tar-header-block-summarize tokens t)))
1174 (if (multibyte-string-p line)
1175 (insert-before-markers (string-as-unibyte line) "\n")
1176 (insert-before-markers line "\n")))
97590737 1177 (delete-region p after)
aa73f29c
RS
1178 (setq tar-header-offset (marker-position m)))
1179 )))
1180 ;; after doing the insertion, add any final padding that may be necessary.
1181 (tar-pad-to-blocksize))
1b33e237
KH
1182 (narrow-to-region 1 tar-header-offset)
1183 (set-buffer-multibyte tar-buffer-multibyte)))
aa73f29c 1184 (set-buffer-modified-p t) ; mark the tar file as modified
47414bc1 1185 (tar-next-line 0)
aa73f29c 1186 (set-buffer subfile)
1b33e237
KH
1187 ;; Restore the buffer multibyteness.
1188 (set-buffer-multibyte subfile-multibyte)
aa73f29c 1189 (set-buffer-modified-p nil) ; mark the tar subfile as unmodified
67501c01 1190 (message "Saved into tar-buffer `%s'. Be sure to save that buffer!"
0f8becaa 1191 (buffer-name tar-superior-buffer))
47414bc1
RS
1192 ;; Prevent basic-save-buffer from changing our coding-system.
1193 (setq last-coding-system-used buffer-file-coding-system)
e865c5ce
RS
1194 ;; Prevent ordinary saving from happening.
1195 t)))
aa73f29c
RS
1196
1197
1b33e237 1198;; When this function is called, it is sure that the buffer is unibyte.
aa73f29c
RS
1199(defun tar-pad-to-blocksize ()
1200 "If we are being anal about tar file blocksizes, fix up the current buffer.
1201Leaves the region wide."
1202 (if (null tar-anal-blocksize)
1203 nil
1204 (widen)
1205 (let* ((last-desc (nth (1- (length tar-parse-info)) tar-parse-info))
1206 (start (tar-desc-data-start last-desc))
1207 (tokens (tar-desc-tokens last-desc))
1208 (link-p (tar-header-link-type tokens))
1209 (size (if link-p 0 (tar-header-size tokens)))
1210 (data-end (+ start size))
1211 (bbytes (ash tar-anal-blocksize 9))
1212 (pad-to (+ bbytes (* bbytes (/ (1- data-end) bbytes))))
628d6cef 1213 (inhibit-read-only t) ; ##
aa73f29c
RS
1214 )
1215 ;; If the padding after the last data is too long, delete some;
1216 ;; else insert some until we are padded out to the right number of blocks.
1217 ;;
1218 (goto-char (+ (or tar-header-offset 0) data-end))
1219 (if (> (1+ (buffer-size)) (+ (or tar-header-offset 0) pad-to))
1220 (delete-region (+ (or tar-header-offset 0) pad-to) (1+ (buffer-size)))
1221 (insert (make-string (- (+ (or tar-header-offset 0) pad-to)
1222 (1+ (buffer-size)))
1223 0)))
1224 )))
1225
1226
439fa06f 1227;; Used in write-file-hook to write tar-files out correctly.
67501c01
RS
1228(defun tar-mode-write-file ()
1229 (unwind-protect
1230 (save-excursion
1231 (widen)
1232 ;; Doing this here confuses things - the region gets left too wide!
1233 ;; I suppose this is run in a context where changing the buffer is bad.
1234 ;; (tar-pad-to-blocksize)
4063eb1c
DL
1235 ;; tar-header-offset turns out to be null for files fetched with W3,
1236 ;; at least.
1b33e237 1237 (let ((coding-system-for-write 'no-conversion))
e63f0ff0
GM
1238 (write-region (if tar-header-offset
1239 (byte-to-position tar-header-offset)
1240 (point-min))
1b33e237
KH
1241 (point-max)
1242 buffer-file-name nil t))
87aed91b
RS
1243 (tar-clear-modification-flags)
1244 (set-buffer-modified-p nil))
1b33e237 1245 (narrow-to-region 1 (byte-to-position tar-header-offset)))
23bdfc9a 1246 ;; Return t because we've written the file.
67501c01 1247 t)
aa73f29c 1248\f
aa73f29c
RS
1249(provide 'tar-mode)
1250
c88ab9ce 1251;;; tar-mode.el ends here